Zoltan2
Public Types | Static Public Member Functions
Zoltan2::InputTraits< User > Struct Template Reference

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

#include <Zoltan2_InputTraits.hpp>

List of all members.

Public Types

typedef default_scalar_t scalar_t
 The data type for weights and coordinates.
typedef default_lno_t lno_t
 The ordinal type (e.g., int, long, int64_t) that represents local counts and local indices.
typedef default_gno_t gno_t
 The ordinal type (e.g., int, long, int64_t) that can represent global counts and identifiers.
typedef default_gno_t gid_t
 The data type that the user uses for global Identifiers.
typedef default_part_t part_t
 The data type to represent part numbers.
typedef
KokkosClassic::DefaultNode::DefaultNodeType 
node_t
 The Kokkos node type. This is only meaningful for users of Tpetra objects.

Static Public Member Functions

static std::string name ()
 The name of the user's input object.

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:

Todo:
Tpetra::RowMatrix

Definition at line 180 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 184 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 189 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 194 of file Zoltan2_InputTraits.hpp.

template<typename User>
typedef default_gno_t Zoltan2::InputTraits< User >::gid_t

The data type that the user uses for global Identifiers.

In most cases this is the same as the gno_t. However if a user uses Ids that are not Teuchos Ordinals, such as pair<int, int> then this is different.

Definition at line 202 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 206 of file Zoltan2_InputTraits.hpp.

template<typename User>
typedef KokkosClassic::DefaultNode::DefaultNodeType Zoltan2::InputTraits< User >::node_t

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

Definition at line 211 of file Zoltan2_InputTraits.hpp.


Member Function Documentation

template<typename User>
static std::string Zoltan2::InputTraits< User >::name ( ) [inline, static]

The name of the user's input object.

Definition at line 215 of file Zoltan2_InputTraits.hpp.


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