This boundary condition provides a self-contained version of the mapped condition. It does not use information on the patch; instead it holds the data locally. More...

Inheritance diagram for mappedFieldFvPatchField< Type >:

[legend]

Collaboration diagram for mappedFieldFvPatchField< Type >:

[legend]

Public Member Functions
	TypeName ("mappedField")

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

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

	mappedFieldFvPatchField (const fvPatch &, const DimensionedField< Type, volMesh > &, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const scalar distance, const word &fieldName, const bool setAverage, const Type average, const word &interpolationScheme)

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

	mappedFieldFvPatchField (const mappedFieldFvPatchField< Type > &)

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

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

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

virtual void	autoMap (const fvPatchFieldMapper &)

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

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 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 mappedPatchBase
	TypeName ("mappedPatchBase")

	mappedPatchBase (const polyPatch &)

	mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vectorField &offsets)

	mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vector &uniformOffset)

	mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const scalar normalDistance)

	mappedPatchBase (const polyPatch &, const dictionary &)

	mappedPatchBase (const polyPatch &, const sampleMode, const dictionary &)

	mappedPatchBase (const polyPatch &, const mappedPatchBase &)

	mappedPatchBase (const polyPatch &, const mappedPatchBase &, const labelUList &mapAddressing)

virtual	~mappedPatchBase ()

void	clearOut ()

void	setOffset (const scalar normalDist)

void	setOffset (const vector &uniformOffset)

void	setOffset (const vectorField &offsets)

sampleMode	mode () const noexcept

const word &	sampleWorld () const noexcept

const word &	sampleRegion () const

const word &	samplePatch () const

const word &	coupleGroup () const

label	sampleSize () const

const vector &	offset () const noexcept

const vectorField &	offsets () const noexcept

label	getCommunicator () const

label	comm () const

bool	sameWorld () const

bool	masterWorld () const

bool	sameRegion () const noexcept

const mapDistribute &	map () const

const AMIPatchToPatchInterpolation &	AMI (const bool forceUpdate=false) const

bool	owner () const

const autoPtr< Foam::searchableSurface > &	surfPtr () const

const polyMesh &	sampleMesh () const

const polyPatch &	samplePolyPatch () const

tmp< pointField >	samplePoints () const

const fileName &	sampleDatabasePath () const

bool	sampleDatabase () const

virtual fileName	sendPath (const label proci) const

virtual fileName	receivePath (const label proci) const

template<class Type >
void	distribute (List< Type > &lst) const

template<class Type , class CombineOp >
void	distribute (List< Type > &lst, const CombineOp &cop) const

template<class Type >
void	reverseDistribute (List< Type > &lst) const

template<class Type , class CombineOp >
void	reverseDistribute (List< Type > &lst, const CombineOp &cop) const

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

Public Types inherited from mappedPatchBase
enum	sampleMode { NEARESTCELL, NEARESTPATCHFACE, NEARESTPATCHFACEAMI, NEARESTPATCHPOINT, NEARESTFACE, NEARESTONLYCELL }

enum	offsetMode { UNIFORM, NONUNIFORM, NORMAL }

typedef Tuple2< pointIndexHit, Tuple2< scalar, label > >	nearInfo

typedef Tuple2< nearInfo, label >	nearInfoWorld

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 mappedPatchBase
static pointIndexHit	facePoint (const polyMesh &, const label facei, const polyMesh::cellDecomposition)

static fileName	sendPath (const fileName &root, const label proci)

static fileName	receivePath (const fileName &root, const label proci)

static const objectRegistry &	subRegistry (const objectRegistry &obr, const fileName &path)

template<class Type >
static void	storeField (objectRegistry &obr, const word &fieldName, const Field< Type > &values)

static void	writeDict (const objectRegistry &obr, dictionary &dict)

static void	readDict (const dictionary &d, objectRegistry &obr)

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

Static Public Attributes inherited from mappedPatchBase
static const Enum< sampleMode >	sampleModeNames_

static const Enum< offsetMode >	offsetModeNames_

Protected Member Functions inherited from mappedPatchBase
bool	addWorldConnection ()

label	getWorldCommunicator () const

const polyMesh &	lookupMesh (const word &region) const

const polyPatch &	lookupPatch (const word &sampleRegion, const word &samplePatch) const

tmp< pointField >	facePoints (const polyPatch &) const

void	collectSamples (const label mySampleWorld, const pointField &facePoints, pointField &samples, labelList &patchFaceWorlds, labelList &patchFaceProcs, labelList &patchFaces, pointField &patchFc) const

void	findLocalSamples (const sampleMode mode, const label sampleWorld, const word &sampleRegion, const word &samplePatch, const pointField &samplePoints, List< nearInfoWorld > &nearest) const

