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)

Index	domesticToGlobal (Index domesticIdx) const
	Converts a domestic index to a global one. More...

Index	globalToDomestic (Index globalIdx) const
	Converts a global index to a domestic one. More...

size_t	numLocal () const
	Returns the number of indices which are in the interior or on the border of the current rank. More...

size_t	numDomestic () const
	Returns the number domestic indices. More...

void	addIndex (Index domesticIdx, Index globalIdx)
	Add an index to the domestic<->global mapping. More...

void	sendBorderIndex (ProcessRank peerRank, Index domesticIdx, Index peerLocalIdx)
	Send a border index to a remote process. More...

void	receiveBorderIndex (ProcessRank peerRank)
	Receive an index on the border from a remote process and add it the translation maps. More...

bool	hasGlobalIndex (Index 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 Opm::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

◆ GlobalIndices()

template<class ForeignOverlap >

Opm::Linear::GlobalIndices< ForeignOverlap >::GlobalIndices ( const ForeignOverlap & foreignOverlap )

inline

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

Member Function Documentation

◆ addIndex()

template<class ForeignOverlap >

void Opm::Linear::GlobalIndices< ForeignOverlap >::addIndex	(	Index	domesticIdx,
		Index	globalIdx
	)

inline

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

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

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

◆ borderList_()

template<class ForeignOverlap >

const BorderList & Opm::Linear::GlobalIndices< ForeignOverlap >::borderList_ ( ) const

inlineprotected

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

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

◆ buildGlobalIndices_()

template<class ForeignOverlap >

void Opm::Linear::GlobalIndices< ForeignOverlap >::buildGlobalIndices_ ( )

inlineprotected

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

◆ domesticToGlobal()

template<class ForeignOverlap >

Index Opm::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal ( Index domesticIdx ) const

inline

Converts a domestic index to a global one.

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

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

◆ globalToDomestic()

template<class ForeignOverlap >

Index Opm::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic ( Index globalIdx ) const

inline

Converts a global index to a domestic one.

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

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

◆ hasGlobalIndex()

template<class ForeignOverlap >

bool Opm::Linear::GlobalIndices< ForeignOverlap >::hasGlobalIndex ( Index globalIdx ) const

inline

Return true iff a given global index already exists.

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

Referenced by Opm::Linear::DomesticOverlapFromBCRSMatrix::receiveIndicesFromPeer_().

◆ numDomestic()

template<class ForeignOverlap >

size_t Opm::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 Opm::Linear::GlobalIndices< ForeignOverlap >::numDomestic_.

Referenced by Opm::Linear::DomesticOverlapFromBCRSMatrix::numDomestic(), and Opm::Linear::DomesticOverlapFromBCRSMatrix::receiveIndicesFromPeer_().

◆ numLocal()

template<class ForeignOverlap >

size_t Opm::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 Opm::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_.

◆ peerSet_()

template<class ForeignOverlap >

const PeerSet & Opm::Linear::GlobalIndices< ForeignOverlap >::peerSet_ ( ) const

inlineprotected

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

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

◆ print()

template<class ForeignOverlap >

void Opm::Linear::GlobalIndices< ForeignOverlap >::print ( ) const

inline

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

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

Referenced by Opm::Linear::DomesticOverlapFromBCRSMatrix::print().

◆ receiveBorderFrom_()

template<class ForeignOverlap >

void Opm::Linear::GlobalIndices< ForeignOverlap >::receiveBorderFrom_ ( ProcessRank peerRank )

inlineprotected

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

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

◆ receiveBorderIndex()

template<class ForeignOverlap >

void Opm::Linear::GlobalIndices< ForeignOverlap >::receiveBorderIndex ( ProcessRank peerRank )

inline

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

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

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

◆ sendBorderIndex()

template<class ForeignOverlap >

void Opm::Linear::GlobalIndices< ForeignOverlap >::sendBorderIndex	(	ProcessRank	peerRank,
		Index	domesticIdx,
		Index	peerLocalIdx
	)

inline

Send a border index to a remote process.

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

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

◆ sendBorderTo_()

template<class ForeignOverlap >

void Opm::Linear::GlobalIndices< ForeignOverlap >::sendBorderTo_ ( ProcessRank peerRank )

inlineprotected

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

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

Member Data Documentation

◆ domesticOffset_

template<class ForeignOverlap >

int Opm::Linear::GlobalIndices< ForeignOverlap >::domesticOffset_

protected

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

◆ domesticToGlobal_

template<class ForeignOverlap >

DomesticToGlobalMap Opm::Linear::GlobalIndices< ForeignOverlap >::domesticToGlobal_

protected

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

◆ foreignOverlap_

template<class ForeignOverlap >

const ForeignOverlap& Opm::Linear::GlobalIndices< ForeignOverlap >::foreignOverlap_

protected

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

◆ globalToDomestic_

template<class ForeignOverlap >

GlobalToDomesticMap Opm::Linear::GlobalIndices< ForeignOverlap >::globalToDomestic_

protected

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

◆ mpiSize_

template<class ForeignOverlap >

size_t Opm::Linear::GlobalIndices< ForeignOverlap >::mpiSize_

protected

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

◆ myRank_

template<class ForeignOverlap >

ProcessRank Opm::Linear::GlobalIndices< ForeignOverlap >::myRank_

protected

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

◆ numDomestic_

template<class ForeignOverlap >

size_t Opm::Linear::GlobalIndices< ForeignOverlap >::numDomestic_

protected

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

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

globalindices.hh

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ GlobalIndices()

Member Function Documentation

◆ addIndex()

◆ borderList_()

◆ buildGlobalIndices_()

◆ domesticToGlobal()

◆ globalToDomestic()

◆ hasGlobalIndex()

◆ numDomestic()

◆ numLocal()

◆ peerSet_()

◆ print()

◆ receiveBorderFrom_()

◆ receiveBorderIndex()

◆ sendBorderIndex()

◆ sendBorderTo_()

Member Data Documentation

◆ domesticOffset_

◆ domesticToGlobal_

◆ foreignOverlap_

◆ globalToDomestic_

◆ mpiSize_

◆ myRank_

◆ numDomestic_