populationBalance Class Reference

This diameter model computes the diameter from multiple size group diameters and fractions provided by an associated population balance model. More...

Inheritance diagram for populationBalance:
Collaboration diagram for populationBalance:

Public Member Functions

 TypeName ("populationBalance")
 Runtime type information. More...
 
 populationBalance (const dictionary &diameterProperties, const phaseModel &phase)
 Construct from dictionary and phase. More...
 
virtual ~populationBalance ()
 Destructor. More...
 
const wordpopBalName () const
 Return name of populationBalance this populationBalance belongs to. More...
 
const populationBalanceModelpopBal () const
 Return the populationBalance this populationBalance belongs to. More...
 
label nGroups () const
 Return the number of groups in this phase. More...
 
label iFirst () const
 Return the index of the first group of this phase. More...
 
label iLast () const
 Return the index of the last group of this phase. More...
 
virtual tmp< volScalarFieldd () const
 Get the diameter field. More...
 
virtual tmp< volScalarFieldAv () const
 Get the surface area per unit volume field. More...
 
tmp< volScalarField::InternalfSum () const
 ... More...
 
virtual void correct ()
 Correct the model. More...
 
virtual bool read (const dictionary &diameterProperties)
 Read diameter properties dictionary. More...
 
- Public Member Functions inherited from diameterModel
 TypeName ("diameterModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, diameterModel, dictionary,(const dictionary &diameterProperties, const phaseModel &phase),(diameterProperties, phase))
 
 diameterModel (const dictionary &diameterProperties, const phaseModel &phase)
 Construct from dictionary and phase. More...
 
virtual ~diameterModel ()
 Destructor. More...
 
const phaseModelphase () const
 Return the phase. More...
 
virtual bool read ()
 Read diameter properties dictionary. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from diameterModel
static autoPtr< diameterModelNew (const dictionary &diameterProperties, const phaseModel &phase)
 Select from dictionary and phase. More...
 

Detailed Description

This diameter model computes the diameter from multiple size group diameters and fractions provided by an associated population balance model.

This model requires the name of the population balance model to be specified, and will trigger construction of said population balance model. The number of groups associated with the phase is also specified here. The sizes/diameters themselves, as well as all models relating to evolution of the size distribution (i.e., coalescence and breakup) are specified for population balance model and not for this diameter model.

Usage
Excerpt from an exemplary phaseProperties dictionary:
diameterModel
{
    type                populationBalance;

    populationBalance   bubbles;

    nGroups             10;
}
See also
Foam::populationBalanceModel
Source files

Definition at line 78 of file populationBalance.H.

Constructor & Destructor Documentation

◆ populationBalance()

populationBalance ( const dictionary diameterProperties,
const phaseModel phase 
)

Construct from dictionary and phase.

Definition at line 53 of file populationBalance.C.

◆ ~populationBalance()

~populationBalance ( )
virtual

Destructor.

Definition at line 82 of file populationBalance.C.

Member Function Documentation

◆ TypeName()

TypeName ( "populationBalance"  )

Runtime type information.

◆ popBalName()

const Foam::word & popBalName ( ) const
inline

Return name of populationBalance this populationBalance belongs to.

Definition at line 31 of file populationBalanceI.H.

Referenced by populationBalanceModel::populationBalanceModel(), and populationBalanceSetSizeDistribution::write().

Here is the caller graph for this function:

◆ popBal()

const Foam::populationBalanceModel & popBal ( ) const

Return the populationBalance this populationBalance belongs to.

Definition at line 89 of file populationBalance.C.

References objectRegistry::lookupObject(), and populationBalanceModel::mesh().

Here is the call graph for this function:

◆ nGroups()

Foam::label nGroups ( ) const
inline

Return the number of groups in this phase.

Definition at line 37 of file populationBalanceI.H.

Referenced by populationBalanceModel::populationBalanceModel().

Here is the caller graph for this function:

◆ iFirst()

Foam::label iFirst ( ) const

Return the index of the first group of this phase.

Definition at line 101 of file populationBalance.C.

References forAll.

Referenced by populationBalanceModel::populationBalanceModel(), populationBalanceModel::solve(), and populationBalanceSetSizeDistribution::write().

Here is the caller graph for this function:

◆ iLast()

Foam::label iLast ( ) const
inline

Return the index of the last group of this phase.

Definition at line 43 of file populationBalanceI.H.

Referenced by populationBalanceModel::populationBalanceModel(), populationBalanceModel::solve(), and populationBalanceSetSizeDistribution::write().

Here is the caller graph for this function:

◆ d()

Foam::tmp< Foam::volScalarField > d ( ) const
virtual

Get the diameter field.

Implements diameterModel.

Definition at line 133 of file populationBalance.C.

◆ Av()

Foam::tmp< Foam::volScalarField > Av ( ) const
virtual

Get the surface area per unit volume field.

Implements diameterModel.

Definition at line 140 of file populationBalance.C.

References populationBalanceModel::a(), Foam::dimLength, populationBalanceModel::f(), Foam::inv(), mesh, GeometricField< Type, GeoMesh, PrimitiveField >::New(), tmp< T >::ref(), populationBalanceModel::v(), and Foam::Zero.

Here is the call graph for this function:

◆ fSum()

...

Definition at line 165 of file populationBalance.C.

References Foam::dimless, populationBalanceModel::f(), mesh, DimensionedField< Type, GeoMesh, PrimitiveField >::New(), and tmp< T >::ref().

Referenced by populationBalanceModel::solve().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ correct()

◆ read()

bool read ( const dictionary diameterProperties)
virtual

Read diameter properties dictionary.

Implements diameterModel.

Definition at line 231 of file populationBalance.C.


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