Zoltan2_Directory is an abstract base class. More...

#include <Zoltan2_Directory.hpp>

Inheritance diagram for Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >:

[legend]

Public Types
enum	Update_Mode { Replace = 0 , Add , Aggregate , AggregateAdd }
	Update_Mode determines how update executes. More...

Public Member Functions
	Zoltan2_Directory (Teuchos::RCP< const Teuchos::Comm< int > > comm_, bool use_lid_, int debug_level_)
	Construct Zoltan2_Directory (abstract class).

virtual	~Zoltan2_Directory ()
	Destructor currently does nothing.

int	update (size_t length, const gid_t gid, const lid_t lid, const user_t user, const int partition, Update_Mode update_mode)
	update is called by user to submit new data.

int	find (size_t length, const gid_t gid, lid_t lid, user_t user, int partition, int *owner, bool throw_if_missing=true)
	Can be Replace, Add, or Aggregate.

int	remove (size_t length, const gid_t *gid)
	if true will throw if a gid is not found. This is used by the unit tests to properly assess if remove has worked.

int	print () const
	gids to remove.

void	stats () const
	stats. New Kokkos mode needs further development.

bool	is_use_lid () const
	returns true if the directory is handling local ids.

void	get_locally_managed_gids (std::vector< gid_t > &local_gids) const

void	remap_user_data_as_unique_gids ()

size_t	node_map_size () const

Protected Types
typedef Kokkos::UnorderedMap< gid_t, Zoltan2_Directory_Node< gid_t, lid_t, user_t >, Kokkos::HostSpace >	node_map_t

Protected Member Functions
int	update_local (gid_t gid, lid_t lid, user_t *user, int partition, int owner)

int	find_local (gid_t gid, lid_t lid, user_t user, int partition, int *owner, bool throw_if_missing=true) const

int	remove_local (gid_t *gid)

void	allocate ()

int	copy (const Zoltan2_Directory< gid_t, lid_t, user_t > &dd)

unsigned int	hash_proc (const gid_t &gid) const

virtual bool	is_Zoltan2_Directory_Vector () const

virtual void	update_local_user (const user_t *pRaw, user_t &dst)

virtual void	user_to_raw (const user_t &src, user_t *pRaw) const

virtual void	raw_to_user (const user_t *pRaw, user_t &dst) const

virtual size_t	size_of_value_type () const

virtual size_t	get_update_msg_size (const user_t &data) const

virtual size_t	get_update_msg_size (const user_t *pRaw) const

virtual size_t	get_local_find_msg_size (gid_t *gid, bool throw_if_missing=true) const

virtual size_t	get_incoming_find_msg_size (Zoltan2_DD_Find_Msg< gid_t, lid_t > *msg) const

Protected Attributes
size_t	find_msg_size

size_t	update_msg_size

size_t	remove_msg_size

node_map_t	node_map

Teuchos::RCP< const Teuchos::Comm< int > >	comm

bool	use_lid

int	debug_level

size_t	max_id_size

Update_Mode	mode

Detailed Description

template<typename gid_t, typename lid_t, typename user_t>
class Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >

Zoltan2_Directory is an abstract base class.

The user will implement Zoltan2_Directory_Simple or Zoltan2_Directory_Vector in the current form and this class provides all the shared methods.

Definition at line 88 of file Zoltan2_Directory.hpp.

Member Typedef Documentation

◆ node_map_t

template<typename gid_t , typename lid_t , typename user_t >

typedef Kokkos::UnorderedMap<gid_t, Zoltan2_Directory_Node<gid_t,lid_t,user_t>, Kokkos::HostSpace> Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::node_map_t

protected

Definition at line 219 of file Zoltan2_Directory.hpp.

Member Enumeration Documentation

◆ Update_Mode

template<typename gid_t , typename lid_t , typename user_t >

enum Zoltan2::Zoltan2_Directory::Update_Mode

Update_Mode determines how update executes.

Enumerator
Replace	The new value replaces the original value.
Add	All values from different procs are summed.
Aggregate	For std::vector user data, aggregates all data so for example [1,2,5] and [3,5] becomes [1,2,3,5].
AggregateAdd	In progress and needs discussion. Currently this mode will use operator== to determine if two items match and then user operator += to aggregate them together, which allows a custom struct user data type to define how aggregation works. Did this for graph metrics work. Note that this mode currently won't worry about sorting the order but that could be handled through operator>.

Definition at line 91 of file Zoltan2_Directory.hpp.

Constructor & Destructor Documentation

◆ Zoltan2_Directory()

template<typename gid_t , typename lid_t , typename user_t >

Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::Zoltan2_Directory	(	Teuchos::RCP< const Teuchos::Comm< int > >	comm_,
		bool	use_lid_,
		int	debug_level_
	)

inline

Construct Zoltan2_Directory (abstract class).

Parameters

comm_	Teuchos comm provided by user.
use_lid_	are local IDs being submitted and read.
debug_level_	debug level controls output

Definition at line 106 of file Zoltan2_Directory.hpp.

◆ ~Zoltan2_Directory()

template<typename gid_t , typename lid_t , typename user_t >

virtual Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::~Zoltan2_Directory ( )

inlinevirtual

Destructor currently does nothing.

Definition at line 117 of file Zoltan2_Directory.hpp.

Member Function Documentation

◆ update()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::update	(	size_t	length,
		const gid_t *	gid,
		const lid_t *	lid,
		const user_t *	user,
		const int *	partition,
		Update_Mode	update_mode
	)

update is called by user to submit new data.

Parameters

lid	gids being updated.
user	lids if used.
partition	user data if used.
update_mode	partition data if used.

Definition at line 126 of file Zoltan2_Directory_Impl.hpp.

◆ find()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::find	(	size_t	length,
		const gid_t *	gid,
		lid_t *	lid,
		user_t *	user,
		int *	partition,
		int *	owner,
		bool	throw_if_missing = `true`
	)

Can be Replace, Add, or Aggregate.

find is called by user to get data back from directory.

Parameters

lid	gids to find.
user	lids to find if being used.
partition	user data to find if being used.
owner	partition data to find if used.
throw_if_missing	owner data to find if used.

Definition at line 531 of file Zoltan2_Directory_Impl.hpp.

◆ remove()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::remove	(	size_t	length,
		const gid_t *	gid
	)

if true will throw if a gid is not found. This is used by the unit tests to properly assess if remove has worked.

remove eliminates these gids from the directory .

Definition at line 913 of file Zoltan2_Directory_Impl.hpp.

◆ print()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::print ( ) const

gids to remove.

print output. New Kokkos mode needs further development.

Definition at line 850 of file Zoltan2_Directory_Impl.hpp.

◆ stats()

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::stats ( ) const

stats. New Kokkos mode needs further development.

Definition at line 894 of file Zoltan2_Directory_Impl.hpp.

◆ is_use_lid()

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::is_use_lid ( ) const

inline

returns true if the directory is handling local ids.

Definition at line 153 of file Zoltan2_Directory.hpp.

◆ get_locally_managed_gids()

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::get_locally_managed_gids ( std::vector< gid_t > & local_gids ) const

inline

Definition at line 155 of file Zoltan2_Directory.hpp.

◆ remap_user_data_as_unique_gids()

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::remap_user_data_as_unique_gids ( )

inline

Definition at line 173 of file Zoltan2_Directory.hpp.

◆ node_map_size()

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::node_map_size ( ) const

inline

Definition at line 195 of file Zoltan2_Directory.hpp.

◆ update_local()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::update_local	(	gid_t *	gid,
		lid_t *	lid,
		user_t *	user,
		int	partition,
		int	owner
	)

protected

Definition at line 381 of file Zoltan2_Directory_Impl.hpp.

◆ find_local()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::find_local	(	gid_t *	gid,
		lid_t *	lid,
		user_t *	user,
		int *	partition,
		int *	owner,
		bool	throw_if_missing = `true`
	)		const

protected

Definition at line 784 of file Zoltan2_Directory_Impl.hpp.

◆ remove_local()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::remove_local ( gid_t * gid )

protected

Definition at line 1014 of file Zoltan2_Directory_Impl.hpp.

◆ allocate()

template<typename gid_t , typename lid_t , typename user_t >

void Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::allocate ( )

protected

Definition at line 44 of file Zoltan2_Directory_Impl.hpp.

◆ copy()

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::copy ( const Zoltan2_Directory< gid_t, lid_t, user_t > & dd )

protected

Definition at line 119 of file Zoltan2_Directory_Impl.hpp.

◆ hash_proc()

template<typename gid_t , typename lid_t , typename user_t >

unsigned int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::hash_proc ( const gid_t & gid ) const

protected

Definition at line 1042 of file Zoltan2_Directory_Impl.hpp.

◆ is_Zoltan2_Directory_Vector()

template<typename gid_t , typename lid_t , typename user_t >

virtual bool Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::is_Zoltan2_Directory_Vector ( ) const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 251 of file Zoltan2_Directory.hpp.

◆ update_local_user()

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::update_local_user	(	const user_t *	pRaw,
		user_t &	dst
	)

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 252 of file Zoltan2_Directory.hpp.

◆ user_to_raw()

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::user_to_raw	(	const user_t &	src,
		user_t *	pRaw
	)		const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 253 of file Zoltan2_Directory.hpp.

◆ raw_to_user()

template<typename gid_t , typename lid_t , typename user_t >

virtual void Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::raw_to_user	(	const user_t *	pRaw,
		user_t &	dst
	)		const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 254 of file Zoltan2_Directory.hpp.

◆ size_of_value_type()

template<typename gid_t , typename lid_t , typename user_t >

virtual size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::size_of_value_type ( ) const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 255 of file Zoltan2_Directory.hpp.

◆ get_update_msg_size() [1/2]

template<typename gid_t , typename lid_t , typename user_t >

virtual size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::get_update_msg_size ( const user_t & data ) const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 256 of file Zoltan2_Directory.hpp.

◆ get_update_msg_size() [2/2]

template<typename gid_t , typename lid_t , typename user_t >

virtual size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::get_update_msg_size ( const user_t * pRaw ) const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 257 of file Zoltan2_Directory.hpp.

◆ get_local_find_msg_size()

template<typename gid_t , typename lid_t , typename user_t >

virtual size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::get_local_find_msg_size	(	gid_t *	gid,
		bool	throw_if_missing = `true`
	)		const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 258 of file Zoltan2_Directory.hpp.

◆ get_incoming_find_msg_size()

template<typename gid_t , typename lid_t , typename user_t >

virtual size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::get_incoming_find_msg_size ( Zoltan2_DD_Find_Msg< gid_t, lid_t > * msg ) const

inlineprotectedvirtual

Reimplemented in Zoltan2::Zoltan2_Directory_Simple< gid_t, lid_t, user_t >, and Zoltan2::Zoltan2_Directory_Vector< gid_t, lid_t, user_t >.

Definition at line 260 of file Zoltan2_Directory.hpp.

Member Data Documentation

◆ find_msg_size

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::find_msg_size

protected

Definition at line 212 of file Zoltan2_Directory.hpp.

◆ update_msg_size

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::update_msg_size

protected

Definition at line 213 of file Zoltan2_Directory.hpp.

◆ remove_msg_size

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::remove_msg_size

protected

Definition at line 214 of file Zoltan2_Directory.hpp.

◆ node_map

template<typename gid_t , typename lid_t , typename user_t >

node_map_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::node_map

protected

Definition at line 220 of file Zoltan2_Directory.hpp.

◆ comm

template<typename gid_t , typename lid_t , typename user_t >

Teuchos::RCP<const Teuchos::Comm<int> > Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::comm

protected

Definition at line 236 of file Zoltan2_Directory.hpp.

◆ use_lid

template<typename gid_t , typename lid_t , typename user_t >

bool Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::use_lid

protected

Definition at line 238 of file Zoltan2_Directory.hpp.

◆ debug_level

template<typename gid_t , typename lid_t , typename user_t >

int Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::debug_level

protected

Definition at line 239 of file Zoltan2_Directory.hpp.

◆ max_id_size

template<typename gid_t , typename lid_t , typename user_t >

size_t Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::max_id_size

protected

Definition at line 241 of file Zoltan2_Directory.hpp.

◆ mode

template<typename gid_t , typename lid_t , typename user_t >

Update_Mode Zoltan2::Zoltan2_Directory< gid_t, lid_t, user_t >::mode

protected

Definition at line 242 of file Zoltan2_Directory.hpp.

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ node_map_t

Member Enumeration Documentation

◆ Update_Mode

Constructor & Destructor Documentation

◆ Zoltan2_Directory()

◆ ~Zoltan2_Directory()

Member Function Documentation

◆ update()

◆ find()

◆ remove()

◆ print()

◆ stats()

◆ is_use_lid()

◆ get_locally_managed_gids()

◆ remap_user_data_as_unique_gids()

◆ node_map_size()

◆ update_local()

◆ find_local()

◆ remove_local()

◆ allocate()

◆ copy()

◆ hash_proc()

◆ is_Zoltan2_Directory_Vector()

◆ update_local_user()

◆ user_to_raw()

◆ raw_to_user()

◆ size_of_value_type()

◆ get_update_msg_size() [1/2]

◆ get_update_msg_size() [2/2]

◆ get_local_find_msg_size()

◆ get_incoming_find_msg_size()

Member Data Documentation

◆ find_msg_size

◆ update_msg_size

◆ remove_msg_size

◆ node_map

◆ comm

◆ use_lid

◆ debug_level

◆ max_id_size

◆ mode