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	weightType { numberConcentration, volumeConcentration, areaConcentration, cellVolume }
	Enumeration for the weight types. More...

Public Types inherited from volRegion
enum	regionTypes { vrtCellZone, vrtAll }
	Region type enumeration. 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...

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

Public Member Functions inherited from volRegion
	TypeName ("volRegion")
	Run-time type information. More...

	volRegion (const fvMesh &mesh, const dictionary &dict)
	Construct from fvMesh and dictionary. More...

virtual	~volRegion ()
	Destructor. More...

bool	read (const dictionary &)
	Read from dictionary. More...

const regionTypes &	regionType () const
	Return the region type. More...

const labelList &	cellIDs () const
	Return the local list of cell IDs. More...

label	nCells () const
	Return the number of cells in the region. More...

scalar	V () const
	Return total volume of the region. 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...

Static Public Attributes inherited from volRegion
static const NamedEnum< regionTypes, 2 >	regionTypeNames_
	Region type names. 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 Member Functions inherited from volRegion
void	writeFileHeader (const writeFile &wf, Ostream &file)
	Output file header information. 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...

Protected Attributes inherited from volRegion
regionTypes	regionType_
	Region type. More...

word	regionName_
	Region name (patch, zone, etc.) More...

label	regionID_
	Region ID (patch ID, zone ID, etc.) 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                ("libmultiphaseEulerFoamFunctionObjects.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
`regionType`	cellZone or all	no	all
`name`	name of cellZone if required	no
`setFormat`	output format	yes