Public Member Functions | Protected Attributes | List of all members
function1Viscosity Class Reference

The Foam::Function1 temperature-dependent viscosity model multiplies the viscosity of a base model by a Function1 temperature function. More...

Inheritance diagram for function1Viscosity:
Inheritance graph
[legend]
Collaboration diagram for function1Viscosity:
Collaboration graph
[legend]

Public Member Functions

 TypeName ("function1")
 
 function1Viscosity (surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
 
virtual ~function1Viscosity ()
 
virtual void correct (const volScalarField &p, const volScalarField &T)
 
- Public Member Functions inherited from filmViscosityModel
 TypeName ("filmViscosityModel")
 
 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)
 
virtual ~filmViscosityModel ()
 
virtual void info (Ostream &os) const
 
- Public Member Functions inherited from filmSubModelBase
 filmSubModelBase (surfaceFilmRegionModel &film)
 
 filmSubModelBase (surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 filmSubModelBase (const word &modelName, surfaceFilmRegionModel &film, const dictionary &dict, const word &baseName, const word &modelType)
 
virtual ~filmSubModelBase ()
 
virtual bool writeTime () const
 
const surfaceFilmRegionModelfilm () const
 
surfaceFilmRegionModelfilm ()
 
template<class FilmType >
const FilmType & filmType () const
 
- Public Member Functions inherited from subModelBase
 subModelBase (dictionary &properties)
 
 subModelBase (dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType, const word &dictExt="Coeffs")
 
 subModelBase (const word &modelName, dictionary &properties, const dictionary &dict, const word &baseName, const word &modelType)
 
 subModelBase (const subModelBase &smb)
 
virtual ~subModelBase ()
 
const wordmodelName () const
 
const dictionarydict () const
 
const wordbaseName () const
 
const wordmodelType () const
 
const dictionarycoeffDict () const
 
const dictionaryproperties () const
 
virtual bool defaultCoeffs (const bool printMsg) const
 
virtual bool active () const
 
virtual void cacheFields (const bool store)
 
virtual fileName localPath () const
 
template<class Type >
Type getBaseProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void getBaseProperty (const word &entryName, Type &value) const
 
template<class Type >
void setBaseProperty (const word &entryName, const Type &value)
 
bool getModelDict (const word &entryName, dictionary &dict) const
 
template<class Type >
void getModelProperty (const word &entryName, Type &value) const
 
template<class Type >
Type getModelProperty (const word &entryName, const Type &defaultValue=Type(Zero)) const
 
template<class Type >
void setModelProperty (const word &entryName, const Type &value)
 
virtual void write (Ostream &os) const
 

Protected Attributes

autoPtr< filmViscosityModelviscosity_
 
autoPtr< Function1< scalar > > function_
 
- Protected Attributes inherited from filmViscosityModel
volScalarFieldmu_
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModelfilmModel_
 
- Protected Attributes inherited from subModelBase
const word modelName_
 
dictionaryproperties_
 
const dictionary dict_
 
const word baseName_
 
const word modelType_
 
const dictionary coeffDict_
 

Additional Inherited Members

- Static Public Member Functions inherited from filmViscosityModel
static autoPtr< filmViscosityModelNew (surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
 
- Protected Member Functions inherited from subModelBase
bool inLine () const
 

Detailed Description

The Foam::Function1 temperature-dependent viscosity model multiplies the viscosity of a base model by a Function1 temperature function.

Source files

Definition at line 52 of file function1Viscosity.H.

Constructor & Destructor Documentation

◆ function1Viscosity()

function1Viscosity ( surfaceFilmRegionModel film,
const dictionary dict,
volScalarField mu 
)

Definition at line 48 of file function1Viscosity.C.

◆ ~function1Viscosity()

~function1Viscosity ( )
virtual

Definition at line 65 of file function1Viscosity.C.

Member Function Documentation

◆ TypeName()

TypeName ( "function1"  )

◆ correct()

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

Implements filmViscosityModel.

Definition at line 72 of file function1Viscosity.C.

References p, and Foam::T().

Here is the call graph for this function:

Member Data Documentation

◆ viscosity_

autoPtr<filmViscosityModel> viscosity_
protected

Definition at line 70 of file function1Viscosity.H.

◆ function_

autoPtr<Function1<scalar> > function_
protected

Definition at line 73 of file function1Viscosity.H.


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