derivedFields Class Reference

Computes two predefined derived fields, i.e. rhoU, and pTotal, where the defined fields are hard-coded as follows: More...

Inheritance diagram for derivedFields:
[legend]
Collaboration diagram for derivedFields:
[legend]

Public Types

enum  derivedType { NONE = 0 , MASS_FLUX , TOTAL_PRESSURE , UNKNOWN }
 Options for the derived/calculated field type. More...
 

Public Member Functions

 TypeName ("derivedFields")
 Run-time type information. More...
 
 derivedFields (const word &name, const Time &runTime, const dictionary &dict)
 Construct from Time and dictionary. More...
 
 derivedFields (const derivedFields &)=delete
 No copy construct. More...
 
void operator= (const derivedFields &)=delete
 No copy assignment. More...
 
virtual ~derivedFields ()=default
 Destructor. More...
 
void removeDerivedFields ()
 Remove (checkOut) derived fields from the object registry. More...
 
virtual bool read (const dictionary &dict)
 Read the data. More...
 
virtual bool execute ()
 Calculate the derived fields. More...
 
virtual bool write ()
 Write derived fields. More...
 
virtual void updateMesh (const mapPolyMesh &mpm)
 Update for changes of mesh. More...
 
virtual void movePoints (const polyMesh &m)
 Update for mesh point-motion. 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...
 
virtual bool read (const dictionary &dict)
 Read optional controls. 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...
 
dictionarypropertyDict ()
 Return access to the property dictionary. More...
 
bool foundProperty (const word &entryName) const
 Return true if the property exists. More...
 
void clearTrigger ()
 Remove the trigger index from the properties. More...
 
label getTrigger () const
 Get the current trigger index. More...
 
bool setTrigger (const label triggeri)
 Set new 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...
 
wordList objectResultEntries () const
 Retrieve the result entries. More...
 
wordList 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 Timetime () const
 Return time database. More...
 
objectRegistrystoredObjects ()
 
const objectRegistrystoredObjects () const
 
- Public Member Functions inherited from functionObject
 declareRunTimeSelectionTable (autoPtr, functionObject, dictionary,(const word &name, const Time &runTime, const dictionary &dict),(name, runTime, dict))
 
 functionObject (const word &name, const bool withNamePrefix=defaultUseNamePrefix)
 Construct from components. More...
 
autoPtr< functionObjectclone () const
 Return clone. More...
 
virtual ~functionObject ()=default
 Destructor. More...
 
virtual const wordtype () const =0
 Runtime type information. More...
 
const wordname () const noexcept
 Return the name of this functionObject. More...
 
bool useNamePrefix () const noexcept
 Return the flag for adding a scoping name prefix. More...
 
bool useNamePrefix (bool on) noexcept
 Modify the flag for adding a scoping name prefix. More...
 
virtual bool read (const dictionary &dict)
 Read and set the function object if its data have changed. More...
 
virtual bool execute ()=0
 Called at each ++ or += of the time-loop. More...
 
virtual bool execute (const label subIndex)
 Execute using the specified subIndex. 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 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...
 

Static Public Attributes

static const Enum< derivedTypeknownNames
 Names for derivedType. 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 bool defaultUseNamePrefix
 Global default for useNamePrefix. More...
 
static word outputPrefix
 Directory prefix. More...
 

Protected Member Functions

bool add_rhoU (const word &derivedName)
 Hard-coded derived field (rho * U) More...
 
bool add_pTotal (const word &derivedName)
 Hard-coded derived field (p + 1/2 * rho * U) 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 objectRegistryobr () 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...
 
template<class ObjectType >
bool storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
 Store the field in an optional 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 functionObjects::propertiesstateDict () const
 Return a const reference to the state dictionary. More...
 
functionObjects::propertiesstateDict ()
 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 (prefixed) name. More...
 

Protected Attributes

List< derivedTypederivedTypes_
 List of derived field (types) to create. More...
 
scalar rhoRef_
 Reference density (to convert from kinematic to static pressure) More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 Name for alternative object registry. More...
 
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
const objectRegistryobrPtr_
 Pointer to alternative (eg, sub-region) objectRegistry. More...
 
- Protected Attributes inherited from timeFunctionObject
const Timetime_
 Reference to the time database. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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...
 

Detailed Description

