Loading...
Searching...
No Matches
nutWallFunctionFvPatchScalarField Class Referenceabstract
Turbulence models » Boundary conditions » Wall functions

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

#include <nutWallFunctionFvPatchScalarField.H>

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

Public Member Functions

 TypeName ("nutWallFunction")
 Runtime type information.
 nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field.
 nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary.
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given nutWallFunctionFvPatchScalarField onto a new patch.
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
 Construct as copy.
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference.
virtual tmp< scalarField > yPlus () const =0
 Calculate and return the yPlus at the boundary.
const wallFunctionCoefficients & wallCoeffs () const noexcept
 Return wallFunctionCoefficients.
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field.
virtual void write (Ostream &) const
 Write.

Static Public Member Functions

static const nutWallFunctionFvPatchScalarField & nutw (const turbulenceModel &turbModel, const label patchi)
 Return the nut patchField for the given wall patch.

Protected Member Functions

virtual const volVectorField & U (const turbulenceModel &turb) const
 Helper to return the velocity field either from the turbulence model (default) or the mesh database.
virtual void checkType ()
 Check the type of the patch.
virtual tmp< scalarField > calcNut () const =0
 Calculate the turbulent viscosity.
void writeLocalEntries (Ostream &) const
 Write local wall function variables.

Protected Attributes

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

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 93 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 78 of file nutWallFunctionFvPatchScalarField.C.

References checkType(), p, UName_, and wallCoeffs_.

Referenced by nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), nutLowReWallFunctionFvPatchScalarField::nutLowReWallFunctionFvPatchScalarField(), nutLowReWallFunctionFvPatchScalarField::nutLowReWallFunctionFvPatchScalarField(), nutLowReWallFunctionFvPatchScalarField::nutLowReWallFunctionFvPatchScalarField(), nutLowReWallFunctionFvPatchScalarField::nutLowReWallFunctionFvPatchScalarField(), nutLowReWallFunctionFvPatchScalarField::nutLowReWallFunctionFvPatchScalarField(), nutUBlendedWallFunctionFvPatchScalarField::nutUBlendedWallFunctionFvPatchScalarField(), nutUBlendedWallFunctionFvPatchScalarField::nutUBlendedWallFunctionFvPatchScalarField(), nutUBlendedWallFunctionFvPatchScalarField::nutUBlendedWallFunctionFvPatchScalarField(), nutUBlendedWallFunctionFvPatchScalarField::nutUBlendedWallFunctionFvPatchScalarField(), nutUBlendedWallFunctionFvPatchScalarField::nutUBlendedWallFunctionFvPatchScalarField(), nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField(), nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField(), nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField(), nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField(), nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField(), nutUSpaldingWallFunctionFvPatchScalarField::nutUSpaldingWallFunctionFvPatchScalarField(), nutUSpaldingWallFunctionFvPatchScalarField::nutUSpaldingWallFunctionFvPatchScalarField(), nutUSpaldingWallFunctionFvPatchScalarField::nutUSpaldingWallFunctionFvPatchScalarField(), nutUSpaldingWallFunctionFvPatchScalarField::nutUSpaldingWallFunctionFvPatchScalarField(), nutUSpaldingWallFunctionFvPatchScalarField::nutUSpaldingWallFunctionFvPatchScalarField(), nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField(), nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField(), nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField(), nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField(), nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), and TypeName().

Here is the call graph for this function:
Here is the caller 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 108 of file nutWallFunctionFvPatchScalarField.C.

References checkType(), dict, p, UName_, and wallCoeffs_.

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 92 of file nutWallFunctionFvPatchScalarField.C.

References checkType(), nutWallFunctionFvPatchScalarField(), p, UName_, and wallCoeffs_.

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [4/5]

nutWallFunctionFvPatchScalarField ( const nutWallFunctionFvPatchScalarField & wfpsf)

Construct as copy.

Definition at line 123 of file nutWallFunctionFvPatchScalarField.C.

References checkType(), nutWallFunctionFvPatchScalarField(), UName_, and wallCoeffs_.

Here is the call graph for this function:

◆ nutWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 136 of file nutWallFunctionFvPatchScalarField.C.

References checkType(), nutWallFunctionFvPatchScalarField(), UName_, and wallCoeffs_.

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 52 of file nutWallFunctionFvPatchScalarField.C.

References turb, and UName_.

◆ checkType()

void checkType ( )
protectedvirtual

Check the type of the patch.

Definition at line 38 of file nutWallFunctionFvPatchScalarField.C.

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

Referenced by nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), and nutWallFunctionFvPatchScalarField().

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

◆ calcNut()

virtual tmp< scalarField > calcNut ( ) const
protectedpure virtual

Calculate the turbulent viscosity.

Implemented in atmNutkWallFunctionFvPatchScalarField, atmNutUWallFunctionFvPatchScalarField, atmNutWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, nutkRoughWallFunctionFvPatchScalarField, nutkWallFunctionFvPatchScalarField, nutLowReWallFunctionFvPatchScalarField, nutUBlendedWallFunctionFvPatchScalarField, nutUSpaldingWallFunctionFvPatchScalarField, nutUTabulatedWallFunctionFvPatchScalarField, and nutUWallFunctionFvPatchScalarField.

Referenced by updateCoeffs().

Here is the caller graph for this function:

◆ writeLocalEntries()

void writeLocalEntries ( Ostream & os) const
protected

Write local wall function variables.

Definition at line 66 of file nutWallFunctionFvPatchScalarField.C.

References word::null, os(), UName_, and wallCoeffs_.

Referenced by write().

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

◆ TypeName()

TypeName ( "nutWallFunction" )

Runtime type information.

References nutWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutw()

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

Return the nut patchField for the given wall patch.

Definition at line 153 of file nutWallFunctionFvPatchScalarField.C.

References turbulenceModel::nut(), and Foam::refCast().

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

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 alphatJayatillekeWallFunctionFvPatchScalarField::yPlus().

Here is the caller graph for this function:

◆ wallCoeffs()

const wallFunctionCoefficients & wallCoeffs ( ) const
inlinenoexcept

Return wallFunctionCoefficients.

Definition at line 222 of file nutWallFunctionFvPatchScalarField.H.

References Foam::noexcept, and 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 168 of file nutWallFunctionFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream & os) const
virtual

Write.

Reimplemented in atmNutkWallFunctionFvPatchScalarField, atmNutUWallFunctionFvPatchScalarField, atmNutWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, nutkRoughWallFunctionFvPatchScalarField, nutkWallFunctionFvPatchScalarField, nutLowReWallFunctionFvPatchScalarField, nutUBlendedWallFunctionFvPatchScalarField, nutURoughWallFunctionFvPatchScalarField, nutUSpaldingWallFunctionFvPatchScalarField, nutUTabulatedWallFunctionFvPatchScalarField, and nutUWallFunctionFvPatchScalarField.

Definition at line 181 of file nutWallFunctionFvPatchScalarField.C.

References os(), fvPatchField< Type >::write(), and writeLocalEntries().

Referenced by atmNutkWallFunctionFvPatchScalarField::write(), atmNutUWallFunctionFvPatchScalarField::write(), atmNutWallFunctionFvPatchScalarField::write(), nutkFilmWallFunctionFvPatchScalarField::write(), nutkRoughWallFunctionFvPatchScalarField::write(), nutkWallFunctionFvPatchScalarField::write(), nutLowReWallFunctionFvPatchScalarField::write(), nutUBlendedWallFunctionFvPatchScalarField::write(), nutURoughWallFunctionFvPatchScalarField::write(), nutUSpaldingWallFunctionFvPatchScalarField::write(), nutUTabulatedWallFunctionFvPatchScalarField::write(), and nutUWallFunctionFvPatchScalarField::write().

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

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 107 of file nutWallFunctionFvPatchScalarField.H.

Referenced by nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), U(), and writeLocalEntries().

◆ wallCoeffs_

wallFunctionCoefficients wallCoeffs_
protected

Wall-function coefficients.

Definition at line 112 of file nutWallFunctionFvPatchScalarField.H.

Referenced by atmNutkWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), atmNutWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), nutkFilmWallFunctionFvPatchScalarField::calcUTau(), nutUBlendedWallFunctionFvPatchScalarField::calcUTau(), nutUSpaldingWallFunctionFvPatchScalarField::calcUTau(), nutUWallFunctionFvPatchScalarField::calcYPlus(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField(), wallCoeffs(), writeLocalEntries(), nutkWallFunctionFvPatchScalarField::yPlus(), and nutUWallFunctionFvPatchScalarField::yPlus().

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