Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
nutUTabulatedWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions. As input, the user specifies a look-up table of U+ as a function of near-wall Reynolds number. The table should be located in the $FOAM_CASE/constant directory. More...

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

Public Member Functions

 TypeName ("nutTabulatedWallFunction")
 Runtime type information. More...
 
 nutUTabulatedWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 nutUTabulatedWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutUTabulatedWallFunctionFvPatchScalarField (const nutUTabulatedWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 nutUTabulatedWallFunctionFvPatchScalarField (const nutUTabulatedWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutUTabulatedWallFunctionFvPatchScalarField (const nutUTabulatedWallFunctionFvPatchScalarField &, 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 &)
 Construct by mapping given. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
scalar yPlusLam () const
 Return the Y+ at the edge of the laminar sublayer. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 

Protected Member Functions

virtual tmp< scalarFieldcalcNut () const
 Calculate the turbulence viscosity. More...
 
virtual tmp< scalarFieldcalcUPlus (const scalarField &Rey) const
 Calculate wall u+ from table. More...
 
- Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual void checkType ()
 Check the type of the patch. More...
 
virtual void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 

Protected Attributes

word uPlusTableName_
 Name of u+ table. More...
 
uniformInterpolationTable< scalar > uPlusTable_
 U+ table. More...
 
- Protected Attributes inherited from nutWallFunctionFvPatchScalarField
scalar Cmu_
 Cmu coefficient. More...
 
scalar kappa_
 Von Karman constant. More...
 
scalar E_
 E coefficient. More...
 
scalar yPlusLam_
 Y+ at the edge of the laminar sublayer. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static scalar yPlusLam (const scalar kappa, const scalar E)
 Calculate the Y+ at the edge of the laminar sublayer. More...
 

Detailed Description

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions. As input, the user specifies a look-up table of U+ as a function of near-wall Reynolds number. The table should be located in the $FOAM_CASE/constant directory.

Usage
Property Description Required Default value
uPlusTable U+ as a function of Re table name yes

Example of the boundary condition specification:

    <patchName>
    {
        type            nutTabulatedWallFunction;
        uPlusTable      myUPlusTable;
    }
Note
The tables are not registered since the same table object may be used for more than one patch.
See also
Foam::nutWallFunctionFvPatchScalarField
Source files

Definition at line 84 of file nutUTabulatedWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutUTabulatedWallFunctionFvPatchScalarField() [1/5]

◆ nutUTabulatedWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 130 of file nutUTabulatedWallFunctionFvPatchScalarField.C.

References nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutUTabulatedWallFunctionFvPatchScalarField() [3/5]

Construct by mapping given.

nutUTabulatedWallFunctionFvPatchScalarField onto a new patch

Definition at line 115 of file nutUTabulatedWallFunctionFvPatchScalarField.C.

References nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutUTabulatedWallFunctionFvPatchScalarField() [4/5]

Construct as copy.

Definition at line 156 of file nutUTabulatedWallFunctionFvPatchScalarField.C.

References nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutUTabulatedWallFunctionFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 168 of file nutUTabulatedWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const
protectedvirtual

◆ calcUPlus()

tmp< scalarField > calcUPlus ( const scalarField Rey) const
protectedvirtual

◆ TypeName()

TypeName ( "nutTabulatedWallFunction"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 149 of file nutUTabulatedWallFunctionFvPatchScalarField.H.

References nutUTabulatedWallFunctionFvPatchScalarField::nutUTabulatedWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

◆ yPlus()

tmp< scalarField > yPlus ( ) const
virtual

◆ write()

void write ( Ostream os) const
virtual

Member Data Documentation

◆ uPlusTableName_

word uPlusTableName_
protected

◆ uPlusTable_

uniformInterpolationTable<scalar> uPlusTable_
protected

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