Public Types | Protected Attributes | Private Member Functions | Private Attributes | List of all members
Xpetra::MpiPlatform< Node > Class Template Reference

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

#include <Xpetra_MpiPlatform.hpp>

Inheritance diagram for Xpetra::MpiPlatform< Node >:

Public Types

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

Protected Attributes

Teuchos::RCP< Node > node_
 Node object instantiated for the platform. More...
 

Private Member Functions

 MpiPlatform (const MpiPlatform< Node > &platform)
 

Private Attributes

Teuchos::RCP< Teuchos::MpiComm< int > > comm_
 

Constructor/Destructor Methods

 MpiPlatform (Teuchos::RCP< Node > node)
 Constructor. More...
 
 MpiPlatform (Teuchos::RCP< Node > node, const Teuchos::RCP< const Teuchos::OpaqueWrapper< MPI_Comm > > &rawMpiComm)
 Constructor. More...
 
 ~MpiPlatform ()
 Destructor. More...
 

Class Creation and Accessor Methods

Teuchos::RCP< const Teuchos::Comm< int > > getComm () const
 Comm Instance. More...
 
Teuchos::RCP< Node > getNode () const
 Get Get a node for parallel computation. More...
 

Detailed Description

template<class Node = KokkosClassic::DefaultNode::DefaultNodeType>
class Xpetra::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 64 of file Xpetra_MpiPlatform.hpp.

Member Typedef Documentation

◆ NodeType

template<class Node = KokkosClassic::DefaultNode::DefaultNodeType>
typedef Node Xpetra::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 67 of file Xpetra_MpiPlatform.hpp.

Constructor & Destructor Documentation

◆ MpiPlatform() [1/3]

template<class Node >
Xpetra::MpiPlatform< Node >::MpiPlatform ( Teuchos::RCP< Node >  node)
explicit

Constructor.

Definition at line 109 of file Xpetra_MpiPlatform.hpp.

◆ MpiPlatform() [2/3]

template<class Node >
Xpetra::MpiPlatform< Node >::MpiPlatform ( Teuchos::RCP< Node >  node,
const Teuchos::RCP< const Teuchos::OpaqueWrapper< MPI_Comm > > &  rawMpiComm 
)

Constructor.

Definition at line 103 of file Xpetra_MpiPlatform.hpp.

◆ ~MpiPlatform()

template<class Node >
Xpetra::MpiPlatform< Node >::~MpiPlatform ( )

Destructor.

Definition at line 115 of file Xpetra_MpiPlatform.hpp.

◆ MpiPlatform() [3/3]

template<class Node >
Xpetra::MpiPlatform< Node >::MpiPlatform ( const MpiPlatform< Node > &  platform)
private

Definition at line 118 of file Xpetra_MpiPlatform.hpp.

Member Function Documentation

◆ getComm()

template<class Node >
Teuchos::RCP< const Teuchos::Comm< int > > Xpetra::MpiPlatform< Node >::getComm ( ) const

Comm Instance.

Definition at line 124 of file Xpetra_MpiPlatform.hpp.

◆ getNode()

template<class Node >
Teuchos::RCP< Node > Xpetra::MpiPlatform< Node >::getNode ( ) const

Get Get a node for parallel computation.

Definition at line 129 of file Xpetra_MpiPlatform.hpp.

Member Data Documentation

◆ node_

template<class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::RCP<Node> Xpetra::MpiPlatform< Node >::node_
protected

Node object instantiated for the platform.

Definition at line 95 of file Xpetra_MpiPlatform.hpp.

◆ comm_

template<class Node = KokkosClassic::DefaultNode::DefaultNodeType>
Teuchos::RCP<Teuchos::MpiComm<int> > Xpetra::MpiPlatform< Node >::comm_
private

Definition at line 98 of file Xpetra_MpiPlatform.hpp.


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