Nearest-face Arbitrary Mesh Interface (AMI) method. More...

Inheritance diagram for nearestFaceAMI:

Collaboration diagram for nearestFaceAMI:

Classes
class	nearestEqOp
	Helper class for finding nearest. More...

Public Types
typedef Tuple2< pointIndexHit, scalar >	nearestAndDist

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

	nearestFaceAMI (const dictionary &dict, const bool reverseTarget=false)
	Construct from dictionary. More...

	nearestFaceAMI (const bool requireMatch=true, const bool reverseTarget=false, const scalar lowWeightCorrection=-1)
	Construct from components. More...

	nearestFaceAMI (const nearestFaceAMI &ami)
	Construct as copy. More...

virtual autoPtr< AMIInterpolation >	clone () const
	Construct and return a clone. More...

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

virtual bool	calculate (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const autoPtr< searchableSurface > &surfPtr=nullptr)
	Update addressing and weights. More...

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

	declareRunTimeSelectionTable (autoPtr, AMIInterpolation, dict,(const dictionary &dict, const bool reverseTarget),(dict, reverseTarget))
	Selection table for dictionary construction. More...

	declareRunTimeSelectionTable (autoPtr, AMIInterpolation, component,(const bool requireMatch, const bool reverseTarget, const scalar lowWeightCorrection),(requireMatch, reverseTarget, lowWeightCorrection))
	Selection table for component-wise construction. More...

	AMIInterpolation (const dictionary &dict, const bool reverseTarget=false)
	Construct from dictionary. More...

	AMIInterpolation (const bool requireMatch=true, const bool reverseTarget=false, const scalar lowWeightCorrection=-1)
	Construct from components. More...

	AMIInterpolation (const AMIInterpolation &fineAMI, const labelList &sourceRestrictAddressing, const labelList &neighbourRestrictAddressing)

	AMIInterpolation (const AMIInterpolation &ami)
	Construct as copy. More...

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

bool	upToDate () const
	Access to the up-to-date flag. More...

bool &	upToDate ()
	Access to the up-to-date flag. More...

bool	distributed () const
	Access to the distributed flag. More...

bool	requireMatch () const
	Access to the requireMatch flag. More...

bool	setRequireMatch (const bool flag)
	Access to the requireMatch flag. More...

bool	mustMatchFaces () const
	Return true if requireMatch and lowWeightCorrectionin active. More...

bool	reverseTarget () const
	Access to the reverseTarget flag. More...

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

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

label	singlePatchProc () const

const List< scalar > &	srcMagSf () const
	Return const access to source patch face areas. More...

List< scalar > &	srcMagSf ()
	Return access to source patch face areas. More...

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

labelListList &	srcAddress ()
	Return 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

scalarField &	srcWeightsSum ()

const pointListList &	srcCentroids () const
	Return const access to source patch face centroids. More...

pointListList &	srcCentroids ()
	Return access to source patch face centroids. More...

const mapDistribute &	srcMap () const

const List< scalar > &	tgtMagSf () const
	Return const access to target patch face areas. More...

List< scalar > &	tgtMagSf ()
	Return access to target patch face areas. More...

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

labelListList &	tgtAddress ()
	Return 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

scalarField &	tgtWeightsSum ()

const mapDistribute &	tgtMap () const

void	reset (autoPtr< mapDistribute > &&srcToTgtMap, autoPtr< mapDistribute > &&tgtToSrcMap, labelListList &&srcAddress, scalarListList &&srcWeights, labelListList &&tgtAddress, scalarListList &&tgtWeights)
	Set the maps, addresses and weights from an external source. More...

void	append (const primitivePatch &srcPatch, const primitivePatch &tgtPatch)
	Append additional addressing and weights. More...

void	normaliseWeights (const bool conformal, const bool output)
	Normalise the 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

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

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...

bool	checkSymmetricWeights (const bool log) const

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

virtual void	write (Ostream &os) const
	Write. 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

Additional Inherited Members
Static Public Member Functions inherited from AMIInterpolation
static autoPtr< AMIInterpolation >	New (const word &modelName, const dictionary &dict, const bool reverseTarget=false)
	Selector for dictionary. More...

static autoPtr< AMIInterpolation >	New (const word &modelName, const bool requireMatch=true, const bool reverseTarget=false, const scalar lowWeightCorrection=-1)
	Selector for components. More...

Static Public Attributes inherited from AMIInterpolation
static bool	cacheIntersections_ = false

Protected Types inherited from AMIInterpolation
typedef treeDataPrimitivePatch< primitivePatch >	treeType
	Local typedef to octree tree-type. More...

Protected Member Functions inherited from AMIInterpolation
void	operator= (const AMIInterpolation &)=delete
	No copy assignment. More...

autoPtr< indexedOctree< treeType > >	createTree (const primitivePatch &patch) const
	Reset the octree for the patch face search. More...

