nutUWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a wall constraint on the turbulent kinematic viscosity, i.e. nut, when using wall functions, based on velocity, U. More...

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

Public Member Functions

 TypeName ("nutUWallFunction")
 Runtime type information. More...
 
 nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual tmp< scalarFieldyPlus () const
 Calculate and return the yPlus at the boundary. More...
 
virtual void write (Ostream &os) const
 Write. More...
 
- Public Member Functions inherited from nutWallFunctionFvPatchScalarField
 TypeName ("nutWallFunction")
 Runtime type information. More...
 
 nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. 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 fvPatchFieldMapper &)
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy 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 viscous sublayer. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 

Protected Member Functions

virtual tmp< scalarFieldcalcYPlus (const scalarField &magUp) const
 Calculate yPlus. More...
 
virtual tmp< scalarFieldcalcNut () const
 Calculate the turbulence viscosity. More...
 
- Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorFieldU (const turbulenceModel &turb) const
 
virtual void checkType ()
 Check the type of the patch. More...
 
virtual void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarFieldnutw (const turbulenceModel &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 viscous sublayer. More...
 
- Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word UName_
 Name of velocity field. More...
 
scalar Cmu_
 Cmu coefficient. More...
 
scalar kappa_
 Von Karman constant. More...
 
scalar E_
 E coefficient. More...
 
scalar yPlusLam_
 Estimated y+ value at the edge of the viscous sublayer. More...
 

Detailed Description

This boundary condition provides a wall constraint on the turbulent kinematic viscosity, i.e. nut, when using wall functions, based on velocity, U.

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

Example of the boundary condition specification:

    <patchName>
    {
        // Mandatory entries
        type            nutUWallFunction;

        // Optional entries
    }
See also
Foam::nutWallFunctionFvPatchScalarField
Note
Suffers from non-exact restart since correctNut() (called through turbulence->validate) returns a slightly different value every time it is called. See nutUSpaldingWallFunctionFvPatchScalarField.C
Source files

Definition at line 103 of file nutUWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutUWallFunctionFvPatchScalarField() [1/5]

nutUWallFunctionFvPatchScalarField ( const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF 
)

Construct from patch and internal field.

Definition at line 125 of file nutUWallFunctionFvPatchScalarField.C.

Referenced by nutUWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ nutUWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 147 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [3/5]

nutUWallFunctionFvPatchScalarField ( const nutUWallFunctionFvPatchScalarField ptf,
const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping given nutUWallFunctionFvPatchScalarField onto a new patch

Definition at line 135 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [4/5]

Construct as copy.

Definition at line 158 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 167 of file nutUWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcYPlus()

Foam::tmp< Foam::scalarField > calcYPlus ( const scalarField magUp) const
protectedvirtual

Calculate yPlus.

Definition at line 77 of file nutUWallFunctionFvPatchScalarField.C.

References forAll, Foam::constant::atomic::group, IOobject::groupName(), Foam::log(), Foam::mag(), magUp, Foam::max(), turbulenceModel::nu(), Foam::foamVersion::patch, turbulenceModel::propertiesName, tmp< T >::ref(), y, turbulenceModel::y(), yPlus, and Foam::Zero.

Referenced by nutUWallFunctionFvPatchScalarField::calcNut().

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

◆ calcNut()

◆ TypeName()

TypeName ( "nutUWallFunction"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 159 of file nutUWallFunctionFvPatchScalarField.H.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 176 of file nutUWallFunctionFvPatchScalarField.H.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ yPlus()

Foam::tmp< Foam::scalarField > yPlus ( ) const
virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 179 of file nutUWallFunctionFvPatchScalarField.C.

References Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), magUp, Foam::foamVersion::patch, turbulenceModel::propertiesName, and U.

Referenced by nutUWallFunctionFvPatchScalarField::calcNut().

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

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 198 of file nutUWallFunctionFvPatchScalarField.C.

References fvPatchField< Type >::write().

Here is the call graph for this function:

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