Public Member Functions | List of all members
wallFunctionCoefficients Class Reference

Class to host the wall-function coefficients being used in the wall function boundary conditions. More...

Public Member Functions

 wallFunctionCoefficients ()
 Construct with default coefficients. More...
 
 wallFunctionCoefficients (const dictionary &dict)
 Construct from dictionary. More...
 
scalar Cmu () const noexcept
 Return the object: Cmu. More...
 
scalar kappa () const noexcept
 Return the object: kappa. More...
 
scalar E () const noexcept
 Return the object: E. More...
 
scalar yPlusLam () const noexcept
 Return the object: yPlusLam. More...
 
void writeEntries (Ostream &) const
 Write wall-function coefficients as dictionary entries. More...
 

Detailed Description

Class to host the wall-function coefficients being used in the wall function boundary conditions.

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

    // Optional entries
    Cmu             0.09;
    kappa           0.41;
    E               9.8;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Deflt
Cmu Empirical model coefficient scalar no 0.09
kappa von Karman constant scalar no 0.41
E Wall roughness parameter scalar no 9.8
Source files

Definition at line 101 of file wallFunctionCoefficients.H.

Constructor & Destructor Documentation

◆ wallFunctionCoefficients() [1/2]

wallFunctionCoefficients ( )

Construct with default coefficients.

Definition at line 54 of file wallFunctionCoefficients.C.

◆ wallFunctionCoefficients() [2/2]

wallFunctionCoefficients ( const dictionary &  dict)
explicit

Construct from dictionary.

Definition at line 64 of file wallFunctionCoefficients.C.

Member Function Documentation

◆ Cmu()

scalar Cmu ( ) const
inlinenoexcept

Return the object: Cmu.

Definition at line 149 of file wallFunctionCoefficients.H.

Referenced by adjointkOmegaSST::addWallFunctionTerms(), adjointkOmegaSST::adjointMeanFlowSource(), nutkWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), atmNutkWallFunctionFvPatchScalarField::calcNut(), atmNutWallFunctionFvPatchScalarField::calcNut(), kaqRWallFunctionFvPatchScalarField::manipulateMatrix(), and kLowReWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ kappa()

scalar kappa ( ) const
inlinenoexcept

Return the object: kappa.

Definition at line 157 of file wallFunctionCoefficients.H.

Referenced by nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), atmNutUWallFunctionFvPatchScalarField::calcNut(), atmNutkWallFunctionFvPatchScalarField::calcNut(), atmNutWallFunctionFvPatchScalarField::calcNut(), and kLowReWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ E()

scalar E ( ) const
inlinenoexcept

Return the object: E.

Definition at line 165 of file wallFunctionCoefficients.H.

Referenced by nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), and nutkRoughWallFunctionFvPatchScalarField::calcNut().

Here is the caller graph for this function:

◆ yPlusLam()

scalar yPlusLam ( ) const
inlinenoexcept

Return the object: yPlusLam.

Definition at line 173 of file wallFunctionCoefficients.H.

Referenced by nutkWallFunctionFvPatchScalarField::calcNut(), nutUWallFunctionFvPatchScalarField::calcNut(), and kLowReWallFunctionFvPatchScalarField::updateCoeffs().

Here is the caller graph for this function:

◆ writeEntries()

void writeEntries ( Ostream &  os) const

Write wall-function coefficients as dictionary entries.

Definition at line 81 of file wallFunctionCoefficients.C.

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

Here is the call graph for this function:
The documentation for this class was generated from the following files: