This boundary condition generates a fluctuating inlet condition by adding a random component to a reference (mean) field. More...

Inheritance diagram for turbulentInletFvPatchField< Type >:

[legend]

Collaboration diagram for turbulentInletFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("turbulentInlet")
	Runtime type information. More...

	turbulentInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	turbulentInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping given turbulentInletFvPatchField. More...

	turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &)
	Construct as copy. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

	turbulentInletFvPatchField (const turbulentInletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) const
	Construct and return a clone setting internal field reference. More...

const Type &	fluctuationScale () const
	Return the fluctuation scale. More...

Type &	fluctuationScale ()
	Return reference to the fluctuation scale to allow adjustment. More...

const Field< Type > &	referenceField () const
	Return the reference field. More...

Field< Type > &	referenceField ()
	Return reference to the reference field to allow adjustment. More...

virtual void	autoMap (const fvPatchFieldMapper &)
	Map (and resize as needed) from self given a mapping object. More...

virtual void	rmap (const fvPatchField< Type > &, const labelList &)
	Reverse map the given fvPatchField onto this fvPatchField. More...

virtual void	updateCoeffs ()
	Update the coefficients associated with the patch field. More...

virtual void	write (Ostream &) const
	Write. More...

Public Member Functions inherited from fixedValueFvPatchField< Type >
	TypeName ("fixedValue")
	Runtime type information. More...

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)
	Construct from patch and internal field. More...

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Construct from patch, internal field and dictionary. More...

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fixedValueFvPatchField<Type> More...

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &)
	Construct as copy. More...

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual tmp< Field< Type > >	valueInternalCoeffs (const tmp< scalarField > &) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	valueBoundaryCoeffs (const tmp< scalarField > &) const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual void	operator= (const UList< Type > &)

virtual void	operator= (const fvPatchField< Type > &)

virtual void	operator+= (const fvPatchField< Type > &)

virtual void	operator-= (const fvPatchField< Type > &)

virtual void	operator*= (const fvPatchField< scalar > &)

virtual void	operator/= (const fvPatchField< scalar > &)

virtual void	operator+= (const Field< Type > &)

virtual void	operator-= (const Field< Type > &)

virtual void	operator*= (const Field< scalar > &)

virtual void	operator/= (const Field< scalar > &)

virtual void	operator= (const Type &)

virtual void	operator+= (const Type &)

virtual void	operator-= (const Type &)

virtual void	operator*= (const scalar)

virtual void	operator/= (const scalar)

Public Member Functions inherited from fvPatchField< Type >
	TypeName ("fvPatchField")
	Runtime type information. More...

	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 > &)
	Construct from patch and internal field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &patchType)
	Construct from patch and internal field and patch type. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Field< Type > &)
	Construct from patch and internal field and patch field. More...

	fvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=false)
	Construct from patch, internal field and dictionary. More...

	fvPatchField (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Construct by mapping the given fvPatchField onto a new patch. More...

	fvPatchField (const fvPatchField< Type > &)
	Construct as copy. More...

	fvPatchField (const fvPatchField< Type > &, const DimensionedField< Type, volMesh > &)
	Construct as copy setting internal field reference. More...

virtual tmp< fvPatchField< Type > >	clone () const
	Construct and return a clone. More...

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatch &p)

Foam::tmp< Foam::fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &pf)

virtual	~fvPatchField ()
	Destructor. More...

const objectRegistry &	db () const
	Return local objectRegistry. More...

const fvPatch &	patch () const
	Return patch. More...

const DimensionedField< Type, volMesh > &	dimensionedInternalField () const
	Return dimensioned internal field reference. More...

const Field< Type > &	internalField () const
	Return internal field reference. More...

const word &	patchType () const
	Optional patch type. More...

word &	patchType ()
	Optional patch type. More...

virtual bool	fixesValue () const
	Return true if this patch field fixes a value. More...

virtual bool	coupled () const
	Return true if this patch field is coupled. More...

bool	updated () const
	Return true if the boundary condition has already been updated. More...

bool	manipulatedMatrix () const
	Return true if the matrix has already been manipulated. More...

virtual tmp< Field< Type > >	snGrad () const
	Return patch-normal gradient. More...

virtual tmp< Field< Type > >	snGrad (const scalarField &deltaCoeffs) const
	Return patch-normal gradient for coupled-patches. More...

