Model for tracking the evolution of a dispersed phase size distribution due to coalescence (synonymous with coagulation, aggregation, agglomeration) and breakup events as well as density or phase changes. Provides an approximate solution of the population balance equation by means of a class method. The underlying theory is described in the article of Lehnigk et al. (2021). More...

Inheritance diagram for populationBalanceModel:

[legend]

Collaboration diagram for populationBalanceModel:

[legend]

Public Types
typedef HashPtrTable< volScalarField::Internal, phaseInterfaceKey, phaseInterfaceKey::hash >	dmdtfTable
	Table of interfacial mass transfer rates. More...

Public Types inherited from IOobject
enum	objectState { GOOD , BAD }
	Enumeration defining the valid states of an IOobject. More...

enum	readOption { MUST_READ , MUST_READ_IF_MODIFIED , READ_IF_PRESENT , NO_READ }
	Enumeration defining the read options. More...

enum	writeOption { AUTO_WRITE = 0 , NO_WRITE = 1 }
	Enumeration defining the write options. More...

enum	fileCheckTypes { timeStamp , timeStampMaster , inotify , inotifyMaster }
	Enumeration defining the file checking options. More...

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

	populationBalanceModel (const phaseSystem &fluid, const word &name)
	Construct for a fluid and with a given name. More...

virtual	~populationBalanceModel ()
	Destructor. More...

const phaseSystem &	fluid () const
	Return reference to the phaseSystem. More...

const fvMesh &	mesh () const
	Return reference to the mesh. More...

const phaseModel &	continuousPhase () const
	Return continuous phase. More...

label	nGroups () const
	Return the number of groups in the population balance. More...

const UPtrList< const phaseModel > &	phases () const
	Access the list of phases associated with each group. More...

const UPtrList< const phaseModel > &	uniquePhases () const
	Access the minimal list of the phases in this population balance. More...

const UPtrList< const diameterModels::populationBalance > &	diameters () const
	Access the list of diameter models associated with each group. More...

const UPtrList< const diameterModels::populationBalance > &	uniqueDiameters () const
	Access the minimal list of the diameter models in this population. More...

const PtrList< volScalarField > &	fs () const
	Access the group fractions. More...

PtrList< volScalarField > &	fs ()
	Modify the group fractions. More...

const volScalarField &	f (const label i) const
	Access a group fraction. More...

volScalarField &	f (const label i)
	Modify a group fraction. More...

const PtrList< dimensionedScalar > &	dSphs () const
	Access the representative spherical diameters of the groups. More...

const dimensionedScalar &	dSph (const label i) const
	Access the representative spherical diameters of a group. More...

const PtrList< dimensionedScalar > &	vs () const
	Access the representative volumes diameters of the groups. More...

const dimensionedScalar &	v (const label i) const
	Access the representative volumes diameters of a group. More...

const populationBalance::shapeModel &	shape () const
	Access the shape model. More...

tmp< volScalarField >	a (const label i) const
	Return the representative surface area of the group. More...

tmp< volScalarField >	d (const label i) const
	Return the representative diameter of the group. More...

const dmdtfTable &	dmdtfs () const
	Return reference to the coalescence and breakup interfacial mass. More...

const dmdtfTable &	expansionDmdtfs () const
	Return reference to the expansion interfacial mass transfer rates. More...

const dmdtfTable &	modelSourceDmdtfs () const
	Return reference to the model source interfacial mass transfer rates. More...

const dictionary &	solverDict () const
	Return solution settings dictionary for this populationBalance. More...

bool	solveOnFinalIterOnly () const
	Solve on final pimple iteration only. More...

const List< labelPair > &	coalescencePairs () const
	Return coalescence relevant group pairs. More...

const List< labelPair > &	binaryBreakupPairs () const
	Return binary breakup relevant group pairs. More...

const volScalarField &	alphas () const
	Return total void of phases belonging to this populationBalance. More...

tmp< volVectorField >	U () const
	Return average velocity. More...

dimensionedScalar	eta (const label i, const dimensionedScalar &v) const
	Return the number allocation coefficient for a single volume. More...

tmp< volScalarField::Internal >	eta (const label i, const volScalarField::Internal &v) const
	Return the number allocation coefficient for a field of volumes. More...

dimensionedScalar	etaV (const label i, const dimensionedScalar &v) const
	Return the volume allocation coefficient for a single volume. More...

tmp< volScalarField::Internal >	etaV (const label i, const volScalarField::Internal &v) const
	Return the volume allocation coefficient for a field of volumes. More...

dimensionedScalar	etaV (const labelPair is, const distribution &d) const
	Return the volume allocation coefficient for a given distribution. More...

dimensionedScalar	etaV (const label i, const distribution &d) const
	Return the volume allocation coefficient for a given distribution. More...

const tmp< volScalarField >	sigmaWithContinuousPhase (const phaseModel &dispersedPhase) const
	Return the surface tension coefficient between a given dispersed. More...

const tmp< volScalarField >	sigmaWithContinuousPhase (const label i) const
	Return the surface tension coefficient between a given group. More...

const phaseCompressibleMomentumTransportModel &	continuousTurbulence () const
	Return reference to momentumTransport model of the continuous phase. More...

