Public Types | Public Member Functions | Static Public Member Functions | List of all members
Stokes< BasicMomentumTransportModel > Class Template Reference

Turbulence model for Stokes flow. More...

Inheritance diagram for Stokes< BasicMomentumTransportModel >:
Inheritance graph
[legend]
Collaboration diagram for Stokes< BasicMomentumTransportModel >:
Collaboration graph
[legend]

Public Types

typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 
typedef BasicMomentumTransportModel::transportModel transportModel
 
- Public Types inherited from linearViscousStress< laminarModel< BasicMomentumTransportModel > >
typedef laminarModel< BasicMomentumTransportModel > ::alphaField alphaField
 
typedef laminarModel< BasicMomentumTransportModel > ::rhoField rhoField
 
typedef laminarModel< BasicMomentumTransportModel > ::transportModel transportModel
 
- Public Types inherited from laminarModel< BasicMomentumTransportModel >
typedef BasicMomentumTransportModel::alphaField alphaField
 
typedef BasicMomentumTransportModel::rhoField rhoField
 
typedef BasicMomentumTransportModel::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)
 Construct from components. More...
 
virtual ~Stokes ()
 Destructor. More...
 
virtual const dictionary & coeffDict () const
 Const access to the coefficients dictionary. More...
 
virtual bool read ()
 Read momentumTransport dictionary. More...
 
virtual tmp< volScalarField > nut () const
 Return the turbulence viscosity, i.e. 0 for Stokes flow. More...
 
virtual tmp< scalarField > nut (const label patchi) const
 Return the turbulence viscosity on patch. More...
 
virtual tmp< volScalarField > nuEff () const
 Return the effective viscosity, i.e. the Stokes viscosity. More...
 
virtual tmp< scalarField > nuEff (const label patchi) const
 Return the effective viscosity on patch. More...
 
virtual tmp< volScalarField > k () const
 Return the turbulence kinetic energy, i.e. 0 for Stokes flow. More...
 
virtual tmp< volScalarField > epsilon () const
 Return the turbulence kinetic energy dissipation rate,. More...
 
virtual tmp< volSymmTensorField > sigma () const
 Return the stress tensor [m^2/s^2], i.e. 0 for Stokes flow. More...
 
virtual void correct ()
 Correct the Stokes viscosity. More...
 
- Public Member Functions inherited from linearViscousStress< laminarModel< BasicMomentumTransportModel > >
 linearViscousStress (const word &modelName, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Construct from components. More...
 
virtual ~linearViscousStress ()
 Destructor. More...
 
virtual tmp< volSymmTensorField > devTau () const
 Return the effective stress tensor. More...
 
virtual tmp< fvVectorMatrix > divDevTau (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrix > divDevTau (const volScalarField &rho, volVectorField &U) const
 Return the source term for the momentum equation. More...
 
- Public Member Functions inherited from laminarModel< BasicMomentumTransportModel >
 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),(alpha, rho, U, alphaRhoPhi, phi, transport))
 
 laminarModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Construct from components. More...
 
 laminarModel (const laminarModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~laminarModel ()
 Destructor. More...
 
void operator= (const laminarModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< Stokes > New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Return a reference to the selected turbulence model. More...
 
- Static Public Member Functions inherited from laminarModel< BasicMomentumTransportModel >
static autoPtr< laminarModel > New (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const transportModel &transport)
 Return a reference to the selected laminar model. More...
 

Additional Inherited Members

- Protected Member Functions inherited from laminarModel< BasicMomentumTransportModel >
virtual void printCoeffs (const word &type)
 Print model coefficients. More...
 
- Protected Attributes inherited from laminarModel< BasicMomentumTransportModel >
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 BasicMomentumTransportModel>
class Foam::laminarModels::Stokes< BasicMomentumTransportModel >

Turbulence model for Stokes flow.

Source files

Definition at line 52 of file Stokes.H.

Member Typedef Documentation

◆ alphaField

typedef BasicMomentumTransportModel::alphaField alphaField

Definition at line 59 of file Stokes.H.

◆ rhoField

typedef BasicMomentumTransportModel::rhoField rhoField

Definition at line 60 of file Stokes.H.

◆ transportModel

typedef BasicMomentumTransportModel::transportModel transportModel

Definition at line 61 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 
)

Construct from components.

Definition at line 44 of file Stokes.C.

◆ ~Stokes()

virtual ~Stokes ( )
inlinevirtual

Destructor.

Definition at line 97 of file Stokes.H.

References Stokes< BasicMomentumTransportModel >::coeffDict(), Stokes< BasicMomentumTransportModel >::correct(), Stokes< BasicMomentumTransportModel >::epsilon(), Stokes< BasicMomentumTransportModel >::k(), Stokes< BasicMomentumTransportModel >::nuEff(), Stokes< BasicMomentumTransportModel >::nut(), patchi, Stokes< BasicMomentumTransportModel >::read(), and Stokes< BasicMomentumTransportModel >::sigma().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "Stokes< BasicMomentumTransportModel >"  )

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 
)
static

