This class represents a single sizeGroup belonging to a velocityGroup. The main property of a sizeGroup is its representative diameter. The corresponding volScalarField f<number>.<phaseName>.<populationBalanceName> gives the volume fraction of the sizeGroup such that all sizeGroup fractions over a velocityGroup must sum to unity. The field is either read from the startTime directory if present or constructed from a reference field called f.<phaseName>.<populationBalanceName> where the boundary condition types must be specified. All field and boundary condition values are reset to match the "value" given in the sizeGroup subdictionary. More...

Inheritance diagram for sizeGroup:

[legend]

Collaboration diagram for sizeGroup:

[legend]

Classes
class	iNew
	Return a pointer to a new sizeGroup created on freestore. More...

Public Member Functions
	sizeGroup (const word &name, const dictionary &dict, const phaseModel &phase, const velocityGroup &velocityGroup, const fvMesh &mesh)

autoPtr< sizeGroup >	clone () const
	Return clone. More...

virtual	~sizeGroup ()
	Destructor. More...

const word &	keyword () const

const phaseModel &	phase () const
	Return const-reference to the phase. More...

const velocityGroup &	VelocityGroup () const
	Return const-reference to the velocityGroup. More...

const dimensionedScalar &	d () const
	Return representative diameter of the sizeGroup. More...

const dimensionedScalar &	x () const
	Return representative volume of the sizeGroup. More...

Public Member Functions inherited from GeometricField< Type, PatchField, GeoMesh >
	TypeName ("GeometricField")
	Runtime type information. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct given IOobject, mesh, dimensions and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensions and patch types. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
	Construct given IOobject, mesh, dimensioned<Type> and patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
	Construct given IOobject, mesh, dimensioned<Type> and patch types. More...

	GeometricField (const IOobject &io, const Internal &diField, const PtrList< PatchField< Type >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Copy construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
	Move construct from internal field, with specified patch type. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const PtrList< PatchField< Type >> &ptfl)
	Copy construct from components. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
	Construct and read given IOobject. More...

	GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict)
	Construct from dictionary. More...

	GeometricField (const GeometricField< Type, PatchField, GeoMesh > &gf)
	Copy construct. More...

	GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	Construct from tmp<GeometricField> deleting argument. More...

	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf)
	Construct as copy resetting IO parameters. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	Construct as copy of tmp<GeometricField> resetting IO parameters. More...

	GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &gf)
	Copy construct with a new name. More...

	GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	Construct with a new name from tmp<GeometricField> More...

	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const word &patchFieldType)
	Construct as copy resetting IO parameters and patch type. More...

	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const labelList &patchIDs, const word &patchFieldType)

	GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

	GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Construct as copy resetting IO parameters and boundary types. More...

tmp< GeometricField< Type, PatchField, GeoMesh > >	clone () const
	Clone. More...

virtual	~GeometricField ()
	Destructor. More...

Internal &	ref (const bool updateAccessTime=true)
	Return a reference to the dimensioned internal field. More...

const Internal &	internalField () const
	Return a const-reference to the dimensioned internal field. More...

const Internal &	v () const

Internal::FieldType &	primitiveFieldRef (const bool updateAccessTime=true)
	Return a reference to the internal field. More...

const Internal::FieldType &	primitiveField () const
	Return a const-reference to the internal field. More...

Boundary &	boundaryFieldRef (const bool updateAccessTime=true)
	Return a reference to the boundary field. More...

const Boundary &	boundaryField () const
	Return const-reference to the boundary field. More...

label	timeIndex () const
	Return the time index of the field. More...

label &	timeIndex ()
	Return the time index of the field. More...

void	storeOldTimes () const
	Store the old-time fields. More...

void	storeOldTime () const
	Store the old-time field. More...

label	nOldTimes () const
	Return the number of old time fields stored. More...

const GeometricField< Type, PatchField, GeoMesh > &	oldTime () const
	Return old time field. More...

GeometricField< Type, PatchField, GeoMesh > &	oldTime ()
	Return non-const old time field. More...

void	storePrevIter () const
	Store the field as the previous iteration value. More...

const GeometricField< Type, PatchField, GeoMesh > &	prevIter () const
	Return previous iteration field. More...

void	correctBoundaryConditions ()
	Correct boundary field. More...

bool	needReference () const
	Does the field need a reference level for solution. More...

