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 class	momentType { integerMoment , mean , variance , stdDev }
	Enumeration for the moment types. More...

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

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

enum class	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)
	Construct from the region objectRegistry. More...

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

virtual	~fvMeshFunctionObject ()
	Destructor. More...

const fvMesh &	mesh () const
	Return a reference to the mesh. 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)
	Construct from the region objectRegistry. 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 objectRegistryFunctionObject
	TypeName ("objectRegistryFunctionObject")
	Runtime type information. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr, const dictionary &dict)
	Construct from an objectRegistry and dictionary. More...

	objectRegistryFunctionObject (const word &name, const objectRegistry &obr)
	Construct from an objectRegistry. More...

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

virtual	~objectRegistryFunctionObject ()
	Destructor. More...

void	operator= (const objectRegistryFunctionObject &)=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...

	functionObject (const word &name, const Time &runTime, const dictionary &dict)
	Construct from dictionary. 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...

Static Public Attributes
static const NamedEnum< momentType, 4 >	momentTypeNames_ {"integerMoment", "mean", "variance", "stdDev"}
	Names of the moment types. More...

static const NamedEnum< coordinateType, 3 >	coordinateTypeNames_ {"volume", "area", "diameter"}
	Names of the coordinate types. More...

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

static const NamedEnum< meanType, 3 >	meanTypeNames_ {"arithmetic", "geometric", "notApplicable"}
	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 execute at start time. More...

Protected Member Functions inherited from objectRegistryFunctionObject
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 >
ObjectType &	store (const tmp< ObjectType > &tfield)
	Store the given field in the objectRegistry. More...

template<class ObjectType >
ObjectType &	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 objectRegistryFunctionObject
const objectRegistry &	obr_
	Reference to the objectRegistry. More...

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

See also: Foam::diameterModels::populationBalanceModel Foam::functionObjects::fvMeshFunctionObject Foam::functionObject

Source files

Definition at line 122 of file populationBalanceMoments.H.

Member Enumeration Documentation

◆ momentType

enum momentType

strong

Enumeration for the moment types.

Enumerator
integerMoment
mean
variance
stdDev

Definition at line 129 of file populationBalanceMoments.H.

◆ coordinateType

enum coordinateType

strong

Enumeration for the coordinate types.

Enumerator
volume
area
diameter

Definition at line 141 of file populationBalanceMoments.H.

◆ weightType

enum weightType

strong

Enumeration for the weight types.

Enumerator
numberConcentration
volumeConcentration
areaConcentration

Definition at line 152 of file populationBalanceMoments.H.

◆ meanType

enum meanType

strong

Enumeration for the mean types.

Enumerator
arithmetic
geometric
notApplicable

Definition at line 163 of file populationBalanceMoments.H.

Constructor & Destructor Documentation

◆ populationBalanceMoments() [1/2]

populationBalanceMoments	(	const word &	name,
		const Time &	runTime,
		const dictionary &	dict
	)

Construct from Time and dictionary.

Definition at line 696 of file populationBalanceMoments.C.

References dict, and populationBalanceMoments::read().

Here is the call graph for this function:

◆ populationBalanceMoments() [2/2]

populationBalanceMoments ( const populationBalanceMoments & )

delete

Disallow default bitwise copy construction.

◆ ~populationBalanceMoments()

~populationBalanceMoments ( )

virtual

Destructor.

Definition at line 723 of file populationBalanceMoments.C.

Member Function Documentation

◆ TypeName()

TypeName ( "populationBalanceMoments" )

Runtime type information.

◆ read()

bool read ( const dictionary & dict )

virtual

Read the data.

Reimplemented from objectRegistryFunctionObject.

Definition at line 730 of file populationBalanceMoments.C.

References dict, Foam::dimless, IOobject::NO_READ, IOobject::NO_WRITE, objectRegistryFunctionObject::read(), and Foam::Zero.

Referenced by populationBalanceMoments::populationBalanceMoments().

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 272 of file populationBalanceMoments.H.

References List< word >::null().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Calculate the moment fields.

Implements functionObject.

Definition at line 855 of file populationBalanceMoments.C.

References sizeGroup::a(), sizeGroup::d(), forAll, sizeGroup::phase(), Foam::pow(), populationBalanceModel::sizeGroups(), Foam::sqrt(), sizeGroup::x(), and Foam::Zero.

Here is the call graph for this function:

◆ write()

bool write ( )

virtual

Write the moment fields.

Implements functionObject.

Definition at line 950 of file populationBalanceMoments.C.

◆ operator=()

void operator= ( const populationBalanceMoments & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ momentTypeNames_

const Foam::NamedEnum< Foam::functionObjects::populationBalanceMoments::momentType, 4 > momentTypeNames_ {"integerMoment", "mean", "variance", "stdDev"}

static

Names of the moment types.

Definition at line 138 of file populationBalanceMoments.H.

◆ coordinateTypeNames_

const Foam::NamedEnum< Foam::functionObjects::populationBalanceMoments::coordinateType, 3 > coordinateTypeNames_ {"volume", "area", "diameter"}

static

Names of the coordinate types.

Definition at line 149 of file populationBalanceMoments.H.

◆ weightTypeNames_

const Foam::NamedEnum< Foam::functionObjects::populationBalanceMoments::weightType, 3 > weightTypeNames_

static

Initial value:

{
    "numberConcentration",
    "volumeConcentration",
    "areaConcentration"
}

Names of the weight types.

Definition at line 160 of file populationBalanceMoments.H.

◆ meanTypeNames_

const Foam::NamedEnum< Foam::functionObjects::populationBalanceMoments::meanType, 3 > meanTypeNames_ {"arithmetic", "geometric", "notApplicable"}

static

Names of the mean types.

Definition at line 171 of file populationBalanceMoments.H.

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

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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ momentType

◆ coordinateType

◆ weightType

◆ meanType

Constructor & Destructor Documentation

◆ populationBalanceMoments() [1/2]

◆ populationBalanceMoments() [2/2]

◆ ~populationBalanceMoments()

Member Function Documentation

◆ TypeName()

◆ read()

◆ fields()

◆ execute()

◆ write()

◆ operator=()

Member Data Documentation

◆ momentTypeNames_

◆ coordinateTypeNames_

◆ weightTypeNames_

◆ meanTypeNames_