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

Inheritance diagram for nutUWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutUWallFunctionFvPatchScalarField:

[legend]

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

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

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

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

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

virtual tmp< fvPatchScalarField >	clone () const
	Construct and return a clone. More...

	nutUWallFunctionFvPatchScalarField (const nutUWallFunctionFvPatchScalarField &, 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 &os) 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 &)

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

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

virtual tmp< scalarField >	yPlus () const =0
	Calculate and return the yPlus at the boundary. More...

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

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

virtual void	write (Ostream &) const
	Write. More...

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

tmp< scalarField >	calcYPlus (const scalarField &magUp) const
	Calculate yPlus. 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

virtual void	checkType ()
	Check the type of the patch. More...

virtual tmp< scalarField >	calcNut () const =0
	Calculate the turbulent viscosity. 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 velocity (i.e. U) for low- and high-Reynolds number applications.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            nutUWallFunction;

    // Inherited entries
    ...
}

where the entries mean:

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

The inherited entries are elaborated in:

Note

Suffers from non-exact restart since correctNut() (called through turbulence->validate) returns a slightly different value every time it is called. See nutUSpaldingWallFunctionFvPatchScalarField.C.

Source files

Definition at line 98 of file nutUWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutUWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 205 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 229 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given nutUWallFunctionFvPatchScalarField onto a new patch

Definition at line 216 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [4/5]

nutUWallFunctionFvPatchScalarField ( const nutUWallFunctionFvPatchScalarField & sawfpsf )

Construct as copy.

Definition at line 241 of file nutUWallFunctionFvPatchScalarField.C.

◆ nutUWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 251 of file nutUWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

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

protectedvirtual

Calculate the turbulent viscosity.

Implements nutWallFunctionFvPatchScalarField.

Reimplemented in atmNutUWallFunctionFvPatchScalarField.

Definition at line 39 of file nutUWallFunctionFvPatchScalarField.C.

References wallFunctionBlenders::blender_, nutUWallFunctionFvPatchScalarField::calcYPlus(), e, wallFunctionCoefficients::E(), Foam::exp(), forAll, IOobject::groupName(), wallFunctionCoefficients::kappa(), Foam::log(), Foam::mag(), magUp, Foam::max(), wallFunctionBlenders::n_, Time::New(), nutWallFunctionFvPatchScalarField::nutw(), Foam::pow(), Foam::pow4(), turbulenceModel::propertiesName, Foam::tanh(), U, nutWallFunctionFvPatchScalarField::wallCoeffs_, nutUWallFunctionFvPatchScalarField::yPlus(), wallFunctionCoefficients::yPlusLam(), and Foam::Zero.

Here is the call graph for this function:

◆ calcYPlus()

Foam::tmp< Foam::scalarField > calcYPlus ( const scalarField & magUp ) const

protected

Calculate yPlus.

Definition at line 142 of file nutUWallFunctionFvPatchScalarField.C.

References forAll, IOobject::groupName(), Foam::log(), Foam::mag(), magUp, Foam::max(), Time::New(), turbulenceModel::propertiesName, y, yPlus, and Foam::Zero.

Referenced by nutUWallFunctionFvPatchScalarField::calcNut().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ writeLocalEntries()

void writeLocalEntries ( Ostream & os ) const

protected

Write local wall function variables.

Definition at line 194 of file nutUWallFunctionFvPatchScalarField.C.

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

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutUWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp< fvPatchScalarField > clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented in atmNutUWallFunctionFvPatchScalarField.

Definition at line 158 of file nutUWallFunctionFvPatchScalarField.H.

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

Definition at line 174 of file nutUWallFunctionFvPatchScalarField.H.

◆ yPlus()

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

virtual

Calculate and return the yPlus at the boundary.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 265 of file nutUWallFunctionFvPatchScalarField.C.

References forAll, IOobject::groupName(), Foam::mag(), magUp, fvPatchField< Type >::patchInternalField(), turbulenceModel::propertiesName, tmp< T >::ref(), fvPatchField< Type >::snGrad(), Foam::sqrt(), U, y, and yPlus.

Referenced by nutUWallFunctionFvPatchScalarField::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 atmNutUWallFunctionFvPatchScalarField.

Definition at line 309 of file nutUWallFunctionFvPatchScalarField.C.

References os(), and ObukhovLength::write().

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/nutUWallFunction/nutUWallFunctionFvPatchScalarField.H
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutUWallFunction/nutUWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutUWallFunctionFvPatchScalarField() [1/5]

◆ nutUWallFunctionFvPatchScalarField() [2/5]

◆ nutUWallFunctionFvPatchScalarField() [3/5]

◆ nutUWallFunctionFvPatchScalarField() [4/5]

◆ nutUWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ calcNut()

◆ calcYPlus()

◆ writeLocalEntries()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ yPlus()

◆ write()