Interpolation class dealing with transfer of data between two primitive patches with an arbitrary mesh interface (AMI). More...

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

	AMIInterpolation (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const faceAreaIntersect::triangulationMode &triMode, const bool requireMatch=true, const word &methodName=faceAreaWeightAMI::typeName, const scalar lowWeightCorrection=-1, const bool reverseTarget=false, const bool report=true)
	Construct from components. More...

	AMIInterpolation (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const autoPtr< searchableSurface > &surf, const faceAreaIntersect::triangulationMode &triMode, const bool requireMatch=true, const word &methodName=faceAreaWeightAMI::typeName, const scalar lowWeightCorrection=-1, const bool reverseTarget=false, const bool report=true)
	Construct from components, with projection surface. More...

	AMIInterpolation (const AMIInterpolation &fineAMI, const labelList &sourceRestrictAddressing, const labelList &neighbourRestrictAddressing, const bool report=false)
	Construct from agglomeration of AMIInterpolation. More...

	AMIInterpolation (const AMIInterpolation &)=delete
	Disallow default bitwise copy construction. More...

virtual	~AMIInterpolation ()
	Destructor. More...

label	singlePatchProc () const
	Set to -1, or the processor holding all faces (both sides) of. More...

scalar	lowWeightCorrection () const
	Threshold weight below which interpolation is deactivated. More...

bool	applyLowWeightCorrection () const
	Return true if employing a 'lowWeightCorrection'. More...

const scalarField &	srcMagSf () const
	Return const access to source patch face areas. More...

const labelListList &	srcAddress () const
	Return const access to source patch addressing. More...

const scalarListList &	srcWeights () const
	Return const access to source patch weights. More...

scalarListList &	srcWeights ()
	Return access to source patch weights. More...

const scalarField &	srcWeightsSum () const
	Return const access to normalisation factor of source. More...

scalarField &	srcWeightsSum ()
	Return access to normalisation factor of source. More...

const distributionMap &	srcMap () const
	Source map pointer - valid only if singlePatchProc = -1. More...

const scalarField &	tgtMagSf () const
	Return const access to target patch face areas. More...

const labelListList &	tgtAddress () const
	Return const access to target patch addressing. More...

const scalarListList &	tgtWeights () const
	Return const access to target patch weights. More...

scalarListList &	tgtWeights ()
	Return access to target patch weights. More...

const scalarField &	tgtWeightsSum () const
	Return const access to normalisation factor of target. More...

scalarField &	tgtWeightsSum ()
	Return access to normalisation factor of target. More...

const distributionMap &	tgtMap () const
	Target map pointer - valid only if singlePatchProc=-1. More...

void	update (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const bool report)
	Update addressing and weights. More...

template<class Type , class CombineOp >
void	interpolateToSource (const UList< Type > &fld, const CombineOp &cop, List< Type > &result, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from target to source with supplied op. More...

template<class Type , class CombineOp >
void	interpolateToTarget (const UList< Type > &fld, const CombineOp &cop, List< Type > &result, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from source to target with supplied op. More...

template<class Type , class CombineOp >
tmp< Field< Type > >	interpolateToSource (const Field< Type > &fld, const CombineOp &cop, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from target to source with supplied op. More...

template<class Type , class CombineOp >
tmp< Field< Type > >	interpolateToSource (const tmp< Field< Type >> &tFld, const CombineOp &cop, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from target tmp field to source with supplied op. More...

template<class Type , class CombineOp >
tmp< Field< Type > >	interpolateToTarget (const Field< Type > &fld, const CombineOp &cop, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from source to target with supplied op. More...

template<class Type , class CombineOp >
tmp< Field< Type > >	interpolateToTarget (const tmp< Field< Type >> &tFld, const CombineOp &cop, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from source tmp field to target with supplied op. More...

template<class Type >
tmp< Field< Type > >	interpolateToSource (const Field< Type > &fld, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from target to source. More...

template<class Type >
tmp< Field< Type > >	interpolateToSource (const tmp< Field< Type >> &tFld, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from target tmp field. More...

template<class Type >
tmp< Field< Type > >	interpolateToTarget (const Field< Type > &fld, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from source to target. More...

template<class Type >
tmp< Field< Type > >	interpolateToTarget (const tmp< Field< Type >> &tFld, const UList< Type > &defaultValues=UList< Type >::null()) const
	Interpolate from source tmp field. More...

label	srcPointFace (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const vector &n, const label tgtFacei, point &tgtPoint) const
	Return source patch face index of point on target patch face. More...

label	tgtPointFace (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const vector &n, const label srcFacei, point &srcPoint) const
	Return target patch face index of point on source patch face. More...

void	writeFaceConnectivity (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const labelListList &srcAddress) const
	Write face connectivity as OBJ file. More...

void	operator= (const AMIInterpolation &)=delete
	Disallow default bitwise assignment. More...

template<class Type , class CombineOp >
Foam::tmp< Foam::Field< Type > >	interpolateToSource (const Field< Type > &fld, const CombineOp &cop, const UList< Type > &defaultValues) const

template<class Type , class CombineOp >
Foam::tmp< Foam::Field< Type > >	interpolateToSource (const tmp< Field< Type >> &tFld, const CombineOp &cop, const UList< Type > &defaultValues) const

template<class Type , class CombineOp >
Foam::tmp< Foam::Field< Type > >	interpolateToTarget (const Field< Type > &fld, const CombineOp &cop, const UList< Type > &defaultValues) const

template<class Type , class CombineOp >
Foam::tmp< Foam::Field< Type > >	interpolateToTarget (const tmp< Field< Type >> &tFld, const CombineOp &cop, const UList< Type > &defaultValues) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolateToSource (const Field< Type > &fld, const UList< Type > &defaultValues) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolateToSource (const tmp< Field< Type >> &tFld, const UList< Type > &defaultValues) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolateToTarget (const Field< Type > &fld, const UList< Type > &defaultValues) const

template<class Type >
Foam::tmp< Foam::Field< Type > >	interpolateToTarget (const tmp< Field< Type >> &tFld, const UList< Type > &defaultValues) const

Static Public Member Functions
static void	sumWeights (AMIInterpolation &AMI)
	Sum the weights on both sides of an AMI. More...

static void	sumWeights (PtrList< AMIInterpolation > &AMIs)
	As above, but for multiple AMI-s. More...

static void	reportSumWeights (AMIInterpolation &AMI)
	Print out information relating to the weights sum. Values close. More...

static void	normaliseWeights (AMIInterpolation &AMI)
	Normalise the weights on both sides of an AMI. More...

static void	normaliseWeights (UPtrList< AMIInterpolation > &AMIs)
	As above, but for multiple AMI-s. More...

static tmp< scalarField >	patchMagSf (const primitivePatch &patch, const faceAreaIntersect::triangulationMode triMode)
	Calculate the patch face magnitudes for the given tri-mode. More...

Detailed Description

Interpolation class dealing with transfer of data between two primitive patches with an arbitrary mesh interface (AMI).

Based on the algorithm given in:

Conservative interpolation between volume meshes by local Galerkin projection, Farrell PE and Maddison JR, 2011, Comput. Methods Appl. Mech Engrg, Volume 200, Issues 1-4, pp 89-100

Interpolation requires that the two patches should have opposite orientations (opposite normals). The 'reverseTarget' flag can be used to reverse the orientation of the target patch.

Source files

Definition at line 70 of file AMIInterpolation.H.

Constructor & Destructor Documentation

◆ AMIInterpolation() [1/4]

AMIInterpolation	(	const primitivePatch &	srcPatch,
		const primitivePatch &	tgtPatch,
		const faceAreaIntersect::triangulationMode &	triMode,
		const bool	requireMatch = `true`,
		const word &	methodName = `faceAreaWeightAMI::typeName`,
		const scalar	lowWeightCorrection = `-1`,
		const bool	reverseTarget = `false`,
		const bool	report = `true`
	)

Construct from components.

Definition at line 559 of file AMIInterpolation.C.

Referenced by AMIInterpolation::AMIInterpolation(), and AMIInterpolation::patchMagSf().

Here is the caller graph for this function:

◆ AMIInterpolation() [2/4]

AMIInterpolation	(	const primitivePatch &	srcPatch,
		const primitivePatch &	tgtPatch,
		const autoPtr< searchableSurface > &	surf,
		const faceAreaIntersect::triangulationMode &	triMode,
		const bool	requireMatch = `true`,
		const word &	methodName = `faceAreaWeightAMI::typeName`,
		const scalar	lowWeightCorrection = `-1`,
		const bool	reverseTarget = `false`,
		const bool	report = `true`
	)

Construct from components, with projection surface.

Definition at line 590 of file AMIInterpolation.C.

References AMIInterpolation::AMIInterpolation().

Here is the call graph for this function:

◆ AMIInterpolation() [3/4]

AMIInterpolation	(	const AMIInterpolation &	fineAMI,
		const labelList &	sourceRestrictAddressing,
		const labelList &	neighbourRestrictAddressing,
		const bool	report = `false`
	)

Construct from agglomeration of AMIInterpolation.

Agglomeration passed in as new coarse size and addressing from fine from coarse

Definition at line 622 of file AMIInterpolation.C.

References Foam::endl(), Foam::exit(), Foam::FatalError, FatalErrorInFunction, Foam::max(), Foam::nl, Foam::Pout, List< T >::size(), AMIInterpolation::srcAddress(), AMIInterpolation::srcMagSf(), AMIInterpolation::srcWeights(), AMIInterpolation::tgtAddress(), AMIInterpolation::tgtMagSf(), and AMIInterpolation::tgtWeights().

Here is the call graph for this function:

◆ AMIInterpolation() [4/4]

AMIInterpolation ( const AMIInterpolation & )

delete

Disallow default bitwise copy construction.

◆ ~AMIInterpolation()

~AMIInterpolation ( )

virtual

Destructor.

Definition at line 735 of file AMIInterpolation.C.

References AMIInterpolation::update().

Here is the call graph for this function:

Member Function Documentation

◆ TypeName()

TypeName ( "cyclicAMI" )

Runtime type information.

◆ singlePatchProc()

Foam::label singlePatchProc ( ) const

inline

Set to -1, or the processor holding all faces (both sides) of.

the AMI

Definition at line 26 of file AMIInterpolationI.H.

◆ lowWeightCorrection()

Foam::scalar lowWeightCorrection ( ) const

inline

Threshold weight below which interpolation is deactivated.

Definition at line 32 of file AMIInterpolationI.H.

◆ applyLowWeightCorrection()

bool applyLowWeightCorrection ( ) const

inline

Return true if employing a 'lowWeightCorrection'.

Definition at line 38 of file AMIInterpolationI.H.

◆ srcMagSf()

const Foam::scalarField & srcMagSf ( ) const

inline

Return const access to source patch face areas.

Definition at line 44 of file AMIInterpolationI.H.

Referenced by AMIInterpolation::AMIInterpolation().

Here is the caller graph for this function:

◆ srcAddress()

const Foam::labelListList & srcAddress ( ) const

inline

Return const access to source patch addressing.

Definition at line 50 of file AMIInterpolationI.H.

Referenced by AMIInterpolation::AMIInterpolation().

Here is the caller graph for this function:

◆ srcWeights() [1/2]

const Foam::scalarListList & srcWeights ( ) const

inline

Return const access to source patch weights.

Definition at line 56 of file AMIInterpolationI.H.

Referenced by AMIInterpolation::AMIInterpolation().

Here is the caller graph for this function:

◆ srcWeights() [2/2]

Foam::scalarListList & srcWeights ( )

inline

Return access to source patch weights.

Definition at line 62 of file AMIInterpolationI.H.

◆ srcWeightsSum() [1/2]

const Foam::scalarField & srcWeightsSum ( ) const

inline

Return const access to normalisation factor of source.

patch weights (i.e. the sum before normalisation)

Definition at line 68 of file AMIInterpolationI.H.

◆ srcWeightsSum() [2/2]

Foam::scalarField & srcWeightsSum ( )

inline

Return access to normalisation factor of source.

patch weights (i.e. the sum before normalisation)

Definition at line 74 of file AMIInterpolationI.H.

◆ srcMap()

const Foam::distributionMap & srcMap ( ) const

inline

Source map pointer - valid only if singlePatchProc = -1.

This gets source data into a form to be consumed by tgtAddress, tgtWeights

Definition at line 80 of file AMIInterpolationI.H.

◆ tgtMagSf()

const Foam::scalarField & tgtMagSf ( ) const

inline

Return const access to target patch face areas.

Definition at line 86 of file AMIInterpolationI.H.

Referenced by AMIInterpolation::AMIInterpolation().

Here is the caller graph for this function:

◆ tgtAddress()

const Foam::labelListList & tgtAddress ( ) const

inline

Return const access to target patch addressing.

Definition at line 92 of file AMIInterpolationI.H.

Referenced by AMIInterpolation::AMIInterpolation().

Here is the caller graph for this function:

◆ tgtWeights() [1/2]

const Foam::scalarListList & tgtWeights ( ) const

inline

Return const access to target patch weights.

Definition at line 98 of file AMIInterpolationI.H.

Referenced by AMIInterpolation::AMIInterpolation().

Here is the caller graph for this function:

◆ tgtWeights() [2/2]

Foam::scalarListList & tgtWeights ( )

inline

Return access to target patch weights.

Definition at line 104 of file AMIInterpolationI.H.

◆ tgtWeightsSum() [1/2]

const Foam::scalarField & tgtWeightsSum ( ) const

inline

Return const access to normalisation factor of target.

patch weights (i.e. the sum before normalisation)

Definition at line 110 of file AMIInterpolationI.H.

◆ tgtWeightsSum() [2/2]

Foam::scalarField & tgtWeightsSum ( )

inline

Return access to normalisation factor of target.

patch weights (i.e. the sum before normalisation)

Definition at line 116 of file AMIInterpolationI.H.

◆ tgtMap()

const Foam::distributionMap & tgtMap ( ) const

inline

Target map pointer - valid only if singlePatchProc=-1.

This gets target data into a form to be consumed by srcAddress, srcWeights

Definition at line 122 of file AMIInterpolationI.H.

◆ update()

void update	(	const primitivePatch &	srcPatch,
		const primitivePatch &	tgtPatch,
		const bool	report
	)

Update addressing and weights.

Definition at line 742 of file AMIInterpolation.C.

References AMIMethod::calculate(), distributionMapBase::constructMap(), distributionMapBase::distribute(), Foam::endl(), forAll, Foam::gSum(), Foam::indent(), Foam::Info, AMIMethod::New(), Foam::nl, UPstream::nonBlocking, Foam::returnReduce(), List< T >::size(), distributionMapBase::subMap(), and faceAreaIntersect::triangulationModeNames_.

Referenced by AMIInterpolation::~AMIInterpolation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sumWeights() [1/2]

void sumWeights ( AMIInterpolation & AMI )

static

Sum the weights on both sides of an AMI.

Definition at line 976 of file AMIInterpolation.C.

◆ sumWeights() [2/2]

void sumWeights ( PtrList< AMIInterpolation > & AMIs )

static

As above, but for multiple AMI-s.

Definition at line 983 of file AMIInterpolation.C.

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

Here is the call graph for this function:

◆ reportSumWeights()

void reportSumWeights ( AMIInterpolation & AMI )

static

Print out information relating to the weights sum. Values close.

to one are ideal. This information acts as a measure of the quality of the AMI.

Definition at line 1013 of file AMIInterpolation.C.

◆ normaliseWeights() [1/2]

void normaliseWeights ( AMIInterpolation & AMI )

static

Normalise the weights on both sides of an AMI.

Definition at line 1033 of file AMIInterpolation.C.

◆ normaliseWeights() [2/2]

void normaliseWeights ( UPtrList< AMIInterpolation > & AMIs )

static

As above, but for multiple AMI-s.

Definition at line 1040 of file AMIInterpolation.C.

References forAll, UPtrList< T >::size(), and AMIInterpolation::srcPointFace().

Here is the call graph for this function:

◆ interpolateToSource() [1/9]

void interpolateToSource	(	const UList< Type > &	fld,
		const CombineOp &	cop,
		List< Type > &	result,
		const UList< Type > &	defaultValues = `UList<Type>::null()`
	)		const

Interpolate from target to source with supplied op.

to combine existing value with remote value and weight

Definition at line 120 of file AMIInterpolationTemplates.C.

References Foam::abort(), distributionMap::distribute(), Foam::FatalError, FatalErrorInFunction, forAll, Foam::nl, List< T >::setSize(), and UList< T >::size().

Referenced by mappedPatchBase::distribute(), AMIInterpolation::interpolateToSource(), AMIInterpolation::interpolateToTarget(), and meshToMesh::mapSrcToTgt().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolateToTarget() [1/9]

void interpolateToTarget	(	const UList< Type > &	fld,
		const CombineOp &	cop,
		List< Type > &	result,
		const UList< Type > &	defaultValues = `UList<Type>::null()`
	)		const

Interpolate from source to target with supplied op.

to combine existing value with remote value and weight

Definition at line 36 of file AMIInterpolationTemplates.C.

References Foam::abort(), distributionMap::distribute(), Foam::FatalError, FatalErrorInFunction, forAll, AMIInterpolation::interpolateToSource(), Foam::nl, List< T >::setSize(), and UList< T >::size().

Referenced by AMIInterpolation::interpolateToSource(), AMIInterpolation::interpolateToTarget(), meshToMesh::mapTgtToSrc(), and mappedPatchBase::reverseDistribute().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ interpolateToSource() [2/9]

tmp<Field<Type> > interpolateToSource	(	const Field< Type > &	fld,
		const CombineOp &	cop,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from target to source with supplied op.

◆ interpolateToSource() [3/9]

tmp<Field<Type> > interpolateToSource	(	const tmp< Field< Type >> &	tFld,
		const CombineOp &	cop,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from target tmp field to source with supplied op.

◆ interpolateToTarget() [2/9]

tmp<Field<Type> > interpolateToTarget	(	const Field< Type > &	fld,
		const CombineOp &	cop,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from source to target with supplied op.

◆ interpolateToTarget() [3/9]

tmp<Field<Type> > interpolateToTarget	(	const tmp< Field< Type >> &	tFld,
		const CombineOp &	cop,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from source tmp field to target with supplied op.

◆ interpolateToSource() [4/9]

tmp<Field<Type> > interpolateToSource	(	const Field< Type > &	fld,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from target to source.

◆ interpolateToSource() [5/9]

tmp<Field<Type> > interpolateToSource	(	const tmp< Field< Type >> &	tFld,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from target tmp field.

◆ interpolateToTarget() [4/9]

tmp<Field<Type> > interpolateToTarget	(	const Field< Type > &	fld,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from source to target.

◆ interpolateToTarget() [5/9]

tmp<Field<Type> > interpolateToTarget	(	const tmp< Field< Type >> &	tFld,
		const UList< Type > &	defaultValues = `UList< Type >::null()`
	)		const

Interpolate from source tmp field.

◆ srcPointFace()

Foam::label srcPointFace	(	const primitivePatch &	srcPatch,
		const primitivePatch &	tgtPatch,
		const vector &	n,
		const label	tgtFacei,
		point &	tgtPoint
	)		const

Return source patch face index of point on target patch face.

Definition at line 1061 of file AMIInterpolation.C.

References PointHit< Point >::distance(), PointHit< Point >::eligibleMiss(), f(), forAll, PointHit< Point >::hit(), face::nearestPoint(), PrimitivePatch< FaceList, PointField >::points(), PointHit< Point >::rawPoint(), face::ray(), AMIInterpolation::tgtPointFace(), and intersection::visible.

Referenced by AMIInterpolation::normaliseWeights().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ tgtPointFace()

Foam::label tgtPointFace	(	const primitivePatch &	srcPatch,
		const primitivePatch &	tgtPatch,
		const vector &	n,
		const label	srcFacei,
		point &	srcPoint
	)		const