epsilonWallFunctionFvPatchScalarField Class Reference

This boundary condition provides a turbulence dissipation wall constraint for low- and high-Reynolds number turbulence models. More...

Inheritance diagram for epsilonWallFunctionFvPatchScalarField:
Collaboration diagram for epsilonWallFunctionFvPatchScalarField:

Public Member Functions

 TypeName ("epsilonWallFunction")
 Runtime type information. More...
 
 epsilonWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 epsilonWallFunctionFvPatchScalarField (const epsilonWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 epsilonWallFunctionFvPatchScalarField (const epsilonWallFunctionFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 epsilonWallFunctionFvPatchScalarField (const epsilonWallFunctionFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, fvMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual ~epsilonWallFunctionFvPatchScalarField ()
 Destructor. More...
 
virtual void map (const fvPatchScalarField &, const fieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchScalarField &)
 Reset the fvPatchField to the given fvPatchField. More...
 
virtual void updateCoeffs ()
 Update the coefficients associated with the patch field. More...
 
virtual void manipulateMatrix (fvMatrix< scalar > &matrix)
 Manipulate matrix. More...
 
- Public Member Functions inherited from wallCellWallFunctionFvPatchScalarField
 wallCellWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 wallCellWallFunctionFvPatchScalarField (const wallCellWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
 Construct by mapping given wallCellWallFunctionFvPatchScalarField. More...
 
 wallCellWallFunctionFvPatchScalarField (const wallCellWallFunctionFvPatchScalarField &)=delete
 Disallow copy without setting internal field reference. More...
 
 wallCellWallFunctionFvPatchScalarField (const wallCellWallFunctionFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
 Copy constructor setting internal field reference. More...
 
virtual ~wallCellWallFunctionFvPatchScalarField ()
 Destructor. More...
 
virtual void operator= (const UList< Type > &)
 Inherit assignment. More...
 
virtual void operator= (const fvPatchField< Type > &)
 Inherit assignment. More...
 
virtual void operator= (const Type &)
 Inherit assignment. More...
 

Additional Inherited Members

- Protected Member Functions inherited from wallCellWallFunctionFvPatchScalarField
label masterPatchIndex () const
 Return the master patch index. More...
 
const labelList & wallCells () const
 Return the wall cell indices. More...
 
const scalarField & wallCellFraction () const
 Return the wall cell fractions. More...
 
void initMaster ()
 Initialise the master cell indices and fractions, and allocate the. More...
 
tmp< scalarField > patchFieldsToWallCellField (const PtrList< scalarField > &pfs) const
 Average a set of patch fields into a wall cell field. More...
 
- Static Protected Member Functions inherited from wallCellWallFunctionFvPatchScalarField
static void patchFieldAddToCellField (const fvPatch &fvp, const scalarField &pf, scalarField &vf)
 Sum values from a patch field into a cell field. More...
 

Detailed Description

This boundary condition provides a turbulence dissipation wall constraint for low- and high-Reynolds number turbulence models.

The condition can be applied to wall boundaries for which it

  • calculates epsilon and G
  • specifies the near-wall epsilon value

where

$ epsilon $ = turbulence dissipation field
$ G $ = turbulence generation field

The model switches between laminar and turbulent functions based on the laminar-to-turbulent y+ value derived from the kappa and E specified in the corresponding nutWallFunction.

Usage
Example of the boundary condition specification:
<patchName>
{
    type            epsilonWallFunction;
}
See also
Foam::fixedInternalValueFvPatchField Foam::omegaWallFunctionFvPatchScalarField
Source files

Definition at line 87 of file epsilonWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ epsilonWallFunctionFvPatchScalarField() [1/4]

epsilonWallFunctionFvPatchScalarField ( const fvPatch &  p,
const DimensionedField< scalar, fvMesh > &  iF,
const dictionary &  dict 
)

Construct from patch, internal field and dictionary.

Definition at line 175 of file epsilonWallFunctionFvPatchScalarField.C.

Referenced by epsilonWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ epsilonWallFunctionFvPatchScalarField() [2/4]

epsilonWallFunctionFvPatchScalarField ( const epsilonWallFunctionFvPatchScalarField &  ptf,
const fvPatch &  p,
const DimensionedField< scalar, fvMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

epsilonWallFunctionFvPatchScalarField onto a new patch

Definition at line 189 of file epsilonWallFunctionFvPatchScalarField.C.

◆ epsilonWallFunctionFvPatchScalarField() [3/4]

Disallow copy without setting internal field reference.

◆ epsilonWallFunctionFvPatchScalarField() [4/4]

Copy constructor setting internal field reference.

Definition at line 204 of file epsilonWallFunctionFvPatchScalarField.C.

◆ ~epsilonWallFunctionFvPatchScalarField()

virtual ~epsilonWallFunctionFvPatchScalarField ( )
inlinevirtual

Destructor.

Definition at line 170 of file epsilonWallFunctionFvPatchScalarField.H.

Member Function Documentation

◆ TypeName()

TypeName ( "epsilonWallFunction"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, fvMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from wallCellWallFunctionFvPatchScalarField.

Definition at line 157 of file epsilonWallFunctionFvPatchScalarField.H.

References epsilonWallFunctionFvPatchScalarField::epsilonWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ map()

void map ( const fvPatchScalarField &  ptf,
const fieldMapper &  mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Reimplemented from wallCellWallFunctionFvPatchScalarField.

Definition at line 219 of file epsilonWallFunctionFvPatchScalarField.C.

References wallCellWallFunctionFvPatchScalarField::map().

Here is the call graph for this function:

◆ reset()

void reset ( const fvPatchScalarField &  ptf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Reimplemented from wallCellWallFunctionFvPatchScalarField.

Definition at line 231 of file epsilonWallFunctionFvPatchScalarField.C.

References wallCellWallFunctionFvPatchScalarField::reset().

Here is the call graph for this function:

◆ updateCoeffs()

void updateCoeffs ( )
virtual

Update the coefficients associated with the patch field.

Definition at line 242 of file epsilonWallFunctionFvPatchScalarField.C.

References Foam::operator==(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ manipulateMatrix()

void manipulateMatrix ( fvMatrix< scalar > &  matrix)
virtual

Manipulate matrix.

Definition at line 259 of file epsilonWallFunctionFvPatchScalarField.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, and fvPatchField< Type >::manipulateMatrix().

Here is the call graph for this function:

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