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

A Default MachineRepresentation Class for testing only A more correct machine representation should be used for task mapping. More...

#include <Zoltan2_MachineLDMS.hpp>

Inheritance diagram for Zoltan2::DefaultMachine< nNo_t, nCoord_t >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::DefaultMachine< nNo_t, nCoord_t >:
Collaboration graph
[legend]

Public Member Functions

 MachineRepresentation (const Comm< int > &comm)
 Constructor MachineRepresentation Class. More...
 
 MachineRepresentation (const RCP< Comm< int > > &comm_)
 Constructor MachineRepresentation Class. More...
 
void getMyCoordinate ()
 getMyCoordinate function stores the coordinate of the current processor in procCoords[*][rank] More...
 
void gatherMachineCoordinates ()
 gatherMachineCoordinates function reduces and stores all machine coordinates. More...
 
virtual ~MachineRepresentation ()
 destructor of the class free memory in procCoords. More...
 
int getProcDim () const
 getProcDim function returns the dimension of the physical processor layout. More...
 
nCoord_t ** getProcCoords () const
 getProcDim function returns the coordinates of processors in two dimensional array. More...
 
int getNumProcs () const
 getNumProcs function returns the number of processors. More...
 
- Public Member Functions inherited from Zoltan2::MachineRepresentation< nNo_t, nCoord_t >
 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 (nNo_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, nNo_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, nNo_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 (nNo_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, nNo_t &hops) const
 

Additional Inherited Members

- Public Types inherited from Zoltan2::MachineRepresentation< nNo_t, nCoord_t >
typedef nNo_t machine_pcoord_t
 
typedef nCoord_t machine_part_t
 
typedef MachineForTesting
< nNo_t, nCoord_t > 
machine_t
 
- Static Public Member Functions inherited from Zoltan2::MachineRepresentation< nNo_t, nCoord_t >
static void getValidParameters (Teuchos::ParameterList &pl)
 Set up validators specific to this Problem. More...
 

Detailed Description

template<typename nNo_t, typename nCoord_t>
class Zoltan2::DefaultMachine< nNo_t, nCoord_t >

A Default MachineRepresentation Class for testing only A more correct machine representation should be used for task mapping.

Definition at line 14 of file Zoltan2_MachineLDMS.hpp.

Constructor & Destructor Documentation

template<typename nNo_t , typename nCoord_t >
virtual Zoltan2::DefaultMachine< nNo_t, nCoord_t >::~MachineRepresentation ( )
inlinevirtual

destructor of the class free memory in procCoords.

Definition at line 165 of file Zoltan2_MachineLDMS.hpp.

Member Function Documentation

template<typename nNo_t , typename nCoord_t >
Zoltan2::DefaultMachine< nNo_t, nCoord_t >::MachineRepresentation ( const Comm< int > &  comm)
inline

Constructor MachineRepresentation Class.

Parameters
comm_Communication object.

Definition at line 28 of file Zoltan2_MachineLDMS.hpp.

template<typename nNo_t , typename nCoord_t >
Zoltan2::DefaultMachine< nNo_t, nCoord_t >::MachineRepresentation ( const RCP< Comm< int > > &  comm_)
inline

Constructor MachineRepresentation Class.

Parameters
comm_Communication object.

Definition at line 71 of file Zoltan2_MachineLDMS.hpp.

template<typename nNo_t , typename nCoord_t >
void Zoltan2::DefaultMachine< nNo_t, nCoord_t >::getMyCoordinate ( )
inline

getMyCoordinate function stores the coordinate of the current processor in procCoords[*][rank]

Definition at line 112 of file Zoltan2_MachineLDMS.hpp.

template<typename nNo_t , typename nCoord_t >
void Zoltan2::DefaultMachine< nNo_t, nCoord_t >::gatherMachineCoordinates ( )
inline

gatherMachineCoordinates function reduces and stores all machine coordinates.

Definition at line 145 of file Zoltan2_MachineLDMS.hpp.

template<typename nNo_t , typename nCoord_t >
int Zoltan2::DefaultMachine< nNo_t, nCoord_t >::getProcDim ( ) const
inline

getProcDim function returns the dimension of the physical processor layout.

Definition at line 177 of file Zoltan2_MachineLDMS.hpp.

template<typename nNo_t , typename nCoord_t >
nCoord_t** Zoltan2::DefaultMachine< nNo_t, nCoord_t >::getProcCoords ( ) const
inline

getProcDim function returns the coordinates of processors in two dimensional array.

Definition at line 184 of file Zoltan2_MachineLDMS.hpp.

template<typename nNo_t , typename nCoord_t >
int Zoltan2::DefaultMachine< nNo_t, nCoord_t >::getNumProcs ( ) const
inline

getNumProcs function returns the number of processors.

Definition at line 191 of file Zoltan2_MachineLDMS.hpp.


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