Stokes< BasicMomentumTransportModel > Class Template Reference

Momentum transport model for Stokes flow. More...

Inheritance diagram for Stokes< BasicMomentumTransportModel >:
Collaboration diagram for Stokes< BasicMomentumTransportModel >:

Public Types

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

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 viscosity &viscosity)
 Construct from components. More...
 
virtual ~Stokes ()
 Destructor. More...
 
virtual const dictionarycoeffDict () const
 Const access to the coefficients dictionary. More...
 
virtual bool read ()
 Read momentumTransport dictionary. 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 predict ()
 Predict the Stokes viscosity. More...
 
virtual void correct ()
 The Stokes viscosity is not corrected. 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 viscosity &viscosity)
 Construct from components. More...
 
virtual ~linearViscousStress ()
 Destructor. More...
 
virtual tmp< volSymmTensorFielddevTau () const
 Return the effective stress tensor. More...
 
virtual tmp< fvVectorMatrixdivDevTau (volVectorField &U) const
 Return the source term for the momentum equation. More...
 
virtual tmp< fvVectorMatrixdivDevTau (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 viscosity &viscosity),(alpha, rho, U, alphaRhoPhi, phi, viscosity))
 
 laminarModel (const word &type, const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 Construct from components. More...
 
 laminarModel (const laminarModel &)=delete
 Disallow default bitwise copy construction. More...
 
virtual ~laminarModel ()
 Destructor. 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< 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 turbulence specific dissipation rate,. More...
 
virtual tmp< volSymmTensorFieldsigma () const
 Return the stress tensor [m^2/s^2], i.e. 0 for laminar flow. More...
 
void operator= (const laminarModel &)=delete
 Disallow default bitwise assignment. More...
 

Static Public Member Functions

static autoPtr< StokesNew (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 Return a reference to the selected turbulence model. More...
 
- Static Public Member Functions inherited from laminarModel< BasicMomentumTransportModel >
static autoPtr< laminarModelNew (const alphaField &alpha, const rhoField &rho, const volVectorField &U, const surfaceScalarField &alphaRhoPhi, const surfaceScalarField &phi, const viscosity &viscosity)
 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 >

Momentum transport 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.

Constructor & Destructor Documentation

◆ Stokes()

Stokes ( const alphaField alpha,
const rhoField rho,
const volVectorField U,
const surfaceScalarField alphaRhoPhi,
const surfaceScalarField phi,
const viscosity viscosity 
)

Construct from components.

Definition at line 43 of file Stokes.C.

◆ ~Stokes()

virtual ~Stokes ( )
inlinevirtual

Destructor.

Definition at line 96 of file Stokes.H.

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

Return a reference to the selected turbulence model.

◆ coeffDict()

const dictionary & coeffDict
virtual

Const access to the coefficients dictionary.

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 69 of file Stokes.C.

References dictionary::null.

◆ read()

bool read
virtual

Read momentumTransport dictionary.

Implements linearViscousStress< laminarModel< BasicMomentumTransportModel > >.

Definition at line 76 of file Stokes.C.

◆ nuEff() [1/2]

tmp< volScalarField > nuEff
virtual

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

Implements laminarModel< BasicMomentumTransportModel >.

Definition at line 83 of file Stokes.C.

References GeometricField< Type, PatchField, GeoMesh >::New().

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.

Implements laminarModel< BasicMomentumTransportModel >.

Definition at line 94 of file Stokes.C.

References patchi.

◆ predict()

void predict
virtual

Predict the Stokes viscosity.

Reimplemented from laminarModel< BasicMomentumTransportModel >.

Definition at line 104 of file Stokes.C.

References laminarModel< BasicMomentumTransportModel >::predict().

Here is the call graph for this function:

◆ correct()

virtual void correct ( )
inlinevirtual

The Stokes viscosity is not corrected.

Implements linearViscousStress< laminarModel< BasicMomentumTransportModel > >.

Definition at line 118 of file Stokes.H.


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