filmSubModelBase Class Reference

Base class for surface film sub-models. More...

#include <filmSubModelBase.H>

Inheritance diagram for filmSubModelBase:

Collaboration diagram for filmSubModelBase:

Public Member Functions
	filmSubModelBase (surfaceFilmRegionModel &film)
	Construct null.
	filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from film film without name.
	filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from film film with name.
virtual	~filmSubModelBase ()
	Destructor.
virtual bool	writeTime () const
	Flag to indicate when to write a property.
const surfaceFilmRegionModel &	film () const
	Return const access to the film surface film model.
surfaceFilmRegionModel &	film ()
	Return the reference to the film surface film model.
template<class FilmType>
const FilmType &	filmType () const
Public Member Functions inherited from subModelBase
	subModelBase (dictionary &properties)
	Construct null.
	subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
	Construct from components without name.
	subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
	Construct from components with name.
	subModelBase (const subModelBase &smb)
	Construct as copy.
virtual	~subModelBase ()=default
	Destructor.
const word &	modelName () const
	Return const access to the name of the sub-model.
const dictionary &	dict () const
	Return const access to the cloud dictionary.
const word &	baseName () const
	Return const access to the base name of the sub-model.
const word &	modelType () const
	Return const access to the sub-model type.
const dictionary &	coeffDict () const
	Return const access to the coefficients dictionary.
const dictionary &	properties () const
	Return const access to the properties dictionary.
virtual bool	defaultCoeffs (const bool printMsg) const
	Returns true if defaultCoeffs is true and outputs on printMsg.
virtual bool	active () const
	Return the model 'active' status - default active = true.
virtual void	cacheFields (const bool store)
	Cache dependent sub-model fields.
virtual fileName	localPath () const
	Output directory.
template<class Type>
Type	getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the base model.
template<class Type>
void	getBaseProperty (const word &entryName, Type &value) const
	Retrieve generic property from the base model.
template<class Type>
void	setBaseProperty (const word &entryName, const Type &value)
	Add generic property to the base model.
bool	getModelDict (const word &entryName, dictionary &dict) const
	Retrieve dictionary, return true if set.
template<class Type>
bool	getModelProperty (const word &entryName, Type &value) const
	Retrieve generic property from the sub-model.
template<class Type>
Type	getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
	Retrieve generic property from the sub-model.
template<class Type>
void	setModelProperty (const word &entryName, const Type &value)
	Add generic property to the sub-model.
virtual void	write (Ostream &os) const
	Write.

Protected Attributes
surfaceFilmRegionModel &	filmModel_
	Reference to the film surface film model.
Protected Attributes inherited from subModelBase
const word	modelName_
	Name of the sub-model.
dictionary &	properties_
	Reference to properties dictionary e.g. for restart.
const dictionary	dict_
	Copy of dictionary used during construction.
const word	baseName_
	Name of the sub-model base class.
const word	modelType_
	Type of the sub-model.
const dictionary	coeffDict_
	Coefficients dictionary.

Additional Inherited Members
Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info.
Protected Member Functions inherited from subModelBase
bool	inLine () const
	Flag to indicate whether data is/was read in-line.

Detailed Description

Base class for surface film sub-models.

Source files

• filmSubModelBase.H
• filmSubModelBaseI.H
• filmSubModelBase.C

Source files

• filmSubModelBase.H
• filmSubModelBaseI.H
• filmSubModelBase.C

Definition at line 52 of file filmSubModelBase.H.

Constructor & Destructor Documentation

filmSubModelBase() [1/3]

filmSubModelBase

(

surfaceFilmRegionModel &

film

)

Construct null.

Definition at line 34 of file filmSubModelBase.C.

References film(), filmModel_, and subModelBase::subModelBase().

Referenced by filmRadiationModel::filmRadiationModel(), filmRadiationModel::filmRadiationModel(), filmThermoModel::filmThermoModel(), filmThermoModel::filmThermoModel(), filmTurbulenceModel::filmTurbulenceModel(), filmTurbulenceModel::filmTurbulenceModel(), filmViscosityModel::filmViscosityModel(), force::force(), force::force(), heatTransferModel::heatTransferModel(), heatTransferModel::heatTransferModel(), injectionModel::injectionModel(), injectionModel::injectionModel(), injectionModelList::injectionModelList(), injectionModelList::injectionModelList(), phaseChangeModel::phaseChangeModel(), phaseChangeModel::phaseChangeModel(), transferModel::transferModel(), transferModel::transferModel(), transferModelList::transferModelList(), and transferModelList::transferModelList().

Here is the call graph for this function:

Here is the caller graph for this function:

filmSubModelBase() [2/3]

filmSubModelBase	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict,
		const word &	baseName,
		const word &	modelType,
		const word &	dictExt = "Coeffs" )

Construct from film film without name.

Definition at line 41 of file filmSubModelBase.C.

References subModelBase::baseName(), subModelBase::dict(), film(), filmModel_, subModelBase::modelType(), and subModelBase::subModelBase().

Here is the call graph for this function:

filmSubModelBase() [3/3]

filmSubModelBase	(	const word &	modelName,
		surfaceFilmRegionModel &	film,
		const dictionary &	dict,
		const word &	baseName,
		const word &	modelType )

Construct from film film with name.

Definition at line 62 of file filmSubModelBase.C.

References subModelBase::baseName(), subModelBase::dict(), film(), filmModel_, subModelBase::modelName(), subModelBase::modelType(), and subModelBase::subModelBase().

Here is the call graph for this function:

~filmSubModelBase()

~filmSubModelBase ( )

virtual

Destructor.

Definition at line 85 of file filmSubModelBase.C.

Member Function Documentation

writeTime()

bool writeTime ( ) const

virtual

Flag to indicate when to write a property.

Reimplemented from subModelBase.

Definition at line 91 of file filmSubModelBase.C.

References subModelBase::active(), and filmModel_.

Referenced by injectionModel::correct(), patchInjection::correct(), phaseChangeModel::correct(), transferModel::correct(), injectionModelList::info(), and transferModelList::info().

Here is the call graph for this function:

Here is the caller graph for this function:

film() [1/2]

const surfaceFilmRegionModel & film ( ) const

inline

Return const access to the film surface film model.

Definition at line 32 of file filmSubModelBaseI.H.

References filmModel_.

Referenced by ArrheniusViscosity::ArrheniusViscosity(), BrunDrippingInjection::BrunDrippingInjection(), curvatureSeparation::calcCosAngle(), curvatureSeparation::calcInvR1(), constantFilmThermo::constantFilmThermo(), constantHeatTransfer::constantHeatTransfer(), constantRadiation::constantRadiation(), constantViscosity::constantViscosity(), contactAngleForce::contactAngleForce(), BrunDrippingInjection::correct(), curvatureSeparation::correct(), drippingInjection::correct(), injectionModelList::correct(), liquidViscosity::correct(), patchInjection::correct(), thixotropicViscosity::correct(), transferModel::correct(), transferModelList::correct(), transferModelList::correct(), solidification::correctModel(), standardPhaseChange::correctModel(), standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), waxSolventEvaporation::correctModel(), constantFilmThermo::Cp(), liquidFilmThermo::Cp(), curvatureSeparation::curvatureSeparation(), filmRadiationModel::declareRunTimeSelectionTable(), filmThermoModel::declareRunTimeSelectionTable(), filmTurbulenceModel::declareRunTimeSelectionTable(), filmViscosityModel::declareRunTimeSelectionTable(), force::declareRunTimeSelectionTable(), heatTransferModel::declareRunTimeSelectionTable(), injectionModel::declareRunTimeSelectionTable(), phaseChangeModel::declareRunTimeSelectionTable(), transferModel::declareRunTimeSelectionTable(), distributionContactAngleForce::distributionContactAngleForce(), drippingInjection::drippingInjection(), filmRadiationModel::filmRadiationModel(), filmRadiationModel::filmRadiationModel(), filmSubModelBase(), filmSubModelBase(), filmSubModelBase(), filmThermoModel::filmThermoModel(), filmThermoModel::filmThermoModel(), filmTurbulenceModel::filmTurbulenceModel(), filmTurbulenceModel::filmTurbulenceModel(), filmViscosityModel::filmViscosityModel(), force::force(), force::force(), function1Viscosity::function1Viscosity(), heatTransferModel::heatTransferModel(), heatTransferModel::heatTransferModel(), injectionModelList::info(), transferModelList::info(), injectionModel::injectionModel(), injectionModel::injectionModel(), injectionModelList::injectionModelList(), injectionModelList::injectionModelList(), constantFilmThermo::kappa(), liquidFilmThermo::kappa(), laminar::laminar(), liquidFilmThermo::liquidFilmThermo(), liquidViscosity::liquidViscosity(), mappedConvectiveHeatTransfer::mappedConvectiveHeatTransfer(), constantFilmThermo::mu(), liquidFilmThermo::mu(), noPhaseChange::noPhaseChange(), noRadiation::noRadiation(), patchInjection::patchInjection(), perturbedTemperatureDependentContactAngleForce::perturbedTemperatureDependentContactAngleForce(), phaseChangeModel::phaseChangeModel(), phaseChangeModel::phaseChangeModel(), primaryRadiation::primaryRadiation(), constantFilmThermo::rho(), liquidFilmThermo::rho(), constantRadiation::Shs(), noRadiation::Shs(), primaryRadiation::Shs(), standardRadiation::Shs(), constantFilmThermo::sigma(), liquidFilmThermo::sigma(), solidification::solidification(), standardPhaseChange::standardPhaseChange(), standardRadiation::standardRadiation(), laminar::Su(), temperatureDependentContactAngleForce::temperatureDependentContactAngleForce(), thermocapillaryForce::thermocapillaryForce(), thixotropicViscosity::thixotropicViscosity(), transferModel::transferModel(), transferModel::transferModel(), transferModelList::transferModelList(), transferModelList::transferModelList(), ArrheniusViscosity::TypeName(), BrunDrippingInjection::TypeName(), constantFilmThermo::TypeName(), constantHeatTransfer::TypeName(), constantRadiation::TypeName(), constantViscosity::TypeName(), contactAngleForce::TypeName(), curvatureSeparation::TypeName(), distributionContactAngleForce::TypeName(), drippingInjection::TypeName(), function1Viscosity::TypeName(), laminar::TypeName(), liquidFilmThermo::TypeName(), liquidViscosity::TypeName(), mappedConvectiveHeatTransfer::TypeName(), noPhaseChange::TypeName(), noRadiation::TypeName(), patchInjection::TypeName(), perturbedTemperatureDependentContactAngleForce::TypeName(), primaryRadiation::TypeName(), solidification::TypeName(), standardPhaseChange::TypeName(), standardRadiation::TypeName(), temperatureDependentContactAngleForce::TypeName(), thermocapillaryForce::TypeName(), thixotropicViscosity::TypeName(), waxSolventEvaporation::TypeName(), waxSolventViscosity::TypeName(), VoFPatchTransfer::VoFPatchTransfer(), waxSolventEvaporation::waxSolventEvaporation(), and waxSolventViscosity::waxSolventViscosity().

film() [2/2]

surfaceFilmRegionModel & film ( )

inline

Return the reference to the film surface film model.

Definition at line 38 of file filmSubModelBaseI.H.

References filmModel_.

filmType()

template<class FilmType>

const FilmType & filmType ( ) const

inline

Definition at line 31 of file filmSubModelBaseTemplates.C.

References Foam::abort(), Foam::FatalError, FatalErrorInFunction, filmModel_, Foam::isA(), subModelBase::modelType(), and Foam::refCast().

Referenced by liquidViscosity::correct(), thixotropicViscosity::correct(), solidification::correctModel(), standardPhaseChange::correctModel(), standardPhaseChange::correctModel(), waxSolventEvaporation::correctModel(), and waxSolventEvaporation::correctModel().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

filmModel_

surfaceFilmRegionModel& filmModel_

protected

Reference to the film surface film model.

Definition at line 63 of file filmSubModelBase.H.

Referenced by contactAngleForce::contactAngleForce(), contactAngleForce::correct(), thermocapillaryForce::correct(), solidification::correctModel(), film(), film(), filmSubModelBase(), filmSubModelBase(), filmSubModelBase(), filmType(), constantHeatTransfer::h(), phaseChangeModel::info(), liquidFilmThermo::initLiquid(), laminar::mut(), constantRadiation::Shs(), primaryRadiation::Shs(), standardRadiation::Shs(), laminar::Su(), liquidFilmThermo::thermoFilm(), distributionContactAngleForce::theta(), perturbedTemperatureDependentContactAngleForce::theta(), temperatureDependentContactAngleForce::theta(), laminar::Us(), and writeTime().

---

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

• src/regionModels/surfaceFilmModels/submodels/filmSubModelBase.H
• src/regionModels/surfaceFilmModels/submodels/filmSubModelBase.C
• src/regionModels/surfaceFilmModels/submodels/filmSubModelBaseI.H
• src/regionModels/surfaceFilmModels/submodels/filmSubModelBaseTemplates.C