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

Create an Xpetra::Map instance. More...

#include <Xpetra_MapFactory.hpp>

Static Public Member Functions

static Teuchos::RCP< Node > defaultArgNode ()
 
static Teuchos::RCP< Map< LocalOrdinal, GlobalOrdinal, Node > > Build (UnderlyingLib lib, global_size_t numGlobalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, LocalGlobal lg=Xpetra::GloballyDistributed, const Teuchos::RCP< Node > &node=defaultArgNode())
 Map constructor with Xpetra-defined contiguous uniform distribution. More...
 
static Teuchos::RCP< Map< LocalOrdinal, GlobalOrdinal, Node > > Build (UnderlyingLib lib, global_size_t numGlobalElements, size_t numLocalElements, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=defaultArgNode())
 Map constructor with a user-defined contiguous distribution. More...
 
static Teuchos::RCP< Map< LocalOrdinal, GlobalOrdinal, Node > > Build (UnderlyingLib lib, global_size_t numGlobalElements, const Teuchos::ArrayView< const GlobalOrdinal > &elementList, GlobalOrdinal indexBase, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node=defaultArgNode())
 Map constructor with user-defined non-contiguous (arbitrary) distribution. More...
 
static Teuchos::RCP< Map< LocalOrdinal, GlobalOrdinal, Node > > Build (const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &map, LocalOrdinal numDofPerNode)
 
static Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createLocalMap (UnderlyingLib lib, size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
 Create a locally replicated Map with the default node. More...
 
static Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createLocalMapWithNode (UnderlyingLib lib, size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node)
 Create a locally replicated Map with a specified node. More...
 
static Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createUniformContigMapWithNode (UnderlyingLib lib, global_size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node)
 Create a uniform, contiguous Map with a user-specified node. More...
 
static Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createUniformContigMap (UnderlyingLib lib, global_size_t numElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
 Create a uniform, contiguous Map with the default node. More...
 
static Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createContigMap (UnderlyingLib lib, global_size_t numElements, size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm)
 Create a (potentially) non-uniform, contiguous Map with the default node. More...
 
static Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > createContigMapWithNode (UnderlyingLib lib, global_size_t numElements, size_t localNumElements, const Teuchos::RCP< const Teuchos::Comm< int > > &comm, const Teuchos::RCP< Node > &node)
 Create a (potentially) non-uniform, contiguous Map with a user-specified node. More...
 

Private Member Functions

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

Detailed Description

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
class Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >

Create an Xpetra::Map instance.

Users must specify the exact class of the object that they want to create (either an Xpetra::TpetraMap or an Xpetra::EpetraMap).

Definition at line 70 of file Xpetra_MapFactory.hpp.

Constructor & Destructor Documentation

◆ MapFactory()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::MapFactory ( )
inlineprivate

Private constructor. This is a static class.

Definition at line 74 of file Xpetra_MapFactory.hpp.

Member Function Documentation

◆ defaultArgNode()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP<Node> Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::defaultArgNode ( )
inlinestatic

Definition at line 77 of file Xpetra_MapFactory.hpp.

◆ Build() [1/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP<Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( UnderlyingLib  lib,
global_size_t  numGlobalElements,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
LocalGlobal  lg = Xpetra::GloballyDistributed,
const Teuchos::RCP< Node > &  node = defaultArgNode () 
)
inlinestatic

Map constructor with Xpetra-defined contiguous uniform distribution.

Definition at line 90 of file Xpetra_MapFactory.hpp.

◆ Build() [2/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP<Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( UnderlyingLib  lib,
global_size_t  numGlobalElements,
size_t  numLocalElements,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node = defaultArgNode () 
)
inlinestatic

Map constructor with a user-defined contiguous distribution.

Definition at line 110 of file Xpetra_MapFactory.hpp.

◆ Build() [3/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP<Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( UnderlyingLib  lib,
global_size_t  numGlobalElements,
const Teuchos::ArrayView< const GlobalOrdinal > &  elementList,
GlobalOrdinal  indexBase,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node = defaultArgNode () 
)
inlinestatic

Map constructor with user-defined non-contiguous (arbitrary) distribution.

Definition at line 130 of file Xpetra_MapFactory.hpp.

◆ Build() [4/4]

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP<Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::Build ( const Teuchos::RCP< const Map< LocalOrdinal, GlobalOrdinal, Node > > &  map,
LocalOrdinal  numDofPerNode 
)
inlinestatic

Map constructor transforming degrees of freedom for numDofPerNode this acts like a deep copy

Definition at line 151 of file Xpetra_MapFactory.hpp.

◆ createLocalMap()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP<const Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::createLocalMap ( UnderlyingLib  lib,
size_t  numElements,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm 
)
inlinestatic

Create a locally replicated Map with the default node.

Definition at line 173 of file Xpetra_MapFactory.hpp.

◆ createLocalMapWithNode()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::createLocalMapWithNode ( UnderlyingLib  lib,
size_t  numElements,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node 
)
inlinestatic

Create a locally replicated Map with a specified node.

Definition at line 190 of file Xpetra_MapFactory.hpp.

◆ createUniformContigMapWithNode()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::createUniformContigMapWithNode ( UnderlyingLib  lib,
global_size_t  numElements,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node 
)
inlinestatic

Create a uniform, contiguous Map with a user-specified node.

Definition at line 208 of file Xpetra_MapFactory.hpp.

◆ createUniformContigMap()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::createUniformContigMap ( UnderlyingLib  lib,
global_size_t  numElements,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm 
)
inlinestatic

Create a uniform, contiguous Map with the default node.

Definition at line 226 of file Xpetra_MapFactory.hpp.

◆ createContigMap()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::createContigMap ( UnderlyingLib  lib,
global_size_t  numElements,
size_t  localNumElements,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm 
)
inlinestatic

Create a (potentially) non-uniform, contiguous Map with the default node.

Definition at line 243 of file Xpetra_MapFactory.hpp.

◆ createContigMapWithNode()

template<class LocalOrdinal = Map<>::local_ordinal_type, class GlobalOrdinal = typename Map<LocalOrdinal>::global_ordinal_type, class Node = typename Map<LocalOrdinal, GlobalOrdinal>::node_type>
static Teuchos::RCP< const Map<LocalOrdinal,GlobalOrdinal, Node> > Xpetra::MapFactory< LocalOrdinal, GlobalOrdinal, Node >::createContigMapWithNode ( UnderlyingLib  lib,
global_size_t  numElements,
size_t  localNumElements,
const Teuchos::RCP< const Teuchos::Comm< int > > &  comm,
const Teuchos::RCP< Node > &  node 
)
inlinestatic

Create a (potentially) non-uniform, contiguous Map with a user-specified node.

Definition at line 261 of file Xpetra_MapFactory.hpp.


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