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...
|
| 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...
|
|
| 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...
|
|
| 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...
|
|
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...
|
|
| stateFunctionObject (const word &name, const Time &runTime) |
| Construct from components. More...
|
|
virtual | ~stateFunctionObject ()=default |
| Destructor. More...
|
|
dictionary & | propertyDict () |
| Return access to the property dictionary. More...
|
|
bool | foundProperty (const word &entryName) const |
| Return true if the property exists. More...
|
|
label | getTrigger () const |
| Get the current trigger index. More...
|
|
bool | setTrigger (const label triggeri) |
| Set the current 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...
|
|
List< word > | objectResultEntries () const |
| Retrieve the result entries. More...
|
|
List< word > | 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...
|
|
| timeFunctionObject (const word &name, const Time &runTime) |
| Construct from Time. More...
|
|
virtual | ~timeFunctionObject ()=default |
| Destructor. More...
|
|
const Time & | time () const |
| Return time database. More...
|
|
objectRegistry & | storedObjects () |
|
const objectRegistry & | storedObjects () const |
|
virtual const word & | type () 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< functionObject > | clone () const |
| Return clone. More...
|
|
virtual | ~functionObject ()=default |
| Destructor. More...
|
|
const word & | name () const |
| Return the name of this functionObject. More...
|
|
virtual bool | execute (const label subIndex) |
| Execute using the specified subIndex. 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...
|
|
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 ("libreactingEulerFoamFunctionObjects.so");
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.