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< regionModelFunctionObject >	clone () 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< regionModelFunctionObject >	New (const dictionary &dict, regionModel &region, const word &modelType)
	Selector. More...

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

Detailed Description

Region model function object base class.

Source files

• regionModelFunctionObject.H
• regionModelFunctionObject.C
• regionModelFunctionObjectNew.C

Definition at line 56 of file regionModelFunctionObject.H.

Constructor & Destructor Documentation

regionModelFunctionObject() [1/3]

regionModelFunctionObject

(

regionModel &

region

)

Construct null from region.

Definition at line 43 of file regionModelFunctionObject.C.

Referenced by regionModelFunctionObject::clone(), and regionModelFunctionObject::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 54 of file regionModelFunctionObject.C.

References regionModelFunctionObject::regionModelFunctionObject().

Here is the call graph for this function:

regionModelFunctionObject() [3/3]

regionModelFunctionObject

(

const regionModelFunctionObject &

ppm

)

Construct copy.

Definition at line 67 of file regionModelFunctionObject.C.

~regionModelFunctionObject()

~regionModelFunctionObject ( )

virtual

Destructor.

Definition at line 79 of file regionModelFunctionObject.C.

Referenced by regionModelFunctionObject::clone().

Here is the caller graph for this function:

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

inlinevirtual

Construct and return a clone.

Definition at line 108 of file regionModelFunctionObject.H.

References regionModelFunctionObject::New(), regionModelFunctionObject::postEvolveRegion(), regionModelFunctionObject::preEvolveRegion(), regionModelFunctionObject::regionModelFunctionObject(), regionModelFunctionObject::write(), and regionModelFunctionObject::~regionModelFunctionObject().

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 32 of file regionModelFunctionObjectNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), Foam::nl, and dictionary::subDict().

Referenced by regionModelFunctionObject::clone().

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 85 of file regionModelFunctionObject.C.

Referenced by regionModelFunctionObject::clone().

Here is the caller graph for this function:

postEvolveRegion()

void postEvolveRegion ( )

virtual

Post-evolve region hook.

Definition at line 89 of file regionModelFunctionObject.C.

References Foam::blockMeshTools::write().

Referenced by regionModelFunctionObject::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

write()

void write ( ) const

virtual

write

Definition at line 98 of file regionModelFunctionObject.C.

Referenced by regionModelFunctionObject::clone().

Here is the caller graph for this function:

Member Data Documentation

dict_

dictionary dict_

protected

Dictionary.

Definition at line 63 of file regionModelFunctionObject.H.

regionModel_

regionModel& regionModel_

protected

Reference to the region model.

Definition at line 66 of file regionModelFunctionObject.H.

modelType_

word modelType_

protected

Model type name.

Definition at line 69 of file regionModelFunctionObject.H.

---

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

• src/regionModels/regionModel/regionModelFunctionObject/regionModelFunctionObject/regionModelFunctionObject.H
• src/regionModels/regionModel/regionModelFunctionObject/regionModelFunctionObject/regionModelFunctionObject.C
• src/regionModels/regionModel/regionModelFunctionObject/regionModelFunctionObject/regionModelFunctionObjectNew.C