Public Member Functions | Protected Attributes | List of all members
ArrheniusViscosity Class Reference
Inheritance diagram for ArrheniusViscosity:
Inheritance graph
[legend]
Collaboration diagram for ArrheniusViscosity:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("Arrhenius")
 Runtime type information. More...
 
 ArrheniusViscosity (surfaceFilmModel &owner, 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 &owner, const dictionary &dict, volScalarField &mu ),(owner, dict, mu))
 
 filmViscosityModel (const word &modelType, surfaceFilmModel &owner, 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 &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 outputTime () const
 Flag to indicate when to write a property. More...
 
const surfaceFilmModelowner () const
 Return const access to the owner surface film model. More...
 
surfaceFilmModelowner ()
 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 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 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< filmViscosityModelviscosity_
 Base viscosity model. More...
 
dimensionedScalar k1_
 Coefficient k1. More...
 
dimensionedScalar k2_
 Coefficient k2. More...
 
dimensionedScalar Tref_
 Reference temperature. More...
 
- Protected Attributes inherited from filmViscosityModel
volScalarFieldmu_
 Reference to the viscosity field. More...
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmModelowner_
 Reference to the owner 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 filmViscosityModel
static autoPtr< filmViscosityModelNew (surfaceFilmModel &owner, 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 ( surfaceFilmModel owner,
const dictionary dict,
volScalarField mu 
)

Construct from surface film model.

Definition at line 53 of file ArrheniusViscosity.C.

~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 ( "Arrhenius"  )

Runtime type information.

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

Member Data Documentation

autoPtr<filmViscosityModel> viscosity_
protected

Base viscosity model.

Definition at line 79 of file ArrheniusViscosity.H.

Referenced by ArrheniusViscosity::correct().

dimensionedScalar k1_
protected

Coefficient k1.

Definition at line 82 of file ArrheniusViscosity.H.

Referenced by ArrheniusViscosity::correct().

dimensionedScalar k2_
protected

Coefficient k2.

Definition at line 85 of file ArrheniusViscosity.H.

Referenced by ArrheniusViscosity::correct().

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: