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

Base-class for fluid thermodynamic properties. More...

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

Classes

class  implementation
 

Public Member Functions

 TypeName ("fluidThermo")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fluidThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
 Declare run-time constructor selection table. More...
 
virtual ~fluidThermo ()
 Destructor. More...
 
virtual const volScalarField & p () const =0
 Pressure [Pa]. More...
 
virtual volScalarField & p ()=0
 Pressure [Pa]. More...
 
virtual const volScalarField & psi () const =0
 Compressibility [s^2/m^2]. More...
 
virtual tmp< volScalarField > renameRho ()=0
 Rename the thermodynamic density field if stored and return. More...
 
virtual void correctRho (const volScalarField &deltaRho)=0
 Add the given density correction to the density field. More...
 
virtual const volScalarField & mu () const =0
 Dynamic viscosity of mixture [kg/m/s]. More...
 
tmp< volScalarField > nu () const
 Kinematic viscosity of mixture [m^2/s]. More...
 
tmp< scalarField > nu (const label patchi) const
 Kinematic viscosity of mixture for patch [m^2/s]. More...
 
- Public Member Functions inherited from basicThermo
 TypeName ("basicThermo")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, basicThermo, fvMesh,(const fvMesh &mesh, const word &phaseName),(mesh, phaseName))
 Declare run-time constructor selection table. More...
 
virtual ~basicThermo ()
 Destructor. More...
 
virtual const IOdictionary & properties () const =0
 Properties dictionary. More...
 
virtual IOdictionary & properties ()=0
 Non-const access the properties dictionary. More...
 
virtual const fvMesh & mesh () const =0
 Return const access to the mesh. More...
 
virtual const word & phaseName () const =0
 Phase name. More...
 
word phasePropertyName (const word &name) const
 Name of a property for a given phase. More...
 
void validate (const string &app, const word &) const
 Check that the thermodynamics package is consistent. More...
 
void validate (const string &app, const word &, const word &) const
 Check that the thermodynamics package is consistent. More...
 
virtual void correct ()=0
 Update properties. More...
 
virtual word thermoName () const =0
 Name of the thermo physics. More...
 
virtual bool incompressible () const =0
 Return true if the equation of state is incompressible. More...
 
virtual bool isochoric () const =0
 Return true if the equation of state is isochoric. More...
 
virtual Switch dpdt () const =0
 Should the dpdt term be included in the enthalpy equation. More...
 
virtual tmp< volScalarField > W () const =0
 Molecular weight [kg/kmol]. More...
 
virtual tmp< scalarField > W (const label patchi) const =0
 Molecular weight for patch [kg/kmol]. More...
 
virtual const volScalarField & T () const =0
 Temperature [K]. More...
 
virtual volScalarField & T ()=0
 Temperature [K]. More...
 
virtual const volScalarField & he () const =0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual volScalarField & he ()=0
 Enthalpy/Internal energy [J/kg]. More...
 
virtual const volScalarField & Cp () const =0
 Heat capacity at constant pressure [J/kg/K]. More...
 
virtual const volScalarField & Cv () const =0
 Heat capacity at constant volume [J/kg/K]. More...
 
virtual const volScalarField & Cpv () const =0
 Heat capacity at constant pressure/volume [J/kg/K]. More...
 
virtual tmp< volScalarField > rho () const =0
 Density [kg/m^3]. More...
 
virtual tmp< scalarField > rho (const label patchi) const =0
 Density for patch [kg/m^3]. More...
 
virtual tmp< volScalarField > he (const volScalarField &p, const volScalarField &T) const =0
 Enthalpy/Internal energy. More...
 
virtual tmp< volScalarField::Internal > he (const volScalarField::Internal &p, const volScalarField::Internal &T) const =0
 Enthalpy/Internal energy. More...
 
virtual tmp< scalarField > he (const scalarField &T, const labelList &cells) const =0
 Enthalpy/Internal energy for cell-set [J/kg]. More...
 
virtual tmp< scalarField > he (const scalarField &T, const label patchi) const =0
 Enthalpy/Internal energy for patch [J/kg]. More...
 
virtual tmp< volScalarField::Internal > he (const volScalarField::Internal &T, const fvSource &model, const volScalarField::Internal &source) const =0
 Enthalpy/Internal energy for source [J/kg]. More...
 
virtual tmp< scalarField > he (const scalarField &T, const fvSource &model, const scalarField &source, const labelUList &cells) const =0
 Enthalpy/Internal energy for source [J/kg]. More...
 
virtual tmp< volScalarField > hs () const =0
 Sensible enthalpy [J/kg]. More...
 
virtual tmp< volScalarField > hs (const volScalarField &p, const volScalarField &T) const =0
 Sensible enthalpy. More...
 
virtual tmp< volScalarField::Internal > hs (const volScalarField::Internal &p, const volScalarField::Internal &T) const =0
 Sensible enthalpy. More...
 
virtual tmp< scalarField > hs (const scalarField &T, const labelList &cells) const =0
 Sensible enthalpy for cell-set [J/kg]. More...
 
virtual tmp< scalarField > hs (const scalarField &T, const label patchi) const =0
 Sensible enthalpy for patch [J/kg]. More...
 
virtual tmp< volScalarField > ha () const =0
 Absolute enthalpy [J/kg]. More...
 
virtual tmp< volScalarField > ha (const volScalarField &p, const volScalarField &T) const =0
 Absolute enthalpy. More...
 
virtual tmp< volScalarField::Internal > ha (const volScalarField::Internal &p, const volScalarField::Internal &T) const =0
 Absolute enthalpy. More...
 
virtual tmp< scalarField > ha (const scalarField &T, const labelList &cells) const =0
 Absolute enthalpy for cell-set [J/kg]. More...
 
virtual tmp< scalarField > ha (const scalarField &T, const label patchi) const =0
 Absolute enthalpy for patch [J/kg]. More...
 
virtual tmp< scalarField > Cp (const scalarField &T, const label patchi) const =0
 Heat capacity at constant pressure for patch [J/kg/K]. More...
 
virtual tmp< scalarField > Cv (const scalarField &T, const label patchi) const =0
 Heat capacity at constant volume for patch [J/kg/K]. More...
 
virtual tmp< scalarField > Cpv (const scalarField &T, const label patchi) const =0
 Heat capacity at constant pressure/volume for patch [J/kg/K]. More...
 
tmp< volScalarField > gamma () const
 Gamma = Cp/Cv []. More...
 
tmp< scalarField > gamma (const scalarField &T, const label patchi) const
 Gamma = Cp/Cv for patch []. More...
 
virtual tmp< volScalarField > The (const volScalarField &h, const volScalarField &p, const volScalarField &T0) const =0
 Temperature from enthalpy/internal energy. More...
 
virtual tmp< scalarField > The (const scalarField &h, const scalarField &T0, const labelList &cells) const =0
 Temperature from enthalpy/internal energy for cell-set. More...
 
virtual tmp< scalarField > The (const scalarField &h, const scalarField &T0, const label patchi) const =0
 Temperature from enthalpy/internal energy for patch. More...
 
virtual const volScalarField & kappa () const =0
 Thermal conductivity of mixture [W/m/K]. More...
 
template<class FieldType >
const Foam::basicThermo & lookupThermo (const FieldType &f)
 
template<class Thermo >
Foam::autoPtr< Thermo > New (const fvMesh &mesh, const word &phaseName)
 
