Zoltan2
Public Types | Public Member Functions | List of all members
Zoltan2::MachineRepresentation< pcoord_t, part_t > Class Template Reference

MachineRepresentation Class Base class for representing machine coordinates, networks, etc. More...

#include <Zoltan2_MachineRepresentation.hpp>

Public Types

typedef MachineForTesting< pcoord_t, part_t > machine_t
 

Public Member Functions

 MachineRepresentation (const Teuchos::Comm< int > &comm)
 Constructor MachineRepresentation Class. More...
 
 MachineRepresentation (const Teuchos::Comm< int > &comm, const Teuchos::ParameterList &pl)
 
 ~MachineRepresentation ()
 
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...
 
bool getHopCount (int rank1, int rank2, pcoord_t &hops) const
 

Detailed Description

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

MachineRepresentation Class Base class for representing machine coordinates, networks, etc.

Definition at line 17 of file Zoltan2_MachineRepresentation.hpp.

Member Typedef Documentation

◆ machine_t

template<typename pcoord_t, typename part_t>
typedef MachineForTesting<pcoord_t,part_t> Zoltan2::MachineRepresentation< pcoord_t, part_t >::machine_t

Definition at line 30 of file Zoltan2_MachineRepresentation.hpp.

Constructor & Destructor Documentation

◆ MachineRepresentation() [1/2]

template<typename pcoord_t, typename part_t>
Zoltan2::MachineRepresentation< pcoord_t, part_t >::MachineRepresentation ( const Teuchos::Comm< int > &  comm)
inline

Constructor MachineRepresentation Class.

Parameters
comm_Communication object.

Definition at line 37 of file Zoltan2_MachineRepresentation.hpp.

◆ MachineRepresentation() [2/2]

template<typename pcoord_t, typename part_t>
Zoltan2::MachineRepresentation< pcoord_t, part_t >::MachineRepresentation ( const Teuchos::Comm< int > &  comm,
const Teuchos::ParameterList &  pl 
)
inline

Definition at line 40 of file Zoltan2_MachineRepresentation.hpp.

◆ ~MachineRepresentation()

template<typename pcoord_t, typename part_t>
Zoltan2::MachineRepresentation< pcoord_t, part_t >::~MachineRepresentation ( )
inline

Definition at line 43 of file Zoltan2_MachineRepresentation.hpp.

Member Function Documentation

◆ hasMachineCoordinates()

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< pcoord_t, part_t >::hasMachineCoordinates ( ) const
inline

indicates whether or not the machine has coordinates

Definition at line 50 of file Zoltan2_MachineRepresentation.hpp.

◆ getMachineDim()

template<typename pcoord_t, typename part_t>
int Zoltan2::MachineRepresentation< pcoord_t, part_t >::getMachineDim ( ) const
inline

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

Definition at line 56 of file Zoltan2_MachineRepresentation.hpp.

◆ getMachineExtent()

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< 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 61 of file Zoltan2_MachineRepresentation.hpp.

◆ getMachineExtentWrapArounds()

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< 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 68 of file Zoltan2_MachineRepresentation.hpp.

◆ getMyMachineCoordinate()

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< 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 77 of file Zoltan2_MachineRepresentation.hpp.

◆ getMachineCoordinate() [1/2]

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< 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 85 of file Zoltan2_MachineRepresentation.hpp.

◆ getMachineCoordinate() [2/2]

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< 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 94 of file Zoltan2_MachineRepresentation.hpp.

◆ getAllMachineCoordinatesView()

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< 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 105 of file Zoltan2_MachineRepresentation.hpp.

◆ getNumRanks()

template<typename pcoord_t, typename part_t>
int Zoltan2::MachineRepresentation< pcoord_t, part_t >::getNumRanks ( ) const
inline

return the number of ranks.

Definition at line 111 of file Zoltan2_MachineRepresentation.hpp.

◆ getHopCount()

template<typename pcoord_t, typename part_t>
bool Zoltan2::MachineRepresentation< pcoord_t, part_t >::getHopCount ( int  rank1,
int  rank2,
pcoord_t &  hops 
) const
inline

Definition at line 114 of file Zoltan2_MachineRepresentation.hpp.


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