Computes two predefined derived fields, i.e. rhoU, and pTotal, where the defined fields are hard-coded as follows:

\( rhoU \) = \( \rho \vec U \)
\( pTotal \) = \( p + 1/2 \rho \, mag(\vec U)^2 \)

Operands:

Operand Type Location
input vol{Scalar,Vector}Field $FOAM_CASE/<time>/<inpField>
output file - -
output field vol{Scalar,Vector}Field $FOAM_CASE/<time>/<outField>
Usage
Minimal example by using system/controlDict.functions:
derivedFields1
{
    // Mandatory entries (unmodifiable)
    type            derivedFields;
    libs            (fieldFunctionObjects);

    // Mandatory entries (runtime modifiable)
    derived         (rhoU pTotal);

    // Optional entries (runtime modifiable)
    rhoRef          1.0;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Req'd Dflt
type Type name: derivedFields word yes -
libs Library name: fieldFunctionObjects word yes -
derived Names of operand fields (rhoU/pTotal) word yes -
rhoRef Reference density for incompressible flows scalar no 1.0

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

See also
Source files

Definition at line 163 of file derivedFields.H.

Member Enumeration Documentation

◆ derivedType

Options for the derived/calculated field type.

Enumerator
NONE 

"none"

MASS_FLUX 

"rhoU"

TOTAL_PRESSURE 

"pTotal"

UNKNOWN 

Definition at line 172 of file derivedFields.H.

Constructor & Destructor Documentation

◆ derivedFields() [1/2]

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

Construct from Time and dictionary.

Definition at line 174 of file derivedFields.C.

References dict, Foam::name(), and derivedFields::read().

Here is the call graph for this function:

◆ derivedFields() [2/2]

derivedFields ( const derivedFields )
delete

No copy construct.

◆ ~derivedFields()

virtual ~derivedFields ( )
virtualdefault

Destructor.

Member Function Documentation

◆ add_rhoU()

bool add_rhoU ( const word derivedName)
protected

Hard-coded derived field (rho * U)

Returns
true if field did not previously exist

◆ add_pTotal()

bool add_pTotal ( const word derivedName)
protected

Hard-coded derived field (p + 1/2 * rho * U)

Returns
true if field did not previously exist

◆ TypeName()

TypeName ( "derivedFields"  )

Run-time type information.

◆ operator=()

void operator= ( const derivedFields )
delete

No copy assignment.

◆ removeDerivedFields()

void removeDerivedFields ( )

Remove (checkOut) derived fields from the object registry.

Definition at line 318 of file derivedFields.C.

◆ read()

bool read ( const dictionary dict)
virtual

Read the data.

Reimplemented from regionFunctionObject.

Definition at line 191 of file derivedFields.C.

References dict, Foam::flatOutput(), forAll, Foam::Info, Foam::nl, kEpsilonLopesdaCosta< BasicTurbulenceModel >::read(), Foam::type(), and WarningInFunction.

Referenced by derivedFields::derivedFields().

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

◆ execute()

bool execute ( )
virtual

Calculate the derived fields.

Implements functionObject.

Definition at line 248 of file derivedFields.C.

References Foam::calc_pTotal(), Foam::calc_rhoU(), Foam::endl(), Log, Foam::nl, and Foam::type().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write derived fields.

Implements functionObject.

Definition at line 287 of file derivedFields.C.

References Foam::endl(), Log, Foam::name(), Foam::nl, Foam::type(), and Ostream::write().

Here is the call graph for this function:

◆ updateMesh()

void updateMesh ( const mapPolyMesh mpm)
virtual

Update for changes of mesh.

Reimplemented from functionObject.

Definition at line 327 of file derivedFields.C.

References mapPolyMesh::mesh().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh m)
virtual

Update for mesh point-motion.

Reimplemented from functionObject.

Definition at line 336 of file derivedFields.C.

Member Data Documentation

◆ knownNames

Names for derivedType.

Definition at line 181 of file derivedFields.H.

◆ derivedTypes_

List<derivedType> derivedTypes_
protected

List of derived field (types) to create.

Definition at line 189 of file derivedFields.H.

◆ rhoRef_

scalar rhoRef_
protected

Reference density (to convert from kinematic to static pressure)

Definition at line 192 of file derivedFields.H.


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