This class represents a single sizeGroup belonging to a velocityGroup. The main property of a sizeGroup is its representative volume. 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...
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 dictionary & | dict () const |
| Return const-reference to the dictionary. More... | |
| const phaseModel & | phase () const |
| Return const-reference to the phase. More... | |
| const velocityGroup & | VelocityGroup () const |
| Return const-reference to the velocityGroup. More... | |
| const dimensionedScalar & | dSph () const |
| Return representative spherical diameter of the sizeGroup. More... | |
| const dimensionedScalar & | x () const |
| Return representative volume of the sizeGroup. More... | |
| autoPtr< shapeModel > & | shapeModelPtr () |
| Return reference to diameterModel of the phase. More... | |
| const autoPtr< shapeModel > & | shapeModelPtr () const |
| Return const-reference to diameterModel of the phase. More... | |
| const autoPtr< label > & | i () const |
| Return label of the sizeGroup within the population balance. More... | |
| const tmp< volScalarField > | a () const |
| Return representative surface area of the sizeGroup. More... | |
| const tmp< volScalarField > | d () const |
| Return representative diameter of the sizeGroup. More... | |
| void | correct () |
| Correct secondary properties. More... | |
 Public Member Functions inherited from GeometricField< Type, PatchField, GeoMesh > | |
