This boundary condition maps the value at a set of cells or patch faces back to *this. More...

Inheritance diagram for mappedFixedValueFvPatchField< Type >:

[legend]

Collaboration diagram for mappedFixedValueFvPatchField< Type >:

Public Member Functions
	TypeName ("mapped")

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

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

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

	mappedFixedValueFvPatchField (const mappedFixedValueFvPatchField< Type > &)

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

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

virtual tmp< fvPatchField< Type > >	clone (const DimensionedField< Type, volMesh > &iF) 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 &)

Public Member Functions inherited from mappedPatchFieldBase< Type >
	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const word &fieldName, const bool setAverage, const Type average, const word &interpolationScheme)

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict)

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict, const Field< Type > &fld)

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField)

	mappedPatchFieldBase (const mappedPatchFieldBase< Type > &mapper)

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const mappedPatchFieldBase< Type > &base)

virtual	~mappedPatchFieldBase ()=default

template<class T >
const GeometricField< T, fvPatchField, volMesh > &	sampleField (const word &fieldName) const

const GeometricField< Type, fvPatchField, volMesh > &	sampleField () const

virtual tmp< Field< Type > >	mappedField () const

virtual tmp< Field< Type > >	mappedInternalField () const

virtual tmp< scalarField >	mappedWeightField () const

virtual void	mappedWeightField (const word &weightFieldName, tmp< scalarField > &thisWeights, tmp< scalarField > &nbrWeights) const

template<class T >
void	distribute (const word &fieldName, Field< T > &newValues) const

template<class Type2 >
const Foam::GeometricField< Type2, Foam::fvPatchField, Foam::volMesh > &	sampleField (const word &fieldName) const

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 Member Functions inherited from mappedPatchFieldBase< Type >
static const mappedPatchBase &	mapper (const fvPatch &p, const DimensionedField< Type, volMesh > &iF)

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField

Protected Member Functions inherited from mappedPatchFieldBase< Type >
template<class T >
void	initRetrieveField (const objectRegistry &obr, const word &region, const word &patch, const labelListList &map, const word &fieldName, const Field< T > &fld) const

template<class T >
bool	storeAndRetrieveField (const word &fieldName, const label myComm, const labelListList &subMap, const label constructSize, const labelListList &constructMap, const labelListList &address, const scalarListList &weights, Field< T > &fld) const

template<class T >
void	initRetrieveField (const word &fieldName, const Field< T > &fld) const

template<class T >
void	storeField (const objectRegistry &obr, const word &region, const word &patch, const label myComm, const labelListList &procToMap, const word &fieldName, const Field< T > &fld) const

template<class T >
bool	retrieveField (const bool allowUnset, const objectRegistry &obr, const word &region, const word &patch, const label myComm, const labelListList &procToMap, const word &fieldName, Field< T > &fld) const

Protected Attributes inherited from mappedPatchFieldBase< Type >
const mappedPatchBase &	mapper_

const fvPatchField< Type > &	patchField_

word	fieldName_

const bool	setAverage_

const Type	average_

word	interpolationScheme_

Detailed Description

template<class Type>
class Foam::mappedFixedValueFvPatchField< Type >

This boundary condition maps the value at a set of cells or patch faces back to *this.

The sample mode is set by the underlying mapping engine, provided by the mappedPatchBase class.

Usage

Property	Description	Required	Default
`field`	Field name to be mapped	no	this field name
`setAverage`	Use average value	no	false
`average`	Average value to use if `setAverage` = yes	partly
`interpolationScheme`	type of interpolation scheme	partly

Example of the boundary condition specification:

    <patchName>
    {
        type            mapped;
        field           T;
        setAverage      no;
        average         0;
        interpolationScheme cell;
        value           uniform 0;
    }

When employing the nearestCell sample mode, the user must also specify the interpolation scheme using the interpolationScheme entry.

In case of interpolation (where scheme != cell) the limitation is that there is only one value per cell. For example, if you have a cell with two boundary faces and both faces sample into the cell, both faces will get the same value.

Note: It is not possible to sample internal faces since volume fields are not defined on faces.

See also: Foam::mappedPatchBase Foam::interpolation Foam::fixedValueFvPatchField

Source files

Definition at line 121 of file mappedFixedValueFvPatchField.H.

Constructor & Destructor Documentation

◆ mappedFixedValueFvPatchField() [1/5]

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

Definition at line 28 of file mappedFixedValueFvPatchField.C.

◆ mappedFixedValueFvPatchField() [2/5]

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

Definition at line 40 of file mappedFixedValueFvPatchField.C.

◆ mappedFixedValueFvPatchField() [3/5]

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

Definition at line 59 of file mappedFixedValueFvPatchField.C.

◆ mappedFixedValueFvPatchField() [4/5]

mappedFixedValueFvPatchField ( const mappedFixedValueFvPatchField< Type > & ptf )

Definition at line 78 of file mappedFixedValueFvPatchField.C.

◆ mappedFixedValueFvPatchField() [5/5]

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

Definition at line 89 of file mappedFixedValueFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mapped" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Reimplemented in mappedFixedPushedInternalValueFvPatchField< Type >, and mappedFixedInternalValueFvPatchField< Type >.

Definition at line 166 of file mappedFixedValueFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Reimplemented in mappedFixedPushedInternalValueFvPatchField< Type >, and mappedFixedInternalValueFvPatchField< Type >.

Definition at line 183 of file mappedFixedValueFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Reimplemented in mappedFixedPushedInternalValueFvPatchField< Type >, and mappedFixedInternalValueFvPatchField< Type >.

Definition at line 107 of file mappedFixedValueFvPatchField.C.

References Foam::expressions::patchExpr::debug, Foam::endl(), Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::Info, Foam::operator==(), and Foam::foamVersion::patch.

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Reimplemented from fixedValueFvPatchField< Type >.

Reimplemented in mappedFixedInternalValueFvPatchField< Type >, and mappedFixedPushedInternalValueFvPatchField< Type >.

Definition at line 132 of file mappedFixedValueFvPatchField.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/mappedFixedValue/mappedFixedValueFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/mappedFixedValue/mappedFixedValueFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::mappedFixedValueFvPatchField< Type >

Constructor & Destructor Documentation

◆ mappedFixedValueFvPatchField() [1/5]

◆ mappedFixedValueFvPatchField() [2/5]

◆ mappedFixedValueFvPatchField() [3/5]

◆ mappedFixedValueFvPatchField() [4/5]

◆ mappedFixedValueFvPatchField() [5/5]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ updateCoeffs()

◆ write()

template<class Type>
class Foam::mappedFixedValueFvPatchField< Type >