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 &)
	Construct by mapping given. 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. 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. More...

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

	nutWallFunctionFvPatchScalarField (const nutWallFunctionFvPatchScalarField &, const DimensionedField< scalar, volMesh > &)
	Construct as copy setting internal field reference. 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...

virtual tmp< scalarField >	calcUTau (const scalarField &magGradU) const
	Calculate the friction velocity. More...

Protected Member Functions inherited from nutWallFunctionFvPatchScalarField
virtual void	checkType ()
	Check the type of the patch. More...

virtual void	writeLocalEntries (Ostream &) const
	Write local wall function variables. More...

Protected Attributes
word	filmRegionName_
	Name of film region. More...

scalar	B_
	B Coefficient (default = 5.5) More...

scalar	yPlusCrit_
	y+ value for laminar -> turbulent transition (default = 11.05) More...

Protected Attributes inherited from nutWallFunctionFvPatchScalarField
scalar	Cmu_
	Cmu coefficient. More...

scalar	kappa_
	Von Karman constant. More...

scalar	E_
	E coefficient. More...

scalar	yPlusLam_
	Y+ at the edge of the laminar sublayer. More...

Additional Inherited Members
Static Public Member Functions inherited from nutWallFunctionFvPatchScalarField
static scalar	yPlusLam (const scalar kappa, const scalar E)
	Calculate the Y+ at the edge of the laminar sublayer. 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.

Patch usage

Example of the boundary condition specification:

myPatch
{
    type            nutkFilmWallFunction;
    value           uniform 0;
}

See also: Foam::nutkWallFunctionFvPatchScalarField

Source files

Definition at line 71 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 154 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 182 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 167 of file nutkFilmWallFunctionFvPatchScalarField.C.

◆ nutkFilmWallFunctionFvPatchScalarField() [4/5]

nutkFilmWallFunctionFvPatchScalarField ( const nutkFilmWallFunctionFvPatchScalarField & wfpsf )

Construct as copy.

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

Member Function Documentation

◆ calcNut()

tmp< scalarField > calcNut ( ) const

protectedvirtual

Calculate the turbulence viscosity.

Reimplemented from nutkWallFunctionFvPatchScalarField.

Definition at line 125 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::calcUTau(), dimensionedInternalField(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), Foam::max(), patchi, turbulenceModel::propertiesName, and Foam::sqr().

Here is the call graph for this function:

◆ calcUTau()

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

protectedvirtual

Calculate the friction velocity.

Definition at line 47 of file nutkFilmWallFunctionFvPatchScalarField.C.

References dimensionedInternalField(), Foam::exp(), forAll, objectRegistry::foundObject(), Foam::constant::atomic::group, IOobject::groupName(), k, Foam::max(), Foam::min(), patchi, Foam::pow(), turbulenceModel::propertiesName, Foam::sqrt(), regionModel::time(), uTau, and y.

Referenced by nutkFilmWallFunctionFvPatchScalarField::calcNut(), and nutkFilmWallFunctionFvPatchScalarField::yPlus().

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 139 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 156 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 225 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::calcUTau(), dimensionedInternalField(), Foam::constant::atomic::group, IOobject::groupName(), Foam::mag(), patchi, turbulenceModel::propertiesName, fvPatchField::snGrad(), and y.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from nutWallFunctionFvPatchScalarField.

Definition at line 247 of file nutkFilmWallFunctionFvPatchScalarField.C.

References nutkFilmWallFunctionFvPatchScalarField::B_, token::END_STATEMENT, nutkFilmWallFunctionFvPatchScalarField::filmRegionName_, Foam::nl, fvPatchField::write(), Ostream::writeKeyword(), nutWallFunctionFvPatchScalarField::writeLocalEntries(), and nutkFilmWallFunctionFvPatchScalarField::yPlusCrit_.

Here is the call graph for this function:

Field Documentation

◆ filmRegionName_

word filmRegionName_

protected

Name of film region.

Definition at line 80 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by nutkFilmWallFunctionFvPatchScalarField::write().

◆ B_

scalar B_

protected

B Coefficient (default = 5.5)

Definition at line 83 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by nutkFilmWallFunctionFvPatchScalarField::write().

◆ yPlusCrit_

scalar yPlusCrit_

protected

y+ value for laminar -> turbulent transition (default = 11.05)

Definition at line 86 of file nutkFilmWallFunctionFvPatchScalarField.H.

Referenced by nutkFilmWallFunctionFvPatchScalarField::write().

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

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ yPlus()

◆ write()

Field Documentation

◆ filmRegionName_

◆ B_

◆ yPlusCrit_