Zoltan2_Machine.hpp

Go to the documentation of this file.

// @HEADER
// *****************************************************************************
//   Zoltan2: A package of combinatorial algorithms for scientific computing
//
// Copyright 2012 NTESS and the Zoltan2 contributors.
// SPDX-License-Identifier: BSD-3-Clause
// *****************************************************************************
// @HEADER
 
#ifndef _ZOLTAN2_MACHINE_HPP_
#define _ZOLTAN2_MACHINE_HPP_
 
#include <Teuchos_Comm.hpp>
#include <Zoltan2_config.h>
namespace Zoltan2{

template <typename pcoord_t, typename part_t>
class Machine{
 
protected:
    int numRanks;
    int myRank;
 
public:
 
    Machine(const Teuchos::Comm<int> &comm) :
      numRanks(comm.getSize()), myRank(comm.getRank())
    { }
 
    virtual ~Machine(){ }

    bool hasMachineCoordinates() const {
      return false;  // Coordinates not available in this machine
    }

    int getMachineDim() const {
      return 0;  // Coordinates not available in this machine
    }

    bool getMachineExtent(int *nxyz) const {
      return false;  // Extent not available in this machine
    }

    bool getMachineExtentWrapArounds(bool *wrap_around) const {
      return false;  // Extent not available in this machine
    }

    bool getMyMachineCoordinate(pcoord_t *xyz) const { 
      return false;  // Coordinates not available in this machine
    }

    bool getMachineCoordinate(const int rank, pcoord_t *xyz) const {
      return false;  // Coordinates not available by rank
    }

    bool getMachineCoordinate(const char *nodename, pcoord_t *xyz) const {
      return false;  // Coordinates not available by nodename
    }

    bool getAllMachineCoordinatesView(pcoord_t **allCoords) const { 
      return false;  // Coordinates not available in this machine
    }

    int getNumRanks() const { return numRanks; }

    virtual bool getHopCount(int rank1, int rank2, pcoord_t &hops) const {
      return false;
    }

    virtual part_t getNumUniqueGroups() const {
      return 1;
    }

    virtual bool getGroupCount(part_t *grp_count) const {
      return false;
    }
 
    // KDD TODO: Add Graph interface and methods supporting full LDMS interface.
 
};
}
#endif