This functionObject 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...

	phaseForces (const phaseForces &)=delete
	Disallow default bitwise copy construction. 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...

void	operator= (const phaseForces &)=delete
	Disallow default bitwise assignment. 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...

	fvMeshFunctionObject (const fvMeshFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~fvMeshFunctionObject ()
	Destructor. More...

void	operator= (const fvMeshFunctionObject &)=delete
	Disallow default bitwise assignment. 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...

	regionFunctionObject (const regionFunctionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~regionFunctionObject ()
	Destructor. More...

void	operator= (const regionFunctionObject &)=delete
	Disallow default bitwise assignment. More...

Public Member Functions inherited from functionObject
	ClassName ("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...

	functionObject (const functionObject &)=delete
	Disallow default bitwise copy construction. More...

virtual	~functionObject ()
	Destructor. More...

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

virtual bool	executeAtStart () const
	Return true if the functionObject should be executed at the start. More...

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

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

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

void	operator= (const functionObject &)=delete
	Disallow default bitwise assignment. More...

Protected Member Functions
template<class modelType >
tmp< volVectorField >	nonDragForce (const phasePair &key) const
	Evaluate and return non-drag force. 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 (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
bool	store (const 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
HashPtrTable< volVectorField >	forceFields_

const phaseModel &	phase_
	Phase for which forces are evaluated. More...

const phaseSystem &	fluid_
	Constant access to phaseSystem. 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...

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...

Switch	executeAtStart_
	Switch write log to Info. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. More...

Detailed Description

This functionObject 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 ("libmultiphaseEulerFoamFunctionObjects.so");

    phase           water;
}

Usage

Property	Description	Required	Default value
`type`	type name: phaseForces	yes
`phase`	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() [1/2]

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

Construct from Time and dictionary.

◆ phaseForces() [2/2]

phaseForces ( const phaseForces & )

delete

Disallow default bitwise copy construction.

◆ ~phaseForces()

virtual ~phaseForces ( )

virtual

Destructor.

Member Function Documentation

◆ nonDragForce()

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

protected

Evaluate and return non-drag force.

◆ 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.

◆ operator=()

void operator= ( const phaseForces & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ forceFields_

HashPtrTable<volVectorField> forceFields_

protected

Definition at line 106 of file phaseForces.H.

◆ phase_

const phaseModel& phase_

protected

Phase for which forces are evaluated.

Definition at line 109 of file phaseForces.H.

◆ fluid_

const phaseSystem& fluid_

protected

Constant access to phaseSystem.

Definition at line 112 of file phaseForces.H.

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseForces() [1/2]

◆ phaseForces() [2/2]

◆ ~phaseForces()

Member Function Documentation

◆ nonDragForce()

◆ TypeName()

◆ read()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ forceFields_

◆ phase_

◆ fluid_