The outletMappedUniformInlet is an inlet boundary condition that. More...

Inheritance diagram for outletMappedUniformInletFvPatchField< Type >:

Collaboration diagram for outletMappedUniformInletFvPatchField< Type >:

Public Member Functions
	TypeName ("outletMappedUniformInlet")

	outletMappedUniformInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	outletMappedUniformInletFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &)

	outletMappedUniformInletFvPatchField (const outletMappedUniformInletFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	outletMappedUniformInletFvPatchField (const outletMappedUniformInletFvPatchField< Type > &)

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

	outletMappedUniformInletFvPatchField (const outletMappedUniformInletFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

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

const word &	outletPatchName () const

virtual void	updateCoeffs ()

virtual void	write (Ostream &) const

Public Member Functions inherited from fixedValueFvPatchField< Type >
	TypeName ("fixedValue")

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &)

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const Type &value)

	fixedValueFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const dictionary &, const bool valueRequired=true)

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const fvPatch &, const DimensionedField< Type, volMesh > &, const fvPatchFieldMapper &)

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &)

	fixedValueFvPatchField (const fixedValueFvPatchField< Type > &, const DimensionedField< Type, volMesh > &)

virtual bool	fixesValue () const

virtual bool	assignable () 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

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

	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	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 void	evaluate (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 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::outletMappedUniformInletFvPatchField< Type >

The outletMappedUniformInlet is an inlet boundary condition that.

averages the patch field of <Type> over a specified "outlet" patch and uniformly applies the averaged value over a specified inlet patch.
optionally, the averaged value can be scaled and/or offset by a pair of specified values.

The governing equation of the boundary condition is:

$\phi_{inlet} = f \phi_{outlet} + \phi_{offset}$

where

$\phi_{inlet}$	=	Spatially-uniform patch-field value at an inlet patch
$\phi_{outlet}$	=	Averaged patch-field value at an outlet patch
	=	User-defined fraction value
$\phi_{offset}$	=	User-defined offset value

Usage

Example of the boundary condition specification:

<patchName>
{
    // Mandatory entries (unmodifiable)
    type            outletMappedFilterInlet;
    outletPatch     <outletPatchName>;

    // Optional entries (unmodifiable)
    fraction        0.1;
    offset          10;    // (1 0 0);
    phi             phi;

    // Optional (inherited) entries
    ...
}

where the entries mean:

Property	Description	Type	Reqd	Dflt
`type`	Type name: outletMappedUniformInlet	word	yes	-
`outletPatch`	Name of patch to be mapped	word	yes	-
`fraction`	Fraction value	scalar	no	1
`offset`	Offset value	Type	no	Zero
`phi`	Name of operand flux field	word	no	phi

The inherited entries are elaborated in:

fixedValueFvPatchFields.H

See also

Foam::fixedValueFvPatchField
Foam::outletMappedUniformInletHeatAdditionFvPatchField
Foam::outletMappedUniformInletTemperatureFvPatchField

Source files

Definition at line 159 of file outletMappedUniformInletFvPatchField.H.

Constructor & Destructor Documentation

◆ outletMappedUniformInletFvPatchField() [1/5]

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

Definition at line 31 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [2/5]

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

Definition at line 47 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [3/5]

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

Definition at line 64 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [4/5]

outletMappedUniformInletFvPatchField ( const outletMappedUniformInletFvPatchField< Type > & ptf )

Definition at line 82 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [5/5]

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

Definition at line 97 of file outletMappedUniformInletFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "outletMappedUniformInlet" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 218 of file outletMappedUniformInletFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 235 of file outletMappedUniformInletFvPatchField.H.

◆ outletPatchName()

const word& outletPatchName ( ) const

inline

Definition at line 251 of file outletMappedUniformInletFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 113 of file outletMappedUniformInletFvPatchField.C.

References Foam::abort(), f(), Foam::FatalError, FatalErrorInFunction, Foam::gSum(), fvPatch::magSf(), Foam::operator==(), p, Foam::foamVersion::patch, and phi.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 173 of file outletMappedUniformInletFvPatchField.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/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/outletMappedUniformInlet/outletMappedUniformInletFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::outletMappedUniformInletFvPatchField< Type >

Constructor & Destructor Documentation

◆ outletMappedUniformInletFvPatchField() [1/5]

◆ outletMappedUniformInletFvPatchField() [2/5]

◆ outletMappedUniformInletFvPatchField() [3/5]

◆ outletMappedUniformInletFvPatchField() [4/5]

◆ outletMappedUniformInletFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ outletPatchName()

◆ updateCoeffs()

◆ write()

template<class Type>
class Foam::outletMappedUniformInletFvPatchField< Type >