Public Member Functions | Static Public Member Functions | Protected Attributes | List of all members
viscosityModel Class Referenceabstract

Base class for surface film viscosity models. More...

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

Public Member Functions

 TypeName ("viscosity")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, viscosityModel, dictionary,(surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu),(film, dict, mu))
 
 viscosityModel (const word &modelType, surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
 Construct from type name, dictionary and surface film model. More...
 
 viscosityModel (const viscosityModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~viscosityModel ()
 Destructor. More...
 
virtual void correct (const volScalarField &p, const volScalarField &T)=0
 Correct. More...
 
virtual void info (Ostream &os) const
 Provide some feedback. More...
 
void operator= (const viscosityModel &)=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 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)
 Copy constructor. 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 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...
 

Static Public Member Functions

static autoPtr< viscosityModel > New (surfaceFilmRegionModel &film, const dictionary &dict, volScalarField &mu)
 Return a reference to the selected phase change model. More...
 

Protected Attributes

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

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

Detailed Description

Base class for surface film viscosity models.

Source files

Definition at line 55 of file filmViscosityModel.H.

Constructor & Destructor Documentation

◆ viscosityModel() [1/2]

viscosityModel ( const word &  modelType,
surfaceFilmRegionModel &  film,
const dictionary &  dict,
volScalarField &  mu 
)

Construct from type name, dictionary and surface film model.

Definition at line 45 of file filmViscosityModel.C.

◆ viscosityModel() [2/2]

viscosityModel ( const viscosityModel &  )
delete

Disallow default bitwise copy construction.

◆ ~viscosityModel()

~viscosityModel ( )
virtual

Destructor.

Definition at line 59 of file filmViscosityModel.C.

Member Function Documentation

◆ TypeName()

TypeName ( "viscosity"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

autoPtr< viscosityModel > New ( surfaceFilmRegionModel &  film,
const dictionary &  dict,
volScalarField &  mu 
)
static

Return a reference to the selected phase change model.

Definition at line 40 of file filmViscosityModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, dictionary::found(), Foam::Info, dictionary::lookupEntryBackwardsCompatible(), Foam::constant::physicoChemical::mu, Foam::nl, and dictionary::subDict().

Here is the call graph for this function:

◆ correct()

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

Correct.

Implemented in thixotropicViscosity, ArrheniusViscosity, waxSolventViscosity, function1Viscosity, constantViscosity, and NewtonianViscosity.

◆ info()

void info ( Ostream &  os) const
virtual

Provide some feedback.

Definition at line 65 of file filmViscosityModel.C.

◆ operator=()

void operator= ( const viscosityModel &  )
delete

Disallow default bitwise assignment.

Member Data Documentation

◆ mu_

volScalarField& mu_
protected

Reference to the viscosity field.

Definition at line 64 of file filmViscosityModel.H.

Referenced by NewtonianViscosity::correct(), constantViscosity::correct(), function1Viscosity::correct(), ArrheniusViscosity::correct(), and thixotropicViscosity::correct().

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