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:

[legend]

Collaboration diagram for nutkFilmWallFunctionFvPatchScalarField:

[legend]

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 &)

	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 &)

	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 &)

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

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

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

Definition at line 120 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 176 of file nutkFilmWallFunctionFvPatchScalarField.C.

◆ 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 204 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 189 of file nutkFilmWallFunctionFvPatchScalarField.C.

◆ nutkFilmWallFunctionFvPatchScalarField() [4/5]

nutkFilmWallFunctionFvPatchScalarField ( const nutkFilmWallFunctionFvPatchScalarField & wfpsf )

Construct as copy.

Definition at line 221 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 233 of file nutkFilmWallFunctionFvPatchScalarField.C.

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Calculate the turbulence viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 131 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::calcUTau(), IOobject::groupName(), Foam::mag(), Foam::max(), phaseSystem::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 49 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::B_, wallFunctionCoefficients::Cmu(), Foam::exp(), nutkFilmWallFunctionFvPatchScalarField::filmRegionName_, forAll, IOobject::groupName(), k, wallFunctionCoefficients::kappa(), Foam::max(), Foam::min(), Time::New(), Foam::pow(), Foam::pow025(), phaseSystem::propertiesName, Foam::sqrt(), uTau, nutWallFunctionFvPatchScalarField::wallCoeffs_, y, nutkFilmWallFunctionFvPatchScalarField::yPlus(), nutkFilmWallFunctionFvPatchScalarField::yPlusCrit_, 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 158 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::B_, nutkFilmWallFunctionFvPatchScalarField::filmRegionName_, os(), Ostream::writeEntryIfDifferent(), and nutkFilmWallFunctionFvPatchScalarField::yPlusCrit_.

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 191 of file nutkFilmWallFunctionFvPatchScalarField.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 from nutkWallFunctionFvPatchScalarField.

Definition at line 207 of file nutkFilmWallFunctionFvPatchScalarField.H.

◆ yPlus()

tmp< scalarField > yPlus ( ) const

virtual

Calculate and return the yPlus at the boundary.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 248 of file nutkFilmWallFunctionFvPatchScalarField.C.

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

Referenced by nutkFilmWallFunctionFvPatchScalarField::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 272 of file nutkFilmWallFunctionFvPatchScalarField.C.

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

Here is the call graph for this function:

Member Data Documentation

◆ filmRegionName_

word filmRegionName_

protected

Name of film region.

Definition at line 129 of file nutkFilmWallFunctionFvPatchScalarField.H.

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

◆ B_

scalar B_

protected

B Coefficient.

Definition at line 132 of file nutkFilmWallFunctionFvPatchScalarField.H.

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

◆ yPlusCrit_

scalar yPlusCrit_

protected

y+ value for laminar -> turbulent transition

Definition at line 135 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by nutkFilmWallFunctionFvPatchScalarField::calcUTau(), and nutkFilmWallFunctionFvPatchScalarField::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_