Public Types | Public Member Functions | Private Member Functions | Private Attributes | List of all members
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_MapExtractor_fwd.hpp>

Inheritance diagram for Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >:

Public Types

typedef Scalar scalar_type
 
typedef LocalOrdinal local_ordinal_type
 
typedef GlobalOrdinal global_ordinal_type
 
typedef Node node_type
 

Public Member Functions

 MapExtractor (const RCP< const Map > &fullmap, const std::vector< RCP< const Map > > &maps, bool bThyraMode=false)
 
 MapExtractor (const std::vector< RCP< const Map > > &maps, const std::vector< RCP< const Map > > &thyramaps)
 Expert constructor for Thyra maps. More...
 
 MapExtractor (const MapExtractor &input)
 copy constructor More...
 
RCP< VectorgetVector (size_t i, bool bThyraMode=false, bool bZero=true) const
 
RCP< MultiVectorgetVector (size_t i, size_t numvec, bool bThyraMode=false, bool bZero=true) const
 
bool getThyraMode () const
 returns true, if sub maps are stored in Thyra-style numbering More...
 

Private Member Functions

bool CheckConsistency () const
 

Private Attributes

RCP< const Mapfullmap_
 
std::vector< RCP< const Map > > maps_
 
std::vector< RCP< Import > > importers_
 
bool bThyraMode_
 
std::vector< RCP< const Map > > thyraMaps_
 

Extract subblocks from full map

void ExtractVector (const Vector &full, size_t block, Vector &partial) const
 
void ExtractVector (const MultiVector &full, size_t block, MultiVector &partial) const
 
void ExtractVector (RCP< const Vector > &full, size_t block, RCP< Vector > &partial) const
 
void ExtractVector (RCP< Vector > &full, size_t block, RCP< Vector > &partial) const
 
void ExtractVector (RCP< const MultiVector > &full, size_t block, RCP< MultiVector > &partial) const
 
void ExtractVector (RCP< MultiVector > &full, size_t block, RCP< MultiVector > &partial) const
 
RCP< VectorExtractVector (RCP< const Vector > &full, size_t block, bool bThyraMode=false) const
 
RCP< VectorExtractVector (RCP< Vector > &full, size_t block, bool bThyraMode=false) const
 
RCP< MultiVectorExtractVector (RCP< const MultiVector > &full, size_t block, bool bThyraMode=false) const
 
RCP< MultiVectorExtractVector (RCP< MultiVector > &full, size_t block, bool bThyraMode=false) const
 
RCP< MultiVectorExtractVector (RCP< const BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &full, size_t block, bool bThyraMode=false) const
 
RCP< MultiVectorExtractVector (RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &full, size_t block, bool bThyraMode=false) const
 

Insert subblocks into full map

void InsertVector (const Vector &partial, size_t block, Vector &full, bool bThyraMode=false) const
 
void InsertVector (const MultiVector &partial, size_t block, MultiVector &full, bool bThyraMode=false) const
 
void InsertVector (RCP< const Vector > partial, size_t block, RCP< Vector > full, bool bThyraMode=false) const
 
void InsertVector (RCP< Vector > partial, size_t block, RCP< Vector > full, bool bThyraMode=false) const
 
void InsertVector (RCP< const MultiVector > partial, size_t block, RCP< MultiVector > full, bool bThyraMode=false) const
 
void InsertVector (RCP< MultiVector > partial, size_t block, RCP< MultiVector > full, bool bThyraMode=false) const
 
void InsertVector (RCP< const MultiVector > partial, size_t block, RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > full, bool bThyraMode=false) const
 
void InsertVector (RCP< MultiVector > partial, size_t block, RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > full, bool bThyraMode=false) const
 

Maps

size_t NumMaps () const
 number of partial maps More...
 
const RCP< const MapgetMap (size_t i, bool bThyraMode=false) const
 
const RCP< const MapgetFullMap () const
 the full map More...
 
size_t getMapIndexForGID (GlobalOrdinal gid) const
 returns map index in map extractor which contains GID More...
 

Detailed Description

template<class Scalar, class LocalOrdinal, class GlobalOrdinal, class Node>
class Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >

