This boundary condition specifies an inlet value for the turbulence kinetic energy, $k$ , 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 > &)
	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 &)
	Construct by mapping given. More...

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	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 ()
	Construct null. 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 &)
	Construct as copy. 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	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 &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, $k$ , 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/4]

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

Construct from patch and internal field.

Definition at line 41 of file atmBoundaryLayerInletKFvPatchScalarField.C.

Referenced by atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), and atmBoundaryLayerInletKFvPatchScalarField::clone().

Here is the caller graph for this function:

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

References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), dictionary::found(), k, dictionary::lookupOrDefault(), Field< scalar >::operator=(), and fvPatch::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 81 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField().

Here is the call graph for this function:

◆ atmBoundaryLayerInletKFvPatchScalarField() [4/4]

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

Construct as copy setting internal field reference.

Definition at line 95 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayerInletKFvPatchScalarField::autoMap().

Here is the call graph for this function:

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

References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField().

Here is the call graph for this function:

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

References atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), atmBoundaryLayerInletKFvPatchScalarField::autoMap(), atmBoundaryLayerInletKFvPatchScalarField::rmap(), and atmBoundaryLayerInletKFvPatchScalarField::write().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

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

Definition at line 108 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::autoMap(), and atmBoundaryLayerInletKFvPatchScalarField::rmap().

Referenced by atmBoundaryLayerInletKFvPatchScalarField::atmBoundaryLayerInletKFvPatchScalarField(), and atmBoundaryLayerInletKFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller 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 118 of file atmBoundaryLayerInletKFvPatchScalarField.C.

References atmBoundaryLayer::rmap().

Referenced by atmBoundaryLayerInletKFvPatchScalarField::autoMap(), and atmBoundaryLayerInletKFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Definition at line 132 of file atmBoundaryLayerInletKFvPatchScalarField.C.

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

Referenced by atmBoundaryLayerInletKFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller 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/4]

◆ atmBoundaryLayerInletKFvPatchScalarField() [2/4]

◆ atmBoundaryLayerInletKFvPatchScalarField() [3/4]

◆ atmBoundaryLayerInletKFvPatchScalarField() [4/4]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ write()