tmp< volScalarField::Internal >	Sp (const label i) const
	Return the implicit coalescence and breakup source term. More...

tmp< volScalarField::Internal >	expansionSu (const label i, const UPtrList< volScalarField > &flds=UPtrList< volScalarField >()) const
	Return the explicit expansion source term. More...

tmp< volScalarField::Internal >	expansionSp (const label i) const
	Return the implicit expansion source term. More...

tmp< volScalarField::Internal >	modelSourceSu (const label i, const UPtrList< volScalarField > &flds=UPtrList< volScalarField >()) const
	Return the explicit model source source term. More...

void	solve ()
	Solve the population balance equation. More...

void	correct ()
	Correct derived quantities. More...

bool	writeData (Ostream &) const
	Dummy write for regIOobject. More...

Public Member Functions inherited from regIOobject
	TypeName ("regIOobject")
	Runtime type information. More...

	regIOobject (const IOobject &, const bool isTime=false)
	Construct from IOobject. Optional flag for if IOobject is the. More...

	regIOobject (const word &newName, const IOobject &, bool registerObject)
	Construct from IOobject with new name, and overriding the. More...

	regIOobject (const regIOobject &)
	Copy constructor. More...

	regIOobject (regIOobject &&)
	Move constructor. More...

	regIOobject (const regIOobject &, bool registerCopy)
	Copy constructor, transferring registry registration to copy. More...

virtual	~regIOobject ()
	Destructor. More...

virtual bool	global () const
	Return true if object is global, i.e. same for all processors. More...

virtual bool	globalFile () const
	Return true if object is global, i.e. same for all processors. More...

const fileName &	caseName () const

fileName	path () const
	Return complete path. More...

fileName	objectPath () const
	Return complete path + object name. More...

fileName	filePath () const
	Return complete path + object name if the file exists. More...

bool	checkIn ()
	Add object to registry. More...

bool	checkOut ()
	Remove object from registry. More...

void	addWatch ()
	Add file watch on object (if registered and READ_IF_MODIFIED) More...

bool	registered () const
	Is this object registered with the registry? More...

bool	ownedByRegistry () const
	Is this object owned by the registry? More...

void	store ()
	Transfer ownership of this object to its registry. More...

void	release ()
	Release ownership of this object from its registry. More...

uint64_t	eventNo () const
	Event number at last update. More...

uint64_t &	eventNo ()
	Event number at last update. More...

bool	upToDate (const regIOobject &) const
	Return true if up-to-date with respect to given object. More...

bool	upToDate (const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

bool	upToDate (const regIOobject &, const regIOobject &, const regIOobject &, const regIOobject &) const
	Return true if up-to-date with respect to given objects. More...

void	setUpToDate ()
	Set up to date (obviously) More...

virtual void	rename (const word &newName)
	Rename. More...

bool	headerOk ()
	Read and check header info. More...

Istream &	readStream (const word &, const bool read=true)
	Return Istream and check object type against that given. More...

void	close ()
	Close Istream. More...

virtual bool	readData (Istream &)
	Virtual readData function. More...

virtual bool	read ()
	Read object. More...

const labelList &	watchIndices () const
	Return file-monitoring handles. More...

labelList &	watchIndices ()
	Return file-monitoring handles. More...

virtual bool	modified () const
	Return true if the object's file (or files for objectRegistry) More...

virtual bool	dependenciesModified () const
	Return true if the object's dependencies have been modified. More...

virtual bool	readIfModified ()
	Read object if modified (as set by call to modified) More...

virtual bool	writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType, const bool write) const
	Write using given format, version and compression. More...

virtual bool	write (const bool write=true) const
	Write using setting from DB. More...

void	operator= (const IOobject &)=delete
	Assign to IOobject. More...

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

const fileName &	caseName (const bool global) const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

Public Member Functions inherited from IOobject
	TypeName ("IOobject")
	Runtime type information. More...

	IOobject (const word &name, const fileName &instance, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, registry, io options. More...

	IOobject (const word &name, const fileName &instance, const fileName &local, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from name, instance, local, registry, io options. More...

	IOobject (const fileName &path, const objectRegistry &registry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true)
	Construct from path, registry, io options. More...

	IOobject (const IOobject &io, const objectRegistry &registry)
	Construct from copy resetting registry. More...

	IOobject (const IOobject &io, const word &name)
	Construct from copy resetting name. More...

	IOobject (const IOobject &io)=default
	Copy constructor. More...

autoPtr< IOobject >	clone () const
	Clone. More...

autoPtr< IOobject >	clone (const objectRegistry &registry) const
	Clone resetting registry. More...

virtual	~IOobject ()
	Destructor. More...

const Time &	time () const
	Return time. More...

const objectRegistry &	db () const
	Return the local objectRegistry. More...

const word &	name () const
	Return name. More...

const word &	headerClassName () const
	Return name of the class name read from header. More...

word &	headerClassName ()
	Return name of the class name read from header. More...

string &	note ()
	Return non-constant access to the optional note. More...

const string &	note () const
	Return the optional note. More...

bool &	registerObject ()
	Register object created from this IOobject with registry if true. More...

bool	registerObject () const
	Register object created from this IOobject with registry if true. More...

readOption	readOpt () const

readOption &	readOpt ()

writeOption &	writeOpt () const

writeOption &	writeOpt ()

word	group () const
	Return group (extension part of name) More...

word	member () const
	Return member (name without the extension) More...

const fileName &	rootPath () const

const fileName &	caseName (const bool global) const

fileName &	instance () const
	Return the instance directory, constant, system, <time> etc. More...

void	updateInstance () const
	If the instance is a time directory update to the current time. More...

void	updateTimeInstance () const
	Update instance to the current time. More...

const fileName &	local () const

fileName	path (const bool global) const
	Return complete path including the processor sub-directory. More...

fileName	objectPath (const bool global) const
	Return complete path + object name including the processor. More...

fileName	relativePath () const
	Return the path relative to the case directory. More...

fileName	relativeObjectPath () const
	Return complete relativePath + object name. More...

fileName	filePath (const bool global) const
	Return complete path + object name if the file exists. More...

bool	readHeader (Istream &)
	Read header. More...

bool	headerOk ()
	Read header of local object without type-checking. More...

template<class Type >
void	warnNoRereading () const
	Helper: warn that type does not support re-reading. More...

bool	writeHeader (Ostream &) const
	Write header. More...

bool	writeHeader (Ostream &, const word &objectType) const
	Write header. Allow override of type. More...

bool	good () const

bool	bad () const

InfoProxy< IOobject >	info () const
	Return info proxy. More...

void	operator= (const IOobject &)

template<class Name >
Foam::word	groupName (Name name, const word &group)

Static Public Member Functions
static IOobject	groupFieldIo (const word &name, const label i, const phaseModel &phase, const IOobject::readOption r=IOobject::NO_READ, const IOobject::writeOption w=IOobject::NO_WRITE, const bool registerObject=true)
	Return IO for a group-associated field. More...

static tmp< volScalarField >	groupField (const word &name, const label i, const phaseModel &phase)
	Read and return a group-associated field. More...

Static Public Member Functions inherited from regIOobject
template<class Type >
static Type &	store (Type *)
	Transfer ownership of the given object pointer to its registry. More...

template<class Type >
static Type &	store (autoPtr< Type > &)
	Transfer ownership of the given object pointer to its registry. More...

Static Public Member Functions inherited from IOobject
static bool	fileNameComponents (const fileName &path, fileName &instance, fileName &local, word &name)
	Split path into instance, local, name components. More...

template<class Name >
static word	groupName (Name name, const word &group)

static word	group (const word &name)
	Return group (extension part of name) More...

static word	member (const word &name)
	Return member (name without the extension) More...

template<class Stream >
static Stream &	writeBanner (Stream &os, bool noHint=false)
	Write the standard OpenFOAM file/dictionary banner. More...

template<class Stream >
static Stream &	writeDivider (Stream &os)
	Write the standard file section divider. More...

template<class Stream >
static Stream &	writeEndDivider (Stream &os)
	Write the standard end file divider. More...

static bool	writeHeader (Ostream &os, const IOstream::versionNumber version, const IOstream::streamFormat format, const word &type, const string &note, const fileName &location, const word &name)
	Write header. More...

static bool	writeHeader (Ostream &, const dictionary &foamFileDict)
	Write header. More...

Additional Inherited Members
Static Public Attributes inherited from regIOobject
static float	fileModificationSkew

Static Public Attributes inherited from IOobject
static constexpr const char *	foamFile = "FoamFile"
	Keyword for the FoamFile header sub-dictionary. More...

static const NamedEnum< fileCheckTypes, 4 >	fileCheckTypesNames

static fileCheckTypes	fileModificationChecking
	Type of file modification checking. More...

Protected Member Functions inherited from regIOobject
bool	readHeaderOk (const IOstream::streamFormat defaultFormat, const word &typeName)
	Read header, check readOpt flags and read data if necessary. More...

Protected Member Functions inherited from IOobject
template<class Type >
bool	typeHeaderOk (const bool checkType)
	Read header using typeGlobalFile to find file. More...

Detailed Description

Model for tracking the evolution of a dispersed phase size distribution due to coalescence (synonymous with coagulation, aggregation, agglomeration) and breakup events as well as density or phase changes. Provides an approximate solution of the population balance equation by means of a class method. The underlying theory is described in the article of Lehnigk et al. (2021).

The size distribution, expressed through a volume-based number density function, is discretised using the fixot pivot technique of Kumar and Ramkrishna (1996). Thereby, the population balance equation is transformed into a series of transport equations for the particle (bubble, droplet) number concentrations in separate size classes that are coupled through their source terms. The discretisation is based on representative particle volumes, which are provided by the user through the corresponding sphere equivalent diameters.

Since the representative volumes are fixed a priori and the total dispersed phase volume already available from solving the phase continuity equation, the model only determines the evolution of the individual size class fraciions

$f_{i,\varphi} = \frac{\alpha_{i,\varphi}}{\alpha_{\varphi}}\,,$

where $\alpha_{i,\varphi}$ is the volume fraction of the size class and $\alpha_{\varphi}$ the total phase fraction of phase $\varphi$ .

The source terms are formulated such that the first and second moment of the distribution, i.e. the total particle number and volume, are conserved irrespective of the discretisation of the size domain. The treatment of particle breakup depends on the selected breakup submodels. For models which provide a total breakup frequency and a separate daughter size distribution function, the formulation provided Kumar and Ramkrishna (1996) is utilised, which is applicable both for binary and multiple breakup events. Currently, only field-independent daughter size distribution models are allowed. In case of binary breakup models that provide the breakup frequency between a size class pair directly, the formulation of Liao et al. (2018) is adopted, which is computationally more efficient compared to first extracting the field-dependent daughter size distribution and then consuming it in the formulation of Kumar and Ramkrishna. The source terms describing a drift of the size distribution through particle growth or shrinkage are derived using upwind differencing, thus ensuring conservation of the total particle number and volume. Note that due to the volume-based implementation, both density as well as phase change lead to a drift of the size distribution function. Further, users can specify multiple submodels for each mechanism, whose contributions are added up.

The model also allows to distribute the size classes over multiple representative phases with identical physical properties that collectively define the dispersed phase. Thereby, size class fields can be transported with different velocity fields in order to account for the size dependency of the particle motion. A possible mass transfer between representative phases by means of coalescence, breakup and drift is taken into account. Similarly, the spatial evolution of secondary particle properties such as the particle surface area can be tracked.

The key variable during a simulation is the Sauter diameter, which is computed from the size class fractions of the corresponding phase. The underlying size distribution can be extracted from the simulation using the functionObject 'sizeDistribution'. Integral and mean properties of a size distribution can be computed with the functionObject 'moments'.

Verification cases for the population balance modelling functionality are provided in test/multiphaseEuler/populationBalance.

References:

    Lehnigk, R., Bainbridge, W., Liao, Y., Lucas, D., Niemi, T.,
    Peltola, J., & Schlegel, F. (2021).
    An open‐source population balance modeling framework for the simulation
    of polydisperse multiphase flows.
    AIChE Journal, 68(3), e17539.

    Coalescence and breakup term formulation:
    Kumar, S., & Ramkrishna, D. (1996).
    On the solution of population balance equations by discretization-I. A
    fixed pivot technique.
    Chemical Engineering Science, 51(8), 1311-1332.

    Binary breakup term formulation:
    Liao, Y., Oertel, R., Kriebitzsch, S., Schlegel, F., & Lucas, D. (2018).
    A discrete population balance equation for binary breakage.
    International Journal for Numerical Methods in Fluids, 87(4), 202-215.

Usage

Excerpt from an exemplary phaseProperties dictionary:

// Define the phases
phases          (air water);

// Settings for the air phase. This phase is in the form of bubbles, the
// diameters of which will be represented by a population balance model.
// So, set the diameter model to 'populationBalance' and set the name of
// the associated population balance to 'bubbles'. The name of the
// population balance is arbitrary; it just needs to be unique and
// descriptive as it will be referred to below. And if multiple phases
// share the same population balance then it needs to be the same for all
// those phases.
air
{
    type            pureIsothermalPhaseModel;

    diameterModel
    {
        type            populationBalance;
        populationBalance bubbles;
        nGroups         5;
    }

    residualAlpha   1e-6;
}

// Settings for the water phase. This phase is continuous, so there is no
// diameter model.
water
{
    type            pureIsothermalPhaseModel;

    diameterModel   none;

    residualAlpha   1e-6;
}

// Set the blending to 'continuous' so that only sub-models relating to the
// air_dispersedIn_water configuration are used
blending
{
    default
    {
        type            continuous;
        phase           water;
    }
}

// Set the surface tension
surfaceTension
{
    air_water
    {
        type            constant;
        sigma           0.07;
    }
}

// Settings for the bubbles population balance model
bubbles
{
    // The continuous phase surrounding the bubbles is the water phase
    continuousPhase water;

    // Give the groups uniformly spaced diameters between 1 [mm] and 5 [mm]
    sphericalDiameters
    {
        type            uniform;
        min             1e-3;
        max             5e-3;
    }

    // Define the bubbles to be spherical
    shapeModel      spherical;

    // Choose coalescence and breakup sub-models ...

    coalescenceModel LehrMilliesMewes;

    breakupModel    LehrMilliesMewes;
}

See also: Foam::populationBalanceSystem Foam::diameterModels::populationBalance Foam::populationBalance::coalescenceModel Foam::populationBalance::breakupModel Foam::populationBalance::daughterSizeDistributionModel Foam::functionObjects::populationBalanceSizeDistribution Foam::functionObjects::populationBalanceSetSizeDistribution Foam::functionObjects::populationBalanceMoments

Source files

Definition at line 250 of file populationBalanceModel.H.

Member Typedef Documentation

◆ dmdtfTable

typedef HashPtrTable< volScalarField::Internal, phaseInterfaceKey, phaseInterfaceKey::hash > dmdtfTable

Table of interfacial mass transfer rates.

Definition at line 266 of file populationBalanceModel.H.

Constructor & Destructor Documentation

◆ populationBalanceModel()

populationBalanceModel	(	const phaseSystem &	fluid,
		const word &	name
	)

Construct for a fluid and with a given name.

Definition at line 696 of file populationBalanceModel.C.

References IOobject::AUTO_WRITE, Foam::average(), populationBalanceModel::correct(), Foam::decrIndent(), phaseModel::diameter(), Foam::dimDensity, Foam::dimLength, Foam::dimTime, Foam::dimVolume, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, populationBalanceModel::fluid(), forAll, populationBalanceModel::groupField(), populationBalanceModel::groupFieldIo(), IOobject::groupName(), populationBalance::iFirst(), populationBalance::iLast(), Foam::incrIndent(), Foam::indent(), Foam::indentOrNl(), Foam::Info, HashTable< T, Key, Hash >::insert(), Foam::inv(), Foam::mag(), Foam::max(), populationBalanceModel::mesh(), Foam::min(), phaseInterface::name(), phaseModel::name(), IOobject::name(), dimensioned< Type >::name(), Foam::name(), Foam::New(), oneDimensionalDiscretisation::New(), populationBalance::nGroups(), populationBalanceModel::nGroups(), IOobject::NO_READ, phaseSystem::phases(), Foam::constant::mathematical::pi(), populationBalance::popBalName(), Foam::pow3(), IOobject::time(), and Foam::typedName().

Here is the call graph for this function:

◆ ~populationBalanceModel()

~populationBalanceModel ( )

virtual

Destructor.

Definition at line 1076 of file populationBalanceModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "populationBalanceModel" )

Runtime type information.

◆ groupFieldIo()

Foam::IOobject groupFieldIo	(	const word &	name,
		const label	i,
		const phaseModel &	phase,
		const IOobject::readOption	r = `IOobject::NO_READ`,
		const IOobject::writeOption	w = `IOobject::NO_WRITE`,
		const bool	registerObject = `true`
	)

static

Return IO for a group-associated field.

Definition at line 54 of file populationBalanceModel.C.

References IOobject::groupName(), IOobject::IOobject(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), phaseModel::name(), IOobject::name(), Foam::name(), and IOobject::registerObject().

Referenced by populationBalanceModel::populationBalanceModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ groupField()

Foam::tmp< Foam::volScalarField > groupField	(	const word &	name,
		const label	i,
		const phaseModel &	phase
	)

static

Read and return a group-associated field.

Definition at line 81 of file populationBalanceModel.C.

References IOobject::AUTO_WRITE, typeIOobject< Type >::headerOk(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), IOobject::MUST_READ, and Foam::name().

Referenced by populationBalanceModel::populationBalanceModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fluid()

const Foam::phaseSystem & fluid ( ) const

inline

Return reference to the phaseSystem.

Definition at line 40 of file populationBalanceModelI.H.

Referenced by populationBalance::correct(), and populationBalanceModel::populationBalanceModel().

Here is the caller graph for this function:

◆ mesh()

const Foam::fvMesh & mesh ( ) const

inline

Return reference to the mesh.

Definition at line 46 of file populationBalanceModelI.H.

Referenced by populationBalanceModel::modelSourceSu(), populationBalance::popBal(), populationBalanceModel::populationBalanceModel(), PrinceBlanch::PrinceBlanch(), and populationBalanceModel::solve().

Here is the caller graph for this function:

◆ continuousPhase()

const Foam::phaseModel & continuousPhase ( ) const

inline

Return continuous phase.

Definition at line 53 of file populationBalanceModelI.H.

◆ nGroups()

Foam::label nGroups ( ) const

inline

Return the number of groups in the population balance.

Definition at line 59 of file populationBalanceModelI.H.

Referenced by populationBalanceModel::etaV(), populationBalanceModel::expansionSp(), growthGroupFractionFvScalarFieldSource::internalCoeff(), populationBalanceModel::populationBalanceModel(), growthGroupFractionFvScalarFieldSource::sourceCoeffs(), growthSecondaryPropertyFvScalarFieldSource::sourceCoeffs(), and populationBalanceSizeDistribution::write().

Here is the caller graph for this function:

◆ phases()

const Foam::UPtrList< const Foam::phaseModel > & phases ( ) const

inline

Access the list of phases associated with each group.

Definition at line 66 of file populationBalanceModelI.H.

Referenced by populationBalanceMoments::execute(), populationBalanceSetSizeDistribution::write(), and populationBalanceSizeDistribution::write().

Here is the caller graph for this function:

◆ uniquePhases()

const Foam::UPtrList< const Foam::phaseModel > & uniquePhases ( ) const

inline

Access the minimal list of the phases in this population balance.

Definition at line 73 of file populationBalanceModelI.H.

◆ diameters()

const Foam::UPtrList< const Foam::diameterModels::populationBalance > & diameters ( ) const

inline

Access the list of diameter models associated with each group.

Definition at line 80 of file populationBalanceModelI.H.

Referenced by growthGroupFractionFvScalarFieldSource::sourceCoeff(), growthSecondaryPropertyFvScalarFieldSource::sourceCoeff(), singleGroupFractionFvPatchScalarField::updateCoeffs(), and populationBalanceSetSizeDistribution::write().

Here is the caller graph for this function:

◆ uniqueDiameters()

const Foam::UPtrList< const Foam::diameterModels::populationBalance > & uniqueDiameters ( ) const

inline

Access the minimal list of the diameter models in this population.

balance

Definition at line 87 of file populationBalanceModelI.H.

◆ fs() [1/2]

const Foam::PtrList< Foam::volScalarField > & fs ( ) const

inline

Access the group fractions.

Definition at line 94 of file populationBalanceModelI.H.

Referenced by populationBalanceMoments::execute(), KochFriedlanderSintering::KochFriedlanderSintering(), populationBalanceSetSizeDistribution::write(), and populationBalanceSizeDistribution::write().

Here is the caller graph for this function:

◆ fs() [2/2]

Foam::PtrList< Foam::volScalarField > & fs ( )

inline

Modify the group fractions.

Definition at line 100 of file populationBalanceModelI.H.

◆ f() [1/2]

const Foam::volScalarField & f ( const label i ) const

inline

Access a group fraction.

Definition at line 106 of file populationBalanceModelI.H.

Referenced by populationBalance::Av(), populationBalance::correct(), populationBalanceMoments::execute(), populationBalance::fSum(), growthSecondaryPropertyFvScalarFieldSource::internalCoeff(), growthGroupFractionFvScalarFieldSource::sourceCoeffs(), growthSecondaryPropertyFvScalarFieldSource::sourceCoeffs(), populationBalanceSetSizeDistribution::write(), and populationBalanceSizeDistribution::write().

Here is the caller graph for this function:

◆ f() [2/2]

Foam::volScalarField & f ( const label i )

inline

Modify a group fraction.

Definition at line 115 of file populationBalanceModelI.H.

◆ dSphs()

const Foam::PtrList< Foam::dimensionedScalar > & dSphs ( ) const

inline

Access the representative spherical diameters of the groups.

Definition at line 122 of file populationBalanceModelI.H.

Referenced by populationBalanceModel::etaV().

Here is the caller graph for this function:

◆ dSph()

const Foam::dimensionedScalar & dSph ( const label i ) const

inline

Access the representative spherical diameters of a group.

Definition at line 128 of file populationBalanceModelI.H.

Referenced by hardSphereGroupSurfaceAreaVolumeRatioFvScalarFieldSource::value().

Here is the caller graph for this function:

◆ vs()

const Foam::PtrList< Foam::dimensionedScalar > & vs ( ) const

inline

Access the representative volumes diameters of the groups.

Definition at line 138 of file populationBalanceModelI.H.

◆ v()

const Foam::dimensionedScalar & v ( const label i ) const

inline

Access the representative volumes diameters of a group.

Definition at line 144 of file populationBalanceModelI.H.

Referenced by populationBalance::Av(), LaakkonenDaughterSizeDistribution::calcNik(), uniformBinary::calcNik(), populationBalance::correct(), populationBalanceModel::eta(), populationBalanceModel::etaV(), populationBalanceMoments::execute(), growthGroupFractionFvScalarFieldSource::internalCoeff(), growthGroupFractionFvScalarFieldSource::sourceCoeffs(), ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource::value(), and populationBalanceSizeDistribution::write().

Here is the caller graph for this function:

◆ shape()

const Foam::populationBalance::shapeModel & shape ( ) const

Access the shape model.

Definition at line 1083 of file populationBalanceModel.C.

Referenced by KochFriedlanderSintering::KochFriedlanderSintering(), hardSphereGroupSurfaceAreaVolumeRatioFvScalarFieldSource::value(), and ParkRogakGroupSurfaceAreaVolumeRatioFvScalarFieldSource::value().

Here is the caller graph for this function:

◆ a()

Foam::tmp< Foam::volScalarField > a ( const label i ) const

Return the representative surface area of the group.

Definition at line 1089 of file populationBalanceModel.C.

Referenced by populationBalance::Av(), populationBalance::correct(), populationBalanceMoments::execute(), and populationBalanceSizeDistribution::write().

Here is the caller graph for this function:

◆ d()

Foam::tmp< Foam::volScalarField > d ( const label i ) const

Return the representative diameter of the group.

Definition at line 1098 of file populationBalanceModel.C.

Referenced by populationBalanceModel::etaV(), and populationBalanceMoments::execute().

Here is the caller graph for this function:

◆ dmdtfs()

const Foam::populationBalanceModel::dmdtfTable & dmdtfs ( ) const

inline

Return reference to the coalescence and breakup interfacial mass.

transfer rates

Definition at line 154 of file populationBalanceModelI.H.

◆ expansionDmdtfs()

const Foam::populationBalanceModel::dmdtfTable & expansionDmdtfs ( ) const

inline

Return reference to the expansion interfacial mass transfer rates.

Definition at line 161 of file populationBalanceModelI.H.

◆ modelSourceDmdtfs()

const Foam::populationBalanceModel::dmdtfTable & modelSourceDmdtfs ( ) const

inline

Return reference to the model source interfacial mass transfer rates.

Definition at line 168 of file populationBalanceModelI.H.

◆ solverDict()

const Foam::dictionary & solverDict ( ) const

inline

Return solution settings dictionary for this populationBalance.

Definition at line 174 of file populationBalanceModelI.H.

Referenced by populationBalanceModel::solve().

Here is the caller graph for this function:

◆ solveOnFinalIterOnly()

bool solveOnFinalIterOnly ( ) const

inline

Solve on final pimple iteration only.

Definition at line 180 of file populationBalanceModelI.H.

Referenced by populationBalance::correct(), and populationBalanceModel::solve().

Here is the caller graph for this function:

◆ coalescencePairs()

const Foam::List< Foam::Pair< Foam::label > > & coalescencePairs ( ) const

inline

Return coalescence relevant group pairs.

Definition at line 187 of file populationBalanceModelI.H.

◆ binaryBreakupPairs()

const Foam::List< Foam::Pair< Foam::label > > & binaryBreakupPairs ( ) const

inline

Return binary breakup relevant group pairs.

Definition at line 194 of file populationBalanceModelI.H.

◆ alphas()

const Foam::volScalarField & alphas ( ) const

inline

Return total void of phases belonging to this populationBalance.

Definition at line 200 of file populationBalanceModelI.H.

◆ U()

Foam::tmp< Foam::volVectorField > U ( ) const

inline

Return average velocity.

Definition at line 209 of file populationBalanceModelI.H.

◆ eta() [1/2]

Foam::dimensionedScalar eta	(	const label	i,
		const dimensionedScalar &	v
	)		const

Return the number allocation coefficient for a single volume.

Definition at line 1107 of file populationBalanceModel.C.

References Foam::dimless, Pair< Type >::first(), Foam::max(), Foam::min(), Pair< Type >::second(), and populationBalanceModel::v().

Here is the call graph for this function:

◆ eta() [2/2]

Foam::tmp< Foam::volScalarField::Internal > eta	(	const label	i,
		const volScalarField::Internal &	v
	)		const

Return the number allocation coefficient for a field of volumes.

Definition at line 1129 of file populationBalanceModel.C.

References Foam::dimless, Pair< Type >::first(), Foam::max(), Foam::min(), Pair< Type >::second(), and populationBalanceModel::v().

Here is the call graph for this function:

◆ etaV() [1/4]

Foam::dimensionedScalar etaV	(	const label	i,
		const dimensionedScalar &	v
	)		const

Return the volume allocation coefficient for a single volume.

Definition at line 1151 of file populationBalanceModel.C.

References Foam::dimless, Pair< Type >::first(), Foam::max(), Foam::min(), Pair< Type >::second(), and populationBalanceModel::v().

Referenced by populationBalanceModel::etaV(), nucleationGroupFractionFvScalarFieldSource::sourceValue(), and populationBalanceSetSizeDistribution::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ etaV() [2/4]

Foam::tmp< Foam::volScalarField::Internal > etaV	(	const label	i,
		const volScalarField::Internal &	v
	)		const

Return the volume allocation coefficient for a field of volumes.

Definition at line 1174 of file populationBalanceModel.C.

References Foam::dimless, Pair< Type >::first(), Foam::max(), Foam::min(), Pair< Type >::second(), and populationBalanceModel::v().

Here is the call graph for this function:

◆ etaV() [3/4]

Foam::dimensionedScalar etaV	(	const labelPair	is,
		const distribution &	d
	)		const

Return the volume allocation coefficient for a given distribution.

of diameters over a range of groups. The diameter distribution should be volumetrically sampled (i.e., sampleQ should equal 3).

Definition at line 1196 of file populationBalanceModel.C.

References populationBalanceModel::d(), populationBalanceModel::dSphs(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Pair< Type >::first(), populationBalanceModel::nGroups(), Foam::constant::mathematical::pi(), and Pair< Type >::second().

Here is the call graph for this function:

◆ etaV() [4/4]

Foam::dimensionedScalar etaV	(	const label	i,
		const distribution &	d
	)		const

Return the volume allocation coefficient for a given distribution.

of diameters. The diameter distribution should be volumetrically sampled (i.e., sampleQ should equal 3). The result is normalised with respect to the volume allocation coefficient for the phase.

Definition at line 1295 of file populationBalanceModel.C.

References populationBalanceModel::d(), Foam::dimless, populationBalanceModel::etaV(), Foam::max(), and populationBalanceModel::nGroups().

Here is the call graph for this function:

◆ sigmaWithContinuousPhase() [1/2]

const Foam::tmp< Foam::volScalarField > sigmaWithContinuousPhase ( const phaseModel & dispersedPhase ) const

Return the surface tension coefficient between a given dispersed.

and the continuous phase

Definition at line 1322 of file populationBalanceModel.C.

References phaseInterface::sigma().

Here is the call graph for this function:

◆ sigmaWithContinuousPhase() [2/2]

const Foam::tmp< Foam::volScalarField > sigmaWithContinuousPhase ( const label i ) const

Return the surface tension coefficient between a given group.

and the continuous phase

Definition at line 1332 of file populationBalanceModel.C.

References phaseInterface::sigma().

Here is the call graph for this function:

◆ continuousTurbulence()

const Foam::phaseCompressible::momentumTransportModel & continuousTurbulence ( ) const

Return reference to momentumTransport model of the continuous phase.

Definition at line 1342 of file populationBalanceModel.C.

References objectRegistry::lookupType(), and phaseModel::name().

Here is the call graph for this function:

◆ Sp()

Foam::tmp< Foam::volScalarField::Internal > Sp ( const label i ) const

Return the implicit coalescence and breakup source term.

Definition at line 1352 of file populationBalanceModel.C.

◆ expansionSu()

Foam::tmp< Foam::volScalarField::Internal > expansionSu	(	const label	i,
		const UPtrList< volScalarField > &	flds = `UPtrList<volScalarField>()`
	)		const

Return the explicit expansion source term.

Definition at line 1362 of file populationBalanceModel.C.

References Pair< Type >::first(), and Pair< Type >::second().

Referenced by populationBalanceModel::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ expansionSp()

Foam::tmp< Foam::volScalarField::Internal > expansionSp ( const label i ) const

Return the implicit expansion source term.

Definition at line 1378 of file populationBalanceModel.C.

References Foam::negPart(), populationBalanceModel::nGroups(), Foam::posPart(), and tmp< T >::ref().

Referenced by populationBalanceModel::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modelSourceSu()

Foam::tmp< Foam::volScalarField::Internal > modelSourceSu	(	const label	i,
		const UPtrList< volScalarField > &	flds = `UPtrList<volScalarField>()`
	)		const

Return the explicit model source source term.

Definition at line 1411 of file populationBalanceModel.C.

References Foam::dimless, Foam::dimTime, UPtrList< T >::empty(), Pair< Type >::first(), populationBalanceModel::mesh(), dimensioned< Type >::name(), DimensionedField< Type, GeoMesh, PrimitiveField >::New(), rho, and Pair< Type >::second().

Referenced by populationBalanceModel::solve().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ solve()

void solve ( )

Solve the population balance equation.

Definition at line 1434 of file populationBalanceModel.C.

References alpha(), phaseModel::alphaPhi(), fvConstraints::constrain(), Foam::correction(), Foam::fvm::ddt(), Foam::fvm::div(), Foam::endl(), populationBalanceModel::expansionSp(), populationBalanceModel::expansionSu(), pimpleNoLoopControl::finalIter(), forAll, populationBalance::fSum(), phaseSystem::fvConstraints(), phaseSystem::fvModels(), populationBalance::iFirst(), populationBalance::iLast(), phaseModel::index(), Foam::Info, dictionary::lookup(), dictionary::lookupBackwardsCompatible(), Foam::max(), populationBalanceModel::mesh(), Foam::min(), populationBalanceModel::modelSourceSu(), phaseModel::name(), IOobject::name(), diameterModel::phase(), phaseSystem::pimple(), fvMatrix< Type >::relax(), phaseModel::residualAlpha(), rho, phaseModel::rho(), fvMatrix< Type >::solve(), populationBalanceModel::solveOnFinalIterOnly(), populationBalanceModel::solverDict(), fvModels::source(), Foam::fvm::Sp(), Foam::fvm::SuSp(), IOobject::time(), and DimensionedField< Type, GeoMesh, PrimitiveField >::weightedAverage().

Here is the call graph for this function:

◆ correct()

void correct ( )

Correct derived quantities.

Definition at line 1569 of file populationBalanceModel.C.

References IOobject::AUTO_WRITE, Foam::dimLength, Foam::dimless, Foam::dimVelocity, forAll, IOobject::groupName(), Foam::inv(), Foam::max(), IOobject::name(), dimensioned< Type >::name(), GeometricField< Type, GeoMesh, PrimitiveField >::New(), IOobject::NO_READ, tmp< T >::ref(), IOobject::time(), and Foam::Zero.

Referenced by populationBalanceModel::populationBalanceModel().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeData()

bool writeData ( Ostream & os ) const

virtual

Dummy write for regIOobject.

Implements regIOobject.

Definition at line 1696 of file populationBalanceModel.C.

References IOstream::good().

Here is the call graph for this function:

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

applications/modules/multiphaseEuler/populationBalance/populationBalanceModel/populationBalanceModel.H
applications/modules/multiphaseEuler/populationBalance/populationBalanceModel/populationBalanceModel.C
applications/modules/multiphaseEuler/populationBalance/populationBalanceModel/populationBalanceModelI.H

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ dmdtfTable

Constructor & Destructor Documentation

◆ populationBalanceModel()

◆ ~populationBalanceModel()

Member Function Documentation

◆ TypeName()

◆ groupFieldIo()

◆ groupField()

◆ fluid()

◆ mesh()

◆ continuousPhase()

◆ nGroups()

◆ phases()

◆ uniquePhases()

◆ diameters()

◆ uniqueDiameters()

◆ fs() [1/2]

◆ fs() [2/2]

◆ f() [1/2]

◆ f() [2/2]

◆ dSphs()

◆ dSph()

◆ vs()

◆ v()

◆ shape()

◆ a()

◆ d()

◆ dmdtfs()

◆ expansionDmdtfs()

◆ modelSourceDmdtfs()

◆ solverDict()

◆ solveOnFinalIterOnly()

◆ coalescencePairs()

◆ binaryBreakupPairs()

◆ alphas()

◆ U()

◆ eta() [1/2]

◆ eta() [2/2]

◆ etaV() [1/4]

◆ etaV() [2/4]

◆ etaV() [3/4]

◆ etaV() [4/4]

◆ sigmaWithContinuousPhase() [1/2]

◆ sigmaWithContinuousPhase() [2/2]

◆ continuousTurbulence()

◆ Sp()

◆ expansionSu()

◆ expansionSp()

◆ modelSourceSu()

◆ solve()

◆ correct()

◆ writeData()