Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
fieldExpression Class Referenceabstract
Inheritance diagram for fieldExpression:
Inheritance graph
[legend]
Collaboration diagram for fieldExpression:
Collaboration graph
[legend]

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...
 
virtual ~fieldExpression ()
 Destructor. More...
 
virtual bool read (const dictionary &)
 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 ()
 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 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 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

virtual bool calc ()=0
 
void setResultName (const word &typeName, const word &defaultArg)
 
template<class Type >
bool foundObject (const word &name)
 
- 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

word fieldName_
 Name of field to process. More...
 
word resultName_
 Name of result field. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
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

See also
Foam::functionObjects::fvMeshFunctionObject
Source files

Definition at line 53 of file fieldExpression.H.

Constructor & Destructor Documentation

◆ fieldExpression()

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 70 of file fieldExpression.C.

References Foam::read().

Here is the call graph for this function:

◆ ~fieldExpression()

~fieldExpression ( )
virtual

Destructor.

Definition at line 88 of file fieldExpression.C.

Member Function Documentation

◆ calc()

virtual bool calc ( )
protectedpure virtual

◆ setResultName()

void setResultName ( const word typeName,
const word defaultArg 
)
protected

Definition at line 43 of file fieldExpression.C.

◆ foundObject()

bool foundObject ( const word name)
protected

Definition at line 32 of file fieldExpressionTemplates.C.

References Foam::endl(), Foam::name(), Foam::type(), and Foam::Warning.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "fieldExpression"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the fieldExpression data.

Reimplemented from regionFunctionObject.

Reimplemented in pressure, CourantNo, blendingFactor, scale, randomise, and log.

Definition at line 94 of file fieldExpression.C.

References dictionary::found(), dictionary::lookup(), and regionFunctionObject::read().

Referenced by log::read(), randomise::read(), scale::read(), blendingFactor::read(), and CourantNo::read().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ execute()

bool execute ( )
virtual

Calculate the result field.

Implements functionObject.

Definition at line 112 of file fieldExpression.C.

References clear(), Foam::endl(), Foam::name(), Foam::type(), and Foam::Warning.

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write the result field.

Implements functionObject.

Reimplemented in components.

Definition at line 132 of file fieldExpression.C.

◆ clear()

bool clear ( )
virtual

Clear the result field from the objectRegistry.

Reimplemented in components.

Definition at line 138 of file fieldExpression.C.

Member Data Documentation

◆ fieldName_

word fieldName_
protected

Name of field to process.

Definition at line 62 of file fieldExpression.H.

◆ resultName_

word resultName_
protected

Name of result field.

Definition at line 65 of file fieldExpression.H.


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