Nearest-face Arbitrary Mesh Interface (AMI) method. More...
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... | |
| virtual void | write (Ostream &os) const |
| Write. 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) | |
| Construct from agglomeration of AMIInterpolation. Agglomeration passed in as new coarse size and addressing from fine from coarse. More... | |
| AMIInterpolation (const AMIInterpolation &ami) | |
| Construct as copy. More... | |
| AMIInterpolation (Istream &is) | |
| Construct from Istream. More... | |
| virtual | ~AMIInterpolation ()=default |
| Destructor. More... | |
| bool | upToDate () const noexcept |
| Is up-to-date? More... | |
| bool | upToDate (bool flag) noexcept |
| Set as up-to-date, return the previous value. More... | |
| bool | distributed () const noexcept |
| Distributed across processors (singlePatchProc == -1) More... | |
| bool | requireMatch () const noexcept |
| Return the requireMatch flag. More... | |
| bool | setRequireMatch (bool flag) noexcept |
| Set the require match flag, return the new value. More... | |
| bool | mustMatchFaces () const |
| Return true if requireMatch and but not lowWeightCorrection. More... | |
| bool | reverseTarget () const noexcept |
| 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 noexcept |
| The processor holding all faces (both sides), or -1 if distributed. More... | |
| label | comm () const |
| Communicator to use for parallel operations. More... | |
| label | comm (const label newComm) |
| Set communicator to use for parallel operations. Return. More... | |
| 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 |
| Return const access to normalisation factor of source patch weights (i.e. the sum before normalisation) More... | |
| scalarField & | srcWeightsSum () |
| Return access to normalisation factor of source patch weights (i.e. the sum before normalisation) More... | |
| 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 |
| Source map - valid only if singlePatchProc = -1 This gets source data into a form to be consumed by tgtAddress, tgtWeights. More... | |
| const mapDistribute * | hasSrcMap () const noexcept |
| Pointer to the source map (if distributed). Can be checked as a bool. More... | |
| 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 |
| Return const access to normalisation factor of target patch weights (i.e. the sum before normalisation) More... | |
| scalarField & | tgtWeightsSum () |
| Return access to normalisation factor of target patch weights (i.e. the sum before normalisation) More... | |
| const mapDistribute & | tgtMap () const |
| Target map - valid only if singlePatchProc=-1. This gets target data into a form to be consumed by srcAddress, srcWeights. More... | |
| const mapDistribute * | hasTgtMap () const noexcept |
| Pointer to the target map (if distributed). Can be checked as a bool. More... | |
| void | reset (autoPtr< mapDistribute > &&srcToTgtMap, autoPtr< mapDistribute > &&tgtToSrcMap, labelListList &&srcAddress, scalarListList &&srcWeights, labelListList &&tgtAddress, scalarListList &&tgtWeights, const label singlePatchProc) |
| 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 > | |
| void | weightedSum (const bool interpolateToSource, const UList< Type > &fld, List< Type > &result, const UList< Type > &defaultValues) const |
| Weighted sum of contributions. 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 to combine existing value with remote value and weight. 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 to combine existing value with remote value and weight. 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... | |
| bool | checkSymmetricWeights (const bool log) const |
| Check if src addresses are present in tgt addresses and viceversa. More... | |
| void | writeFaceConnectivity (const primitivePatch &srcPatch, const primitivePatch &tgtPatch, const labelListList &srcAddress) const |
| Write face connectivity as OBJ file. More... | |
| virtual bool | writeData (Ostream &os) const |
| Write AMI raw. More... | |
| bool & | upToDate () noexcept |
| Non-const access to the up-to-date flag. 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... | |
| template<class Type , class CombineOp > | |
| static void | weightedSum (const scalar lowWeightCorrection, const labelListList &allSlots, const scalarListList &allWeights, const scalarField &weightsSum, const UList< Type > &fld, const CombineOp &cop, List< Type > &result, const UList< Type > &defaultValues) |
| Weighted sum of contributions. 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, const label comm) |
| Normalise the (area) weights - suppresses numerical error in weights calculation. More... | |
| 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, const label comm) |
| Protected Attributes inherited from AMIInterpolation | |
| bool | requireMatch_ |
| Flag to indicate that the two patches must be matched/an overlap exists between them. More... | |
| const bool | reverseTarget_ |
| Flag to indicate that the two patches are co-directional and that the orientation of the target patch should be reversed. More... | |
| const scalar | lowWeightCorrection_ |
| Threshold weight below which interpolation is deactivated. More... | |
| label | singlePatchProc_ |
| Index of processor that holds all of both sides. The value is -1 for distributed cases. More... | |
| label | comm_ |
| Communicator to use for parallel operations. More... | |
| 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_ |
| Source patch points if input points are manipulated, e.g. projected. More... | |
| 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_ |
| Target patch points if input points are manipulated, e.g. projected. More... | |
| 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... | |
Nearest-face Arbitrary Mesh Interface (AMI) method.
Definition at line 47 of file nearestFaceAMI.H.
| typedef Tuple2<pointIndexHit, scalar> nearestAndDist |
Definition at line 53 of file nearestFaceAMI.H.
| nearestFaceAMI | ( | const dictionary & | dict, |
| const bool | reverseTarget = false |
||
| ) |
Construct from dictionary.
Definition at line 238 of file nearestFaceAMI.C.
Referenced by nearestFaceAMI::clone().
| nearestFaceAMI | ( | const bool | requireMatch = true, |
| const bool | reverseTarget = false, |
||
| const scalar | lowWeightCorrection = -1 |
||
| ) |
Construct from components.
Definition at line 249 of file nearestFaceAMI.C.
| nearestFaceAMI | ( | const nearestFaceAMI & | ami | ) |
Construct as copy.
Definition at line 260 of file nearestFaceAMI.C.
|
virtualdefault |
Destructor.
| TypeName | ( | "nearestFaceAMI" | ) |
Runtime type information.
|
inlinevirtual |
Construct and return a clone.
Reimplemented from AMIInterpolation.
Definition at line 150 of file nearestFaceAMI.H.
References nearestFaceAMI::nearestFaceAMI().
|
virtual |
Update addressing and weights.
Reimplemented from AMIInterpolation.
Definition at line 270 of file nearestFaceAMI.C.
References AMIInterpolation::calculate(), Foam::createTree(), Foam::ensightOutput::debug, Foam::endl(), forAll, PointIndexHit< PointType >::hit(), PointIndexHit< PointType >::index(), Foam::mag(), Foam::magSqr(), and WarningInFunction.
|
virtual |
Write.
Reimplemented from AMIInterpolation.
Definition at line 411 of file nearestFaceAMI.C.
References os(), AMIInterpolation::write(), and Ostream::writeEntryIfDifferent().
1.8.14 