Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type > Class Template Reference

SerialPlatform specialization for the default Node type. More...

#include <Tpetra_SerialPlatform.hpp>

Inherits Describable.

Public Types
Typedefs
typedef Tpetra::Details::DefaultTypes::node_type	NodeType
	Kokkos Node type; the template parameter of this class. More...

Public Member Functions
Constructors and destructor
	SerialPlatform ()
	Default constructor: uses Kokkos default node. More...
	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. 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 > >	comm_
	Teuchos::Comm object instantiated for the platform. More...
Teuchos::RCP< const Teuchos::Comm< int > >	getComm () const
	The Teuchos::Comm instance with which this object was created. More...
Teuchos::RCP< Tpetra::Details::DefaultTypes::node_type >	getNode () const
	The Kokkos Node instance. More...

Detailed Description

template<>
class Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >

SerialPlatform specialization for the default Node type.

Note

Tpetra::Details::DefaultTypes::node_type is a typedef, and may have a different type, depending on Trilinos' build options.

Definition at line 157 of file Tpetra_SerialPlatform.hpp.

Member Typedef Documentation

NodeType

typedef Tpetra::Details::DefaultTypes::node_type Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::NodeType

Kokkos Node type; the template parameter of this class.

Definition at line 164 of file Tpetra_SerialPlatform.hpp.

Constructor & Destructor Documentation

SerialPlatform() [1/4]

Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::SerialPlatform ( )

inline

Default constructor: uses Kokkos default node.

The specialization of SerialPlatform for the default Node type includes a default constructor.

Definition at line 174 of file Tpetra_SerialPlatform.hpp.

SerialPlatform() [2/4]

Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::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 183 of file Tpetra_SerialPlatform.hpp.

SerialPlatform() [3/4]

Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::SerialPlatform ( const Teuchos::RCP< NodeType > &  )

inlineexplicit

Constructor that accepts a Kokkos Node.

This version of the constructor is declared "explicit" to forbid silent type conversions from the Node instance to a SerialPlatform. (A single-argument constructor that is not declared "explicit" defines a type conversion method from the input type to the constructor's class's type.) The "explicit" declaration does not affect typical use of this constructor.

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

Definition at line 202 of file Tpetra_SerialPlatform.hpp.

SerialPlatform() [4/4]

Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::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 217 of file Tpetra_SerialPlatform.hpp.

~SerialPlatform()

virtual Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::~SerialPlatform ( )

inlinevirtual

Destructor (virtual for memory safety of derived classes).

Definition at line 226 of file Tpetra_SerialPlatform.hpp.

Member Function Documentation

getComm()

Teuchos::RCP<const Teuchos::Comm<int> > Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::getComm ( ) const

inline

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

Definition at line 233 of file Tpetra_SerialPlatform.hpp.

getNode()

Teuchos::RCP<Tpetra::Details::DefaultTypes::node_type> Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::getNode ( ) const

inline

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 243 of file Tpetra_SerialPlatform.hpp.

Member Data Documentation

comm_

Teuchos::RCP<const Teuchos::Comm<int> > Tpetra::SerialPlatform< Tpetra::Details::DefaultTypes::node_type >::comm_

protected

Teuchos::Comm object instantiated for the platform.

Definition at line 258 of file Tpetra_SerialPlatform.hpp.

---

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

• Tpetra_SerialPlatform.hpp