phaseForces Class Reference

This function object calculates and outputs the blended interfacial forces acting on a given phase, i.e. drag, virtual mass, lift, wall-lubrication and turbulent dispersion. Note that it works only in run-time processing mode and in combination with the reactingEulerFoam solvers. More...

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

Public Member Functions

 TypeName ("phaseForces")
 Runtime type information. More...
 
 phaseForces (const word &name, const Time &runTime, const dictionary &)
 Construct from Time and dictionary. More...
 
virtual ~phaseForces ()
 Destructor. More...
 
virtual bool read (const dictionary &dict)
 Read the input data. More...
 
virtual bool execute ()
 Calculate the force fields. More...
 
virtual bool write ()
 Write the force fields. More...
 
template<class modelType >
Foam::tmp< Foam::volVectorFieldnonDragForce (const phasePair &pair) const
 
- 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...
 

Protected Member Functions

template<class modelType >
tmp< volVectorFieldnonDragForce (const phasePair &key) const
 Evaluate and return non-drag force. 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

HashPtrTable< volVectorFieldforceFields_
 
const phaseModelphase_
 Phase for which forces are evaluated. More...
 
const phaseSystemfluid_
 Constant access to phaseSystem. 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...
 
- 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...
 

Detailed Description

This function object calculates and outputs the blended interfacial forces acting on a given phase, i.e. drag, virtual mass, lift, wall-lubrication and turbulent dispersion. Note that it works only in run-time processing mode and in combination with the reactingEulerFoam solvers.

For a simulation involving more than two phases, the accumulated force is calculated by looping over all phasePairs involving that phase. The fields are stored in the database so that they can be processed further, e.g. with the fieldAveraging functionObject.

Example of function object specification:

phaseForces.water
{
    type phaseForces;
    libs (reactingEulerFoamFunctionObjects);
    writeControl    writeTime;
    writeInterval   1;

    ...

    phaseName       water;
}
Usage
Property Description Required Default value
type type name: phaseForces yes
phaseName Name of evaluated phase yes
See also
Foam::BlendedInterfacialModel Foam::functionObjects::fvMeshFunctionObject Foam::functionObject
Source files

Definition at line 103 of file phaseForces.H.

Constructor & Destructor Documentation

◆ phaseForces()

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

Construct from Time and dictionary.

Definition at line 71 of file phaseForces.C.

References phasePair::contains(), dict, Foam::dimForce, Foam::dimVolume, phaseForces::fluid_, forAllConstIter, phaseForces::forceFields_, phaseSystem::foundBlendedSubModel(), IOobject::groupName(), fvMeshFunctionObject::mesh_, phaseModel::name(), phasePairKey::ordered(), phaseForces::phase_, phaseSystem::phasePairs(), phaseForces::read(), fvMesh::time(), Time::timeName(), and ensightPTraits< Type >::typeName.

Here is the call graph for this function:

◆ ~phaseForces()

~phaseForces ( )
virtual

Destructor.

Definition at line 214 of file phaseForces.C.

Member Function Documentation

◆ nonDragForce() [1/2]

tmp< volVectorField > nonDragForce ( const phasePair key) const
protected

Evaluate and return non-drag force.

◆ TypeName()

TypeName ( "phaseForces"  )

Runtime type information.

◆ read()

bool read ( const dictionary dict)
virtual

Read the input data.

Reimplemented from regionFunctionObject.

Definition at line 220 of file phaseForces.C.

References dict, and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Referenced by phaseForces::phaseForces().

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

◆ execute()

bool execute ( )
virtual

Calculate the force fields.

Implements functionObject.

Definition at line 228 of file phaseForces.C.

References phasePair::contains(), phaseModel::DUDt(), forAllConstIter, forAllIter, phasePairKey::ordered(), phasePair::otherPhase(), Foam::type(), and phaseModel::U().

Here is the call graph for this function:

◆ write()

bool write ( )
virtual

Write the force fields.

Implements functionObject.

Definition at line 292 of file phaseForces.C.

References forAllIter, and Foam::name().

Here is the call graph for this function:

◆ nonDragForce() [2/2]

Foam::tmp< Foam::volVectorField > nonDragForce ( const phasePair pair) const

Definition at line 53 of file phaseForces.C.

References phaseForces::fluid_, phaseSystem::lookupBlendedSubModel(), phasePair::phase1(), and phaseForces::phase_.

Here is the call graph for this function:

Member Data Documentation

◆ forceFields_

HashPtrTable<volVectorField> forceFields_
protected

Definition at line 120 of file phaseForces.H.

Referenced by phaseForces::phaseForces().

◆ phase_

const phaseModel& phase_
protected

Phase for which forces are evaluated.

Definition at line 123 of file phaseForces.H.

Referenced by phaseForces::nonDragForce(), and phaseForces::phaseForces().

◆ fluid_

const phaseSystem& fluid_
protected

Constant access to phaseSystem.

Definition at line 126 of file phaseForces.H.

Referenced by phaseForces::nonDragForce(), and phaseForces::phaseForces().


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