Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | List of all members
derivedFields Class Reference
FunctionObjects » Field function objects

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

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

Public Types

enum  derivedType { NONE = 0, MASS_FLUX, TOTAL_PRESSURE, UNKNOWN }
 

Public Member Functions

 TypeName ("derivedFields")
 
 derivedFields (const word &name, const Time &runTime, const dictionary &dict)
 
 derivedFields (const derivedFields &)=delete
 
void operator= (const derivedFields &)=delete
 
virtual ~derivedFields ()=default
 
void removeDerivedFields ()
 
virtual bool read (const dictionary &dict)
 
virtual bool execute ()
 
virtual bool write ()
 
virtual void updateMesh (const mapPolyMesh &mpm)
 
virtual void movePoints (const polyMesh &m)
 
- Public Member Functions inherited from fvMeshFunctionObject
 TypeName ("fvMeshFunctionObject")
 
 fvMeshFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 fvMeshFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~fvMeshFunctionObject ()=default
 
- Public Member Functions inherited from regionFunctionObject
 TypeName ("regionFunctionObject")
 
 regionFunctionObject (const word &name, const Time &runTime, const dictionary &dict)
 
 regionFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
 
virtual ~regionFunctionObject ()=default
 
template<class ObjectType >
const ObjectType * lookupObjectPtr (const word &fieldName) const
 
template<class ObjectType >
ObjectType * lookupObjectRefPtr (const word &fieldName) const
 
- Public Member Functions inherited from stateFunctionObject
 stateFunctionObject (const word &name, const Time &runTime)
 
virtual ~stateFunctionObject ()=default
 
dictionary & propertyDict ()
 
bool foundProperty (const word &entryName) const
 
void clearTrigger ()
 
label getTrigger () const
 
bool setTrigger (const label triggeri, bool increaseOnly=true)
 
bool getDict (const word &entryName, dictionary &dict) const
 
bool getObjectDict (const word &objectName, const word &entryName, dictionary &dict) const
 
template<class Type >
Type getProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getProperty (const word &entryName, Type &value) const
 
template<class Type >
void setProperty (const word &entryName, const Type &value)
 
