Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
momentumError Class Reference
FunctionObjects » Forces function objects

Computes balance terms for the steady momentum equation. More...

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

Public Member Functions

 TypeName ("momentumError")
 
 momentumError (const word &name, const Time &runTime, const dictionary &dict)
 
 momentumError (const momentumError &)=delete
 
void operator= (const momentumError &)=delete
 
virtual ~momentumError ()=default
 
virtual bool read (const dictionary &)
 
virtual bool execute ()
 
virtual bool write ()
 
void calcMomentError ()
 
- 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
 
virtual void updateMesh (const mapPolyMesh &mpm)
 
virtual void movePoints (const polyMesh &mesh)
 

Protected Member Functions

tmp< volVectorField > divDevRhoReff ()
 
- 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

word pName_
 
word UName_
 
word phiName_
 
autoPtr< Detail::zoneSubSet > zoneSubSetPtr_
 
- 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
 
- Static Public Attributes inherited from functionObject
static int debug
 
static bool postProcess
 
static bool defaultUseNamePrefix
 
static word outputPrefix
 

Detailed Description

Computes balance terms for the steady momentum equation.

Operands:

Operand Type Location
input - -
output file - -
output field volVectorField $FOAM_CASE/<time>/<file>
Usage
Minimal example by using system/controlDict.functions: 
momentumError1
{
    // Mandatory entries (unmodifiable)
    type        momentumError;
    libs        (fieldFunctionObjects);

    // Optional entries (runtime modifiable)
    p           <pName>;
    U           <UName>;
    phi         <phiName>;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
type Type name: momentumError word yes -
libs Library name: fieldFunctionObjects word yes -
p Name of pressure field word no p
U Name of velocity field word no U
phi Name of flux field word no phi

The inherited entries are elaborated in:

Usage by the postProcess utility is not available.

Note
  • Optionally the user can specify cellZones to create a sub-mesh for the momentumError calculation.
See also
Source files

Definition at line 157 of file momentumError.H.

Constructor & Destructor Documentation

◆ momentumError() [1/2]

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

Definition at line 130 of file momentumError.C.

References dict, Foam::dimVelocity, Foam::dimVolume, IOobject::NO_READ, IOobject::NO_WRITE, phi, Foam::read(), fvMesh::time(), and Time::timeName().

Here is the call graph for this function:

◆ momentumError() [2/2]

momentumError ( const momentumError &  )
delete

◆ ~momentumError()

virtual ~momentumError ( )
virtualdefault

Member Function Documentation

◆ divDevRhoReff()

Foam::tmp< Foam::volVectorField > divDevRhoReff ( )
protected

Definition at line 45 of file momentumError.C.

References Foam::dev2(), Foam::fvc::div(), Foam::fvc::grad(), fvMeshSubset::interpolate(), Foam::fvc::laplacian(), tmp::New(), GeometricField::null(), turbulenceModel::propertiesName, Foam::T(), trho, turb, U, momentumError::UName_, and momentumError::zoneSubSetPtr_.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "momentumError"  )

◆ operator=()

void operator= ( const momentumError &  )
delete

◆ read()

bool read ( const dictionary &  dict)
virtual

Reimplemented from regionFunctionObject.

Definition at line 200 of file momentumError.C.

References dict, Foam::endl(), Foam::Info, Foam::name(), Foam::nl, regionFunctionObject::read(), and Foam::type().

Here is the call graph for this function:

◆ execute()

bool execute ( )
virtual

Implements functionObject.

Definition at line 279 of file momentumError.C.

◆ write()

bool write ( )
virtual

Implements functionObject.

Definition at line 287 of file momentumError.C.

References Foam::endl(), Log, objectRegistry::lookupObject(), Foam::name(), fvMeshSubset::subMesh(), and Foam::type().

Here is the call graph for this function:

◆ calcMomentError()

void calcMomentError ( )

Definition at line 237 of file momentumError.C.

References Foam::fvc::div(), Foam::fvc::grad(), fvMeshSubset::interpolate(), objectRegistry::lookupObjectRef(), p, phi, and U.

Here is the call graph for this function:

Member Data Documentation

◆ pName_

word pName_
protected

Definition at line 168 of file momentumError.H.

◆ UName_

word UName_
protected

Definition at line 171 of file momentumError.H.

Referenced by momentumError::divDevRhoReff().

◆ phiName_

word phiName_
protected

Definition at line 174 of file momentumError.H.

◆ zoneSubSetPtr_

autoPtr<Detail::zoneSubSet> zoneSubSetPtr_
protected

Definition at line 177 of file momentumError.H.

Referenced by momentumError::divDevRhoReff().

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