Stokes< BasicTurbulenceModel > Class Template Reference

Turbulence model for Stokes flow. More...

Inheritance diagram for Stokes< BasicTurbulenceModel >:
[legend]
Collaboration diagram for Stokes< BasicTurbulenceModel >:
[legend]

Public Types

typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 
- Public Types inherited from linearViscousStress< laminarModel< BasicTurbulenceModel > >
typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 
- Public Types inherited from laminarModel< BasicTurbulenceModel >
typedef BasicTurbulenceModel::alphaField alphaField
 
typedef BasicTurbulenceModel::rhoField rhoField
 
typedef BasicTurbulenceModel::transportModel transportModel
 

Public Member Functions

 TypeName ("Stokes")
 Runtime type information. More...
 
 Stokes (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
 Construct from components. More...
 
virtual ~Stokes ()=default
 Destructor. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. More...
 
virtual bool read ()
 Read turbulenceProperties dictionary. More...
 
virtual tmp< volScalarFieldnut () const
 Return the turbulence viscosity, i.e. 0 for Stokes flow. More...
 
virtual tmp< scalarFieldnut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity, i.e. the Stokes viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual void correct ()
 Correct the Stokes viscosity. More...
 
- Public Member Functions inherited from linearViscousStress< laminarModel< BasicTurbulenceModel > >
 linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
 Construct from components. More...
 
virtual ~linearViscousStress ()=default
 Destructor. More...
 
virtual bool read ()=0
 Re-read model coefficients if they have changed. More...
 
virtual tmp< volSymmTensorFielddevRhoReff () const
 Return the effective stress tensor. More...
 
virtual tmp< volSymmTensorFielddevRhoReff (const volVectorField &U) const
 Return the effective stress tensor based on a given velocity field. More...
 
virtual tmp< fvVectorMatrixdivDevRhoReff (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrixdivDevRhoReff (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual void correct ()=0
 Solve the turbulence equations and correct the turbulence viscosity. More...
 
- Public Member Functions inherited from laminarModel< BasicTurbulenceModel >
 TypeName ("laminar")
 Runtime type information. More...
 
 declareRunTimeSelectionTable (autoPtr, laminarModel, dictionary,(const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName),(alpha, rho, U, alphaRhoPhi, phi, transport, propertiesName))
 
 laminarModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName)
 Construct from components. More...
 
virtual ~laminarModel ()=default
 Destructor. More...
 
virtual bool read ()
 Read model coefficients if they have changed. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. More...
 
virtual tmp< volScalarFieldnut () const
 Return the turbulence viscosity, i.e. 0 for laminar flow. More...
 
virtual tmp< scalarFieldnut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarFieldnuEff () const
 Return the effective viscosity, i.e. the laminar viscosity. More...
 
virtual tmp< scalarFieldnuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual tmp< volScalarFieldk () const
 Return the turbulence kinetic energy, i.e. 0 for laminar flow. More...
 
virtual tmp< volScalarFieldepsilon () const
 Return the turbulence kinetic energy dissipation rate,. More...
 
virtual tmp< volScalarFieldomega () const
 Return the specific dissipation rate, i.e. 0 for laminar flow. More...
 
virtual tmp< volSymmTensorFieldR () const
 Return the Reynolds stress tensor, i.e. 0 for laminar flow. More...
 
virtual void correct ()
 Correct the laminar transport. More...
 

Static Public Member Functions

static autoPtr< StokesNew (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
 Return a reference to the selected turbulence model. More...
 
- Static Public Member Functions inherited from laminarModel< BasicTurbulenceModel >
static autoPtr< laminarModelNew (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport, const word &propertiesName=turbulenceModel::propertiesName)
 Return a reference to the selected laminar model. More...
 

Additional Inherited Members

- Protected Member Functions inherited from laminarModel< BasicTurbulenceModel >
virtual void printCoeffs (const word &type)
 Print model coefficients. More...
 
 laminarModel (const laminarModel &)=delete
 No copy construct. More...
 
void operator= (const laminarModel &)=delete
 No copy assignment. More...
 
- Protected Attributes inherited from laminarModel< BasicTurbulenceModel >
dictionary laminarDict_
 laminar coefficients dictionary More...
 
Switch printCoeffs_
 Flag to print the model coeffs at run-time. More...
 
dictionary coeffDict_
 Model coefficients dictionary. More...
 

Detailed Description

template<class BasicTurbulenceModel>
class Foam::laminarModels::Stokes< BasicTurbulenceModel >

Turbulence model for Stokes flow.

Source files

Definition at line 58 of file Stokes.H.

Member Typedef Documentation

◆ alphaField

typedef BasicTurbulenceModel::alphaField alphaField

Definition at line 65 of file Stokes.H.

◆ rhoField

typedef BasicTurbulenceModel::rhoField rhoField

Definition at line 66 of file Stokes.H.

◆ transportModel

typedef BasicTurbulenceModel::transportModel transportModel

Definition at line 67 of file Stokes.H.

Constructor & Destructor Documentation

◆ Stokes()

Stokes ( const alphaField alpha,
const rhoField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const transportModel transport,
const word propertiesName = turbulenceModel::propertiesName 
)

Construct from components.

Definition at line 46 of file Stokes.C.

◆ ~Stokes()

virtual ~Stokes ( )
virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "Stokes< BasicTurbulenceModel >"  )

Runtime type information.

◆ New()

static autoPtr< Stokes > New ( const alphaField alpha,
const rhoField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const transportModel transport,
const word propertiesName = turbulenceModel::propertiesName 
)
static

Return a reference to the selected turbulence model.

◆ coeffDict()

const dictionary & coeffDict
virtual

Const access to the coefficients dictionary.

Reimplemented from laminarModel< BasicTurbulenceModel >.

Definition at line 75 of file Stokes.C.

References dictionary::null.

◆ read()

bool read
virtual

Read turbulenceProperties dictionary.

Implements linearViscousStress< laminarModel< BasicTurbulenceModel > >.

Definition at line 82 of file Stokes.C.

◆ nut() [1/2]

tmp< volScalarField > nut
virtual

Return the turbulence viscosity, i.e. 0 for Stokes flow.

Reimplemented from laminarModel< BasicTurbulenceModel >.

Definition at line 90 of file Stokes.C.

References Foam::dimViscosity, IOobject::groupName(), Time::New(), IOobject::NO_READ, IOobject::NO_WRITE, and Foam::Zero.

Here is the call graph for this function:

◆ nut() [2/2]

tmp< scalarField > nut ( const label  patchi) const
virtual

Return the turbulence viscosity on patch.

Reimplemented from laminarModel< BasicTurbulenceModel >.

Definition at line 111 of file Stokes.C.

References Foam::Zero.

◆ nuEff() [1/2]

tmp< volScalarField > nuEff
virtual

Return the effective viscosity, i.e. the Stokes viscosity.

Reimplemented from laminarModel< BasicTurbulenceModel >.

Definition at line 125 of file Stokes.C.

References IOobject::groupName().

Here is the call graph for this function:

◆ nuEff() [2/2]

tmp< scalarField > nuEff ( const label  patchi) const
virtual

Return the effective viscosity on patch.

Reimplemented from laminarModel< BasicTurbulenceModel >.

Definition at line 139 of file Stokes.C.

References nu.

◆ correct()

void correct
virtual

Correct the Stokes viscosity.

Implements linearViscousStress< laminarModel< BasicTurbulenceModel > >.

Definition at line 149 of file Stokes.C.

References laminarModel< BasicTurbulenceModel >::correct().

Here is the call graph for this function:

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