Xpetra  Version of the Day
Static Public Member Functions | Private Member Functions | List of all members
Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node > Class Template Reference

#include <Xpetra_StridedMapFactory_fwd.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)
 
static RCP< StridedMap > Build (const RCP< const StridedMap > &map, LocalOrdinal stridedBlockId)
 
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)
 

Private Member Functions

 StridedMapFactory ()
 Private constructor. This is a static class. More...
 

Detailed Description

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

Definition at line 51 of file Xpetra_StridedMapFactory_fwd.hpp.

Constructor & Destructor Documentation

◆ StridedMapFactory()

template<class LocalOrdinal , class GlobalOrdinal , class Node >
Xpetra::StridedMapFactory< LocalOrdinal, GlobalOrdinal, Node >::StridedMapFactory ( )
private

Private constructor. This is a static class.

Definition at line 67 of file Xpetra_StridedMapFactory_def.hpp.

Member Function Documentation

◆ Build() [1/6]

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 77 of file Xpetra_StridedMapFactory_def.hpp.

◆ Build() [2/6]

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 95 of file Xpetra_StridedMapFactory_def.hpp.

◆ Build() [3/6]

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

Definition at line 111 of file Xpetra_StridedMapFactory_def.hpp.

◆ Build() [4/6]

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

Definition at line 123 of file Xpetra_StridedMapFactory_def.hpp.

◆ Build() [5/6]

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 174 of file Xpetra_StridedMapFactory_def.hpp.

◆ Build() [6/6]

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. (for experts only. There is no special check whether the generated strided maps are valid)

Definition at line 199 of file Xpetra_StridedMapFactory_def.hpp.

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