atmBoundaryLayerInletVelocityFvPatchVectorField Class Reference

This boundary condition specifies a velocity inlet profile appropriate for atmospheric boundary layers (ABL). More...

Inheritance diagram for atmBoundaryLayerInletVelocityFvPatchVectorField:
Collaboration diagram for atmBoundaryLayerInletVelocityFvPatchVectorField:

Public Member Functions

 TypeName ("atmBoundaryLayerInletVelocity")
 Runtime type information. More...
 
 atmBoundaryLayerInletVelocityFvPatchVectorField (const fvPatch &, const DimensionedField< vector, volMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 atmBoundaryLayerInletVelocityFvPatchVectorField (const atmBoundaryLayerInletVelocityFvPatchVectorField &, const fvPatch &, const DimensionedField< vector, volMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 atmBoundaryLayerInletVelocityFvPatchVectorField (const atmBoundaryLayerInletVelocityFvPatchVectorField &, const DimensionedField< vector, volMesh > &)
 Construct as copy setting internal field reference. More...
 
virtual tmp< fvPatchVectorFieldclone (const DimensionedField< vector, volMesh > &iF) const
 Construct and return a clone setting internal field reference. More...
 
virtual void map (const fvPatchVectorField &, const fieldMapper &)
 Map the given fvPatchField onto this fvPatchField. More...
 
virtual void reset (const fvPatchVectorField &)
 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 vectorflowDir () const
 Return flow direction. More...
 
const vectorzDir () const
 Return z-direction. More...
 
const scalarFieldUstar () 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< vectorFieldU (const vectorField &p) const
 Return the velocity distribution for the ATM. More...
 
tmp< scalarFieldk (const vectorField &p) const
 Return the turbulent kinetic energy distribution for the ATM. More...
 
tmp< scalarFieldepsilon (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 a velocity inlet profile appropriate for atmospheric boundary layers (ABL).

See Foam::atmBoundaryLayer for details.

Example of the boundary condition specification:

ground
{
    type            atmBoundaryLayerInletVelocity;
    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::atmBoundaryLayerInletKFvPatchScalarField, Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField
Source files

Definition at line 72 of file atmBoundaryLayerInletVelocityFvPatchVectorField.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [1/3]

Construct from patch, internal field and dictionary.

Definition at line 39 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

References dict, DimensionedField< Type, GeoMesh >::dimensions(), Field< vector >::operator, Field< vector >::operator=(), p, atmBoundaryLayer::U(), and Foam::Zero.

Referenced by atmBoundaryLayerInletVelocityFvPatchVectorField::clone().

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

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [2/3]

◆ atmBoundaryLayerInletVelocityFvPatchVectorField() [3/3]

Construct as copy setting internal field reference.

Definition at line 84 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmBoundaryLayerInletVelocity"  )

Runtime type information.

◆ clone()

virtual tmp<fvPatchVectorField> clone ( const DimensionedField< vector, volMesh > &  iF) const
inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 112 of file atmBoundaryLayerInletVelocityFvPatchVectorField.H.

References atmBoundaryLayerInletVelocityFvPatchVectorField::atmBoundaryLayerInletVelocityFvPatchVectorField().

Here is the call graph for this function:

◆ map()

void map ( const fvPatchVectorField pvf,
const fieldMapper mapper 
)
virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 98 of file atmBoundaryLayerInletVelocityFvPatchVectorField.C.

References atmBoundaryLayer::map().

Here is the call graph for this function:

◆ reset()

void reset ( const fvPatchVectorField pvf)
virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 113 of file atmBoundaryLayerInletVelocityFvPatchVectorField.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 atmBoundaryLayerInletVelocityFvPatchVectorField.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: