regionModelFunctionObject Class Reference

Region model function object base class. More...

Collaboration diagram for regionModelFunctionObject:

Public Member Functions

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

Static Public Member Functions

static autoPtr< regionModelFunctionObjectNew (const dictionary &dict, regionModel &region, const word &modelType)
 Selector. More...

Protected Attributes

dictionary dict_
 Dictionary. More...
 Reference to the region model. More...
word modelType_
 Model type name. More...

Detailed Description

Region model function object base class.

Source files

Definition at line 58 of file regionModelFunctionObject.H.

Constructor & Destructor Documentation

◆ regionModelFunctionObject() [1/3]

Construct null from region.

Definition at line 46 of file regionModelFunctionObject.C.

◆ regionModelFunctionObject() [2/3]

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

Construct from dictionary.

Definition at line 57 of file regionModelFunctionObject.C.

◆ regionModelFunctionObject() [3/3]

Construct copy.

Definition at line 70 of file regionModelFunctionObject.C.

◆ ~regionModelFunctionObject()


Definition at line 82 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.

◆ clone()

virtual autoPtr<regionModelFunctionObject> clone ( ) const

Construct and return a clone.

Definition at line 110 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 


Definition at line 35 of file regionModelFunctionObjectNew.C.

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

Here is the call graph for this function:

◆ preEvolveRegion()

void preEvolveRegion ( )

Pre-evolve region hook.

Definition at line 88 of file regionModelFunctionObject.C.

◆ postEvolveRegion()

void postEvolveRegion ( )

Post-evolve region hook.

Definition at line 92 of file regionModelFunctionObject.C.

References Foam::vtk::write().

Here is the call graph for this function:

◆ write()

void write ( ) const


Definition at line 101 of file regionModelFunctionObject.C.

Member Data Documentation

◆ dict_

dictionary dict_


Definition at line 65 of file regionModelFunctionObject.H.

◆ regionModel_

regionModel& regionModel_

Reference to the region model.

Definition at line 68 of file regionModelFunctionObject.H.

◆ modelType_

word modelType_

Model type name.

Definition at line 71 of file regionModelFunctionObject.H.

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