Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
Ewoms::Linear::GlobalIndices< ForeignOverlap > Class Template Reference

This class maps domestic row indices to and from "global" indices which is used to construct an algebraic overlap for the parallel linear solvers. More...

#include <globalindices.hh>

Public Member Functions

 GlobalIndices (const ForeignOverlap &foreignOverlap)
 
int domesticToGlobal (int domesticIdx) const
 Converts a domestic index to a global one. More...
 
int globalToDomestic (int globalIdx) const
 Converts a global index to a domestic one. More...
 
int numLocal () const
 Returns the number of indices which are in the interior or on the border of the current rank. More...
 
int numDomestic () const
 Returns the number domestic indices. More...
 
void addIndex (int domesticIdx, int globalIdx)
 Add an index to the domestic<->global mapping. More...
 
void sendBorderIndex (int peerRank, int domesticIdx, int peerLocalIdx)
 Send a border index to a remote process. More...
 
void receiveBorderIndex (int peerRank)
 Receive an index on the border from a remote process and add it the translation maps. More...
 
bool hasGlobalIndex (int globalIdx) const
 Return true iff a given global index already exists. More...
 
void print () const
 Prints the global indices of all domestic indices for debugging purposes. More...
 

Protected Member Functions

void buildGlobalIndices_ ()
 
void sendBorderTo_ (ProcessRank peerRank)
 
void receiveBorderFrom_ (ProcessRank peerRank)
 
const PeerSet & peerSet_ () const
 
const BorderList & borderList_ () const
 

Protected Attributes

ProcessRank myRank_
 
size_t mpiSize_
 
int domesticOffset_
 
size_t numDomestic_
 
const ForeignOverlap & foreignOverlap_
 
GlobalToDomesticMap globalToDomestic_
 
DomesticToGlobalMap domesticToGlobal_
 

Detailed Description

template<class ForeignOverlap>
class Ewoms::Linear::GlobalIndices< ForeignOverlap >

This class maps domestic row indices to and from "global" indices which is used to construct an algebraic overlap for the parallel linear solvers.

Constructor & Destructor Documentation

template<class ForeignOverlap >
Ewoms::Linear::GlobalIndices< ForeignOverlap >::GlobalIndices ( const ForeignOverlap &  foreignOverlap)
inline

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::mpiSize_, and Ewoms::Linear::GlobalIndices< ForeignOverlap >::myRank_.

Member Function Documentation

template<class ForeignOverlap >
void Ewoms::Linear::GlobalIndices< ForeignOverlap >::addIndex ( int  domesticIdx,
int  globalIdx 
)
inline

Add an index to the domestic<->global mapping.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal_, Ewoms::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic_, and Ewoms::Linear::GlobalIndices< ForeignOverlap >::numDomestic_.

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderIndex(), and Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::receiveIndicesFromPeer_().

