Public Member Functions | List of all members
NoPhaseChange< CloudType > Class Template Reference

Dummy phase change model for 'none'. More...

Inheritance diagram for NoPhaseChange< CloudType >:
Inheritance graph
[legend]
Collaboration diagram for NoPhaseChange< CloudType >:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("none")
 Runtime type information. More...
 
 NoPhaseChange (const dictionary &, CloudType &)
 Construct from dictionary. More...
 
 NoPhaseChange (const NoPhaseChange< CloudType > &pcm)
 Construct copy. More...
 
virtual autoPtr< PhaseChangeModel< CloudType > > clone () const
 Construct and return a clone. More...
 
virtual ~NoPhaseChange ()
 Destructor. More...
 
virtual bool active () const
 Flag to indicate whether model activates phase change model. More...
 
virtual void calculate (const scalar dt, const label celli, const scalar Re, const scalar Pr, const scalar d, const scalar nu, const scalar T, const scalar Ts, const scalar pc, const scalar Tc, const scalarField &X, scalarField &dMassPC) const
 Update model. More...
 
- Public Member Functions inherited from PhaseChangeModel< CloudType >
 TypeName ("phaseChangeModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, PhaseChangeModel, dictionary,(const dictionary &dict, CloudType &owner),(dict, owner))
 Declare runtime constructor selection table. More...
 
 PhaseChangeModel (CloudType &owner)
 Construct null from owner. More...
 
 PhaseChangeModel (const dictionary &dict, CloudType &owner, const word &type)
 Construct from dictionary. More...
 
 PhaseChangeModel (const PhaseChangeModel< CloudType > &pcm)
 Construct copy. More...
 
virtual ~PhaseChangeModel ()
 Destructor. More...
 
const enthalpyTransferTypeenthalpyTransfer () const
 Return the enthalpy transfer type enumeration. More...
 
virtual scalar dh (const label idc, const label idl, const scalar p, const scalar T) const
 Return the enthalpy per unit mass. More...
 
virtual scalar Tvap (const scalarField &X) const
 Return vapourisation temperature. More...
 
virtual scalar TMax (const scalar p, const scalarField &X) const
 Return maximum/limiting temperature. More...
 
void addToPhaseChangeMass (const scalar dMass)
 Add to phase change mass. More...
 
virtual void info (Ostream &os)
 Write injection info to stream. More...
 
- Public Member Functions inherited from CloudSubModelBase< CloudType >
 CloudSubModelBase (CloudType &owner)
 Construct null from owner cloud. More...
 
 CloudSubModelBase (CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from owner cloud without name. More...
 
 CloudSubModelBase (const word &modelName, CloudType &owner, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from owner cloud with name. More...
 
 CloudSubModelBase (const CloudSubModelBase< CloudType > &smb)
 Construct as copy. More...
 
virtual ~CloudSubModelBase ()
 Destructor. More...
 
const CloudTypeowner () const
 Return const access to the owner cloud. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
CloudTypeowner ()
 Return non-const access to the owner cloud for manipulation. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 Construct null. More...
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from components without name. More...
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from components with name. More...
 
 subModelBase (const subModelBase &smb)
 Construct as copy. More...
 
virtual ~subModelBase ()
 Destructor. More...
 
const wordmodelName () const
 Return const access to the name of the sub-model. More...
 
const dictionarydict () const
 Return const access to the cloud dictionary. More...
 
const wordbaseName () const
 Return const access to the base name of the sub-model. More...
 
const wordmodelType () const
 Return const access to the sub-model type. More...
 
const dictionarycoeffDict () const
 Return const access to the coefficients dictionary. More...
 
const dictionaryproperties () const
 Return const access to the properties dictionary. More...
 
virtual bool defaultCoeffs (const bool printMsg) const
 Returns true if defaultCoeffs is true and outputs on printMsg. More...
 
virtual void cacheFields (const bool store)
 Cache dependant sub-model fields. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 Retrieve generic property from the base model. More...
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 Add generic property to the base model. More...
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=pTraits< Type >::zero) const
 Retrieve generic property from the sub-model. More...
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 Add generic property to the sub-model. More...
 

Additional Inherited Members

- Public Types inherited from PhaseChangeModel< CloudType >
enum  enthalpyTransferType { etLatentHeat, etEnthalpyDifference }
 Enthalpy transfer type. More...
 
- Public Types inherited from CloudSubModelBase< CloudType >
typedef CloudType cloudType
 Type of cloud this model was instantiated for. More...
 
- Static Public Member Functions inherited from PhaseChangeModel< CloudType >
static autoPtr< PhaseChangeModel< CloudType > > New (const dictionary &dict, CloudType &owner)
 Selector. More...
 
- Static Public Attributes inherited from PhaseChangeModel< CloudType >
static const Foam::wordList enthalpyTransferTypeNames
 Name representations of enthalpy transfer types. More...
 
- Protected Member Functions inherited from PhaseChangeModel< CloudType >
enthalpyTransferType wordToEnthalpyTransfer (const word &etName) const
 Convert word to enthalpy transfer type. More...
 
scalar Sh () const
 Sherwood number. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 
- Protected Attributes inherited from PhaseChangeModel< CloudType >
enthalpyTransferType enthalpyTransfer_
 Enthalpy transfer type enumeration. More...
 
scalar dMass_
 Mass of lagrangian phase converted. More...
 
- Protected Attributes inherited from CloudSubModelBase< CloudType >
CloudTypeowner_
 Reference to the cloud. More...
 
- Protected Attributes inherited from subModelBase
const word modelName_
 Name of the sub-model. More...
 
dictionaryproperties_
 Reference to properties dictionary e.g. for restart. More...
 
const dictionary dict_
 Copy of dictionary used during construction. More...
 
const word baseName_
 Name of the sub-model base class. More...
 
const word modelType_
 Type of the sub-model. More...
 
const dictionary coeffDict_
 Coefficients dictionary. More...
 

Detailed Description

template<class CloudType>
class Foam::NoPhaseChange< CloudType >

Dummy phase change model for 'none'.

Definition at line 45 of file NoPhaseChange.H.

Constructor & Destructor Documentation

◆ NoPhaseChange() [1/2]

NoPhaseChange ( const dictionary ,
CloudType owner 
)

Construct from dictionary.

Definition at line 32 of file NoPhaseChange.C.

◆ NoPhaseChange() [2/2]

NoPhaseChange ( const NoPhaseChange< CloudType > &  pcm)

Construct copy.

Definition at line 43 of file NoPhaseChange.C.

◆ ~NoPhaseChange()

~NoPhaseChange ( )
virtual

Destructor.

Definition at line 54 of file NoPhaseChange.C.

Referenced by NoPhaseChange< CloudType >::clone().

Here is the caller graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "none"  )

Runtime type information.

◆ clone()

virtual autoPtr<PhaseChangeModel<CloudType> > clone ( ) const
inlinevirtual

Construct and return a clone.

Implements PhaseChangeModel< CloudType >.

Definition at line 64 of file NoPhaseChange.H.

References NoPhaseChange< CloudType >::active(), NoPhaseChange< CloudType >::calculate(), nu, Pr(), Foam::Re(), Foam::T(), and NoPhaseChange< CloudType >::~NoPhaseChange().

Here is the call graph for this function:

◆ active()

bool active ( ) const
virtual

Flag to indicate whether model activates phase change model.

Reimplemented from subModelBase.

Definition at line 61 of file NoPhaseChange.C.

References NoPhaseChange< CloudType >::calculate().

Referenced by NoPhaseChange< CloudType >::clone().

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

◆ calculate()

void calculate ( const scalar  dt,
const label  celli,
const scalar  Re,
const scalar  Pr,
const scalar  d,
const scalar  nu,
const scalar  T,
const scalar  Ts,
const scalar  pc,
const scalar  Tc,
const scalarField X,
scalarField dMassPC 
) const
virtual

Update model.

Implements PhaseChangeModel< CloudType >.

Definition at line 69 of file NoPhaseChange.C.

Referenced by NoPhaseChange< CloudType >::active(), and NoPhaseChange< CloudType >::clone().

Here is the caller graph for this function:

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