Loading...
Searching...
No Matches
viscosityModel Class Referenceabstract

An abstract base class for incompressible viscosityModels. More...

#include <viscosityModel.H>

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

Public Member Functions

 TypeName ("viscosityModel")
 Runtime type information.
 declareRunTimeSelectionTable (autoPtr, viscosityModel, dictionary,(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi),(name, viscosityProperties, U, phi))
 viscosityModel (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Construct from components.
virtual ~viscosityModel ()=default
 Destructor.
const dictionary & viscosityProperties () const
 Return the phase transport properties dictionary.
tmp< volScalarField > strainRate () const
 Return the strain rate.
virtual tmp< volScalarField > nu () const =0
 Return the laminar viscosity.
virtual tmp< scalarField > nu (const label patchi) const =0
 Return the laminar viscosity for patch.
virtual void correct ()=0
 Correct the laminar viscosity.
virtual bool read (const dictionary &viscosityProperties)=0
 Read transportProperties dictionary.

Static Public Member Functions

static autoPtr< viscosityModel > New (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Return a reference to the selected viscosity model.

Protected Member Functions

 viscosityModel (const viscosityModel &)=delete
 No copy construct.
void operator= (const viscosityModel &)=delete
 No copy assignment.

Protected Attributes

word name_
dictionary viscosityProperties_
const volVectorField & U_
const surfaceScalarField & phi_

Detailed Description

An abstract base class for incompressible viscosityModels.

Source files

The strain rate is defined by:

mag(symm(grad(U)))

Source files

Definition at line 64 of file viscosityModel.H.

Constructor & Destructor Documentation

◆ viscosityModel() [1/2]

viscosityModel ( const viscosityModel & )
protecteddelete

No copy construct.

References viscosityModel().

Referenced by BirdCarreau::BirdCarreau(), Casson::Casson(), CrossPowerLaw::CrossPowerLaw(), declareRunTimeSelectionTable(), HerschelBulkley::HerschelBulkley(), Newtonian::Newtonian(), operator=(), powerLaw::powerLaw(), strainRateFunction::strainRateFunction(), and viscosityModel().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ viscosityModel() [2/2]

viscosityModel ( const word & name,
const dictionary & viscosityProperties,
const volVectorField & U,
const surfaceScalarField & phi )

Construct from components.

Definition at line 36 of file viscosityModel.C.

References Foam::name(), name_, phi, phi_, U, U_, viscosityProperties(), and viscosityProperties_.

Here is the call graph for this function:

◆ ~viscosityModel()

virtual ~viscosityModel ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator=()

void operator= ( const viscosityModel & )
protecteddelete

No copy assignment.

References viscosityModel().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "viscosityModel" )

Runtime type information.

◆ declareRunTimeSelectionTable()

declareRunTimeSelectionTable ( autoPtr ,
viscosityModel ,
dictionary ,
(const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi) ,
(name, viscosityProperties, U, phi)  )

References Foam::name(), phi, U, viscosityModel(), and viscosityProperties().

Here is the call graph for this function:

◆ New()

Foam::autoPtr< Foam::viscosityModel > New ( const word & name,
const dictionary & viscosityProperties,
const volVectorField & U,
const surfaceScalarField & phi )
static

Return a reference to the selected viscosity model.

Definition at line 28 of file viscosityModelNew.C.

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

Referenced by strainRateFunction::strainRateFunction().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ viscosityProperties()

const dictionary & viscosityProperties ( ) const
inline

Return the phase transport properties dictionary.

Definition at line 155 of file viscosityModel.H.

References viscosityProperties_.

Referenced by Arrhenius< BirdCarreau >::Arrhenius(), BirdCarreau::BirdCarreau(), Casson::Casson(), correct(), CrossPowerLaw::CrossPowerLaw(), declareRunTimeSelectionTable(), HerschelBulkley::HerschelBulkley(), Newtonian::Newtonian(), powerLaw::powerLaw(), read(), Arrhenius< BirdCarreau >::read(), BirdCarreau::read(), Casson::read(), CrossPowerLaw::read(), HerschelBulkley::read(), Newtonian::read(), powerLaw::read(), strainRateFunction::read(), strainRateFunction::strainRateFunction(), BirdCarreau::TypeName(), Casson::TypeName(), CrossPowerLaw::TypeName(), HerschelBulkley::TypeName(), Newtonian::TypeName(), powerLaw::TypeName(), strainRateFunction::TypeName(), viscosityModel(), and strainRateFunction::~strainRateFunction().

Here is the caller graph for this function:

◆ strainRate()

Foam::tmp< Foam::volScalarField > strainRate ( ) const

Return the strain rate.

Definition at line 53 of file viscosityModel.C.

References Foam::fvc::grad(), Foam::mag(), Foam::sqrt(), Foam::symm(), and U_.

Referenced by BirdCarreau::calcNu(), Casson::calcNu(), CrossPowerLaw::calcNu(), HerschelBulkley::calcNu(), powerLaw::calcNu(), and strainRateFunction::correct().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ nu() [1/2]

virtual tmp< volScalarField > nu ( ) const
pure virtual

Return the laminar viscosity.

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

◆ nu() [2/2]

virtual tmp< scalarField > nu ( const label patchi) const
pure virtual

Return the laminar viscosity for patch.

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

◆ correct()

virtual void correct ( )
pure virtual

Correct the laminar viscosity.

Implemented in Arrhenius< BirdCarreau >, Arrhenius< Casson >, Arrhenius< CrossPowerLaw >, Arrhenius< HerschelBulkley >, Arrhenius< Newtonian >, BirdCarreau, Casson, CrossPowerLaw, HerschelBulkley, Newtonian, powerLaw, and strainRateFunction.

References viscosityProperties().

Here is the call graph for this function:

◆ read()

bool read ( const dictionary & viscosityProperties)
pure virtual

Read transportProperties dictionary.

Implemented in Arrhenius< BirdCarreau >, Arrhenius< Casson >, Arrhenius< CrossPowerLaw >, Arrhenius< HerschelBulkley >, Arrhenius< Newtonian >, BirdCarreau, Casson, CrossPowerLaw, HerschelBulkley, Newtonian, powerLaw, and strainRateFunction.

Definition at line 59 of file viscosityModel.C.

References viscosityProperties(), and viscosityProperties_.

Referenced by Arrhenius< ViscousModel >::read(), BirdCarreau::read(), Casson::read(), CrossPowerLaw::read(), HerschelBulkley::read(), Newtonian::read(), powerLaw::read(), and strainRateFunction::read().

Here is the call graph for this function:
Here is the caller graph for this function:

Member Data Documentation

◆ name_

word name_
protected

Definition at line 71 of file viscosityModel.H.

Referenced by viscosityModel().

◆ viscosityProperties_

dictionary viscosityProperties_
protected

Definition at line 72 of file viscosityModel.H.

Referenced by Newtonian::Newtonian(), read(), Newtonian::read(), viscosityModel(), and viscosityProperties().

◆ U_

const volVectorField& U_
protected

Definition at line 74 of file viscosityModel.H.

Referenced by BirdCarreau::BirdCarreau(), Casson::Casson(), CrossPowerLaw::CrossPowerLaw(), HerschelBulkley::HerschelBulkley(), Newtonian::Newtonian(), powerLaw::powerLaw(), strainRateFunction::read(), strainRate(), strainRateFunction::strainRateFunction(), and viscosityModel().

◆ phi_

const surfaceScalarField& phi_
protected

Definition at line 75 of file viscosityModel.H.

Referenced by viscosityModel().

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