- Public Member Functions inherited from viscosity
 TypeName ("viscosity")
 Runtime type information. More...
 
 viscosity ()
 Construct. More...
 
 viscosity (const viscosity &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~viscosity ()
 Destructor. More...
 
void operator= (const viscosity &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< fluidThermo > New (const fvMesh &, const word &phaseName=word::null)
 Standard selection based on fvMesh. More...
 
- Static Public Member Functions inherited from basicThermo
static word phasePropertyName (const word &name, const word &phaseName)
 Name of a property for a given phase. More...
 
template<class FieldType >
static const basicThermo & lookupThermo (const FieldType &f)
 Lookup the thermo associated with the given field. More...
 
static wordList splitThermoName (const word &thermoName, const int nCmpt)
 Split name of thermo package into a list of the components names. More...
 
static List< Pair< word > > thermoNameComponents (const word &thermoName)
 Split name of thermo package into a list of named components names. More...
 
template<class Thermo >
static autoPtr< Thermo > New (const fvMesh &, const word &phaseName=word::null)
 Generic New for each of the related thermodynamics packages. More...
 
static autoPtr< basicThermo > New (const fvMesh &, const word &phaseName=word::null)
 Specialisation of the Generic New for basicThermo. More...
 

Additional Inherited Members

- Protected Member Functions inherited from basicThermo
wordList heBoundaryTypes ()
 Enthalpy/internal energy field boundary types. More...
 
wordList heBoundaryBaseTypes ()
 Enthalpy/internal energy field boundary base types. More...
 
HashTable< word > heSourcesTypes ()
 Enthalpy/internal energy field sources types. More...
 
- Static Protected Member Functions inherited from basicThermo
static volScalarField & lookupOrConstruct (const fvMesh &mesh, const char *name)
 Lookup and the named field, or construct it as MUST-READ if it is. More...
 
template<class Thermo , class Table >
static Table::iterator lookupCstrIter (const dictionary &thermoTypeDict, Table *tablePtr, const int nCmpt, const char *cmptNames[], const word &thermoTypeName)
 Get the constructor iterator for the given thermo dictionary and. More...
 
template<class Thermo , class Table >
static Table::iterator lookupCstrIter (const dictionary &thermoDict, Table *tablePtr)
 Get the constructor iterator for the given thermo dictionary and. More...
 

Detailed Description

Base-class for fluid thermodynamic properties.

See also
Foam::basicThermo
Source files

Definition at line 52 of file fluidThermo.H.

Constructor & Destructor Documentation

◆ ~fluidThermo()

~fluidThermo ( )
virtual

Destructor.

Definition at line 92 of file fluidThermo.C.

Member Function Documentation

◆ TypeName()

TypeName ( "fluidThermo"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
fluidThermo  ,
fvMesh  ,
(const fvMesh &mesh, const word &phaseName)  ,
(mesh, phaseName)   
)

Declare run-time constructor selection table.

◆ New()

Foam::autoPtr< Foam::fluidThermo > New ( const fvMesh &  mesh,
const word &  phaseName = word::null 
)
static

Standard selection based on fvMesh.

Definition at line 80 of file fluidThermo.C.

References basicThermo::mesh(), and basicThermo::phaseName().

Here is the call graph for this function:

◆ p() [1/2]

virtual const volScalarField& p ( ) const
pure virtual

Pressure [Pa].

Implemented in fluidThermo::implementation.

Referenced by CloudFilmTransfer< CloudType >::absorbInteraction(), adsorptionMassFractionFvPatchScalarField::calcPhiYp(), semiPermeableBaffleMassFractionFvPatchScalarField::calcPhiYp(), chemistryModel< ThermoType >::calculate(), Fickian< BasicThermophysicalTransportModel >::divj(), Fickian< BasicThermophysicalTransportModel >::divq(), MaxwellStefan< BasicThermophysicalTransportModel >::divq(), CloudFilmTransfer< CloudType >::drySplashInteraction(), Fickian< BasicThermophysicalTransportModel >::j(), specieTransferTemperatureFvPatchScalarField::phiHep(), Fickian< BasicThermophysicalTransportModel >::q(), MaxwellStefan< BasicThermophysicalTransportModel >::q(), chemistryModel< ThermoType >::reactionRR(), psiThermo::implementation::rho(), psiuMulticomponentThermo::rhob(), psiuMulticomponentThermo::rhou(), chemistryModel< ThermoType >::solve(), chemistryModel< ThermoType >::specieReactionRR(), chemistryModel< ThermoType >::tc(), CloudFilmTransfer< CloudType >::wetSplashInteraction(), and saturated::wRatioByP().

Here is the caller graph for this function:

◆ p() [2/2]

virtual volScalarField& p ( )
pure virtual

Pressure [Pa].

Non-const access allowed for transport equations

Implemented in fluidThermo::implementation.

◆ psi()

virtual const volScalarField& psi ( ) const
pure virtual

Compressibility [s^2/m^2].

Implemented in fluidThermo::implementation.

Referenced by phaseSystem::correctPhi(), shockFluid::pressureCorrector(), and psiThermo::implementation::rho().

Here is the caller graph for this function:

◆ renameRho()

virtual tmp<volScalarField> renameRho ( )
pure virtual

Rename the thermodynamic density field if stored and return.

This is used by solvers which create a separate continuity rho [kg/m^3]

Implemented in rhoFluidThermo, and psiThermo.

◆ correctRho()

virtual void correctRho ( const volScalarField &  deltaRho)
pure virtual

Add the given density correction to the density field.

Used to update the density field following pressure solution

Implemented in rhoFluidThermo, and psiThermo.

◆ mu()

virtual const volScalarField& mu ( ) const
pure virtual

Dynamic viscosity of mixture [kg/m/s].

Implemented in fluidThermo::implementation.

Referenced by homogeneousLiquidPhaseSeparation::correct(), and fluidThermo::nu().

Here is the caller graph for this function:

◆ nu() [1/2]

Foam::tmp< Foam::volScalarField > nu ( ) const
virtual

Kinematic viscosity of mixture [m^2/s].

Implements viscosity.

Definition at line 102 of file fluidThermo.C.

References fluidThermo::mu(), and basicThermo::rho().

Here is the call graph for this function:

◆ nu() [2/2]

Foam::tmp< Foam::scalarField > nu ( const label  patchi) const
virtual

Kinematic viscosity of mixture for patch [m^2/s].

Implements viscosity.

Definition at line 109 of file fluidThermo.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), fluidThermo::mu(), patchi, and basicThermo::rho().

Here is the call graph for this function:
The documentation for this class was generated from the following files: