Xpetra Version of the Day
Loading...
Searching...
No Matches
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 >:
Teuchos::Describable Teuchos::LabeledObject

Public Types

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

Class Creation and Accessor Methods

Teuchos::RCP< Teuchos::MpiComm< int > > comm_
 
Teuchos::RCP< const Teuchos::Comm< int > > getComm () const
 Comm Instance.
 
 MpiPlatform (const MpiPlatform< Node > &platform)
 

Constructor/Destructor Methods

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

Additional Inherited Members

- Public Member Functions inherited from Teuchos::Describable
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
DescribableStreamManipulatorState describe (const Describable &describable, const EVerbosityLevel verbLevel=Describable::verbLevel_default)
 
std::ostream & operator<< (std::ostream &os, const DescribableStreamManipulatorState &d)
 
virtual std::string description () const
 
virtual void describe (FancyOStream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
void describe (std::ostream &out, const EVerbosityLevel verbLevel=verbLevel_default) const
 
virtual ~Describable ()
 
- Public Member Functions inherited from Teuchos::LabeledObject
 LabeledObject ()
 
virtual ~LabeledObject ()
 
virtual void setObjectLabel (const std::string &objectLabel)
 
virtual std::string getObjectLabel () const
 
- Static Public Attributes inherited from Teuchos::Describable
static const EVerbosityLevel verbLevel_default
 

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 102 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 97 of file Xpetra_MpiPlatform.hpp.

◆ ~MpiPlatform()

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

Destructor.

Definition at line 107 of file Xpetra_MpiPlatform.hpp.

◆ MpiPlatform() [3/3]

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

Definition at line 110 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 116 of file Xpetra_MpiPlatform.hpp.

Member Data Documentation

◆ comm_

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

Definition at line 92 of file Xpetra_MpiPlatform.hpp.


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