nutWallFunctionFvPatchScalarField Class Referenceabstract

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on turbulence kinetic energy. More...

Inheritance diagram for nutWallFunctionFvPatchScalarField:
Collaboration diagram for nutWallFunctionFvPatchScalarField:

Public Member Functions

 TypeName ("nutWallFunction")
 Runtime type information. More...
 
 nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
scalar Cmu () const
 Return Cmu. More...
 
scalar kappa () const
 Return kappa. More...
 
scalar E () const
 Return E. More...
 
scalar yPlusLam () const
 Return the Y+ at the edge of the laminar sublayer. More...
 
virtual tmp< scalarFieldyPlus () const =0
 Calculate and return the yPlus at the boundary. More...
 
virtual void map (const fvPatchScalarField &, const fieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void write (Ostream &) const
 Write. More...
 

Static Public Member Functions

static const nutWallFunctionFvPatchScalarFieldnutw (const momentumTransportModel &turbModel, const label patchi)
 Return the nut patchField for the given wall patch. More...
 
static scalar yPlusLam (const scalar kappa, const scalar E)
 Calculate the Y+ at the edge of the laminar sublayer. More...
 

Protected Member Functions

virtual void checkType ()
 Check the type of the patch. More...
 
virtual tmp< scalarFieldnut () const =0
 Calculate the turbulence viscosity. More...
 
virtual void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 

Protected Attributes

scalar Cmu_
 Cmu coefficient. More...
 
scalar kappa_
 Von Karman constant. More...
 
scalar E_
 E coefficient. More...
 
scalar yPlusLam_
 Y+ at the edge of the laminar sublayer. More...
 

Detailed Description

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions, based on turbulence kinetic energy.

- replicates OpenFOAM v1.5 (and earlier) behaviour

Usage
Property Description Required Default value
Cmu Cmu coefficient no 0.09
kappa Von Karman constant no 0.41
E E coefficient no 9.8

Examples of the boundary condition specification:

    <patchName>
    {
        type            nutWallFunction;
        value           uniform 0;
    }

Reference for the default model coefficients:

        H. Versteeg, W. Malalasekera
        An Introduction to Computational Fluid Dynamics: The Finite Volume
        Method, subsection "3.5.2 k-epsilon model"
See also
Foam::fixedValueFvPatchField
Source files

Definition at line 99 of file nutWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutWallFunctionFvPatchScalarField() [1/4]

nutWallFunctionFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const dictionary dict 
)

Construct from patch, internal field and dictionary.

Definition at line 68 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [2/4]

nutWallFunctionFvPatchScalarField ( const nutWallFunctionFvPatchScalarField ptf,
const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const fieldMapper mapper 
)

Construct by mapping given.

nutWallFunctionFvPatchScalarField onto a new patch

Definition at line 85 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [3/4]

Disallow copy without setting internal field reference.

◆ nutWallFunctionFvPatchScalarField() [4/4]

Copy constructor setting internal field reference.

Definition at line 104 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

Member Function Documentation

◆ checkType()

void checkType ( )
protectedvirtual

Check the type of the patch.

Definition at line 41 of file nutWallFunctionFvPatchScalarField.C.

References Foam::abort(), Foam::endl(), Foam::FatalError, FatalErrorInFunction, and Foam::nl.

Referenced by nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField().

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

◆ nut()

◆ writeLocalEntries()

void writeLocalEntries ( Ostream os) const
protectedvirtual

◆ TypeName()

TypeName ( "nutWallFunction"  )

Runtime type information.

◆ Cmu()

scalar Cmu ( ) const
inline

Return Cmu.

Definition at line 176 of file nutWallFunctionFvPatchScalarField.H.

References nutWallFunctionFvPatchScalarField::Cmu_.

Referenced by fWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ kappa()

scalar kappa ( ) const
inline

◆ E()

◆ nutw()

◆ yPlusLam() [1/2]

Foam::scalar yPlusLam ( const scalar  kappa,
const scalar  E 
)
static

Calculate the Y+ at the edge of the laminar sublayer.

Definition at line 137 of file nutWallFunctionFvPatchScalarField.C.

References Foam::constant::electromagnetic::kappa, Foam::log(), and Foam::max().

Referenced by fWallFunctionFvPatchScalarField::updateCoeffs().

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

◆ yPlusLam() [2/2]

Foam::scalar yPlusLam ( ) const

Return the Y+ at the edge of the laminar sublayer.

Definition at line 169 of file nutWallFunctionFvPatchScalarField.C.

Referenced by nutkRoughWallFunctionFvPatchScalarField::nut().

Here is the caller graph for this function:

◆ yPlus()

virtual tmp<scalarField> yPlus ( ) const
pure virtual

◆ map()

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 185 of file nutWallFunctionFvPatchScalarField.C.

References nut, and Foam::operator==().

Here is the call graph for this function:

◆ write()

Member Data Documentation

◆ Cmu_

◆ kappa_

◆ E_

◆ yPlusLam_


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