populationBalanceSizeDistribution Class Reference

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:
Collaboration diagram for populationBalanceSizeDistribution:

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 Types inherited from polyCellSet
enum class  selectionTypes { points , cellSet , cellZone , all }
 Enumeration for selection mode 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...
 
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 wordtype () 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< functionObjectclone () const
 Return clone. More...
 
 functionObject (const functionObject &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~functionObject ()
 Destructor. More...
 
const wordname () 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...
 
- Public Member Functions inherited from fvCellSet
 fvCellSet (const fvMesh &mesh)
 Construct from mesh. Will select all. More...
 
 fvCellSet (const fvMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 ~fvCellSet ()
 Destructor. More...
 
scalar V () const
 Return const access to the total cell volume. More...
 
void movePoints ()
 Update for mesh motion. More...
 
void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
bool read (const dictionary &dict)
 Read coefficients dictionary. More...
 
- Public Member Functions inherited from polyCellSet
 polyCellSet (const polyMesh &mesh)
 Construct from mesh. Will select all. More...
 
 polyCellSet (const polyMesh &mesh, const dictionary &dict)
 Construct from mesh and dictionary. More...
 
 ~polyCellSet ()
 Destructor. More...
 
const selectionTypesselectionType () const
 Return const access to the cell selection type. More...
 
const wordcellSetName () const
 Return const access to the name of cellSet. More...
 
labelUList cells () const
 Return const access to the cell set. More...
 
label nCells () const
 Return the number of cells in the set. More...
 
bool all () const
 Return true if the set comprises all the cells. More...
 
label celli (const label i) const
 Return the cell index corresponding to the cell set index. More...
 
void movePoints ()
 Update for mesh motion. More...
 
void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
bool read (const dictionary &dict)
 Read coefficients dictionary. 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 polyCellSet
static const NamedEnum< selectionTypes, 4 > selectionTypeNames
 Word list of selection type names. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from functionObject
static autoPtr< functionObjectNew (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 fvMeshFunctionObject
labelHashSet patchSet (const dictionary &, const bool optional=false) const
 Return the patch set corresponding to the patch selection entries. 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...
 
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...
 
- Protected Member Functions inherited from fvCellSet
void writeFileHeader (const functionObjects::writeFile &wf, Ostream &file)
 Output file header information. More...
 
- Protected Attributes inherited from fvMeshFunctionObject
const fvMeshmesh_
 Reference to the fvMesh. More...
 
- Protected Attributes inherited from regionFunctionObject
const objectRegistryobr_
 Reference to the region objectRegistry. More...
 
- Protected Attributes inherited from functionObject
const Timetime_
 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
select cellZone or all no all
name name of cellZone if required no
setFormat output format yes
See also
Foam::diameterModels::populationBalanceModel Foam::functionObjects::fvMeshFunctionObject Foam::fvCellSet Foam::functionObject
Source files

Definition at line 149 of file populationBalanceSizeDistribution.H.

Member Enumeration Documentation

◆ functionType

Function type enumeration.

Enumerator
numberConcentration 
numberDensity 
volumeConcentration 
volumeDensity 
areaConcentration 
areaDensity 

Definition at line 159 of file populationBalanceSizeDistribution.H.

◆ coordinateType

Coordinate type enumeration.

Enumerator
volume 
area 
diameter 
projectedAreaDiameter 

Definition at line 173 of file populationBalanceSizeDistribution.H.

◆ weightType

enum weightType
strong

Enumeration for the weight types.

Enumerator
numberConcentration 
volumeConcentration 
areaConcentration 
cellVolume 

Definition at line 185 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 347 of file populationBalanceSizeDistribution.C.

◆ populationBalanceSizeDistribution() [2/2]

Disallow default bitwise copy construction.

◆ ~populationBalanceSizeDistribution()

Destructor.

Definition at line 395 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 288 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 regionFunctionObject.

Definition at line 402 of file populationBalanceSizeDistribution.C.

References dict, Log, Foam::name(), setWriter::New(), Foam::nl, regionFunctionObject::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 417 of file populationBalanceSizeDistribution.C.

◆ write()

bool write ( )
virtual

◆ operator=()

void operator= ( const populationBalanceSizeDistribution )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ functionTypeNames_

Function type names.

Definition at line 170 of file populationBalanceSizeDistribution.H.

◆ coordinateTypeNames_

const NamedEnum<coordinateType, 4> coordinateTypeNames_
static

Coordinate type names.

Definition at line 182 of file populationBalanceSizeDistribution.H.

◆ weightTypeNames_

Names of the weight types.

Definition at line 194 of file populationBalanceSizeDistribution.H.


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