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

#include <Zoltan2_CoordinateModel.hpp>

Inheritance diagram for Zoltan2::CoordinateModel< Adapter >:

Collaboration diagram for Zoltan2::CoordinateModel< Adapter >:

Public Member Functions
	CoordinateModel (const VectorAdapter< user_t > *ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
	CoordinateModel (const MatrixAdapter< user_t, userCoord_t > *ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
	CoordinateModel (const GraphAdapter< user_t, userCoord_t > *ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
	CoordinateModel (const MeshAdapter< user_t > *ia, const RCP< const Environment > &env, const RCP< const Comm< int > > &comm, modelFlag_t &flags)
	CoordinateModel (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.
size_t	getLocalNumCoordinates () const
	Returns the number of coordinates on this process.
global_size_t	getGlobalNumCoordinates () const
	Returns the global number coordinates.
int	getNumWeightsPerCoordinate () const
	Returns the number (0 or greater) of weights per coordinate.
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.
size_t	getLocalNumObjects () const
	Return the local number of objects.
size_t	getGlobalNumObjects () const
	Return the global number of objects.
RCP< const idmap_t >	getIdentifierMap () const
	Return the map from user global identifiers to internal Zoltan2 global numbers.
Protected Member Functions
void	setIdentifierMap (RCP< const idmap_t > &map)
	Set the IdentifierMap used by the 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 76 of file Zoltan2_CoordinateModel.hpp.

Constructor & Destructor Documentation

template<typename Adapter>

Zoltan2::CoordinateModel< Adapter >::CoordinateModel	(	const VectorAdapter< user_t > *	ia,
		const RCP< const Environment > &	env,
		const RCP< const Comm< int > > &	comm,
		modelFlag_t &	flags
	)		`[inline]`

Definition at line 96 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>

Zoltan2::CoordinateModel< Adapter >::CoordinateModel	(	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 109 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>

Zoltan2::CoordinateModel< Adapter >::CoordinateModel	(	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 129 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>

Zoltan2::CoordinateModel< Adapter >::CoordinateModel	(	const MeshAdapter< user_t > *	ia,
		const RCP< const Environment > &	env,
		const RCP< const Comm< int > > &	comm,
		modelFlag_t &	flags
	)		`[inline]`

Definition at line 149 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>

Zoltan2::CoordinateModel< Adapter >::CoordinateModel	(	const IdentifierAdapter< user_t > *	ia,
		const RCP< const Environment > &	env,
		const RCP< const Comm< int > > &	comm,
		modelFlag_t &	flags
	)		`[inline]`

Definition at line 162 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 177 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 181 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 185 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 189 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:

Ids	will on return point to the list of the global Ids for each coordinate on this process.
xyz	on 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]`.
wgts	on 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 213 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>

size_t Zoltan2::CoordinateModel< Adapter >::getLocalNumObjects ( ) const [inline, virtual]

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 238 of file Zoltan2_CoordinateModel.hpp.

template<typename Adapter>

size_t Zoltan2::CoordinateModel< Adapter >::getGlobalNumObjects ( ) const [inline, virtual]

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

template<typename Adapter>

RCP<const idmap_t > Zoltan2::Model< Adapter >::getIdentifierMap ( ) const [inline, inherited]

Return the map from user global identifiers to internal Zoltan2 global numbers.

Every model must have an IdentifierMap, whether it needs for mapping or not. The Map can simply indicate that Zoltan2 global numbers are identical to the application's global IDs.

Definition at line 139 of file Zoltan2_Model.hpp.

template<typename Adapter>

void Zoltan2::Model< Adapter >::setIdentifierMap ( RCP< const idmap_t > & map ) [inline, protected, inherited]

Set the IdentifierMap used by the model.

The Model should set the identifier map with this call during the constructor.

Definition at line 165 of file Zoltan2_Model.hpp.

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

Zoltan2_CoordinateModel.hpp

Public Member Functions

Protected Member Functions

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

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