Definition at line 51 of file Xpetra_MapExtractor_fwd.hpp.

Member Typedef Documentation

◆ scalar_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
typedef Scalar Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::scalar_type

Definition at line 80 of file Xpetra_MapExtractor.hpp.

◆ local_ordinal_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
typedef LocalOrdinal Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::local_ordinal_type

Definition at line 81 of file Xpetra_MapExtractor.hpp.

◆ global_ordinal_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
typedef GlobalOrdinal Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::global_ordinal_type

Definition at line 82 of file Xpetra_MapExtractor.hpp.

◆ node_type

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
typedef Node Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::node_type

Definition at line 83 of file Xpetra_MapExtractor.hpp.

Constructor & Destructor Documentation

◆ MapExtractor() [1/3]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractor ( const RCP< const Map > &  fullmap,
const std::vector< RCP< const Map > > &  maps,
bool  bThyraMode = false 
)
inline

MapExtractor basic constructor

Parameters
[in]fullmapFull map containing all GIDs throughout the full vector. This parameter is only important if bThyraMode == false (see below)
[in]mapsVector containing submaps. The set of all GIDs stored in the submaps should be the same than stored in fullmap, if bThyraMode == false. In Thyra mode, the submaps should contain consecutive GIDs starting with 0 in each submap.
[in]bThyraModeFlag which allows to switch between generating a MapExtractor in Thyra mode or Xpetra mode

In Thyra mode, fullmap is not important as a fullmap with unique blocked GIDs is automatically generated which map the GIDs of the submaps to uniquely defined GIDs in the fullmap. The user has to provide a fullmap in Thyra mode to specify the underlying linear algebra library (Epetra or Tpetra) and some other map information (e.g. indexBase). This could be fixed.

In Xpetra mode, the fullmap has to be the same as the union of the GIDs stored in the submaps in maps. The intersection of the GIDs of the sub- maps in maps must be empty.

Definition at line 103 of file Xpetra_MapExtractor.hpp.

◆ MapExtractor() [2/3]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractor ( const std::vector< RCP< const Map > > &  maps,
const std::vector< RCP< const Map > > &  thyramaps 
)
inline

Expert constructor for Thyra maps.

Definition at line 189 of file Xpetra_MapExtractor.hpp.

◆ MapExtractor() [3/3]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::MapExtractor ( const MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node > &  input)
inline

copy constructor

Definition at line 226 of file Xpetra_MapExtractor.hpp.

Member Function Documentation