void	findSamples (const sampleMode mode, const label myWorldIndex, const pointField &, const labelList &wantedWorlds, const labelList &origProcs, labelList &sampleProcs, labelList &sampleIndices, pointField &sampleLocations) const

tmp< pointField >	samplePoints (const pointField &) const

void	calcMapping () const

void	calcAMI () const

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

Static Protected Member Functions inherited from mappedPatchBase
static autoPtr< fileName >	readDatabase (const dictionary &dict)

static const objectRegistry &	subRegistry (const objectRegistry &obr, const wordList &names, const label index)

template<class Type >
static bool	writeIOField (const regIOobject &obj, dictionary &dict)

template<class Type >
static bool	constructIOField (const word &name, token &tok, Istream &is, objectRegistry &obr)

Protected Attributes inherited from mappedPatchBase
const polyPatch &	patch_

word	sampleWorld_

word	sampleRegion_

const sampleMode	mode_

word	samplePatch_

const coupleGroupIdentifier	coupleGroup_

const autoPtr< fileName >	sampleDatabasePtr_

offsetMode	offsetMode_

vector	offset_

vectorField	offsets_

scalar	distance_

label	communicator_

bool	sameRegion_

autoPtr< mapDistribute >	mapPtr_

const bool	AMIReverse_

autoPtr< AMIPatchToPatchInterpolation >	AMIPtr_

autoPtr< searchableSurface >	surfPtr_

dictionary	surfDict_

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::mappedFieldFvPatchField< Type >

This boundary condition provides a self-contained version of the mapped condition. It does not use information on the patch; instead it holds the data locally.

Usage

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 use if `setAverage` = yes	partly

Example of the boundary condition specification:

    <patchName>
    {
        type            mappedField;
        field           T;              // optional field name
        setAverage      no;             // apply an average value
        average         0;              // average to apply if setAverage
        value           uniform 0;      // place holder
    }

Note: Since this condition can be applied on a per-field and per-patch basis, it is possible to duplicate the mapping information. If possible, employ the mapped condition in preference to avoid this situation, and only employ this condition if it is not possible to change the underlying geometric (poly) patch type to mapped.

See also: Foam::mappedPatchBase Foam::mappedPolyPatch Foam::mappedFvPatch Foam::fixedValueFvPatchField

Source files

Definition at line 110 of file mappedFieldFvPatchField.H.

Constructor & Destructor Documentation

◆ mappedFieldFvPatchField() [1/6]

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

Definition at line 29 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [2/6]

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

Definition at line 42 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [3/6]

mappedFieldFvPatchField	(	const fvPatch &	p,
		const DimensionedField< Type, volMesh > &	iF,
		const word &	sampleRegion,
		const sampleMode	sampleMode,
		const word &	samplePatch,
		const scalar	distance,
		const word &	fieldName,
		const bool	setAverage,
		const Type	average,
		const word &	interpolationScheme
	)

Definition at line 71 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [4/6]

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

Definition at line 56 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [5/6]

mappedFieldFvPatchField ( const mappedFieldFvPatchField< Type > & ptf )

Definition at line 111 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [6/6]

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

Definition at line 123 of file mappedFieldFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedField" )

◆ clone() [1/2]

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

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 178 of file mappedFieldFvPatchField.H.

◆ clone() [2/2]

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

inlinevirtual

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 198 of file mappedFieldFvPatchField.H.

◆ autoMap()

void autoMap ( const fvPatchFieldMapper & m )

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 138 of file mappedFieldFvPatchField.C.

◆ rmap()

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

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 149 of file mappedFieldFvPatchField.C.

◆ updateCoeffs()

void updateCoeffs

virtual

Reimplemented from fvPatchField< Type >.

Definition at line 160 of file mappedFieldFvPatchField.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 >.

Definition at line 184 of file mappedFieldFvPatchField.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/mappedField/mappedFieldFvPatchField.H
src/finiteVolume/fields/fvPatchFields/derived/mappedField/mappedFieldFvPatchField.C

Public Member Functions

Additional Inherited Members

Detailed Description

template<class Type> class Foam::mappedFieldFvPatchField< Type >

Constructor & Destructor Documentation

◆ mappedFieldFvPatchField() [1/6]

◆ mappedFieldFvPatchField() [2/6]

◆ mappedFieldFvPatchField() [3/6]

◆ mappedFieldFvPatchField() [4/6]

◆ mappedFieldFvPatchField() [5/6]

◆ mappedFieldFvPatchField() [6/6]

Member Function Documentation

◆ TypeName()

◆ clone() [1/2]

◆ clone() [2/2]

◆ autoMap()

◆ rmap()

◆ updateCoeffs()

◆ write()

template<class Type>
class Foam::mappedFieldFvPatchField< Type >