matrixsolver.h

Go to the documentation of this file.

/* EPANET 3
 *
 * Copyright (c) 2016 Open Water Analytics
 * Licensed under the terms of the MIT License (see the LICENSE file for details).
 *
 */


#ifndef MATRIXSOLVER_H_
#define MATRIXSOLVER_H_

#include <string>
#include <ostream>


class MatrixSolver
{
  public:

    MatrixSolver();
    virtual ~MatrixSolver();
    static  MatrixSolver* factory(const std::string solver, std::ostream& logger);

    virtual int    init(int nRows, int nOffDiags, int offDiagRow[], int offDiagCol[])= 0;
    virtual void   reset() = 0;

    virtual double getDiag(int i)    {return 0.0;}
    virtual double getOffDiag(int i) {return 0.0;}
    virtual double getRhs(int i)     {return 0.0;}

    virtual void   setDiag(int row, double a) = 0;
    virtual void   setRhs(int row, double b) = 0;
    virtual void   addToDiag(int row, double a) = 0;
    virtual void   addToOffDiag(int offDiag, double a) = 0;
    virtual void   addToRhs(int row, double b) = 0;
    virtual int    solve(int nRows, double x[]) = 0;

    virtual void  debug(std::ostream& out) {}
};

#endif