solidification Class Reference

Solidification phase change model where all film mass is converted when the local temperature > activation temperature. The latent heat is assumed to be removed by heat-transfer to the wall. More...

Inheritance diagram for solidification:
[legend]
Collaboration diagram for solidification:
[legend]

Public Member Functions

 TypeName ("solidification")
 Runtime type information. More...
 
 solidification (surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from surface film model. More...
 
virtual ~solidification ()
 Destructor. More...
 
virtual void correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy)
 Correct. More...
 
- Public Member Functions inherited from phaseChangeModel
 TypeName ("phaseChangeModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, phaseChangeModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict),(film, dict))
 
 phaseChangeModel (surfaceFilmRegionModel &film)
 Construct null. More...
 
 phaseChangeModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict)
 Construct from type name, dictionary and surface film model. More...
 
virtual ~phaseChangeModel ()
 Destructor. More...
 
virtual void correct (const scalar dt, scalarField &availableMass, volScalarField &dMass, volScalarField &dEnergy)
 Correct. More...
 
virtual void correctModel (const scalar dt, scalarField &availableMass, scalarField &dMass, scalarField &dEnergy)=0
 Correct. More...
 
virtual void info (Ostream &os) const
 Provide some feedback. More...
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmRegionModel &film)
 Construct null. More...
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 Construct from film film without name. More...
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 Construct from film film with name. More...
 
virtual ~filmSubModelBase ()
 Destructor. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
const surfaceFilmRegionModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModelfilm ()
 Return the reference to the film surface film model. More...
 
template<class FilmType >
const FilmType & filmType () const
 
- 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 bool active () const
 Return the model 'active' status - default active = true. More...
 
virtual void cacheFields (const bool store)
 Cache dependent sub-model fields. More...
 
virtual bool writeTime () const
 Flag to indicate when to write a property. More...
 
virtual fileName localPath () const
 Output directory. More...
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=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...
 
bool getModelDict (const word &entryName, dictionary &dict) const
 Retrieve dictionary, return true if set. More...
 
template<class Type >
bool 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=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...
 
virtual void write (Ostream &os) const
 Write. More...
 

Protected Attributes

scalar T0_
 Temperature at which solidification starts. More...
 
scalar maxSolidificationFrac_
 Solidification limiter. More...
 
dimensionedScalar maxSolidificationRate_
 Solidification limiter. More...
 
volScalarField mass_
 Accumulated solid mass [kg]. More...
 
volScalarField thickness_
 Accumulated solid thickness [m]. More...
 
- Protected Attributes inherited from phaseChangeModel
scalar latestMassPC_
 Latest mass transfer due to phase change. More...
 
scalar totalMassPC_
 Total mass transfer due to phase change. More...
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModelfilmModel_
 Reference to the film surface film model. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from phaseChangeModel
static autoPtr< phaseChangeModelNew (surfaceFilmRegionModel &film, const dictionary &dict)
 Return a reference to the selected phase change model. More...
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 Flag to indicate whether data is/was read in-line. More...
 

Detailed Description

Solidification phase change model where all film mass is converted when the local temperature > activation temperature. The latent heat is assumed to be removed by heat-transfer to the wall.

Source files

Definition at line 56 of file solidification.H.

Constructor & Destructor Documentation

◆ solidification()

solidification ( surfaceFilmRegionModel film,
const dictionary dict 
)

Construct from surface film model.

Definition at line 55 of file solidification.C.

◆ ~solidification()

~solidification ( )
virtual

Destructor.

Definition at line 107 of file solidification.C.

Member Function Documentation

◆ TypeName()

TypeName ( "solidification"  )

Runtime type information.

◆ correctModel()

void correctModel ( const scalar  dt,
scalarField availableMass,
scalarField dMass,
scalarField dEnergy 
)
virtual

Member Data Documentation

◆ T0_

scalar T0_
protected

Temperature at which solidification starts.

Definition at line 74 of file solidification.H.

Referenced by solidification::correctModel().

◆ maxSolidificationFrac_

scalar maxSolidificationFrac_
protected

Solidification limiter.

Maximum fraction of film which can solidify in a time-step

Definition at line 78 of file solidification.H.

Referenced by solidification::correctModel().

◆ maxSolidificationRate_

dimensionedScalar maxSolidificationRate_
protected

Solidification limiter.

Maximum rate at which the film can solidify

Definition at line 82 of file solidification.H.

Referenced by solidification::correctModel().

◆ mass_

volScalarField mass_
protected

Accumulated solid mass [kg].

Definition at line 85 of file solidification.H.

Referenced by solidification::correctModel().

◆ thickness_

volScalarField thickness_
protected

Accumulated solid thickness [m].

Definition at line 88 of file solidification.H.

Referenced by solidification::correctModel().


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