MPIBlock.hpp

/*
 * MPIBlock.hpp
 *
 *  Created on: Dec 7, 2016
 *      Author: Pete Schultz
 */

#ifndef MPIBLOCK_HPP_
#define MPIBLOCK_HPP_

#include "arch/mpi/mpi.h"

namespace PV {

class MPIBlock {
  public:
   MPIBlock(
         MPI_Comm comm,
         int globalNumRows,
         int globalNumColumns,
         int globalBatchDimension,
         int blockNumRows,
         int blockNumColumns,
         int blockBatchDimension);

   int
   calcRankFromRowColBatch(int const rowIndex, int const columnIndex, int const batchIndex) const;

   void
   calcRowColBatchFromRank(int const rank, int &rowIndex, int &columnIndex, int &batchIndex) const;

   int calcRowFromRank(int const rank) const;

   int calcColumnFromRank(int const rank) const;

   int calcBatchIndexFromRank(int const rank) const;

   MPI_Comm getComm() const { return mComm; }

   MPI_Comm getGlobalComm() const { return mGlobalComm; }

   int getRank() const { return mRank; }

   int getGlobalRank() const { return mGlobalRank; }

   int getGlobalNumRows() const { return mGlobalNumRows; }

   int getGlobalNumColumns() const { return mGlobalNumColumns; }

   int getGlobalBatchDimension() const { return mGlobalBatchDimension; }

   int getNumRows() const { return mNumRows; }

   int getNumColumns() const { return mNumColumns; }

   int getBatchDimension() const { return mBatchDimension; }

   int getSize() const { return mNumRows * mNumColumns * mBatchDimension; }

   int getStartRow() const { return mStartRow; }

   int getStartColumn() const { return mStartColumn; }

   int getStartBatch() const { return mStartBatch; }

   int getRowIndex() const { return mRowIndex; }

   int getColumnIndex() const { return mColumnIndex; }

   int getBatchIndex() const { return mBatchIndex; }

  private:
   void initGlobalDimensions(
         MPI_Comm comm,
         int const globalNumRows,
         int const globalNumColumns,
         int const globalBatchDimension);

   void initBlockDimensions(
         int const blockNumRows,
         int const blockNumColumns,
         int const globalBatchDimension);

   void initBlockLocation(MPI_Comm comm);

   void createBlockComm(MPI_Comm comm);

   void checkRankInBounds(int const rank) const;

   int calcRowFromRankInternal(int const rank) const;

   int calcColumnFromRankInternal(int const rank) const;

   int calcBatchIndexFromRankInternal(int const rank) const;

   static int calcNumCells(int cellSize, int overallSize);

   // Data members
  private:
   MPI_Comm mGlobalComm;
   MPI_Comm mComm;
   int mGlobalRank           = 0;
   int mRank                 = 0;
   int mGlobalNumRows        = 0;
   int mGlobalNumColumns     = 0;
   int mGlobalBatchDimension = 0;
   int mNumRows              = 0;
   int mNumColumns           = 0;
   int mBatchDimension       = 0;
   int mStartRow             = 0;
   int mStartColumn          = 0;
   int mStartBatch           = 0;
   int mRowIndex             = 0;
   int mColumnIndex          = 0;
   int mBatchIndex           = 0;

}; // end classe MPIBlock

} // end namespace PV

#endif // MPIBLOCK_HPP_