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

Inheritance diagram for nutkRoughWallFunctionFvPatchScalarField:
Collaboration diagram for nutkRoughWallFunctionFvPatchScalarField:

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 &)
 Construct by mapping given. More...
 
 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 ()
 
scalarFieldCs ()
 
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 &)
 Construct by mapping given. More...
 
 nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
 nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy 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 &)
 Construct as copy. More...
 
 nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. 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 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...
 

Protected Attributes

scalarField Ks_
 Roughness height. More...
 
scalarField Cs_
 Roughness constant. 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 for rough walls, based on turbulence kinetic energy. The condition manipulates the E parameter to account for roughness effects.

Parameter ranges

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


Patch usage

Property Description Required Default value
Ks sand-grain roughness height yes
Cs roughness constant yes

Example of the boundary condition specification:

    myPatch
    {
        type            nutkRoughWallFunction;
        Ks              uniform 0;
        Cs              uniform 0.5;
    }
See Also
Foam::nutkRoughWallFunctionFvPatchScalarField
Source files

Definition at line 94 of file nutkRoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 131 of file nutkRoughWallFunctionFvPatchScalarField.C.

Referenced by nutkRoughWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

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

Construct from patch, internal field and dictionary.

Definition at line 157 of file nutkRoughWallFunctionFvPatchScalarField.C.

Construct by mapping given.

nutkRoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 143 of file nutkRoughWallFunctionFvPatchScalarField.C.

Construct as copy setting internal field reference.

Definition at line 181 of file nutkRoughWallFunctionFvPatchScalarField.C.

Member Function Documentation

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

Compute the roughness function.

Definition at line 40 of file nutkRoughWallFunctionFvPatchScalarField.C.

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

Referenced by nutkRoughWallFunctionFvPatchScalarField::calcNut().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName ( "nutkRoughWallFunction"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 159 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

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 176 of file nutkRoughWallFunctionFvPatchScalarField.H.

References nutkRoughWallFunctionFvPatchScalarField::nutkRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

void autoMap ( const fvPatchFieldMapper m)
virtual

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

Definition at line 195 of file nutkRoughWallFunctionFvPatchScalarField.C.

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

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 206 of file nutkRoughWallFunctionFvPatchScalarField.C.

References nutkRoughWallFunctionFvPatchScalarField::Cs_, nutkRoughWallFunctionFvPatchScalarField::Ks_, and nutkRoughWallFunctionFvPatchScalarField::rmap().

Referenced by nutkRoughWallFunctionFvPatchScalarField::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation


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