Inheritance diagram for standardPhaseChange:

Collaboration diagram for standardPhaseChange:

Public Member Functions
	TypeName ("standardPhaseChange")
	Runtime type information. More...

	standardPhaseChange (surfaceFilmModel &owner, const dictionary &dict)
	Construct from surface film model. More...

virtual	~standardPhaseChange ()
	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,(surfaceFilmModel &owner, const dictionary &dict),(owner, dict))

	phaseChangeModel (surfaceFilmModel &owner)
	Construct null. More...

	phaseChangeModel (const word &modelType, surfaceFilmModel &owner, 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	info (Ostream &os) const
	Provide some feedback. More...

Public Member Functions inherited from filmSubModelBase
	filmSubModelBase (surfaceFilmModel &owner)
	Construct null. More...

	filmSubModelBase (surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from owner film wihout name. More...

	filmSubModelBase (const word &modelName, surfaceFilmModel &owner, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from owner film with name. More...

virtual	~filmSubModelBase ()
	Destructor. More...

virtual bool	writeTime () const
	Flag to indicate when to write a property. More...

const surfaceFilmModel &	owner () const
	Return const access to the owner surface film model. More...

surfaceFilmModel &	owner ()
	Return the reference to the owner 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 word &	modelName () const
	Return const access to the name of the sub-model. More...

const dictionary &	dict () const
	Return const access to the cloud dictionary. More...

const word &	baseName () const
	Return const access to the base name of the sub-model. More...

const word &	modelType () const
	Return const access to the sub-model type. More...

const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary. More...

const dictionary &	properties () 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 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...

virtual void	write (Ostream &os) const
	Write. More...

Protected Member Functions
scalar	Sh (const scalar Re, const scalar Sc) const
	Return Sherwood number as a function of Reynolds and Schmidt numbers. More...

Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line. More...

Protected Attributes
const scalar	deltaMin_
	Minimum film height for model to be active. More...

const scalar	L_
	Length scale / [m]. More...

const scalar	TbFactor_
	Boiling temperature factor / []. 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
surfaceFilmModel &	owner_
	Reference to the owner surface film model. More...

Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model. More...

dictionary &	properties_
	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< phaseChangeModel >	New (surfaceFilmModel &owner, const dictionary &dict)
	Return a reference to the selected phase change model. More...

Detailed Description

Definition at line 52 of file standardPhaseChange.H.

Constructor & Destructor Documentation

standardPhaseChange	(	surfaceFilmModel &	owner,
		const dictionary &	dict
	)

Construct from surface film model.

Definition at line 72 of file standardPhaseChange.C.

~standardPhaseChange ( )

virtual

Destructor.

Definition at line 86 of file standardPhaseChange.C.

References standardPhaseChange::correctModel().

Here is the call graph for this function:

Member Function Documentation

scalar Sh	(	const scalar	Re,
		const scalar	Sc
	)		const

protected

Return Sherwood number as a function of Reynolds and Schmidt numbers.

Definition at line 53 of file standardPhaseChange.C.

References Foam::cbrt(), Foam::pow(), and Foam::sqrt().

Referenced by standardPhaseChange::correctModel().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "standardPhaseChange" )

Runtime type information.

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

virtual

Correct.

Implements phaseChangeModel.

Definition at line 93 of file standardPhaseChange.C.

References filmThermoModel::Cp(), filmThermoModel::D(), delta, kinematicSingleLayer::delta(), standardPhaseChange::deltaMin_, kinematicSingleLayer::filmThermo(), forAll, filmThermoModel::hl(), standardPhaseChange::L_, Foam::mag(), singleLayerRegion::magSf(), Foam::max(), Foam::min(), kinematicSingleLayer::muPrimary(), filmThermoModel::name(), kinematicSingleLayer::pPrimary(), filmThermoModel::pv(), rho, kinematicSingleLayer::rho(), kinematicSingleLayer::rhoPrimary(), standardPhaseChange::Sh(), Foam::T(), thermoSingleLayer::T(), filmThermoModel::Tb(), standardPhaseChange::TbFactor_, thermoSingleLayer::thermo(), kinematicSingleLayer::UPrimary(), kinematicSingleLayer::Us(), filmThermoModel::W(), and thermoSingleLayer::YPrimary().

Referenced by standardPhaseChange::~standardPhaseChange().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

const scalar deltaMin_

protected

Minimum film height for model to be active.

Definition at line 72 of file standardPhaseChange.H.

Referenced by standardPhaseChange::correctModel().

const scalar L_

protected

Length scale / [m].

Definition at line 75 of file standardPhaseChange.H.

Referenced by standardPhaseChange::correctModel().

const scalar TbFactor_

protected

Boiling temperature factor / [].

Used to set max limit on temperature to Tb*TbFactor

Definition at line 79 of file standardPhaseChange.H.

Referenced by standardPhaseChange::correctModel().

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

src/regionModels/surfaceFilmModels/submodels/thermo/phaseChangeModel/standardPhaseChange/standardPhaseChange.H
src/regionModels/surfaceFilmModels/submodels/thermo/phaseChangeModel/standardPhaseChange/standardPhaseChange.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation