Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BirdCarreau Class Reference

An incompressible Bird-Carreau non-Newtonian viscosity model. More...

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

Public Member Functions

 TypeName ("BirdCarreau")
 Runtime type information. More...
 
 BirdCarreau (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Construct from components. More...
 
virtual ~BirdCarreau ()=default
 Destructor. More...
 
virtual tmp< volScalarField > nu () const
 Return the laminar viscosity. More...
 
virtual tmp< scalarField > nu (const label patchi) const
 Return the laminar viscosity for patch. More...
 
virtual void correct ()
 Correct the laminar viscosity. More...
 
virtual bool read (const dictionary &viscosityProperties)
 Read transportProperties dictionary. More...
 
- Public Member Functions inherited from viscosityModel
 TypeName ("viscosityModel")
 Runtime type information. More...
 
 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. More...
 
virtual ~viscosityModel ()=default
 Destructor. More...
 
const dictionary & viscosityProperties () const
 Return the phase transport properties dictionary. More...
 
tmp< volScalarField > strainRate () const
 Return the strain rate. More...
 

Protected Member Functions

tmp< volScalarField > calcNu () const
 Calculate and return the laminar viscosity. More...
 
- Protected Member Functions inherited from viscosityModel
 viscosityModel (const viscosityModel &)=delete
 No copy construct. More...
 
void operator= (const viscosityModel &)=delete
 No copy assignment. More...
 

Protected Attributes

volScalarField nu_
 
- Protected Attributes inherited from viscosityModel
word name_
 
dictionary viscosityProperties_
 
const volVectorField & U_
 
const surfaceScalarField & phi_
 

Additional Inherited Members

- Static Public Member Functions inherited from viscosityModel
static autoPtr< viscosityModel > New (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Return a reference to the selected viscosity model. More...
 

Detailed Description

An incompressible Bird-Carreau non-Newtonian viscosity model.

The Bird-Carreau-Yasuda form is also supported if the optional "a" coefficient is specified. "a" defaults to 2 for the Bird-Carreau model.

Source files

Definition at line 54 of file BirdCarreau.H.

Constructor & Destructor Documentation

◆ BirdCarreau()

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

Construct from components.

Definition at line 58 of file BirdCarreau.C.

◆ ~BirdCarreau()

virtual ~BirdCarreau ( )
virtualdefault

Destructor.

Member Function Documentation

◆ calcNu()

Foam::tmp< Foam::volScalarField > calcNu ( ) const
protected

Calculate and return the laminar viscosity.

Definition at line 46 of file BirdCarreau.C.

References Foam::pow(), and viscosityModel::strainRate().

Referenced by BirdCarreau::correct().

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

◆ TypeName()

TypeName ( "BirdCarreau"  )

Runtime type information.

◆ nu() [1/2]

virtual tmp<volScalarField> nu ( ) const
inlinevirtual

Return the laminar viscosity.

Implements viscosityModel.

Definition at line 116 of file BirdCarreau.H.

References BirdCarreau::nu_.

◆ nu() [2/2]

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

Return the laminar viscosity for patch.

Implements viscosityModel.

Definition at line 124 of file BirdCarreau.H.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), and BirdCarreau::nu_.

Here is the call graph for this function:

◆ correct()

virtual void correct ( )
inlinevirtual

Correct the laminar viscosity.

Implements viscosityModel.

Definition at line 132 of file BirdCarreau.H.

References BirdCarreau::calcNu(), and BirdCarreau::nu_.

Here is the call graph for this function:

◆ read()

bool read ( const dictionary &  viscosityProperties)
virtual

Read transportProperties dictionary.

Implements viscosityModel.

Definition at line 100 of file BirdCarreau.C.

References Foam::dimless, dictionary::optionalSubDict(), viscosityModel::read(), and dictionary::readEntry().

Here is the call graph for this function:

Member Data Documentation

◆ nu_

volScalarField nu_
protected

Definition at line 73 of file BirdCarreau.H.

Referenced by BirdCarreau::correct(), and BirdCarreau::nu().

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