| TypeName ("GeometricField") | |
| Runtime type information. More... | |
| GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::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()) | |
| Constructor given IOobject, mesh, dimensions and patch field types. More... | |
| GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType()) | |
| Constructor given IOobject, mesh, dimensioned<Type> More... | |
| GeometricField (const IOobject &, const Mesh &, const dimensioned< Type > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList()) | |
| Constructor given IOobject, mesh, dimensioned<Type> More... | |
| GeometricField (const IOobject &, const Internal &, const PtrList< PatchField< Type >> &) | |
| Constructor from components. More... | |
| GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type >> &) | |
| 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, PatchField, GeoMesh > &) | |
| Copy constructor. More... | |
| GeometricField (GeometricField< Type, PatchField, GeoMesh > &&) | |
| Move constructor. More... | |
| GeometricField (const tmp< GeometricField< Type, PatchField, GeoMesh >> &) | |
| Construct as copy of tmp<GeometricField> deleting argument. More... | |
| GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &) | |
| Construct as copy resetting IO parameters. More... | |
| GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh >> &) | |
| Construct as copy of tmp<GeometricField> resetting IO parameters. More... | |
| GeometricField (const word &newName, const GeometricField< Type, PatchField, GeoMesh > &) | |
| Construct as copy resetting name. More... | |
| GeometricField (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &) | |
| Construct as copy resetting name. More... | |
| GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const word &patchFieldType) | |
| Construct as copy resetting IO parameters and patch field type. More... | |
| GeometricField (const IOobject &, const GeometricField< Type, PatchField, GeoMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList()) | |
| Construct as copy resetting IO parameters and boundary types. More... | |
| GeometricField (const IOobject &, const tmp< GeometricField< Type, PatchField, GeoMesh >> &, 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 () |
| 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 |
| Return a const-reference to the dimensioned internal field. More... | |
| Internal::FieldType & | primitiveFieldRef () |
| Return a reference to the internal field. More... | |
| const Internal::FieldType & | primitiveField () const |
| Return a const-reference to the internal field. More... | |
| Boundary & | boundaryFieldRef () |
| 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 () |
| void | replace (const direction, const GeometricField< cmptType, PatchField, GeoMesh > &) |
| void | replace (const direction, const dimensioned< cmptType > &) |
| void | max (const dimensioned< Type > &) |
| void | min (const dimensioned< Type > &) |
| void | maxMin (const dimensioned< Type > &minDt, const dimensioned< Type > &maxDt) |
| const Internal & | operator() () const |
| Return a const-reference to the dimensioned internal field. More... | |
| void | operator= (const GeometricField< Type, PatchField, GeoMesh > &) |
| void | operator= (GeometricField< Type, PatchField, GeoMesh > &&) |
| void | operator= (const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
| void | operator= (const dimensioned< Type > &) |
| void | operator= (const zero &) |
| void | operator== (const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
| void | operator== (const dimensioned< Type > &) |
| void | operator== (const zero &) |
| 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, 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) |
| Public Member Functions inherited from DimensionedField< Type, GeoMesh > | |
| TypeName ("DimensionedField") | |
| Runtime type information. More... | |
| DimensionedField (const IOobject &, const Mesh &mesh, const dimensionSet &, const Field< 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 > &) | |
| Copy constructor. More... | |
| DimensionedField (DimensionedField< Type, GeoMesh > &, bool reuse) | |
| Copy constructor or re-use as specified. More... | |
| DimensionedField (DimensionedField< Type, GeoMesh > &&) | |
| Move constructor. More... | |
| DimensionedField (const tmp< DimensionedField< Type, GeoMesh >> &) | |
| Copy constructor of tmp<DimensionedField> deleting argument. More... | |
| DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &) | |
| Copy constructor resetting IO parameters. More... | |
| DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh > &, bool reuse) | |
| Copy constructor resetting IO parameters and re-use as specified. More... | |
| DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &) | |
| Copy constructor resetting name. More... | |
| DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &, bool reuse) | |
| Copy constructor resetting name and re-use as specified. More... | |
| DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &) | |
| Copy constructor resetting name. More... | |
| tmp< DimensionedField< Type, GeoMesh > > | clone () const |
| Clone. More... | |
| virtual | ~DimensionedField () |
| Destructor. More... | |
| void | readField (const dictionary &fieldDict, const word &fieldDictEntry="value") |
| const Mesh & | mesh () const |
| Return mesh. More... | |
| const dimensionSet & | dimensions () const |
| Return dimensions. More... | |
| dimensionSet & | dimensions () |
| Return non-const access to dimensions. More... | |
| const Field< Type > & | field () const |
| Field< Type > & | field () |
| tmp< DimensionedField< cmptType, GeoMesh > > | component (const direction) const |
| Return a component field of the field. More... | |
| void | replace (const direction, const DimensionedField< cmptType, GeoMesh > &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const tmp< DimensionedField< cmptType, GeoMesh >> &) |
| Replace a component field of the field. More... | |
| tmp< DimensionedField< Type, GeoMesh > > | T () const |
| Return the field transpose (only defined for second rank tensors) More... | |
| dimensioned< Type > | average () const |
| Calculate and return arithmetic average. More... | |
| dimensioned< Type > | weightedAverage (const DimensionedField< scalar, GeoMesh > &) const |
| Calculate and return weighted average. More... | |
| dimensioned< Type > | weightedAverage (const tmp< DimensionedField< scalar, GeoMesh >> &) const |
| Calculate and return weighted average. More... | |
| bool | writeData (Ostream &, const word &fieldDictEntry) const |
| void | operator= (const DimensionedField< Type, GeoMesh > &) |
| void | operator= (DimensionedField< Type, GeoMesh > &&) |
| void | operator= (const tmp< DimensionedField< Type, GeoMesh >> &) |
| void | operator= (const dimensioned< Type > &) |
| void | operator= (const zero &) |
| void | operator+= (const DimensionedField< Type, GeoMesh > &) |
| void | operator+= (const tmp< DimensionedField< Type, GeoMesh >> &) |
| void | operator-= (const DimensionedField< Type, GeoMesh > &) |
| void | operator-= (const tmp< DimensionedField< Type, GeoMesh >> &) |
| void | operator*= (const DimensionedField< scalar, GeoMesh > &) |
| void | operator*= (const tmp< DimensionedField< scalar, GeoMesh >> &) |
| void | operator/= (const DimensionedField< scalar, GeoMesh > &) |
| void | operator/= (const tmp< DimensionedField< scalar, GeoMesh >> &) |
| void | operator+= (const dimensioned< Type > &) |
| void | operator-= (const dimensioned< Type > &) |
| void | operator*= (const dimensioned< scalar > &) |
| void | operator/= (const dimensioned< scalar > &) |
| 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 (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... | |
| 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 | 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... | |
| label & | 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... | |
| virtual fileName | filePath () const |
| Return complete path + object name if the file exists. 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 | readIfModified () |
| Read object if modified (as set by call to modified) More... | |
| virtual bool | global () const |
| Is object same for all processors. 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 &) |
| Public Member Functions inherited from IOobject | |
| TypeName ("IOobject") | |
| Runtime type information. More... | |
| IOobject (const word &name, const fileName &instance, const objectRegistry ®istry, 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 ®istry, 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 ®istry, readOption r=NO_READ, writeOption w=NO_WRITE, bool registerObject=true) | |
| Construct from path, registry, io options. More... | |
| IOobject (const IOobject &io, const objectRegistry ®istry) | |
| 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 ®istry) 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... | |
| word | modelName (const char *name) const |
| Return the name of the object within this model. More... | |
| const fileName & | rootPath () const |
| const fileName & | caseName () const |
| const fileName & | instance () const |
| fileName & | instance () |
| const fileName & | local () const |
| fileName | path () const |
| Return complete path. More... | |
| fileName | path (const word &instance, const fileName &local="") const |
| Return complete path with alternative instance and local. More... | |
| fileName | localPath () const |
| Return the path relative to the case. More... | |
| fileName | objectPath () const |
| Return complete path + object name. More... | |
| fileName | localObjectPath () const |
| Return complete localPath + object name. More... | |
| fileName | localFilePath (const word &typeName) const |
| Helper for filePath that searches locally. More... | |
| fileName | globalFilePath (const word &typeName) const |
| Helper for filePath that searches up if in parallel. More... | |
| bool | readHeader (Istream &) |
| Read header. More... | |
| template<class Type > | |
| bool | typeHeaderOk (const bool checkType=true) |
| Read header (uses typeFilePath to find file) and check header. 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) |
| template<class Name > | |
| Foam::word | modelName (Name name, const word &model) |
| Public Member Functions inherited from Field< Type > | |
| Field () | |
| Construct null. More... | |
| Field (const label) | |
| Construct given size. More... | |
| Field (const label, const Type &) | |
| Construct given size and initial value. More... | |
| Field (const label, const zero) | |
| Construct given size and initialed to zero. More... | |
| Field (const UList< Type > &) | |
| Copy constructor of a UList<Type> More... | |
| Field (List< Type > &&) | |
| Mover constructor transferring the List contents. More... | |
| Field (const UIndirectList< Type > &) | |
| Copy constructor of a UIndirectList<Type> More... | |
| Field (const Field< Type > &) | |
| Copy constructor. More... | |
| Field (Field< Type > &, bool reuse) | |
| Copy constructor or re-use as specified. More... | |
| Field (Field< Type > &&) | |
| Move constructor transferring the Field contents. More... | |
| Field (const tmp< Field< Type >> &) | |
| Copy constructor of tmp<Field> More... | |
| Field (const UList< Type > &mapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given field. More... | |
| Field (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) | |
| Construct by 1 to 1 mapping from the given tmp field. More... | |
| Field (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given field. More... | |
| Field (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) | |
| Construct by interpolative mapping from the given tmp field. More... | |
| Field (Istream &) | |
| Construct from Istream. More... | |
| Field (const word &keyword, const dictionary &, const label size) | |
| Construct from a dictionary entry. More... | |
| tmp< Field< Type > > | clone () const |
| Clone. More... | |
| void | map (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given field More... | |
| void | map (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 map from the given tmp field More... | |
| void | map (const UList< Type > &mapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given field. More... | |
| void | map (const tmp< Field< Type >> &tmapF, const labelListList &mapAddressing, const scalarListList &weights) |
| Interpolative map from the given tmp field. More... | |
| void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given field More... | |
| void | rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing) |
| 1 to 1 reverse-map from the given tmp field More... | |
| void | rmap (const UList< Type > &mapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given field. More... | |
| void | rmap (const tmp< Field< Type >> &tmapF, const labelUList &mapAddressing, const UList< scalar > &weights) |
| Interpolative reverse map from the given tmp field. More... | |
| void | negate () |
| Negate this field. More... | |
| tmp< Field< cmptType > > | component (const direction) const |
| Return a component field of the field. More... | |
| void | replace (const direction, const UList< cmptType > &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const tmp< Field< cmptType >> &) |
| Replace a component field of the field. More... | |
| void | replace (const direction, const cmptType &) |
| Replace a component field of the field. More... | |
| template<class VSForm > | |
| VSForm | block (const label start) const |
| tmp< Field< Type > > | T () const |
| Return the field transpose (only defined for second rank tensors) More... | |
| void | operator= (const Field< Type > &) |
| void | operator= (Field< Type > &&) |
| void | operator= (const UList< Type > &) |
| void | operator= (List< Type > &&) |
| void | operator= (const SubField< Type > &) |
| void | operator= (const tmp< Field< Type >> &) |
| void | operator= (const Type &) |
| void | operator= (const zero) |
| template<class Form , class Cmpt , direction nCmpt> | |
| void | operator= (const VectorSpace< Form, Cmpt, nCmpt > &) |
| void | operator+= (const UList< Type > &) |
| void | operator+= (const tmp< Field< Type >> &) |
| void | operator-= (const UList< Type > &) |
| void | operator-= (const tmp< Field< Type >> &) |
| void | operator*= (const UList< scalar > &) |
| void | operator*= (const tmp< Field< scalar >> &) |
| void | operator/= (const UList< scalar > &) |
| void | operator/= (const tmp< Field< scalar >> &) |
| void | operator+= (const Type &) |
| void | operator-= (const Type &) |
| void | operator*= (const scalar &) |
| void | operator/= (const scalar &) |
| template<class Type> | |
| void | operator= (const tmp< Field > &rhs) |
| Public Member Functions inherited from refCount | |
| int | count () const |
| Return the current reference count. More... | |
| bool | unique () const |
| Return true if the reference count is zero. More... | |
| void | operator++ () |
| Increment the reference count. More... | |
| void | operator++ (int) |
| Increment the reference count. More... | |
| void | operator-- () |
| Decrement the reference count. More... | |
| void | operator-- (int) |
| Decrement the reference count. More... | |
| Public Member Functions inherited from List< Type > | |
| List () | |
| Null constructor. More... | |
| List (const label) | |
| Construct with given size. More... | |
| List (const label, const Type &) | |
| Construct with given size and value for all elements. More... | |
| List (const label, const zero) | |
| Construct with given size initialising all elements to zero. More... | |
| List (const List< Type > &) | |
| Copy constructor. More... | |
| List (const List< T2 > &) | |
| Copy constructor from list containing another type. More... | |
| List (List< Type > &&) | |
| Move constructor. More... | |
| List (List< Type > &, bool reuse) | |
| Construct as copy or re-use as specified. More... | |
| List (const UList< Type > &, const labelUList &mapAddressing) | |
| Construct as subset. More... | |
| List (InputIterator first, InputIterator last) | |
| Construct given start and end iterators. More... | |
| List (const FixedList< Type, Size > &) | |
| Construct as copy of FixedList<T, Size> More... | |
| List (const PtrList< Type > &) | |
| Construct as copy of PtrList<T> More... | |
| List (const SLList< Type > &) | |
| Construct as copy of SLList<T> More... | |
| List (const UIndirectList< Type > &) | |
| Construct as copy of UIndirectList<T> More... | |
| List (const BiIndirectList< Type > &) | |
| Construct as copy of BiIndirectList<T> More... | |
| List (std::initializer_list< Type >) | |
| Construct from an initialiser list. More... | |
| List (Istream &) | |
| Construct from Istream. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| autoPtr< List< Type > > | clone () const |
| Clone. More... | |
| ~List () | |
| Destructor. More... | |
| void | resize (const label) |
| Alias for setSize(const label) More... | |
| void | resize (const label, const Type &) |
| Alias for setSize(const label, const T&) More... | |
| void | setSize (const label) |
| Reset size of List. More... | |
| void | setSize (const label, const Type &) |
| Reset size of List and value for new elements. More... | |
| void | clear () |
| Clear the list, i.e. set size to zero. More... | |
| void | append (const Type &) |
| Append an element at the end of the list. More... | |
| void | append (const UList< Type > &) |
| Append a List at the end of this list. More... | |
| void | append (const UIndirectList< Type > &) |
| Append a UIndirectList at the end of this list. More... | |
| void | transfer (List< Type > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (DynamicList< Type, SizeInc, SizeMult, SizeDiv > &) |
| Transfer the contents of the argument List into this list. More... | |
| void | transfer (SortableList< Type > &) |
| Transfer the contents of the argument List into this list. More... | |
| Type & | newElmt (const label) |
| Return subscript-checked element of UList. More... | |
| void | shallowCopy (const UList< Type > &)=delete |
| Disallow implicit shallowCopy. More... | |
| void | operator= (const UList< Type > &) |
| Assignment to UList operator. Takes linear time. More... | |
| void | operator= (const List< Type > &) |
| Assignment operator. Takes linear time. More... | |
| void | operator= (List< Type > &&) |
| Move assignment operator. More... | |
| void | operator= (const SLList< Type > &) |
| Assignment to SLList operator. Takes linear time. More... | |
| void | operator= (const UIndirectList< Type > &) |
| Assignment to UIndirectList operator. Takes linear time. More... | |
| void | operator= (const BiIndirectList< Type > &) |
| Assignment to BiIndirectList operator. Takes linear time. More... | |
| void | operator= (std::initializer_list< Type >) |
| Assignment to an initialiser list. More... | |
| void | operator= (const Type &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| Public Member Functions inherited from UList< Type > | |
| void | operator= (const Type &) |
| Assignment of all entries to the given value. More... | |
| void | operator= (const zero) |
| Assignment of all entries to zero. More... | |
| UList () | |
| Null constructor. More... | |
| UList (Type *__restrict__ v, label size) | |
| Construct from components. More... | |
| label | fcIndex (const label i) const |
| Return the forward circular index, i.e. the next index. More... | |
| label | rcIndex (const label i) const |
| Return the reverse circular index, i.e. the previous index. More... | |
| std::streamsize | byteSize () const |
| Return the binary size in number of characters of the UList. More... | |
| const Type * | cdata () const |
| Return a const pointer to the first data element,. More... | |
| Type * | data () |
| Return a pointer to the first data element,. More... | |
| Type & | first () |
| Return the first element of the list. More... | |
| const Type & | first () const |
| Return first element of the list. More... | |
| Type & | last () |
| Return the last element of the list. More... | |
| const Type & | last () const |
| Return the last element of the list. More... | |
| void | checkStart (const label start) const |
| Check start is within valid range (0 ... size-1) More... | |
| void | checkSize (const label size) const |
| Check size is within valid range (0 ... size) More... | |
| void | checkIndex (const label i) const |
| Check index i is within valid range (0 ... size-1) More... | |
| void | shallowCopy (const UList< Type > &) |
| Copy the pointer held by the given UList. More... | |
| void | deepCopy (const UList< Type > &) |
| Copy elements of the given UList. More... | |
| Type & | operator[] (const label) |
| Return element of UList. More... | |
| const Type & | operator[] (const label) const |
| Return element of constant UList. More... | |
| const bool & | operator[] (const label i) const |
| operator const Foam::List< Type > & () const | |
| Allow cast to a const List<T>&. More... | |
| iterator | begin () |
| Return an iterator to begin traversing the UList. More... | |
| const_iterator | begin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| iterator | end () |
| Return an iterator to end traversing the UList. More... | |
| const_iterator | end () const |
| Return const_iterator to end traversing the constant UList. More... | |
| const_iterator | cbegin () const |
| Return const_iterator to begin traversing the constant UList. More... | |
| const_iterator | cend () const |
| Return const_iterator to end traversing the constant UList. More... | |
| reverse_iterator | rbegin () |
| Return reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | rbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| reverse_iterator | rend () |
| Return reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | rend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| const_reverse_iterator | crbegin () const |
| Return const_reverse_iterator to begin reverse traversing the UList. More... | |
| const_reverse_iterator | crend () const |
| Return const_reverse_iterator to end reverse traversing the UList. More... | |
| label | size () const |
| Return the number of elements in the UList. More... | |
| label | max_size () const |
| Return size of the largest possible UList. More... | |
| bool | empty () const |
| Return true if the UList is empty (ie, size() is zero) More... | |
| void | swap (UList< Type > &) |
| Swap two ULists of the same type in constant time. More... | |
| bool | operator== (const UList< Type > &) const |
| Equality operation on ULists of the same type. More... | |
| bool | operator!= (const UList< Type > &) const |
| The opposite of the equality operation. Takes linear time. More... | |
| bool | operator< (const UList< Type > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator> (const UList< Type > &) const |
| Compare two ULists lexicographically. Takes linear time. More... | |
| bool | operator<= (const UList< Type > &) const |
| Return true if !(a > b). Takes linear time. More... | |
| bool | operator>= (const UList< Type > &) const |
| Return true if !(a < b). Takes linear time. More... | |
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 |
| Type of boundary mesh on which this. More... | |
| typedef DimensionedField< Type, GeoMesh > | Internal |
| Type of the internal field from which this GeometricField is derived. More... | |
| typedef PatchField< Type > | Patch |
| Type of the patch field of which the. More... | |
| typedef Field< Type >::cmptType | cmptType |
| Public Types inherited from DimensionedField< Type, GeoMesh > | |
| typedef GeoMesh::Mesh | Mesh |
| Type of mesh on which this DimensionedField is instantiated. More... | |
| typedef Field< Type > | FieldType |
| Type of the field from which this DimensionedField is derived. More... | |
| typedef Field< 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... | |
| Public Types inherited from Field< Type > | |
| typedef pTraits< Type >::cmptType | cmptType |
| Component type. More... | |
| typedef SubField< Type > | subField |
| Declare type of subField. More... | |
| Public Types inherited from List< Type > | |
| typedef SubList< Type > | subList |
| Declare type of subList. More... | |
| Public Types inherited from UList< Type > | |
| typedef Type | value_type |
| Type of values the UList contains. More... | |
| typedef Type & | reference |
| Type that can be used for storing into. More... | |
| typedef const Type & | const_reference |
| Type that can be used for storing into. More... | |
| typedef label | difference_type |
| The type that can represent the difference between any two. More... | |
| typedef label | size_type |
| The type that can represent the size of a UList. More... | |
| typedef Type * | iterator |
| Random access iterator for traversing UList. More... | |
| typedef const Type * | const_iterator |
| Random access iterator for traversing UList. More... | |
| typedef std::reverse_iterator< iterator > | reverse_iterator |
| Reverse iterator for reverse traversal of UList. More... | |
| typedef std::reverse_iterator< const_iterator > | const_reverse_iterator |
| Reverse iterator for reverse traversal of constant UList. More... | |
| 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 Internal &, const PtrList< PatchField< Type >> &) |
| Return a temporary field constructed from name,. More... | |
| static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &name, const Mesh &, const dimensionSet &, const word &patchFieldType=PatchField< Type >::calculatedType()) |
| Return a temporary field constructed from name, mesh, dimensionSet. More... | |
| static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &name, const Mesh &, const dimensioned< Type > &, const word &patchFieldType=PatchField< Type >::calculatedType()) |
| Return a temporary field constructed from mesh, dimensioned<Type> More... | |
| static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &name, const Mesh &, const dimensioned< Type > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList()) |
| Return a temporary field constructed from mesh, dimensioned<Type> More... | |
| static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &) |
| Rename temporary field and return. More... | |
| static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &, const word &) |
| Rename temporary field, reset patch field type and return. More... | |
| static tmp< GeometricField< Type, PatchField, GeoMesh > > | New (const word &newName, const tmp< GeometricField< Type, PatchField, GeoMesh >> &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList()) |
| Rename and reset patch fields types of temporary field and return. More... | |
| Static Public Member Functions inherited from DimensionedField< Type, GeoMesh > | |
| static const DimensionedField< Type, GeoMesh > & | null () |
| Return a null DimensionedField. More... | |
| static tmp< DimensionedField< Type, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensionSet &) |
| Return a temporary field constructed from name, mesh. More... | |
| static tmp< DimensionedField< Type, GeoMesh > > | New (const word &name, const Mesh &mesh, const dimensioned< Type > &) |
| Return a temporary field constructed from name, mesh. More... | |
| static tmp< DimensionedField< Type, GeoMesh > > | New (const word &newName, const DimensionedField< Type, GeoMesh > &) |
| Return a temporary field constructed from name and a field. More... | |
| static tmp< DimensionedField< Type, GeoMesh > > | New (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &) |
| 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 Name > | |
| static word | modelName (Name name, const word &model) |
| Return the name of the object within the given model. 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 Public Member Functions inherited from Field< Type > | |
| static const Field< Type > & | null () |
| Return a null field. More... | |
| template<class Type2 > | |
| static tmp< Field< Type > > | NewCalculatedType (const Field< Type2 > &f) |
| Return a pointer to a new calculatedFvPatchFieldField created on. More... | |
| Static Public Member Functions inherited from List< Type > | |
| static const List< Type > & | null () |
| Return a null List. More... | |
| Static Public Member Functions inherited from UList< Type > | |
| static const UList< Type > & | null () |
| Return a null UList. 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... | |
| Static Public Attributes inherited from Field< Type > | |
| static const char *const | typeName |
| 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 | |
| void | setBad (const string &) |
| Set the object state to bad. More... | |
| Protected Member Functions inherited from refCount | |
| refCount () | |
| Construct null initialising count to 0. More... | |
| Protected Member Functions inherited from List< Type > | |
| void | size (const label) |
| Override size to be inconsistent with allocated storage. More... | |
This class represents a single sizeGroup belonging to a velocityGroup. The main property of a sizeGroup is its representative volume. 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.
The corresponding physical diameter that is representative for the class is computed by a separate shapeModel, specified in the velocityGroupCoeffs dictionary.
| Property | Description | Required | Default value |
|---|---|---|---|
dSph | Sphere equivalent diameter | yes | none |
value | Field and BC value | yes | none |
Example
f1
{
ds 3e-3;
value 1.0;
}
Definition at line 100 of file sizeGroup.H.
| sizeGroup | ( | const word & | name, |
| const dictionary & | dict, | ||
| const phaseModel & | phase, | ||
| const velocityGroup & | velocityGroup, | ||
| const fvMesh & | mesh | ||
| ) |
|
virtual |
Destructor.
Referenced by sizeGroup::iNew::operator()().
|
inline |
Return const-reference to the dictionary.
Definition at line 29 of file sizeGroupI.H.
Referenced by sizeGroup::iNew::operator()().
|
inline |
Return const-reference to the phase.
Definition at line 36 of file sizeGroupI.H.
Referenced by sizeGroup::iNew::operator()().
|
inline |
Return const-reference to the velocityGroup.
Definition at line 43 of file sizeGroupI.H.
Referenced by sizeGroup::iNew::operator()().
|
inline |
Return representative spherical diameter of the sizeGroup.
Definition at line 50 of file sizeGroupI.H.
Referenced by sizeGroup::iNew::operator()().
|
inline |
Return representative volume of the sizeGroup.
Definition at line 57 of file sizeGroupI.H.
Referenced by sizeGroup::iNew::operator()().
|
inline |
Return reference to diameterModel of the phase.
Definition at line 64 of file sizeGroupI.H.
Referenced by sizeGroup::iNew::operator()().
|
inline |
Return const-reference to diameterModel of the phase.
Definition at line 71 of file sizeGroupI.H.
Return label of the sizeGroup within the population balance.
Referenced by sizeGroup::iNew::operator()().
| const tmp<volScalarField> a | ( | ) | const |
Return representative surface area of the sizeGroup.
Referenced by sizeGroup::iNew::operator()().
| const tmp<volScalarField> d | ( | ) | const |
Return representative diameter of the sizeGroup.
Referenced by sizeGroup::iNew::operator()().
| void correct | ( | ) |
Correct secondary properties.
Referenced by sizeGroup::iNew::operator()().
1.8.13 