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

Run-time selected strain-rate function non-Newtonian viscosity model. More...

Inheritance diagram for strainRateFunction:
[legend]
Collaboration diagram for strainRateFunction:
[legend]

Public Member Functions

 TypeName ("strainRateFunction")
 Runtime type information. More...
 
 strainRateFunction (const word &name, const dictionary &viscosityProperties, const volVectorField &U, const surfaceScalarField &phi)
 Construct from components. More...
 
virtual ~strainRateFunction ()=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...
 
virtual tmp< volScalarField > nu () const =0
 Return the laminar viscosity. More...
 
virtual tmp< scalarField > nu (const label patchi) const =0
 Return the laminar viscosity for patch. More...
 
virtual void correct ()=0
 Correct the laminar viscosity. More...
 
virtual bool read (const dictionary &viscosityProperties)=0
 Read transportProperties dictionary. 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...
 
- Protected Member Functions inherited from viscosityModel
 viscosityModel (const viscosityModel &)=delete
 No copy construct. More...
 
void operator= (const viscosityModel &)=delete
 No copy assignment. More...
 

Detailed Description

Run-time selected strain-rate function non-Newtonian viscosity model.

Example linear function of strain-rate: 

    transportModel  strainRateFunction;

    strainRateFunctionCoeffs
    {
        function polynomial ((0 0.1) (1 1.3));
    }
See also
Foam::viscosityModel Foam::Function1
Source files

Definition at line 69 of file strainRateFunction.H.

Constructor & Destructor Documentation

◆ strainRateFunction()

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

Construct from components.

Definition at line 53 of file strainRateFunction.C.

References strainRateFunction::correct(), Foam::dimViscosity, Foam::name(), and Foam::New().

Here is the call graph for this function:

◆ ~strainRateFunction()

virtual ~strainRateFunction ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "strainRateFunction"  )

Runtime type information.

◆ nu() [1/2]

Foam::tmp< Foam::volScalarField > nu ( ) const
virtual

Return the laminar viscosity.

Implements viscosityModel.

Definition at line 96 of file strainRateFunction.C.

◆ nu() [2/2]

Foam::tmp< Foam::scalarField > nu ( const label  patchi) const
virtual

Return the laminar viscosity for patch.

Implements viscosityModel.

Definition at line 103 of file strainRateFunction.C.

◆ correct()

void correct ( )
virtual

Correct the laminar viscosity.

Implements viscosityModel.

Definition at line 109 of file strainRateFunction.C.

References forAll.

Referenced by strainRateFunction::strainRateFunction().

Here is the caller graph for this function:

◆ read()

bool read ( const dictionary &  viscosityProperties)
virtual

Read transportProperties dictionary.

Implements viscosityModel.

Definition at line 126 of file strainRateFunction.C.

References dictionary::clear(), Time::New(), dictionary::optionalSubDict(), and kEpsilonLopesdaCosta< BasicTurbulenceModel >::read().

Here is the call graph for this function:

Member Data Documentation

◆ nu_

volScalarField nu_
protected

Definition at line 86 of file strainRateFunction.H.

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