This function object calculates and outputs the blended interfacial forces acting on a given phase (drag, virtual mass, lift, wall-lubrication and turbulent dispersion). It works only 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. 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...

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 ()
	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 ()
	Destructor. More...

Public Member Functions inherited from functionObject
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 ()
	Destructor. More...

const word &	name () const
	Return the name of this functionObject. More...

virtual bool	end ()
	Called when Time::run() determines that the time-loop exits. More...

virtual bool	setTimeStep ()
	Called by Time::setDeltaT(). Allows the function object to override. More...

virtual scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the function object to. 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...

Additional Inherited Members
Static Public Member Functions inherited from functionObject
static autoPtr< functionObject >	New (const word &name, const Time &, const dictionary &)
	Select from dictionary, based on its "type" entry. More...

Public Attributes inherited from functionObject
Switch	log
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static int	debug

static bool	postProcess
	Global post-processing mode switch. More...

Protected Member Functions inherited from regionFunctionObject
template<class ObjectType >
bool	foundObject (const word &fieldName) const
	Find field in the objectRegistry. More...

template<class ObjectType >
const ObjectType &	lookupObject (const word &fieldName) const
	Lookup object from the objectRegistry. More...

template<class ObjectType >
ObjectType &	lookupObjectRef (const word &fieldName)
	Lookup non-const object reference from the objectRegistry. More...

template<class ObjectType >
bool	store (word &fieldName, const tmp< ObjectType > &tfield, bool cacheable=false)
	Store the given field in the objectRegistry under the given name. More...

bool	writeObject (const word &fieldName)
	Write field if present in objectRegistry. More...

bool	clearObject (const word &fieldName)
	Clear field from the objectRegistry if present. More...

Protected Attributes inherited from fvMeshFunctionObject
const fvMesh &	mesh_
	Reference to the fvMesh. More...

Protected Attributes inherited from regionFunctionObject
const Time &	time_
	Reference to the Time. More...

const objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Detailed Description

This function object calculates and outputs the blended interfacial forces acting on a given phase (drag, virtual mass, lift, wall-lubrication and turbulent dispersion). It works only 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    outputTime;
    writeInterval   1;
    log             false;
    ...
    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 98 of file phaseForces.H.

Constructor & Destructor Documentation

◆ phaseForces()

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

Construct from Time and dictionary.

◆ ~phaseForces()

virtual ~phaseForces ( )

virtual

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "phaseForces" )

Runtime type information.

◆ read()

virtual bool read ( const dictionary & dict )

virtual

Read the input data.

Reimplemented from regionFunctionObject.

◆ execute()

virtual bool execute ( )

virtual

Calculate the force fields.

Implements functionObject.

◆ write()

virtual bool write ( )

virtual

Write the force fields.

Implements functionObject.

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

applications/solvers/multiphase/reactingEulerFoam/functionObjects/phaseForces/phaseForces.H

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseForces()

◆ ~phaseForces()

Member Function Documentation

◆ TypeName()

◆ read()

◆ execute()

◆ write()