sizeGroup Class Reference

Single size class fraction field representing a fixed particle volume as defined by the user through the corresponding sphere equivalent diameter. More...

Inheritance diagram for sizeGroup:
Collaboration diagram for sizeGroup:

Classes

class  iNew
 Return a pointer to a new sizeGroup created from Istream. More...
 

Public Member Functions

 sizeGroup (const label i, const dictionary &dict, const velocityGroup &group)
 Construct from index, dictionary and velocity group. More...
 
autoPtr< sizeGroupclone () const
 Return clone. More...
 
virtual ~sizeGroup ()
 Destructor. More...
 
label i () const
 Return index of the size group within the population balance. More...
 
const phaseModelphase () const
 Return const-reference to the phase. More...
 
const velocityGroupgroup () const
 Return const-reference to the velocityGroup. More...
 
const dimensionedScalardSph () const
 Return representative spherical diameter of the sizeGroup. More...
 
const dimensionedScalarx () const
 Return representative volume of the sizeGroup. More...
 
shapeModelshape ()
 Return reference to the shape model. More...
 
const shapeModelshape () const
 Return const-reference to the shape model. More...
 
const tmp< volScalarFielda () const
 Return representative surface area of the sizeGroup. More...
 
const tmp< volScalarFieldd () const
 Return representative diameter of the sizeGroup. More...
 
void correct ()
 Correct secondary properties. More...
 
- Public Member Functions inherited from GeometricField< Type, GeoMesh, PrimitiveField >
 TypeName ("GeometricField")
 Runtime type information. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=Patch::calculatedType())
 Constructor given IOobject, mesh, dimensions and patch field type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Constructor given IOobject, mesh, dimensions and patch field types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=Patch::calculatedType())
 Constructor given IOobject, mesh, dimensioned<Type> More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Constructor given IOobject, mesh, dimensioned<Type> More...
 
 GeometricField (const IOobject &, const Internal &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
 Constructor from components. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const PrimitiveField< Type > &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
 Constructor from components. More...
 
 GeometricField (const IOobject &, const Mesh &)
 Construct and read given IOobject. More...
 
 GeometricField (const IOobject &, const Mesh &, const dictionary &)
 Construct from dictionary. More...
 
 GeometricField (const GeometricField< Type, GeoMesh, PrimitiveField > &)
 Copy constructor. More...
 
template<template< class > class PrimitiveField2>
 GeometricField (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 Copy constructor. More...
 
 GeometricField (GeometricField< Type, GeoMesh, PrimitiveField > &&)
 Move constructor. More...
 
 GeometricField (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
 Construct as copy of tmp. More...
 
template<template< class > class PrimitiveField2>
 GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 Construct as copy resetting IO parameters. More...
 
 GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
 Construct as copy of tmp resetting IO parameters. More...
 
template<template< class > class PrimitiveField2>
 GeometricField (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 Construct as copy resetting name. More...
 
 GeometricField (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
 Construct as copy of tmp resetting name. More...
 
template<template< class > class PrimitiveField2>
 GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
 Construct as copy resetting IO parameters and patch field type. More...
 
 GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const word &patchFieldType)
 Construct as copy of tmp resetting IO parameters. More...
 
template<template< class > class PrimitiveField2>
 GeometricField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
 Constructor from internal field and patch field type. More...
 
 GeometricField (const IOobject &, const tmp< Internal > &, const word &patchFieldType)
 Constructor from temporary internal field and patch field type. More...
 
template<template< class > class PrimitiveField2>
 GeometricField (const IOobject &, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Construct as copy resetting IO parameters and patch field types. More...
 
 GeometricField (const IOobject &, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Construct as copy of tmp resetting IO parameters. More...
 
template<template< class > class PrimitiveField2>
 GeometricField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Construct from IOobject, internal field and patch field types. More...
 
 GeometricField (const IOobject &, const tmp< Internal > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Construct from IOobject, tmp internal field and patch field types. More...
 
tmp< GeometricField< Type, GeoMesh, PrimitiveField > > clone () const
 Clone. More...
 
tmp< GeometricField< Type, GeoMesh, PrimitiveField > > cloneUnSliced () const
 Clone un-sliced. More...
 
virtual ~GeometricField ()
 Destructor. More...
 
InternalinternalFieldRef ()
 Return a reference to the dimensioned internal field. More...
 
const InternalinternalField () const
 Return a const-reference to the dimensioned internal field. More...
 
const Internalv () const
 Return a const-reference to the dimensioned internal field. More...
 
Internal::FieldTypeprimitiveFieldRef ()
 Return a reference to the primitive field. More...
 
const Internal::FieldTypeprimitiveField () const
 Return a const-reference to the primitive field. More...
 
BoundaryboundaryFieldRef ()
 Return a reference to the boundary field. More...
 
BoundaryboundaryFieldRefNoStoreOldTimes ()
 Return a reference to the boundary field without storing old times. More...
 
const BoundaryboundaryField () const
 Return const-reference to the boundary field. More...
 
SourcessourcesRef ()
 Return a reference to the sources. More...
 
const Sourcessources () const
 Return const-reference to the sources. More...
 
void storePrevIter () const
 Store the field as the previous iteration value. More...
 
void clearPrevIter ()
 Delete the previous iteration field. More...
 
const GeometricField< Type, GeoMesh, Field > & prevIter () const
 Return previous iteration field. More...
 
 USING_OLD_TIME_FIELD (GeometricField)
 Use old-time methods from the base class. More...
 
void correctBoundaryConditions ()
 Correct boundary field. More...
 
template<template< class > class PrimitiveField2>
void reset (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 Reset the field contents to the given field. More...
 
void reset (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
 Reset the field contents to the given tmp-field. More...
 
template<template< class > class PrimitiveField2>
void reset (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
 Reset the field contents to the given tmp-field. More...
 
bool needReference () const
 Does the field need a reference level for solution. More...
 
tmp< GeometricField< cmptType, GeoMesh, Field > > 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, GeoMesh, Field > > T () const
 Return transpose (only if it is a tensor field) More...
 
void relax (const scalar alpha)
 Relax field (for steady-state solution). More...
 
scalar relaxationFactor () const
 Return the field relaxation factor read from fvSolution. More...
 
void relax ()
 Relax current field with respect to the cached previous iteration. More...
 
template<template< class > class PrimitiveField2>
void relax (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &, const scalar alpha)
 Relax given field with respect to the current field. More...
 
template<template< class > class PrimitiveField2>
void relax (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
 Relax given field with respect to the current field. 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 ()
 
template<template< class > class PrimitiveField2>
void replace (const direction, const GeometricField< cmptType, GeoMesh, PrimitiveField2 > &)
 Replace a component field of the field. More...
 
template<template< class > class PrimitiveField2>
void replace (const direction, const tmp< GeometricField< cmptType, GeoMesh, PrimitiveField2 >> &)
 Replace a component field of the field. More...
 
void replace (const direction, const dimensioned< cmptType > &)
 Replace a component field of the field. More...
 
void max (const dimensioned< Type > &)
 
void min (const dimensioned< Type > &)
 
void maxMin (const dimensioned< Type > &minDt, const dimensioned< Type > &maxDt)
 
const Internaloperator() () const
 Return a const-reference to the dimensioned internal field. More...
 
void operator= (const GeometricField< Type, GeoMesh, PrimitiveField > &)
 
void operator= (GeometricField< Type, GeoMesh, PrimitiveField > &&)
 
template<template< class > class PrimitiveField2>
void operator= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 
void operator= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
 
template<template< class > class PrimitiveField2>
void operator= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator= (const dimensioned< Type > &)
 
void operator= (const zero &)
 
template<template< class > class PrimitiveField2>
void operator== (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 
void operator== (const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
 
template<template< class > class PrimitiveField2>
void operator== (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator== (const dimensioned< Type > &)
 
void operator== (const zero &)
 
template<template< class > class PrimitiveField2>
void operator+= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator+= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator+= (const dimensioned< Type > &)
 
template<template< class > class PrimitiveField2>
void operator-= (const GeometricField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator-= (const tmp< GeometricField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator-= (const dimensioned< Type > &)
 
template<template< class > class PrimitiveField2>
void operator*= (const GeometricField< scalar, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator*= (const tmp< GeometricField< scalar, GeoMesh, PrimitiveField2 >> &)
 
void operator*= (const dimensioned< scalar > &)
 
template<template< class > class PrimitiveField2>
void operator/= (const GeometricField< scalar, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator/= (const tmp< GeometricField< scalar, GeoMesh, PrimitiveField2 >> &)
 
void operator/= (const dimensioned< scalar > &)
 
tmp< VolField< scalar > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, volMesh, PrimitiveField > &sf)
 
Foam::tmp< Foam::GeometricField< Foam::scalar, Foam::volMesh > > component (const direction) const
 
void replace (const direction, const GeometricField< scalar, volMesh, PrimitiveField > &gsf)
 
template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &gf, const word &patchFieldType)
 
template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df, const word &patchFieldType)
 
template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &gf, const wordList &patchFieldTypes, const wordList &actualPatchTypes, const HashTable< word > &fieldSourceTypes)
 
template<template< class > class PrimitiveField2>
Foam::tmp< Foam::GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df, const wordList &patchFieldTypes, const wordList &actualPatchTypes, const HashTable< word > &fieldSourceTypes)
 
template<template< class > class PrimitiveField2>
void replace (const direction d, const GeometricField< typename GeometricField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &gcf)
 
template<template< class > class PrimitiveField2>
void replace (const direction d, const tmp< GeometricField< typename GeometricField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &gcf)
 
- Public Member Functions inherited from DimensionedField< Type, GeoMesh, PrimitiveField >
 TypeName ("DimensionedField")
 Runtime type information. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const bool checkIOFlags=true)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dimensioned< Type > &, const bool checkIOFlags=true)
 Construct from components. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const word &fieldDictEntry="value")
 Construct from Istream. More...
 
 DimensionedField (const IOobject &, const Mesh &mesh, const dictionary &fieldDict, const word &fieldDictEntry="value")
 Construct from dictionary. More...
 
 DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
 Copy constructor. More...
 
 DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField > &&)
 Move constructor. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Copy constructor. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
 Copy constructor or reuse as specified. More...
 
 DimensionedField (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Copy constructor of tmp<DimensionedField> deleting argument. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool checkIOFlags=true)
 Copy constructor resetting IO parameters. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse, const bool checkIOFlags=true)
 Copy constructor resetting IO parameters and reuse as specified. More...
 
 DimensionedField (const IOobject &, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &, const bool checkIOFlags=true)
 Copy constructor from tmp resetting IO parameters. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Copy constructor resetting name. More...
 
template<template< class > class PrimitiveField2>
 DimensionedField (const word &newName, DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const bool reuse)
 Copy constructor resetting name and reuse as specified. More...
 
 DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Copy constructor from tmp resetting name. More...
 
tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > clone () const
 Clone. More...
 
virtual ~DimensionedField ()
 Destructor. More...
 
void readField (const dictionary &fieldDict, const word &fieldDictEntry="value")
 
const Meshmesh () const
 Return mesh. More...
 
const dimensionSetdimensions () const
 Return dimensions. More...
 
dimensionSetdimensions ()
 Return non-const access to dimensions. More...
 
PrimitiveField< Type > & primitiveFieldRef ()
 Return a reference to the internal field. More...
 
const PrimitiveField< Type > & primitiveField () const
 Return a const-reference to the primitive field. More...
 
 USING_OLD_TIME_FIELD (DimensionedField)
 Use old-time methods from the base class. More...
 
tmp< DimensionedField< cmptType, GeoMesh, Field > > component (const direction) const
 Return a component field of the field. More...
 
template<template< class > class PrimitiveField2>
void replace (const direction, const DimensionedField< cmptType, GeoMesh, PrimitiveField2 > &)
 Replace a component field of the field. More...
 
template<template< class > class PrimitiveField2>
void replace (const direction, const tmp< DimensionedField< cmptType, GeoMesh, PrimitiveField2 >> &)
 Replace a component field of the field. More...
 
tmp< DimensionedField< Type, GeoMesh, Field > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
dimensioned< Type > average () const
 Calculate and return arithmetic average. More...
 
template<template< class > class PrimitiveField2>
dimensioned< Type > weightedAverage (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &) const
 Calculate and return weighted average. More...
 
template<template< class > class PrimitiveField2>
dimensioned< Type > weightedAverage (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &) const
 Calculate and return weighted average. More...
 
template<template< class > class PrimitiveField2>
void reset (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Reset the field values to the given field. More...
 
void reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Reset the field values to the given tmp-field. More...
 
template<template< class > class PrimitiveField2>
void reset (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 Reset the field values to the given tmp-field. More...
 
bool writeData (Ostream &, const word &fieldDictEntry) const
 
void operator= (const DimensionedField< Type, GeoMesh, PrimitiveField > &)
 
void operator= (DimensionedField< Type, GeoMesh, PrimitiveField > &&)
 
void operator= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 
template<template< class > class PrimitiveField2>
void operator= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator= (const dimensioned< Type > &)
 
void operator= (const zero &)
 
template<template< class > class PrimitiveField2>
void operator== (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator== (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator== (const dimensioned< Type > &)
 
void operator== (const zero &)
 
template<template< class > class PrimitiveField2>
void operator+= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator+= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator+= (const dimensioned< Type > &)
 
template<template< class > class PrimitiveField2>
void operator-= (const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator-= (const tmp< DimensionedField< Type, GeoMesh, PrimitiveField2 >> &)
 
void operator-= (const dimensioned< Type > &)
 
template<template< class > class PrimitiveField2>
void operator*= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator*= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)
 
void operator*= (const dimensioned< scalar > &)
 
template<template< class > class PrimitiveField2>
void operator/= (const DimensionedField< scalar, GeoMesh, PrimitiveField2 > &)
 
template<template< class > class PrimitiveField2>
void operator/= (const tmp< DimensionedField< scalar, GeoMesh, PrimitiveField2 >> &)
 
void operator/= (const dimensioned< scalar > &)
 
template<template< class > class PrimitiveField2>
Foam::tmp< Foam::DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &df)
 
template<template< class > class PrimitiveField2>
void replace (const direction d, const DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > &df)
 
template<template< class > class PrimitiveField2>
void replace (const direction d, const tmp< DimensionedField< typename DimensionedField< Type, GeoMesh, PrimitiveField >::cmptType, GeoMesh, PrimitiveField2 > > &tdf)
 
- 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 regIOobject &)
 Copy constructor. More...
 
 regIOobject (regIOobject &&)
 Move constructor. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Copy constructor, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Copy constructor with new name, transferring registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Copy constructor with new IO parameters. 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 fileNamecaseName () 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...
 
label eventNo () const
 Event number at last update. More...
 
labeleventNo ()
 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...
 
IstreamreadStream (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 labelListwatchIndices () const
 Return file-monitoring handles. More...
 
labelListwatchIndices ()
 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 fileNamecaseName (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< IOobjectclone () const
 Clone. More...
 
autoPtr< IOobjectclone (const objectRegistry &registry) const
 Clone resetting registry. More...
 
virtual ~IOobject ()
 Destructor. More...
 
const Timetime () const
 Return time. More...
 
const objectRegistrydb () const
 Return the local objectRegistry. More...
 
const wordname () const
 Return name. More...
 
const wordheaderClassName () const
 Return name of the class name read from header. More...
 
wordheaderClassName ()
 Return name of the class name read from header. More...
 
stringnote ()
 Return non-constant access to the optional note. More...
 
const stringnote () 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
 
readOptionreadOpt ()
 
writeOption writeOpt () const
 
writeOptionwriteOpt ()
 
word group () const
 Return group (extension part of name) More...
 
word member () const
 Return member (name without the extension) More...
 
const fileNamerootPath () const
 
const fileNamecaseName (const bool global) const
 
fileNameinstance () 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 fileNamelocal () 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< IOobjectinfo () const
 Return info proxy. More...
 
void operator= (const IOobject &)
 
template<class Name >
Foam::word groupName (Name name, const word &group)
 
- Public Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
 OldTimeField (const label timeIndex)
 Construct from a time index. More...
 
 OldTimeField (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &otf)
 Copy construct. More...
 
 OldTimeField (OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &&otf)
 Move construct. More...
 
 ~OldTimeField ()
 Destructor. More...
 
label timeIndex () const
 Return the time index of the field. More...
 
labeltimeIndex ()
 Return a non-const reference to the time index of the field. More...
 
bool isOldTime () const
 Return whether or not this is an old-time field. More...
 
bool hasStoredOldTimes () const
 Return whether old-time fields have been stored yet. More...
 
void storeOldTimes () const
 Store the old-time fields. More...
 
void clearOldTimes ()
 Clear old-time fields. More...
 
void nullOldestTime ()
 Set the oldest field pointer to nullObjectPtr. This removes the. More...
 
label nOldTimes (const bool includeNull=true) const
 Return the number of old-time fields stored. More...
 
const Field0Type & oldTime () const
 Return the old-time field. More...
 
const Field0Type & oldTime (const label n) const
 Return the n-th old-time field. More...
 
Field0Type & oldTimeRef ()
 Return a non-const reference to the old-time field. More...
 
Field0Type & oldTimeRef (const label n)
 Return a non-const reference to the n-th old time field. More...
 
void operator= (const OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > >
 OldTimeField (const label timeIndex)
 Construct from a time index. More...
 
 OldTimeField (const OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &otf)
 Copy construct. More...
 
 OldTimeField (OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &&otf)
 Move construct. More...
 
 ~OldTimeField ()
 Destructor. More...
 
label timeIndex () const
 Return the time index of the field. More...
 
labeltimeIndex ()
 Return a non-const reference to the time index of the field. More...
 
bool isOldTime () const
 Return whether or not this is an old-time field. More...
 
bool hasStoredOldTimes () const
 Return whether old-time fields have been stored yet. More...
 
void storeOldTimes () const
 Store the old-time fields. More...
 
void clearOldTimes ()
 Clear old-time fields. More...
 
void nullOldestTime ()
 Set the oldest field pointer to nullObjectPtr. This removes the. More...
 
label nOldTimes (const bool includeNull=true) const
 Return the number of old-time fields stored. More...
 
const Field0Type & oldTime () const
 Return the old-time field. More...
 
const Field0Type & oldTime (const label n) const
 Return the n-th old-time field. More...
 
Field0Type & oldTimeRef ()
 Return a non-const reference to the old-time field. More...
 
Field0Type & oldTimeRef (const label n)
 Return a non-const reference to the n-th old time field. More...
 
void operator= (const OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > > &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static IOobject fieldIo (const word &name, const label i, const velocityGroup &group, const IOobject::readOption r=IOobject::NO_READ, const bool registerObject=true)
 Return IO for a size-group field. Construction helper. More...
 
static tmp< volScalarFieldfield (const word &name, const label i, const velocityGroup &group)
 Return IO a size-group field. Construction helper. More...
 
- Static Public Member Functions inherited from GeometricField< Type, GeoMesh, PrimitiveField >
static const GeometricField< Type, GeoMesh, PrimitiveField > & null ()
 Return a null geometric field. More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Internal &, const PtrList< Patch > &, const HashPtrTable< Source > &=HashPtrTable< Source >())
 Return a temporary field constructed from name,. More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &, const dimensionSet &, const word &patchFieldType=Patch::calculatedType())
 Return a temporary field constructed from name, mesh, dimensionSet. More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=Patch::calculatedType())
 Return a temporary field constructed from mesh, dimensioned<Type> More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &, const dimensioned< Type > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Return a temporary field constructed from mesh, dimensioned<Type> More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &)
 Rename temporary field and return. More...
 
template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
 Rename field, reset patch field type and return. More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const word &patchFieldType)
 Rename temporary field, reset patch field type and return. More...
 
template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &name, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const word &patchFieldType)
 Return a temporary field constructed from name,. More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &name, const tmp< Internal > &, const word &patchFieldType)
 Return a temporary field constructed from name,. More...
 
template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const GeometricField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Rename and reset patch fields types of field and return. More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const tmp< GeometricField< Type, GeoMesh, PrimitiveField >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Rename and reset patch fields types of temporary field and return. More...
 
template<template< class > class PrimitiveField2>
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Return a temporary field constructed from IOobject,. More...
 
static tmp< GeometricField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const tmp< Internal > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Return a temporary field constructed from IOobject,. More...
 
- Static Public Member Functions inherited from DimensionedField< Type, GeoMesh, PrimitiveField >
static const DimensionedField< Type, GeoMesh, PrimitiveField > & null ()
 Return a null DimensionedField. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &mesh, const dimensionSet &, const PrimitiveField< Type > &)
 Return a temporary field constructed from name, mesh,. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &mesh, const dimensionSet &)
 Return a temporary field constructed from name, mesh. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &name, const Mesh &mesh, const dimensioned< Type > &)
 Return a temporary field constructed from name, mesh. More...
 
template<template< class > class PrimitiveField2>
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const DimensionedField< Type, GeoMesh, PrimitiveField2 > &)
 Return a temporary field constructed from name and a field. More...
 
static tmp< DimensionedField< Type, GeoMesh, PrimitiveField > > New (const word &newName, const tmp< DimensionedField< Type, GeoMesh, PrimitiveField >> &)
 Return renamed temporary 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...
 

Additional Inherited Members

- Public Types inherited from GeometricField< Type, GeoMesh, PrimitiveField >
typedef GeoMesh::Mesh Mesh
 Type of mesh on which this GeometricField is instantiated. More...
 
typedef DimensionedField< Type, GeoMesh, PrimitiveField > Internal
 Type of the internal field from which this GeometricField is derived. More...
 
typedef DimensionedField< Type, GeoMesh, PrimitiveField > Base
 Type of the field from which this GeometricField is derived. More...
 
typedef GeoMesh::template PatchField< Type > Patch
 Type of the patch field of which the Boundary is composed. More...
 
typedef GeometricBoundaryField< Type, GeoMesh, PrimitiveField > Boundary
 Type of the boundary field. More...
 
typedef GeoMesh::template FieldSource< Type > Source
 Type of the field source of which the Sources is composed. More...
 
typedef GeometricFieldSources< Type, GeoMesh, PrimitiveField > Sources
 Type of the field sources. More...
 
typedef Field< Type >::cmptType cmptType
 Component type of the elements of the field. More...
 
- Public Types inherited from DimensionedField< Type, GeoMesh, PrimitiveField >
typedef GeoMesh::Mesh Mesh
 Type of mesh on which this DimensionedField is instantiated. More...
 
typedef PrimitiveField< Type > FieldType
 Type of the field from which this DimensionedField is derived. More...
 
typedef PrimitiveField< Type > Base
 Type of the field from which this DimensionedField is derived. More...
 
typedef PrimitiveField< Type >::cmptType cmptType
 Component type of the elements of the field. 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...
 
- 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...
 
- Protected Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh, PrimitiveField > >
bool readOldTimeIfPresent ()
 Read old-time field from file if it is present. More...
 
void copyOldTimes (const IOobject &io, const OtherOldTime< OtherPrimitiveField > &)
 Copy the old-times from the given field. More...
 
void copyOldTimes (const word &newName, const OtherOldTime< OtherPrimitiveField > &)
 Copy the old-times from the given field. More...
 
- Protected Member Functions inherited from OldTimeField< GeometricField< Type, GeoMesh, PrimitiveField > >
bool readOldTimeIfPresent ()
 Read old-time field from file if it is present. More...
 
void copyOldTimes (const IOobject &io, const OtherOldTime< OtherPrimitiveField > &)
 Copy the old-times from the given field. More...
 
void copyOldTimes (const word &newName, const OtherOldTime< OtherPrimitiveField > &)
 Copy the old-times from the given field. More...
 

Detailed Description

Single size class fraction field representing a fixed particle volume as defined by the user through the corresponding sphere equivalent diameter.

If present, the field is read from the start time directory, e.g. during restart. Otherwise, it is constructed as a uniform field using the size class fraction value provided by the user. In the latter case, the boundary condition types are taken from the 'f.<phaseName>' field, which represents the sum of all size group fractions of a phase. The user specified value is also applied at fixed value boundary conditions and used as inlet value for mixed boundary conditions.

An alternative diameter field is provided by the selected shape model, e.g. a collisional diameter, which is then utilised in selected population balance submodels, e.g. for modelling fractal aggregation.

Usage
Property Description Required Default value
dSph Sphere equivalent diameter yes none
shapeModel Shape model providing an alternative diameter field yes none
See also
Foam::diameterModels::populationBalanceModel Foam::diameterModels::velocityGroup Foam::diameterModels::shapeModel
Source files

Definition at line 93 of file sizeGroup.H.

Constructor & Destructor Documentation

◆ sizeGroup()

sizeGroup ( const label  i,
const dictionary dict,
const velocityGroup group 
)

Construct from index, dictionary and velocity group.

Definition at line 88 of file sizeGroup.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, sizeGroup::group(), IOobject::groupName(), sizeGroup::i(), phaseModel::name(), IOobject::name(), diameterModel::phase(), and velocityGroup::popBalName().

Referenced by sizeGroup::iNew::operator()().

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

◆ ~sizeGroup()

~sizeGroup ( )
virtual

Destructor.

Definition at line 120 of file sizeGroup.C.

Member Function Documentation

◆ fieldIo()

Foam::IOobject fieldIo ( const word name,
const label  i,
const velocityGroup group,
const IOobject::readOption  r = IOobject::NO_READ,
const bool  registerObject = true 
)
static

◆ field()

Foam::tmp< Foam::volScalarField > field ( const word name,
const label  i,
const velocityGroup group 
)
static

Return IO a size-group field. Construction helper.

Definition at line 60 of file sizeGroup.C.

References sizeGroup::field(), Foam::constant::atomic::group, typeIOobject< Type >::headerOk(), IOobject::MUST_READ, and Foam::name().

Referenced by sizeGroup::field().

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

◆ clone()

autoPtr<sizeGroup> clone ( ) const
inline

Return clone.

Definition at line 152 of file sizeGroup.H.

References NotImplemented.

◆ i()

◆ phase()

◆ group()

◆ dSph()

◆ x()

◆ shape() [1/2]

Return reference to the shape model.

Definition at line 127 of file sizeGroup.C.

◆ shape() [2/2]

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

Return const-reference to the shape model.

Definition at line 134 of file sizeGroup.C.

◆ a()

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

Return representative surface area of the sizeGroup.

Definition at line 140 of file sizeGroup.C.

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

Here is the caller graph for this function:

◆ d()

◆ correct()

void correct ( )

Correct secondary properties.

Definition at line 153 of file sizeGroup.C.


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