nutkRoughWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a wall-function for the turbulent viscosity (i.e. nut) when using wall functions for rough walls, based on the turbulent kinetic energy (i.e. k). The condition manipulates the wall roughness parameter (i.e. E) to account for roughness effects. More...

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

Public Member Functions

 TypeName ("nutkRoughWallFunction")
 Runtime type information. More...
 
 nutkRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 nutkRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutkRoughWallFunctionFvPatchScalarField (const nutkRoughWallFunctionFvPatchScalarField &, 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...
 
scalarFieldKs ()
 Return Ks. More...
 
scalarFieldCs ()
 Return Cs. More...
 
virtual void autoMap (const fvPatchFieldMapper &)
 Map (and resize as needed) from self given a mapping object. More...
 
virtual void rmap (const fvPatchScalarField &, const labelList &)
 Reverse map the given fvPatchField onto this fvPatchField. More...
 
virtual void write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from nutkWallFunctionFvPatchScalarField
 TypeName ("nutkWallFunction")
 Runtime type information. More...
 
 nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 
 nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, 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 &) 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 &)
 
 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...
 

Protected Member Functions

virtual scalar fnRough (const scalar KsPlus, const scalar Cs) const
 Compute the roughness function. More...
 
virtual tmp< scalarFieldcalcNut () const
 Calculate the turbulent viscosity. More...
 
void writeLocalEntries (Ostream &os) const
 Write local wall function variables. More...
 
- Protected Member Functions inherited from nutkWallFunctionFvPatchScalarField
virtual tmp< scalarFieldcalcNut () const
 Calculate the turbulent viscosity. More...
 
void writeLocalEntries (Ostream &) const
 Write local wall function variables. More...
 
- Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
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

scalarField Ks_
 Roughness height. More...
 
scalarField Cs_
 Roughness constant. More...
 
- Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word UName_
 Name of velocity field. More...
 
wallFunctionCoefficients wallCoeffs_
 Wall-function coefficients. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarFieldnutw (const turbulenceModel &turbModel, const label patchi)
 Return the nut patchField for the given wall patch. More...
 

Detailed Description

This boundary condition provides a wall-function for the turbulent viscosity (i.e. nut) when using wall functions for rough walls, based on the turbulent kinetic energy (i.e. k). The condition manipulates the wall roughness parameter (i.e. E) to account for roughness effects.

Parameter ranges:

  • roughness height (i.e. Ks)= sand-grain roughness (0 for smooth walls)
  • roughness constant (i.e. Cs) = 0.5-1.0
Usage
Example of the boundary condition specification:
<patchName>
{
    // Mandatory entries
    type            nutkRoughWallFunction;
    Ks              uniform 0;
    Cs              uniform 0.5;

    // Inherited entries
    ...
}

where the entries mean:

Property Description Type Reqd Dflt
type Type name: nutkRoughWallFunction word yes -
Ks Sand-grain roughness height scalarField yes -
Cs Roughness constant scalarField yes -

The inherited entries are elaborated in:

Source files

Definition at line 112 of file nutkRoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutkRoughWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 142 of file nutkRoughWallFunctionFvPatchScalarField.C.

◆ nutkRoughWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 170 of file nutkRoughWallFunctionFvPatchScalarField.C.

◆ nutkRoughWallFunctionFvPatchScalarField() [3/5]

Construct by mapping given nutkRoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 155 of file nutkRoughWallFunctionFvPatchScalarField.C.

◆ nutkRoughWallFunctionFvPatchScalarField() [4/5]

◆ nutkRoughWallFunctionFvPatchScalarField() [5/5]

Construct as copy setting internal field reference.

Definition at line 196 of file nutkRoughWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ fnRough()

Foam::scalar fnRough ( const scalar  KsPlus,
const scalar  Cs 
) const
protectedvirtual

Compute the roughness function.

Definition at line 37 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::Cs(), Foam::log(), Foam::pow(), and Foam::sin().

Here is the call graph for this function:

◆ calcNut()

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

Calculate the turbulent viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 58 of file nutkRoughWallFunctionFvPatchScalarField.C.

References e, Foam::endl(), forAll, IOobject::groupName(), Foam::Info, k, Foam::log(), Foam::max(), Foam::min(), Time::New(), Foam::pow025(), turbulenceModel::propertiesName, Foam::sqrt(), y, and yPlus.

Here is the call graph for this function:

◆ writeLocalEntries()

void writeLocalEntries ( Ostream os) const
protected

Write local wall function variables.

Definition at line 130 of file nutkRoughWallFunctionFvPatchScalarField.C.

References os().

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutkRoughWallFunction"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 180 of file nutkRoughWallFunctionFvPatchScalarField.H.

◆ clone() [2/2]

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

Construct and return a clone setting internal field reference.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 196 of file nutkRoughWallFunctionFvPatchScalarField.H.

◆ Ks()

scalarField & Ks ( )
inline

◆ Cs()

scalarField & Cs ( )
inline

Return Cs.

Definition at line 219 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::Cs_.

Referenced by nutkRoughWallFunctionFvPatchScalarField::fnRough().

Here is the caller graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper m)
virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 211 of file nutkRoughWallFunctionFvPatchScalarField.C.

References atmBoundaryLayer::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap ( const fvPatchScalarField ptf,
const labelList addr 
)
virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 222 of file nutkRoughWallFunctionFvPatchScalarField.C.

References atmBoundaryLayer::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 238 of file nutkRoughWallFunctionFvPatchScalarField.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ Ks_

scalarField Ks_
protected

Roughness height.

Definition at line 121 of file nutkRoughWallFunctionFvPatchScalarField.H.

Referenced by nutkRoughWallFunctionFvPatchScalarField::Ks().

◆ Cs_

scalarField Cs_
protected

Roughness constant.

Definition at line 124 of file nutkRoughWallFunctionFvPatchScalarField.H.

Referenced by nutkRoughWallFunctionFvPatchScalarField::Cs().


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