Public Member Functions | List of all members
nutURoughWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a turbulent kinematic viscosity condition when using wall functions for rough walls, based on velocity. More...

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

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 &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutURoughWallFunctionFvPatchScalarField (const nutURoughWallFunctionFvPatchScalarField &, 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...
 
scalar roughnessHeight () const
 Return the roughness height. More...
 
scalar & roughnessHeight ()
 Return reference to the roughness height to allow adjustment. More...
 
scalar roughnessConstant () const
 Return the roughness constant scale. More...
 
scalar & roughnessConstant ()
 Return reference to the roughness constant to allow adjustment. More...
 
scalar roughnessFactor () const
 Return the roughness scale factor. More...
 
scalar & roughnessFactor ()
 Return reference to the roughness scale factor to allow. 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...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. 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...
 
- 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 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.

Usage
Property Description Required Default value
roughnessHeight roughness height yes
roughnessConstant roughness constanr yes
roughnessFactor scaling factor yes

Example of the boundary condition specification:

    <patchName>
    {
        type            nutURoughWallFunction;
        roughnessHeight 1e-5;
        roughnessConstant 0.5;
        roughnessFactor 1;
    }
See also
Foam::nutWallFunctionFvPatchScalarField
Source files

Definition at line 94 of file nutURoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

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

Construct from patch and internal field.

Definition at line 206 of file nutURoughWallFunctionFvPatchScalarField.C.

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

Here is the caller graph for this function:

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

Construct from patch, internal field and dictionary.

Definition at line 234 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Construct by mapping given.

nutURoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 219 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Construct as copy.

Definition at line 248 of file nutURoughWallFunctionFvPatchScalarField.C.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 260 of file nutURoughWallFunctionFvPatchScalarField.C.

Member Function Documentation

TypeName ( "nutURoughWallFunction"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Definition at line 162 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

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.

Definition at line 179 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::nutURoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

scalar roughnessHeight ( ) const
inline

Return the roughness height.

Definition at line 195 of file nutURoughWallFunctionFvPatchScalarField.H.

scalar& roughnessHeight ( )
inline

Return reference to the roughness height to allow adjustment.

Definition at line 201 of file nutURoughWallFunctionFvPatchScalarField.H.

scalar roughnessConstant ( ) const
inline

Return the roughness constant scale.

Definition at line 208 of file nutURoughWallFunctionFvPatchScalarField.H.

scalar& roughnessConstant ( )
inline

Return reference to the roughness constant to allow adjustment.

Definition at line 214 of file nutURoughWallFunctionFvPatchScalarField.H.

scalar roughnessFactor ( ) const
inline

Return the roughness scale factor.

Definition at line 220 of file nutURoughWallFunctionFvPatchScalarField.H.

References nutURoughWallFunctionFvPatchScalarField::write(), and nutURoughWallFunctionFvPatchScalarField::yPlus().

Here is the call graph for this function:

scalar& roughnessFactor ( )
inline

Return reference to the roughness scale factor to allow.

adjustment

Definition at line 227 of file nutURoughWallFunctionFvPatchScalarField.H.

tmp< scalarField > yPlus ( ) const
virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 274 of file nutURoughWallFunctionFvPatchScalarField.C.

References GeometricField< Type, PatchField, GeoMesh >::boundaryField(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), magUp, patchi, turbulenceModel::propertiesName, and turbulenceModel::U().

Referenced by nutURoughWallFunctionFvPatchScalarField::roughnessFactor().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
virtual

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