Calculates and writes out integral (integer moments) or mean properties (mean, variance, standard deviation) of a size distribution determined by a population balance model. Requires solver post-processing. More...

Inheritance diagram for populationBalanceMoments:

[legend]

Collaboration diagram for populationBalanceMoments:

[legend]

Public Types
enum	momentType { integerMoment, mean, variance, stdDev }
	Enumeration for the moment types. More...

enum	coordinateType { volume, area, diameter }
	Enumeration for the coordinate types. More...

enum	weightType { numberConcentration, volumeConcentration, areaConcentration }
	Enumeration for the weight types. More...

enum	meanType { arithmetic, geometric, notApplicable }
	Enumeration for the mean types. More...

Public Member Functions
	TypeName ("populationBalanceMoments")
	Runtime type information. More...

	populationBalanceMoments (const word &name, const Time &runTime, const dictionary &)
	Construct from Time and dictionary. More...

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

virtual	~populationBalanceMoments ()
	Destructor. More...

virtual bool	read (const dictionary &)
	Read the data. More...

virtual wordList	fields () const
	Return the list of fields required. More...

virtual bool	execute ()
	Calculate the moment fields. More...

virtual bool	write ()
	Write the moment fields. More...

void	operator= (const populationBalanceMoments &)=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 scalar	timeToNextWrite ()
	Called by Time::adjustTimeStep(). Allows the functionObject to. 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...

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

Static Public Attributes
static const NamedEnum< momentType, 4 >	momentTypeNames_
	Names of the moment types. More...

static const NamedEnum< coordinateType, 3 >	coordinateTypeNames_
	Names of the coordinate types. More...

static const NamedEnum< weightType, 3 >	weightTypeNames_
	Names of the weight types. More...

static const NamedEnum< meanType, 3 >	meanTypeNames_
	Names of the mean types. More...

Static Public Attributes inherited from functionObject
static bool	postProcess
	Global post-processing mode switch. 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...

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

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

Calculates and writes out integral (integer moments) or mean properties (mean, variance, standard deviation) of a size distribution determined by a population balance model. Requires solver post-processing.

The following function object specification for example returns the first moment of the volume-based number density function which is equivalent to the phase fraction of the particulate phase:

populationBalanceMoments
{
    type                populationBalanceMoments;
    libs                ("libmultiphaseEulerFoamFunctionObjects.so");
    executeControl      timeStep;
    writeControl        writeTime;
    populationBalance   bubbles;
    momentType          integerMoment;
    coordinateType      volume;
    order               1;
}

Usage

Property	Description	Required	Default
`populationBalance`	population balance name	yes
`momentType`	desired moment of the distribution	yes
`coordinateType`	particle property	yes
`weightType`	number/volume/area concentration	no	numberConcentration
`order`	order of integer moment	for integer moments
`meanType`	arithmetic or geometric	for non-integer moments	arithmetic