This boundary conditon averages the field over the "outlet" patch specified by name "outletPatchName" and applies this as the uniform value of the field over this patch. More...

Inheritance diagram for outletMappedUniformInletFvPatchField< Type >:

[legend]

Collaboration diagram for outletMappedUniformInletFvPatchField< Type >:

[legend]

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

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

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

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

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

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

	outletMappedUniformInletFvPatchField (const outletMappedUniformInletFvPatchField< 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 word &	outletPatchName () const
	Name of the outlet patch to be mapped. 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 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 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
word	outletPatchName_
	Name of the outlet patch to be mapped. More...

word	phiName_
	Name of the flux transporting the field. 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::outletMappedUniformInletFvPatchField< Type >

This boundary conditon averages the field over the "outlet" patch specified by name "outletPatchName" and applies this as the uniform value of the field over this patch.

Patch usage

Property	Description	Required	Default value
`outletPatchName`	name of outlet patch	yes
`phi`	flux field name	no	phi

Example of the boundary condition specification:

    myPatch
    {
        type            outletMappedUniformInlet;
        outletPatchName aPatch;
        phi             phi;
        value           uniform 0;
    }

See also: Foam::fixedValueFvPatchField

Source files

Definition at line 91 of file outletMappedUniformInletFvPatchField.H.

Constructor & Destructor Documentation

◆ outletMappedUniformInletFvPatchField() [1/5]

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

Construct from patch and internal field.

Definition at line 35 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [2/5]

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

Construct from patch, internal field and dictionary.

Definition at line 65 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [3/5]

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

Construct by mapping given outletMappedUniformInletFvPatchField.

onto a new patch

Definition at line 49 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [4/5]

outletMappedUniformInletFvPatchField ( const outletMappedUniformInletFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 80 of file outletMappedUniformInletFvPatchField.C.

◆ outletMappedUniformInletFvPatchField() [5/5]

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

Construct as copy setting internal field reference.

Definition at line 94 of file outletMappedUniformInletFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "outletMappedUniformInlet" )

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 144 of file outletMappedUniformInletFvPatchField.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 161 of file outletMappedUniformInletFvPatchField.H.

◆ outletPatchName()

const word& outletPatchName ( ) const

inline

Name of the outlet patch to be mapped.

Definition at line 177 of file outletMappedUniformInletFvPatchField.H.

References outletMappedUniformInletFvPatchField< Type >::outletPatchName_.

◆ updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 108 of file outletMappedUniformInletFvPatchField.C.

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

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 168 of file outletMappedUniformInletFvPatchField.C.

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

Here is the call graph for this function:

Field Documentation

◆ outletPatchName_

word outletPatchName_

private

Name of the outlet patch to be mapped.

Definition at line 98 of file outletMappedUniformInletFvPatchField.H.

Referenced by outletMappedUniformInletFvPatchField< Type >::outletPatchName().

◆ phiName_

word phiName_

private

Name of the flux transporting the field.

Definition at line 101 of file outletMappedUniformInletFvPatchField.H.

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

Private Attributes

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

Field Documentation

◆ outletPatchName_

◆ phiName_

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