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

Implementation of the Platform concept for MPI-based platforms. More...

#include <Tpetra_MpiPlatform.hpp>

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

List of all members.

Public Types

Typedefs
typedef Node NodeType
 Kokkos Node type; the template parameter of this class.

Public Member Functions

Constructors and destructor
 MpiPlatform (const Teuchos::RCP< Node > &node)
 Constructor that accepts a Kokkos Node.
 MpiPlatform (const Teuchos::RCP< Node > &node, const Teuchos::RCP< const Teuchos::OpaqueWrapper< MPI_Comm > > &rawMpiComm)
 Constructor that accepts a Kokkos Node and a wrapped MPI communicator.
 MpiPlatform (const Teuchos::RCP< Node > &node, MPI_Comm rawMpiComm)
 Constructor that accepts a Kokkos Node and a raw MPI communicator.
virtual ~MpiPlatform ()
 Destructor (virtual for memory safety of derived classes).
Methods to access the communicator and Kokkos Node.
Teuchos::RCP< const Comm< int > > getComm () const
 The Teuchos::Comm instance with which this object was created.
Teuchos::RCP< Node > getNode () const
 The Kokkos Node instance with which this object was created.

Protected Attributes

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

Detailed Description

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

Implementation of the Platform concept for MPI-based platforms.

MpiPlatform specialization for KokkosClassic::DefaultNode::DefaultNodeType.

MpiPlatform is an implementation of Tpetra's Platform concept. Classes implementing the Platform concept are templated on the Kokkos Node type. They have at least the following public interface:

 // This is not a real class; it just illustrates the concept.
 template<class Node>
 class Platform {
 public:
   typedef Node NodeType;
   explicit Platform (const RCP<Node>& node);
   RCP<const Comm<int> > getComm() const;
   RCP<Node> getNode() const;
 };

MpiPlatform also has a constructor that accepts an MPI communicator, over which the application using the platform should perform communication. The default communicator is MPI_COMM_WORLD. MpiPlatform is only available if Trilinos was built with MPI.

Warning:
KokkosClassic::DefaultNode::DefaultNodeType is a typedef, and may have a different type, depending on Trilinos' build options. For example, it may be KokkosClassic::SerialNode if Trilinos was built without a threading library, or KokkosClassic::TPINode if Trilinos was built with Pthreads.
Note:
In the past (up to and including the 10.8 Trilinos release), the specialization of MpiPlatform for the default Node type delayed instantiation of the default Node instance until getNode() was called. We have changed this behavior to simplify the code and make the specialization of MpiPlatform conform more closely to the generic version of MpiPlatform.

Definition at line 75 of file Tpetra_MpiPlatform.hpp.


Member Typedef Documentation

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

Kokkos Node type; the template parameter of this class.

Definition at line 81 of file Tpetra_MpiPlatform.hpp.


Constructor & Destructor Documentation

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

Constructor that accepts a Kokkos Node.

This version of the constructor uses MPI_COMM_WORLD as the communicator. It is declared "explicit" to forbid silent conversions via assignment from the Node instance to an MpiPlatform.

Parameters:
node[in/out] The Kokkos Node instance. If null, this class will create a Node with default parameters.

Definition at line 96 of file Tpetra_MpiPlatform.hpp.

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

Constructor that accepts a Kokkos Node and a wrapped MPI communicator.

This version of the constructor accepts an arbitrary MPI communicator. It requires that you first wrap the MPI communicator in a Teuchos::OpaqueWrapper. This is helpful if you want to "free" the communicator automatically after use.

If you just have a raw MPI_Comm and you want to be responsible for freeing it after use, use the constructor version that takes a raw MPI_Comm. Otherwise, see the documentation of Teuchos::OpaqueWrapper to learn how to wrap an MPI_Comm and how to set the wrapper to free the communicator automatically after use.

Parameters:
node[in/out] The Kokkos Node instance. If null, this class will create a Node with default parameters.
rawMpiComm[in] The MPI communicator, wrapped in a Teuchos::OpaqueWrapper.

Definition at line 119 of file Tpetra_MpiPlatform.hpp.

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

Constructor that accepts a Kokkos Node and a raw MPI communicator.

This version of constructor accepts an arbitrary "raw" (not wrapped) MPI communicator. You are responsible for freeing the MPI communicator after use, if necessary.

Parameters:
node[in/out] The Kokkos Node instance. If null, this class will create a Node with default parameters.
rawMpiComm[in] The "raw" (not wrapped) MPI communicator.

Definition at line 135 of file Tpetra_MpiPlatform.hpp.

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

Destructor (virtual for memory safety of derived classes).

Definition at line 141 of file Tpetra_MpiPlatform.hpp.


Member Function Documentation

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

The Teuchos::Comm instance with which this object was created.

Definition at line 148 of file Tpetra_MpiPlatform.hpp.

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

The Kokkos Node instance with which this object was created.

Definition at line 153 of file Tpetra_MpiPlatform.hpp.


Member Data Documentation

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

Teuchos::Comm object instantiated for the platform.

Definition at line 160 of file Tpetra_MpiPlatform.hpp.

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

Kokkos Node object instantiated for the platform.

Definition at line 162 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