Tpetra::SerialPlatform< Node > Class Template Reference

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

#include <Tpetra_SerialPlatform.hpp>

Inherits Describable.

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

Public Member Functions
Constructors and destructor
	SerialPlatform (int *argc, char ***argv)
	Constructor that accepts the same arguments as Tpetra::initialize(). More...
	SerialPlatform (const Teuchos::RCP< NodeType > &)
	Constructor that accepts a Kokkos Node instance. More...
	SerialPlatform (int *argc, char ***argv, const Teuchos::RCP< NodeType > &)
	Constructor that accepts the same arguments as Tpetra::initialize(), plus a Kokkos Node. More...
virtual	~SerialPlatform ()
	Destructor (virtual for memory safety of derived classes). More...
Methods to access the communicator and Kokkos Node.
Teuchos::RCP< const Teuchos::Comm< int > >	getComm () const
	The Teuchos::Comm instance with which this object was created. More...
Teuchos::RCP< Node >	getNode () const
	The Kokkos Node instance. More...

Protected Attributes
Teuchos::RCP< const Teuchos::Comm< int > >	comm_
	Teuchos::Comm object instantiated for the platform. More...

Detailed Description

template<class Node>
class Tpetra::SerialPlatform< Node >

Implementation of the Platform concept for non-MPI platforms.

Warning

This class is DEPRECATED and will be REMOVED SOON. Do not use *Platform classes any more. To initialize Tpetra, include Tpetra_Core.hpp and use Tpetra::ScopeGuard, or Tpetra::initialize and Tpetra::finalize. To get Tpetra's default Comm instance, include Tpetra_Core.hpp and call Tpetra::getDefaultComm(). For the default Node type, use Tpetra::Map<>::node_type. Do not create Node instances yourself. It is OK for Node instances to be null.

Definition at line 66 of file Tpetra_SerialPlatform.hpp.

Member Typedef Documentation

template<class Node>

typedef Node Tpetra::SerialPlatform< Node >::NodeType

Kokkos Node type; the template parameter of this class.

Definition at line 72 of file Tpetra_SerialPlatform.hpp.

Constructor & Destructor Documentation

template<class Node>

Tpetra::SerialPlatform< Node >::SerialPlatform ( int *  argc, char ***  argv  )

inlineexplicit

Constructor that accepts the same arguments as Tpetra::initialize().

Parameters

argc	[in/out] First argument of Tpetra::initialize().
argv	[in/out] Second argument of Tpetra::initialize().

Definition at line 83 of file Tpetra_SerialPlatform.hpp.

template<class Node>

Tpetra::SerialPlatform< Node >::SerialPlatform ( const Teuchos::RCP< NodeType > &  )

inlineexplicit

Constructor that accepts a Kokkos Node instance.

Node will be deprecated and removed in favor of Kokkos::Device, so the Node can and should always be Teuchos::null.

Definition at line 95 of file Tpetra_SerialPlatform.hpp.

template<class Node>

Tpetra::SerialPlatform< Node >::SerialPlatform ( int *  argc, char ***  argv, const Teuchos::RCP< NodeType > &    )

inlineexplicit

Constructor that accepts the same arguments as Tpetra::initialize(), plus a Kokkos Node.

Parameters

argc	[in/out] First argument of Tpetra::initialize().
argv	[in/out] Second argument of Tpetra::initialize().
node	[in/out] The Kokkos Node instance.

Node will be deprecated and removed in favor of Kokkos::Device, so the Node can and should always be Teuchos::null.

Definition at line 110 of file Tpetra_SerialPlatform.hpp.

template<class Node>

virtual Tpetra::SerialPlatform< Node >::~SerialPlatform ( )

inlinevirtual

Destructor (virtual for memory safety of derived classes).

Definition at line 119 of file Tpetra_SerialPlatform.hpp.

Member Function Documentation

template<class Node>

Teuchos::RCP<const Teuchos::Comm<int> > Tpetra::SerialPlatform< Node >::getComm ( ) const

inline

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

Definition at line 126 of file Tpetra_SerialPlatform.hpp.

template<class Node>

Teuchos::RCP<Node> Tpetra::SerialPlatform< Node >::getNode ( ) const

inline

The Kokkos Node instance.

Since Node will be deprecated and removed in favor of Kokkos::Device, this method may return Teuchos::null.

Definition at line 134 of file Tpetra_SerialPlatform.hpp.

Member Data Documentation

template<class Node>

Teuchos::RCP<const Teuchos::Comm<int> > Tpetra::SerialPlatform< Node >::comm_

protected

Teuchos::Comm object instantiated for the platform.

Definition at line 141 of file Tpetra_SerialPlatform.hpp.

---

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

• Tpetra_SerialPlatform.hpp