Writes out the size distribution determined by a population balance model, either for the entire domain or a cell zone. Requires solver post- processing. More...

Inheritance diagram for populationBalanceSizeDistribution:

[legend]

Collaboration diagram for populationBalanceSizeDistribution:

[legend]

Public Types
enum	functionType { numberConcentration , numberDensity , volumeConcentration , volumeDensity , areaConcentration , areaDensity }
	Function type enumeration. More...

enum	coordinateType { volume , area , diameter , projectedAreaDiameter }
	Coordinate type enumeration. More...

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

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

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

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

virtual	~populationBalanceSizeDistribution ()
	Destructor. More...

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

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

virtual bool	execute ()
	Execute, currently does nothing. More...

virtual bool	write ()
	Calculate and write the size distribution. More...

virtual void	movePoints (const polyMesh &)
	Update for mesh motion. More...

virtual void	topoChange (const polyTopoChangeMap &)
	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 populationBalanceSizeDistribution &)=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...

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

Static Public Attributes
static const NamedEnum< functionType, 6 >	functionTypeNames_
	Function type names. More...

static const NamedEnum< coordinateType, 4 >	coordinateTypeNames_
	Coordinate type names. More...

static const NamedEnum< weightType, 4 >	weightTypeNames_
	Names of the weight 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

Writes out the size distribution determined by a population balance model, either for the entire domain or a cell zone. Requires solver post- processing.

The following function object specification for example returns the volume- based number density function:

Example of function object specification:

numberDensity
{
    type                populationBalanceSizeDistribution;
    libs                ("libmultiphaseEulerFunctionObjects.so");
    writeControl        writeTime;
    populationBalance   bubbles;
    functionType        numberDensity;
    coordinateType      volume;
    setFormat           raw;
}

Usage

Property	Description	Required	Default
`populationBalance`	population balance name	yes
`functionType`	function type	yes
`coordinateType`	particle property	yes
`allCoordinates`	write all coordinate values	no	false
`normalise`	divide by total concentration	no	false
`logTransform`	class width based on log of coordinate	no	false
`weightType`	weighting in case of field-dependent particle properties	no	numberConcentration
`cellZone`	cellZone	yes
`name`	name of cellZone if required	no
`setFormat`	output format	yes

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

Source files

Definition at line 149 of file populationBalanceSizeDistribution.H.

Member Enumeration Documentation

◆ functionType

enum functionType

Function type enumeration.

Enumerator
numberConcentration
numberDensity
volumeConcentration
volumeDensity
areaConcentration
areaDensity

Definition at line 158 of file populationBalanceSizeDistribution.H.

◆ coordinateType

enum coordinateType

Coordinate type enumeration.

Enumerator
volume
area
diameter
projectedAreaDiameter

Definition at line 172 of file populationBalanceSizeDistribution.H.

◆ weightType

enum weightType

strong

Enumeration for the weight types.

Enumerator
numberConcentration
volumeConcentration
areaConcentration
cellVolume

Definition at line 184 of file populationBalanceSizeDistribution.H.

Constructor & Destructor Documentation

◆ populationBalanceSizeDistribution() [1/2]

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

Construct from Time and dictionary.

Definition at line 323 of file populationBalanceSizeDistribution.C.

◆ populationBalanceSizeDistribution() [2/2]

populationBalanceSizeDistribution ( const populationBalanceSizeDistribution & )

delete

Disallow default bitwise copy construction.

◆ ~populationBalanceSizeDistribution()

~populationBalanceSizeDistribution ( )

virtual

Destructor.

Definition at line 365 of file populationBalanceSizeDistribution.C.

Member Function Documentation

◆ TypeName()

TypeName ( "populationBalanceSizeDistribution" )

Runtime type information.

◆ fields()

virtual wordList fields ( ) const

inlinevirtual

Return the list of fields required.

Implements functionObject.

Definition at line 290 of file populationBalanceSizeDistribution.H.

References List< word >::null().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & dict )

virtual

Read the populationBalanceSizeDistribution data.

