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...
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... | |
![]() | |
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... | |
![]() | |
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... | |
![]() | |
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... | |
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 bool | postProcess |
Global post-processing mode switch. More... | |
Additional Inherited Members | |
![]() | |
static autoPtr< functionObject > | New (const word &name, const Time &, const dictionary &) |
Select from dictionary, based on its "type" entry. More... | |
![]() | |
Switch | log |
Switch write log to Info. More... | |
Switch | executeAtStart_ |
Switch write log to Info. More... | |
![]() | |
labelHashSet | patchSet (const dictionary &, const bool optional=false) const |
Return the patch set corresponding to the patch selection entries. More... | |
![]() | |
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... | |
![]() | |
const fvMesh & | mesh_ |
Reference to the fvMesh. More... | |
![]() | |
const objectRegistry & | obr_ |
Reference to the region objectRegistry. More... | |
![]() | |
const Time & | time_ |
Reference to time. More... | |
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; }
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 |
Definition at line 122 of file populationBalanceMoments.H.
|
strong |
Enumeration for the moment types.
Enumerator | |
---|---|
integerMoment | |
mean | |
variance | |
stdDev |
Definition at line 129 of file populationBalanceMoments.H.
|
strong |
Enumeration for the coordinate types.
Enumerator | |
---|---|
volume | |
area | |
diameter |
Definition at line 141 of file populationBalanceMoments.H.
|
strong |
Enumeration for the weight types.
Enumerator | |
---|---|
numberConcentration | |
volumeConcentration | |
areaConcentration |
Definition at line 152 of file populationBalanceMoments.H.
|
strong |
Enumeration for the mean types.
Enumerator | |
---|---|
arithmetic | |
geometric | |
notApplicable |
Definition at line 163 of file populationBalanceMoments.H.
populationBalanceMoments | ( | const word & | name, |
const Time & | runTime, | ||
const dictionary & | dict | ||
) |
Construct from Time and dictionary.
Definition at line 729 of file populationBalanceMoments.C.
References dict, and populationBalanceMoments::read().
|
delete |
Disallow default bitwise copy construction.
|
virtual |
Destructor.
Definition at line 762 of file populationBalanceMoments.C.
TypeName | ( | "populationBalanceMoments" | ) |
Runtime type information.
|
virtual |
Read the data.
Reimplemented from regionFunctionObject.
Definition at line 769 of file populationBalanceMoments.C.
References dict, Foam::dimless, IOobject::NO_READ, IOobject::NO_WRITE, regionFunctionObject::read(), and Foam::Zero.
Referenced by populationBalanceMoments::populationBalanceMoments().
|
inlinevirtual |
Return the list of fields required.
Implements functionObject.
Definition at line 260 of file populationBalanceMoments.H.
References List< word >::null().
|
virtual |
Calculate the moment fields.
Implements functionObject.
Definition at line 885 of file populationBalanceMoments.C.
References sizeGroup::a(), sizeGroup::d(), forAll, sizeGroup::phase(), Foam::pow(), Foam::sqrt(), sizeGroup::x(), and Foam::Zero.
|
virtual |
Write the moment fields.
Implements functionObject.
Definition at line 974 of file populationBalanceMoments.C.
|
delete |
Disallow default bitwise assignment.
|
static |
Names of the moment types.
Definition at line 138 of file populationBalanceMoments.H.
|
static |
Names of the coordinate types.
Definition at line 149 of file populationBalanceMoments.H.
|
static |
Names of the weight types.
Definition at line 160 of file populationBalanceMoments.H.
|
static |
Names of the mean types.
Definition at line 171 of file populationBalanceMoments.H.