This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy (i.e. k) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling. 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 > &)
	Construct from patch and internal field. 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 &)

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. 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	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from atmBoundaryLayer
	atmBoundaryLayer (const Time &time, const polyPatch &pp)
	Construct null from time. More...

	atmBoundaryLayer (const Time &time, const polyPatch &pp, const dictionary &dict)
	Construct from the time database and dictionary. More...

	atmBoundaryLayer (const atmBoundaryLayer &abl, const fvPatch &patch, const fvPatchFieldMapper &mapper)
	Construct by mapping given atmBoundaryLayer onto a new patch. More...

	atmBoundaryLayer (const atmBoundaryLayer &)
	Construct as copy. More...

vector	flowDir () const
	Return flow direction. More...

vector	zDir () const
	Return the ground-normal direction. More...

tmp< scalarField >	Ustar (const scalarField &z0) const
	Return friction velocity. More...

void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

void	rmap (const atmBoundaryLayer &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

tmp< vectorField >	U (const vectorField &pCf) const
	Return the velocity distribution for the ATM. More...

tmp< scalarField >	k (const vectorField &pCf) const
	Return the turbulent kinetic energy distribution for the ATM. More...

tmp< scalarField >	epsilon (const vectorField &pCf) const
	Return the turbulent dissipation rate distribution for the ATM. More...

tmp< scalarField >	omega (const vectorField &pCf) const
	Return the specific dissipation rate distribution for the ATM. More...

void	write (Ostream &) const
	Write. More...

Additional Inherited Members
Protected Attributes inherited from atmBoundaryLayer
bool	initABL_

Detailed Description

This boundary condition provides a log-law type ground-normal inlet boundary condition for the turbulent kinetic energy (i.e. k) for homogeneous, two-dimensional, dry-air, equilibrium and neutral atmospheric boundary layer modelling.

The ground-normal k profile expression:

\[ k = \frac{(u^*)^2}{\sqrt{C_\mu}} \sqrt{C_1 \ln \left( \frac{z - d + z_0}{z_0} \right) + C_2} \]

where

\( k \)	=	Ground-normal turbulent kinetic energy profile [m^2/s^3]
\( u^* \)	=	Friction velocity [m/s]
\( C_\mu \)	=	Empirical model constant [-]
\( C_1 \)	=	Curve-fitting coefficient for `YGCJ` profiles [-]
\( C_2 \)	=	Curve-fitting coefficient for `YGCJ` profiles [-]

Required fields:

        k    | Turbulent kinetic energy                         [m2/s2]

Usage

Example of the boundary condition specification:

inlet
{
    // Mandatory entries (unmodifiable)
    type            atmBoundaryLayerInletK;

    // Mandatory/Optional (inherited) entries (unmodifiable)
    ...
    flowDir         (1 0 0);    // not used
    zDir            (0 0 1);    // not used
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: atmBoundaryLayerInletK	word	yes	-

The inherited entries are elaborated in:

See also

Source files

Definition at line 143 of file atmBoundaryLayerInletKFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletKFvPatchScalarField() [1/4]

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

Construct from patch and internal field.

Definition at line 42 of file atmBoundaryLayerInletKFvPatchScalarField.C.

◆ atmBoundaryLayerInletKFvPatchScalarField() [2/4]

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

Construct from patch, internal field and dictionary.

Definition at line 54 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References dict, dictionary::getOrDefault(), atmBoundaryLayer::initABL_, k, Field< scalar >::operator=(), p, and UList< T >::size().

Here is the call graph for this function:

◆ atmBoundaryLayerInletKFvPatchScalarField() [3/4]

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 83 of file atmBoundaryLayerInletKFvPatchScalarField.C.

◆ atmBoundaryLayerInletKFvPatchScalarField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 97 of file atmBoundaryLayerInletKFvPatchScalarField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "atmBoundaryLayerInletK" )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 183 of file atmBoundaryLayerInletKFvPatchScalarField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Definition at line 199 of file atmBoundaryLayerInletKFvPatchScalarField.H.

◆ updateCoeffs()

void updateCoeffs ( )

virtual

Update the coefficients associated with the patch field.

Definition at line 111 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References k.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Definition at line 124 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap	(	const fvPatchScalarField &	psf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 134 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 149 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References os(), ObukhovLength::write(), and Ostream::writeEntryIfDifferent().

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

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ atmBoundaryLayerInletKFvPatchScalarField() [1/4]

◆ atmBoundaryLayerInletKFvPatchScalarField() [2/4]

◆ atmBoundaryLayerInletKFvPatchScalarField() [3/4]

◆ atmBoundaryLayerInletKFvPatchScalarField() [4/4]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ autoMap()

◆ rmap()

◆ write()