singleComponentPhaseChange Class Reference

Base class for phase change models in which only a single component changes phase. Can be applied to any combination of pure and multicomponent phases. If either phase is multicomponent, then a single specie must be identified as the one that changes phase. More...

Inheritance diagram for singleComponentPhaseChange:
Collaboration diagram for singleComponentPhaseChange:

Public Member Functions

 TypeName ("singleComponentPhaseChange")
 Runtime type information. More...
 
 singleComponentPhaseChange (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const Pair< bool > &fluidThermosRequired, const Pair< bool > &specieThermosRequired)
 Construct from explicit source name and mesh. More...
 
const wordspecie () const
 Return the name of the changing specie. More...
 
const Pair< label > & specieis () const
 Return the indices of the changing species in the phases. More...
 
void addSup (const volScalarField &alpha, const volScalarField &rho, const volScalarField &heOrYi, fvMatrix< scalar > &eqn) const
 Override the energy equation to add the phase change heat, or. More...
 
virtual bool read (const dictionary &dict)
 Read source dictionary. More...
 
- Public Member Functions inherited from phaseChange
 TypeName ("phaseChange")
 Runtime type information. More...
 
 phaseChange (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict, const Pair< bool > &fluidThermosRequired, const Pair< bool > &specieThermosRequired)
 Construct from explicit source name and mesh. More...
 
const ThermoRefPair< basicThermo > & thermos () const
 Return the thermo references. More...
 
const ThermoRefPair< fluidThermo > & fluidThermos () const
 Return the fluid thermo references. More...
 
const ThermoRefPair< multicomponentThermo > & specieThermos () const
 Return the specie thermo references. More...
 
const Pair< word > & heNames () const
 Return the names of the energy fields. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > Tchange () const
 Return the temperature at which the phases are considered to be. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > Lfraction () const
 Return the fraction of the latent heat that is transferred into. More...
 
- Public Member Functions inherited from massTransfer
 TypeName ("massTransfer")
 Runtime type information. More...
 
 massTransfer (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from explicit source name and mesh. More...
 
virtual bool addsSupToField (const word &fieldName) const
 Return true if the fvModel adds a source term to the given. More...
 
const Pair< word > & phaseNames () const
 Return the names of the phases. More...
 
const Pair< word > & alphaNames () const
 Return the names of the volume fraction fields. More...
 
const Pair< word > & rhoNames () const
 Return the names of the density fields. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > mDot () const =0
 Return the mass transfer rate. More...
 
virtual tmp< DimensionedField< scalar, volMesh > > S (const word &fieldName) const
 Return the source value. More...
 
virtual void addSup (fvMatrix< scalar > &eqn) const
 Add a source term to a field-less proxy equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_FIELD_SUP)
 Add a source term to an equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_RHO_FIELD_SUP)
 Add a source term to a compressible equation. More...
 
 FOR_ALL_FIELD_TYPES (DEFINE_FV_MODEL_ADD_ALPHA_RHO_FIELD_SUP)
 Add a source term to a phase equation. More...
 
template<class Type >
const Foam::VolField< Type > & otherField (const VolField< Type > &field) const
 
- Public Member Functions inherited from fvSpecificSource
 TypeName ("fvSpecificSource")
 Runtime type information. More...
 
 fvSpecificSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from explicit source name and mesh. More...
 
virtual ~fvSpecificSource ()
 Destructor. More...
 
virtual labelUList cells () const
 Return the cells that the source applies to. More...
 
virtual label nCells () const
 Return the number of cells that the source applies to. More...
 
virtual tmp< scalarFieldsource (const word &fieldName) const
 Return the source value. More...
 
virtual bool movePoints ()
 Update for mesh motion. More...
 
virtual void topoChange (const polyTopoChangeMap &)
 Update topology using the given map. More...
 
virtual void mapMesh (const polyMeshMap &)
 Update from another mesh using the given map. More...
 
virtual void distribute (const polyDistributionMap &)
 Redistribute or update using the given distribution map. More...
 