Reimplemented from objectRegistryFunctionObject.

Definition at line 372 of file populationBalanceSizeDistribution.C.

References dict, Log, Foam::name(), setWriter::New(), Foam::nl, objectRegistryFunctionObject::read(), and Foam::type().

Here is the call graph for this function:

◆ execute()

bool execute ( )

virtual

Execute, currently does nothing.

Implements functionObject.

Definition at line 387 of file populationBalanceSizeDistribution.C.

◆ write()

bool write ( )

virtual

Calculate and write the size distribution.

Implements functionObject.

Definition at line 393 of file populationBalanceSizeDistribution.C.

References sizeGroup::a(), UList< T >::first(), forAll, Foam::gSum(), UList< T >::last(), Log, Foam::log(), UPstream::master(), Foam::name(), Foam::nl, sizeGroup::phase(), PtrList< T >::set(), List< T >::size(), populationBalanceModel::sizeGroups(), Foam::sum(), Foam::type(), and sizeGroup::x().

Here is the call graph for this function:

◆ movePoints()

void movePoints ( const polyMesh & mesh )

virtual

Update for mesh motion.

Reimplemented from functionObject.

Definition at line 639 of file populationBalanceSizeDistribution.C.

References mesh.

◆ topoChange()

void topoChange ( const polyTopoChangeMap & map )

virtual

Update topology using the given map.

Reimplemented from functionObject.

Definition at line 651 of file populationBalanceSizeDistribution.C.

References polyTopoChangeMap::mesh(), and mesh.

Here is the call graph for this function:

◆ mapMesh()

void mapMesh ( const polyMeshMap & map )

virtual

Update from another mesh using the given map.

Reimplemented from functionObject.

Definition at line 663 of file populationBalanceSizeDistribution.C.

References polyMeshMap::mesh(), and mesh.

Here is the call graph for this function:

◆ distribute()

void distribute ( const polyDistributionMap & map )

virtual

Redistribute or update using the given distribution map.

Reimplemented from functionObject.

Definition at line 675 of file populationBalanceSizeDistribution.C.

References polyDistributionMap::mesh(), and mesh.

Here is the call graph for this function:

◆ operator=()

void operator= ( const populationBalanceSizeDistribution & )

delete

Disallow default bitwise assignment.

Member Data Documentation

◆ functionTypeNames_

const Foam::NamedEnum< Foam::functionObjects::populationBalanceSizeDistribution::functionType, 6 > functionTypeNames_

static

Initial value:

{
    "numberConcentration",
    "numberDensity",
    "volumeConcentration",
    "volumeDensity",
    "areaConcentration",
    "areaDensity"
}

Function type names.

Definition at line 169 of file populationBalanceSizeDistribution.H.

◆ coordinateTypeNames_

const Foam::NamedEnum< Foam::functionObjects::populationBalanceSizeDistribution::coordinateType, 4 > coordinateTypeNames_

static

Initial value:

{
    "volume",
    "area",
    "diameter",
    "projectedAreaDiameter"
}

Coordinate type names.

Definition at line 181 of file populationBalanceSizeDistribution.H.

◆ weightTypeNames_

const Foam::NamedEnum< Foam::functionObjects::populationBalanceSizeDistribution::weightType, 4 > weightTypeNames_

static

Initial value:

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

Names of the weight types.

Definition at line 193 of file populationBalanceSizeDistribution.H.

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

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

Public Types

Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ functionType

◆ coordinateType

◆ weightType

Constructor & Destructor Documentation

◆ populationBalanceSizeDistribution() [1/2]

◆ populationBalanceSizeDistribution() [2/2]

◆ ~populationBalanceSizeDistribution()

Member Function Documentation

◆ TypeName()

◆ fields()

◆ read()

◆ execute()

◆ write()

◆ movePoints()

◆ topoChange()

◆ mapMesh()

◆ distribute()

◆ operator=()

Member Data Documentation

◆ functionTypeNames_

◆ coordinateTypeNames_

◆ weightTypeNames_