nutkFilmWallFunctionFvPatchScalarField Class Reference

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

Inheritance diagram for nutkFilmWallFunctionFvPatchScalarField:

Collaboration diagram for nutkFilmWallFunctionFvPatchScalarField:

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

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

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

• nutkFilmWallFunctionFvPatchScalarField.H
• nutkFilmWallFunctionFvPatchScalarField.C

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

Referenced by nutkFilmWallFunctionFvPatchScalarField::clone().

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

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

nutkFilmWallFunctionFvPatchScalarField() [4/5]

nutkFilmWallFunctionFvPatchScalarField

(

const nutkFilmWallFunctionFvPatchScalarField &

wfpsf

)

Construct as copy.

Definition at line 215 of file nutkFilmWallFunctionFvPatchScalarField.C.

nutkFilmWallFunctionFvPatchScalarField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 227 of file nutkFilmWallFunctionFvPatchScalarField.C.

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 nutkFilmWallFunctionFvPatchScalarField::calcUTau(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::max(), Foam::foamVersion::patch, 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 43 of file nutkFilmWallFunctionFvPatchScalarField.C.

References Foam::exp(), forAll, Foam::constant::atomic::group, IOobject::groupName(), k, Foam::constant::electromagnetic::kappa, Foam::max(), Foam::min(), tmp< T >::New(), Foam::foamVersion::patch, Foam::pow(), Foam::pow025(), turbulenceModel::propertiesName, Foam::sqrt(), uTau, y, yPlus, and Foam::Zero.

Referenced by nutkFilmWallFunctionFvPatchScalarField::calcNut(), and nutkFilmWallFunctionFvPatchScalarField::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 152 of file nutkFilmWallFunctionFvPatchScalarField.C.

References os().

Referenced by nutkFilmWallFunctionFvPatchScalarField::write().

Here is the call graph for this function:

Here is the caller graph for this function:

TypeName()

TypeName

(

"nutkFilmWallFunction"

)

Runtime type information.

clone() [1/2]

virtual tmp<fvPatchScalarField> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 211 of file nutkFilmWallFunctionFvPatchScalarField.H.

References nutkFilmWallFunctionFvPatchScalarField::nutkFilmWallFunctionFvPatchScalarField().

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

Definition at line 232 of file nutkFilmWallFunctionFvPatchScalarField.H.

References nutkFilmWallFunctionFvPatchScalarField::nutkFilmWallFunctionFvPatchScalarField().

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 nutkFilmWallFunctionFvPatchScalarField::calcUTau(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::foamVersion::patch, turbulenceModel::propertiesName, fvPatchField< Type >::snGrad(), and y.

Here is the call 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(), nutkFilmWallFunctionFvPatchScalarField::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.

B_

scalar B_

protected

B Coefficient.

Definition at line 132 of file nutkFilmWallFunctionFvPatchScalarField.H.

yPlusCrit_

scalar yPlusCrit_

protected

y+ value for laminar -> turbulent transition

Definition at line 137 of file nutkFilmWallFunctionFvPatchScalarField.H.

---

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