Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

This factory creates a Xpetra::StridedMap . More...

#include <Xpetra_StridedMapFactory_decl.hpp>

Static Public Member Functions
static RCP< Xpetra::StridedMap < LocalOrdinal, GlobalOrdinal, Node > >	Build (UnderlyingLib lib, global_size_t numGlobalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0, LocalGlobal lg=Xpetra::GloballyDistributed)
	Map constructor with Xpetra-defined contiguous uniform distribution. More...
static RCP< StridedMap >	Build (UnderlyingLib lib, global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0)
	Map constructor with a user-defined contiguous distribution. More...
static RCP< StridedMap >	Build (const RCP< const Map > &map, std::vector< size_t > &stridingInfo, LocalOrdinal stridedBlockId=-1, GlobalOrdinal offset=0)
	Build a strided map. More...
static RCP< StridedMap >	Build (const RCP< const StridedMap > &map, LocalOrdinal stridedBlockId)
	special constructor for generating a given subblock of a strided map More...
static RCP< StridedMap >	Build (const StridedMap &map)
	Create copy of existing map (this just creates a copy of your map, it's not a clone in the sense of Tpetra) More...
static RCP< StridedMap >	Build (UnderlyingLib lib, global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, std::vector< size_t > &stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &comm, LocalOrdinal stridedBlockId=-1, GlobalOrdinal=0)
	Map constructor with a user-defined contiguous distribution. More...

Private Member Functions
	StridedMapFactory ()=delete
	Private constructor. This is a static class. More...

Detailed Description

template<class LocalOrdinal, class GlobalOrdinal, class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >

This factory creates a Xpetra::StridedMap .

Template Parameters

LocalOrdinal
GlobalOrdinal
Node

Definition at line 32 of file Xpetra_StridedMapFactory_decl.hpp.

Constructor & Destructor Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node = Tpetra::KokkosClassic::DefaultNode::DefaultNodeType>

Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::StridedMapFactory ( )

privatedelete

Private constructor. This is a static class.

Member Function Documentation

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( UnderlyingLib  lib, global_size_t  numGlobalElements, GlobalOrdinal  indexBase, std::vector< size_t > &  stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &  comm, LocalOrdinal  stridedBlockId = -1, GlobalOrdinal  offset = 0, LocalGlobal  lg = Xpetra::GloballyDistributed  )

static

Map constructor with Xpetra-defined contiguous uniform distribution.

Definition at line 24 of file Xpetra_StridedMapFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( UnderlyingLib  lib, global_size_t  numGlobalElements, size_t  numLocalElements, GlobalOrdinal  indexBase, std::vector< size_t > &  stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &  comm, LocalOrdinal  stridedBlockId = -1, GlobalOrdinal  offset = 0  )

static

Map constructor with a user-defined contiguous distribution.

Definition at line 38 of file Xpetra_StridedMapFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const RCP< const Map > &  map, std::vector< size_t > &  stridingInfo, LocalOrdinal  stridedBlockId = -1, GlobalOrdinal  offset = 0  )

static

Build a strided map.

Definition at line 52 of file Xpetra_StridedMapFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const RCP< const StridedMap > &  map, LocalOrdinal  stridedBlockId  )

static

special constructor for generating a given subblock of a strided map

Definition at line 62 of file Xpetra_StridedMapFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const StridedMap &  map )

static

Create copy of existing map (this just creates a copy of your map, it's not a clone in the sense of Tpetra)

Definition at line 105 of file Xpetra_StridedMapFactory_def.hpp.

template<class LocalOrdinal , class GlobalOrdinal , class Node >

RCP< Xpetra::StridedMap< LocalOrdinal, GlobalOrdinal, Node > > Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( UnderlyingLib  lib, global_size_t  numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &  elementList, GlobalOrdinal  indexBase, std::vector< size_t > &  stridingInfo, const Teuchos::RCP< const Teuchos::Comm< int >> &  comm, LocalOrdinal  stridedBlockId = -1, GlobalOrdinal  = 0  )

static

Map constructor with a user-defined contiguous distribution.

Warning

For experts only. There is no special check whether the generated strided maps are valid.

Definition at line 122 of file Xpetra_StridedMapFactory_def.hpp.

---

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

• Xpetra_StridedMapFactory_decl.hpp
• Xpetra_StridedMapFactory_def.hpp