Functionality for sampling fields using mappedPatchBase. Every call to mappedField() returns a sampled field, optionally scaled to maintain an area-weighted average. More...

Inheritance diagram for mappedPatchFieldBase< Type >:

[legend]

Collaboration diagram for mappedPatchFieldBase< Type >:

[legend]

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

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict)
	Construct from dictionary. More...

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const dictionary &dict, const Field< Type > &fld)
	Construct from dictionary and initial field value. More...

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField)
	Construct empty. More...

	mappedPatchFieldBase (const mappedPatchFieldBase< Type > &mapper)
	Construct copy. More...

	mappedPatchFieldBase (const mappedPatchBase &mapper, const fvPatchField< Type > &patchField, const mappedPatchFieldBase< Type > &base)
	Construct copy, resetting patch and field. More...

virtual	~mappedPatchFieldBase ()=default
	Destructor. More...

template<class T >
const GeometricField< T, fvPatchField, volMesh > &	sampleField (const word &fieldName) const
	Field to sample. Either on my or nbr mesh. More...

const GeometricField< Type, fvPatchField, volMesh > &	sampleField () const
	Field to sample. Either on my or nbr mesh. More...

virtual tmp< Field< Type > >	mappedField () const
	Map sampleField onto *this patch. More...

virtual tmp< Field< Type > >	mappedInternalField () const
	Map internal of sampleField onto *this patch. More...

virtual tmp< scalarField >	mappedWeightField () const
	Map optional weightField onto *this patch. Default is deltaCoeffs. More...

virtual void	mappedWeightField (const word &weightFieldName, tmp< scalarField > &thisWeights, tmp< scalarField > &nbrWeights) const
	Map optional weightField (given by name) onto *this patch. More...

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

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

Static Public Member Functions
static const mappedPatchBase &	mapper (const fvPatch &p, const DimensionedField< Type, volMesh > &iF)
	Check that patch is of correct type. More...

Protected Member Functions
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
	Construct field from registered elements. More...

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
	Helper : storeField and retrieveField and interpolate. Leaves fld. More...

template<class T >
void	initRetrieveField (const word &fieldName, const Field< T > &fld) const
	Initialise field to retrieve (e.g. when value read from dictionary) More...

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
	Store elements of field onto (sub) registry. More...

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
	Construct field from registered elements. More...

Protected Attributes
const mappedPatchBase &	mapper_
	Mapping engine. More...

const fvPatchField< Type > &	patchField_
	Underlying patch field. More...

word	fieldName_
	Name of field to sample. More...

const bool	setAverage_
	If true adjust the mapped field to maintain average value average_. More...

const Type	average_

word	interpolationScheme_
	Interpolation scheme to use for nearestcell mode. More...

Detailed Description

template<class Type>
class Foam::mappedPatchFieldBase< Type >

Functionality for sampling fields using mappedPatchBase. Every call to mappedField() returns a sampled field, optionally scaled to maintain an area-weighted average.

Example usage:

{
    field               T;          // default is same as fvPatchField
    setAverage          false;
    average             1.0;        // only if setAverage=true
    interpolationScheme cellPoint;  // default is cell
}

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

Source files

Definition at line 105 of file mappedPatchFieldBase.H.

Constructor & Destructor Documentation

◆ mappedPatchFieldBase() [1/6]

mappedPatchFieldBase	(	const mappedPatchBase &	mapper,
		const fvPatchField< Type > &	patchField,
		const word &	fieldName,
		const bool	setAverage,
		const Type	average,
		const word &	interpolationScheme
	)

Construct from components.

Definition at line 320 of file mappedPatchFieldBase.C.

◆ mappedPatchFieldBase() [2/6]

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

Construct from dictionary.

Definition at line 340 of file mappedPatchFieldBase.C.

References dict, Foam::exit(), Foam::FatalError, FatalErrorInFunction, mappedPatchFieldBase< Type >::interpolationScheme_, mappedPatchFieldBase< Type >::mapper_, mappedPatchBase::mode(), mappedPatchBase::NEARESTCELL, mappedPatchBase::NEARESTPATCHFACE, mappedPatchBase::NEARESTPATCHFACEAMI, dictionary::readEntry(), mappedPatchBase::sampleDatabase(), and mappedPatchBase::sampleModeNames_.

Here is the call graph for this function:

◆ mappedPatchFieldBase() [3/6]

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

Construct from dictionary and initial field value.

(for when running in database mode)

Definition at line 396 of file mappedPatchFieldBase.C.

References mapDistributeBase::constructMap(), mappedPatchFieldBase< Type >::initRetrieveField(), mappedPatchBase::map(), mappedPatchFieldBase< Type >::mapper_, mappedPatchBase::mode(), mappedPatchBase::NEARESTPATCHFACE, mappedPatchBase::NEARESTPATCHFACEAMI, mappedPatchFieldBase< Type >::patchField_, mappedPatchBase::sampleDatabase(), mappedPatchBase::samplePatch(), and mappedPatchBase::sampleRegion().

Here is the call graph for this function:

◆ mappedPatchFieldBase() [4/6]

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

Construct empty.

Definition at line 434 of file mappedPatchFieldBase.C.

◆ mappedPatchFieldBase() [5/6]

mappedPatchFieldBase ( const mappedPatchFieldBase< Type > & mapper )

explicit

Construct copy.

Definition at line 450 of file mappedPatchFieldBase.C.

◆ mappedPatchFieldBase() [6/6]

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

Construct copy, resetting patch and field.

Definition at line 465 of file mappedPatchFieldBase.C.

◆ ~mappedPatchFieldBase()

virtual ~mappedPatchFieldBase ( )

virtualdefault

Destructor.

Member Function Documentation

◆ initRetrieveField() [1/2]

void initRetrieveField	(	const objectRegistry &	obr,
		const word &	region,
		const word &	patch,
		const labelListList &	map,
		const word &	fieldName,
		const Field< T > &	fld
	)		const

protected

Construct field from registered elements.

Definition at line 200 of file mappedPatchFieldBase.C.

Referenced by mappedPatchFieldBase< Type >::mappedPatchFieldBase().

Here is the caller graph for this function:

◆ storeAndRetrieveField()

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

protected

Helper : storeField and retrieveField and interpolate. Leaves fld.

unchanged (and returns false) if new values cannot be retrieved. Returns true otherwise.

Definition at line 251 of file mappedPatchFieldBase.C.

◆ initRetrieveField() [2/2]

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

protected

Initialise field to retrieve (e.g. when value read from dictionary)

Definition at line 980 of file mappedPatchFieldBase.C.

References fld(), and mappedPatchBase::NEARESTPATCHFACE.

Here is the call graph for this function:

◆ storeField()

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

protected

Store elements of field onto (sub) registry.

Definition at line 53 of file mappedPatchFieldBase.C.

References Foam::endl(), Foam::flatOutput(), fld(), forAll, Foam::Pout, and UList< T >::size().

Here is the call graph for this function:

◆ retrieveField()

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

Construct field from registered elements.

Returns: true if successful

Definition at line 104 of file mappedPatchFieldBase.C.

References forAll, and UList< T >::size().

Here is the call graph for this function:

◆ sampleField() [1/3]

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

Field to sample. Either on my or nbr mesh.

◆ sampleField() [2/3]

const Foam::GeometricField< Type, Foam::fvPatchField, Foam::volMesh > & sampleField

Field to sample. Either on my or nbr mesh.

Definition at line 515 of file mappedPatchFieldBase.C.

◆ mappedField()

Foam::tmp< Foam::Field< Type > > mappedField

virtual

Map sampleField onto *this patch.

Definition at line 613 of file mappedPatchFieldBase.C.

References Foam::abort(), polyMesh::boundaryMesh(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, polyBoundaryMesh::findPatchID(), fld(), forAll, Foam::gSum(), Foam::mag(), pTraits< complex >::max, polyBoundaryMesh::mesh(), UPstream::msgType(), primitiveMesh::nCells(), mappedPatchBase::NEARESTCELL, mappedPatchBase::NEARESTFACE, mappedPatchBase::NEARESTPATCHFACE, mappedPatchBase::NEARESTPATCHFACEAMI, Time::New(), Foam::New(), primitiveMesh::nFaces(), Foam::nl, mapDistribute::reverseDistribute(), samples(), List< T >::setSize(), UList< T >::size(), and Foam::Zero.

Here is the call graph for this function:

◆ mappedInternalField()

Foam::tmp< Foam::Field< Type > > mappedInternalField

virtual

Map internal of sampleField onto *this patch.

Definition at line 823 of file mappedPatchFieldBase.C.

References UPstream::msgType(), and tmp< T >::ref().

Here is the call graph for this function:

◆ mappedWeightField() [1/2]

Foam::tmp< Foam::scalarField > mappedWeightField

virtual

Map optional weightField onto *this patch. Default is deltaCoeffs.

Definition at line 859 of file mappedPatchFieldBase.C.

References UPstream::msgType(), and tmp< T >::ref().

Here is the call graph for this function:

◆ mappedWeightField() [2/2]

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

virtual

Map optional weightField (given by name) onto *this patch.

Definition at line 896 of file mappedPatchFieldBase.C.

References UPstream::msgType(), and tmp< T >::ref().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented in mappedFieldFvPatchField< Type >, mappedMixedFieldFvPatchField< Type >, mappedFixedPushedInternalValueFvPatchField< Type >, mappedFixedValueFvPatchField< Type >, mappedMixedFvPatchField< Type >, thermalBaffleFvPatchScalarField, mappedFixedInternalValueFvPatchField< Type >, turbulentTemperatureCoupledBaffleMixedFvPatchScalarField, and turbulentTemperatureRadCoupledMixedFvPatchScalarField.

Definition at line 1007 of file mappedPatchFieldBase.C.

References mappedPatchBase::NEARESTCELL, os(), Ostream::writeEntry(), and Ostream::writeEntryIfDifferent().

Here is the call graph for this function:

◆ mapper()

const Foam::mappedPatchBase & mapper	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF
	)

static

Check that patch is of correct type.

Definition at line 958 of file mappedPatchFieldBase.C.

References Foam::exit(), Foam::FatalError, FatalErrorInFunction, IOobject::name(), Foam::nl, IOobject::objectPath(), and p.

Referenced by turbulentTemperatureCoupledBaffleMixedFvPatchScalarField::updateCoeffs(), and turbulentTemperatureRadCoupledMixedFvPatchScalarField::updateCoeffs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ distribute()

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

Wrapper for mapDistribute::distribute that knows about dabase mapping

Definition at line 523 of file mappedPatchFieldBase.C.

References mapDistributeBase::constructMap(), mapDistributeBase::constructSize(), fld(), mappedPatchBase::NEARESTPATCHFACEAMI, AMIInterpolation::srcAddress(), AMIInterpolation::srcMap(), AMIInterpolation::srcWeights(), mapDistributeBase::subMap(), AMIInterpolation::tgtAddress(), AMIInterpolation::tgtMap(), and AMIInterpolation::tgtWeights().

Here is the call graph for this function:

◆ sampleField() [3/3]

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

Definition at line 486 of file mappedPatchFieldBase.C.

References polyMesh::boundaryMesh(), and polyBoundaryMesh::mesh().

Here is the call graph for this function:

Member Data Documentation

◆ mapper_

const mappedPatchBase& mapper_

protected

Mapping engine.

Definition at line 118 of file mappedPatchFieldBase.H.

Referenced by mappedPatchFieldBase< Type >::mappedPatchFieldBase().

◆ patchField_

const fvPatchField<Type>& patchField_

protected

Underlying patch field.

Definition at line 121 of file mappedPatchFieldBase.H.

Referenced by mappedPatchFieldBase< Type >::mappedPatchFieldBase().

◆ fieldName_

word fieldName_

protected

Name of field to sample.

Definition at line 124 of file mappedPatchFieldBase.H.

◆ setAverage_

const bool setAverage_

protected

If true adjust the mapped field to maintain average value average_.

Definition at line 127 of file mappedPatchFieldBase.H.

◆ average_

const Type average_

protected

Average value the mapped field is adjusted to maintain if setAverage_ is set true

Definition at line 131 of file mappedPatchFieldBase.H.

◆ interpolationScheme_

word interpolationScheme_

protected

Interpolation scheme to use for nearestcell mode.

Definition at line 134 of file mappedPatchFieldBase.H.

Referenced by mappedPatchFieldBase< Type >::mappedPatchFieldBase().

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

src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.H
src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedPatchFieldBase.C

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ mappedPatchFieldBase() [1/6]

◆ mappedPatchFieldBase() [2/6]

◆ mappedPatchFieldBase() [3/6]

◆ mappedPatchFieldBase() [4/6]

◆ mappedPatchFieldBase() [5/6]

◆ mappedPatchFieldBase() [6/6]

◆ ~mappedPatchFieldBase()

Member Function Documentation

◆ initRetrieveField() [1/2]

◆ storeAndRetrieveField()

◆ initRetrieveField() [2/2]

◆ storeField()

◆ retrieveField()

◆ sampleField() [1/3]

◆ sampleField() [2/3]

◆ mappedField()

◆ mappedInternalField()

◆ mappedWeightField() [1/2]

◆ mappedWeightField() [2/2]

◆ write()

◆ mapper()

◆ distribute()

◆ sampleField() [3/3]

Member Data Documentation

◆ mapper_

◆ patchField_

◆ fieldName_

◆ setAverage_

◆ average_

◆ interpolationScheme_