fei_Matrix.hpp

/*--------------------------------------------------------------------*/
/*    Copyright 2005 Sandia Corporation.                              */
/*    Under the terms of Contract DE-AC04-94AL85000, there is a       */
/*    non-exclusive license for use of this work by or on behalf      */
/*    of the U.S. Government.  Export of this program may require     */
/*    a license from the United States Government.                    */
/*--------------------------------------------------------------------*/

#ifndef _fei_Matrix_hpp_
#define _fei_Matrix_hpp_

#include "fei_iosfwd.hpp"
#include "fei_SharedPtr.hpp"
#include "fei_MatrixGraph.hpp"
#include "fei_defs.h"

namespace fei {
  class Matrix {
  public:
    class Factory {
    public:
      virtual ~Factory(){}

      virtual fei::SharedPtr<fei::Matrix>
        createMatrix(fei::SharedPtr<fei::MatrixGraph> matrixGraph) = 0;
    };

    virtual ~Matrix(){}

    virtual const char* typeName() = 0;

    virtual int parameters(const fei::ParameterSet& paramset) = 0;

    virtual fei::SharedPtr<fei::MatrixGraph> getMatrixGraph() const = 0;

    virtual void setMatrixGraph(fei::SharedPtr<fei::MatrixGraph> matrixGraph) = 0;

    virtual int getGlobalNumRows() const = 0;

    virtual int getLocalNumRows() const = 0;

    virtual int getRowLength(int row, int& length) const = 0;

    virtual int putScalar(double scalar) = 0;

    virtual int copyOutRow(int row, int len, double* coefs, int* indices) const = 0;

    virtual int sumIn(int numRows, const int* rows,
                      int numCols, const int* cols,
                      const double* const* values,
                      int format=0) = 0;

    virtual int copyIn(int numRows, const int* rows,
                       int numCols, const int* cols,
                       const double* const* values,
                      int format=0) = 0;

    virtual int sumInFieldData(int fieldID,
                               int idType,
                               int rowID,
                               int colID,
                               const double* const* data,
                               int format=0) = 0;

    virtual int sumInFieldData(int fieldID,
                               int idType,
                               int rowID,
                               int colID,
                               const double* data,
                               int format=0) = 0;

    virtual int sumIn(int blockID, int connectivityID,
                      const double* const* values,
                      int format=0) = 0;

    virtual int globalAssemble() = 0;

    virtual int multiply(fei::Vector* x,
                         fei::Vector* y) = 0;

    virtual void setCommSizes() = 0;

    virtual int gatherFromOverlap(bool accumulate = true) = 0;

    virtual int writeToFile(const char* filename,
                            bool matrixMarketFormat=true) = 0;

    virtual int writeToStream(FEI_OSTREAM& ostrm,
                              bool matrixMarketFormat=true) = 0;

    virtual bool usingBlockEntryStorage() = 0;

    virtual void markState() = 0;

    virtual bool changedSinceMark() = 0;

    virtual double* getBeginPointer() { return NULL; }
    virtual int getOffset(int row, int col) { return -1; }

  };//class Matrix
}//namespace fei

#ifndef _fei_ostream_ops_hpp_
#include <fei_ostream_ops.hpp>
#endif

#endif // _fei_Matrix_hpp_