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 multiphaseEuler solver module. 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 wordList	fields () const
	Return the list of fields required. 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, const Time &runTime)
	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 scalar	timeToNextAction ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. More...

virtual scalar	maxDeltaT () const
	Return the maximum time-step for stable operation. More...

virtual void	movePoints (const polyMesh &mesh)
	Update topology using the given map. More...

virtual void	topoChange (const polyTopoChangeMap &map)
	Update topology using the given map. More...

virtual void	mapMesh (const polyMeshMap &)
	Update from another mesh using the given map. More...

virtual void	distribute (const polyDistributionMap &)
	Redistribute or update using the given distribution map. More...

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

Protected Attributes
HashPtrTable< volVectorField >	forceFields_
	Force fields. More...

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 objectRegistry &	obr_
	Reference to the region objectRegistry. More...

Protected Attributes inherited from functionObject
const Time &	time_
	Reference to time. 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...

Protected Member Functions inherited from fvMeshFunctionObject
labelHashSet	patchSet (const dictionary &, const bool optional=false) const
	Return the patch set corresponding to the patch selection entries. 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 >
void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObject (const word &fieldName)
	Prints a warning message that fieldName cannot be found. More...

void	cannotFindObjects (const wordList &fieldNames)
	Prints a warning message that fieldNames cannot be found. 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...

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 multiphaseEuler solver module.

For a simulation involving more than two phases, the accumulated force is calculated by looping over all interfaces 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 ("libmultiphaseEulerFunctionObjects.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 &	dict
	)

Construct from Time and dictionary.

Definition at line 49 of file phaseForces.C.

References dict, Foam::dimForce, Foam::dimVolume, phaseForces::fluid_, forAll, phaseForces::forceFields_, phaseSystem::foundInterfacialModel(), IOobject::groupName(), fvMeshFunctionObject::mesh_, phaseModel::name(), dimensioned< Type >::name(), phaseForces::phase_, phaseSystem::phases(), phaseForces::read(), fvMesh::time(), and Foam::Zero.

Here is the call graph for this function:

◆ phaseForces() [2/2]

phaseForces ( const phaseForces & )

delete

Disallow default bitwise copy construction.

◆ ~phaseForces()

~phaseForces ( )

virtual

Destructor.

Definition at line 196 of file phaseForces.C.

Member Function Documentation

◆ TypeName()

TypeName ( "phaseForces" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the input data.

Reimplemented from regionFunctionObject.

Definition at line 202 of file phaseForces.C.

References dict, and regionFunctionObject::read().

Referenced by phaseForces::phaseForces().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 146 of file phaseForces.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the force fields.

Implements functionObject.

Definition at line 210 of file phaseForces.C.

References D, phaseModel::DUDt(), blendedLiftModel::F(), blendedWallLubricationModel::F(), forAll, forAllConstIter, Foam::fvc::grad(), K, Foam::max(), phaseInterface::phase1(), phaseModel::residualAlpha(), phaseModel::U(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the force fields.

Implements functionObject.

Definition at line 290 of file phaseForces.C.

References forAllConstIter, and Foam::name().

Here is the call graph for this function:

◆ operator=()

void operator= ( const phaseForces & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ forceFields_

HashPtrTable<volVectorField> forceFields_

protected

Force fields.

Definition at line 107 of file phaseForces.H.

Referenced by phaseForces::phaseForces().

◆ phase_

const phaseModel& phase_

protected

Phase for which forces are evaluated.

Definition at line 110 of file phaseForces.H.

Referenced by phaseForces::phaseForces().

◆ fluid_

const phaseSystem& fluid_

protected

Constant access to phaseSystem.

Definition at line 113 of file phaseForces.H.

Referenced by phaseForces::phaseForces().

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

applications/modules/multiphaseEuler/functionObjects/phaseForces/phaseForces.H
applications/modules/multiphaseEuler/functionObjects/phaseForces/phaseForces.C

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ phaseForces() [1/2]

◆ phaseForces() [2/2]

◆ ~phaseForces()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ forceFields_

◆ phase_

◆ fluid_