Classes | Public Member Functions | List of all members
sizeGroup Class Reference

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:
Inheritance graph
[legend]
Collaboration diagram for sizeGroup:
Collaboration graph
[legend]

Classes

class  iNew
 

Public Member Functions

 sizeGroup (const word &name, const dictionary &dict, const phaseModel &phase, const velocityGroup &velocityGroup, const fvMesh &mesh)
 
autoPtr< sizeGroupclone () const
 
virtual ~sizeGroup ()
 
const wordkeyword () const
 
const phaseModelphase () const
 
const velocityGroupVelocityGroup () const
 
const dimensionedScalard () const
 
const dimensionedScalarx () const
 
- Public Member Functions inherited from GeometricField
 TypeName ("GeometricField")
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const word &patchFieldType=PatchField< Type >::calculatedType())
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensioned< Type > &dt, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 
 GeometricField (const IOobject &io, const Internal &diField, const PtrList< PatchField< Type >> &ptfl)
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const word &patchFieldType=PatchField< Type >::calculatedType())
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, Field< Type > &&iField, const word &patchFieldType=PatchField< Type >::calculatedType())
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dimensionSet &ds, const Field< Type > &iField, const PtrList< PatchField< Type >> &ptfl)
 
 GeometricField (const IOobject &io, const Mesh &mesh, const bool readOldTime=true)
 
 GeometricField (const IOobject &io, const Mesh &mesh, const dictionary &dict)
 
 GeometricField (const GeometricField< Type, PatchField, GeoMesh > &gf)
 
 GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
 
 GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf)
 
 GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
 
 GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &gf)
 
 GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf)
 
 GeometricField (const IOobject &io, const GeometricField< Type, PatchField, GeoMesh > &gf, const word &patchFieldType)
 
 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())
 
 GeometricField (const IOobject &io, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 
tmp< GeometricField< Type, PatchField, GeoMesh > > clone () const
 
virtual ~GeometricField ()
 
Internalref (const bool updateAccessTime=true)
 
const InternalinternalField () const
 
const Internalv () const
 
Internal::FieldTypeprimitiveFieldRef (const bool updateAccessTime=true)
 
const Internal::FieldTypeprimitiveField () const
 
BoundaryboundaryFieldRef (const bool updateAccessTime=true)
 
const BoundaryboundaryField () const
 
label timeIndex () const
 
label & timeIndex ()
 
void storeOldTimes () const
 
void storeOldTime () const
 
label nOldTimes () const
 
const GeometricField< Type, PatchField, GeoMesh > & oldTime () const
 
GeometricField< Type, PatchField, GeoMesh > & oldTime ()
 
void storePrevIter () const
 
const GeometricField< Type, PatchField, GeoMesh > & prevIter () const
 
void correctBoundaryConditions ()
 
bool needReference () const
 
tmp< GeometricField< cmptType, PatchField, GeoMesh > > component (const direction) const
 
bool writeData (Ostream &) const
 
tmp< GeometricField< Type, PatchField, GeoMesh > > T () const
 
void relax (const scalar alpha)
 
void relax ()
 
word select (bool final) const
 
void writeMinMax (Ostream &os) const
 
void negate ()
 
void replace (const direction d, const GeometricField< cmptType, PatchField, GeoMesh > &gcf)
 
void replace (const direction d, const dimensioned< cmptType > &ds)
 
void min (const dimensioned< Type > &dt)
 
void max (const dimensioned< Type > &dt)
 
void clip (const dimensioned< MinMax< Type >> &range)
 
void clip (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
 
void maxMin (const dimensioned< Type > &minVal, const dimensioned< Type > &maxVal)
 
const Internaloperator() () const
 
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 > &)
 
tmp< GeometricField< scalar, faPatchField, areaMesh > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &gsf)
 
tmp< GeometricField< scalar, faPatchField, areaMesh > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, faPatchField, areaMesh > &sf)
 
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &gsf)
 
tmp< GeometricField< scalar, fvPatchField, volMesh > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, fvPatchField, volMesh > &sf)
 

Additional Inherited Members

- Public Types inherited from GeometricField
typedef GeoMesh::Mesh Mesh
 
typedef GeoMesh::BoundaryMesh BoundaryMesh
 
typedef DimensionedField< Type, GeoMeshInternal
 
typedef PatchField< Type > Patch
 
typedef Field< Type >::cmptType cmptType
 
- Static Public Member Functions inherited from GeometricField
static const GeometricField< Type, PatchField, GeoMesh > & null ()
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &name, const Mesh &mesh, const dimensionSet &ds, const word &patchFieldType=PatchField< Type >::calculatedType())
 
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)
 
static tmp< GeometricField< Type, PatchField, GeoMesh > > New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &tgf, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 

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 92 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 29 of file sizeGroup.C.

References f(), and forAll.

Here is the call graph for this function:

◆ ~sizeGroup()

~sizeGroup ( )
virtual

Definition at line 89 of file sizeGroup.C.

Member Function Documentation

◆ clone()

Definition at line 96 of file sizeGroup.C.

References NotImplemented.

◆ keyword()

const Foam::word & keyword ( ) const
inline

Definition at line 24 of file sizeGroupI.H.

References Foam::name().

Here is the call graph for this function:

◆ phase()

const Foam::phaseModel & phase ( ) const
inline

◆ VelocityGroup()

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

Definition at line 38 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

◆ x()

const Foam::dimensionedScalar & x ( ) const
inline

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