This boundary condition provides a turbulent kinematic viscosity for atmospheric velocity profiles. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition. The values are calculated using: More...

Inheritance diagram for nutkAtmRoughWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutkAtmRoughWallFunctionFvPatchScalarField:

[legend]

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

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

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

	nutkAtmRoughWallFunctionFvPatchScalarField (const nutkAtmRoughWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given. More...

	nutkAtmRoughWallFunctionFvPatchScalarField (const nutkAtmRoughWallFunctionFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	nutkAtmRoughWallFunctionFvPatchScalarField (const nutkAtmRoughWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor 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...

scalarField &	z0 ()

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	reset (const fvPatchScalarField &)
	Reset the fvPatchField to the given 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 &)
	Construct by mapping given. More...

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

virtual tmp< scalarField >	yPlus () const
	Calculate and return the yPlus at the boundary. 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 &)
	Construct by mapping given. More...

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Copy constructor setting internal field reference. More...

scalar	Cmu () const
	Return Cmu. More...

scalar	kappa () const
	Return kappa. More...

scalar	E () const
	Return E. More...

scalar	yPlusLam () const
	Return the Y+ at the edge of the laminar sublayer. More...

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

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

Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual void	checkType ()
	Check the type of the patch. More...

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

Protected Attributes
scalarField	z0_
	Surface roughness length. More...

Protected Attributes inherited from nutWallFunctionFvPatchScalarField
scalar	Cmu_
	Cmu coefficient. More...

scalar	kappa_
	Von Karman constant. More...

scalar	E_
	E coefficient. More...

scalar	yPlusLam_
	Y+ at the edge of the laminar sublayer. More...

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

static scalar	yPlusLam (const scalar kappa, const scalar E)
	Calculate the Y+ at the edge of the laminar sublayer. More...

Detailed Description

This boundary condition provides a turbulent kinematic viscosity for atmospheric velocity profiles. It is designed to be used in conjunction with the atmBoundaryLayerInletVelocity boundary condition. The values are calculated using:

$U = frac{U_f}{\kappa} ln(\frac{z + z_0}{z_0})$

where

	=	frictional velocity
$\kappa$	=	Von Karman's constant
	=	surface roughness length
	=	vertical co-ordinate

Usage

Property	Description	Required	Default value
`z0`	surface roughness length	yes

Example of the boundary condition specification:

    <patchName>
    {
        type            nutkAtmRoughWallFunction;
        z0              uniform 0;
    }

See also: Foam::nutkWallFunctionFvPatchField

Source files

Definition at line 108 of file nutkAtmRoughWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 92 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::clone(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), and nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the caller graph for this function:

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 104 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given.

nutkAtmRoughWallFunctionFvPatchScalarField onto a new patch

Definition at line 117 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [4/5]

nutkAtmRoughWallFunctionFvPatchScalarField ( const nutkAtmRoughWallFunctionFvPatchScalarField & )

delete

Disallow copy without setting internal field reference.

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [5/5]

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

Copy constructor setting internal field reference.

Definition at line 131 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::autoMap().

Here is the call graph for this function:

Member Function Documentation

◆ nut()

tmp< scalarField > nut ( ) const

protectedvirtual

Calculate the turbulence viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 39 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::Cmu_, Foam::e, Foam::endl(), forAll, Foam::constant::atomic::group, IOobject::groupName(), Foam::Info, k, momentumTransportModel::k(), nutWallFunctionFvPatchScalarField::kappa_, Foam::log(), Foam::max(), momentumTransportModel::nu(), nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField::nutw(), patchi, Foam::pow025(), tmp< T >::ref(), Foam::sqrt(), y, momentumTransportModel::y(), nutkWallFunctionFvPatchScalarField::yPlus(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutkAtmRoughWallFunction" )

Runtime type information.

◆ clone()

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 175 of file nutkAtmRoughWallFunctionFvPatchScalarField.H.

References nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ z0()

scalarField& z0 ( )

inline

Definition at line 191 of file nutkAtmRoughWallFunctionFvPatchScalarField.H.

References nutkAtmRoughWallFunctionFvPatchScalarField::autoMap(), nutkAtmRoughWallFunctionFvPatchScalarField::reset(), nutkAtmRoughWallFunctionFvPatchScalarField::rmap(), nutkAtmRoughWallFunctionFvPatchScalarField::write(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

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 144 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References nutkAtmRoughWallFunctionFvPatchScalarField::rmap(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::nutkAtmRoughWallFunctionFvPatchScalarField(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0().

Here is the call graph for this function:

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

References nutkAtmRoughWallFunctionFvPatchScalarField::reset(), Field< Type >::rmap(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::autoMap(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ reset()

void reset ( const fvPatchScalarField & ptf )

virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Definition at line 169 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References Field< Type >::reset(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::rmap(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 182 of file nutkAtmRoughWallFunctionFvPatchScalarField.C.

References Foam::makePatchTypeField(), fvPatchField< Type >::write(), Foam::writeEntry(), nutWallFunctionFvPatchScalarField::writeLocalEntries(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0_.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::z0().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ z0_

scalarField z0_

protected

Surface roughness length.

Definition at line 117 of file nutkAtmRoughWallFunctionFvPatchScalarField.H.

Referenced by nutkAtmRoughWallFunctionFvPatchScalarField::autoMap(), nutkAtmRoughWallFunctionFvPatchScalarField::nut(), nutkAtmRoughWallFunctionFvPatchScalarField::reset(), nutkAtmRoughWallFunctionFvPatchScalarField::rmap(), nutkAtmRoughWallFunctionFvPatchScalarField::write(), and nutkAtmRoughWallFunctionFvPatchScalarField::z0().

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

src/atmosphericModels/derivedFvPatchFields/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.H
src/atmosphericModels/derivedFvPatchFields/nutkAtmRoughWallFunction/nutkAtmRoughWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [1/5]

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [2/5]

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [3/5]

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [4/5]

◆ nutkAtmRoughWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ nut()

◆ TypeName()

◆ clone()

◆ z0()

◆ autoMap()

◆ rmap()

◆ reset()

◆ write()

Member Data Documentation

◆ z0_