- Public Member Functions inherited from fvSource
 TypeName ("fvSource")
 Runtime type information. More...
 
 fvSource (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from explicit source name and mesh. More...
 
 fvSource (const fvSource &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~fvSource ()
 Destructor. More...
 
virtual wordList addSupFields () const
 Return the list of fields for which the fvModel adds source term. More...
 
void operator= (const fvSource &)=delete
 Disallow default bitwise assignment. More...
 
- Public Member Functions inherited from fvModel
 TypeName ("fvModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, fvModel, dictionary,(const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict),(name, modelType, mesh, dict))
 
 fvModel (const word &name, const word &modelType, const fvMesh &mesh, const dictionary &dict)
 Construct from components. More...
 
autoPtr< fvModelclone () const
 Return clone. More...
 
virtual ~fvModel ()
 Destructor. More...
 
const wordname () const
 Return const access to the source name. More...
 
const fvMeshmesh () const
 Return const access to the mesh database. More...
 
const dictionarycoeffs () const
 Return dictionary. More...
 
virtual scalar maxDeltaT () const
 Return the maximum time-step for stable operation. More...
 
template<class Type >
tmp< fvMatrix< Type > > sourceProxy (const VolField< Type > &eqnField) const
 Add a source term to an equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const VolField< Type > &field) const
 Return source for an equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
 Return source for an equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const volScalarField &rho, const VolField< Type > &field) const
 Return source for a compressible equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
 Return source for a compressible equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
 Return source for a phase equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
 Return source for a phase equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
 Return source for a phase equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
 Return source for a phase equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
 Return source for a phase equation. More...
 
template<class Type >
tmp< fvMatrix< Type > > d2dt2 (const VolField< Type > &field) const
 Return source for an equation with a second time derivative. More...
 
virtual void preUpdateMesh ()
 Prepare for mesh update. More...
 
virtual void correct ()
 Correct the fvModel. More...
 
virtual bool write (const bool write=true) const
 Write fvModel data. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
Foam::dimensionSet sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
const Foam::wordfieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 
template<class AlphaRhoFieldType >
const Foam::wordfieldName (const AlphaRhoFieldType &alphaRhoField)
 
template<class Type , class ... AlphaRhoFieldTypes>
Foam::tmp< Foam::fvMatrix< Type > > sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > sourceProxy (const VolField< Type > &eqnField) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const VolField< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > sourceProxy (const VolField< Type > &field, const VolField< Type > &eqnField) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const volScalarField &rho, const VolField< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > sourceProxy (const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > sourceProxy (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, const VolField< Type > &eqnField) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const geometricOneField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const volScalarField &alpha, const geometricOneField &rho, const VolField< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > source (const geometricOneField &alpha, const volScalarField &rho, const VolField< Type > &field) const
 
template<class Type >
Foam::tmp< Foam::fvMatrix< Type > > d2dt2 (const VolField< Type > &field) const
 

Additional Inherited Members

- Static Public Member Functions inherited from fvModel
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static dimensionSet sourceDims (const dimensionSet &ds, const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the dimensions of the matrix of a source term. More...
 
static const dimensionSetsourceDims (const dimensionSet &ds)
 Return the dimensions of the matrix of a source term (base. More...
 
template<class AlphaRhoFieldType , class ... AlphaRhoFieldTypes>
static const wordfieldName (const AlphaRhoFieldType &alphaRhoField, const AlphaRhoFieldTypes &... alphaRhoFields)
 Return the name of the field associated with a source term. More...
 
template<class AlphaRhoFieldType >
static const wordfieldName (const AlphaRhoFieldType &alphaRhoField)
 Return the name of the field associated with a source term (base. More...
 
static const wordfieldName ()
 Return the name of the field associated with a source term. Special. More...
 
static autoPtr< fvModelNew (const word &name, const fvMesh &mesh, const dictionary &dict)
 Return a reference to the selected fvModel. More...
 
- Protected Member Functions inherited from phaseChange
const volScalarFieldp () const
 Access the pressure field. More...
 
- Protected Member Functions inherited from massTransfer
const Pair< wordlookupPhaseNames () const
 Lookup the phase names. More...
 
const Pair< wordlookupPhaseFieldNames (const word &name) const
 Lookup the phase field names. More...
 
tmp< volScalarField::Internalrho (const label i) const
 Return the density. More...
 
template<class Type >
const VolField< Type > & otherField (const VolField< Type > &field) const
 Return the corresponding field in the other phase, or a null. More...
 
template<class Type >
void addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to an equation. More...
 
void addSupType (const volScalarField &alphaOrField, fvMatrix< scalar > &eqn) const
 Add a source term to a scalar equation. More...
 
template<class Type >
void addSupType (const volScalarField &alphaOrRho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to a compressible equation. More...
 
void addSupType (const volScalarField &alphaOrRho, const volScalarField &rhoOrField, fvMatrix< scalar > &eqn) const
 Add a source term to a compressible scalar equation. More...
 
template<class Type >
void addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to a phase equation. More...
 
- Protected Member Functions inherited from fvSpecificSource
template<class Type >
void addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to an equation. More...
 
template<class Type >
void addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to a compressible equation. More...
 
template<class Type >
void addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to a phase equation. More...
 
- Protected Member Functions inherited from fvModel
template<class Type >
void addSupType (const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to an equation. More...
 
template<class Type >
void addSupType (const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to a compressible equation. More...
 
template<class Type >
void addSupType (const volScalarField &alpha, const volScalarField &rho, const VolField< Type > &field, fvMatrix< Type > &eqn) const
 Add a source term to a phase equation. More...
 
template<class Type , class ... AlphaRhoFieldTypes>
tmp< fvMatrix< Type > > sourceTerm (const VolField< Type > &eqnField, const dimensionSet &ds, const AlphaRhoFieldTypes &... alphaRhoFields) const
 Return a source for an equation. More...
 
- Static Protected Member Functions inherited from phaseChange
static tmp< volScalarFieldvifToVf (const tmp< DimensionedField< scalar, volMesh >> &tvif)
 Add a boundary field to the given internal field. More...
 
static tmp< DimensionedField< scalar, volMesh > > vfToVif (const tmp< volScalarField > &tvf)
 Remove the boundary field from the given geometric field. More...
 
- Static Protected Member Functions inherited from massTransfer
static label index (const Pair< word > &names, const word &name)
 Get the index of the name in the given pair, or -1. More...
 
static label sign (const Pair< word > &names, const word &name)
 Get the sign associated with the name in the given pair; i.e., -1. More...
 

Detailed Description

Base class for phase change models in which only a single component changes phase. Can be applied to any combination of pure and multicomponent phases. If either phase is multicomponent, then a single specie must be identified as the one that changes phase.

Source files

Definition at line 53 of file singleComponentPhaseChange.H.

Constructor & Destructor Documentation

◆ singleComponentPhaseChange()

singleComponentPhaseChange ( const word name,
const word modelType,
const fvMesh mesh,
const dictionary dict,
const Pair< bool > &  fluidThermosRequired,
const Pair< bool > &  specieThermosRequired 
)

Construct from explicit source name and mesh.

Definition at line 64 of file singleComponentPhaseChange.C.

Member Function Documentation

◆ TypeName()

TypeName ( "singleComponentPhaseChange"  )

Runtime type information.

◆ specie()

const Foam::word & specie ( ) const
inline

Return the name of the changing specie.

Definition at line 31 of file singleComponentPhaseChangeI.H.

◆ specieis()

const Foam::Pair< Foam::label > & specieis ( ) const
inline

Return the indices of the changing species in the phases.

Definition at line 38 of file singleComponentPhaseChangeI.H.

◆ addSup()

void addSup ( const volScalarField alpha,
const volScalarField rho,
const volScalarField heOrYi,
fvMatrix< scalar > &  eqn 
) const

Override the energy equation to add the phase change heat, or.

the species equations to add the relevant mass sources

Definition at line 106 of file singleComponentPhaseChange.C.

References massTransfer::addSup(), alpha(), Pair< Type >::first(), ha(), hs(), IOobject::member(), IOobject::name(), p, rho, s(), Pair< Type >::second(), Foam::sign(), and Foam::fvm::SuSp().

Referenced by homogeneousCondensation::addSup(), homogeneousLiquidPhaseSeparation::addSup(), and coefficientPhaseChange::addSup().

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

◆ read()

bool read ( const dictionary dict)
virtual

Read source dictionary.

Reimplemented from massTransfer.

Reimplemented in coefficientPhaseChange, homogeneousLiquidPhaseSeparation, and homogeneousCondensation.

Definition at line 178 of file singleComponentPhaseChange.C.

References dict, and massTransfer::read().

Referenced by homogeneousCondensation::read(), homogeneousLiquidPhaseSeparation::read(), and coefficientPhaseChange::read().

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

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