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

This boundary condition provides a turbulent kinematic viscosity for atmospheric velocity profiles. It is desinged to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition. The values are calculated using: More...

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

Public Member Functions

 TypeName ("nutkAtmRoughWallFunction")
 Runtime type information. More...
 
 nutkAtmRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
 Construct from patch and internal field. More...
 
 nutkAtmRoughWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 nutkAtmRoughWallFunctionFvPatchScalarField (const nutkAtmRoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
 Construct by mapping given. More...
 
 nutkAtmRoughWallFunctionFvPatchScalarField (const nutkAtmRoughWallFunctionFvPatchScalarField &)
 Construct as copy. More...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutkAtmRoughWallFunctionFvPatchScalarField (const nutkAtmRoughWallFunctionFvPatchScalarField &, 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...
 
scalarFieldz0 ()
 
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 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 z0_
 Surface roughness length. 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 for atmospheric velocity profiles. It is desinged to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition. The values are calculated using:

\[ U = frac{U_f}{K} ln(\frac{z + z_0}{z_0}) \]

where

$ U_f $ = frictional velocity
$ K $ = Von Karman's constant
$ z_0 $ = surface roughness length
$ z $ = vertical co-ordinate


Patch usage

Property Description Required Default value
z0 surface roughness length yes

Example of the boundary condition specification:

    myPatch
    {
        type            nutkAtmRoughWallFunction;
        z0              uniform 0;
    }
See also
Foam::nutkWallFunctionFvPatchField
Source files

Definition at line 112 of file nutkAtmRoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

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

Construct from patch, internal field and dictionary.

Definition at line 117 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Construct by mapping given.

nutkAtmRoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 103 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Construct as copy.

Definition at line 130 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Construct as copy setting internal field reference.

Definition at line 141 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

tmp< scalarField > calcNut ( ) const
protectedvirtual
TypeName ( "nutkAtmRoughWallFunction"  )

Runtime type information.

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 172 of file nutkAtmRoughWallFunctionFvPatchScalarField.H.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

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 189 of file nutkAtmRoughWallFunctionFvPatchScalarField.H.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

scalarField& z0 ( )
inline
void autoMap ( const fvPatchFieldMapper m)
virtual

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

Definition at line 154 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References Field< Type >::autoMap(), nutkAtmRoughWallFunctionFvPatchScalarField::rmap(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 164 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References Field< Type >::rmap(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::autoMap(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0().

Here is the call graph for this function:

Here is the caller graph for this function:

void write ( Ostream os) const
virtual

Member Data Documentation

scalarField z0_
protected

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