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

An RCA Machine Class (Torus Networks) for testing only A more realistic machine should be used for task mapping. More...

#include <Zoltan2_MachineTorusRCAForTesting.hpp>

Inheritance diagram for Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >:
Inheritance graph
[legend]
Collaboration diagram for Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >:
Collaboration graph
[legend]

Public Member Functions

 MachineTorusRCAForTesting (const Teuchos::Comm< int > &comm)
 Constructor: A BlueGeneQ network machine description;. More...
 
virtual bool getMachineExtentWrapArounds (bool *wrap_around) const
 
 MachineTorusRCAForTesting (const Teuchos::Comm< int > &comm, const Teuchos::ParameterList &pl_)
 
virtual ~MachineTorusRCAForTesting ()
 
bool hasMachineCoordinates () const
 
int getMachineDim () const
 
int getRealMachineDim () const
 
bool getMachineExtent (int *nxyz) const
 
bool getRealMachineExtent (int *nxyz) const
 
void printAllocation ()
 
bool getMyMachineCoordinate (pcoord_t *xyz)
 
bool getMyActualMachineCoordinate (pcoord_t *xyz)
 
bool getMachineCoordinate (const int rank, pcoord_t *xyz) const
 
bool getMachineCoordinate (const char *nodename, pcoord_t *xyz)
 
bool getAllMachineCoordinatesView (pcoord_t **&allCoords) const
 
virtual bool getHopCount (int rank1, int rank2, pcoord_t &hops) const override
 getHopCount function set hops between rank1 and rank2 return true if coordinates are available More...
 
- Public Member Functions inherited from Zoltan2::Machine< pcoord_t, part_t >
 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
 getNumRanks function return the number of ranks. More...
 
virtual part_t getNumUniqueGroups () const
 getNumUniqueGroups function return the number of unique Dragonfly network groups in provided allocation. More...
 
virtual bool getGroupCount (part_t *grp_count) const
 getGroupCount function return the number of ranks in each group (RCA X-dim, e.g. first dim) More...
 

Additional Inherited Members

- Protected Attributes inherited from Zoltan2::Machine< pcoord_t, part_t >
int numRanks
 
int myRank
 

Detailed Description

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

An RCA Machine Class (Torus Networks) for testing only A more realistic machine should be used for task mapping.

Definition at line 19 of file Zoltan2_MachineTorusRCAForTesting.hpp.

Constructor & Destructor Documentation

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

Constructor: A BlueGeneQ network machine description;.

Parameters
commCommunication object.

Definition at line 26 of file Zoltan2_MachineTorusRCAForTesting.hpp.

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

Definition at line 69 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
virtual Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::~MachineTorusRCAForTesting ( )
inlinevirtual

Definition at line 301 of file Zoltan2_MachineTorusRCAForTesting.hpp.

Member Function Documentation

template<typename pcoord_t , typename part_t >
virtual bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getMachineExtentWrapArounds ( bool *  wrap_around) const
inlinevirtual

Definition at line 56 of file Zoltan2_MachineTorusRCAForTesting.hpp.

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

Definition at line 317 of file Zoltan2_MachineTorusRCAForTesting.hpp.

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

Definition at line 319 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
int Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getRealMachineDim ( ) const
inline

Definition at line 320 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getMachineExtent ( int *  nxyz) const
inline

Definition at line 322 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getRealMachineExtent ( int *  nxyz) const
inline

Definition at line 335 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
void Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::printAllocation ( )
inline

Definition at line 344 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getMyMachineCoordinate ( pcoord_t *  xyz)
inline

Definition at line 359 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getMyActualMachineCoordinate ( pcoord_t *  xyz)
inline

Definition at line 366 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getMachineCoordinate ( const int  rank,
pcoord_t *  xyz 
) const
inline

Definition at line 373 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getMachineCoordinate ( const char *  nodename,
pcoord_t *  xyz 
)
inline

Definition at line 382 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getAllMachineCoordinatesView ( pcoord_t **&  allCoords) const
inline

Definition at line 386 of file Zoltan2_MachineTorusRCAForTesting.hpp.

template<typename pcoord_t , typename part_t >
virtual bool Zoltan2::MachineTorusRCAForTesting< pcoord_t, part_t >::getHopCount ( int  rank1,
int  rank2,
pcoord_t &  hops 
) const
inlineoverridevirtual

getHopCount function set hops between rank1 and rank2 return true if coordinates are available

Reimplemented from Zoltan2::Machine< pcoord_t, part_t >.

Definition at line 391 of file Zoltan2_MachineTorusRCAForTesting.hpp.


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