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

An RCA Machine class on Torus Networks. More...

#include <Zoltan2_MachineTorusRCA.hpp>

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

Public Member Functions

 MachineTorusRCA (const Teuchos::Comm< int > &comm)
 Constructor: A BlueGeneQ network machine description;.
 
virtual bool getMachineExtentWrapArounds (bool *wrap_around) const
 
 MachineTorusRCA (const Teuchos::Comm< int > &comm, const Teuchos::ParameterList &pl_)
 
virtual ~MachineTorusRCA ()
 
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
 
- 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::MachineTorusRCA< pcoord_t, part_t >

An RCA Machine class on Torus Networks.

Definition at line 21 of file Zoltan2_MachineTorusRCA.hpp.

Constructor & Destructor Documentation

◆ MachineTorusRCA() [1/2]

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

Constructor: A BlueGeneQ network machine description;.

Parameters
commCommunication object.

Definition at line 28 of file Zoltan2_MachineTorusRCA.hpp.

◆ MachineTorusRCA() [2/2]

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

Definition at line 73 of file Zoltan2_MachineTorusRCA.hpp.

◆ ~MachineTorusRCA()

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

Definition at line 267 of file Zoltan2_MachineTorusRCA.hpp.

Member Function Documentation

◆ getMachineExtentWrapArounds()

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

Definition at line 61 of file Zoltan2_MachineTorusRCA.hpp.

◆ hasMachineCoordinates()

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

Definition at line 283 of file Zoltan2_MachineTorusRCA.hpp.

◆ getMachineDim()

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

Definition at line 285 of file Zoltan2_MachineTorusRCA.hpp.

◆ getRealMachineDim()

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

Definition at line 286 of file Zoltan2_MachineTorusRCA.hpp.

◆ getMachineExtent()

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

Definition at line 288 of file Zoltan2_MachineTorusRCA.hpp.

◆ getRealMachineExtent()

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

Definition at line 301 of file Zoltan2_MachineTorusRCA.hpp.

◆ printAllocation()

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

Definition at line 316 of file Zoltan2_MachineTorusRCA.hpp.

◆ getMyMachineCoordinate()

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

Definition at line 331 of file Zoltan2_MachineTorusRCA.hpp.

◆ getMyActualMachineCoordinate()

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

Definition at line 338 of file Zoltan2_MachineTorusRCA.hpp.

◆ getMachineCoordinate() [1/2]

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

Definition at line 358 of file Zoltan2_MachineTorusRCA.hpp.

◆ getMachineCoordinate() [2/2]

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

Definition at line 367 of file Zoltan2_MachineTorusRCA.hpp.

◆ getAllMachineCoordinatesView()

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

Definition at line 371 of file Zoltan2_MachineTorusRCA.hpp.

◆ getHopCount()

template<typename pcoord_t , typename part_t >
virtual bool Zoltan2::MachineTorusRCA< 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 376 of file Zoltan2_MachineTorusRCA.hpp.


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