MachineClass Base class for representing machine coordinates, networks, etc. More...

#include <Zoltan2_Machine.hpp>

Inheritance diagram for Zoltan2::Machine< pcoord_t, part_t >:

[legend]

Public Member Functions
	Machine (const Teuchos::Comm< int > &comm)
	Constructor MachineRepresentation Class. More...

virtual	~Machine ()

bool	hasMachineCoordinates () const
	indicates whether or not the machine has coordinates More...

int	getMachineDim () const
	returns the dimension (number of coords per node) in the machine More...

bool	getMachineExtent (int *nxyz) const
	sets the number of unique coordinates in each machine dimension return true if coordinates are available More...

bool	getMachineExtentWrapArounds (bool *wrap_around) const
	if the machine has a wrap-around tourus link in each dimension. return true if the information is available More...

bool	getMyMachineCoordinate (pcoord_t *xyz) const
	getMyCoordinate function set the machine coordinate xyz of the current process return true if current process' coordinates are available More...

bool	getMachineCoordinate (const int rank, pcoord_t *xyz) const
	getCoordinate function set the machine coordinate xyz of any rank process return true if coordinates are available by rank More...

bool	getMachineCoordinate (const char nodename, pcoord_t xyz) const
	getCoordinate function set the machine coordinate xyz of any node by nodename return true if coordinates are available by nodename More...

bool	getAllMachineCoordinatesView (pcoord_t **allCoords) const
	getProcDim function set the coordinates of all ranks allCoords[i][j], i=0,...,getMachineDim(), j=0,...,getNumRanks(), is the i-th dimensional coordinate for rank j. return true if coordinates are available for all ranks More...

int	getNumRanks () const
	return the number of ranks. More...

virtual bool	getHopCount (int rank1, int rank2, pcoord_t &hops)

Protected Attributes
int	numRanks

int	myRank

Detailed Description

template<typename pcoord_t, typename part_t>
class Zoltan2::Machine< pcoord_t, part_t >

MachineClass Base class for representing machine coordinates, networks, etc.

Definition at line 12 of file Zoltan2_Machine.hpp.

Constructor & Destructor Documentation

◆ Machine()

template<typename pcoord_t , typename part_t >

Zoltan2::Machine< pcoord_t, part_t >::Machine ( const Teuchos::Comm< int > & comm )

inline

Constructor MachineRepresentation Class.

Parameters

comm_ Communication object.

Definition at line 23 of file Zoltan2_Machine.hpp.

◆ ~Machine()

template<typename pcoord_t , typename part_t >

virtual Zoltan2::Machine< pcoord_t, part_t >::~Machine ( )

inlinevirtual

Definition at line 27 of file Zoltan2_Machine.hpp.

Member Function Documentation

◆ hasMachineCoordinates()

template<typename pcoord_t , typename part_t >

bool Zoltan2::Machine< pcoord_t, part_t >::hasMachineCoordinates ( ) const

inline

indicates whether or not the machine has coordinates

Definition at line 31 of file Zoltan2_Machine.hpp.

◆ getMachineDim()

template<typename pcoord_t , typename part_t >

int Zoltan2::Machine< pcoord_t, part_t >::getMachineDim ( ) const

inline

returns the dimension (number of coords per node) in the machine

Definition at line 37 of file Zoltan2_Machine.hpp.

◆ getMachineExtent()

template<typename pcoord_t , typename part_t >

bool Zoltan2::Machine< pcoord_t, part_t >::getMachineExtent ( int * nxyz ) const

inline

sets the number of unique coordinates in each machine dimension return true if coordinates are available

Definition at line 44 of file Zoltan2_Machine.hpp.

◆ getMachineExtentWrapArounds()

template<typename pcoord_t , typename part_t >

bool Zoltan2::Machine< pcoord_t, part_t >::getMachineExtentWrapArounds ( bool * wrap_around ) const

inline

if the machine has a wrap-around tourus link in each dimension. return true if the information is available

