This boundary condition specifies an inlet value for the turbulence kinetic energy, , appropriate for atmospheric boundary layers. More...

Inheritance diagram for atmBoundaryLayerInletKFvPatchScalarField:

[legend]

Collaboration diagram for atmBoundaryLayerInletKFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("atmBoundaryLayerInletK")
	Runtime type information. More...

	atmBoundaryLayerInletKFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	atmBoundaryLayerInletKFvPatchScalarField (const atmBoundaryLayerInletKFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	atmBoundaryLayerInletKFvPatchScalarField (const atmBoundaryLayerInletKFvPatchScalarField &, 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 fvPatchFieldMapper &)
	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 fvPatchFieldMapper &)
	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 fvPatchFieldMapper &)
	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 kinetic energy, , appropriate for atmospheric boundary layers.

See Foam::atmBoundaryLayer for details.

Example of the boundary condition specification:

ground
{
    type            atmBoundaryLayerInletK;
    z               (0 0 1);
    Uref            10.0;
    Zref            20.0;
    z0              uniform 0.1;
    zGround         uniform 0.0;
}

See also: Foam::atmBoundaryLayer, Foam::atmBoundaryLayerInletVelocityFvPatchVectorField, Foam::atmBoundaryLayerInletEpsilonFvPatchScalarField

Source files

Definition at line 71 of file atmBoundaryLayerInletKFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletKFvPatchScalarField() [1/3]

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

Construct from patch, internal field and dictionary.

Definition at line 39 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References dict, atmBoundaryLayer::k(), Field< scalar >::operator=(), and p.

Referenced by atmBoundaryLayerInletKFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmBoundaryLayerInletKFvPatchScalarField() [2/3]

atmBoundaryLayerInletKFvPatchScalarField	(	const atmBoundaryLayerInletKFvPatchScalarField &	psf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given.

atmBoundaryLayerInletKFvPatchScalarField onto a new patch

Definition at line 67 of file atmBoundaryLayerInletKFvPatchScalarField.C.

◆ atmBoundaryLayerInletKFvPatchScalarField() [3/3]

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

Construct as copy setting internal field reference.

Definition at line 81 of file atmBoundaryLayerInletKFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmBoundaryLayerInletK" )

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 111 of file atmBoundaryLayerInletKFvPatchScalarField.H.

References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField().

Here is the call graph for this function:

◆ map()

void map	(	const fvPatchScalarField &	psf,
		const fvPatchFieldMapper &	mapper
	)

virtual

Map the given fvPatchField onto this fvPatchField.

Definition at line 95 of file atmBoundaryLayerInletKFvPatchScalarField.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 110 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::reset().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 124 of file atmBoundaryLayerInletKFvPatchScalarField.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:

src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayerInletK/atmBoundaryLayerInletKFvPatchScalarField.H
src/atmosphericModels/derivedFvPatchFields/atmBoundaryLayerInletK/atmBoundaryLayerInletKFvPatchScalarField.C

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletKFvPatchScalarField() [1/3]

◆ atmBoundaryLayerInletKFvPatchScalarField() [2/3]

◆ atmBoundaryLayerInletKFvPatchScalarField() [3/3]

Member Function Documentation

◆ TypeName()

◆ clone()

◆ map()

◆ reset()

◆ write()