◆ ExtractVector() [1/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( const Vector full,
size_t  block,
Vector partial 
) const
inline

Definition at line 259 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [2/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( const MultiVector full,
size_t  block,
MultiVector partial 
) const
inline

Definition at line 266 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [3/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< const Vector > &  full,
size_t  block,
RCP< Vector > &  partial 
) const
inline

Definition at line 272 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [4/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< Vector > &  full,
size_t  block,
RCP< Vector > &  partial 
) const
inline

Definition at line 273 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [5/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< const MultiVector > &  full,
size_t  block,
RCP< MultiVector > &  partial 
) const
inline

Definition at line 274 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [6/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< MultiVector > &  full,
size_t  block,
RCP< MultiVector > &  partial 
) const
inline

Definition at line 275 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [7/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Vector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< const Vector > &  full,
size_t  block,
bool  bThyraMode = false 
) const
inline

Definition at line 277 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [8/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Vector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< Vector > &  full,
size_t  block,
bool  bThyraMode = false 
) const
inline

Definition at line 302 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [9/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< const MultiVector > &  full,
size_t  block,
bool  bThyraMode = false 
) const
inline

Definition at line 327 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [10/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< MultiVector > &  full,
size_t  block,
bool  bThyraMode = false 
) const
inline

Definition at line 353 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [11/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< const BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  full,
size_t  block,
bool  bThyraMode = false 
) const
inline

Definition at line 379 of file Xpetra_MapExtractor.hpp.

◆ ExtractVector() [12/12]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::ExtractVector ( RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > > &  full,
size_t  block,
bool  bThyraMode = false 
) const
inline

Definition at line 388 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [1/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( const Vector partial,
size_t  block,
Vector full,
bool  bThyraMode = false 
) const
inline

Definition at line 401 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [2/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( const MultiVector partial,
size_t  block,
MultiVector full,
bool  bThyraMode = false 
) const
inline

Definition at line 431 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [3/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< const Vector partial,
size_t  block,
RCP< Vector full,
bool  bThyraMode = false 
) const
inline

Definition at line 464 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [4/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< Vector partial,
size_t  block,
RCP< Vector full,
bool  bThyraMode = false 
) const
inline

Definition at line 465 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [5/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< const MultiVector partial,
size_t  block,
RCP< MultiVector full,
bool  bThyraMode = false 
) const
inline

Definition at line 466 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [6/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< MultiVector partial,
size_t  block,
RCP< MultiVector full,
bool  bThyraMode = false 
) const
inline

Definition at line 467 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [7/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< const MultiVector partial,
size_t  block,
RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >  full,
bool  bThyraMode = false 
) const
inline

Definition at line 469 of file Xpetra_MapExtractor.hpp.

◆ InsertVector() [8/8]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
void Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::InsertVector ( RCP< MultiVector partial,
size_t  block,
RCP< Xpetra::BlockedMultiVector< Scalar, LocalOrdinal, GlobalOrdinal, Node > >  full,
bool  bThyraMode = false 
) const
inline

Definition at line 476 of file Xpetra_MapExtractor.hpp.

◆ getVector() [1/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP< Vector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector ( size_t  i,
bool  bThyraMode = false,
bool  bZero = true 
) const
inline

Definition at line 486 of file Xpetra_MapExtractor.hpp.

◆ getVector() [2/2]

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<MultiVector> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getVector ( size_t  i,
size_t  numvec,
bool  bThyraMode = false,
bool  bZero = true 
) const
inline

Definition at line 491 of file Xpetra_MapExtractor.hpp.

◆ getThyraMode()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getThyraMode ( ) const
inline

returns true, if sub maps are stored in Thyra-style numbering

Definition at line 498 of file Xpetra_MapExtractor.hpp.

◆ NumMaps()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::NumMaps ( ) const
inline

number of partial maps

Definition at line 504 of file Xpetra_MapExtractor.hpp.

◆ getMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP<const Map> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMap ( size_t  i,
bool  bThyraMode = false 
) const
inline

get the map returns the sub map i from list of sub maps depending on the parameter bThyraMode the sub map that is returned uses Thyra or Xpetra numbering Note: Thyra-numbering is only allowed if the MapExtractor is also constructed using Thyra numbering

Definition at line 510 of file Xpetra_MapExtractor.hpp.

◆ getFullMap()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
const RCP<const Map> Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getFullMap ( ) const
inline

the full map

Definition at line 520 of file Xpetra_MapExtractor.hpp.

◆ getMapIndexForGID()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
size_t Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::getMapIndexForGID ( GlobalOrdinal  gid) const
inline

returns map index in map extractor which contains GID

Definition at line 523 of file Xpetra_MapExtractor.hpp.

◆ CheckConsistency()

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::CheckConsistency ( ) const
inlineprivate

Definition at line 536 of file Xpetra_MapExtractor.hpp.

Member Data Documentation

◆ fullmap_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
RCP<const Map > Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::fullmap_
private

Definition at line 551 of file Xpetra_MapExtractor.hpp.

◆ maps_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::vector<RCP<const Map> > Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::maps_
private

Definition at line 552 of file Xpetra_MapExtractor.hpp.

◆ importers_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::vector<RCP<Import > > Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::importers_
private

Definition at line 553 of file Xpetra_MapExtractor.hpp.

◆ bThyraMode_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
bool Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::bThyraMode_
private

Definition at line 554 of file Xpetra_MapExtractor.hpp.

◆ thyraMaps_

template<class Scalar , class LocalOrdinal , class GlobalOrdinal , class Node >
std::vector<RCP<const Map> > Xpetra::MapExtractor< Scalar, LocalOrdinal, GlobalOrdinal, Node >::thyraMaps_
private

Definition at line 555 of file Xpetra_MapExtractor.hpp.


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