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

An abstract base class for generalized Newtonian viscosity models. More...

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

Public Member Functions

 TypeName ("generalizedNewtonianViscosityModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, generalizedNewtonianViscosityModel, dictionary,(const dictionary &viscosityProperties),(viscosityProperties))
 
 generalizedNewtonianViscosityModel (const generalizedNewtonianViscosityModel &)=delete
 No copy construct. More...
 
void operator= (const generalizedNewtonianViscosityModel &)=delete
 No copy assignment. More...
 
 generalizedNewtonianViscosityModel (const dictionary &viscosityProperties)
 Construct from dictionary (components) More...
 
virtual ~generalizedNewtonianViscosityModel ()=default
 Destructor. More...
 
const dictionary & viscosityProperties () const
 Return the phase transport properties dictionary. More...
 
virtual tmp< volScalarField > nu (const volScalarField &nu0, const volScalarField &strainRate) const =0
 Return the laminar viscosity. More...
 
virtual bool read (const dictionary &viscosityProperties)=0
 Read transportProperties dictionary. More...
 

Static Public Member Functions

static autoPtr< generalizedNewtonianViscosityModel > New (const dictionary &dict)
 Select a viscosity model. More...
 

Protected Attributes

dictionary viscosityProperties_
 

Detailed Description

An abstract base class for generalized Newtonian viscosity models.

Source files

Definition at line 60 of file generalizedNewtonianViscosityModel.H.

Constructor & Destructor Documentation

◆ generalizedNewtonianViscosityModel() [1/2]

generalizedNewtonianViscosityModel ( const generalizedNewtonianViscosityModel &  )
delete

No copy construct.

◆ generalizedNewtonianViscosityModel() [2/2]

generalizedNewtonianViscosityModel ( const dictionary &  viscosityProperties)
explicit

Construct from dictionary (components)

Definition at line 39 of file generalizedNewtonianViscosityModel.C.

◆ ~generalizedNewtonianViscosityModel()

virtual ~generalizedNewtonianViscosityModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "generalizedNewtonianViscosityModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr  ,
generalizedNewtonianViscosityModel  ,
dictionary  ,
(const dictionary &viscosityProperties)  ,
(viscosityProperties)   
)

◆ operator=()

void operator= ( const generalizedNewtonianViscosityModel &  )
delete

No copy assignment.

◆ New()

Foam::autoPtr< Foam::laminarModels::generalizedNewtonianViscosityModel > New ( const dictionary &  dict)
static

Select a viscosity model.

Definition at line 28 of file generalizedNewtonianViscosityModelNew.C.

References dict, Foam::endl(), Foam::exit(), Foam::FatalIOError, FatalIOErrorInLookup, and Foam::Info.

Here is the call graph for this function:

◆ viscosityProperties()

const dictionary& viscosityProperties ( ) const
inline

Return the phase transport properties dictionary.

Definition at line 140 of file generalizedNewtonianViscosityModel.H.

References generalizedNewtonianViscosityModel::viscosityProperties_.

◆ nu()

virtual tmp<volScalarField> nu ( const volScalarField &  nu0,
const volScalarField &  strainRate 
) const
pure virtual

Return the laminar viscosity.

Implemented in CrossPowerLaw, Casson, strainRateFunction, BirdCarreau, powerLaw, and HerschelBulkley.

◆ read()

bool read ( const dictionary &  viscosityProperties)
pure virtual

Read transportProperties dictionary.

Implemented in CrossPowerLaw, Casson, strainRateFunction, BirdCarreau, powerLaw, and HerschelBulkley.

Definition at line 50 of file generalizedNewtonianViscosityModel.C.

Member Data Documentation

◆ viscosityProperties_

dictionary viscosityProperties_
protected

Definition at line 66 of file generalizedNewtonianViscosityModel.H.

Referenced by generalizedNewtonianViscosityModel::viscosityProperties().

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