Tpetra Matrix/Vector Services Version of the Day
Public Types | Protected Attributes
Tpetra::MpiPlatform< Node > Class Template Reference

A implementation of the Platform class for MPI-based platforms. More...

#include <Tpetra_MpiPlatform.hpp>

Inheritance diagram for Tpetra::MpiPlatform< Node >:
Inheritance graph
[legend]

List of all members.

Public Types

typedef Node NodeType
 Typedef indicating the node type over which the platform is templated. This default to the Kokkos default node type.

Public Member Functions

Constructor/Destructor Methods
 MpiPlatform (const RCP< Node > &node)
 Node-accepting constructor uses MPI_COMM_WORLD.
 MpiPlatform (const RCP< Node > &node, const RCP< const Teuchos::OpaqueWrapper< MPI_Comm > > &rawMpiComm)
 Node and MPI_Comm accepting constructor.
virtual ~MpiPlatform ()
 Destructor.
Class Creation and Accessor Methods
RCP< const Comm< int > > getComm () const
 Comm Instance.
RCP< Node > getNode () const
 Get Get a node for parallel computation.

Protected Attributes

RCP< Teuchos::MpiComm< int > > comm_
 Teuchos::Comm object instantiated for the platform.
RCP< Node > node_
 Node object instantiated for the platform.

Detailed Description

template<class Node>
class Tpetra::MpiPlatform< Node >

A implementation of the Platform class for MPI-based platforms.

This class is templated on Scalar, LocalOrdinal and GlobalOrdinal. The LocalOrdinal type, if omitted, defaults to int. The GlobalOrdinal type, if omitted, defaults to the LocalOrdinal type.

Definition at line 45 of file Tpetra_MpiPlatform.hpp.


Member Typedef Documentation

template<class Node>
typedef Node Tpetra::MpiPlatform< Node >::NodeType

Typedef indicating the node type over which the platform is templated. This default to the Kokkos default node type.

Definition at line 56 of file Tpetra_MpiPlatform.hpp.


Constructor & Destructor Documentation

template<class Node>
Tpetra::MpiPlatform< Node >::MpiPlatform ( const RCP< Node > &  node) [inline, explicit]

Node-accepting constructor uses MPI_COMM_WORLD.

Definition at line 61 of file Tpetra_MpiPlatform.hpp.

template<class Node>
Tpetra::MpiPlatform< Node >::MpiPlatform ( const RCP< Node > &  node,
const RCP< const Teuchos::OpaqueWrapper< MPI_Comm > > &  rawMpiComm 
) [inline]

Node and MPI_Comm accepting constructor.

Definition at line 67 of file Tpetra_MpiPlatform.hpp.

template<class Node>
virtual Tpetra::MpiPlatform< Node >::~MpiPlatform ( ) [inline, virtual]

Destructor.

Definition at line 73 of file Tpetra_MpiPlatform.hpp.


Member Function Documentation

template<class Node>
RCP< const Comm<int> > Tpetra::MpiPlatform< Node >::getComm ( ) const [inline]

Comm Instance.

Definition at line 81 of file Tpetra_MpiPlatform.hpp.

template<class Node>
RCP<Node> Tpetra::MpiPlatform< Node >::getNode ( ) const [inline]

Get Get a node for parallel computation.

Definition at line 86 of file Tpetra_MpiPlatform.hpp.


Member Data Documentation

template<class Node>
RCP<Teuchos::MpiComm<int> > Tpetra::MpiPlatform< Node >::comm_ [protected]

Teuchos::Comm object instantiated for the platform.

Definition at line 51 of file Tpetra_MpiPlatform.hpp.

template<class Node>
RCP<Node> Tpetra::MpiPlatform< Node >::node_ [protected]

Node object instantiated for the platform.

Definition at line 53 of file Tpetra_MpiPlatform.hpp.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines