nutURoughWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity. The condition manipulates the E parameter to account for roughness effects. More...

Inheritance diagram for nutURoughWallFunctionFvPatchScalarField:
Collaboration diagram for nutURoughWallFunctionFvPatchScalarField:

Public Member Functions

 TypeName ("nutURoughWallFunction")
 Runtime type information. More...
 
 nutURoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 nutURoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &)
 Copy constructor. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarFieldclone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
const scalarFieldKs () const
 Return the roughness height. More...
 
scalarFieldKs ()
 Return reference to the roughness height to allow adjustment. More...
 
const scalarFieldCs () const
 Return the roughness constant scale. More...
 
scalarFieldCs ()
 Return reference to the roughness constant to allow adjustment. 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 &os) const
 Write. More...
 
- Public Member Functions inherited from nutUWallFunctionFvPatchScalarField
 TypeName ("nutUWallFunction")
 Runtime type information. More...
 
 nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &)
 Copy constructor. More...
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< scalarFieldyPlus () const
 Calculate and return the yPlus at the boundary. 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 &)
 Copy constructor. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Copy constructor setting internal field reference. More...
 
scalar Cmu () const
 Return Cmu. More...
 
scalar kappa () const
 Return kappa. More...
 
scalar E () const
 Return E. 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< scalarFieldyPlus (const scalarField &magUp) const
 Calculate yPLus. More...
 
virtual tmp< scalarFieldnut () const
 Calculate the turbulence viscosity. 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...
 

Additional Inherited Members

- Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarFieldnutw (const momentumTransportModel &turbModel, const label patchi)
 Return the nut patchField for the given wall patch. More...
 
static scalar yPlusLam (const scalar kappa, const scalar E)
 Calculate the Y+ at the edge of the laminar sublayer. 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...
 

Detailed Description

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity. The condition manipulates the E parameter to account for roughness effects.

Reference:

    Cebeci, T., & Bradshaw, P. (1977).
    Momentum transfer in boundary layers.
    Washington, DC, Hemisphere Publishing Corp.; New York,
    McGraw-Hill Book Co., 1977. 407 p.
Usage
Property Description Required Default value
Ks sand-grain roughness height yes
Cs roughness constant yes

Parameter ranges

  • roughness height (Ks) = sand-grain roughness (0 for smooth walls)
  • roughness constant (Cs) = 0.5 - 1.0

Example of the boundary condition specification:

    <patchName>
    {
        type            nutURoughWallFunction;
        Ks              uniform 1e-5;
        Cs              uniform 0.5;
        value           uniform 0;
    }
See also
Foam::nutUWallFunctionFvPatchScalarField
Source files

Definition at line 98 of file nutURoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutURoughWallFunctionFvPatchScalarField() [1/5]

◆ nutURoughWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 237 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutURoughWallFunctionFvPatchScalarField() [3/5]

Construct by mapping given.

nutURoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 250 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutURoughWallFunctionFvPatchScalarField() [4/5]

◆ nutURoughWallFunctionFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 275 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ yPlus()

◆ nut()

◆ TypeName()

TypeName ( "nutURoughWallFunction"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 163 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ 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 nutUWallFunctionFvPatchScalarField.

Definition at line 180 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ Ks() [1/2]

const scalarField& Ks ( ) const
inline

Return the roughness height.

Definition at line 196 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ Ks() [2/2]

scalarField& Ks ( )
inline

Return reference to the roughness height to allow adjustment.

Definition at line 202 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ Cs() [1/2]

const scalarField& Cs ( ) const
inline

Return the roughness constant scale.

Definition at line 209 of file nutURoughWallFunctionFvPatchScalarField.H.

◆ Cs() [2/2]

scalarField& Cs ( )
inline

Return reference to the roughness constant to allow adjustment.

Definition at line 215 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::autoMap(), nutURoughWallFunctionFvPatchScalarField::rmap(), and nutURoughWallFunctionFvPatchScalarField::write().

Here is the call 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 289 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField::rmap().

Referenced by nutURoughWallFunctionFvPatchScalarField::Cs(), and nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

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

References Field< Type >::rmap().

Referenced by nutURoughWallFunctionFvPatchScalarField::autoMap(), and nutURoughWallFunctionFvPatchScalarField::Cs().

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

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 315 of file nutURoughWallFunctionFvPatchScalarField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), Foam::writeEntry(), and nutWallFunctionFvPatchScalarField::writeLocalEntries().

Referenced by nutURoughWallFunctionFvPatchScalarField::Cs().

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

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