template<class ForeignOverlap >
const BorderList& Ewoms::Linear::GlobalIndices< ForeignOverlap >::borderList_ ( ) const
inlineprotected

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_.

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderFrom_(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderTo_().

template<class ForeignOverlap >
void Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_ ( )
inlineprotected

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::addIndex(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticOffset_, Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_, Ewoms::Linear::GlobalIndices< ForeignOverlap >::mpiSize_, Ewoms::Linear::GlobalIndices< ForeignOverlap >::myRank_, Ewoms::Linear::GlobalIndices< ForeignOverlap >::numDomestic_, Ewoms::Linear::GlobalIndices< ForeignOverlap >::peerSet_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderFrom_(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderTo_().

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::GlobalIndices().

template<class ForeignOverlap >
int Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal ( int  domesticIdx) const
inline

Converts a domestic index to a global one.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal_.

Referenced by Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::domesticToGlobal(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::print(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderIndex(), and Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::sendIndicesToPeer_().

template<class ForeignOverlap >
int Ewoms::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic ( int  globalIdx) const
inline

Converts a global index to a domestic one.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic_.

Referenced by Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::globalToDomestic(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::print(), and Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::receiveIndicesFromPeer_().

template<class ForeignOverlap >
bool Ewoms::Linear::GlobalIndices< ForeignOverlap >::hasGlobalIndex ( int  globalIdx) const
inline

Return true iff a given global index already exists.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic_.

Referenced by Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::receiveIndicesFromPeer_().

template<class ForeignOverlap >
int Ewoms::Linear::GlobalIndices< ForeignOverlap >::numDomestic ( ) const
inline

Returns the number domestic indices.

The domestic indices are defined as the process' local indices plus its copies of indices in the overlap regions

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::numDomestic_.

Referenced by Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::numDomestic(), and Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::receiveIndicesFromPeer_().

template<class ForeignOverlap >
int Ewoms::Linear::GlobalIndices< ForeignOverlap >::numLocal ( ) const
inline

Returns the number of indices which are in the interior or on the border of the current rank.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_.

template<class ForeignOverlap >
const PeerSet& Ewoms::Linear::GlobalIndices< ForeignOverlap >::peerSet_ ( ) const
inlineprotected

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_.

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_().

template<class ForeignOverlap >
void Ewoms::Linear::GlobalIndices< ForeignOverlap >::print ( ) const
inline

Prints the global indices of all domestic indices for debugging purposes.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal_, Ewoms::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::myRank_.

Referenced by Ewoms::Linear::DomesticOverlapFromBCRSMatrix< BCRSMatrix >::print().

template<class ForeignOverlap >
void Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderFrom_ ( ProcessRank  peerRank)
inlineprotected

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::borderList_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_, and Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderIndex().

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_().

template<class ForeignOverlap >
void Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderIndex ( int  peerRank)
inline

Receive an index on the border from a remote process and add it the translation maps.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::addIndex(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_, Ewoms::Linear::PeerIndexGlobalIndex::globalIdx, and Ewoms::Linear::PeerIndexGlobalIndex::peerIdx.

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderFrom_().

template<class ForeignOverlap >
void Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderIndex ( int  peerRank,
int  domesticIdx,
int  peerLocalIdx 
)
inline

Send a border index to a remote process.

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal(), Ewoms::Linear::PeerIndexGlobalIndex::globalIdx, and Ewoms::Linear::PeerIndexGlobalIndex::peerIdx.

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderTo_().

template<class ForeignOverlap >
void Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderTo_ ( ProcessRank  peerRank)
inlineprotected

References Ewoms::Linear::GlobalIndices< ForeignOverlap >::borderList_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_, and Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderIndex().

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_().

Member Data Documentation

template<class ForeignOverlap >
int Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticOffset_
protected

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_().

template<class ForeignOverlap >
DomesticToGlobalMap Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal_
protected

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::addIndex(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::print().

template<class ForeignOverlap >
const ForeignOverlap& Ewoms::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_
protected

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::borderList_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::numLocal(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::peerSet_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderFrom_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::receiveBorderIndex(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::sendBorderTo_().

template<class ForeignOverlap >
GlobalToDomesticMap Ewoms::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic_
protected

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::addIndex(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::hasGlobalIndex().

template<class ForeignOverlap >
size_t Ewoms::Linear::GlobalIndices< ForeignOverlap >::mpiSize_
protected

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::GlobalIndices().

template<class ForeignOverlap >
ProcessRank Ewoms::Linear::GlobalIndices< ForeignOverlap >::myRank_
protected

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::GlobalIndices(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::print().

template<class ForeignOverlap >
size_t Ewoms::Linear::GlobalIndices< ForeignOverlap >::numDomestic_
protected

Referenced by Ewoms::Linear::GlobalIndices< ForeignOverlap >::addIndex(), Ewoms::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_(), and Ewoms::Linear::GlobalIndices< ForeignOverlap >::numDomestic().

The documentation for this class was generated from the following file: