This boundary condition provides a wall function for the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy, (i.e. k) for for low- and high-Reynolds number applications. More...

#include <nutkWallFunctionFvPatchScalarField.H>

Inheritance diagram for nutkWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutkWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("nutkWallFunction")
	Runtime type information.
	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutkWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutkWallFunctionFvPatchScalarField onto a new patch.
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutkWallFunctionFvPatchScalarField (const nutkWallFunctionFvPatchScalarField &, 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 tmp< scalarField >	yPlus () const
	Calculate and return the yPlus at the boundary.
virtual void	write (Ostream &) const
	Write.
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 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 function for the turbulent viscosity (i.e. nut) based on the turbulent kinetic energy, (i.e. k) for for low- and high-Reynolds number applications.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            nutkWallFunction;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: nutkWallFunction	word	yes	-

The inherited entries are elaborated in:

Source files

Definition at line 88 of file nutkWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutkWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 177 of file nutkWallFunctionFvPatchScalarField.C.

References nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), p, and wallFunctionBlenders::wallFunctionBlenders().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nutkWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 201 of file nutkWallFunctionFvPatchScalarField.C.

References dict, nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), p, wallFunctionBlenders::STEPWISE, and wallFunctionBlenders::wallFunctionBlenders().

Here is the call graph for this function:

◆ nutkWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given nutkWallFunctionFvPatchScalarField onto a new patch.

Definition at line 188 of file nutkWallFunctionFvPatchScalarField.C.

References nutkWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), p, and wallFunctionBlenders::wallFunctionBlenders().

Here is the call graph for this function:

◆ nutkWallFunctionFvPatchScalarField() [4/5]

nutkWallFunctionFvPatchScalarField ( const nutkWallFunctionFvPatchScalarField & wfpsf )

Construct as copy.

Definition at line 213 of file nutkWallFunctionFvPatchScalarField.C.

References nutkWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), and wallFunctionBlenders::wallFunctionBlenders().

Here is the call graph for this function:

◆ nutkWallFunctionFvPatchScalarField() [5/5]

nutkWallFunctionFvPatchScalarField	(	const nutkWallFunctionFvPatchScalarField &	wfpsf,
		const DimensionedField< scalar, volMesh > &	iF )

Construct as copy setting internal field reference.

Definition at line 223 of file nutkWallFunctionFvPatchScalarField.C.

References nutkWallFunctionFvPatchScalarField(), nutWallFunctionFvPatchScalarField::nutWallFunctionFvPatchScalarField(), and wallFunctionBlenders::wallFunctionBlenders().

Here is the call graph for this function:

Member Function Documentation

◆ calcNut()

Foam::tmp< Foam::scalarField > calcNut ( ) const

protectedvirtual

Calculate the turbulent viscosity.

Implements nutWallFunctionFvPatchScalarField.

Reimplemented in atmNutkWallFunctionFvPatchScalarField, atmNutWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, and nutkRoughWallFunctionFvPatchScalarField.

Definition at line 31 of file nutkWallFunctionFvPatchScalarField.C.

References wallFunctionBlenders::blender_, e, Foam::exp(), forAll, IOobject::groupName(), k, Foam::log(), Foam::max(), wallFunctionBlenders::n_, tmp< T >::New(), nutWallFunctionFvPatchScalarField::nutw(), Foam::pow(), Foam::pow025(), Foam::pow4(), turbulenceModel::propertiesName, Foam::sqrt(), Foam::tanh(), nutWallFunctionFvPatchScalarField::wallCoeffs_, y, yPlus(), and Foam::Zero.

Here is the call graph for this function:

◆ writeLocalEntries()

void writeLocalEntries ( Ostream & os ) const

protected

Write local wall function variables.

Definition at line 166 of file nutkWallFunctionFvPatchScalarField.C.

References os(), and wallFunctionBlenders::writeEntries().

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "nutkWallFunction" )

Runtime type information.

References nutkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

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

inlinevirtual

Return a clone.

Reimplemented in atmNutkWallFunctionFvPatchScalarField, atmNutWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, and nutkRoughWallFunctionFvPatchScalarField.

Definition at line 170 of file nutkWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call 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 in atmNutkWallFunctionFvPatchScalarField, atmNutWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, and nutkRoughWallFunctionFvPatchScalarField.

Definition at line 178 of file nutkWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ yPlus()

Foam::tmp< Foam::scalarField > yPlus ( ) const

virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Reimplemented in nutkFilmWallFunctionFvPatchScalarField.

Definition at line 236 of file nutkWallFunctionFvPatchScalarField.C.

References forAll, IOobject::groupName(), k, Foam::mag(), tmp< T >::New(), Foam::pow025(), turbulenceModel::propertiesName, fvPatchField< Type >::snGrad(), Foam::sqrt(), U, nutWallFunctionFvPatchScalarField::wallCoeffs_, y, yPlus(), and Foam::Zero.

Referenced by atmNutkWallFunctionFvPatchScalarField::calcNut(), nutkRoughWallFunctionFvPatchScalarField::calcNut(), calcNut(), and yPlus().

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.

Reimplemented in atmNutkWallFunctionFvPatchScalarField, atmNutWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, and nutkRoughWallFunctionFvPatchScalarField.

Definition at line 289 of file nutkWallFunctionFvPatchScalarField.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/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.H
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutkWallFunction/nutkWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutkWallFunctionFvPatchScalarField() [1/5]

◆ nutkWallFunctionFvPatchScalarField() [2/5]

◆ nutkWallFunctionFvPatchScalarField() [3/5]

◆ nutkWallFunctionFvPatchScalarField() [4/5]

◆ nutkWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ calcNut()

◆ writeLocalEntries()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ yPlus()

◆ write()