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

MachineRepresentation Class Finds the coordinate of the processor. Used to find the processor coordinates or graph. More...

#include <Zoltan2_MachineRepresentation.hpp>

Public Member Functions

 MachineRepresentation (const RCP< 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...
 
 ~MachineRepresentation ()
 destructor of the class free memory in procCoords. More...
 
int getProcDim () const
 getProcDim function returns the dimension of the physical processor layout. More...
 
pcoord_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...
 

Detailed Description

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

MachineRepresentation Class Finds the coordinate of the processor. Used to find the processor coordinates or graph.

Definition at line 13 of file Zoltan2_MachineRepresentation.hpp.

Constructor & Destructor Documentation

template<typename pcoord_t>
Zoltan2::MachineRepresentation< pcoord_t >::MachineRepresentation ( const RCP< const Comm< int > > &  comm_)
inline

Constructor MachineRepresentation Class.

Parameters
comm_Communication object.

Definition at line 26 of file Zoltan2_MachineRepresentation.hpp.

template<typename pcoord_t>
Zoltan2::MachineRepresentation< pcoord_t >::MachineRepresentation ( const RCP< Comm< int > > &  comm_)
inline

Constructor MachineRepresentation Class.

Parameters
comm_Communication object.

Definition at line 67 of file Zoltan2_MachineRepresentation.hpp.

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

destructor of the class free memory in procCoords.

Definition at line 151 of file Zoltan2_MachineRepresentation.hpp.

Member Function Documentation

template<typename pcoord_t>
void Zoltan2::MachineRepresentation< pcoord_t >::getMyCoordinate ( )
inline

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

Definition at line 108 of file Zoltan2_MachineRepresentation.hpp.

template<typename pcoord_t>
void Zoltan2::MachineRepresentation< pcoord_t >::gatherMachineCoordinates ( )
inline

gatherMachineCoordinates function reduces and stores all machine coordinates.

Definition at line 131 of file Zoltan2_MachineRepresentation.hpp.

template<typename pcoord_t>
int Zoltan2::MachineRepresentation< pcoord_t >::getProcDim ( ) const
inline

getProcDim function returns the dimension of the physical processor layout.

Definition at line 163 of file Zoltan2_MachineRepresentation.hpp.

template<typename pcoord_t>
pcoord_t** Zoltan2::MachineRepresentation< pcoord_t >::getProcCoords ( ) const
inline

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

Definition at line 170 of file Zoltan2_MachineRepresentation.hpp.

template<typename pcoord_t>
int Zoltan2::MachineRepresentation< pcoord_t >::getNumProcs ( ) const
inline

getNumProcs function returns the number of processors.

Definition at line 177 of file Zoltan2_MachineRepresentation.hpp.


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