Loading...
Searching...
No Matches
regionModelFunctionObject Class Reference

Region model function object base class. More...

#include <regionModelFunctionObject.H>

Collaboration diagram for regionModelFunctionObject:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("regionModelFunctionObject")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, regionModelFunctionObject, dictionary,(const dictionary &dict, regionModel &region),(dict, region))
 Declare runtime constructor selection table.
 regionModelFunctionObject (regionModel &region)
 Construct null from region.
 regionModelFunctionObject (const dictionary &dict, regionModel &region, const word &modelType)
 Construct from dictionary.
 regionModelFunctionObject (const regionModelFunctionObject &ppm)
 Construct copy.
virtual autoPtr< regionModelFunctionObject > clone () const
 Construct and return a clone.
virtual ~regionModelFunctionObject ()
 Destructor.
virtual void preEvolveRegion ()
 Pre-evolve region hook.
virtual void postEvolveRegion ()
 Post-evolve region hook.
virtual void write () const
 write

Static Public Member Functions

static autoPtr< regionModelFunctionObject > New (const dictionary &dict, regionModel &region, const word &modelType)
 Selector.

Protected Attributes

dictionary dict_
 Dictionary.
regionModel & regionModel_
 Reference to the region model.
word modelType_
 Model type name.

Detailed Description

Region model function object base class.

Source files

Definition at line 54 of file regionModelFunctionObject.H.

Constructor & Destructor Documentation

◆ regionModelFunctionObject() [1/3]

regionModelFunctionObject ( regionModel & region)

Construct null from region.

Definition at line 38 of file regionModelFunctionObject.C.

References dict_, modelType_, and regionModel_.

Referenced by declareRunTimeSelectionTable(), and regionModelFunctionObject().

Here is the caller graph for this function:

◆ regionModelFunctionObject() [2/3]

regionModelFunctionObject ( const dictionary & dict,
regionModel & region,
const word & modelType )

Construct from dictionary.

Definition at line 49 of file regionModelFunctionObject.C.

References dict, dict_, modelType_, and regionModel_.

◆ regionModelFunctionObject() [3/3]

regionModelFunctionObject ( const regionModelFunctionObject & ppm)

Construct copy.

Definition at line 62 of file regionModelFunctionObject.C.

References dict_, modelType_, regionModel_, and regionModelFunctionObject().

Here is the call graph for this function:

◆ ~regionModelFunctionObject()

~regionModelFunctionObject ( )
virtual

Destructor.

Definition at line 75 of file regionModelFunctionObject.C.

Member Function Documentation

◆ TypeName()

TypeName ( "regionModelFunctionObject" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
regionModelFunctionObject ,
dictionary ,
(const dictionary &dict, regionModel &region) ,
(dict, region)  )

Declare runtime constructor selection table.

References dict, and regionModelFunctionObject().

Here is the call graph for this function:

◆ clone()

virtual autoPtr< regionModelFunctionObject > clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 124 of file regionModelFunctionObject.H.

References autoPtr< T >::New().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::regionModels::regionModelFunctionObject > New ( const dictionary & dict,
regionModel & region,
const word & modelType )
static

Selector.

Definition at line 27 of file regionModelFunctionObjectNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Referenced by regionModelFunctionObjectList::regionModelFunctionObjectList().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ preEvolveRegion()

void preEvolveRegion ( )
virtual

Pre-evolve region hook.

Definition at line 81 of file regionModelFunctionObject.C.

◆ postEvolveRegion()

void postEvolveRegion ( )
virtual

Post-evolve region hook.

Definition at line 85 of file regionModelFunctionObject.C.

References regionModel_, and write().

Here is the call graph for this function:

◆ write()

void write ( ) const
virtual

write

Definition at line 94 of file regionModelFunctionObject.C.

Member Data Documentation

◆ dict_

dictionary dict_
protected

Dictionary.

Definition at line 63 of file regionModelFunctionObject.H.

Referenced by regionModelFunctionObject(), regionModelFunctionObject(), and regionModelFunctionObject().

◆ regionModel_

regionModel& regionModel_
protected

Reference to the region model.

Definition at line 68 of file regionModelFunctionObject.H.

Referenced by postEvolveRegion(), regionModelFunctionObject(), regionModelFunctionObject(), and regionModelFunctionObject().

◆ modelType_

word modelType_
protected

Model type name.

Definition at line 73 of file regionModelFunctionObject.H.

Referenced by regionModelFunctionObject(), regionModelFunctionObject(), and regionModelFunctionObject().

The documentation for this class was generated from the following files: