kqRWallFunctionFvPatchField< Type > Class Template Reference

This boundary condition provides a simple wrapper around the zero-gradient condition, which can be used for the turbulent kinetic energy, i.e. k, square-root of turbulent kinetic energy, i.e. q, and Reynolds stress tensor fields, i.e. R, for the cases of high Reynolds number flow using wall functions. More...

Inheritance diagram for kqRWallFunctionFvPatchField< Type >:

Collaboration diagram for kqRWallFunctionFvPatchField< Type >:

Public Member Functions
	TypeName ("kqRWallFunction")
	kqRWallFunctionFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	kqRWallFunctionFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	kqRWallFunctionFvPatchField (const kqRWallFunctionFvPatchField &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	kqRWallFunctionFvPatchField (const kqRWallFunctionFvPatchField &)
virtual tmp< fvPatchField< Type > >	clone () const
	kqRWallFunctionFvPatchField (const kqRWallFunctionFvPatchField &, const DimensionedField< Type, volMesh > &)
virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
virtual void	write (Ostream &) const
Public Member Functions inherited from zeroGradientFvPatchField< Type >
	TypeName ("zeroGradient")
	zeroGradientFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	zeroGradientFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	zeroGradientFvPatchField (const zeroGradientFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	zeroGradientFvPatchField (const zeroGradientFvPatchField< Type > &)
	zeroGradientFvPatchField (const zeroGradientFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
virtual tmp< Field< Type > >	snGrad () const
virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
virtual tmp< Field< Type > >	gradientInternalCoeffs () const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	declareRunTimeSelectionTable (tmp, fvPatchField, patch,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF),(p, iF))
	declareRunTimeSelectionTable (tmp, fvPatchField, patchMapper,(const fvPatchField< Type > &ptf, const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const fvPatchFieldMapper &m),(dynamic_cast< const fvPatchFieldType & >(ptf), p, iF, m))
	declareRunTimeSelectionTable (tmp, fvPatchField, dictionary,(const fvPatch &p, const DimensionedField< Type, volMesh > &iF, const dictionary &dict),(p, iF, dict))
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)
	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	fvPatchField (const fvPatchField< Type > &)
	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
virtual tmp< fvPatchField< Type > >	clone () const
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)
Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)
virtual	~fvPatchField ()=default
bool	useImplicit () const noexcept
bool	useImplicit (bool on) noexcept
virtual bool	fixesValue () const
virtual bool	assignable () const
virtual bool	coupled () const
const objectRegistry &	db () const
const fvPatch &	patch () const
const DimensionedField< Type, volMesh > &	internalField () const
const Field< Type > &	primitiveField () const
const word &	patchType () const
word &	patchType ()
bool	updated () const
bool	manipulatedMatrix () const
virtual void	autoMap (const fvPatchFieldMapper &)
virtual void	rmap (const fvPatchField< Type > &, const labelList &)
virtual tmp< Field< Type > >	snGrad () const
virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
virtual void	updateCoeffs ()
virtual void	updateWeightedCoeffs (const scalarField &weights)
virtual tmp< Field< Type > >	patchInternalField () const
virtual void	patchInternalField (Field< Type > &) const
virtual tmp< Field< Type > >	patchNeighbourField () const
virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::commsTypes::blocking)
virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< Field< scalar >> &) const
virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< Field< scalar >> &) const
virtual tmp< Field< Type > >	gradientInternalCoeffs () const
virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const label iMatrix, const direction cmp)
void	check (const fvPatchField< Type > &) const
virtual void	operator= (const UList< Type > &)
virtual void	operator= (const fvPatchField< Type > &)
virtual void	operator= (const Type &)
virtual void	operator+= (const fvPatchField< Type > &)
virtual void	operator+= (const Field< Type > &)
virtual void	operator+= (const Type &)
virtual void	operator-= (const fvPatchField< Type > &)
virtual void	operator-= (const Field< Type > &)
virtual void	operator-= (const Type &)
virtual void	operator*= (const fvPatchField< scalar > &)
virtual void	operator*= (const Field< scalar > &)
virtual void	operator*= (const scalar)
virtual void	operator/= (const fvPatchField< scalar > &)
virtual void	operator/= (const Field< scalar > &)
virtual void	operator/= (const scalar)
virtual void	operator== (const fvPatchField< Type > &)
virtual void	operator== (const Field< Type > &)
virtual void	operator== (const Type &)

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch
typedef calculatedFvPatchField< Type >	Calculated
Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
static const word &	calculatedType ()
Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Detailed Description

