phaseModel Class Referenceabstract
Inheritance diagram for phaseModel:
Collaboration diagram for phaseModel:

Classes

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

Public Member Functions

 ClassName ("phaseModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseModel, phaseSystem,(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index),(fluid, phaseName, referencePhase, index))
 
 phaseModel (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
 
autoPtr< phaseModelclone () const
 Return clone. More...
 
virtual ~phaseModel ()
 Destructor. More...
 
const wordname () const
 Return the name of this phase. More...
 
const wordkeyword () const
 Return the name of the phase for use as the keyword in PtrDictionary. More...
 
label index () const
 Return the index of the phase. More...
 
const phaseSystemfluid () const
 Return the system to which this phase belongs. More...
 
const dimensionedScalarresidualAlpha () const
 Return the residual phase-fraction for given phase. More...
 
scalar alphaMax () const
 Return the maximum phase-fraction (e.g. packing limit) More...
 
tmp< volScalarFieldd () const
 Return the Sauter-mean diameter. More...
 
const diameterModeldiameter () const
 Return a reference to the diameterModel of the phase. More...
 
virtual void correct ()
 Correct the phase properties. More...
 
virtual void correctContinuityError (const volScalarField &source)
 Correct the continuity error. More...
 
virtual void correctKinematics ()
 Correct the kinematics. More...
 
virtual void correctThermo ()
 Correct the thermodynamics. More...
 
virtual void correctReactions ()
 Correct the reactions. More...
 
virtual void correctSpecies ()
 Correct the species concentrations. More...
 
virtual void predictMomentumTransport ()
 Predict the momentumTransport. More...
 
virtual void predictThermophysicalTransport ()
 Predict the energy transport. More...
 
virtual void correctMomentumTransport ()
 Correct the momentumTransport. More...
 
virtual void correctThermophysicalTransport ()
 Correct the energy transport. More...
 
virtual void correctUf ()
 Correct the face velocity for moving meshes. More...
 
void correctInflowOutflow (surfaceScalarField &alphaPhi) const
 Ensure that the flux at inflow/outflow BCs is preserved. More...
 
virtual bool read ()
 Read phase properties dictionary. More...
 
virtual bool incompressible () const =0
 Return true if the phase is incompressible otherwise false. More...
 
virtual bool isochoric () const =0
 Return true if the phase is constant density otherwise false. More...
 
virtual const autoPtr< volScalarField > & divU () const =0
 Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...
 
virtual void divU (tmp< volScalarField > divU)=0
 Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...
 
virtual const rhoThermothermo () const =0
 Return the thermophysical model. More...
 
virtual rhoThermothermo ()=0
 Access the thermophysical model. More...
 
virtual const rhoFluidThermofluidThermo () const =0
 Return the thermophysical model. More...
 
virtual rhoFluidThermofluidThermo ()=0
 Access the thermophysical model. More...
 
virtual const volScalarFieldrho () const =0
 Return the density field. More...
 
virtual volScalarFieldrho ()=0
 Access the density field. More...
 
virtual bool isothermal () const =0
 Return whether the phase is isothermal. More...
 
virtual tmp< fvScalarMatrixheEqn ()=0
 Return the enthalpy equation. More...
 
virtual bool pure () const =0
 Return whether the phase is pure (i.e., not multi-component) More...
 
virtual tmp< fvScalarMatrixYiEqn (volScalarField &Yi)=0
 Return the species fraction equation. More...
 
virtual const PtrList< volScalarField > & Y () const =0
 Return the species mass fractions. More...
 
virtual const volScalarFieldY (const word &name) const =0
 Return a species mass fraction by name. More...
 
virtual PtrList< volScalarField > & YRef ()=0
 Access the species mass fractions. More...
 
virtual bool solveSpecie (const label speciei) const =0
 Should the given specie be solved for? I.e., is it active and. More...
 
virtual tmp< fvScalarMatrixR (volScalarField &Yi) const =0
 Return the fuel consumption rate matrix. More...
 
virtual bool stationary () const =0
 Return whether the phase is stationary. More...
 
virtual tmp< fvVectorMatrixUEqn ()=0
 Return the momentum equation. More...
 
virtual tmp< fvVectorMatrixUfEqn ()=0
 Return the momentum equation for the face-based algorithm. More...
 
virtual tmp< volVectorFieldU () const =0
 Return the velocity. More...
 
virtual volVectorFieldURef ()=0
 Access the velocity. More...
 
virtual const volVectorFieldURef () const =0
 Access the velocity. More...
 
virtual tmp< surfaceScalarFieldphi () const =0
 Return the volumetric flux. More...
 
virtual surfaceScalarFieldphiRef ()=0
 Access the volumetric flux. More...
 
virtual const surfaceScalarFieldphiRef () const =0
 Access the volumetric flux. More...
 
virtual const autoPtr< surfaceVectorField > & Uf () const =0
 Return the face velocity. More...
 
virtual surfaceVectorFieldUfRef ()=0
 Access the face velocity. More...
 
virtual const surfaceVectorFieldUfRef () const =0
 Access the face velocity. More...
 
virtual tmp< surfaceScalarFieldalphaPhi () const =0
 Return the volumetric flux of the phase. More...
 
virtual surfaceScalarFieldalphaPhiRef ()=0
 Access the volumetric flux of the phase. More...
 
virtual const surfaceScalarFieldalphaPhiRef () const =0
 Access the volumetric flux of the phase. More...
 
virtual tmp< surfaceScalarFieldalphaRhoPhi () const =0
 Return the mass flux of the phase. More...
 
virtual surfaceScalarFieldalphaRhoPhiRef ()=0
 Access the mass flux of the phase. More...
 
virtual const surfaceScalarFieldalphaRhoPhiRef () const =0
 Access the mass flux of the phase. More...
 
virtual tmp< fvVectorMatrixUgradU () const =0
 Return the velocity transport matrix. More...
 
virtual tmp< fvVectorMatrixDUDt () const =0
 Return the substantive acceleration matrix. More...
 
virtual tmp< volScalarFieldcontinuityError () const =0
 Return the continuity error. More...
 
virtual tmp< volScalarFieldK () const =0
 Return the phase kinetic energy. More...
 
virtual tmp< scalarFieldkappaEff (const label patchi) const =0
 Effective thermal turbulent conductivity. More...
 
virtual tmp< volScalarFieldk () const =0
 Return the turbulent kinetic energy. More...
 
virtual tmp< surfaceScalarFieldpPrimef () const =0
 Return the face-phase-pressure'. 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(), 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=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(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Constructor given IOobject, mesh, dimensioned<Type> More...
 
 GeometricField (const IOobject &, const Internal &, const PtrList< PatchField< Type >> &, const HashPtrTable< Source > &=HashPtrTable< Source >())
 Constructor from components. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< Type > &, const PtrList< PatchField< Type >> &, 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, 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. 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 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 of tmp 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(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 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(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 Construct as copy of tmp resetting IO parameters and boundary types. More...
 
tmp< GeometricField< Type, PatchField, GeoMesh > > clone () const
 Clone. More...
 
tmp< GeometricField< Type, PatchField, GeoMesh > > 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...
 
const BoundaryboundaryField () const
 Return const-reference to the boundary field. 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, PatchField, GeoMesh > & 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...
 
void reset (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
 Reset the field contents to the given 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...
 
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...
 
void relax (const tmp< GeometricField< Type, PatchField, GeoMesh >> &, const scalar alpha)
 Relax given field with respect to the current field. More...
 
void relax (const tmp< GeometricField< Type, PatchField, GeoMesh >> &)
 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 ()
 
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 Internaloperator() () 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 > &)
 
- 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 reuse 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 > &, const bool checkIOFlags=true)
 Copy constructor resetting IO parameters. More...
 
 DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh > &, bool reuse, const bool checkIOFlags=true)
 Copy constructor resetting IO parameters and reuse as specified. More...
 
 DimensionedField (const IOobject &, const tmp< DimensionedField< Type, GeoMesh >> &, const bool checkIOFlags=true)
 Copy constructor from tmp resetting IO parameters. 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 reuse as specified. More...
 
 DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh >> &)
 Copy constructor from tmp 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 Meshmesh () const
 Return mesh. More...
 
const dimensionSetdimensions () const
 Return dimensions. More...
 
dimensionSetdimensions ()
 Return non-const access to dimensions. More...
 
Field< Type > & primitiveFieldRef ()
 Return a reference to the internal field. More...
 
const Field< 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 > > 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...
 
void reset (const DimensionedField< Type, GeoMesh > &)
 Reset the field values to the given field. 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 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 &&)
 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...
 
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 &)
 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 word &typeName, 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...
 
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 word &typeName, 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 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 initialised 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 reuse 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...
 
 Field (const word &keyword, const unitConversion &, const dictionary &, const label size)
 Construct from a dictionary entry with unit conversion. 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 reset (const Field< Type > &)
 Reset the field values to the given 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...
 
