nutWallFunctionFvPatchScalarField Class Referenceabstract

The class nutWallFunction is an abstract base class that hosts \(y^+\) calculation methods and common functions for nut wall-function boundary conditions. More...

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

Public Member Functions

 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...
 
virtual tmp< scalarFieldyPlus () const =0
 Calculate and return the yPlus at the boundary. More...
 
const wallFunctionCoefficientswallCoeffs () const noexcept
 Return wallFunctionCoefficients. 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 turbulenceModel &turbModel, const label patchi)
 Return the nut patchField for the given wall patch. More...
 

Protected Member Functions

virtual const volVectorFieldU (const turbulenceModel &turb) const
 
virtual void checkType ()
 Check the type of the patch. More...
 
virtual tmp< scalarFieldcalcNut () const =0
 Calculate the turbulent viscosity. More...
 
void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 

Protected Attributes

word UName_
 Name of velocity field. More...
 
wallFunctionCoefficients wallCoeffs_
 Wall-function coefficients. More...
 

Detailed Description

The class nutWallFunction is an abstract base class that hosts \(y^+\) calculation methods and common functions for nut wall-function boundary conditions.

Usage
Example of the boundary condition specification:
<patchName>
{
    // Top-level entries
    ...

    // Optional entries
    U             U;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
U Name of operand velocity field word no U

The inherited entries are elaborated in:

Source files

Definition at line 97 of file nutWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 85 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 115 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given nutWallFunctionFvPatchScalarField onto a new patch

Definition at line 99 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [4/5]

Construct as copy.

Definition at line 130 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 143 of file nutWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::checkType().

Here is the call graph for this function:

Member Function Documentation

◆ U()

const Foam::volVectorField & U ( const turbulenceModel turb) const
protectedvirtual

Helper to return the velocity field either from the turbulence model (default) or the mesh database

Definition at line 59 of file nutWallFunctionFvPatchScalarField.C.

References turb.

◆ checkType()

void checkType ( )
protectedvirtual

Check the type of the patch.

Definition at line 45 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:

◆ calcNut()

◆ writeLocalEntries()

void writeLocalEntries ( Ostream os) const
protected

Write local wall function variables.

Definition at line 73 of file nutWallFunctionFvPatchScalarField.C.

References word::null, os(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutWallFunction"  )

Runtime type information.

◆ nutw()

const Foam::nutWallFunctionFvPatchScalarField & nutw ( const turbulenceModel turbModel,
const label  patchi 
)
static

Return the nut patchField for the given wall patch.

Definition at line 160 of file nutWallFunctionFvPatchScalarField.C.

References turbulenceModel::nut().

Referenced by atmNutkWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), atmNutWallFunctionFvPatchScalarField::calcNut(), nutkWallFunctionFvPatchScalarField::calcNut(), nutUSpaldingWallFunctionFvPatchScalarField::calcNut(), and nutUWallFunctionFvPatchScalarField::calcNut().

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

◆ yPlus()

virtual tmp< scalarField > yPlus ( ) const
pure virtual

Calculate and return the yPlus at the boundary.

yPlus is the first-cell-centre height from boundary in wall units

Implemented in nutkFilmWallFunctionFvPatchScalarField, nutkWallFunctionFvPatchScalarField, nutLowReWallFunctionFvPatchScalarField, nutUBlendedWallFunctionFvPatchScalarField, nutURoughWallFunctionFvPatchScalarField, nutUSpaldingWallFunctionFvPatchScalarField, nutUTabulatedWallFunctionFvPatchScalarField, and nutUWallFunctionFvPatchScalarField.

Referenced by yPlus::execute(), and alphatJayatillekeWallFunctionFvPatchScalarField::yPlus().

Here is the caller graph for this function:

◆ wallCoeffs()

const wallFunctionCoefficients & wallCoeffs ( ) const
inlinenoexcept

Return wallFunctionCoefficients.

Definition at line 194 of file nutWallFunctionFvPatchScalarField.H.

References nutWallFunctionFvPatchScalarField::wallCoeffs_.

Referenced by adjointkOmegaSST::addWallFunctionTerms(), adjointkOmegaSST::adjointMeanFlowSource(), and kaqRWallFunctionFvPatchScalarField::manipulateMatrix().

Here is the caller graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 175 of file nutWallFunctionFvPatchScalarField.C.

References Foam::operator==().

Here is the call graph for this function:

◆ write()

Member Data Documentation

◆ UName_

word UName_
protected

Name of velocity field.

Default is null (not specified) in which case the velocity is retrieved from the turbulence model

Definition at line 108 of file nutWallFunctionFvPatchScalarField.H.

◆ wallCoeffs_


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