Public Member Functions | |
TypeName ("fieldsExpression") | |
Runtime type information. More... | |
fieldsExpression (const word &name, const Time &runTime, const dictionary &dict, const wordList &fieldNames=wordList::null(), const word &resultName=word::null) | |
Construct from Time and dictionary. More... | |
virtual | ~fieldsExpression () |
Destructor. More... | |
virtual bool | read (const dictionary &) |
Read the fieldsExpression data. More... | |
virtual bool | execute () |
Calculate the result fields. More... | |
virtual bool | write () |
Write the result fields. More... | |
virtual bool | clear () |
Clear the result fields from the objectRegistry. More... | |
Public Member Functions inherited from fvMeshFunctionObject | |
TypeName ("fvMeshFunctionObject") | |
Runtime type information. More... | |
fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict) | |
Construct from Time and dictionary. More... | |
fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict) | |
Construct from the region objectRegistry and dictionary. More... | |
virtual | ~fvMeshFunctionObject () |
Destructor. More... | |
Public Member Functions inherited from regionFunctionObject | |
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... | |
Public Member Functions inherited from functionObject | |
virtual const word & | type () 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< functionObject > | clone () const |
Return clone. More... | |
virtual | ~functionObject () |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | end () |
Called when Time::run() determines that the time-loop exits. More... | |
virtual bool | setTimeStep () |
Called by Time::setDeltaT(). Allows the function object to override. More... | |
virtual scalar | timeToNextWrite () |
Called by Time::adjustTimeStep(). Allows the function object to. 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 | |
void | setResultName (const word &typeName, const wordList &defaultArg=wordList::null()) |
template<class Type , class FOType > | |
bool | calcFieldTypes (FOType &fo) |
Call 'calcFieldType' for the given functionObject. More... | |
template<class Type , class FOType > | |
bool | calcType (FOType &fo) |
Call 'calcFieldTypes' for the given 'Type' and functionObject. More... | |
template<class FOType > | |
bool | calcAllTypes (FOType &fo) |
Call 'calcType' for the given functionObject. More... | |
virtual bool | calc ()=0 |
Protected Member Functions inherited from regionFunctionObject | |
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 object from the objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) |
Lookup non-const object reference 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 | |
wordList | fieldNames_ |
Names of fields to process. More... | |
word | resultName_ |
Name of result fields. More... | |
Protected Attributes inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
const Time & | time_ |
Reference to the Time. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (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... | |
Definition at line 53 of file fieldsExpression.H.
fieldsExpression | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict, | ||
const wordList & | fieldNames = wordList::null() , |
||
const word & | resultName = word::null |
||
) |
Construct from Time and dictionary.
Definition at line 75 of file fieldsExpression.C.
References Foam::exit(), Foam::FatalIOError, FatalIOErrorInFunction, Foam::read(), and Foam::type().
|
virtual |
Destructor.
Definition at line 102 of file fieldsExpression.C.
|
protected |
Definition at line 43 of file fieldsExpression.C.
|
protected |
Call 'calcFieldType' for the given functionObject.
for 'volField' and 'surfaceField' field types
Definition at line 32 of file fieldsExpressionTemplates.C.
References fieldsExpression::fieldNames_, fieldsExpression::resultName_, and regionFunctionObject::store().
|
protected |
Call 'calcFieldTypes' for the given 'Type' and functionObject.
Definition at line 61 of file fieldsExpressionTemplates.C.
|
protected |
Call 'calcType' for the given functionObject.
for each primitive type
Definition at line 68 of file fieldsExpressionTemplates.C.
|
protectedpure virtual |
TypeName | ( | "fieldsExpression" | ) |
Runtime type information.
|
virtual |
Read the fieldsExpression data.
Reimplemented from regionFunctionObject.
Definition at line 108 of file fieldsExpression.C.
References dictionary::found(), dictionary::lookup(), and regionFunctionObject::read().
|
virtual |
Calculate the result fields.
Implements functionObject.
Definition at line 126 of file fieldsExpression.C.
References clear(), Foam::endl(), Foam::name(), Foam::type(), and Foam::Warning.
|
virtual |
Write the result fields.
Implements functionObject.
Definition at line 146 of file fieldsExpression.C.
|
virtual |
Clear the result fields from the objectRegistry.
Definition at line 152 of file fieldsExpression.C.
|
protected |
Names of fields to process.
Definition at line 62 of file fieldsExpression.H.
Referenced by add::calcFieldType(), subtract::calcFieldType(), and fieldsExpression::calcFieldTypes().
|
protected |
Name of result fields.
Definition at line 65 of file fieldsExpression.H.
Referenced by fieldsExpression::calcFieldTypes().