Constant viscosity model. More...

Inheritance diagram for constantViscosity:

Collaboration diagram for constantViscosity:

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

	constantViscosity (surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
	Construct from surface film model. More...

virtual	~constantViscosity ()
	Destructor. More...

virtual void	correct (const volScalarField &p, const volScalarField &T)
	Correct. More...

Public Member Functions inherited from filmViscosityModel
	TypeName ("filmViscosityModel")
	Runtime type information. More...

	declareRunTimeSelectionTable (autoPtr, filmViscosityModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu),(film, dict, mu))

	filmViscosityModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
	Construct from type name, dictionary and surface film model. More...

virtual	~filmViscosityModel ()
	Destructor. 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 surfaceFilmRegionModel &	film () const
	Return const access to the film surface film model. More...

surfaceFilmRegionModel &	film ()
	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 ()=default
	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 dependent sub-model fields. 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
dimensionedScalar	mu0_
	Constant viscosity [Pa.s]. More...

Protected Attributes inherited from filmViscosityModel
volScalarField &	mu_
	Reference to the viscosity field. More...

Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModel &	filmModel_
	Reference to the film 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 filmViscosityModel
static autoPtr< filmViscosityModel >	New (surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
	Return a reference to the selected phase change model. More...

Public Attributes inherited from subModelBase
bool	log
	Flag to write log into Info. More...

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

Detailed Description

Constant viscosity model.

Source files

Definition at line 50 of file constantViscosity.H.

Constructor & Destructor Documentation

◆ constantViscosity()

constantViscosity	(	surfaceFilmRegionModel &	film,
		const dictionary &	dict,
		volScalarField &	mu
	)

Construct from surface film model.

Definition at line 47 of file constantViscosity.C.

◆ ~constantViscosity()

~constantViscosity ( )

virtual

Destructor.

Definition at line 62 of file constantViscosity.C.

Member Function Documentation

◆ TypeName()

TypeName ( "constant" )

Runtime type information.

◆ correct()

void correct	(	const volScalarField &	p,
		const volScalarField &	T
	)

virtual

Correct.

Implements filmViscosityModel.

Definition at line 69 of file constantViscosity.C.

Member Data Documentation

◆ mu0_

dimensionedScalar mu0_

protected

Constant viscosity [Pa.s].

Definition at line 74 of file constantViscosity.H.

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

src/regionModels/surfaceFilmModels/submodels/thermo/filmViscosityModel/constantViscosity/constantViscosity.H
src/regionModels/surfaceFilmModels/submodels/thermo/filmViscosityModel/constantViscosity/constantViscosity.C

Public Member Functions

Protected Attributes

Additional Inherited Members