This boundary condition provides a turbulent viscosity condition when using wall functions, based on turbulence kinetic energy, for use with surface film models. More...

#include <nutkFilmWallFunctionFvPatchScalarField.H>

Inheritance diagram for nutkFilmWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for nutkFilmWallFunctionFvPatchScalarField:

[legend]

Public Member Functions
	TypeName ("nutkFilmWallFunction")
	Runtime type information.
	nutkFilmWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &)
	Construct from patch and internal field.
	nutkFilmWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary.
	nutkFilmWallFunctionFvPatchScalarField (const nutkFilmWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given nutkFilmWallFunctionFvPatchScalarField onto a new patch.
	nutkFilmWallFunctionFvPatchScalarField (const nutkFilmWallFunctionFvPatchScalarField &)
	Construct as copy.
	nutkFilmWallFunctionFvPatchScalarField (const nutkFilmWallFunctionFvPatchScalarField &, 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 &os) const
	Write.
Public Member Functions inherited from nutkWallFunctionFvPatchScalarField
	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.
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 turbulence viscosity.
tmp< scalarField >	calcUTau (const scalarField &magGradU) const
	Calculate the friction velocity.
void	writeLocalEntries (Ostream &) const
	Write local wall function variables.
Protected Member Functions inherited from nutkWallFunctionFvPatchScalarField
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.

Protected Attributes
word	filmRegionName_
	Name of film region.
scalar	B_
	B Coefficient.
scalar	yPlusCrit_
	y+ value for laminar -> turbulent transition
Protected Attributes inherited from nutWallFunctionFvPatchScalarField
word	UName_
	Name of velocity field.
wallFunctionCoefficients	wallCoeffs_
	Wall-function coefficients.

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.

Detailed Description

This boundary condition provides a turbulent viscosity condition when using wall functions, based on turbulence kinetic energy, for use with surface film models.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries
    type            nutkFilmWallFunction;

    // Optional entries
    filmRegion      <word>;
    B               <scalar>;
    yPlusCrit       <scalar>;

    // Inherited entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Deflt
`type`	Type name: alphatFilmWallFunction	word	yes	-
`filmRegion`	Name of film region	word	no	surfaceFilmProperties
`B`	Model coefficient	scalar	no	5.5
`yPlusCrit`	Critical y+ for transition to turbulence	scalar	no	11.5

The inherited entries are elaborated in:

nutkWallFunctionFvPatchScalarField.H

Source files

Definition at line 116 of file nutkFilmWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ nutkFilmWallFunctionFvPatchScalarField() [1/5]

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

Construct from patch and internal field.

Definition at line 169 of file nutkFilmWallFunctionFvPatchScalarField.C.

References B_, filmRegionName_, nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), p, and yPlusCrit_.

Referenced by nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), and TypeName().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ nutkFilmWallFunctionFvPatchScalarField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 197 of file nutkFilmWallFunctionFvPatchScalarField.C.

References B_, dict, filmRegionName_, nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), p, and yPlusCrit_.

Here is the call graph for this function:

◆ nutkFilmWallFunctionFvPatchScalarField() [3/5]

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

Construct by mapping given nutkFilmWallFunctionFvPatchScalarField onto a new patch.

Definition at line 182 of file nutkFilmWallFunctionFvPatchScalarField.C.

References B_, filmRegionName_, nutkFilmWallFunctionFvPatchScalarField(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), p, and yPlusCrit_.

Here is the call graph for this function:

◆ nutkFilmWallFunctionFvPatchScalarField() [4/5]

nutkFilmWallFunctionFvPatchScalarField ( const nutkFilmWallFunctionFvPatchScalarField & wfpsf )

Construct as copy.

Definition at line 214 of file nutkFilmWallFunctionFvPatchScalarField.C.

References B_, filmRegionName_, nutkFilmWallFunctionFvPatchScalarField(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), and yPlusCrit_.

Here is the call graph for this function:

◆ nutkFilmWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 226 of file nutkFilmWallFunctionFvPatchScalarField.C.

References B_, filmRegionName_, nutkFilmWallFunctionFvPatchScalarField(), nutkWallFunctionFvPatchScalarField::nutkWallFunctionFvPatchScalarField(), and yPlusCrit_.

Here is the call graph for this function:

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Calculate the turbulence viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 124 of file nutkFilmWallFunctionFvPatchScalarField.C.

References calcUTau(), IOobject::groupName(), Foam::mag(), Foam::max(), turbulenceModel::propertiesName, and Foam::sqr().

Here is the call graph for this function:

◆ calcUTau()

tmp< scalarField > calcUTau ( const scalarField & magGradU ) const

protected

Calculate the friction velocity.

Definition at line 42 of file nutkFilmWallFunctionFvPatchScalarField.C.

References B_, Foam::exp(), filmRegionName_, forAll, IOobject::groupName(), k, Foam::max(), Foam::min(), tmp< T >::New(), Foam::pow(), Foam::pow025(), turbulenceModel::propertiesName, Foam::sqrt(), uTau, nutWallFunctionFvPatchScalarField::wallCoeffs_, y, yPlus(), yPlusCrit_, and Foam::Zero.

Referenced by calcNut(), and yPlus().

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 151 of file nutkFilmWallFunctionFvPatchScalarField.C.

References B_, filmRegionName_, os(), and yPlusCrit_.

Referenced by write().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TypeName()

TypeName ( "nutkFilmWallFunction" )

Runtime type information.

References nutkFilmWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ clone() [1/2]

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

inlinevirtual

Return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 220 of file nutkFilmWallFunctionFvPatchScalarField.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 from nutkWallFunctionFvPatchScalarField.

Definition at line 228 of file nutkFilmWallFunctionFvPatchScalarField.H.

References fvPatchField< Type >::Clone().

Here is the call graph for this function:

◆ yPlus()

tmp< scalarField > yPlus ( ) const

virtual

Calculate and return the yPlus at the boundary.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 241 of file nutkFilmWallFunctionFvPatchScalarField.C.

References calcUTau(), IOobject::groupName(), Foam::mag(), turbulenceModel::propertiesName, fvPatchField< Type >::snGrad(), and y.

Referenced by calcUTau().

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

Definition at line 265 of file nutkFilmWallFunctionFvPatchScalarField.C.

References os(), nutWallFunctionFvPatchScalarField::write(), writeLocalEntries(), and fvPatchField< Type >::writeValueEntry().

Here is the call graph for this function:

Member Data Documentation

◆ filmRegionName_

word filmRegionName_

protected

Name of film region.

Definition at line 127 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by calcUTau(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), and writeLocalEntries().

◆ B_

scalar B_

protected

B Coefficient.

Definition at line 132 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by calcUTau(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), and writeLocalEntries().

◆ yPlusCrit_

scalar yPlusCrit_

protected

y+ value for laminar -> turbulent transition

Definition at line 137 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by calcUTau(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), nutkFilmWallFunctionFvPatchScalarField(), and writeLocalEntries().

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

src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.H
src/regionModels/surfaceFilmModels/derivedFvPatchFields/wallFunctions/nutkFilmWallFunction/nutkFilmWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ nutkFilmWallFunctionFvPatchScalarField() [1/5]

◆ nutkFilmWallFunctionFvPatchScalarField() [2/5]

◆ nutkFilmWallFunctionFvPatchScalarField() [3/5]

◆ nutkFilmWallFunctionFvPatchScalarField() [4/5]

◆ nutkFilmWallFunctionFvPatchScalarField() [5/5]

Member Function Documentation

◆ calcNut()

◆ calcUTau()

◆ writeLocalEntries()

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ yPlus()

◆ write()

Member Data Documentation

◆ filmRegionName_

◆ B_

◆ yPlusCrit_