Class containing processor-to-processor mapping information. More...
Classes | |
class | transform |
Default transformation behaviour. More... | |
class | transformPosition |
Default transformation behaviour for position. More... | |
Public Member Functions | |
ClassName ("distributionMap") | |
distributionMap () | |
Construct null. More... | |
distributionMap (const label constructSize, labelListList &&subMap, labelListList &&constructMap, const bool subHasFlip=false, const bool constructHasFlip=false) | |
Construct from components. More... | |
distributionMap (const label constructSize, labelListList &&subMap, labelListList &&constructMap, labelListList &&transformElements, labelList &&transformStart, const bool subHasFlip=false, const bool constructHasFlip=false) | |
Construct from components. More... | |
distributionMap (const labelList &sendProcs, const labelList &recvProcs) | |
Construct from reverse addressing: per data item the send. More... | |
distributionMap (const globalIndex &, labelList &elements, List< Map< label >> &compactMap, const int tag=Pstream::msgType()) | |
Construct from list of (possibly) remote elements in globalIndex. More... | |
distributionMap (const globalIndex &, labelListList &cellCells, List< Map< label >> &compactMap, const int tag=Pstream::msgType()) | |
Special variant that works with the info sorted into bins. More... | |
distributionMap (const globalIndex &, labelList &untransformedElements, const globalIndexAndTransform &, const labelPairList &transformedElements, labelList &transformedIndices, List< Map< label >> &compactMap, const int tag=Pstream::msgType()) | |
Construct from list of (possibly remote) untransformed elements. More... | |
distributionMap (const globalIndex &, labelListList &cellCells, const globalIndexAndTransform &, const List< labelPairList > &transformedElements, labelListList &transformedIndices, List< Map< label >> &compactMap, const int tag=Pstream::msgType()) | |
As above but with ListLists. More... | |
distributionMap (const distributionMap &) | |
Copy constructor. More... | |
distributionMap (distributionMap &&) | |
Move constructor. More... | |
distributionMap (Istream &) | |
Construct from Istream. More... | |
autoPtr< distributionMap > | clone () const |
Clone. More... | |
virtual | ~distributionMap () |
Destructor. More... | |
const labelListList & | transformElements () const |
For every globalIndexAndTransform::transformPermutations. More... | |
const labelList & | transformStart () const |
Destination in constructMap for transformed elements. More... | |
label | whichTransform (const label index) const |
Find transform from transformElements. More... | |
void | transfer (distributionMap &) |
Transfer the contents of the argument and annul the argument. More... | |
template<class T > | |
void | distribute (List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const |
Distribute data using default commsType. More... | |
template<class T , class negateOp > | |
void | distribute (List< T > &fld, const negateOp &negOp, const bool dummyTransform=true, const int tag=UPstream::msgType()) const |
Distribute data using default commsType. More... | |
template<class T > | |
void | distribute (DynamicList< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const |
Distribute data using default commsType. More... | |
template<class T > | |
void | reverseDistribute (const label constructSize, List< T > &, const bool dummyTransform=true, const int tag=UPstream::msgType()) const |
Reverse distribute data using default commsType. More... | |
template<class T > | |
void | reverseDistribute (const label constructSize, const T &nullValue, List< T > &fld, const bool dummyTransform=true, const int tag=UPstream::msgType()) const |
Reverse distribute data using default commsType. More... | |
template<class T , class TransformOp > | |
void | distribute (const globalIndexAndTransform &, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const |
Distribute with transforms. More... | |
template<class T , class TransformOp > | |
void | reverseDistribute (const globalIndexAndTransform &, const label constructSize, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const |
Reverse distribute with transforms. More... | |
template<class T , class TransformOp > | |
void | reverseDistribute (const globalIndexAndTransform &, const label constructSize, const T &nullValue, List< T > &fld, const TransformOp &top, const int tag=UPstream::msgType()) const |
Reverse distribute with transforms. More... | |
void | printLayout (Ostream &os) const |
Debug: print layout. Can only be used on maps with sorted. More... | |
void | operator= (const distributionMap &) |
Public Member Functions inherited from distributionMapBase | |
ClassName ("distributionMapBase") | |
distributionMapBase () | |
Construct null. More... | |
distributionMapBase (const label constructSize, const labelListList &&subMap, const labelListList &&constructMap, const bool subHasFlip=false, const bool constructHasFlip=false) | |
Move construct from components. More... | |
distributionMapBase (const labelList &sendProcs, const labelList &recvProcs) | |
Construct from reverse addressing: per data item the send. More... | |
distributionMapBase (const globalIndex &, labelList &elements, List< Map< label >> &compactMap, const int tag=Pstream::msgType()) | |
Construct from list of (possibly) remote elements in globalIndex. More... | |
distributionMapBase (const globalIndex &, labelListList &cellCells, List< Map< label >> &compactMap, const int tag=Pstream::msgType()) | |
Special variant that works with the info sorted into bins. More... | |
distributionMapBase (const distributionMapBase &) | |
Construct copy. More... | |
distributionMapBase (distributionMapBase &&) | |
Move constructor. More... | |
distributionMapBase (Istream &) | |
Construct from Istream. More... | |
label | constructSize () const |
Constructed data size. More... | |
label & | constructSize () |
Constructed data size. More... | |
const labelListList & | subMap () const |
From subsetted data back to original data. More... | |
labelListList & | subMap () |
From subsetted data back to original data. More... | |
const labelListList & | constructMap () const |
From subsetted data to new reconstructed data. More... | |
labelListList & | constructMap () |
From subsetted data to new reconstructed data. More... | |
bool | subHasFlip () const |
Does subMap include a sign. More... | |
bool & | subHasFlip () |
Does subMap include a sign. More... | |
bool | constructHasFlip () const |
Does constructMap include a sign. More... | |
bool & | constructHasFlip () |
Does constructMap include a sign. More... | |
const List< labelPair > & | schedule () const |
Return a schedule. Demand driven. See above. More... | |
void | transfer (distributionMapBase &) |
Transfer the contents of the argument and annul the argument. More... | |
void | compact (const boolList &elemIsUsed, const int tag=UPstream::msgType()) |
Compact maps. Gets per field a bool whether it is used (locally) More... | |
void | compact (const boolList &elemIsUsed, const label localSize, labelList &oldToNewSub, labelList &oldToNewConstruct, const int tag=UPstream::msgType()) |
Compact all maps and layout. Returns compaction maps for. More... | |
template<class T > | |
void | distribute (List< T > &fld, const int tag=UPstream::msgType()) const |
Distribute data using default commsType. More... | |
template<class T , class negateOp > | |
void | distribute (List< T > &fld, const negateOp &negOp, const int tag=UPstream::msgType()) const |
Distribute data using default commsType. More... | |
template<class T > | |
void | distribute (DynamicList< T > &fld, const int tag=UPstream::msgType()) const |
Distribute data using default commsType. More... | |
template<class T > | |
void | reverseDistribute (const label constructSize, List< T > &, const int tag=UPstream::msgType()) const |
Reverse distribute data using default commsType. More... | |
template<class T > | |
void | reverseDistribute (const label constructSize, const T &nullValue, List< T > &fld, const int tag=UPstream::msgType()) const |
Reverse distribute data using default commsType. More... | |
template<class T > | |
void | send (PstreamBuffers &, const List< T > &) const |
Do all sends using PstreamBuffers. More... | |
template<class T > | |
void | receive (PstreamBuffers &, List< T > &) const |
Do all receives using PstreamBuffers. More... | |
void | printLayout (Ostream &os) const |
Debug: print layout. Can only be used on maps with sorted. More... | |
void | operator= (const distributionMapBase &) |
void | operator= (distributionMapBase &&) |
Friends | |
Istream & | operator>> (Istream &, distributionMap &) |
Read dictionary from Istream. More... | |
Ostream & | operator<< (Ostream &, const distributionMap &) |
Write dictionary to Ostream. More... | |
Additional Inherited Members | |
Static Public Member Functions inherited from distributionMapBase | |
static List< labelPair > | schedule (const labelListList &subMap, const labelListList &constructMap, const int tag) |
Calculate a schedule. See above. More... | |
static label | renumber (const globalIndex &, const List< Map< label >> &compactMap, const label globalElement) |
Helper for construct from globalIndex. Renumbers element. More... | |
template<class T , class negateOp > | |
static void | distribute (const Pstream::commsTypes commsType, const List< labelPair > &schedule, const label constructSize, const labelListList &subMap, const bool subHasFlip, const labelListList &constructMap, const bool constructHasFlip, List< T > &, const negateOp &negOp, const int tag=UPstream::msgType()) |
Distribute data. Note:schedule only used for. More... | |
template<class T , class CombineOp , class negateOp > | |
static void | distribute (const Pstream::commsTypes commsType, const List< labelPair > &schedule, const label constructSize, const labelListList &subMap, const bool subHasFlip, const labelListList &constructMap, const bool constructHasFlip, List< T > &, const CombineOp &cop, const negateOp &negOp, const T &nullValue, const int tag=UPstream::msgType()) |
Distribute data. If multiple processors writing to same. More... | |
Protected Member Functions inherited from distributionMapBase | |
void | calcCompactAddressing (const globalIndex &globalNumbering, const labelList &elements, List< Map< label >> &compactMap) const |
Construct per processor compact addressing of the global elements. More... | |
void | calcCompactAddressing (const globalIndex &globalNumbering, const labelListList &elements, List< Map< label >> &compactMap) const |
void | exchangeAddressing (const int tag, const globalIndex &globalNumbering, labelList &elements, List< Map< label >> &compactMap, labelList &compactStart) |
void | exchangeAddressing (const int tag, const globalIndex &globalNumbering, labelListList &elements, List< Map< label >> &compactMap, labelList &compactStart) |
Static Protected Member Functions inherited from distributionMapBase | |
static void | checkReceivedSize (const label proci, const label expectedSize, const label receivedSize) |
template<class T , class CombineOp , class negateOp > | |
static void | flipAndCombine (const UList< label > &map, const bool hasFlip, const UList< T > &rhs, const CombineOp &cop, const negateOp &negOp, List< T > &lhs) |
template<class T , class negateOp > | |
static T | accessAndFlip (const UList< T > &fld, const label index, const bool hasFlip, const negateOp &negOp) |
Protected Attributes inherited from distributionMapBase | |
label | constructSize_ |
Size of reconstructed data. More... | |
labelListList | subMap_ |
Maps from subsetted data back to original data. More... | |
labelListList | constructMap_ |
Maps from subsetted data to new reconstructed data. More... | |
bool | subHasFlip_ |
Whether subMap includes flip or not. More... | |
bool | constructHasFlip_ |
Whether constructMap includes flip or not. More... | |
autoPtr< List< labelPair > > | schedulePtr_ |
Schedule. More... | |
Class containing processor-to-processor mapping information.
We store mapping from the bits-to-send to the complete starting list (subXXXMap) and from the received bits to their location in the new list (constructXXXMap).
Schedule is a list of processor pairs (one send, one receive. One of them will be myself) which forms a scheduled (i.e. non-buffered) exchange. See distribute on how to use it. Note2: number of items sent on one processor have to equal the number of items received on the other processor.
To aid constructing these maps there are the constructors from global numbering, either with or without transforms.
It rewrites the input global indices into indices into the constructed data.
Any distribute with transforms is now done as: 1. exchange data with other processors and receive these into the slots for that processor 2. for all transformations transform a subset of the data according to transformElements_[transformI] and store this starting from transformStart_[transformI]
In the same way a reverse distribute will 1. apply the inverse transform to the data starting at transformStart_[transformI] and copy the result back into the transformElements_[transformI]. These might be local or remote slots. 2. the data in the remote slots will now be sent back to the correct location in the originating processor.
E.g. a map to handle
on e.g. processor 1 out of 2:
+——+ <- transformStart[2] | | | | <- transform2 applied to data in local or remote slots | | +——+ <- transformStart[1] | | | | <- transform1 applied to data in local or remote slots | | +——+ <- transformStart[1] | | | | <- transform0 applied to data in local or remote slots | | +——+ <- transformStart[0] | | | | <- data from proc2 | | +——+ | | | | <- data from proc0 | | +——+ <- mesh.nPoints() | | | | | | +——+ 0
When constructing from components optionally a 'flip' on the maps can be specified. This will interpret the map values as index+flip, similar to e.g. faceProcAddressing. The flip will only be applied to fieldTypes (scalar, vector, .. triad)
Definition at line 157 of file distributionMap.H.
distributionMap | ( | ) |
Construct null.
Definition at line 150 of file distributionMap.C.
distributionMap | ( | const label | constructSize, |
labelListList && | subMap, | ||
labelListList && | constructMap, | ||
const bool | subHasFlip = false , |
||
const bool | constructHasFlip = false |
||
) |
Construct from components.
Definition at line 156 of file distributionMap.C.
distributionMap | ( | const label | constructSize, |
labelListList && | subMap, | ||
labelListList && | constructMap, | ||
labelListList && | transformElements, | ||
labelList && | transformStart, | ||
const bool | subHasFlip = false , |
||
const bool | constructHasFlip = false |
||
) |
Construct from components.
Definition at line 176 of file distributionMap.C.
distributionMap | ( | const labelList & | sendProcs, |
const labelList & | recvProcs | ||
) |
Construct from reverse addressing: per data item the send.
processor and the receive processor. (note: data is not stored sorted per processor so cannot use printLayout).
Definition at line 200 of file distributionMap.C.
distributionMap | ( | const globalIndex & | globalNumbering, |
labelList & | elements, | ||
List< Map< label >> & | compactMap, | ||
const int | tag = Pstream::msgType() |
||
) |
Construct from list of (possibly) remote elements in globalIndex.
numbering (or -1). Determines compact numbering (see above) and distribute map to get data into this ordering and renumbers the elements to be in compact numbering.
Definition at line 210 of file distributionMap.C.
distributionMap | ( | const globalIndex & | globalNumbering, |
labelListList & | cellCells, | ||
List< Map< label >> & | compactMap, | ||
const int | tag = Pstream::msgType() |
||
) |
Special variant that works with the info sorted into bins.
according to local indices. E.g. think cellCells where cellCells[localCelli] is a list of global cells
Definition at line 228 of file distributionMap.C.
distributionMap | ( | const globalIndex & | globalNumbering, |
labelList & | untransformedElements, | ||
const globalIndexAndTransform & | globalTransforms, | ||
const labelPairList & | transformedElements, | ||
labelList & | transformedIndices, | ||
List< Map< label >> & | compactMap, | ||
const int | tag = Pstream::msgType() |
||
) |
Construct from list of (possibly remote) untransformed elements.
in globalIndex numbering (or -1) and (possibly remote) transformded elements in globalIndexAndTransform numbering. Determines compact numbering (see above) and distribute map to get data into this ordering and renumbers the elements to be in compact numbering.
Definition at line 246 of file distributionMap.C.
References distributionMapBase::calcCompactAddressing(), distributionMapBase::constructSize_, distributionMapBase::exchangeAddressing(), forAll, globalIndexAndTransform::index(), UPstream::myProcNo(), n, Foam::Pout, distributionMap::printLayout(), globalIndexAndTransform::processor(), List< T >::setSize(), List< T >::size(), globalIndexAndTransform::transformIndex(), and globalIndexAndTransform::transformPermutations().
distributionMap | ( | const globalIndex & | globalNumbering, |
labelListList & | cellCells, | ||
const globalIndexAndTransform & | globalTransforms, | ||
const List< labelPairList > & | transformedElements, | ||
labelListList & | transformedIndices, | ||
List< Map< label >> & | compactMap, | ||
const int | tag = Pstream::msgType() |
||
) |
As above but with ListLists.
Definition at line 351 of file distributionMap.C.
References distributionMapBase::calcCompactAddressing(), distributionMapBase::constructSize_, distributionMapBase::exchangeAddressing(), forAll, globalIndexAndTransform::index(), UPstream::myProcNo(), n, Foam::Pout, distributionMap::printLayout(), globalIndexAndTransform::processor(), List< T >::setSize(), List< T >::size(), globalIndexAndTransform::transformIndex(), and globalIndexAndTransform::transformPermutations().
distributionMap | ( | const distributionMap & | map | ) |
Copy constructor.
Definition at line 469 of file distributionMap.C.
distributionMap | ( | distributionMap && | map | ) |
Move constructor.
Definition at line 477 of file distributionMap.C.
distributionMap | ( | Istream & | is | ) |
Construct from Istream.
Definition at line 485 of file distributionMap.C.
|
inlinevirtual |
Destructor.
Definition at line 432 of file distributionMap.H.
ClassName | ( | "distributionMap" | ) |
Foam::autoPtr< Foam::distributionMap > clone | ( | ) | const |
Clone.
Definition at line 491 of file distributionMap.C.
|
inline |
For every globalIndexAndTransform::transformPermutations.
gives the elements that need to be transformed
Definition at line 442 of file distributionMap.H.
|
inline |
Destination in constructMap for transformed elements.
Definition at line 448 of file distributionMap.H.
Foam::label whichTransform | ( | const label | index | ) | const |
Find transform from transformElements.
Definition at line 499 of file distributionMap.C.
References Foam::findLower().
void transfer | ( | distributionMap & | rhs | ) |
Transfer the contents of the argument and annul the argument.
Definition at line 506 of file distributionMap.C.
References distributionMapBase::transfer().
void distribute | ( | List< T > & | fld, |
const bool | dummyTransform = true , |
||
const int | tag = UPstream::msgType() |
||
) | const |
Distribute data using default commsType.
Definition at line 148 of file distributionMapTemplates.C.
References fld().
Referenced by extendedFaceToCellStencil::collectData(), extendedCellToFaceStencil::collectData(), hexRef8Data::distribute(), polyDistributionMap::distributeCellData(), polyDistributionMap::distributeFaceData(), lagrangianDistributionMap::distributeLagrangianData(), polyDistributionMap::distributePatchData(), polyDistributionMap::distributePointData(), distributedTriSurfaceMesh::findNearest(), globalIndexAndTransform::globalIndexAndTransform(), patchInternalField::interpolateField(), globalMeshData::mergePoints(), PatchTools::pointNormals(), globalMeshData::syncData(), and pointConstraints::syncUntransformedData().
void distribute | ( | List< T > & | fld, |
const negateOp & | negOp, | ||
const bool | dummyTransform = true , |
||
const int | tag = UPstream::msgType() |
||
) | const |
Distribute data using default commsType.
Fill in transformed slots with copies
Definition at line 129 of file distributionMapTemplates.C.
References distributionMapBase::distribute(), and fld().
void distribute | ( | DynamicList< T > & | fld, |
const bool | dummyTransform = true , |
||
const int | tag = UPstream::msgType() |
||
) | const |
Distribute data using default commsType.
Definition at line 160 of file distributionMapTemplates.C.
References fld(), and List< T >::size().
void reverseDistribute | ( | const label | constructSize, |
List< T > & | fld, | ||
const bool | dummyTransform = true , |
||
const int | tag = UPstream::msgType() |
||
) | const |
Reverse distribute data using default commsType.
Definition at line 178 of file distributionMapTemplates.C.
References fld(), and distributionMapBase::reverseDistribute().
Referenced by distributedTriSurfaceMesh::findNearest(), distributedTriSurfaceMesh::getField(), distributedTriSurfaceMesh::getNormal(), distributedTriSurfaceMesh::getRegion(), patchInternalField::interpolateField(), globalMeshData::mergePoints(), PatchTools::pointNormals(), globalMeshData::syncData(), and pointConstraints::syncUntransformedData().
void reverseDistribute | ( | const label | constructSize, |
const T & | nullValue, | ||
List< T > & | fld, | ||
const bool | dummyTransform = true , |
||
const int | tag = UPstream::msgType() |
||
) | const |
Reverse distribute data using default commsType.
Since constructSize might be larger than supplied size supply a nullValue
Definition at line 196 of file distributionMapTemplates.C.
References fld(), and distributionMapBase::reverseDistribute().
void distribute | ( | const globalIndexAndTransform & | git, |
List< T > & | fld, | ||
const TransformOp & | top, | ||
const int | tag = UPstream::msgType() |
||
) | const |
Distribute with transforms.
Definition at line 215 of file distributionMapTemplates.C.
References fld().
void reverseDistribute | ( | const globalIndexAndTransform & | git, |
const label | constructSize, | ||
List< T > & | fld, | ||
const TransformOp & | top, | ||
const int | tag = UPstream::msgType() |
||
) | const |
Reverse distribute with transforms.
Definition at line 231 of file distributionMapTemplates.C.
References fld().
void reverseDistribute | ( | const globalIndexAndTransform & | git, |
const label | constructSize, | ||
const T & | nullValue, | ||
List< T > & | fld, | ||
const TransformOp & | top, | ||
const int | tag = UPstream::msgType() |
||
) | const |
Reverse distribute with transforms.
Definition at line 251 of file distributionMapTemplates.C.
References fld().
void printLayout | ( | Ostream & | os | ) | const |
Debug: print layout. Can only be used on maps with sorted.
storage (local data first, then non-local data)
Definition at line 132 of file distributionMap.C.
References Foam::endl(), forAll, distributionMapBase::printLayout(), and List< T >::size().
Referenced by distributionMap::distributionMap().
void operator= | ( | const distributionMap & | rhs | ) |
Definition at line 516 of file distributionMap.C.
References Foam::abort(), Foam::FatalError, FatalErrorInFunction, and distributionMapBase::operator=().
Referenced by IOdistributionMap::IOdistributionMap().
|
friend |
Read dictionary from Istream.
|
friend |
Write dictionary to Ostream.