This boundary condition provides a simple wrapper around a zero fixed-value condition for the turbulent viscosity (i.e. nut) for low-Reynolds number applications. It sets nut to zero, and provides an access function to calculate y+. More...

Inheritance diagram for nutLowReWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutLowReWallFunctionFvPatchScalarField:

[legend]

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

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

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

	nutLowReWallFunctionFvPatchScalarField (const nutLowReWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutLowReWallFunctionFvPatchScalarField onto a new patch. More...

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

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

	nutLowReWallFunctionFvPatchScalarField (const nutLowReWallFunctionFvPatchScalarField &, 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...

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 simple wrapper around a zero fixed-value condition for the turbulent viscosity (i.e. nut) for low-Reynolds number applications. It sets nut to zero, and provides an access function to calculate y+.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            nutLowReWallFunction;

    // Inherited entries
    ...
}

where the entries mean:

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

The inherited entries are elaborated in:

nutWallFunctionFvPatchScalarField.H

Source files

Definition at line 87 of file nutLowReWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutLowReWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 42 of file nutLowReWallFunctionFvPatchScalarField.C.

Referenced by nutLowReWallFunctionFvPatchScalarField::clone().

Here is the caller graph for this function:

◆ nutLowReWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 66 of file nutLowReWallFunctionFvPatchScalarField.C.

◆ nutLowReWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given nutLowReWallFunctionFvPatchScalarField onto a new patch.

Definition at line 53 of file nutLowReWallFunctionFvPatchScalarField.C.

◆ nutLowReWallFunctionFvPatchScalarField() [4/5]

nutLowReWallFunctionFvPatchScalarField ( const nutLowReWallFunctionFvPatchScalarField & nlrwfpsf )

Construct as copy.

Definition at line 78 of file nutLowReWallFunctionFvPatchScalarField.C.

◆ nutLowReWallFunctionFvPatchScalarField() [5/5]

nutLowReWallFunctionFvPatchScalarField	(	const nutLowReWallFunctionFvPatchScalarField &	nlrwfpsf,
		const DimensionedField< scalar, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 88 of file nutLowReWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

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

protectedvirtual

Calculate the turbulent viscosity.

Implements nutWallFunctionFvPatchScalarField.

Definition at line 32 of file nutLowReWallFunctionFvPatchScalarField.C.

References tmp< T >::New(), Foam::foamVersion::patch, and Foam::Zero.

Here is the call graph for this function:

◆ TypeName()

TypeName ( "nutLowReWallFunction" )

Runtime type information.

◆ clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Definition at line 154 of file nutLowReWallFunctionFvPatchScalarField.H.

References nutLowReWallFunctionFvPatchScalarField::nutLowReWallFunctionFvPatchScalarField().

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.

Definition at line 175 of file nutLowReWallFunctionFvPatchScalarField.H.

References nutLowReWallFunctionFvPatchScalarField::nutLowReWallFunctionFvPatchScalarField().

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.

Definition at line 100 of file nutLowReWallFunctionFvPatchScalarField.C.

References Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::foamVersion::patch, turbulenceModel::propertiesName, fvPatchField< Type >::snGrad(), Foam::sqrt(), U, and y.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 128 of file nutLowReWallFunctionFvPatchScalarField.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/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.H
src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/nutWallFunctions/nutLowReWallFunction/nutLowReWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutLowReWallFunctionFvPatchScalarField() [1/5]

◆ nutLowReWallFunctionFvPatchScalarField() [2/5]

◆ nutLowReWallFunctionFvPatchScalarField() [3/5]

◆ nutLowReWallFunctionFvPatchScalarField() [4/5]

◆ nutLowReWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ calcNut()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ yPlus()

◆ write()