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< 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)
	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)
	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)
	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)
	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)
	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)
	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 72 of file Xpetra_MapFactory.hpp.

Constructor & Destructor Documentation

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 76 of file Xpetra_MapFactory.hpp.

Member Function Documentation

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  )

inlinestatic

Map constructor with Xpetra-defined contiguous uniform distribution.

Definition at line 94 of file Xpetra_MapFactory.hpp.

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  )

inlinestatic

Map constructor with a user-defined contiguous distribution.

Definition at line 126 of file Xpetra_MapFactory.hpp.

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  )

inlinestatic

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

Definition at line 158 of file Xpetra_MapFactory.hpp.

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 178 of file Xpetra_MapFactory.hpp.

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 229 of file Xpetra_MapFactory.hpp.

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  )

inlinestatic

Create a locally replicated Map with a specified node.

Definition at line 257 of file Xpetra_MapFactory.hpp.

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  )

inlinestatic

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

Definition at line 285 of file Xpetra_MapFactory.hpp.

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 302 of file Xpetra_MapFactory.hpp.

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 319 of file Xpetra_MapFactory.hpp.

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  )

inlinestatic

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

Definition at line 349 of file Xpetra_MapFactory.hpp.

---

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

• Xpetra_MapFactory.hpp