Public Member Functions | Protected Member Functions | List of all members
nutUWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a wall constraint on the turbulent viscosity, i.e. nut, based on velocity, i.e. U, for low- and high-Reynolds number turbulence models. More...

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

Public Member Functions

 TypeName ("nutUWallFunction")
 
 nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &)
 
virtual tmp< fvPatchScalarFieldclone () const
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 
virtual tmp< scalarFieldyPlus () const
 
virtual void write (Ostream &os) const
 
- Public Member Functions inherited from nutWallFunctionFvPatchScalarField
 TypeName ("nutWallFunction")
 
 nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 
 nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 
scalar Cmu () const
 
scalar kappa () const
 
scalar E () const
 
scalar yPlusLam () const
 
scalar blend (const scalar nutVis, const scalar nutLog, const scalar yPlus) const
 
virtual void updateCoeffs ()
 

Protected Member Functions

virtual tmp< scalarFieldcalcYPlus (const scalarField &magUp) const
 
virtual tmp< scalarFieldcalcNut () const
 
- Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorFieldU (const turbulenceModel &turb) const
 
virtual void checkType ()
 
virtual void writeLocalEntries (Ostream &) const
 

Additional Inherited Members

- Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarFieldnutw (const turbulenceModel &turbModel, const label patchi)
 
static scalar yPlusLam (const scalar kappa, const scalar E)
 
- Protected Types inherited from nutWallFunctionFvPatchScalarField
enum  blendingType { STEPWISE, MAX, BINOMIAL, EXPONENTIAL }
 
- Protected Attributes inherited from nutWallFunctionFvPatchScalarField
enum blendingType blending_
 
const scalar n_
 
word UName_
 
scalar Cmu_
 
scalar kappa_
 
scalar E_
 
scalar yPlusLam_
 
- Static Protected Attributes inherited from nutWallFunctionFvPatchScalarField
static const Enum< blendingTypeblendingTypeNames
 

Detailed Description

This boundary condition provides a wall constraint on the turbulent viscosity, i.e. nut, based on velocity, i.e. U, for low- and high-Reynolds number turbulence models.

Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries (unmodifiable)
    type            nutUWallFunction;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property Description Type Req'd Dflt
type Type name: nutUWallFunction word yes -

The inherited entries are elaborated in:

Note
Source files

Definition at line 94 of file nutUWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutUWallFunctionFvPatchScalarField() [1/5]

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

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

Definition at line 144 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [3/5]

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

Definition at line 132 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [4/5]

Definition at line 155 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [5/5]

Definition at line 164 of file nutUWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcYPlus()

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

◆ calcNut()

Foam::tmp< Foam::scalarField > calcNut ( ) const
protectedvirtual

◆ TypeName()

TypeName ( "nutUWallFunction"  )

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Reimplemented in atmNutUWallFunctionFvPatchScalarField.

Definition at line 150 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

Reimplemented in atmNutUWallFunctionFvPatchScalarField.

Definition at line 167 of file nutUWallFunctionFvPatchScalarField.H.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ yPlus()

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

◆ write()

void write ( Ostream os) const
virtual

Reimplemented from nutWallFunctionFvPatchScalarField.

Reimplemented in atmNutUWallFunctionFvPatchScalarField.

Definition at line 219 of file nutUWallFunctionFvPatchScalarField.C.

References os(), and fvPatchField::write().

Here is the call graph for this function:

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