Definition at line 51 of file Zoltan2_Machine.hpp.

◆ getMyMachineCoordinate()

template<typename pcoord_t , typename part_t >

bool Zoltan2::Machine< pcoord_t, part_t >::getMyMachineCoordinate ( pcoord_t * xyz ) const

inline

getMyCoordinate function set the machine coordinate xyz of the current process return true if current process' coordinates are available

Definition at line 59 of file Zoltan2_Machine.hpp.

◆ getMachineCoordinate() [1/2]

template<typename pcoord_t , typename part_t >

bool Zoltan2::Machine< pcoord_t, part_t >::getMachineCoordinate	(	const int	rank,
		pcoord_t *	xyz
	)		const

inline

getCoordinate function set the machine coordinate xyz of any rank process return true if coordinates are available by rank

Definition at line 67 of file Zoltan2_Machine.hpp.

◆ getMachineCoordinate() [2/2]

template<typename pcoord_t , typename part_t >

bool Zoltan2::Machine< pcoord_t, part_t >::getMachineCoordinate	(	const char *	nodename,
		pcoord_t *	xyz
	)		const

inline

getCoordinate function set the machine coordinate xyz of any node by nodename return true if coordinates are available by nodename

Definition at line 75 of file Zoltan2_Machine.hpp.

◆ getAllMachineCoordinatesView()

template<typename pcoord_t , typename part_t >

bool Zoltan2::Machine< pcoord_t, part_t >::getAllMachineCoordinatesView ( pcoord_t ** allCoords ) const

inline

getProcDim function set the coordinates of all ranks allCoords[i][j], i=0,...,getMachineDim(), j=0,...,getNumRanks(), is the i-th dimensional coordinate for rank j. return true if coordinates are available for all ranks

Definition at line 85 of file Zoltan2_Machine.hpp.

◆ getNumRanks()

template<typename pcoord_t , typename part_t >

int Zoltan2::Machine< pcoord_t, part_t >::getNumRanks ( ) const

inline

return the number of ranks.

Definition at line 91 of file Zoltan2_Machine.hpp.

◆ getHopCount()

template<typename pcoord_t , typename part_t >

virtual bool Zoltan2::Machine< pcoord_t, part_t >::getHopCount	(	int	rank1,
		int	rank2,
		pcoord_t &	hops
	)

inlinevirtual

Reimplemented in Zoltan2::MachineBGQTest< pcoord_t, part_t >, Zoltan2::MachineRCATest< pcoord_t, part_t >, Zoltan2::MachineRCA< pcoord_t, part_t >, and Zoltan2::MachineTopoMgr< pcoord_t, part_t >.

Definition at line 93 of file Zoltan2_Machine.hpp.

Member Data Documentation

◆ numRanks

template<typename pcoord_t , typename part_t >

int Zoltan2::Machine< pcoord_t, part_t >::numRanks

protected

Definition at line 15 of file Zoltan2_Machine.hpp.

◆ myRank

template<typename pcoord_t , typename part_t >

int Zoltan2::Machine< pcoord_t, part_t >::myRank

protected

Definition at line 16 of file Zoltan2_Machine.hpp.

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

Zoltan2_Machine.hpp

Public Member Functions

Protected Attributes

Detailed Description

template<typename pcoord_t, typename part_t> class Zoltan2::Machine< pcoord_t, part_t >

Constructor & Destructor Documentation

◆ Machine()

◆ ~Machine()

Member Function Documentation

◆ hasMachineCoordinates()

◆ getMachineDim()

◆ getMachineExtent()

◆ getMachineExtentWrapArounds()

◆ getMyMachineCoordinate()

◆ getMachineCoordinate() [1/2]

◆ getMachineCoordinate() [2/2]

◆ getAllMachineCoordinatesView()

◆ getNumRanks()

◆ getHopCount()

Member Data Documentation

◆ numRanks

◆ myRank

template<typename pcoord_t, typename part_t>
class Zoltan2::Machine< pcoord_t, part_t >