void operator= (const refCount &)=delete
 Disallow bitwise assignment. 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 UList< T2 > &)
 Copy constructor from list containing another type. More...
 
 List (List< Type > &&)
 Move constructor. More...
 
 List (List< Type > &, bool reuse)
 Construct as copy or reuse 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...
 
 UList (const UList< Type > &)=default
 Copy construct. 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...
 
- Public Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh > >
 OldTimeField (const label timeIndex)
 Construct from a time index. More...
 
 OldTimeField (const OldTimeField< DimensionedField< Type, GeoMesh > > &otf)
 Copy construct. More...
 
 OldTimeField (OldTimeField< DimensionedField< Type, GeoMesh > > &&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...
 
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 DimensionedField< Type, GeoMesh > & oldTime () const
 Return the old time field. More...
 
const DimensionedField< Type, GeoMesh > & oldTime (const label n) const
 Return the n-th old time field. More...
 
DimensionedField< Type, GeoMesh > & oldTimeRef ()
 Return a non-const reference to the old time field. More...
 
DimensionedField< Type, GeoMesh > & oldTimeRef (const label n)
 Return a non-const reference to the n-th old time field. More...
 
void operator= (const OldTimeField< DimensionedField< Type, GeoMesh > > &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from OldTimeField< GeometricField< Type, PatchField, GeoMesh > >
 OldTimeField (const label timeIndex)
 Construct from a time index. More...
 
 OldTimeField (const OldTimeField< GeometricField< Type, PatchField, GeoMesh > > &otf)
 Copy construct. More...
 
 OldTimeField (OldTimeField< GeometricField< Type, PatchField, GeoMesh > > &&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...
 
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 GeometricField< Type, PatchField, GeoMesh > & oldTime () const
 Return the old time field. More...
 
const GeometricField< Type, PatchField, GeoMesh > & oldTime (const label n) const
 Return the n-th old time field. More...
 
GeometricField< Type, PatchField, GeoMesh > & oldTimeRef ()
 Return a non-const reference to the old time field. More...
 
GeometricField< Type, PatchField, GeoMesh > & oldTimeRef (const label n)
 Return a non-const reference to the n-th old time field. More...
 
void operator= (const OldTimeField< GeometricField< Type, PatchField, GeoMesh > > &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< phaseModelNew (const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index)
 
- 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 >> &, const HashPtrTable< Source > &=HashPtrTable< Source >())
 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(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 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 &patchFieldType)
 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(), const HashTable< word > &fieldSourceTypes=HashTable< word >())
 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 &, const Field< Type > &)
 Return a temporary field constructed from name, mesh,. 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 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...
 

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 DimensionedField< Type, GeoMeshInternal
 Type of the internal field from which this GeometricField is derived. More...
 
typedef DimensionedField< Type, GeoMeshBase
 Type of the field from which this GeometricField is derived. More...
 
typedef PatchField< Type > Patch
 Type of the patch field of which the Boundary is composed. More...
 
typedef GeometricBoundaryField< Type, PatchField, GeoMeshBoundary
 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, GeoMeshSources
 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 >
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 > Base
 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< iteratorreverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef std::reverse_iterator< const_iteratorconst_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Public Types inherited from OldTimeField< DimensionedField< Type, GeoMesh > >
typedef OldTimeField< DimensionedField< Type, GeoMesh > > OldTime
 The old-time field type. More...
 
- Public Types inherited from OldTimeField< GeometricField< Type, PatchField, GeoMesh > >
typedef OldTimeField< GeometricField< Type, PatchField, GeoMesh > > OldTime
 The old-time field type. 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...
 
template<class Type >
bool typeHeaderOk (const bool checkType)
 Read header using typeGlobalFile to find file. More...
 
- Protected Member Functions inherited from refCount
 refCount ()
 Construct null initialising count to 0. More...
 
 refCount (const refCount &)=delete
 Disallow copy. More...
 
- Protected Member Functions inherited from List< Type >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Protected Member Functions inherited from OldTimeField< DimensionedField< Type, GeoMesh > >
bool readOldTimeIfPresent ()
 Read old-time field from file if it is present. More...
 
void copyOldTimes (const IOobject &io, const OldTimeField< DimensionedField< Type, GeoMesh > > &otf)
 Copy the old times from the given field. More...
 
void copyOldTimes (const word &newName, const OldTimeField< DimensionedField< Type, GeoMesh > > &otf)
 Copy the old times from the given field. More...
 
- Protected Member Functions inherited from OldTimeField< GeometricField< Type, PatchField, GeoMesh > >
bool readOldTimeIfPresent ()
 Read old-time field from file if it is present. More...
 
void copyOldTimes (const IOobject &io, const OldTimeField< GeometricField< Type, PatchField, GeoMesh > > &otf)
 Copy the old times from the given field. More...
 
void copyOldTimes (const word &newName, const OldTimeField< GeometricField< Type, PatchField, GeoMesh > > &otf)
 Copy the old times from the given field. More...
 

Detailed Description

Source files

Definition at line 54 of file phaseModel.H.

Constructor & Destructor Documentation

◆ phaseModel()

phaseModel ( const phaseSystem fluid,
const word phaseName,
const bool  referencePhase,
const label  index 
)

Definition at line 41 of file phaseModel.C.

References phaseModel::fluid(), diameterModel::New(), and dictionary::subDict().

Here is the call graph for this function:

◆ ~phaseModel()

~phaseModel ( )
virtual

Destructor.

Definition at line 139 of file phaseModel.C.

Member Function Documentation

◆ ClassName()

ClassName ( "phaseModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
phaseModel  ,
phaseSystem  ,
(const phaseSystem &fluid, const word &phaseName, const bool referencePhase, const label index ,
(fluid, phaseName, referencePhase, index  
)

◆ clone()

Foam::autoPtr< Foam::phaseModel > clone ( ) const

Return clone.

Definition at line 130 of file phaseModel.C.

References NotImplemented.

◆ New()

Foam::autoPtr< Foam::phaseModel > New ( const phaseSystem fluid,
const word phaseName,
const bool  referencePhase,
const label  index 
)
static

Definition at line 31 of file phaseModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, phaseModel::fluid(), phaseModel::index(), Foam::Info, dictionary::lookup(), and dictionary::subDict().

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

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

◆ name()

const Foam::word & name ( ) const

Return the name of this phase.

Definition at line 145 of file phaseModel.C.

Referenced by TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::addDmdtHefs(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmdtHefs(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmdtHefsWithoutL(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmdtL(), MomentumTransferPhaseSystem< BasePhaseSystem >::addDmdtUfs(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefs(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefs(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtHefsWithoutL(), HeatTransferPhaseSystem< BasePhaseSystem >::addDmidtL(), Luo::addToCoalescenceRate(), phaseSystem::correctContinuityError(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::correctInterfaceThermo(), sizeGroup::fieldIo(), wallBoilingHeatTransfer::flipSign(), fractal::fractal(), OneResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), ThermalPhaseChangePhaseSystem< BasePhaseSystem >::heatTransfer(), TwoResistanceHeatTransferPhaseSystem< BasePhaseSystem >::heatTransfer(), phaseInterface::index(), SidedInterfacialModel< ModelType >::modelInThe(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransfer(), MomentumTransferPhaseSystem< BasePhaseSystem >::momentumTransferf(), diameterModel::New(), sizeGroup::iNew::operator()(), phaseInterface::otherPhase(), phaseForces::phaseForces(), populationBalanceModel::populationBalanceModel(), blendingMethod::readParameters(), sizeGroup::sizeGroup(), populationBalanceModel::solve(), phaseSystem::solve(), InterfaceCompositionPhaseChangePhaseSystem< BasePhaseSystem >::specieTransfer(), and multiphaseEuler::thermophysicalPredictor().

Here is the caller graph for this function:

◆ keyword()

const Foam::word & keyword ( ) const

Return the name of the phase for use as the keyword in PtrDictionary.

Definition at line 151 of file phaseModel.C.

◆ index()

◆ fluid()

◆ residualAlpha()

◆ alphaMax()

Foam::scalar alphaMax ( ) const

Return the maximum phase-fraction (e.g. packing limit)

Definition at line 175 of file phaseModel.C.

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ d()

◆ diameter()

const Foam::diameterModel & diameter ( ) const

Return a reference to the diameterModel of the phase.

Definition at line 187 of file phaseModel.C.

Referenced by wallBoilingHeatTransfer::K(), phaseChange::precompute(), and phaseSurfaceArrheniusReactionRate::preEvaluate().

Here is the caller graph for this function:

◆ correct()

void correct ( )
virtual

Correct the phase properties.

Definition at line 193 of file phaseModel.C.

◆ correctContinuityError()

void correctContinuityError ( const volScalarField source)
virtual

Correct the continuity error.

Definition at line 199 of file phaseModel.C.

Referenced by phaseSystem::correctContinuityError().

Here is the caller graph for this function:

◆ correctKinematics()

void correctKinematics ( )
virtual

Correct the kinematics.

Definition at line 203 of file phaseModel.C.

◆ correctThermo()

void correctThermo ( )
virtual

Correct the thermodynamics.

Definition at line 207 of file phaseModel.C.

◆ correctReactions()

void correctReactions ( )
virtual

Correct the reactions.

Definition at line 211 of file phaseModel.C.

◆ correctSpecies()

void correctSpecies ( )
virtual

Correct the species concentrations.

Definition at line 215 of file phaseModel.C.

◆ predictMomentumTransport()

void predictMomentumTransport ( )
virtual

Predict the momentumTransport.

Definition at line 219 of file phaseModel.C.

◆ predictThermophysicalTransport()

void predictThermophysicalTransport ( )
virtual

Predict the energy transport.

Definition at line 223 of file phaseModel.C.

◆ correctMomentumTransport()

void correctMomentumTransport ( )
virtual

Correct the momentumTransport.

Definition at line 227 of file phaseModel.C.

◆ correctThermophysicalTransport()

void correctThermophysicalTransport ( )
virtual

Correct the energy transport.

Definition at line 231 of file phaseModel.C.

◆ correctUf()

void correctUf ( )
virtual

Correct the face velocity for moving meshes.

Definition at line 235 of file phaseModel.C.

◆ correctInflowOutflow()

void correctInflowOutflow ( surfaceScalarField alphaPhi) const

Ensure that the flux at inflow/outflow BCs is preserved.

Definition at line 245 of file phaseModel.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryFieldRef(), fvsPatchField< Type >::coupled(), forAll, and patchi.

Referenced by phaseSystem::solve().

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

◆ read()

bool read ( )
virtual

Read phase properties dictionary.

Reimplemented from regIOobject.

Definition at line 239 of file phaseModel.C.

◆ incompressible()

virtual bool incompressible ( ) const
pure virtual

Return true if the phase is incompressible otherwise false.

◆ isochoric()

virtual bool isochoric ( ) const
pure virtual

Return true if the phase is constant density otherwise false.

◆ divU() [1/2]

virtual const autoPtr<volScalarField>& divU ( ) const
pure virtual

Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi))

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ divU() [2/2]

virtual void divU ( tmp< volScalarField divU)
pure virtual

Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi))

◆ thermo() [1/2]

◆ thermo() [2/2]

virtual rhoThermo& thermo ( )
pure virtual

Access the thermophysical model.

◆ fluidThermo() [1/2]

◆ fluidThermo() [2/2]

virtual rhoFluidThermo& fluidThermo ( )
pure virtual

Access the thermophysical model.

◆ rho() [1/2]

◆ rho() [2/2]

virtual volScalarField& rho ( )
pure virtual

Access the density field.

◆ isothermal()

virtual bool isothermal ( ) const
pure virtual

Return whether the phase is isothermal.

Referenced by phaseSystem::phaseSystem().

Here is the caller graph for this function:

◆ heEqn()

virtual tmp<fvScalarMatrix> heEqn ( )
pure virtual

Return the enthalpy equation.

◆ pure()

virtual bool pure ( ) const
pure virtual

Return whether the phase is pure (i.e., not multi-component)

Referenced by PhaseTransferPhaseSystem< BasePhaseSystem >::addDmidtYf(), and phaseSystem::phaseSystem().

Here is the caller graph for this function:

◆ YiEqn()

virtual tmp<fvScalarMatrix> YiEqn ( volScalarField Yi)
pure virtual

Return the species fraction equation.

◆ Y() [1/2]

◆ Y() [2/2]

virtual const volScalarField& Y ( const word name) const
pure virtual

Return a species mass fraction by name.

◆ YRef()

virtual PtrList<volScalarField>& YRef ( )
pure virtual

Access the species mass fractions.

◆ solveSpecie()

virtual bool solveSpecie ( const label  speciei) const
pure virtual

Should the given specie be solved for? I.e., is it active and.

not the default specie?

◆ R()

virtual tmp<fvScalarMatrix> R ( volScalarField Yi) const
pure virtual

Return the fuel consumption rate matrix.

Referenced by reactionDriven::dmidtf().

Here is the caller graph for this function:

◆ stationary()

virtual bool stationary ( ) const
pure virtual

Return whether the phase is stationary.

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::addDmdtUfs(), phaseSystem::phaseSystem(), phaseSystem::solve(), and phaseSystem::validateMassTransfer().

Here is the caller graph for this function:

◆ UEqn()

virtual tmp<fvVectorMatrix> UEqn ( )
pure virtual

Return the momentum equation.

◆ UfEqn()

virtual tmp<fvVectorMatrix> UfEqn ( )
pure virtual

Return the momentum equation for the face-based algorithm.

◆ U()

◆ URef() [1/2]

virtual volVectorField& URef ( )
pure virtual

Access the velocity.

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::addDmdtUfs(), and phaseSystem::correctPhi().

Here is the caller graph for this function:

◆ URef() [2/2]

virtual const volVectorField& URef ( ) const
pure virtual

Access the velocity.

◆ phi()

◆ phiRef() [1/2]

virtual surfaceScalarField& phiRef ( )
pure virtual

Access the volumetric flux.

Referenced by phaseSystem::correctBoundaryFlux(), and phaseSystem::correctPhi().

Here is the caller graph for this function:

◆ phiRef() [2/2]

virtual const surfaceScalarField& phiRef ( ) const
pure virtual

Access the volumetric flux.

◆ Uf()

virtual const autoPtr<surfaceVectorField>& Uf ( ) const
pure virtual

Return the face velocity.

Required for moving mesh cases

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::ddtCorrs().

Here is the caller graph for this function:

◆ UfRef() [1/2]

virtual surfaceVectorField& UfRef ( )
pure virtual

Access the face velocity.

Required for moving mesh cases

Referenced by phaseSystem::correctPhi().

Here is the caller graph for this function:

◆ UfRef() [2/2]

virtual const surfaceVectorField& UfRef ( ) const
pure virtual

Access the face velocity.

Required for moving mesh cases

◆ alphaPhi()

virtual tmp<surfaceScalarField> alphaPhi ( ) const
pure virtual

Return the volumetric flux of the phase.

Referenced by densityChangeDrift::addToDriftRate(), fractal::correct(), populationBalanceModel::solve(), and phaseSystem::solve().

Here is the caller graph for this function:

◆ alphaPhiRef() [1/2]

virtual surfaceScalarField& alphaPhiRef ( )
pure virtual

Access the volumetric flux of the phase.

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ alphaPhiRef() [2/2]

virtual const surfaceScalarField& alphaPhiRef ( ) const
pure virtual

Access the volumetric flux of the phase.

◆ alphaRhoPhi()

virtual tmp<surfaceScalarField> alphaRhoPhi ( ) const
pure virtual

Return the mass flux of the phase.

Referenced by densityChangeDrift::addToDriftRate().

Here is the caller graph for this function:

◆ alphaRhoPhiRef() [1/2]

virtual surfaceScalarField& alphaRhoPhiRef ( )
pure virtual

Access the mass flux of the phase.

Referenced by phaseSystem::solve().

Here is the caller graph for this function:

◆ alphaRhoPhiRef() [2/2]

virtual const surfaceScalarField& alphaRhoPhiRef ( ) const
pure virtual

Access the mass flux of the phase.

◆ UgradU()

virtual tmp<fvVectorMatrix> UgradU ( ) const
pure virtual

Return the velocity transport matrix.

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::invADVfs().

Here is the caller graph for this function:

◆ DUDt()

virtual tmp<fvVectorMatrix> DUDt ( ) const
pure virtual

Return the substantive acceleration matrix.

Referenced by phaseForces::execute(), and MomentumTransferPhaseSystem< BasePhaseSystem >::invADVs().

Here is the caller graph for this function:

◆ continuityError()

virtual tmp<volScalarField> continuityError ( ) const
pure virtual

Return the continuity error.

◆ K()

◆ kappaEff()

virtual tmp<scalarField> kappaEff ( const label  patchi) const
pure virtual

Effective thermal turbulent conductivity.

of mixture for patch [W/m/K]

Referenced by multiphaseExternalTemperatureFvPatchScalarField::getKappa(), coupledMultiphaseTemperatureFvPatchScalarField::getNbr(), and coupledMultiphaseTemperatureFvPatchScalarField::getThis().

Here is the caller graph for this function:

◆ k()

virtual tmp<volScalarField> k ( ) const
pure virtual

Return the turbulent kinetic energy.

◆ pPrimef()

virtual tmp<surfaceScalarField> pPrimef ( ) const
pure virtual

Return the face-phase-pressure'.

(derivative of phase-pressure w.r.t. phase-fraction)

Referenced by MomentumTransferPhaseSystem< BasePhaseSystem >::alphaDByAf(), MomentumTransferPhaseSystem< BasePhaseSystem >::Ffs(), and MomentumTransferPhaseSystem< BasePhaseSystem >::Fs().

Here is the caller graph for this function:

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