Tpetra::Platform< Ordinal > Class Template Reference

Tpetra::Platform: The Tpetra Platform Abstract Base Class. More...

#include <Tpetra_Platform.hpp>

Inheritance diagram for Tpetra::Platform< Ordinal >:

Teuchos::Object Tpetra::MpiPlatform< Ordinal > Tpetra::SerialPlatform< Ordinal > List of all members.

Public Member Functions

Constructor/Destructor Methods
 Platform (const std::string &str)
 Constructor.
virtual ~Platform ()
 Destructor.
virtual Teuchos::RCP< Platform<
Ordinal > > 
clone () const =0
 Clone method.
Class Creation and Accessor Methods
virtual Teuchos::RCP< Teuchos::Comm<
Ordinal > > 
createComm () const =0
 Create a Comm instance for global communication between nodes.

Detailed Description

template<typename Ordinal>
class Tpetra::Platform< Ordinal >

Tpetra::Platform: The Tpetra Platform Abstract Base Class.

Platform is an abstract base class. Platform is used to generate Comm instances. It also manages platform-specific information, such as how inter-image communication is implemented. An implementation of Platform (e.g., SerialPlatform) will create corresponding classes, (e.g., SerialComm). These will then be cast to their base class, and passed back to other Tpetra modules. As a result, other Tpetra modules don't need to know anything about the platform they're running on, or any implementation-specific details.


Constructor & Destructor Documentation

template<typename Ordinal>
Tpetra::Platform< Ordinal >::Platform ( const std::string &  str  ) 

Constructor.

template<typename Ordinal>
virtual Tpetra::Platform< Ordinal >::~Platform (  )  [inline, virtual]

Destructor.


Member Function Documentation

template<typename Ordinal>
virtual Teuchos::RCP< Platform<Ordinal> > Tpetra::Platform< Ordinal >::clone (  )  const [pure virtual]

Clone method.

Returns a copy of this Platform instance. It is allocated on the heap and encapsulated in a Teuchos RCP.

Implemented in Tpetra::MpiPlatform< Ordinal >, and Tpetra::SerialPlatform< Ordinal >.

template<typename Ordinal>
virtual Teuchos::RCP< Teuchos::Comm<Ordinal> > Tpetra::Platform< Ordinal >::createComm (  )  const [pure virtual]

Create a Comm instance for global communication between nodes.

Implemented in Tpetra::MpiPlatform< Ordinal >, and Tpetra::SerialPlatform< Ordinal >.


The documentation for this class was generated from the following file:
Generated on Wed May 12 21:59:42 2010 for Tpetra Matrix/Vector Services by  doxygen 1.4.7