Inheritance diagram for ArrheniusViscosity:

Collaboration diagram for ArrheniusViscosity:

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

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

virtual	~ArrheniusViscosity ()
	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,(surfaceFilmModel &film, const dictionary &dict, volScalarField &mu),(film, dict, mu))

	filmViscosityModel (const word &modelType, surfaceFilmModel &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 (surfaceFilmModel &film)
	Construct null. More...

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

	filmSubModelBase (const word &modelName, surfaceFilmModel &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 surfaceFilmModel &	film () const
	Return const access to the film surface film model. More...

surfaceFilmModel &	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 ()
	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 Attributes
autoPtr< filmViscosityModel >	viscosity_
	Base viscosity model. More...

dimensionedScalar	k1_
	Coefficient k1. More...

dimensionedScalar	k2_
	Coefficient k2. More...

dimensionedScalar	Tref_
	Reference temperature. More...

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

Protected Attributes inherited from filmSubModelBase
surfaceFilmModel &	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 (surfaceFilmModel &film, const dictionary &dict, volScalarField &mu)
	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

Definition at line 61 of file ArrheniusViscosity.H.

Constructor & Destructor Documentation

◆ ArrheniusViscosity()

ArrheniusViscosity	(	surfaceFilmModel &	film,
		const dictionary &	dict,
		volScalarField &	mu
	)

Construct from surface film model.

Definition at line 53 of file ArrheniusViscosity.C.

◆ ~ArrheniusViscosity()

~ArrheniusViscosity ( )

virtual

Destructor.

Definition at line 69 of file ArrheniusViscosity.C.

References ArrheniusViscosity::correct().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "Arrhenius" )

Runtime type information.

◆ correct()

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

virtual

Correct.

Implements filmViscosityModel.

Definition at line 76 of file ArrheniusViscosity.C.

References GeometricField< Type, PatchField, GeoMesh >::correctBoundaryConditions(), Foam::exp(), ArrheniusViscosity::k1_, ArrheniusViscosity::k2_, filmViscosityModel::mu_, ArrheniusViscosity::Tref_, and ArrheniusViscosity::viscosity_.

Referenced by ArrheniusViscosity::~ArrheniusViscosity().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ viscosity_

autoPtr<filmViscosityModel> viscosity_

protected

Base viscosity model.

Definition at line 79 of file ArrheniusViscosity.H.

Referenced by ArrheniusViscosity::correct().

◆ k1_

dimensionedScalar k1_

protected

Coefficient k1.

Definition at line 82 of file ArrheniusViscosity.H.

Referenced by ArrheniusViscosity::correct().

◆ k2_

dimensionedScalar k2_

protected

Coefficient k2.

Definition at line 85 of file ArrheniusViscosity.H.

Referenced by ArrheniusViscosity::correct().

◆ Tref_

dimensionedScalar Tref_

protected

Reference temperature.

Definition at line 88 of file ArrheniusViscosity.H.

Referenced by ArrheniusViscosity::correct().

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

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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ArrheniusViscosity()

◆ ~ArrheniusViscosity()

Member Function Documentation

◆ TypeName()

◆ correct()

Member Data Documentation

◆ viscosity_

◆ k1_

◆ k2_

◆ Tref_