Return a reference to the selected turbulence model.

◆ coeffDict()

const dictionary & coeffDict ( ) const
virtual

Const access to the coefficients dictionary.

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 70 of file Stokes.C.

References dictionary::null.

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

Here is the caller graph for this function:

◆ read()

bool read ( )
virtual

Read momentumTransport dictionary.

Implements linearViscousStress< laminarModel< BasicMomentumTransportModel > >.

Definition at line 77 of file Stokes.C.

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

Here is the caller graph for this function:

◆ nut() [1/2]

tmp< volScalarField > nut ( ) const
virtual

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

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 85 of file Stokes.C.

References Foam::dimViscosity, IOobject::groupName(), and GeometricField< scalar, fvPatchField, volMesh >::New().

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

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

◆ nut() [2/2]

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

Return the turbulence viscosity on patch.

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 99 of file Stokes.C.

References patchi.

◆ nuEff() [1/2]

tmp< volScalarField > nuEff ( ) const
virtual

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

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 112 of file Stokes.C.

References IOobject::groupName(), and GeometricField< scalar, fvPatchField, volMesh >::New().

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

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

◆ nuEff() [2/2]

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

Return the effective viscosity on patch.

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 125 of file Stokes.C.

◆ k()

tmp< volScalarField > k ( ) const
virtual

Return the turbulence kinetic energy, i.e. 0 for Stokes flow.

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 135 of file Stokes.C.

References IOobject::groupName(), GeometricField< scalar, fvPatchField, volMesh >::New(), and Foam::sqr().

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

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

◆ epsilon()

tmp< volScalarField > epsilon ( ) const
virtual

Return the turbulence kinetic energy dissipation rate,.

i.e. 0 for Stokes flow

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 148 of file Stokes.C.

References Foam::dimTime, IOobject::groupName(), GeometricField< scalar, fvPatchField, volMesh >::New(), and Foam::sqr().

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

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

◆ sigma()

tmp< volSymmTensorField > sigma ( ) const
virtual

Return the stress tensor [m^2/s^2], i.e. 0 for Stokes flow.

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 161 of file Stokes.C.

References IOobject::groupName(), GeometricField< symmTensor, fvPatchField, volMesh >::New(), Foam::sqr(), and Foam::Zero.

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

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

◆ correct()

void correct ( )
virtual

Correct the Stokes viscosity.

Implements linearViscousStress< laminarModel< BasicMomentumTransportModel > >.

Definition at line 173 of file Stokes.C.

References laminarModel< BasicMomentumTransportModel >::correct().

Referenced by Stokes< BasicMomentumTransportModel >::~Stokes().

Here is the call graph for this function:
Here is the caller graph for this function:
The documentation for this class was generated from the following files: