Zoltan2
Loading...
Searching...
No Matches
Public Member Functions | List of all members
Zoltan2::MachineTorusBGQTest< pcoord_t, part_t > Class Template Reference

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

#include <Zoltan2_MachineTorusTopoMgrForTesting.hpp>

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

Public Member Functions

 MachineTorusBGQTest (const Teuchos::Comm< int > &comm)
 Constructor: A BlueGeneQ network machine description;.
 
 MachineTorusBGQTest (const Teuchos::Comm< int > &comm, const Teuchos::ParameterList &pl_)
 
virtual ~MachineTorusBGQTest ()
 
bool hasMachineCoordinates () const
 
int getMachineDim () const
 
bool getMachineExtentWrapArounds (bool *wrap_around) const
 
bool getMachineExtentWrapArounds (part_t *wrap_around) const
 
bool getMachineExtent (part_t *extent) const
 
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
 
- Public Member Functions inherited from Zoltan2::Machine< pcoord_t, part_t >
 Machine (const Teuchos::Comm< int > &comm)
 Constructor MachineRepresentation Class.
 
virtual ~Machine ()
 
bool hasMachineCoordinates () const
 indicates whether or not the machine has coordinates
 
int getMachineDim () const
 returns the dimension (number of coords per node) in the machine
 
bool getMachineExtent (int *nxyz) const
 sets the number of unique coordinates in each machine dimension return true if coordinates are available
 
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
 
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
 
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
 
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
 
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
 
int getNumRanks () const
 getNumRanks function return the number of ranks.
 
virtual bool getHopCount (int rank1, int rank2, pcoord_t &hops) const
 getHopCount function set hops between rank1 and rank2 return true if coordinates are available
 
virtual part_t getNumUniqueGroups () const
 getNumUniqueGroups function return the number of unique Dragonfly network groups in provided allocation.
 
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)
 

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::MachineTorusBGQTest< pcoord_t, part_t >

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

Definition at line 16 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

Constructor & Destructor Documentation

◆ MachineTorusBGQTest() [1/2]

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

Constructor: A BlueGeneQ network machine description;.

Parameters
commCommunication object.

Definition at line 23 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ MachineTorusBGQTest() [2/2]

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

Definition at line 57 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ ~MachineTorusBGQTest()

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

Definition at line 111 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

Member Function Documentation

◆ hasMachineCoordinates()

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

Definition at line 126 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMachineDim()

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

Definition at line 128 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMachineExtentWrapArounds() [1/2]

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusBGQTest< pcoord_t, part_t >::getMachineExtentWrapArounds ( bool *  wrap_around) const
inline

Definition at line 130 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMachineExtentWrapArounds() [2/2]

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusBGQTest< pcoord_t, part_t >::getMachineExtentWrapArounds ( part_t wrap_around) const
inline

Definition at line 153 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMachineExtent()

template<typename pcoord_t , typename part_t >
bool Zoltan2::MachineTorusBGQTest< pcoord_t, part_t >::getMachineExtent ( part_t extent) const
inline

Definition at line 175 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMyMachineCoordinate()

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

Definition at line 310 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMyActualMachineCoordinate()

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

Definition at line 317 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMachineCoordinate() [1/2]

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

Definition at line 346 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getMachineCoordinate() [2/2]

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

Definition at line 350 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getAllMachineCoordinatesView()

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

Definition at line 354 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.

◆ getHopCount()

template<typename pcoord_t , typename part_t >
virtual bool Zoltan2::MachineTorusBGQTest< 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 359 of file Zoltan2_MachineTorusTopoMgrForTesting.hpp.


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