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...

Inheritance diagram for atmNutUWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for atmNutUWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("atmNutUWallFunction")

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

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

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

	atmNutUWallFunctionFvPatchScalarField (const atmNutUWallFunctionFvPatchScalarField &)

virtual tmp< fvPatchScalarField >	clone () const

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

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

virtual void	autoMap (const fvPatchFieldMapper &)

virtual void	rmap (const fvPatchScalarField &, const labelList &)

virtual void	write (Ostream &) const

Public Member Functions inherited from nutUWallFunctionFvPatchScalarField
	TypeName ("nutUWallFunction")

	nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)

	nutUWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)

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

	nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &)

	nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)

virtual tmp< scalarField >	yPlus () const

Public Member Functions inherited from nutWallFunctionFvPatchScalarField
	TypeName ("nutWallFunction")

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

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

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

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)

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

scalar	Cmu () const

scalar	kappa () const

scalar	E () const

scalar	yPlusLam () const

scalar	blend (const scalar nutVis, const scalar nutLog, const scalar yPlus) const

virtual void	updateCoeffs ()

Protected Member Functions
virtual tmp< scalarField >	calcNut () const

Protected Member Functions inherited from nutUWallFunctionFvPatchScalarField
virtual tmp< scalarField >	calcYPlus (const scalarField &magUp) const

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

virtual void	checkType ()

virtual void	writeLocalEntries (Ostream &) const

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static const nutWallFunctionFvPatchScalarField &	nutw (const turbulenceModel &turbModel, const label patchi)

static scalar	yPlusLam (const scalar kappa, const scalar E)

Protected Types inherited from nutWallFunctionFvPatchScalarField
enum	blendingType { STEPWISE, MAX, BINOMIAL, EXPONENTIAL }

Protected Attributes inherited from nutWallFunctionFvPatchScalarField
enum blendingType	blending_

const scalar	n_

word	UName_

scalar	Cmu_

scalar	kappa_

scalar	E_

scalar	yPlusLam_

Static Protected Attributes inherited from nutWallFunctionFvPatchScalarField
static const Enum< blendingType >	blendingTypeNames

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 (unmodifiable)
    type            atmNutUWallFunction;

    // Mandatory entries (runtime modifiable)
    z0              uniform 0.001;

    // Optional entries (unmodifiable)
    boundNut        true;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`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:

See also

Source files

Definition at line 149 of file atmNutUWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ atmNutUWallFunctionFvPatchScalarField() [1/5]

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

Definition at line 97 of file atmNutUWallFunctionFvPatchScalarField.C.

Referenced by atmNutUWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ atmNutUWallFunctionFvPatchScalarField() [2/5]

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

Definition at line 123 of file atmNutUWallFunctionFvPatchScalarField.C.

◆ atmNutUWallFunctionFvPatchScalarField() [3/5]

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

Definition at line 109 of file atmNutUWallFunctionFvPatchScalarField.C.

◆ atmNutUWallFunctionFvPatchScalarField() [4/5]

atmNutUWallFunctionFvPatchScalarField ( const atmNutUWallFunctionFvPatchScalarField & rwfpsf )

Definition at line 136 of file atmNutUWallFunctionFvPatchScalarField.C.

◆ atmNutUWallFunctionFvPatchScalarField() [5/5]

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

Definition at line 147 of file atmNutUWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 35 of file atmNutUWallFunctionFvPatchScalarField.C.

References GeometricField::boundaryField(), Foam::constant::electromagnetic::e, Foam::exit(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::constant::atomic::group, IOobject::groupName(), nutWallFunctionFvPatchScalarField::kappa_, Foam::log(), Foam::mag(), Foam::max(), tmp::New(), nutWallFunctionFvPatchScalarField::nutw(), Foam::foamVersion::patch, fvPatchField::patchInternalField(), turbulenceModel::propertiesName, Foam::sqr(), nutWallFunctionFvPatchScalarField::U(), and y.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "atmNutUWallFunction" )

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 212 of file atmNutUWallFunctionFvPatchScalarField.H.

References atmNutUWallFunctionFvPatchScalarField::atmNutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 229 of file atmNutUWallFunctionFvPatchScalarField.H.

References atmNutUWallFunctionFvPatchScalarField::atmNutUWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Definition at line 161 of file atmNutUWallFunctionFvPatchScalarField.C.

◆ rmap()

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

virtual

Definition at line 171 of file atmNutUWallFunctionFvPatchScalarField.C.

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from nutUWallFunctionFvPatchScalarField.

Definition at line 185 of file atmNutUWallFunctionFvPatchScalarField.C.

References os(), fvPatchField::write(), and nutWallFunctionFvPatchScalarField::writeLocalEntries().

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()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ write()