Public Member Functions | List of all members
atmBoundaryLayerInletEpsilonFvPatchScalarField Class Reference

This boundary condition specifies an inlet value for the turbulence dissipation, $\epsilon$, appropriate for atmospheric boundary layers. More...

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

Public Member Functions

 TypeName ("atmBoundaryLayerInletEpsilon")
 Runtime type information. More...
 
 atmBoundaryLayerInletEpsilonFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 atmBoundaryLayerInletEpsilonFvPatchScalarField (const atmBoundaryLayerInletEpsilonFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 atmBoundaryLayerInletEpsilonFvPatchScalarField (const atmBoundaryLayerInletEpsilonFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchScalarField > clone (const DimensionedField< scalar, volMesh > &iF) const
 Construct and return a clone setting internal field reference. 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 write (Ostream &) const
 Write. More...
 
- Public Member Functions inherited from atmBoundaryLayer
 atmBoundaryLayer ()
 Construct null. More...
 
 atmBoundaryLayer (const vector &flowDir, const vector &zDir, const scalar Uref, const scalar Zref, const scalarField &z0, const scalarField &zGround, const scalar kappa=kappaDefault_, const scalar Cmu=CmuDefault_, const scalar ULower=0, const scalar kLower=0, const scalar epsilonLower=0)
 Construct from components. More...
 
 atmBoundaryLayer (const vectorField &p, const dictionary &)
 Construct from the coordinates field and dictionary. More...
 
 atmBoundaryLayer (const atmBoundaryLayer &, const fieldMapper &)
 Construct by mapping given. More...
 
 atmBoundaryLayer (const atmBoundaryLayer &)
 Copy constructor. More...
 
const vector & flowDir () const
 Return flow direction. More...
 
const vector & zDir () const
 Return z-direction. More...
 
const scalarField & Ustar () const
 Return friction velocity. More...
 
void map (const atmBoundaryLayer &, const fieldMapper &)
 Map the given atmBoundaryLayer onto this atmBoundaryLayer. More...
 
void reset (const atmBoundaryLayer &)
 Reset the atmBoundaryLayer to the given atmBoundaryLayer. More...
 
tmp< vectorField > U (const vectorField &p) const
 Return the velocity distribution for the ATM. More...
 
tmp< scalarField > k (const vectorField &p) const
 Return the turbulent kinetic energy distribution for the ATM. More...
 
tmp< scalarField > epsilon (const vectorField &p) const
 Return the turbulent dissipation rate distribution for the ATM. More...
 
void write (Ostream &) const
 Write. More...
 

Detailed Description

This boundary condition specifies an inlet value for the turbulence dissipation, $\epsilon$, appropriate for atmospheric boundary layers.

See Foam::atmBoundaryLayer for details.

Example of the boundary condition specification: 

ground
{
    type            atmBoundaryLayerInletEpsilon;
    flowDir         (1 0 0);
    zDir            (0 0 1);
    Uref            10.0;
    Zref            20.0;
    z0              uniform 0.1;
    zGround         uniform 0.0;
}
See also
Foam::atmBoundaryLayer, Foam::atmBoundaryLayerInletVelocityFvPatchVectorField, Foam::atmBoundaryLayerInletKFvPatchScalarField
Source files

Definition at line 72 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletEpsilonFvPatchScalarField() [1/3]

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

Construct from patch, internal field and dictionary.

Definition at line 39 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References dict, DimensionedField< Type, GeoMesh, PrimitiveField >::dimensions(), atmBoundaryLayer::epsilon(), Field< scalar >::operator, Field< scalar >::operator=(), and p.

Referenced by atmBoundaryLayerInletEpsilonFvPatchScalarField::clone().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ atmBoundaryLayerInletEpsilonFvPatchScalarField() [2/3]

atmBoundaryLayerInletEpsilonFvPatchScalarField ( const atmBoundaryLayerInletEpsilonFvPatchScalarField &  psf,
const fvPatch &  p,
const DimensionedField< scalar, volMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

atmBoundaryLayerInletEpsilonFvPatchScalarField onto a new patch

Definition at line 70 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

◆ atmBoundaryLayerInletEpsilonFvPatchScalarField() [3/3]

atmBoundaryLayerInletEpsilonFvPatchScalarField ( const atmBoundaryLayerInletEpsilonFvPatchScalarField &  psf,
const DimensionedField< scalar, volMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 84 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmBoundaryLayerInletEpsilon"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 112 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.H.

References atmBoundaryLayerInletEpsilonFvPatchScalarField::atmBoundaryLayerInletEpsilonFvPatchScalarField().

Here is the call graph for this function:

◆ map()

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

Map the given fvPatchField onto this fvPatchField.

Definition at line 98 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References atmBoundaryLayer::map().

Here is the call graph for this function:

◆ reset()

void reset ( const fvPatchScalarField &  psf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 113 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References atmBoundaryLayer::reset().

Here is the call graph for this function:

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 127 of file atmBoundaryLayerInletEpsilonFvPatchScalarField.C.

References atmBoundaryLayer::write(), fvPatchField< Type >::write(), and Foam::writeEntry().

Here is the call graph for this function:
The documentation for this class was generated from the following files: