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

Inheritance diagram for mappedFieldFvPatchField< Type >:

[legend]

Collaboration diagram for mappedFieldFvPatchField< Type >:

[legend]

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

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

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

	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)
	Construct from patch, internal field and distance for normal type. More...

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

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

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

	mappedFieldFvPatchField (const mappedFieldFvPatchField< 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...

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

Public Member Functions inherited from mappedPatchBase
	TypeName ("mappedPatchBase")
	Runtime type information. More...

	mappedPatchBase (const polyPatch &)
	Construct from patch. More...

	mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vectorField &offsets)
	Construct with offsetMode=non-uniform. More...

	mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const vector &offset)
	Construct from offsetMode=uniform. More...

	mappedPatchBase (const polyPatch &pp, const word &sampleRegion, const sampleMode sampleMode, const word &samplePatch, const scalar distance)
	Construct from offsetMode=normal and distance. More...

	mappedPatchBase (const polyPatch &, const dictionary &)
	Construct from dictionary. More...

	mappedPatchBase (const polyPatch &, const sampleMode, const dictionary &)
	Construct from dictionary and (collocated) sample mode. More...

	mappedPatchBase (const polyPatch &, const mappedPatchBase &)
	Construct as copy, resetting patch. More...

	mappedPatchBase (const polyPatch &, const mappedPatchBase &, const labelUList &mapAddressing)
	Construct as copy, resetting patch, map original data. More...

virtual	~mappedPatchBase ()
	Destructor. More...

void	clearOut ()

const sampleMode &	mode () const
	What to sample. More...

const word &	sampleRegion () const
	Region to sample. More...

const word &	samplePatch () const
	Patch (only if NEARESTPATCHFACE) More...

const word &	coupleGroup () const
	PatchGroup (only if NEARESTPATCHFACE) More...

label	sampleSize () const
	Return size of mapped mesh/patch/boundary. More...

const vector &	offset () const
	Offset vector (from patch faces to destination mesh objects) More...

const vectorField &	offsets () const
	Offset vector (from patch faces to destination mesh objects) More...

bool	sameRegion () const
	Cached sampleRegion != mesh.name() More...

const mapDistribute &	map () const
	Return reference to the parallel distribution map. More...

const AMIPatchToPatchInterpolation &	AMI (const bool forceUpdate=false) const
	Return reference to the AMI interpolator. More...

const autoPtr< Foam::searchableSurface > &	surfPtr () const
	Return a pointer to the AMI projection surface. More...

const polyMesh &	sampleMesh () const
	Get the region mesh. More...

const polyPatch &	samplePolyPatch () const
	Get the patch on the region. More...

tmp< pointField >	samplePoints () const
	Get the sample points. More...

template<class Type >
void	distribute (List< Type > &lst) const
	Wrapper around map/interpolate data distribution. More...

template<class Type , class CombineOp >
void	distribute (List< Type > &lst, const CombineOp &cop) const
	Wrapper around map/interpolate data distribution with operation. More...

template<class Type >
void	reverseDistribute (List< Type > &lst) const
	Wrapper around map/interpolate data distribution. More...

template<class Type , class CombineOp >
void	reverseDistribute (List< Type > &lst, const CombineOp &cop) const
	Wrapper around map/interpolate data distribution with operation. More...

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

Additional Inherited Members
Public Types inherited from fvPatchField< Type >
typedef fvPatch	Patch

Public Types inherited from mappedPatchBase
enum	sampleMode { NEARESTCELL, NEARESTPATCHFACE, NEARESTPATCHFACEAMI, NEARESTPATCHPOINT, NEARESTFACE, NEARESTONLYCELL }
	Mesh items to sample. More...

enum	offsetMode { UNIFORM, NONUNIFORM, NORMAL }
	How to project face centres. More...

typedef Tuple2< pointIndexHit, Tuple2< scalar, label > >	nearInfo
	Helper class for finding nearest. More...

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 Member Functions inherited from mappedPatchBase
static pointIndexHit	facePoint (const polyMesh &, const label faceI, const polyMesh::cellDecomposition)
	Get a point on the face given a face decomposition method: More...

Static Public Attributes inherited from fvPatchField< Type >
static int	disallowGenericFvPatchField
	Debug switch to disallow the use of genericFvPatchField. More...

Static Public Attributes inherited from mappedPatchBase
static const NamedEnum< sampleMode, 6 >	sampleModeNames_

static const NamedEnum< offsetMode, 3 >	offsetModeNames_

Protected Member Functions inherited from mappedPatchBase
tmp< pointField >	facePoints (const polyPatch &) const
	Get the points from face-centre-decomposition face centres. More...

void	collectSamples (const pointField &facePoints, pointField &, labelList &patchFaceProcs, labelList &patchFaces, pointField &patchFc) const
	Collect single list of samples and originating processor+face. More...

void	findSamples (const sampleMode mode, const pointField &, labelList &sampleProcs, labelList &sampleIndices, pointField &sampleLocations) const
	Find cells/faces containing samples. More...

tmp< pointField >	samplePoints (const pointField &) const
	Get the sample points given the face points. More...

void	calcMapping () const
	Calculate mapping. More...

void	calcAMI () const
	Calculate AMI interpolator. More...

Static Protected Member Functions inherited from mappedPatchBase
static tmp< pointField >	readListOrField (const word &keyword, const dictionary &dict, const label size)
	Helper to read field or non-uniform list from dictionary. More...

Protected Attributes inherited from mappedPatchBase
const polyPatch &	patch_
	Patch to sample. More...

word	sampleRegion_
	Region to sample. More...

const sampleMode	mode_
	What to sample. More...

word	samplePatch_
	Patch (if in sampleMode NEARESTPATCH*) More...

const coupleGroupIdentifier	coupleGroup_
	PatchGroup (if in sampleMode NEARESTPATCH*) More...

offsetMode	offsetMode_
	How to obtain samples. More...

vector	offset_
	Offset vector (uniform) More...

vectorField	offsets_
	Offset vector (nonuniform) More...

scalar	distance_
	Offset distance (normal) More...

bool	sameRegion_
	Same region. More...

autoPtr< mapDistribute >	mapPtr_
	Communication schedule: More...

autoPtr< AMIPatchToPatchInterpolation >	AMIPtr_
	Pointer to AMI interpolator. More...

const bool	AMIReverse_
	Flag to indicate that slave patch should be reversed for AMI. More...

autoPtr< searchableSurface >	surfPtr_
	Pointer to projection surface employed by AMI interpolator. More...

dictionary	surfDict_
	Dictionary storing projection surface description. More...

Protected Attributes inherited from mappedPatchFieldBase< Type >
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_
	Average value the mapped field is adjusted to maintain if. More...

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

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 thr data locally.

Patch usage

Property	Description	Required	Default value
`fieldName`	name of field to be mapped	no	this field name
`setAverage`	flag to activate setting of average value	yes
`average`	average value to apply if `setAverage` = yes	yes

Example of the boundary condition specification:

    myPatch
    {
        type            mappedField;
        fieldName       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 111 of file mappedFieldFvPatchField.H.

Constructor & Destructor Documentation

◆ mappedFieldFvPatchField() [1/6]

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

Construct from patch and internal field.

Definition at line 40 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [2/6]

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

Construct from patch, internal field and dictionary.

Definition at line 68 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
	)

Construct from patch, internal field and distance for normal type.

sampling

Definition at line 82 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [4/6]

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

Construct by mapping given.

mappedFieldFvPatchField onto a new patch

Definition at line 53 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [5/6]

mappedFieldFvPatchField ( const mappedFieldFvPatchField< Type > & ptf )

Construct as copy.

Definition at line 122 of file mappedFieldFvPatchField.C.

◆ mappedFieldFvPatchField() [6/6]

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

Construct as copy setting internal field reference.

Definition at line 134 of file mappedFieldFvPatchField.C.

Member Function Documentation

◆ TypeName()

TypeName ( "mappedField" )

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 179 of file mappedFieldFvPatchField.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 199 of file mappedFieldFvPatchField.H.

◆ updateCoeffs()

void updateCoeffs

virtual

Update the coefficients associated with the patch field.

Reimplemented from fvPatchField< Type >.

Definition at line 148 of file mappedFieldFvPatchField.C.

References dimensionedInternalField(), Foam::endl(), Foam::gAverage(), Foam::gMax(), Foam::gMin(), Foam::Info, Foam::operator==(), and fvPatchField< Type >::updateCoeffs().

Here is the call graph for this function:

◆ write()

void write ( Ostream & os ) const

virtual

Write.

Reimplemented from fixedValueFvPatchField< Type >.

Definition at line 172 of file mappedFieldFvPatchField.C.

References mappedPatchFieldBase< Type >::write(), mappedPatchBase::write(), and fvPatchField::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]

◆ updateCoeffs()

◆ write()

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