crmatrix_mpi.h

// -*-C++-*-
// ==========================================================================
// Module mathlib
// File crmatrix_mpi.h
// Declaration of template class TCompRowMatrixMPI
// Distributed (MPI) version of TCompRowMatrix (template sparse matrix in
// compressed row format)
// Each MPI process operates on a block of matrix rows (r0 <= r < r1)
// ==========================================================================

#ifndef __CRMATRIXMPI_H
#define __CRMATRIXMPI_H

#include "mathlib.h"

// ==========================================================================
// class TCompRowMatrixMPI
// ==========================================================================
template<class MT> class TCompRowMatrixMPI: public TGenericSparseMatrix<MT> {

public:
    TCompRowMatrixMPI ();

    TCompRowMatrixMPI (int rows, int cols);

    TCompRowMatrixMPI (int rows, int cols,
    const int *_rowptr, const int *_colidx,
    int proc_nrows, const int *proc_rows);

    TCompRowMatrixMPI (int rows, int cols,
        const int *_rowptr, const int *_colidx,
        const MT *_data = 0);

    ~TCompRowMatrixMPI ();

    MatrixStorage StorageType() const
    { return MATRIX_COMPROW; }

    void Initialise (const int *_rowptr, const int *_colidx,
        const MT *_data = 0);

    void MPIRange (int *_r0, int *_r1) const
    { *_r0 = r0; *_r1 = r1; }

    void Zero ();

    MT Get (int r, int c) const;

    TVector<MT> Row (int r) const;

    int SparseRow (int r, int *colidx, MT *val) const;

    TVector<MT> Col (int c) const;

    virtual void RowScale (const TVector<MT> &scale);
    // scales the rows with 'scale'

    virtual void ColScale (const TVector<MT> &scale);
    // scales the columns with 'scale'

    virtual void Unlink ();
    // removes the matrix' link to its data block and deletes the data
    // block, if necessary

    bool Exists (int r, int c) const;

    MT &operator() (int r, int c);

    int Get_index (int r, int c) const;

    MT GetNext (int &r, int &c) const;

    void Ax (const TVector<MT> &x, TVector<MT> &b) const;

    void Ax (const TVector<MT> &x, TVector<MT> &b, int i1, int i2) const;

    void ATx (const TVector<MT> &x, TVector<MT> &b) const
    { xERROR("Not implemented"); }

    // ======================================================================
    // Process-specific functions
    // These methods are invoked only for the current process

    void Add_proc (int r, int c, MT val);
  
  //private:
public:
    void MPIinit();

    int rnk;    
    int sze;    

    int *rowptr;

    int *colidx;

    int r0;     
    int r1;     
    int my_nr;  
    int *my_r;  

    int *mpi_r0; 
    int *mpi_nr; 

    MPI_Datatype mpitp; 
};


// ==========================================================================
// typedefs for specific instances of `TCompRowMatrixMPI'

typedef TCompRowMatrixMPI<double>   RCompRowMatrixMPI;
typedef TCompRowMatrixMPI<float>    FCompRowMatrixMPI;
typedef TCompRowMatrixMPI<toast::complex> CCompRowMatrixMPI;
typedef TCompRowMatrixMPI<scomplex> SCCompRowMatrixMPI;
typedef TCompRowMatrixMPI<int>      ICompRowMatrixMPI;

// ==========================================================================
// extern declarations of TCompRowMatrix (only required for VS)

#ifndef MATHLIB_IMPLEMENTATION
extern template class MATHLIB TCompRowMatrixMPI<double>;
extern template class MATHLIB TCompRowMatrixMPI<float>;
extern template class MATHLIB TCompRowMatrixMPI<toast::complex>;
extern template class MATHLIB TCompRowMatrixMPI<scomplex>;
extern template class MATHLIB TCompRowMatrixMPI<int>;
#endif // MATHLIB_IMPLEMENTATION

#endif // !__CRMATRIXMPI_H