virtual void	updateCoeffs (const scalarField &weights)
	Update the coefficients associated with the patch field. More...

virtual tmp< Field< Type > >	patchInternalField () const
	Return internal field next to patch as patch field. More...

virtual void	patchInternalField (Field< Type > &) const
	Return internal field next to patch as patch field. More...

virtual tmp< Field< Type > >	patchNeighbourField () const
	Return patchField on the opposite patch of a coupled patch. More...

virtual void	initEvaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Initialise the evaluation of the patch field. More...

virtual void	evaluate (const Pstream::commsTypes commsType=Pstream::blocking)
	Evaluate the patch field, sets Updated to false. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs () const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientInternalCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix diagonal coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs () const
	Return the matrix source coefficients corresponding to the. More...

virtual tmp< Field< Type > >	gradientBoundaryCoeffs (const scalarField &deltaCoeffs) const
	Return the matrix source coefficients corresponding to the. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix)
	Manipulate matrix. More...

virtual void	manipulateMatrix (fvMatrix< Type > &matrix, const scalarField &weights)
	Manipulate matrix with given weights. More...

void	writeEntryIfDifferent (Ostream &os, const word &entryName, const EntryType &value1, const EntryType &value2) const
	Helper function to write the keyword and entry only if the. More...

void	check (const fvPatchField< Type > &) const
	Check fvPatchField<Type> against given fvPatchField<Type> More...

virtual void	operator== (const fvPatchField< Type > &)

virtual void	operator== (const Field< Type > &)

virtual void	operator== (const Type &)

Private Attributes
Random	ranGen_
	Random number generator. More...

Type	fluctuationScale_
	Fluctuation scake. More...

Field< Type >	referenceField_
	Reference field. More...

scalar	alpha_
	Fraction of RMS component to apply to last time step values. More...

label	curTimeIndex_
	Current time index (used for updating) More...

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

Static Public Member Functions inherited from fvPatchField< Type >
static tmp< fvPatchField< Type > >	New (const word &, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const word &, const word &actualPatchType, const fvPatch &, const DimensionedField< Type, volMesh > &)
	Return a pointer to a new patchField created on freestore given. More...

static tmp< fvPatchField< Type > >	New (const fvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)
	Return a pointer to a new patchField created on freestore from. More...

static tmp< fvPatchField< Type > >	New (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)
	Return a pointer to a new patchField created on freestore. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatch &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static tmp< fvPatchField< Type > >	NewCalculatedType (const fvPatchField< Type2 > &)
	Return a pointer to a new calculatedFvPatchField created on. More...

static const word &	calculatedType ()
	Return the type of the calculated for of fvPatchField. More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Detailed Description

template<class Type>
class Foam::turbulentInletFvPatchField< Type >

This boundary condition generates a fluctuating inlet condition by adding a random component to a reference (mean) field.

$x_p = (1 - \alpha) x_p^{n-1} + \alpha (x_{ref} + s C_{RMS} x_{ref})$

where

	=	patch values
$x_{ref}$	=	reference patch values
	=	time level
$\alpha$	=	fraction of new random component added to previous time value
$C_{RMS}$	=	RMS coefficient
	=	fluctuation scale

Patch usage

Property	Description	Required	Default value
`fluctuationScale`	RMS fluctuation scale (fraction of mean)	yes
`referenceField`	reference (mean) field	yes
`alpha`	fraction of new random component added to previous	no	0.1

Example of the boundary condition specification:

    myPatch
    {
        type            turbulentInlet;
        fluctuationScale 0.1;
        referenceField  uniform 10;
        alpha           0.1;
    }

See also: Foam::fixedValueFvPatchField

Source files

Definition at line 136 of file turbulentInletFvPatchField.H.

Constructor & Destructor Documentation

◆ turbulentInletFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 37 of file turbulentInletFvPatchField.C.

◆ turbulentInletFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 71 of file turbulentInletFvPatchField.C.

References dict, dictionary::found(), fvPatchField< Type >::operator==(), and p.

Here is the call graph for this function:

◆ turbulentInletFvPatchField() [3/5]

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

Construct by mapping given turbulentInletFvPatchField.

onto a new patch

Definition at line 53 of file turbulentInletFvPatchField.C.

◆ turbulentInletFvPatchField() [4/5]

