Zoltan2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Public Member Functions | List of all members
Zoltan2::CoordinateModel< Adapter > Class Template Reference

This class provides geometric coordinates with optional weights to the Zoltan2 algorithm. More...

#include <Zoltan2_CoordinateModel.hpp>

Inheritance diagram for Zoltan2::CoordinateModel< Adapter >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::CoordinateModel< Adapter >:
Collaboration graph
[legend]

Public Member Functions

 CoordinateModel (const RCP< const VectorAdapter< user_t > > &ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
 
 CoordinateModel (const RCP< const MatrixAdapter< user_t, userCoord_t > > &ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
 
 CoordinateModel (const RCP< const GraphAdapter< user_t, userCoord_t > > &ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
 
 CoordinateModel (const RCP< const MeshAdapter< user_t > > &ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
 
 CoordinateModel (const RCP< const IdentifierAdapter< user_t > > &ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
 
int getCoordinateDim () const
 Returns the dimension of the coordinates. More...
 
size_t getLocalNumCoordinates () const
 Returns the number of coordinates on this process. More...
 
global_size_t getGlobalNumCoordinates () const
 Returns the global number coordinates. More...
 
int getNumWeightsPerCoordinate () const
 Returns the number (0 or greater) of weights per coordinate. More...
 
size_t getCoordinates (ArrayView< const gno_t > &Ids, ArrayView< input_t > &xyz, ArrayView< input_t > &wgts) const
 Returns the coordinate ids, values and optional weights. More...
 
size_t getCoordinatesKokkos (Kokkos::View< const gno_t *, typename node_t::device_type > &Ids, Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > &xyz, Kokkos::View< scalar_t **, typename node_t::device_type > &wgts) const
 Returns the coordinate ids, values and optional weights. More...
 
size_t getLocalNumObjects () const
 Return the local number of objects. More...
 
size_t getGlobalNumObjects () const
 Return the global number of objects. More...
 
- Public Member Functions inherited from Zoltan2::Model< Adapter >
virtual ~Model ()
 
 Model ()
 

Detailed Description

template<typename Adapter>
class Zoltan2::CoordinateModel< Adapter >

This class provides geometric coordinates with optional weights to the Zoltan2 algorithm.

The template parameter is an Input Adapter. Input adapters are templated on the basic user input type.

Definition at line 35 of file Zoltan2_CoordinateModel.hpp.

Constructor & Destructor Documentation

template<typename Adapter>
Zoltan2::CoordinateModel< Adapter >::CoordinateModel ( const RCP< const VectorAdapter< user_t > > &  ia,
const RCP< const Environment > &  env,
const RCP< const Comm< int > > &  comm,
modelFlag_t flags 
)
inline

Definition at line 54 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
Zoltan2::CoordinateModel< Adapter >::CoordinateModel ( const RCP< const MatrixAdapter< user_t, userCoord_t > > &  ia,
const RCP< const Environment > &  env,
const RCP< const Comm< int > > &  comm,
modelFlag_t flags 
)
inline

Definition at line 68 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
Zoltan2::CoordinateModel< Adapter >::CoordinateModel ( const RCP< const GraphAdapter< user_t, userCoord_t > > &  ia,
const RCP< const Environment > &  env,
const RCP< const Comm< int > > &  comm,
modelFlag_t flags 
)
inline

Definition at line 88 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
Zoltan2::CoordinateModel< Adapter >::CoordinateModel ( const RCP< const MeshAdapter< user_t > > &  ia,
const RCP< const Environment > &  env,
const RCP< const Comm< int > > &  comm,
modelFlag_t flags 
)
inline

Definition at line 108 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
Zoltan2::CoordinateModel< Adapter >::CoordinateModel ( const RCP< const IdentifierAdapter< user_t > > &  ia,
const RCP< const Environment > &  env,
const RCP< const Comm< int > > &  comm,
modelFlag_t flags 
)
inline

Definition at line 122 of file Zoltan2_CoordinateModel.hpp.

Member Function Documentation

template<typename Adapter>
int Zoltan2::CoordinateModel< Adapter >::getCoordinateDim ( ) const
inline

Returns the dimension of the coordinates.

Definition at line 137 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
size_t Zoltan2::CoordinateModel< Adapter >::getLocalNumCoordinates ( ) const
inline

Returns the number of coordinates on this process.

Definition at line 141 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
global_size_t Zoltan2::CoordinateModel< Adapter >::getGlobalNumCoordinates ( ) const
inline

Returns the global number coordinates.

Definition at line 145 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
int Zoltan2::CoordinateModel< Adapter >::getNumWeightsPerCoordinate ( ) const
inline

Returns the number (0 or greater) of weights per coordinate.

Definition at line 149 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
size_t Zoltan2::CoordinateModel< Adapter >::getCoordinates ( ArrayView< const gno_t > &  Ids,
ArrayView< input_t > &  xyz,
ArrayView< input_t > &  wgts 
) const
inline

Returns the coordinate ids, values and optional weights.

Parameters
Idswill on return point to the list of the global Ids for each coordinate on this process.
xyzon return is a list of getCoordinateDim() StridedData objects, each containing the coordinates for one dimension. If the coordinate dimension is three, then the coordinates for Ids[k] are xyz[0][k], xyz[1][k], xyz[2][k].
wgtson return is a list of getNumWeightsPerCoordinate() StridedData objects, each containing the weights for one weight index. For the index , the weight for Ids[k] is wgts[d][k].
Returns
The number of ids in the Ids list.

Memory for this data is allocated either by the user or the Model. The caller gets a view of the data.

Definition at line 173 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
size_t Zoltan2::CoordinateModel< Adapter >::getCoordinatesKokkos ( Kokkos::View< const gno_t *, typename node_t::device_type > &  Ids,
Kokkos::View< scalar_t **, Kokkos::LayoutLeft, typename node_t::device_type > &  xyz,
Kokkos::View< scalar_t **, typename node_t::device_type > &  wgts 
) const
inline

Returns the coordinate ids, values and optional weights.

Parameters
Idswill on return point to the list of the global Ids for each coordinate on this process.
xyzon return is a view of xyz coordinates.
wgtson return is a view of the weights.
Returns
The number of ids in the Ids list

Definition at line 198 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
size_t Zoltan2::CoordinateModel< Adapter >::getLocalNumObjects ( ) const
inlinevirtual

Return the local number of objects.

Return the local number of objects, which may be vertices, matrix rows, identifiers, coordinates, or mesh nodes or elements.

Implements Zoltan2::Model< Adapter >.

Definition at line 231 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>
size_t Zoltan2::CoordinateModel< Adapter >::getGlobalNumObjects ( ) const
inlinevirtual

Return the global number of objects.

Return the global number of objects, which may be vertices, matrix rows, identifiers, coordinates, or mesh nodes or elements.

Implements Zoltan2::Model< Adapter >.

Definition at line 236 of file Zoltan2_CoordinateModel.hpp.


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