template<class Type>
class Foam::kqRWallFunctionFvPatchField< Type >

This boundary condition provides a simple wrapper around the zero-gradient condition, which can be used for the turbulent kinetic energy, i.e. k, square-root of turbulent kinetic energy, i.e. q, and Reynolds stress tensor fields, i.e. R, for the cases of high Reynolds number flow using wall functions.

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries (unmodifiable)
    type            kqRWallFunction;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Req'd	Dflt
type	Type name: kqRWallFunction	word	yes	-

The inherited entries are elaborated in:

• zeroGradientFvPatchField.H

Source files

• kqRWallFunctionFvPatchField.H
• kqRWallFunctionFvPatchField.C

Definition at line 89 of file kqRWallFunctionFvPatchField.H.

Constructor & Destructor Documentation

kqRWallFunctionFvPatchField() [1/5]

kqRWallFunctionFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 28 of file kqRWallFunctionFvPatchField.C.

Referenced by kqRWallFunctionFvPatchField< Type >::clone().

Here is the caller graph for this function:

kqRWallFunctionFvPatchField() [2/5]

kqRWallFunctionFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const dictionary &	dict
	)

Definition at line 39 of file kqRWallFunctionFvPatchField.C.

kqRWallFunctionFvPatchField() [3/5]

kqRWallFunctionFvPatchField	(	const kqRWallFunctionFvPatchField< Type > &	ptf,
		const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const fvPatchFieldMapper &	mapper
	)

Definition at line 51 of file kqRWallFunctionFvPatchField.C.

kqRWallFunctionFvPatchField() [4/5]

kqRWallFunctionFvPatchField

(

const kqRWallFunctionFvPatchField< Type > &

tkqrwfpf

)

Definition at line 64 of file kqRWallFunctionFvPatchField.C.

kqRWallFunctionFvPatchField() [5/5]

kqRWallFunctionFvPatchField	(	const kqRWallFunctionFvPatchField< Type > &	tkqrwfpf,
		const DimensionedField< Type, volMesh > &	iF
	)

Definition at line 74 of file kqRWallFunctionFvPatchField.C.

Member Function Documentation

TypeName()

TypeName

(

"kqRWallFunction"

)

clone() [1/2]

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

inlinevirtual

Reimplemented from zeroGradientFvPatchField< Type >.

Definition at line 134 of file kqRWallFunctionFvPatchField.H.

References kqRWallFunctionFvPatchField< Type >::kqRWallFunctionFvPatchField().

Here is the call graph for this function:

clone() [2/2]

virtual tmp<fvPatchField<Type> > clone ( const DimensionedField< Type, volMesh > &  iF ) const

inlinevirtual

Reimplemented from zeroGradientFvPatchField< Type >.

Definition at line 151 of file kqRWallFunctionFvPatchField.H.

References kqRWallFunctionFvPatchField< Type >::kqRWallFunctionFvPatchField().

Here is the call graph for this function:

evaluate()

void evaluate ( const Pstream::commsTypes  commsType = Pstream::commsTypes::blocking )

virtual

Reimplemented from zeroGradientFvPatchField< Type >.

Definition at line 87 of file kqRWallFunctionFvPatchField.C.

References Foam::stringOps::evaluate().

Here is the call graph for this function:

write()

void write ( Ostream &  os ) const

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 96 of file kqRWallFunctionFvPatchField.C.

References os(), and Foam::vtk::write().

Here is the call graph for this function:

---

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

• src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.H
• src/TurbulenceModels/turbulenceModels/derivedFvPatchFields/wallFunctions/kqRWallFunctions/kqRWallFunction/kqRWallFunctionFvPatchField.C