Public Member Functions | List of all members
atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField Class Reference

This boundary condition specifies an inlet value for the turbulent kinetic energy, $k$, for an atmospheric boundary layer. More...

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

Public Member Functions

 TypeName ("atmosphericBoundaryLayerTurbulentKineticEnergy")
 Runtime type information. More...
 
 atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
 Construct from patch, internal field and dictionary. More...
 
 atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField (const atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
 Construct by mapping given. More...
 
 atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField (const atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
 Construct as copy 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 void write (Ostream &) const
 Write. More...
 

Detailed Description

This boundary condition specifies an inlet value for the turbulent kinetic energy, $k$, for an atmospheric boundary layer.

See Foam::atmosphericBoundaryLayer for details.

See also
Foam::atmosphericBoundaryLayer Foam::atmosphericBoundaryLayerVelocityFvPatchVectorField Foam::atmosphericBoundaryLayerTurbulentEpsilonFvPatchScalarField
Source files

Definition at line 57 of file atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField() [1/3]

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

Construct from patch, internal field and dictionary.

Definition at line 37 of file atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField() [2/3]

atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField ( const atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField &  psf,
const fvPatch &  p,
const DimensionedField< scalar, fvMesh > &  iF,
const fieldMapper &  mapper 
)

Construct by mapping given.

atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField onto a new patch

Definition at line 70 of file atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField.C.

◆ atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField() [3/3]

atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField ( const atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField &  psf,
const DimensionedField< scalar, fvMesh > &  iF 
)

Construct as copy setting internal field reference.

Definition at line 83 of file atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmosphericBoundaryLayerTurbulentKineticEnergy"  )

Runtime type information.

◆ clone()

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

Construct and return a clone setting internal field reference.

Definition at line 99 of file atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField.H.

◆ write()

void write ( Ostream &  os) const
virtual

Write.

Definition at line 96 of file atmosphericBoundaryLayerTurbulentKineticEnergyFvPatchScalarField.C.

References 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: