This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy (i.e. k) and velocity (i.e. U) for atmospheric boundary layer modelling. More...

Inheritance diagram for atmNutWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for atmNutWallFunctionFvPatchScalarField:

[legend]

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

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

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

	atmNutWallFunctionFvPatchScalarField (const atmNutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)

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

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	atmNutWallFunctionFvPatchScalarField (const atmNutWallFunctionFvPatchScalarField &, 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 nutkWallFunctionFvPatchScalarField
	TypeName ("nutkWallFunction")
	Runtime type information. More...

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

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

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)

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

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, 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 tmp< scalarField >	yPlus () const
	Calculate and return the yPlus at the boundary. More...

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

Public Member Functions inherited from nutWallFunctionFvPatchScalarField
	TypeName ("nutWallFunction")
	Runtime type information. More...

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

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

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)

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

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< scalarField >	yPlus () const =0
	Calculate and return the yPlus at the boundary. More...

const wallFunctionCoefficients &	wallCoeffs () const noexcept
	Return wallFunctionCoefficients. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

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

Protected Member Functions
virtual tmp< scalarField >	calcNut () const
	Calculate the turbulent viscosity. More...

void	writeLocalEntries (Ostream &) const
	Write local wall function variables. More...

Protected Member Functions inherited from nutkWallFunctionFvPatchScalarField
virtual tmp< scalarField >	calcNut () const
	Calculate the turbulent viscosity. More...

void	writeLocalEntries (Ostream &) const
	Write local wall function variables. More...

Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorField &	U (const turbulenceModel &turb) const

virtual void	checkType ()
	Check the type of the patch. More...

virtual tmp< scalarField >	calcNut () const =0
	Calculate the turbulent viscosity. More...

void	writeLocalEntries (Ostream &) const
	Write local wall function variables. More...

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarField &	nutw (const turbulenceModel &turbModel, const label patchi)
	Return the nut patchField for the given wall patch. More...

Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word	UName_
	Name of velocity field. More...

wallFunctionCoefficients	wallCoeffs_
	Wall-function coefficients. More...

Detailed Description

This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy (i.e. k) and velocity (i.e. U) for atmospheric boundary layer modelling.

The governing equation of the boundary condition:

\[ \tau_w = {U^*_u} {U^*_k} \]

with

\[ {U^*_u} = \frac{\kappa U_w}{ln(z_p / z_0)} \]

\[ {U^*_k} = C_{\mu}^{1/4} \sqrt{k} \]

where

\( \tau_w \)	=	wall shear stress
\( U^*_u \)	=	local friction velocity based on near-ground velocity
\( U^*_k \)	=	local friction velocity based on near-ground k
\( \kappa \)	=	von Kármán constant
\( U_w \)	=	near-ground velocity
\( z_p \)	=	vertical coordinate
\( z_0 \)	=	surface roughness length [m]
\( C_mu \)	=	empirical model constant
\( k \)	=	turbulent kinetic energy

References:

        Theoretical expressions (tags:RH, SBJM, SM):
            Richards, P. J., & Hoxey, R. P. (1993).
            Appropriate boundary conditions for computational wind
            engineering models using the k-ε turbulence model.
            In Computational Wind Engineering 1 (pp. 145-153).
            DOI:10.1016/B978-0-444-81688-7.50018-8

            Sørensen, N. N., Bechmann, A., Johansen, J., Myllerup, L.,
            Botha, P., Vinther, S., & Nielsen, B. S. (2007).
            Identification of severe wind conditions using
            a Reynolds Averaged Navier-Stokes solver.
            In Journal of Physics: Conference
            series (Vol. 75, No. 1, p. 012053).
            DOI:10.1088/1742-6596/75/1/012053

            Sumner, J., & Masson, C. (2012).
            k−ε simulations of the neutral atmospheric boundary layer:
            analysis and correction of discretization errors on practical grids.
            International journal for numerical
            methods in fluids, 70(6), 724-741.
            DOI:10.1002/fld.2709

Required fields:

      nut     | Turbulent viscosity      [m2/s]
      k       | Turbulent kinetic energy [m2/s2]

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            atmNutWallFunction;
    z0Min           <scalar>;
    z0              <PatchFunction1<scalar>>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: nutAtmWallFunction	word	yes	-
`z0Min`	Minimum surface roughness length [m]	scalar	yes	-
`z0`	Surface roughness length [m]	PatchFunction1<scalar>	yes	-

The inherited entries are elaborated in:

Source files

Definition at line 204 of file atmNutWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmNutWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 131 of file atmNutWallFunctionFvPatchScalarField.C.

◆ atmNutWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 157 of file atmNutWallFunctionFvPatchScalarField.C.

◆ atmNutWallFunctionFvPatchScalarField() [3/5]

atmNutWallFunctionFvPatchScalarField	(	const atmNutWallFunctionFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Construct by mapping given atmNutWallFunctionFvPatchScalarField onto a new patch

Definition at line 143 of file atmNutWallFunctionFvPatchScalarField.C.

◆ atmNutWallFunctionFvPatchScalarField() [4/5]

atmNutWallFunctionFvPatchScalarField ( const atmNutWallFunctionFvPatchScalarField & rwfpsf )

Construct as copy.

Definition at line 178 of file atmNutWallFunctionFvPatchScalarField.C.

◆ atmNutWallFunctionFvPatchScalarField() [5/5]

atmNutWallFunctionFvPatchScalarField	(	const atmNutWallFunctionFvPatchScalarField &	rwfpsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 189 of file atmNutWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Calculate the turbulent viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 43 of file atmNutWallFunctionFvPatchScalarField.C.

References wallFunctionCoefficients::Cmu(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::groupName(), k, wallFunctionCoefficients::kappa(), Foam::log(), Foam::mag(), magUp, Foam::max(), Time::New(), nutWallFunctionFvPatchScalarField::nutw(), fvPatchField< Type >::patchInternalField(), Foam::pow025(), turbulenceModel::propertiesName, Foam::sqrt(), tauw, nutWallFunctionFvPatchScalarField::wallCoeffs_, and y.

Here is the call graph for this function:

◆ writeLocalEntries()

void writeLocalEntries ( Ostream & os ) const

protected

Write local wall function variables.

Definition at line 115 of file atmNutWallFunctionFvPatchScalarField.C.

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

Referenced by atmNutWallFunctionFvPatchScalarField::write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "atmNutWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 270 of file atmNutWallFunctionFvPatchScalarField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 286 of file atmNutWallFunctionFvPatchScalarField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

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

Definition at line 203 of file atmNutWallFunctionFvPatchScalarField.C.

References atmBoundaryLayer::autoMap().

Here is the call graph for this function:

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 217 of file atmNutWallFunctionFvPatchScalarField.C.

References atmBoundaryLayer::rmap().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 235 of file atmNutWallFunctionFvPatchScalarField.C.

References os(), ObukhovLength::write(), and atmNutWallFunctionFvPatchScalarField::writeLocalEntries().

Here is the call graph for this function:

The documentation for this class was generated from the following files:

src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutWallFunction/atmNutWallFunctionFvPatchScalarField.H
src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutWallFunction/atmNutWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ atmNutWallFunctionFvPatchScalarField() [1/5]

◆ atmNutWallFunctionFvPatchScalarField() [2/5]

◆ atmNutWallFunctionFvPatchScalarField() [3/5]

◆ atmNutWallFunctionFvPatchScalarField() [4/5]

◆ atmNutWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ calcNut()

◆ writeLocalEntries()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ write()