turbulentInletFvPatchField ( const turbulentInletFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 100 of file turbulentInletFvPatchField.C.

◆ turbulentInletFvPatchField() [5/5]

turbulentInletFvPatchField	(	const turbulentInletFvPatchField< Type > &	ptf,
		const DimensionedField< Type, volMesh > &	iF
	)

Construct as copy setting internal field reference.

Definition at line 115 of file turbulentInletFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "turbulentInlet" )

Runtime type information.

◆ clone() [1/2]

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

inlinevirtual

Construct and return a clone.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 198 of file turbulentInletFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Construct and return a clone setting internal field reference.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 215 of file turbulentInletFvPatchField.H.

◆ fluctuationScale() [1/2]

const Type& fluctuationScale ( ) const

inline

Return the fluctuation scale.

Definition at line 231 of file turbulentInletFvPatchField.H.

References turbulentInletFvPatchField< Type >::fluctuationScale_.

◆ fluctuationScale() [2/2]

Type& fluctuationScale ( )

inline

Return reference to the fluctuation scale to allow adjustment.

Definition at line 237 of file turbulentInletFvPatchField.H.

References turbulentInletFvPatchField< Type >::fluctuationScale_.

◆ referenceField() [1/2]

const Field<Type>& referenceField ( ) const

inline

Return the reference field.

Definition at line 243 of file turbulentInletFvPatchField.H.

References turbulentInletFvPatchField< Type >::referenceField_.

◆ referenceField() [2/2]

Field<Type>& referenceField ( )

inline

Return reference to the reference field to allow adjustment.

Definition at line 249 of file turbulentInletFvPatchField.H.

References turbulentInletFvPatchField< Type >::referenceField_.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Map (and resize as needed) from self given a mapping object.

Reimplemented from fvPatchField< Type >.

Definition at line 133 of file turbulentInletFvPatchField.C.

References fvPatchField< Type >::autoMap().

Here is the call graph for this function:

◆ rmap()

void rmap	(	const fvPatchField< Type > &	ptf,
		const labelList &	addr
	)

virtual

Reverse map the given fvPatchField onto this fvPatchField.

Reimplemented from fvPatchField< Type >.

Definition at line 144 of file turbulentInletFvPatchField.C.

References turbulentInletFvPatchField< Type >::referenceField_, turbulentInletFvPatchField< Type >::rmap(), and fvPatchField< Type >::rmap().

Referenced by turbulentInletFvPatchField< Type >::rmap().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 159 of file turbulentInletFvPatchField.C.

References Foam::cmptMultiply(), forAll, Foam::mag(), Foam::sqr(), Foam::sqrt(), timeIndex, and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 201 of file turbulentInletFvPatchField.C.

References token::END_STATEMENT, Foam::nl, fvPatchField::write(), and Ostream::writeKeyword().

Here is the call graph for this function:

Field Documentation

◆ ranGen_

Random ranGen_

private

Random number generator.

Definition at line 143 of file turbulentInletFvPatchField.H.

◆ fluctuationScale_

Type fluctuationScale_

private

Fluctuation scake.

Definition at line 146 of file turbulentInletFvPatchField.H.

Referenced by turbulentInletFvPatchField< Type >::fluctuationScale().

◆ referenceField_

Field<Type> referenceField_

private

Reference field.

Definition at line 149 of file turbulentInletFvPatchField.H.

Referenced by turbulentInletFvPatchField< Type >::referenceField(), and turbulentInletFvPatchField< Type >::rmap().

◆ alpha_

scalar alpha_

private

Fraction of RMS component to apply to last time step values.

Definition at line 152 of file turbulentInletFvPatchField.H.

◆ curTimeIndex_

label curTimeIndex_

private

Current time index (used for updating)

Definition at line 155 of file turbulentInletFvPatchField.H.

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

src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/turbulentInlet/turbulentInletFvPatchField.C

Public Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<class Type> class Foam::turbulentInletFvPatchField< Type >

Constructor & Destructor Documentation

◆ turbulentInletFvPatchField() [1/5]

◆ turbulentInletFvPatchField() [2/5]

◆ turbulentInletFvPatchField() [3/5]

◆ turbulentInletFvPatchField() [4/5]

◆ turbulentInletFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ fluctuationScale() [1/2]

◆ fluctuationScale() [2/2]

◆ referenceField() [1/2]

◆ referenceField() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

Field Documentation

◆ ranGen_

◆ fluctuationScale_

◆ referenceField_

◆ alpha_

◆ curTimeIndex_

template<class Type>
class Foam::turbulentInletFvPatchField< Type >