This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on velocity (i.e. U) for atmospheric boundary layer modelling. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition. More...

#include <atmNutUWallFunctionFvPatchScalarField.H>

Inheritance diagram for atmNutUWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for atmNutUWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("atmNutUWallFunction")
	Runtime type information.
	atmNutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	atmNutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	atmNutUWallFunctionFvPatchScalarField (const atmNutUWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given atmNutUWallFunctionFvPatchScalarField onto a new patch.
	atmNutUWallFunctionFvPatchScalarField (const atmNutUWallFunctionFvPatchScalarField &)
	Construct as copy.
	atmNutUWallFunctionFvPatchScalarField (const atmNutUWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< fvPatchField< scalar > >	clone () const
	Return a clone.
virtual tmp< fvPatchField< scalar > >	clone (const DimensionedField< scalar, volMesh > &iF) const
	Clone with an internal field reference.
virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object.
virtual void	rmap (const fvPatchScalarField &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField.
virtual void	write (Ostream &) const
	Write.
Public Member Functions inherited from nutUWallFunctionFvPatchScalarField
	TypeName ("nutUWallFunction")
	Runtime type information.
	nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutUWallFunctionFvPatchScalarField onto a new patch.
	nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
virtual tmp< scalarField >	yPlus () const
	Calculate and return the yPlus at the boundary.
Public Member Functions inherited from nutWallFunctionFvPatchScalarField
	TypeName ("nutWallFunction")
	Runtime type information.
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutWallFunctionFvPatchScalarField onto a new patch.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference.
const wallFunctionCoefficients &	wallCoeffs () const noexcept
	Return wallFunctionCoefficients.
virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field.

Protected Member Functions
virtual tmp< scalarField >	calcNut () const
	Calculate the turbulent viscosity.
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.
Protected Member Functions inherited from nutUWallFunctionFvPatchScalarField
tmp< scalarField >	calcYPlus (const scalarField &magUp) const
	Calculate yPlus.
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.
Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual const volVectorField &	U (const turbulenceModel &turb) const
	Helper to return the velocity field either from the turbulence model (default) or the mesh database.
virtual void	checkType ()
	Check the type of the patch.
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.

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.
Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word	UName_
	Name of velocity field.
wallFunctionCoefficients	wallCoeffs_
	Wall-function coefficients.

Detailed Description

This boundary condition provides a wall constraint on the turbulent viscosity (i.e. nut) based on velocity (i.e. U) for atmospheric boundary layer modelling. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition.

The governing equation of the boundary condition:

$\‍[ u = \frac{u^*}{\kappa} ln \left(\frac{z + z_0}{z_0}\right) \‍]$

where

	=	Friction velocity
$\kappa$	=	von Kármán constant
	=	Surface roughness length [m]
	=	Ground-normal coordinate

Required fields:

      nut     | Turbulent viscosity         [m2/s]
      U       | Velocity                    [m/s]

Usage

Example of the boundary condition specification:

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

    // Optional entries
    boundNut        true;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: atmNutUWallFunction	word	yes	-
`z0`	Surface roughness length [m]	PatchFunction1<scalar>	yes	-
`boundNut`	Flag: zero-bound nut near wall	bool	no	true

The inherited entries are elaborated in:

Source files

Definition at line 143 of file atmNutUWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmNutUWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 111 of file atmNutUWallFunctionFvPatchScalarField.C.

References nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), and p.

Referenced by atmNutUWallFunctionFvPatchScalarField(), atmNutUWallFunctionFvPatchScalarField(), atmNutUWallFunctionFvPatchScalarField(), rmap(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ atmNutUWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 137 of file atmNutUWallFunctionFvPatchScalarField.C.

References dict, Foam::New(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ atmNutUWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given atmNutUWallFunctionFvPatchScalarField onto a new patch.

Definition at line 123 of file atmNutUWallFunctionFvPatchScalarField.C.

References atmNutUWallFunctionFvPatchScalarField(), clone(), nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField(), and p.

Here is the call graph for this function:

◆ atmNutUWallFunctionFvPatchScalarField() [4/5]

atmNutUWallFunctionFvPatchScalarField ( const atmNutUWallFunctionFvPatchScalarField & rwfpsf )

Construct as copy.

Definition at line 150 of file atmNutUWallFunctionFvPatchScalarField.C.

References atmNutUWallFunctionFvPatchScalarField(), clone(), and nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ atmNutUWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 161 of file atmNutUWallFunctionFvPatchScalarField.C.

References atmNutUWallFunctionFvPatchScalarField(), clone(), and nutUWallFunctionFvPatchScalarField::nutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Calculate the turbulent viscosity.

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 35 of file atmNutUWallFunctionFvPatchScalarField.C.

References e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, IOobject::groupName(), Foam::log(), Foam::mag(), Foam::max(), tmp< T >::New(), nutWallFunctionFvPatchScalarField::nutw(), fvPatchField< Type >::patchInternalField(), turbulenceModel::propertiesName, Foam::sqr(), U, 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 95 of file atmNutUWallFunctionFvPatchScalarField.C.

References os().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "atmNutUWallFunction" )

Runtime type information.

References atmNutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

virtual tmp< fvPatchField< scalar > > clone ( ) const

inlinevirtual

Return a clone.

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 238 of file atmNutUWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Referenced by atmNutUWallFunctionFvPatchScalarField(), atmNutUWallFunctionFvPatchScalarField(), and atmNutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Clone with an internal field reference.

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 246 of file atmNutUWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

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 175 of file atmNutUWallFunctionFvPatchScalarField.C.

◆ rmap()

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

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Definition at line 189 of file atmNutUWallFunctionFvPatchScalarField.C.

References atmNutUWallFunctionFvPatchScalarField(), and Foam::refCast().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 207 of file atmNutUWallFunctionFvPatchScalarField.C.

References os(), nutWallFunctionFvPatchScalarField::write(), writeLocalEntries(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

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

src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutUWallFunction/atmNutUWallFunctionFvPatchScalarField.H
src/atmosphericModels/derivedFvPatchFields/wallFunctions/atmNutUWallFunction/atmNutUWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ atmNutUWallFunctionFvPatchScalarField() [1/5]

◆ atmNutUWallFunctionFvPatchScalarField() [2/5]

◆ atmNutUWallFunctionFvPatchScalarField() [3/5]

◆ atmNutUWallFunctionFvPatchScalarField() [4/5]

◆ atmNutUWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ calcNut()

◆ writeLocalEntries()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ write()