Classes | Public Member Functions | Static Public Member Functions | List of all members
phaseModel Class Referenceabstract

Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations. More...

Inheritance diagram for phaseModel:
Inheritance graph
[legend]
Collaboration diagram for phaseModel:
Collaboration graph
[legend]

Classes

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

Public Member Functions

 phaseModel (const word &phaseName, const volScalarField &p, const volScalarField &T)
 Construct from components. More...
 
autoPtr< phaseModelclone () const
 Return clone. More...
 
const wordname () const
 
const wordkeyword () const
 
const rhoThermothermo () const
 Return const-access to phase rhoThermo. More...
 
rhoThermothermo ()
 Return access to phase rhoThermo. More...
 
const volScalarFielddgdt () const
 Return const-access to phase divergence. More...
 
volScalarFielddgdt ()
 Return access to phase divergence. More...
 
void correct ()
 Correct the laminar viscosity. More...
 
 phaseModel (const word &phaseName, const dictionary &phaseDict, const fvMesh &mesh)
 
autoPtr< phaseModelclone () const
 Return clone. More...
 
virtual ~phaseModel ()
 Destructor. More...
 
const wordname () const
 
const wordkeyword () const
 
tmp< volScalarFieldd () const
 
const dimensionedScalarnu () const
 Return the laminar viscosity. More...
 
const dimensionedScalarkappa () const
 
const dimensionedScalarCp () const
 
const dimensionedScalarrho () const
 
const volVectorFieldU () const
 
volVectorFieldU ()
 
const volVectorFieldDDtU () const
 
volVectorFieldDDtU ()
 
const surfaceScalarFieldphi () const
 
surfaceScalarFieldphi ()
 
const surfaceScalarFieldalphaPhi () const
 
surfaceScalarFieldalphaPhi ()
 
void correct ()
 Correct the phase properties. More...
 
bool read (const dictionary &phaseDict)
 Read base transportProperties dictionary. More...
 
 ClassName ("phaseModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseModel, phaseSystem,( const phaseSystem &fluid, const word &phaseName, const label index ),(fluid, phaseName, index))
 
 phaseModel (const phaseSystem &fluid, const word &phaseName, 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...
 
virtual void correct ()
 Correct the phase properties. More...
 
virtual void correctKinematics ()
 Correct the kinematics. More...
 
virtual void correctThermo ()
 Correct the thermodynamics. More...
 
virtual void correctTurbulence ()
 Correct the turbulence. More...
 
virtual void correctEnergyTransport ()
 Correct the energy transport e.g. alphat. More...
 
virtual tmp< fvVectorMatrixUEqn ()=0
 Return the momentum equation. More...
 
virtual tmp< fvScalarMatrixheEqn ()=0
 Return the enthalpy equation. More...
 
virtual tmp< fvScalarMatrixYiEqn (volScalarField &Yi)=0
 Return the species fraction equation. More...
 
virtual bool read ()
 Read phase properties dictionary. More...
 
virtual bool compressible () const
 Return true if the phase is compressible otherwise false. More...
 
virtual const tmp< volScalarField > & divU () const
 Return the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...
 
virtual void divU (const tmp< volScalarField > &divU)
 Set the phase dilatation rate (d(alpha)/dt + div(alpha*phi)) More...
 
virtual const volScalarFieldK () const
 Return the phase kinetic energy. More...
 
virtual const surfaceScalarFieldDbyA () const
 Return the phase diffusivity divided by the momentum coefficient. More...
 
virtual void DbyA (const tmp< surfaceScalarField > &DbyA)
 Set the phase diffusivity divided by the momentum coefficient. More...
 
virtual const rhoThermothermo () const =0
 Return const access to the thermophysical model. More...
 
virtual rhoThermothermo ()=0
 Return non-const access to the thermophysical model. More...
 
virtual tmp< volScalarFieldrho () const =0
 Return the density field. More...
 
virtual const PtrList< volScalarField > & Y () const =0
 Constant access the species mass fractions. More...
 
virtual PtrList< volScalarField > & Y ()=0
 Access the species mass fractions. More...
 
virtual tmp< volVectorFieldU () const =0
 Constant access the velocity. More...
 
virtual volVectorFieldU ()=0
 Access the velocity. More...
 
virtual tmp< volVectorFieldDUDt () const =0
 Return the substantive acceleration. More...
 
virtual tmp< volScalarFieldcontinuityError () const =0
 Constant access the continuity error. More...
 
virtual tmp< surfaceScalarFieldphi () const =0
 Constant access the volumetric flux. More...
 
virtual surfaceScalarFieldphi ()=0
 Access the volumetric flux. More...
 
virtual tmp< surfaceScalarFieldalphaPhi () const =0
 Constant access the volumetric flux of the phase. More...
 
virtual surfaceScalarFieldalphaPhi ()=0
 Access the volumetric flux of the phase. More...
 
virtual tmp< surfaceScalarFieldalphaRhoPhi () const =0
 Constant access the mass flux of the phase. More...
 
virtual surfaceScalarFieldalphaRhoPhi ()=0
 Access the mass flux of the phase. More...
 
virtual tmp< volScalarFieldmu () const =0
 Return the laminar dynamic viscosity. More...
 
virtual tmp< scalarFieldmu (const label patchi) const =0
 Return the laminar dynamic viscosity on a patch. More...
 
virtual tmp< volScalarFieldnu () const =0
 Return the laminar kinematic viscosity. More...
 
virtual tmp< scalarFieldnu (const label patchi) const =0
 Return the laminar kinematic viscosity on a patch. More...
 
virtual tmp< volScalarFieldkappa () const =0
 Return the laminar thermal conductivity. More...
 
virtual tmp< scalarFieldkappa (const label patchi) const =0
 Return the laminar thermal conductivity on a patch. More...
 
virtual tmp< volScalarFieldkappaEff (const volScalarField &alphat) const =0
 Return the effective thermal conductivity. More...
 
virtual tmp< scalarFieldkappaEff (const scalarField &alphat, const label patchi) const =0
 Access the effective thermal conductivity. More...
 
virtual tmp< volScalarFieldalpha () const =0
 Return the laminar thermal diffusivity for enthalpy. More...
 
virtual tmp< scalarFieldalpha (const label patchi) const =0
 Return the laminar thermal diffusivity for enthalpy on a patch. More...
 
virtual tmp< volScalarFieldalphaEff (const volScalarField &alphat) const =0
 Return the effective thermal diffusivity for enthalpy. More...
 
virtual tmp< scalarFieldalphaEff (const scalarField &alphat, const label patchi) const =0
 Return the effective thermal diffusivity for enthalpy on a patch. More...
 
virtual const phaseCompressibleTurbulenceModelturbulence () const =0
 Return the turbulence model. More...
 
 phaseModel (const twoPhaseSystem &fluid, const dictionary &phaseProperties, const word &phaseName)
 
virtual ~phaseModel ()
 Destructor. More...
 
const wordname () const
 Return the name of this phase. More...
 
const twoPhaseSystemfluid () const
 Return the twoPhaseSystem to which this phase belongs. More...
 
const phaseModelotherPhase () const
 Return the other phase in this two-phase system. More...
 
const dimensionedScalarresidualAlpha () const
 Return the residual phase-fraction for given phase. More...
 
scalar alphaMax () const
 Optional maximum phase-fraction (e.g. packing limit) More...
 
tmp< volScalarFieldd () const
 Return the Sauter-mean diameter. More...
 
const PhaseCompressibleTurbulenceModel< phaseModel > & turbulence () const
 Return the turbulence model. More...
 
PhaseCompressibleTurbulenceModel< phaseModel > & turbulence ()
 Return non-const access to the turbulence model. More...
 
const rhoThermothermo () const
 Return the thermophysical model. More...
 
rhoThermothermo ()
 Return non-const access to the thermophysical model. More...
 
tmp< volScalarFieldnu () const
 Return the laminar viscosity. More...
 
tmp< scalarFieldnu (const label patchi) const
 Return the laminar viscosity for patch. More...
 
tmp< volScalarFieldmu () const
 Return the laminar dynamic viscosity. More...
 
tmp< scalarFieldmu (const label patchi) const
 Return the laminar dynamic viscosity for patch. More...
 
tmp< scalarFieldkappa (const label patchi) const
 Return the thermal conductivity on a patch. More...
 
tmp< volScalarFieldkappa () const
 Return the thermal conductivity. More...
 
tmp< volScalarFieldkappaEff (const volScalarField &alphat) const
 Return the laminar thermal conductivity. More...
 
tmp< scalarFieldkappaEff (const scalarField &alphat, const label patchi) const
 Return the laminar thermal conductivity on a patch. More...
 
tmp< volScalarFieldalpha () const
 Return the laminar thermal diffusivity for enthalpy. More...
 
tmp< scalarFieldalpha (const label patchi) const
 Return the laminar thermal diffusivity for enthalpy on a patch. More...
 
tmp< volScalarFieldalphaEff (const volScalarField &alphat) const
 Return the effective thermal diffusivity for enthalpy. More...
 
tmp< scalarFieldalphaEff (const scalarField &alphat, const label patchi) const
 Return the effective thermal diffusivity for enthalpy on a patch. More...
 
tmp< volScalarFieldCp () const
 Return the specific heat capacity. More...
 
const volScalarFieldrho () const
 Return the density. More...
 
const volVectorFieldU () const
 Return the velocity. More...
 
volVectorFieldU ()
 Return non-const access to the velocity. More...
 
const surfaceScalarFieldphi () const
 Return the volumetric flux. More...
 
surfaceScalarFieldphi ()
 Return non-const access to the volumetric flux. More...
 
const surfaceScalarFieldalphaPhi () const
 Return the volumetric flux of the phase. More...
 
surfaceScalarFieldalphaPhi ()
 Return non-const access to the volumetric flux of the phase. More...
 
const surfaceScalarFieldalphaRhoPhi () const
 Return the mass flux of the phase. More...
 
surfaceScalarFieldalphaRhoPhi ()
 Return non-const access to the mass flux of the phase. More...
 
void correct ()
 Correct the phase properties. More...
 
virtual bool read (const dictionary &phaseProperties)
 Read phaseProperties dictionary. More...
 
virtual bool read ()
 Dummy Read for transportModel. More...
 
- Public Member Functions inherited from GeometricField< scalar, fvPatchField, volMesh >
 TypeName ("GeometricField")
 Runtime type information. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
 Constructor given IOobject, mesh, dimensions and patch type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensions and patch types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< scalar > &, const word &patchFieldType=fvPatchField< scalar >::calculatedType())
 Constructor given IOobject, mesh, dimensioned<Type> and patch type. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensioned< scalar > &, const wordList &wantedPatchTypes, const wordList &actualPatchTypes=wordList())
 Constructor given IOobject, mesh, dimensioned<Type> and patch types. More...
 
 GeometricField (const IOobject &, const Mesh &, const dimensionSet &, const Field< scalar > &, const PtrList< fvPatchField< scalar > > &)
 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< scalar, fvPatchField, volMesh > &)
 Construct as copy. More...
 
 GeometricField (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 Construct as copy of tmp<GeometricField> deleting argument. More...
 
 GeometricField (const IOobject &, const GeometricField< scalar, fvPatchField, volMesh > &)
 Construct as copy resetting IO parameters. More...
 
 GeometricField (const IOobject &, const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 Construct as copy of tmp<GeometricField> resetting IO parameters. More...
 
 GeometricField (const word &newName, const GeometricField< scalar, fvPatchField, volMesh > &)
 Construct as copy resetting name. More...
 
 GeometricField (const word &newName, const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 Construct as copy resetting name. More...
 
 GeometricField (const IOobject &, const GeometricField< scalar, fvPatchField, volMesh > &, const word &patchFieldType)
 Construct as copy resetting IO parameters and patch type. More...
 
 GeometricField (const IOobject &, const GeometricField< scalar, fvPatchField, volMesh > &, const wordList &patchFieldTypes, const wordList &actualPatchTypes=wordList())
 Construct as copy resetting IO parameters and boundary types. More...
 
virtual ~GeometricField ()
 Destructor. More...
 
DimensionedInternalFielddimensionedInternalField ()
 Return dimensioned internal field. More...
 
const DimensionedInternalFielddimensionedInternalField () const
 Return dimensioned internal field. More...
 
InternalFieldinternalField ()
 Return internal field. More...
 
const InternalFieldinternalField () const
 Return internal field. More...
 
GeometricBoundaryField & boundaryField ()
 Return reference to GeometricBoundaryField. More...
 
const GeometricBoundaryField & boundaryField () const
 Return reference to GeometricBoundaryField for const field. More...
 
label timeIndex () const
 Return the time index of the field. More...
 
labeltimeIndex ()
 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< scalar, fvPatchField, volMesh > & oldTime () const
 Return old time field. More...
 
GeometricField< scalar, fvPatchField, volMesh > & oldTime ()
 Return non-const old time field. More...
 
void storePrevIter () const
 Store the field as the previous iteration value. More...
 
const GeometricField< scalar, fvPatchField, volMesh > & 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, fvPatchField, volMesh > > component (const direction) const
 Return a component of the field. More...
 
bool writeData (Ostream &) const
 WriteData member function required by regIOobject. More...
 
tmp< GeometricField< scalar, fvPatchField, volMesh > > 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, fvPatchField, volMesh > &)
 
void replace (const direction, const dimensioned< cmptType > &)
 
void max (const dimensioned< scalar > &)
 
void max (const GeometricField< scalar, fvPatchField, volMesh > &, const dimensioned< scalar > &)
 
void min (const dimensioned< scalar > &)
 
void min (const GeometricField< scalar, fvPatchField, volMesh > &, const dimensioned< scalar > &)
 
void scale (const GeometricField< scalar, fvPatchField, volMesh > &, const GeometricField< scalar, fvPatchField, volMesh > &)
 
void scale (const GeometricField< scalar, fvPatchField, volMesh > &, const dimensioned< scalar > &)
 
void operator= (const GeometricField< scalar, fvPatchField, volMesh > &)
 
void operator= (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 
void operator= (const dimensioned< scalar > &)
 
void operator== (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 
void operator== (const dimensioned< scalar > &)
 
void operator+= (const GeometricField< scalar, fvPatchField, volMesh > &)
 
void operator+= (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 
void operator+= (const dimensioned< scalar > &)
 
void operator-= (const GeometricField< scalar, fvPatchField, volMesh > &)
 
void operator-= (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 
void operator-= (const dimensioned< scalar > &)
 
void operator*= (const GeometricField< scalar, fvPatchField, volMesh > &)
 
void operator*= (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 
void operator*= (const dimensioned< scalar > &)
 
void operator/= (const GeometricField< scalar, fvPatchField, volMesh > &)
 
void operator/= (const tmp< GeometricField< scalar, fvPatchField, volMesh > > &)
 
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 DimensionedField< Type, GeoMesh > &)
 Construct as copy. More...
 
 DimensionedField (DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 DimensionedField (const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField. More...
 
 DimensionedField (const tmp< DimensionedField< Type, GeoMesh > > &)
 Construct as copy of tmp<DimensionedField> deleting argument. More...
 
 DimensionedField (const IOobject &, const DimensionedField< Type, GeoMesh > &)
 Construct as copy resetting IO parameters. More...
 
 DimensionedField (const IOobject &, DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy resetting IO parameters and re-use as specified. More...
 
 DimensionedField (const word &newName, const DimensionedField< Type, GeoMesh > &)
 Construct as copy resetting name. More...
 
 DimensionedField (const word &newName, DimensionedField< Type, GeoMesh > &, bool reUse)
 Construct as copy resetting name and re-use as specified. More...
 
 DimensionedField (const word &newName, const Xfer< DimensionedField< Type, GeoMesh > > &)
 Construct by transferring the DimensionedField with a new name. More...
 
 DimensionedField (const word &newName, const tmp< DimensionedField< Type, GeoMesh > > &)
 Construct as copy 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...
 
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= (const tmp< DimensionedField< Type, GeoMesh > > &)
 
void operator= (const dimensioned< Type > &)
 
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 &)
 Construct as copy. More...
 
 regIOobject (const regIOobject &, bool registerCopy)
 Construct as copy, transferring registry registration to copy. More...
 
 regIOobject (const word &newName, const regIOobject &, bool registerCopy)
 Construct as copy with new name, transfering registry registration. More...
 
 regIOobject (const IOobject &, const regIOobject &)
 Construct as copy with new IO parameters. More...
 
virtual ~regIOobject ()
 Destructor. More...
 
bool checkIn ()
 Add object to registry. More...
 
bool checkOut ()
 Remove object from 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...
 
IstreamreadStream (const word &)
 Return Istream and check object type against that given. More...
 
void close ()
 Close Istream. More...
 
virtual bool readData (Istream &)
 Virtual readData function. More...
 
label watchIndex () const
 Return file-monitoring handle. More...
 
labelwatchIndex ()
 Return file-monitoring handle. 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 writeObject (IOstream::streamFormat, IOstream::versionNumber, IOstream::compressionType) const
 Write using given format, version and compression. More...
 
virtual bool write () 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 &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...
 
Foam::autoPtr< IOobjectclone () const
 Clone. 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...
 
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
 
const fileNameinstance () const
 
fileNameinstance ()
 
const fileNamelocal () 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 objectPath () const
 Return complete path + object name. More...
 
fileName filePath () const
 Return complete path + object name if the file exists. More...
 
bool readHeader (Istream &)
 Read header. More...
 
bool headerOk ()
 Read and check header info. 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 UList< Type > &)
 Construct as copy of a UList<Type> More...
 
 Field (const Xfer< List< Type > > &)
 Construct by transferring the List contents. 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 (const UList< Type > &mapF, const FieldMapper &map)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const Type &defaultValue)
 Construct by mapping from the given field. More...
 
 Field (const UList< Type > &mapF, const FieldMapper &map, const UList< Type > &defaultValues)
 Construct by mapping from the given field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Construct by mapping from the given tmp field. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const Type &defaultValue)
 Construct by mapping from the given tmp field. Supplied uniform. More...
 
 Field (const tmp< Field< Type > > &tmapF, const FieldMapper &map, const UList< Type > &defaultValues)
 Construct by mapping from the given tmp field. Supplied values. More...
 
 Field (const Field< Type > &)
 Construct as copy. More...
 
 Field (Field< Type > &, bool reUse)
 Construct as copy or re-use as specified. More...
 
 Field (const Xfer< Field< Type > > &)
 Construct by transferring the Field contents. More...
 
 Field (const tmp< Field< Type > > &)
 Construct as copy of 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 map (const UList< Type > &mapF, const FieldMapper &map)
 Map from the given field. More...
 
void map (const tmp< Field< Type > > &tmapF, const FieldMapper &map)
 Map from the given tmp field. More...
 
void autoMap (const FieldMapper &map)
 Map from self. 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...
 
tmp< Field< Type > > T () const
 Return the field transpose (only defined for second rank tensors) More...
 
void writeEntry (const word &keyword, Ostream &os) const
 Write the field as a dictionary entry. More...
 
void operator= (const Field< Type > &)
 
void operator= (const UList< Type > &)
 
void operator= (const SubField< Type > &)
 
void operator= (const tmp< Field< Type > > &)
 
void operator= (const Type &)
 
template<class Form , class Cmpt , int 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
 refCount ()
 Construct null with zero count. More...
 
int count () const
 Return the reference count. More...
 
bool okToDelete () const
 Return true if the reference count is zero. More...
 
void resetRefCount ()
 Reset the reference count to 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 >
label size () const
 Return the number of elements in the UList. More...
 
 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 List< Type > &)
 Copy constructor. More...
 
 List (const Xfer< List< Type > > &)
 Construct by transferring the parameter contents. 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 (Istream &)
 Construct from Istream. 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...
 
Xfer< List< Type > > xfer ()
 Transfer contents to the Xfer container. More...
 
Type & newElmt (const label)
 Return subscript-checked element of UList. More...
 
void operator= (const UList< Type > &)
 Assignment from UList operator. Takes linear time. More...
 
void operator= (const List< Type > &)
 Assignment operator. Takes linear time. More...
 
void operator= (const SLList< Type > &)
 Assignment from SLList operator. Takes linear time. More...
 
void operator= (const UIndirectList< Type > &)
 Assignment from UIndirectList operator. Takes linear time. More...
 
void operator= (const BiIndirectList< Type > &)
 Assignment from BiIndirectList operator. Takes linear time. More...
 
void operator= (const Type &)
 Assignment of all entries to the given value. More...
 
- Public Member Functions inherited from UList< Type >
 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 writeEntry (Ostream &) const
 Write the UList as a dictionary entry. More...
 
void writeEntry (const word &keyword, Ostream &) const
 Write the UList as a dictionary entry with keyword. More...
 
void assign (const UList< Type > &)
 Assign elements to those from UList. More...
 
Type & operator[] (const label)
 Return element of UList. More...
 
const Type & operator[] (const label) const
 Return element of constant UList. More...
 
 operator const Foam::List< Type > & () const
 Allow cast to a const List<T>&. More...
 
void operator= (const Type &)
 Assignment of all entries to the given value. 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 transportModel
 TypeName ("transportModel")
 Runtime type information. More...
 
 transportModel ()
 Construct from components. More...
 
virtual ~transportModel ()
 Destructor. More...
 

Static Public Member Functions

static autoPtr< phaseModelNew (const phaseSystem &fluid, const word &phaseName, const label index)
 
- Static Public Member Functions inherited from GeometricField< scalar, fvPatchField, volMesh >
static const GeometricField< scalar, fvPatchField, volMesh > & null ()
 Return a null geometric field. More...
 
- Static Public Member Functions inherited from DimensionedField< Type, GeoMesh >
static const DimensionedField< Type, GeoMesh > & null ()
 Return a null DimensionedField. 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)
 
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< scalar, fvPatchField, volMesh >
typedef volMesh::Mesh Mesh
 
typedef volMesh::BoundaryMesh BoundaryMesh
 
typedef DimensionedField< scalar, volMeshDimensionedInternalField
 
typedef Field< scalar > InternalField
 
typedef fvPatchField< scalar > PatchFieldType
 
typedef Field< scalar >::cmptType cmptType
 
- Public Types inherited from DimensionedField< Type, GeoMesh >
typedef GeoMesh::Mesh Mesh
 
typedef Field< Type >::cmptType cmptType
 
- Public Types inherited from regIOobject
enum  fileCheckTypes { timeStamp, timeStampMaster, inotify, inotifyMaster }
 Types of communications. 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...
 
- 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 Type * reverse_iterator
 Reverse iterator for reverse traversal of UList. More...
 
typedef const Type * const_reverse_iterator
 Reverse iterator for reverse traversal of constant UList. More...
 
- Static Public Attributes inherited from regIOobject
static const NamedEnum< fileCheckTypes, 4 > fileCheckTypesNames
 
static int fileModificationSkew
 
static fileCheckTypes fileModificationChecking
 
- Static Public Attributes inherited from Field< Type >
static const char *const typeName
 
- Protected Member Functions inherited from IOobject
IstreamobjectStream ()
 Construct and return an IFstream for the object. More...
 
IstreamobjectStream (const fileName &)
 Construct and return an IFstream for the object given the. More...
 
void setBad (const string &)
 Set the object state to bad. More...
 
- Protected Member Functions inherited from List< Type >
void size (const label)
 Override size to be inconsistent with allocated storage. More...
 
- Static Protected Attributes inherited from regIOobject
static bool masterOnlyReading = false
 To flag master-only reading of objects. More...
 

Detailed Description

Single incompressible phase derived from the phase-fraction. Used as part of the multiPhaseMixture for interface-capturing multi-phase simulations.

Source files
Source files
Source files
Source files

Definition at line 53 of file phaseModel.H.

Constructor & Destructor Documentation

phaseModel ( const word phaseName,
const volScalarField p,
const volScalarField T 
)

Construct from components.

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

Here is the caller graph for this function:

phaseModel ( const word phaseName,
const dictionary phaseDict,
const fvMesh mesh 
)
virtual ~phaseModel ( )
virtual

Destructor.

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

Here is the caller graph for this function:

phaseModel ( const phaseSystem fluid,
const word phaseName,
const label  index 
)
virtual ~phaseModel ( )
virtual

Destructor.

phaseModel ( const twoPhaseSystem fluid,
const dictionary phaseProperties,
const word phaseName 
)
virtual ~phaseModel ( )
virtual

Destructor.

Member Function Documentation

autoPtr<phaseModel> clone ( ) const

Return clone.

const word& name ( ) const
inline

Definition at line 109 of file phaseModel.H.

Referenced by phaseModel::keyword(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

const word& keyword ( ) const
inline

Definition at line 114 of file phaseModel.H.

References phaseModel::name().

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

Here is the call graph for this function:

Here is the caller graph for this function:

const rhoThermo& thermo ( ) const
inline

Return const-access to phase rhoThermo.

Definition at line 120 of file phaseModel.H.

Referenced by phaseModel::iNew::operator()(), and phaseModel::thermo().

Here is the caller graph for this function:

rhoThermo& thermo ( )
inline

Return access to phase rhoThermo.

Definition at line 126 of file phaseModel.H.

const volScalarField& dgdt ( ) const
inline

Return const-access to phase divergence.

Definition at line 132 of file phaseModel.H.

volScalarField& dgdt ( )
inline

Return access to phase divergence.

Definition at line 138 of file phaseModel.H.

References phaseModel::correct().

Here is the call graph for this function:

void correct ( )
virtual

Correct the laminar viscosity.

Implements transportModel.

Referenced by phaseModel::alphaPhi(), phaseModel::alphaRhoPhi(), phaseModel::dgdt(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

autoPtr<phaseModel> clone ( ) const

Return clone.

const word& name ( ) const
inline

Definition at line 138 of file phaseModel.H.

const word& keyword ( ) const
inline

Definition at line 143 of file phaseModel.H.

References phaseModel::d(), and phaseModel::name().

Here is the call graph for this function:

tmp<volScalarField> d ( ) const

Referenced by phaseModel::fluid(), phaseModel::keyword(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

const dimensionedScalar& nu ( ) const
inlinevirtual

Return the laminar viscosity.

Implements transportModel.

Definition at line 150 of file phaseModel.H.

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

Here is the caller graph for this function:

const dimensionedScalar& kappa ( ) const
inline

Definition at line 155 of file phaseModel.H.

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

Here is the caller graph for this function:

const dimensionedScalar& Cp ( ) const
inline

Definition at line 160 of file phaseModel.H.

const dimensionedScalar& rho ( ) const
inline

Definition at line 165 of file phaseModel.H.

Referenced by phaseModel::iNew::operator()(), mixtureKEpsilon< BasicTurbulenceModel >::rhogEff(), and mixtureKEpsilon< BasicTurbulenceModel >::rholEff().

Here is the caller graph for this function:

const volVectorField& U ( ) const
inline

Definition at line 170 of file phaseModel.H.

Referenced by phaseModel::iNew::operator()(), and phaseModel::U().

Here is the caller graph for this function:

volVectorField& U ( )
inline

Definition at line 175 of file phaseModel.H.

const volVectorField& DDtU ( ) const
inline

Definition at line 180 of file phaseModel.H.

volVectorField& DDtU ( )
inline

Definition at line 185 of file phaseModel.H.

const surfaceScalarField& phi ( ) const
inline

Definition at line 190 of file phaseModel.H.

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

Here is the caller graph for this function:

surfaceScalarField& phi ( )
inline

Definition at line 195 of file phaseModel.H.

const surfaceScalarField& alphaPhi ( ) const
inline

Definition at line 200 of file phaseModel.H.

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

Here is the caller graph for this function:

surfaceScalarField& alphaPhi ( )
inline

Definition at line 205 of file phaseModel.H.

References phaseModel::correct(), phaseModel::read(), and regIOobject::read().

Here is the call graph for this function:

void correct ( )
virtual

Correct the phase properties.

Implements transportModel.

bool read ( const dictionary phaseDict)

Read base transportProperties dictionary.

ClassName ( "phaseModel"  )

Runtime type information.

declareRunTimeSelectionTable ( autoPtr  ,
phaseModel  ,
phaseSystem  ,
( const phaseSystem &fluid, const word &phaseName, const label index ,
(fluid, phaseName, index  
)
autoPtr<phaseModel> clone ( ) const

Return clone.

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

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

Here is the caller graph for this function:

const word& name ( ) const

Return the name of this phase.

const word& keyword ( ) const

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

label index ( ) const

Return the index of the phase.

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

Here is the caller graph for this function:

const phaseSystem& fluid ( ) const

Return the system to which this phase belongs.

Referenced by IATEsource::fluid(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

const dimensionedScalar& residualAlpha ( ) const

Return the residual phase-fraction for given phase.

Used to stabilize the phase momentum as the phase-fraction -> 0

Referenced by phaseModel::fluid(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

scalar alphaMax ( ) const

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

Referenced by phaseModel::fluid(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

tmp<volScalarField> d ( ) const

Return the Sauter-mean diameter.

virtual void correct ( )
virtual

Correct the phase properties.

Implements transportModel.

virtual void correctKinematics ( )
virtual

Correct the kinematics.

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

Here is the caller graph for this function:

virtual void correctThermo ( )
virtual

Correct the thermodynamics.

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

Here is the caller graph for this function:

virtual void correctTurbulence ( )
virtual

Correct the turbulence.

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

Here is the caller graph for this function:

virtual void correctEnergyTransport ( )
virtual

Correct the energy transport e.g. alphat.

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

Here is the caller graph for this function:

virtual tmp<fvVectorMatrix> UEqn ( )
pure virtual

Return the momentum equation.

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

Here is the caller graph for this function:

virtual tmp<fvScalarMatrix> heEqn ( )
pure virtual

Return the enthalpy equation.

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

Here is the caller graph for this function:

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

Return the species fraction equation.

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

Here is the caller graph for this function:

virtual bool read ( )
virtual

Read phase properties dictionary.

Implements transportModel.

Referenced by phaseModel::alphaPhi(), phaseModel::alphaRhoPhi(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

virtual bool compressible ( ) const
virtual

Return true if the phase is compressible otherwise false.

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

Here is the caller graph for this function:

virtual const tmp<volScalarField>& divU ( ) const
virtual

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

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

Here is the caller graph for this function:

virtual void divU ( const tmp< volScalarField > &  divU)
virtual

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

virtual const volScalarField& K ( ) const
virtual

Return the phase kinetic energy.

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

Here is the caller graph for this function:

virtual const surfaceScalarField& DbyA ( ) const
virtual

Return the phase diffusivity divided by the momentum coefficient.

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

Here is the caller graph for this function:

virtual void DbyA ( const tmp< surfaceScalarField > &  DbyA)
virtual

Set the phase diffusivity divided by the momentum coefficient.

virtual const rhoThermo& thermo ( ) const
pure virtual

Return const access to the thermophysical model.

virtual rhoThermo& thermo ( )
pure virtual

Return non-const access to the thermophysical model.

for correction

virtual tmp<volScalarField> rho ( ) const
pure virtual

Return the density field.

virtual const PtrList<volScalarField>& Y ( ) const
pure virtual

Constant access the species mass fractions.

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

Here is the caller graph for this function:

virtual PtrList<volScalarField>& Y ( )
pure virtual

Access the species mass fractions.

virtual tmp<volVectorField> U ( ) const
pure virtual

Constant access the velocity.

virtual volVectorField& U ( )
pure virtual

Access the velocity.

virtual tmp<volVectorField> DUDt ( ) const
pure virtual

Return the substantive acceleration.

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

Here is the caller graph for this function:

virtual tmp<volScalarField> continuityError ( ) const
pure virtual

Constant access the continuity error.

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

Here is the caller graph for this function:

virtual tmp<surfaceScalarField> phi ( ) const
pure virtual

Constant access the volumetric flux.

virtual surfaceScalarField& phi ( )
pure virtual

Access the volumetric flux.

virtual tmp<surfaceScalarField> alphaPhi ( ) const
pure virtual

Constant access the volumetric flux of the phase.

virtual surfaceScalarField& alphaPhi ( )
pure virtual

Access the volumetric flux of the phase.

virtual tmp<surfaceScalarField> alphaRhoPhi ( ) const
pure virtual

Constant access the mass flux of the phase.

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

Here is the caller graph for this function:

virtual surfaceScalarField& alphaRhoPhi ( )
pure virtual

Access the mass flux of the phase.

virtual tmp<volScalarField> mu ( ) const
pure virtual

Return the laminar dynamic viscosity.

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

Here is the caller graph for this function:

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

Return the laminar dynamic viscosity on a patch.

virtual tmp<volScalarField> nu ( ) const
pure virtual

Return the laminar kinematic viscosity.

Implements transportModel.

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

Return the laminar kinematic viscosity on a patch.

Implements transportModel.

virtual tmp<volScalarField> kappa ( ) const
pure virtual

Return the laminar thermal conductivity.

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

Return the laminar thermal conductivity on a patch.

virtual tmp<volScalarField> kappaEff ( const volScalarField alphat) const
pure virtual

Return the effective thermal conductivity.

Referenced by phaseModel::kappa(), phaseModel::kappaEff(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

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

Access the effective thermal conductivity.

virtual tmp<volScalarField> alpha ( ) const
pure virtual

Return the laminar thermal diffusivity for enthalpy.

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

Here is the caller graph for this function:

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

Return the laminar thermal diffusivity for enthalpy on a patch.

virtual tmp<volScalarField> alphaEff ( const volScalarField alphat) const
pure virtual

Return the effective thermal diffusivity for enthalpy.

Referenced by phaseModel::alpha(), phaseModel::alphaEff(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

virtual tmp<scalarField> alphaEff ( const scalarField alphat,
const label  patchi 
) const
pure virtual

Return the effective thermal diffusivity for enthalpy on a patch.

virtual const phaseCompressibleTurbulenceModel& turbulence ( ) const
pure virtual

Return the turbulence model.

Referenced by phaseModel::fluid(), and phaseModel::iNew::operator()().

Here is the caller graph for this function:

const word& name ( ) const
inline

Return the name of this phase.

Definition at line 121 of file phaseModel.H.

const twoPhaseSystem& fluid ( ) const
inline

Return the twoPhaseSystem to which this phase belongs.

Definition at line 127 of file phaseModel.H.

References phaseModel::alphaMax(), phaseModel::d(), phaseModel::otherPhase(), phaseModel::residualAlpha(), and phaseModel::turbulence().

Here is the call graph for this function:

const phaseModel& otherPhase ( ) const

Return the other phase in this two-phase system.

Referenced by phaseModel::fluid(), and IATEsource::otherPhase().

Here is the caller graph for this function:

const dimensionedScalar& residualAlpha ( ) const
inline

Return the residual phase-fraction for given phase.

Used to stabilize the phase momentum as the phase-fraction -> 0

Definition at line 137 of file phaseModel.H.

scalar alphaMax ( ) const
inline

Optional maximum phase-fraction (e.g. packing limit)

Defaults to 1

Definition at line 144 of file phaseModel.H.

tmp<volScalarField> d ( ) const

Return the Sauter-mean diameter.

const PhaseCompressibleTurbulenceModel<phaseModel>& turbulence ( ) const

Return the turbulence model.

Return non-const access to the turbulence model.

for correction

const rhoThermo& thermo ( ) const
inline

Return the thermophysical model.

Definition at line 162 of file phaseModel.H.

References phaseModel::thermo().

Here is the call graph for this function:

rhoThermo& thermo ( )
inline

Return non-const access to the thermophysical model.

for correction

Definition at line 169 of file phaseModel.H.

tmp<volScalarField> nu ( ) const
inlinevirtual

Return the laminar viscosity.

Implements transportModel.

Definition at line 175 of file phaseModel.H.

tmp<scalarField> nu ( const label  patchi) const
inlinevirtual

Return the laminar viscosity for patch.

Implements transportModel.

Definition at line 181 of file phaseModel.H.

tmp<volScalarField> mu ( ) const
inline

Return the laminar dynamic viscosity.

Definition at line 187 of file phaseModel.H.

tmp<scalarField> mu ( const label  patchi) const
inline

Return the laminar dynamic viscosity for patch.

Definition at line 193 of file phaseModel.H.

tmp<scalarField> kappa ( const label  patchi) const
inline

Return the thermal conductivity on a patch.

Definition at line 199 of file phaseModel.H.

tmp<volScalarField> kappa ( ) const
inline

Return the thermal conductivity.

Definition at line 205 of file phaseModel.H.

References phaseModel::kappaEff().

Here is the call graph for this function:

tmp<volScalarField> kappaEff ( const volScalarField alphat) const
inline

Return the laminar thermal conductivity.

Definition at line 212 of file phaseModel.H.

References phaseModel::kappaEff().

Here is the call graph for this function:

tmp<scalarField> kappaEff ( const scalarField alphat,
const label  patchi 
) const
inline

Return the laminar thermal conductivity on a patch.

Definition at line 221 of file phaseModel.H.

tmp<volScalarField> alpha ( ) const
inline

Return the laminar thermal diffusivity for enthalpy.

Definition at line 230 of file phaseModel.H.

tmp<scalarField> alpha ( const label  patchi) const
inline

Return the laminar thermal diffusivity for enthalpy on a patch.

Definition at line 236 of file phaseModel.H.

References phaseModel::alphaEff().

Here is the call graph for this function:

tmp<volScalarField> alphaEff ( const volScalarField alphat) const
inline

Return the effective thermal diffusivity for enthalpy.

Definition at line 243 of file phaseModel.H.

References phaseModel::alphaEff().

Here is the call graph for this function:

tmp<scalarField> alphaEff ( const scalarField alphat,
const label  patchi 
) const
inline

Return the effective thermal diffusivity for enthalpy on a patch.

Definition at line 252 of file phaseModel.H.

tmp<volScalarField> Cp ( ) const
inline

Return the specific heat capacity.

Definition at line 261 of file phaseModel.H.

const volScalarField& rho ( ) const
inline

Return the density.

Definition at line 267 of file phaseModel.H.

const volVectorField& U ( ) const
inline

Return the velocity.

Definition at line 273 of file phaseModel.H.

References phaseModel::U().

Here is the call graph for this function:

volVectorField& U ( )
inline

Return non-const access to the velocity.

Used in the momentum equation

Definition at line 280 of file phaseModel.H.

const surfaceScalarField& phi ( ) const
inline

Return the volumetric flux.

Definition at line 286 of file phaseModel.H.

surfaceScalarField& phi ( )
inline

Return non-const access to the volumetric flux.

Definition at line 292 of file phaseModel.H.

const surfaceScalarField& alphaPhi ( ) const
inline

Return the volumetric flux of the phase.

Definition at line 298 of file phaseModel.H.

surfaceScalarField& alphaPhi ( )
inline

Return non-const access to the volumetric flux of the phase.

Definition at line 304 of file phaseModel.H.

const surfaceScalarField& alphaRhoPhi ( ) const
inline

Return the mass flux of the phase.

Definition at line 310 of file phaseModel.H.

surfaceScalarField& alphaRhoPhi ( )
inline

Return non-const access to the mass flux of the phase.

Definition at line 316 of file phaseModel.H.

References phaseModel::correct(), and phaseModel::read().

Here is the call graph for this function:

void correct ( )
virtual

Correct the phase properties.

other than the thermodynamics and turbulence which have special treatment

Implements transportModel.

virtual bool read ( const dictionary phaseProperties)
virtual

Read phaseProperties dictionary.

virtual bool read ( )
inlinevirtual

Dummy Read for transportModel.

Implements transportModel.

Definition at line 330 of file phaseModel.H.


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