Tpetra::Platform< OrdinalType, ScalarType > Class Template Reference

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

#include <Tpetra_Platform.hpp>

Inheritance diagram for Tpetra::Platform< OrdinalType, ScalarType >:

[legend]List of all members.

Public Member Functions
virtual	~Platform ()
	Destructor.
virtual Teuchos::RCP< Platform< OrdinalType, ScalarType > >	clone () const =0
	Clone method.
virtual Teuchos::RCP< Comm< OrdinalType, ScalarType > >	createScalarComm () const =0
	Comm Instances.
virtual Teuchos::RCP< Comm< OrdinalType, OrdinalType > >	createOrdinalComm () const =0
virtual void	printInfo (ostream &os) const =0
	printInfo

---

Detailed Description

template<typename OrdinalType, typename ScalarType>
class Tpetra::Platform< OrdinalType, ScalarType >

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

Platform is an abstract base class. It should never be called directly. Rather, an implementation of Platform, such as SerialPlatform, should be used instead. 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, such as SerialPlatform, will create corresponding classes, such as 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.

NOTE: Methods that return a new object (such as clone, createComm, etc.) return them encapsulated in a Teuchos RCP object. This is done whenever the new object is allocated on the heap.

---

Member Function Documentation

template<typename OrdinalType, typename ScalarType>

virtual Teuchos::RCP< Platform<OrdinalType, ScalarType> > Tpetra::Platform< OrdinalType, ScalarType >::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< OrdinalType, ScalarType >, and Tpetra::SerialPlatform< OrdinalType, ScalarType >.

---

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

• Tpetra_Platform.hpp

---