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

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

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

Public Member Functions

 TypeName ("generalisedNewtonianViscosityModel")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, generalisedNewtonianViscosityModel, dictionary,(const dictionary &viscosityProperties),(viscosityProperties))
 
 generalisedNewtonianViscosityModel (const dictionary &viscosityProperties)
 Construct from components. More...
 
 generalisedNewtonianViscosityModel (const generalisedNewtonianViscosityModel &)
 Disallow default bitwise copy construction. More...
 
virtual ~generalisedNewtonianViscosityModel ()
 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...
 
void operator= (const generalisedNewtonianViscosityModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< generalisedNewtonianViscosityModel > New (const dictionary &viscosityProperties)
 Return a reference to the selected viscosity model. More...
 

Protected Attributes

dictionary viscosityProperties_
 

Detailed Description

An abstract base class for generalised Newtonian viscosity models.

Source files

Definition at line 60 of file generalisedNewtonianViscosityModel.H.

Constructor & Destructor Documentation

◆ generalisedNewtonianViscosityModel() [1/2]

generalisedNewtonianViscosityModel ( const dictionary &  viscosityProperties)

Construct from components.

Definition at line 44 of file generalisedNewtonianViscosityModel.C.

References generalisedNewtonianViscosityModel::read().

Here is the call graph for this function:

◆ generalisedNewtonianViscosityModel() [2/2]

generalisedNewtonianViscosityModel ( const generalisedNewtonianViscosityModel &  )

Disallow default bitwise copy construction.

◆ ~generalisedNewtonianViscosityModel()

virtual ~generalisedNewtonianViscosityModel ( )
inlinevirtual

Destructor.

Definition at line 114 of file generalisedNewtonianViscosityModel.H.

Member Function Documentation

◆ TypeName()

TypeName ( "generalisedNewtonianViscosityModel"  )

Runtime type information.

◆ declareRunTimeSelectionTable()

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

◆ New()

Foam::autoPtr< Foam::laminarModels::generalisedNewtonianViscosityModel > New ( const dictionary &  viscosityProperties)
static

Return a reference to the selected viscosity model.

Definition at line 32 of file generalisedNewtonianViscosityModelNew.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::Info, dictionary::lookup(), and Foam::nl.

Here is the call graph for this function:

◆ viscosityProperties()

const dictionary& viscosityProperties ( ) const
inline

Return the phase transport properties dictionary.

Definition at line 121 of file generalisedNewtonianViscosityModel.H.

References generalisedNewtonianViscosityModel::nu(), generalisedNewtonianViscosityModel::operator=(), generalisedNewtonianViscosityModel::read(), and generalisedNewtonianViscosityModel::viscosityProperties_.

Here is the call graph for this function:

◆ nu()

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

Return the laminar viscosity.

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

Referenced by generalisedNewtonianViscosityModel::viscosityProperties().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  viscosityProperties)
pure virtual

Read transportProperties dictionary.

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

Definition at line 55 of file generalisedNewtonianViscosityModel.C.

Referenced by generalisedNewtonianViscosityModel::generalisedNewtonianViscosityModel(), HerschelBulkley::read(), powerLaw::read(), strainRateFunction::read(), Casson::read(), CrossPowerLaw::read(), BirdCarreau::read(), and generalisedNewtonianViscosityModel::viscosityProperties().

Here is the caller graph for this function:

◆ operator=()

void operator= ( const generalisedNewtonianViscosityModel &  )
delete

Disallow default bitwise assignment.

Referenced by generalisedNewtonianViscosityModel::viscosityProperties().

Here is the caller graph for this function:

Member Data Documentation

◆ viscosityProperties_

dictionary viscosityProperties_
protected

Definition at line 66 of file generalisedNewtonianViscosityModel.H.

Referenced by generalisedNewtonianViscosityModel::viscosityProperties().

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