Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
regionFunctionObject Class Reference

Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry. More...

Inheritance diagram for regionFunctionObject:
Inheritance graph
[legend]
Collaboration diagram for regionFunctionObject:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("regionFunctionObject")
 Runtime type information. More...
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 Construct from the region objectRegistry and dictionary. More...
 
virtual ~regionFunctionObject ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 Read optional controls. More...
 
- Public Member Functions inherited from functionObject
virtual const wordtype () const =0
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () const
 Return the name of this functionObject. More...
 
virtual bool execute ()=0
 Called at each ++ or += of the time-loop. More...
 
virtual bool write ()=0
 Called at each ++ or += of the time-loop. More...
 
virtual bool end ()
 Called when Time::run() determines that the time-loop exits. More...
 
virtual bool adjustTimeStep ()
 Called at the end of Time::adjustDeltaT() if adjustTime is true. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &mesh)
 Update for changes of mesh. More...
 

Protected Member Functions

template<class ObjectType >
bool foundObject (const word &fieldName) const
 Find field in the objectRegistry. More...
 
template<class ObjectType >
const ObjectType & lookupObject (const word &fieldName) const
 Lookup field from the objectRegistry. More...
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 Store the given field in the objectRegistry under the given name. More...
 
bool writeObject (const word &fieldName)
 Write field if present in objectRegistry. More...
 
bool clearObject (const word &fieldName)
 Clear field from the objectRegistry if present. More...
 

Protected Attributes

const Timetime_
 Reference to the Time. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (const word &name, const Time &, const dictionary &)
 Select from dictionary, based on its "type" entry. More...
 
- Public Attributes inherited from functionObject
Switch log
 Switch write log to Info. More...
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 Global post-processing mode switch. More...
 

Detailed Description

Specialization of Foam::functionObject for a region and providing a reference to the region Foam::objectRegistry.

See also
Foam::functionObject
Source files

Definition at line 58 of file regionFunctionObject.H.

Constructor & Destructor Documentation

regionFunctionObject ( const word name,
const Time runTime,
const dictionary dict 
)

Construct from Time and dictionary.

The region objectRegistry is looked-up runTime with the name looked-up from the dictionary (defaults to polyMesh::defaultRegion)

Definition at line 94 of file regionFunctionObject.C.

regionFunctionObject ( const word name,
const objectRegistry obr,
const dictionary dict 
)

Construct from the region objectRegistry and dictionary.

Definition at line 113 of file regionFunctionObject.C.

~regionFunctionObject ( )
virtual

Destructor.

Definition at line 127 of file regionFunctionObject.C.

Member Function Documentation

bool foundObject ( const word fieldName) const
protected

Find field in the objectRegistry.

Definition at line 33 of file regionFunctionObjectTemplates.C.

References regionFunctionObject::lookupObject().

Here is the call graph for this function:

const ObjectType & lookupObject ( const word fieldName) const
protected

Lookup field from the objectRegistry.

Definition at line 43 of file regionFunctionObjectTemplates.C.

References regionFunctionObject::store().

Referenced by regionFunctionObject::foundObject(), moleFractions< ThermoType >::moleFractions(), and wallShearStress::write().

Here is the call graph for this function:

Here is the caller graph for this function:

bool store ( word fieldName,
const tmp< ObjectType > &  tfield,
bool  cacheable = false 
)
protected

Store the given field in the objectRegistry under the given name.

Definition at line 53 of file regionFunctionObjectTemplates.C.

References Foam::endl(), Foam::name(), Foam::nl, tmp< T >::ptr(), tmp< T >::ref(), and WarningInFunction.

Referenced by regionFunctionObject::lookupObject().

Here is the call graph for this function:

Here is the caller graph for this function:

bool writeObject ( const word fieldName)
protected

Write field if present in objectRegistry.

Definition at line 44 of file regionFunctionObject.C.

References regionFunctionObject::clearObject(), Foam::endl(), Log, Foam::name(), IOobject::name(), Foam::type(), and regIOobject::write().

Here is the call graph for this function:

bool clearObject ( const word fieldName)
protected

Clear field from the objectRegistry if present.

Definition at line 67 of file regionFunctionObject.C.

References regIOobject::ownedByRegistry().

Referenced by regionFunctionObject::writeObject().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "regionFunctionObject"  )

Runtime type information.

bool read ( const dictionary dict)
virtual

Member Data Documentation

const Time& time_
protected

Reference to the Time.

Definition at line 68 of file regionFunctionObject.H.

const objectRegistry& obr_
protected

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