tmp< GeometricField< cmptType, PatchField, GeoMesh > >	component (const direction) const
	Return a component of the field. More...

bool	writeData (Ostream &) const
	WriteData member function required by regIOobject. More...

tmp< GeometricField< Type, PatchField, GeoMesh > >	T () const
	Return transpose (only if it is a tensor field) More...

void	relax (const scalar alpha)
	Relax field (for steady-state solution). More...

void	relax ()
	Relax field (for steady-state solution). More...

word	select (bool final) const
	Select the final iteration parameters if `final' is true. More...

void	writeMinMax (Ostream &os) const
	Helper function to write the min and max to an Ostream. More...

void	negate ()
	Negate the field inplace. More...

void	replace (const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &gcf)
	Replace specified field component with content from another field. More...

void	replace (const direction d, const dimensioned< cmptType > &ds)
	Replace specified field component with specified value. More...

void	min (const dimensioned< Type > &dt)
	Use the minimum of the field and specified value. More...

void	max (const dimensioned< Type > &dt)
	Use the maximum of the field and specified value. More...

void	clip (const dimensioned< MinMax< Type >> &range)
	Clip the field to be bounded within the specified range. More...

void	clip (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
	Clip the field to be bounded within the specified range. More...

void	maxMin (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
	Deprecated(2019-01) identical to clip() More...

const Internal &	operator() () const
	Return a const-reference to the dimensioned internal field. More...

void	operator= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)

void	operator= (const dimensioned< Type > &)

void	operator== (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)

void	operator== (const dimensioned< Type > &)

void	operator+= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator+= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)

void	operator-= (const GeometricField< Type, PatchField, GeoMesh > &)

void	operator-= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)

void	operator*= (const GeometricField< scalar, PatchField, GeoMesh > &)

void	operator*= (const tmp< GeometricField< scalar, PatchField, GeoMesh >> &)

void	operator/= (const GeometricField< scalar, PatchField, GeoMesh > &)

void	operator/= (const tmp< GeometricField< scalar, PatchField, GeoMesh >> &)

void	operator+= (const dimensioned< Type > &)

void	operator-= (const dimensioned< Type > &)

void	operator*= (const dimensioned< scalar > &)

void	operator/= (const dimensioned< scalar > &)

template<>
tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

template<>
void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)

template<>
tmp< GeometricField< scalar, faPatchField, areaMesh > >	component (const direction) const

template<>
void	replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)

template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

template<>
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)

template<>
tmp< GeometricField< scalar, fvPatchField, volMesh > >	component (const direction) const

template<>
void	replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)

Additional Inherited Members
Public Types inherited from GeometricField< Type, PatchField, GeoMesh >
typedef GeoMesh::Mesh	Mesh
	Type of mesh on which this GeometricField is instantiated. More...

typedef GeoMesh::BoundaryMesh	BoundaryMesh

typedef DimensionedField< Type, GeoMesh >	Internal
	Type of the internal field from which this GeometricField is derived. More...

typedef PatchField< Type >	Patch

typedef Field< Type >::cmptType	cmptType

Static Public Member Functions inherited from GeometricField< Type, PatchField, GeoMesh >
static const GeometricField< Type, PatchField, GeoMesh > &	null ()
	Return a null geometric field. More...

static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
	Return tmp field from name, mesh, dimensions and patch type. More...

static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())

static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())

static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())

static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &name, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())

static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
	Return renamed tmp field. More...

static tmp< GeometricField< Type, PatchField, GeoMesh > >	New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
	Rename tmp field and reset patch field types and return. More...

Detailed Description

This class represents a single sizeGroup belonging to a velocityGroup. The main property of a sizeGroup is its representative diameter. The corresponding volScalarField f<number>.<phaseName>.<populationBalanceName> gives the volume fraction of the sizeGroup such that all sizeGroup fractions over a velocityGroup must sum to unity. The field is either read from the startTime directory if present or constructed from a reference field called f.<phaseName>.<populationBalanceName> where the boundary condition types must be specified. All field and boundary condition values are reset to match the "value" given in the sizeGroup subdictionary.

Usage

Property	Description	Required	Default value
`d`	Representative diameter	yes
`value`	Field and BC value	yes

Example

    f1
    {
        d            3e-3;
        value        1.0;
    }

See also: Foam::diameterModels::velocityGroup Foam::diameterModels::populationBalanceModel

Source files

Definition at line 96 of file sizeGroup.H.

Constructor & Destructor Documentation

◆ sizeGroup()

sizeGroup	(	const word &	name,
		const dictionary &	dict,
		const phaseModel &	phase,
		const velocityGroup &	velocityGroup,
		const fvMesh &	mesh
	)

Definition at line 36 of file sizeGroup.C.

References f(), and forAll.

Here is the call graph for this function:

◆ ~sizeGroup()

~sizeGroup ( )

virtual

Destructor.

Definition at line 96 of file sizeGroup.C.

Member Function Documentation

◆ clone()

Foam::autoPtr< Foam::diameterModels::sizeGroup > clone ( ) const

Return clone.

Definition at line 103 of file sizeGroup.C.

References NotImplemented.

◆ keyword()

const Foam::word & keyword ( ) const

inline

Definition at line 31 of file sizeGroupI.H.

References Foam::name().

Here is the call graph for this function:

◆ phase()

const Foam::phaseModel & phase ( ) const

inline

Return const-reference to the phase.

Definition at line 38 of file sizeGroupI.H.

Referenced by LehrMilliesMewes::addToBinaryBreakupRate(), LuoSvendsen::addToBinaryBreakupRate(), CoulaloglouTavlaridesCoalescence::addToCoalescenceRate(), LehrMilliesMewesCoalescence::addToCoalescenceRate(), Luo::addToCoalescenceRate(), PrinceBlanch::addToCoalescenceRate(), densityChangeDrift::addToDriftRate(), constantDrift::addToDriftRate(), phaseChange::addToDriftRate(), constantNucleation::addToNucleationRate(), wallBoiling::addToNucleationRate(), constantDrift::correct(), phaseChange::correct(), LaakkonenAlopaeusAittamaa::setBreakupRate(), and populationBalanceModel::solve().

Here is the caller graph for this function:

◆ VelocityGroup()

const Foam::diameterModels::velocityGroup & VelocityGroup ( ) const

inline

Return const-reference to the velocityGroup.

Definition at line 45 of file sizeGroupI.H.

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

Here is the caller graph for this function:

◆ d()

const Foam::dimensionedScalar & d ( ) const

inline

Return representative diameter of the sizeGroup.

Definition at line 52 of file sizeGroupI.H.

Referenced by LehrMilliesMewes::addToBinaryBreakupRate(), LuoSvendsen::addToBinaryBreakupRate(), hydrodynamic::addToCoalescenceRate(), LehrMilliesMewesCoalescence::addToCoalescenceRate(), Luo::addToCoalescenceRate(), PrinceBlanch::addToCoalescenceRate(), phaseChange::addToDriftRate(), phaseChange::correct(), LaakkonenAlopaeusAittamaa::setBreakupRate(), sizeDistribution::write(), and sizeDistribution::writeFileHeader().

Here is the caller graph for this function:

◆ x()

const Foam::dimensionedScalar & x ( ) const

inline

Return representative volume of the sizeGroup.

Definition at line 59 of file sizeGroupI.H.

Referenced by powerLawUniformBinary::addToBinaryBreakupRate(), LuoSvendsen::addToBinaryBreakupRate(), CoulaloglouTavlaridesCoalescence::addToCoalescenceRate(), phaseChange::addToDriftRate(), constantNucleation::addToNucleationRate(), wallBoiling::addToNucleationRate(), constantDrift::correct(), phaseChange::correct(), powerLaw::setBreakupRate(), exponential::setBreakupRate(), sizeDistribution::write(), and sizeDistribution::writeFileHeader().

Here is the caller graph for this function:

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

src/phaseSystemModels/reactingEulerFoam/phaseSystems/diameterModels/velocityGroup/sizeGroup/sizeGroup.H
src/phaseSystemModels/reactingEulerFoam/phaseSystems/diameterModels/velocityGroup/sizeGroup/sizeGroup.C
src/phaseSystemModels/reactingEulerFoam/phaseSystems/diameterModels/velocityGroup/sizeGroup/sizeGroupI.H

Classes

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ sizeGroup()

◆ ~sizeGroup()

Member Function Documentation

◆ clone()

◆ keyword()

◆ phase()

◆ VelocityGroup()

◆ d()

◆ x()