Base class for wall functions that modify cell values. More...

Inheritance diagram for wallCellWallFunctionFvPatchScalarField:

[legend]

Collaboration diagram for wallCellWallFunctionFvPatchScalarField:

Public Member Functions
	wallCellWallFunctionFvPatchScalarField (const fvPatch &, const DimensionedField< scalar, fvMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	wallCellWallFunctionFvPatchScalarField (const wallCellWallFunctionFvPatchScalarField &, const fvPatch &, const DimensionedField< scalar, fvMesh > &, const fieldMapper &)
	Construct by mapping given wallCellWallFunctionFvPatchScalarField. More...

	wallCellWallFunctionFvPatchScalarField (const wallCellWallFunctionFvPatchScalarField &)=delete
	Disallow copy without setting internal field reference. More...

	wallCellWallFunctionFvPatchScalarField (const wallCellWallFunctionFvPatchScalarField &, const DimensionedField< scalar, fvMesh > &)
	Copy constructor setting internal field reference. More...

virtual tmp< fvPatchScalarField >	clone (const DimensionedField< scalar, fvMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

virtual	~wallCellWallFunctionFvPatchScalarField ()
	Destructor. More...

virtual void	map (const fvPatchScalarField &, const fieldMapper &)
	Map the given fvPatchField onto this fvPatchField. More...

virtual void	reset (const fvPatchScalarField &)
	Reset the fvPatchField to the given fvPatchField. More...

virtual void	operator= (const UList< Type > &)
	Inherit assignment. More...

virtual void	operator= (const fvPatchField< Type > &)
	Inherit assignment. More...

virtual void	operator= (const Type &)
	Inherit assignment. More...

Protected Member Functions
label	masterPatchIndex () const
	Return the master patch index. More...

const labelList &	wallCells () const
	Return the wall cell indices. More...

const scalarField &	wallCellFraction () const
	Return the wall cell fractions. More...

void	initMaster ()
	Initialise the master cell indices and fractions, and allocate the. More...

tmp< scalarField >	patchFieldsToWallCellField (const PtrList< scalarField > &pfs) const
	Average a set of patch fields into a wall cell field. More...

Static Protected Member Functions
static void	patchFieldAddToCellField (const fvPatch &fvp, const scalarField &pf, scalarField &vf)
	Sum values from a patch field into a cell field. More...

Detailed Description

Base class for wall functions that modify cell values.

Source files

Definition at line 48 of file wallCellWallFunctionFvPatchScalarField.H.

Constructor & Destructor Documentation

◆ wallCellWallFunctionFvPatchScalarField() [1/4]

wallCellWallFunctionFvPatchScalarField	(	const fvPatch &	p,
		const DimensionedField< scalar, fvMesh > &	iF,
		const dictionary &	dict
	)

Construct from patch, internal field and dictionary.

Definition at line 210 of file wallCellWallFunctionFvPatchScalarField.C.

References Foam::operator==().

Referenced by wallCellWallFunctionFvPatchScalarField::clone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ wallCellWallFunctionFvPatchScalarField() [2/4]

wallCellWallFunctionFvPatchScalarField	(	const wallCellWallFunctionFvPatchScalarField &	ptf,
		const fvPatch &	p,
		const DimensionedField< scalar, fvMesh > &	iF,
		const fieldMapper &	mapper
	)

Construct by mapping given wallCellWallFunctionFvPatchScalarField.

onto a new patch

Definition at line 228 of file wallCellWallFunctionFvPatchScalarField.C.

◆ wallCellWallFunctionFvPatchScalarField() [3/4]

wallCellWallFunctionFvPatchScalarField ( const wallCellWallFunctionFvPatchScalarField & )

delete

Disallow copy without setting internal field reference.

◆ wallCellWallFunctionFvPatchScalarField() [4/4]

wallCellWallFunctionFvPatchScalarField	(	const wallCellWallFunctionFvPatchScalarField &	ewfpsf,
		const DimensionedField< scalar, fvMesh > &	iF
	)

Copy constructor setting internal field reference.

Definition at line 247 of file wallCellWallFunctionFvPatchScalarField.C.

◆ ~wallCellWallFunctionFvPatchScalarField()

virtual ~wallCellWallFunctionFvPatchScalarField ( )

inlinevirtual

Destructor.

Definition at line 161 of file wallCellWallFunctionFvPatchScalarField.H.

Member Function Documentation

◆ masterPatchIndex()

label masterPatchIndex ( ) const

inlineprotected

Return the master patch index.

Definition at line 75 of file wallCellWallFunctionFvPatchScalarField.H.

◆ wallCells()

const labelList& wallCells ( ) const

inlineprotected

Return the wall cell indices.

Definition at line 81 of file wallCellWallFunctionFvPatchScalarField.H.

◆ wallCellFraction()

const scalarField& wallCellFraction ( ) const

inlineprotected

Return the wall cell fractions.

Definition at line 87 of file wallCellWallFunctionFvPatchScalarField.H.

◆ initMaster()

void initMaster ( )

protected

Initialise the master cell indices and fractions, and allocate the.

turbulence fields

Definition at line 37 of file wallCellWallFunctionFvPatchScalarField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryFieldRef(), Foam::findIndices(), forAll, fvPatch::magSf(), Foam::max(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), wallCellWallFunctionFvPatchScalarField::patchFieldAddToCellField(), and patchi.

Here is the call graph for this function:

◆ patchFieldAddToCellField()

void patchFieldAddToCellField	(	const fvPatch &	fvp,
		const scalarField &	pf,
		scalarField &	vf
	)

staticprotected

Sum values from a patch field into a cell field.

Definition at line 151 of file wallCellWallFunctionFvPatchScalarField.C.

References fvPatch::faceCells(), and forAll.

Referenced by wallCellWallFunctionFvPatchScalarField::initMaster().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ patchFieldsToWallCellField()

Foam::tmp< Foam::scalarField > patchFieldsToWallCellField ( const PtrList< scalarField > & pfs ) const

protected

Average a set of patch fields into a wall cell field.

Definition at line 168 of file wallCellWallFunctionFvPatchScalarField.C.

References GeometricField< Type, GeoMesh, PrimitiveField >::boundaryField(), forAll, fvPatch::magSf(), Foam::max(), DimensionedField< Type, GeoMesh, PrimitiveField >::mesh(), and patchi.

Here is the call graph for this function:

◆ clone()

virtual tmp<fvPatchScalarField> clone ( const DimensionedField< scalar, fvMesh > & iF ) const

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented in epsilonmWallFunctionFvPatchScalarField, omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 148 of file wallCellWallFunctionFvPatchScalarField.H.

References wallCellWallFunctionFvPatchScalarField::wallCellWallFunctionFvPatchScalarField().

Here is the call graph for this function:

◆ map()

void map	(	const fvPatchScalarField &	ptf,
		const fieldMapper &	mapper
	)

virtual

Map the given fvPatchField onto this fvPatchField.

Reimplemented in omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 264 of file wallCellWallFunctionFvPatchScalarField.C.

Referenced by epsilonWallFunctionFvPatchScalarField::map(), and omegaWallFunctionFvPatchScalarField::map().

Here is the caller graph for this function:

◆ reset()

void reset ( const fvPatchScalarField & ptf )

virtual

Reset the fvPatchField to the given fvPatchField.

Used for mesh to mesh mapping

Reimplemented in omegaWallFunctionFvPatchScalarField, and epsilonWallFunctionFvPatchScalarField.

Definition at line 277 of file wallCellWallFunctionFvPatchScalarField.C.

Referenced by epsilonWallFunctionFvPatchScalarField::reset(), and omegaWallFunctionFvPatchScalarField::reset().

Here is the caller graph for this function:

◆ operator=() [1/3]

void operator=

Inherit assignment.

Definition at line 552 of file fvPatchField.C.

◆ operator=() [2/3]

void operator=

Inherit assignment.

Definition at line 554 of file fvPatchField.C.

◆ operator=() [3/3]

void operator=

Inherit assignment.

Definition at line 566 of file fvPatchField.C.

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

src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/wallFunctions/wallCellWallFunction/wallCellWallFunctionFvPatchScalarField.H
src/MomentumTransportModels/momentumTransportModels/derivedFvPatchFields/wallFunctions/wallCellWallFunction/wallCellWallFunctionFvPatchScalarField.C

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ wallCellWallFunctionFvPatchScalarField() [1/4]

◆ wallCellWallFunctionFvPatchScalarField() [2/4]

◆ wallCellWallFunctionFvPatchScalarField() [3/4]

◆ wallCellWallFunctionFvPatchScalarField() [4/4]

◆ ~wallCellWallFunctionFvPatchScalarField()

Member Function Documentation

◆ masterPatchIndex()

◆ wallCells()

◆ wallCellFraction()

◆ initMaster()

◆ patchFieldAddToCellField()

◆ patchFieldsToWallCellField()

◆ clone()

◆ map()

◆ reset()

◆ operator=() [1/3]

◆ operator=() [2/3]

◆ operator=() [3/3]