Zoltan2::InputTraits< User > Struct Template Reference

The traits required of User input classes or structures. More...

#include <Zoltan2_InputTraits.hpp>

Public Types
typedef default_scalar_t	scalar_t
	The data type for weights and coordinates. More...
typedef default_lno_t	lno_t
	The ordinal type (e.g., int, long, int64_t) that represents local counts and local indices. More...
typedef default_gno_t	gno_t
	The ordinal type (e.g., int, long, int64_t) that can represent global counts and identifiers. More...
typedef default_offset_t	offset_t
	The data type to represent offsets. More...
typedef default_part_t	part_t
	The data type to represent part numbers. More...
typedef default_node_t	node_t
	The Kokkos node type. This is only meaningful for users of Tpetra objects. More...

Static Public Member Functions
static std::string	name ()
	The name of the user's input object. More...

Detailed Description

template<typename User>
struct Zoltan2::InputTraits< User >

The traits required of User input classes or structures.

We use the symbol User as an abtraction of the user's input. If the user's data structure is an instance of a C++ class, or is a C-language struct, then it should have an InputTraits specialization. The InputAdapter is templated on the User object, and Zoltan2 uses the User object traits to get the user's data types.

If the User object is not a C++ class or C-language struct, and particularly if you do not plan to pass your User object as an argument to the InputAdapter constructor, you can use the BasicUserTypes class as your User class.

InputTraits already exist for:

• Xpetra::CrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Tpetra::CrsMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Epetra_CrsMatrix
• Xpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node>
• Tpetra::CrsGraph<LocalOrdinal,GlobalOrdinal,Node>
• Epetra_CrsGraph
• Xpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Tpetra::RowMatrix<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Tpetra::RowGraphx<LocalOrdinal,GlobalOrdinal,Node>
• Xpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Tpetra::Vector<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Epetra_Vector
• Xpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Tpetra::MultiVector<Scalar,LocalOrdinal,GlobalOrdinal,Node>
• Epetra_MultiVector
• BasicUserTypes

Definition at line 178 of file Zoltan2_InputTraits.hpp.

Member Typedef Documentation

template<typename User>

typedef default_scalar_t Zoltan2::InputTraits< User >::scalar_t

The data type for weights and coordinates.

Definition at line 182 of file Zoltan2_InputTraits.hpp.

template<typename User>

typedef default_lno_t Zoltan2::InputTraits< User >::lno_t

The ordinal type (e.g., int, long, int64_t) that represents local counts and local indices.

Definition at line 187 of file Zoltan2_InputTraits.hpp.

template<typename User>

typedef default_gno_t Zoltan2::InputTraits< User >::gno_t

The ordinal type (e.g., int, long, int64_t) that can represent global counts and identifiers.

Definition at line 192 of file Zoltan2_InputTraits.hpp.

template<typename User>

typedef default_offset_t Zoltan2::InputTraits< User >::offset_t

The data type to represent offsets.

Definition at line 196 of file Zoltan2_InputTraits.hpp.

template<typename User>

typedef default_part_t Zoltan2::InputTraits< User >::part_t

The data type to represent part numbers.

Definition at line 200 of file Zoltan2_InputTraits.hpp.

template<typename User>

typedef default_node_t Zoltan2::InputTraits< User >::node_t

The Kokkos node type. This is only meaningful for users of Tpetra objects.

Definition at line 205 of file Zoltan2_InputTraits.hpp.

Member Function Documentation

template<typename User>

static std::string Zoltan2::InputTraits< User >::name ( )

inlinestatic

The name of the user's input object.

Definition at line 209 of file Zoltan2_InputTraits.hpp.

---

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

• Zoltan2_InputTraits.hpp