label	calcDistribution (const primitivePatch &srcPatch, const primitivePatch &tgtPatch) const
	Calculate if patches are on multiple processors. More...

void	projectPointsToSurface (const searchableSurface &surf, pointField &pts) const
	Project points to surface. More...

const primitivePatch &	srcPatch0 () const
	Return the orginal src patch with optionally updated points. More...

const primitivePatch &	tgtPatch0 () const
	Return the orginal tgt patch with optionally updated points. More...

Static Protected Member Functions inherited from AMIInterpolation
static void	normaliseWeights (const scalarList &patchAreas, const word &patchName, const labelListList &addr, scalarListList &wght, scalarField &wghtSum, const bool conformal, const bool output, const scalar lowWeightTol)

static void	agglomerate (const autoPtr< mapDistribute > &targetMap, const scalarList &fineSrcMagSf, const labelListList &fineSrcAddress, const scalarListList &fineSrcWeights, const labelList &sourceRestrictAddressing, const labelList &targetRestrictAddressing, scalarList &srcMagSf, labelListList &srcAddress, scalarListList &srcWeights, scalarField &srcWeightsSum, autoPtr< mapDistribute > &tgtMap)

Protected Attributes inherited from AMIInterpolation
bool	requireMatch_

const bool	reverseTarget_

const scalar	lowWeightCorrection_
	Threshold weight below which interpolation is deactivated. More...

label	singlePatchProc_

scalarList	srcMagSf_
	Source face areas. More...

labelListList	srcAddress_
	Addresses of target faces per source face. More...

scalarListList	srcWeights_
	Weights of target faces per source face. More...

scalarField	srcWeightsSum_
	Sum of weights of target faces per source face. More...

pointListList	srcCentroids_
	Centroid of target faces per source face. More...

pointField	srcPatchPts_

refPtr< primitivePatch >	tsrcPatch0_
	Source patch using manipulated input points. More...

autoPtr< mapDistribute >	srcMapPtr_
	Source map pointer - parallel running only. More...

scalarList	tgtMagSf_
	Target face areas. More...

labelListList	tgtAddress_
	Addresses of source faces per target face. More...

scalarListList	tgtWeights_
	Weights of source faces per target face. More...

scalarField	tgtWeightsSum_
	Sum of weights of source faces per target face. More...

pointListList	tgtCentroids_
	Centroid of source faces per target face. More...

pointField	tgtPatchPts_

refPtr< primitivePatch >	ttgtPatch0_
	Target patch using manipulated input points. More...

autoPtr< mapDistribute >	tgtMapPtr_
	Target map pointer - parallel running only. More...

bool	upToDate_
	Up-to-date flag. More...

Detailed Description

Nearest-face Arbitrary Mesh Interface (AMI) method.

Source files

Definition at line 51 of file nearestFaceAMI.H.

Member Typedef Documentation

◆ nearestAndDist

typedef Tuple2<pointIndexHit, scalar> nearestAndDist

Definition at line 57 of file nearestFaceAMI.H.

Constructor & Destructor Documentation

◆ nearestFaceAMI() [1/3]

nearestFaceAMI	(	const dictionary &	dict,
		const bool	reverseTarget = `false`
	)

Construct from dictionary.

Definition at line 235 of file nearestFaceAMI.C.

Referenced by nearestFaceAMI::clone().

Here is the caller graph for this function:

◆ nearestFaceAMI() [2/3]

nearestFaceAMI	(	const bool	requireMatch = `true`,
		const bool	reverseTarget = `false`,
		const scalar	lowWeightCorrection = `-1`
	)

Construct from components.

Definition at line 246 of file nearestFaceAMI.C.

◆ nearestFaceAMI() [3/3]

nearestFaceAMI ( const nearestFaceAMI & ami )

Construct as copy.

Definition at line 257 of file nearestFaceAMI.C.

◆ ~nearestFaceAMI()

virtual ~nearestFaceAMI ( )

virtualdefault

Destructor.

Member Function Documentation

◆ TypeName()

TypeName ( "nearestFaceAMI" )

Runtime type information.

◆ clone()

virtual autoPtr<AMIInterpolation> clone ( ) const

inlinevirtual

Construct and return a clone.

Reimplemented from AMIInterpolation.

Definition at line 138 of file nearestFaceAMI.H.

References nearestFaceAMI::nearestFaceAMI().

Here is the call graph for this function:

◆ calculate()

bool calculate	(	const primitivePatch &	srcPatch,
		const primitivePatch &	tgtPatch,
		const autoPtr< searchableSurface > &	surfPtr = `nullptr`
	)

virtual

Update addressing and weights.

Reimplemented from AMIInterpolation.

Definition at line 267 of file nearestFaceAMI.C.

References AMIInterpolation::calculate(), Foam::expressions::patchExpr::debug, Foam::endl(), forAll, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::index(), Foam::mag(), Foam::magSqr(), and WarningInFunction.