nutUWallFunctionFvPatchScalarField Class Reference

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

Inheritance diagram for nutUWallFunctionFvPatchScalarField:
Collaboration diagram for nutUWallFunctionFvPatchScalarField:

Public Member Functions

 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...
 
virtual tmp< fvPatchScalarFieldclone () const
 Construct and return a clone. More...
 
 nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, 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...
 
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 &)
 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, based on velocity.

Usage
Example of the boundary condition specification:
<patchName>
{
    type            nutUWallFunction;
    value           uniform 0;
}
See also
Foam::nutWallFunctionFvPatchScalarField
Source files

Definition at line 62 of file nutUWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutUWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 131 of file nutUWallFunctionFvPatchScalarField.C.

Referenced by nutUWallFunctionFvPatchScalarField::clone(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), and nutUWallFunctionFvPatchScalarField::yPlus().

Here is the caller graph for this function:

◆ nutUWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 153 of file nutUWallFunctionFvPatchScalarField.C.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutUWallFunctionFvPatchScalarField() [3/5]

nutUWallFunctionFvPatchScalarField ( const nutUWallFunctionFvPatchScalarField ptf,
const fvPatch p,
const DimensionedField< scalar, volMesh > &  iF,
const fvPatchFieldMapper mapper 
)

Construct by mapping given.

nutUWallFunctionFvPatchScalarField onto a new patch

Definition at line 141 of file nutUWallFunctionFvPatchScalarField.C.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutUWallFunctionFvPatchScalarField() [4/5]

Copy constructor.

Definition at line 164 of file nutUWallFunctionFvPatchScalarField.C.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutUWallFunctionFvPatchScalarField() [5/5]

Copy constructor setting internal field reference.

Definition at line 173 of file nutUWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ yPlus() [1/2]

◆ nut()

◆ TypeName()

TypeName ( "nutUWallFunction"  )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const
inlinevirtual

Construct and return a clone.

Reimplemented in nutURoughWallFunctionFvPatchScalarField.

Definition at line 118 of file nutUWallFunctionFvPatchScalarField.H.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

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 in nutURoughWallFunctionFvPatchScalarField.

Definition at line 135 of file nutUWallFunctionFvPatchScalarField.H.

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

Here is the call graph for this function:

◆ yPlus() [2/2]

◆ write()

void write ( Ostream os) const
virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Reimplemented in nutURoughWallFunctionFvPatchScalarField.

Definition at line 203 of file nutUWallFunctionFvPatchScalarField.C.

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

Referenced by nutUWallFunctionFvPatchScalarField::clone().

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: