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:
Collaboration diagram for function1Viscosity:

Public Member Functions

 TypeName ("function1")
 Runtime type information. More...
 
 function1Viscosity (surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
 Construct from surface film model. More...
 
virtual ~function1Viscosity ()
 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...
 
 filmViscosityModel (const filmViscosityModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~filmViscosityModel ()
 Destructor. More...
 
virtual void info (Ostream &os) const
 Provide some feedback. More...
 
void operator= (const filmViscosityModel &)=delete
 Disallow default bitwise assignment. 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 surfaceFilmRegionModelfilm () const
 Return const access to the film surface film model. More...
 
surfaceFilmRegionModelfilm ()
 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)
 Copy constructor. 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 dependent 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...
 
void operator= (const subModelBase &)=delete
 Disallow default bitwise assignment. More...
 

Protected Attributes

autoPtr< filmViscosityModelviscosity_
 Base viscosity model. More...
 
autoPtr< Function1< scalar > > function_
 Viscosity factor as a function of temperature. More...
 
- Protected Attributes inherited from filmViscosityModel
volScalarFieldmu_
 Reference to the viscosity field. More...
 
- Protected Attributes inherited from filmSubModelBase
surfaceFilmRegionModelfilmModel_
 Reference to the film 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 (surfaceFilmRegionModel &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

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

Source files

Definition at line 54 of file function1Viscosity.H.

Constructor & Destructor Documentation

◆ function1Viscosity()

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

Construct from surface film model.

Definition at line 53 of file function1Viscosity.C.

◆ ~function1Viscosity()

~function1Viscosity ( )
virtual

Destructor.

Definition at line 70 of file function1Viscosity.C.

References function1Viscosity::correct().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "function1"  )

Runtime type information.

◆ correct()

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

Member Data Documentation

◆ viscosity_

autoPtr<filmViscosityModel> viscosity_
protected

Base viscosity model.

Definition at line 72 of file function1Viscosity.H.

Referenced by function1Viscosity::correct().

◆ function_

autoPtr<Function1<scalar> > function_
protected

Viscosity factor as a function of temperature.

Definition at line 75 of file function1Viscosity.H.

Referenced by function1Viscosity::correct().


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