Intermediate class for handling field expression function objects (e.g. blendingFactor
etc.) whereinto a single field is input.
More...
Public Member Functions | |
TypeName ("fieldExpression") | |
Runtime type information. More... | |
fieldExpression (const word &name, const Time &runTime, const dictionary &dict, const word &fieldName=word::null, const word &resultName=word::null) | |
Construct from Time and dictionary. More... | |
fieldExpression (const fieldExpression &)=delete | |
No copy construct. More... | |
void | operator= (const fieldExpression &)=delete |
No copy assignment. More... | |
virtual | ~fieldExpression ()=default |
Destructor. More... | |
virtual bool | read (const dictionary &dict) |
Read the fieldExpression data. More... | |
virtual bool | execute () |
Calculate the result field. More... | |
virtual bool | write () |
Write the result field. More... | |
virtual bool | clear () |
Clear the result field 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 ()=default |
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 ()=default |
Destructor. More... | |
template<class ObjectType > | |
const ObjectType * | lookupObjectPtr (const word &fieldName) const |
Deprecated(2018-10) More... | |
template<class ObjectType > | |
ObjectType * | lookupObjectRefPtr (const word &fieldName) const |
Deprecated(2018-10) More... | |
Public Member Functions inherited from stateFunctionObject | |
stateFunctionObject (const word &name, const Time &runTime) | |
Construct from components. More... | |
virtual | ~stateFunctionObject ()=default |
Destructor. More... | |
dictionary & | propertyDict () |
Return access to the property dictionary. More... | |
bool | foundProperty (const word &entryName) const |
Return true if the property exists. More... | |
label | getTrigger () const |
Get the current trigger index. More... | |
bool | setTrigger (const label triggeri) |
Set the current trigger index. More... | |
bool | getDict (const word &entryName, dictionary &dict) const |
Set dictionary, return true if set. More... | |
bool | getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const |
Set dictionary from named object, return true if set. More... | |
template<class Type > | |
Type | getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property. More... | |
template<class Type > | |
bool | getProperty (const word &entryName, Type &value) const |
Set generic property, return true if set. More... | |
template<class Type > | |
void | setProperty (const word &entryName, const Type &value) |
Add generic property. More... | |
template<class Type > | |
Type | getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve generic property from named object. More... | |
template<class Type > | |
bool | getObjectProperty (const word &objectName, const word &entryName, Type &value) const |
Set generic property from named object, return true if set. More... | |
template<class Type > | |
void | setObjectProperty (const word &objectName, const word &entryName, const Type &value) |
Add generic property from named object. More... | |
template<class Type > | |
void | setResult (const word &entryName, const Type &value) |
Add result. More... | |
template<class Type > | |
void | setObjectResult (const word &objectName, const word &entryName, const Type &value) |
Add result from named object. More... | |
template<class Type > | |
Type | getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result. More... | |
template<class Type > | |
Type | getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const |
Retrieve result from named object. More... | |
template<class Type > | |
bool | getObjectResult (const word &objectName, const word &entryName, Type &value) const |
Set result from named object, return true if set. More... | |
word | resultType (const word &entryName) const |
Retrieve the result type. More... | |
word | objectResultType (const word &objectName, const word &entryName) const |
Return the type of result. More... | |
List< word > | objectResultEntries () const |
Retrieve the result entries. More... | |
List< word > | objectResultEntries (const word &objectName) const |
Return result entries for named object. More... | |
void | writeResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. More... | |
void | writeResultEntries (const word &objectName, Ostream &os) const |
Write the results entries for named object to stream. More... | |
void | writeAllResultEntries (Ostream &os) const |
Write the results entries for all objects to stream. More... | |
Public Member Functions inherited from timeFunctionObject | |
timeFunctionObject (const word &name, const Time &runTime) | |
Construct from Time. More... | |
virtual | ~timeFunctionObject ()=default |
Destructor. More... | |
const Time & | time () const |
Return time database. More... | |
objectRegistry & | storedObjects () |
const objectRegistry & | storedObjects () const |
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 ()=default |
Destructor. More... | |
const word & | name () const |
Return the name of this functionObject. More... | |
virtual bool | execute (const label subIndex) |
Execute using the specified subIndex. 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 bool | filesModified () const |
Did any file get changed during execution? 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 | |
virtual bool | calc ()=0 |
Calculate the components of the field and return true if successful. More... | |
void | setResultName (const word &typeName, const word &defaultArg) |
Set the name of result field. More... | |
template<class Type > | |
bool | foundObject (const word &name, const bool verbose=true) const |
Return true if required objects are found. More... | |
Protected Member Functions inherited from fvMeshFunctionObject | |
fvMeshFunctionObject (const fvMeshFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const fvMeshFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from regionFunctionObject | |
virtual const objectRegistry & | obr () const |
The region or sub-region registry being used. More... | |
template<class ObjectType > | |
bool | foundObject (const word &fieldName) const |
Find object (eg, a field) in the (sub) objectRegistry. More... | |
template<class ObjectType > | |
const ObjectType * | cfindObject (const word &fieldName) const |
template<class ObjectType > | |
const ObjectType * | findObject (const word &fieldName) const |
template<class ObjectType > | |
ObjectType * | findObject (const word &fieldName) |
template<class ObjectType > | |
ObjectType * | getObjectPtr (const word &fieldName) const |
template<class ObjectType > | |
const ObjectType & | lookupObject (const word &fieldName) const |
Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
template<class ObjectType > | |
ObjectType & | lookupObjectRef (const word &fieldName) const |
Lookup and return object (eg, a field) from the (sub) objectRegistry. More... | |
template<class ObjectType > | |
bool | store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false) |
Store the field in the (sub) objectRegistry under the given name. More... | |
bool | writeObject (const word &fieldName) |
Write field if present in the (sub) objectRegistry. More... | |
bool | clearObject (const word &fieldName) |
Clear field from the (sub) objectRegistry if present. More... | |
void | clearObjects (const wordList &objNames) |
Clear fields from the (sub) objectRegistry if present. More... | |
regionFunctionObject (const regionFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const regionFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from stateFunctionObject | |
const IOdictionary & | stateDict () const |
Return a const reference to the state dictionary. More... | |
IOdictionary & | stateDict () |
Return non-const access to the state dictionary. More... | |
stateFunctionObject (const stateFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const stateFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from timeFunctionObject | |
void | clearOutputObjects (const wordList &objNames) |
Remove specified items from "functionObjectObjects". More... | |
timeFunctionObject (const timeFunctionObject &)=delete | |
No copy construct. More... | |
void | operator= (const timeFunctionObject &)=delete |
No copy assignment. More... | |
Protected Member Functions inherited from functionObject | |
word | scopedName (const word &name) const |
Return a scoped name, e.g. used to construct local field names. More... | |
Protected Attributes | |
word | fieldName_ |
Name of field to process. More... | |
word | resultName_ |
Name of result field. More... | |
Protected Attributes inherited from fvMeshFunctionObject | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
Protected Attributes inherited from regionFunctionObject | |
word | subRegistryName_ |
Name for alternative object registry. More... | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
const objectRegistry * | obrPtr_ |
Pointer to alternative (eg, sub-region) objectRegistry. More... | |
Protected Attributes inherited from timeFunctionObject | |
const Time & | time_ |
Reference to the time database. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from functionObject | |
static autoPtr< functionObject > | New (const word &name, const Time &runTime, const dictionary &dict) |
Select from dictionary, based on its "type" entry. More... | |
Public Attributes inherited from functionObject | |
bool | log |
Flag to write log into Info. More... | |
Static Public Attributes inherited from functionObject | |
static int | debug |
Flag to execute debug content. More... | |
static bool | postProcess |
Global post-processing mode switch. More... | |
static word | outputPrefix |
Directory prefix. More... | |
Intermediate class for handling field expression function objects (e.g. blendingFactor
etc.) whereinto a single field is input.
system/controlDict.functions
: <userDefinedSubDictName1> { // Mandatory and other optional entries ... // Optional (inherited) entries (runtime modifiable) field <field>; result <fieldResult>; }
where the entries mean:
Property | Description | Type | Req'd | Dflt |
---|---|---|---|---|
field | Name of the operand field | word | yes | - |
result | Name of the output field | word | no | <FO>(<field>) |
Definition at line 103 of file fieldExpression.H.
fieldExpression | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict, | ||
const word & | fieldName = word::null , |
||
const word & | resultName = word::null |
||
) |
Construct from Time and dictionary.
Definition at line 73 of file fieldExpression.C.
References dict, and Foam::blockMeshTools::read().
|
delete |
No copy construct.
|
virtualdefault |
Destructor.
|
protectedpure virtual |
Calculate the components of the field and return true if successful.
Implemented in heatTransferCoeff, and reactingEulerHtcModel.
Set the name of result field.
Definition at line 46 of file fieldExpression.C.
Return true if required objects are found.
Definition at line 34 of file fieldExpressionTemplates.C.
References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::name(), and Foam::Warning.
TypeName | ( | "fieldExpression" | ) |
Runtime type information.
|
delete |
No copy assignment.
|
virtual |
Read the fieldExpression data.
Reimplemented from regionFunctionObject.
Reimplemented in heatTransferCoeff, reference, reactingEulerHtcModel, stabilityBlendingFactor, pressure, log, pow, blendingFactor, randomise, CourantNo, and PecletNo.
Definition at line 91 of file fieldExpression.C.
References dict, fieldExpression::fieldName_, regionFunctionObject::read(), and fieldExpression::resultName_.
Referenced by reactingEulerHtcModel::read(), CourantNo::read(), randomise::read(), blendingFactor::read(), pow::read(), reference::read(), log::read(), heatTransferCoeff::read(), pressure::read(), and stabilityBlendingFactor::read().
|
virtual |
Calculate the result field.
Implements functionObject.
Definition at line 106 of file fieldExpression.C.
References clear(), Foam::endl(), Foam::name(), Foam::type(), and Foam::Warning.
|
virtual |
Write the result field.
Implements functionObject.
Reimplemented in stabilityBlendingFactor, blendingFactor, and components.
Definition at line 124 of file fieldExpression.C.
Referenced by blendingFactor::write().
|
virtual |
Clear the result field from the objectRegistry.
Reimplemented in components.
Definition at line 130 of file fieldExpression.C.
|
protected |
Name of field to process.
Definition at line 112 of file fieldExpression.H.
Referenced by fieldExpression::read().
|
protected |
Name of result field.
Definition at line 115 of file fieldExpression.H.
Referenced by heatTransferCoeff::calc(), and fieldExpression::read().