template<class Type >
Type getObjectProperty (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectProperty (const word &objectName, const word &entryName, Type &value) const
 
template<class Type >
void setObjectProperty (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
void setResult (const word &entryName, const Type &value)
 
template<class Type >
void setObjectResult (const word &objectName, const word &entryName, const Type &value)
 
template<class Type >
Type getResult (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
Type getObjectResult (const word &objectName, const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
bool getObjectResult (const word &objectName, const word &entryName, Type &value) const
 
word resultType (const word &entryName) const
 
word objectResultType (const word &objectName, const word &entryName) const
 
wordList objectResultEntries () const
 
wordList objectResultEntries (const word &objectName) const
 
void writeResultEntries (Ostream &os) const
 
void writeResultEntries (const word &objectName, Ostream &os) const
 
void writeAllResultEntries (Ostream &os) const
 
- Public Member Functions inherited from timeFunctionObject
 timeFunctionObject (const word &name, const Time &runTime)
 
virtual ~timeFunctionObject ()=default
 
const Time & time () const
 
objectRegistry & storedObjects ()
 
const objectRegistry & storedObjects () 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)
 
autoPtr< functionObject > clone () const
 
virtual ~functionObject ()=default
 
virtual const word & type () const =0
 
const word & name () const noexcept
 
bool useNamePrefix () const noexcept
 
bool useNamePrefix (bool on) noexcept
 
virtual bool execute (const label subIndex)
 
virtual bool end ()
 
virtual bool adjustTimeStep ()
 
virtual bool filesModified () const
 

Static Public Attributes

static const Enum< derivedType > knownNames
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 
static bool defaultUseNamePrefix
 
static word outputPrefix
 

Protected Member Functions

bool add_rhoU (const word &derivedName)
 
bool add_pTotal (const word &derivedName)
 
- Protected Member Functions inherited from fvMeshFunctionObject
 fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
 
void operator= (const fvMeshFunctionObject &)=delete
 
- Protected Member Functions inherited from regionFunctionObject
virtual const objectRegistry & obr () const
 
template<class ObjectType >
bool foundObject (const word &fieldName) const
 
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
 
template<class ObjectType >
ObjectType & lookupObjectRef (const word &fieldName) const
 
template<class ObjectType >
bool store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
 
template<class ObjectType >
bool storeInDb (const word &fieldName, const tmp< ObjectType > &tfield, const objectRegistry &obr)
 
bool writeObject (const word &fieldName)
 
bool clearObject (const word &fieldName)
 
void clearObjects (const wordList &objNames)
 
 regionFunctionObject (const regionFunctionObject &)=delete
 
void operator= (const regionFunctionObject &)=delete
 
- Protected Member Functions inherited from stateFunctionObject
const functionObjects::properties & stateDict () const
 
functionObjects::properties & stateDict ()
 
 stateFunctionObject (const stateFunctionObject &)=delete
 
void operator= (const stateFunctionObject &)=delete
 
- Protected Member Functions inherited from timeFunctionObject
void clearOutputObjects (const wordList &objNames)
 
 timeFunctionObject (const timeFunctionObject &)=delete
 
void operator= (const timeFunctionObject &)=delete
 
- Protected Member Functions inherited from functionObject
word scopedName (const word &name) const
 

Protected Attributes

List< derivedType > derivedTypes_
 
scalar rhoRef_
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMesh & mesh_
 
- Protected Attributes inherited from regionFunctionObject
word subRegistryName_
 
const objectRegistry & obr_
 
const objectRegistry * obrPtr_
 
- Protected Attributes inherited from timeFunctionObject
const Time & time_
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObject > New (const word &name, const Time &runTime, const dictionary &dict)
 
- Public Attributes inherited from functionObject
bool log
 

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 159 of file derivedFields.H.

Member Enumeration Documentation

◆ derivedType

enum derivedType
Enumerator
NONE 

"none"

MASS_FLUX 

"rhoU"

TOTAL_PRESSURE 

"pTotal"

UNKNOWN 

Definition at line 168 of file derivedFields.H.

Constructor & Destructor Documentation

◆ derivedFields() [1/2]

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

Definition at line 168 of file derivedFields.C.

References dict, and Foam::blockMeshTools::read().

Here is the call graph for this function:

◆ derivedFields() [2/2]

derivedFields ( const derivedFields &  )
delete

◆ ~derivedFields()

virtual ~derivedFields ( )
virtualdefault

Member Function Documentation

◆ add_rhoU()

bool add_rhoU ( const word &  derivedName)
protected

◆ add_pTotal()

bool add_pTotal ( const word &  derivedName)
protected

◆ TypeName()

TypeName ( "derivedFields"  )

◆ operator=()

void operator= ( const derivedFields &  )
delete

◆ removeDerivedFields()

void removeDerivedFields ( )

Definition at line 311 of file derivedFields.C.

◆ read()

bool read ( const dictionary &  dict)
virtual

Reimplemented from regionFunctionObject.

Definition at line 184 of file derivedFields.C.

References derivedFields::derivedTypes_, dict, Foam::flatOutput(), forAll, Foam::Info, Foam::glTF::key(), derivedFields::knownNames, Enum::lookup(), Foam::nl, regionFunctionObject::read(), List::resize(), derivedFields::rhoRef_, functionObject::type(), and WarningInFunction.

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Implements functionObject.

Definition at line 241 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

Implements functionObject.

Definition at line 280 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

Reimplemented from functionObject.

Definition at line 320 of file derivedFields.C.

References mapPolyMesh::mesh().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh &  m)
virtual

Reimplemented from functionObject.

Definition at line 329 of file derivedFields.C.

Member Data Documentation

◆ knownNames

const Foam::Enum< Foam::functionObjects::derivedFields::derivedType > knownNames
static

Definition at line 177 of file derivedFields.H.

Referenced by derivedFields::read().

◆ derivedTypes_

List<derivedType> derivedTypes_
protected

Definition at line 185 of file derivedFields.H.

Referenced by derivedFields::read().

◆ rhoRef_

scalar rhoRef_
protected

Definition at line 188 of file derivedFields.H.

Referenced by derivedFields::read().

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

Copyright © 2011-2018  OpenFOAM | OPENFOAM® is a registered trademark of OpenCFD Ltd.

Generated by   doxygen 1.8.17