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

Inheritance diagram for nutkWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutkWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	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 nutkWallFunctionFvPatchScalarField onto a new patch. More...

	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 &)
	Construct by mapping given nutWallFunctionFvPatchScalarField onto a new patch. More...

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

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

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

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. 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 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. More...

virtual void	checkType ()
	Check the type of the patch. 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 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 148 of file nutkWallFunctionFvPatchScalarField.C.

Referenced by nutkWallFunctionFvPatchScalarField::clone().

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 172 of file nutkWallFunctionFvPatchScalarField.C.

◆ 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 159 of file nutkWallFunctionFvPatchScalarField.C.

◆ nutkWallFunctionFvPatchScalarField() [4/5]

nutkWallFunctionFvPatchScalarField ( const nutkWallFunctionFvPatchScalarField & wfpsf )

Construct as copy.

Definition at line 184 of file nutkWallFunctionFvPatchScalarField.C.

◆ nutkWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 194 of file nutkWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

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

protectedvirtual

Calculate the turbulent viscosity.

Implements nutWallFunctionFvPatchScalarField.

Reimplemented in atmNutWallFunctionFvPatchScalarField, atmNutkWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, and nutkRoughWallFunctionFvPatchScalarField.

Definition at line 32 of file nutkWallFunctionFvPatchScalarField.C.

References wallFunctionBlenders::blender_, wallFunctionCoefficients::Cmu(), Foam::constant::electromagnetic::e, wallFunctionCoefficients::E(), Foam::exp(), forAll, Foam::constant::atomic::group, IOobject::groupName(), k, Foam::constant::electromagnetic::kappa, wallFunctionCoefficients::kappa(), Foam::log(), Foam::max(), wallFunctionBlenders::n_, tmp< T >::New(), nutWallFunctionFvPatchScalarField::nutw(), Foam::foamVersion::patch, Foam::pow(), Foam::pow025(), Foam::pow4(), turbulenceModel::propertiesName, Foam::sqrt(), Foam::tanh(), nutWallFunctionFvPatchScalarField::wallCoeffs_, y, nutkWallFunctionFvPatchScalarField::yPlus(), wallFunctionCoefficients::yPlusLam(), 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 137 of file nutkWallFunctionFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutkWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented in atmNutWallFunctionFvPatchScalarField, atmNutkWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, and nutkRoughWallFunctionFvPatchScalarField.

Definition at line 161 of file nutkWallFunctionFvPatchScalarField.H.

References nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in atmNutWallFunctionFvPatchScalarField, atmNutkWallFunctionFvPatchScalarField, nutkFilmWallFunctionFvPatchScalarField, and nutkRoughWallFunctionFvPatchScalarField.

Definition at line 182 of file nutkWallFunctionFvPatchScalarField.H.

References nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField().

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 207 of file nutkWallFunctionFvPatchScalarField.C.

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

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

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 atmNutWallFunctionFvPatchScalarField, atmNutkWallFunctionFvPatchScalarField, nutkRoughWallFunctionFvPatchScalarField, and nutkFilmWallFunctionFvPatchScalarField.

Definition at line 260 of file nutkWallFunctionFvPatchScalarField.C.

References os(), nutWallFunctionFvPatchScalarField::write(), 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()