AbstractSystemMatrix.h

Go to the documentation of this file.

/*******************************************************
*
* Copyright (c) 2003-2010 by University of Queensland
* Earth Systems Science Computational Center (ESSCC)
* http://www.uq.edu.au/esscc
*
* Primary Business: Queensland, Australia
* Licensed under the Open Software License version 3.0
* http://www.opensource.org/licenses/osl-3.0.php
*
*******************************************************/


#if !defined  escript_AbstractSystemMatrix_20040628_H
#define escript_AbstractSystemMatrix_20040628_H
#include "system_dep.h"

#include "FunctionSpace.h"
#include "SystemMatrixException.h"
#include <boost/python/object.hpp>


namespace escript {

//
// Forward declaration
class Data;

class AbstractSystemMatrix {

 public:

  ESCRIPT_DLL_API
  AbstractSystemMatrix();

  ESCRIPT_DLL_API
  AbstractSystemMatrix(const int row_blocksize,
                       const FunctionSpace& row_functionspace,
                       const int column_blocksize,
                       const FunctionSpace& column_functionspace);
  ESCRIPT_DLL_API
  virtual ~AbstractSystemMatrix();


  ESCRIPT_DLL_API
  Data vectorMultiply(Data& right) const;

  ESCRIPT_DLL_API
  int isEmpty() const;

  ESCRIPT_DLL_API
  inline FunctionSpace getColumnFunctionSpace() const
  {
       if (isEmpty())
            throw SystemMatrixException("Error - Matrix is empty.");
       return m_column_functionspace;
  }

  ESCRIPT_DLL_API
  inline FunctionSpace getRowFunctionSpace() const
  {
       if (isEmpty())
            throw SystemMatrixException("Error - Matrix is empty.");
       return m_row_functionspace;
  }

  ESCRIPT_DLL_API
  inline int getRowBlockSize() const
  {
       if (isEmpty())
            throw SystemMatrixException("Error - Matrix is empty.");
       return m_row_blocksize;
  }

  ESCRIPT_DLL_API
  inline int getColumnBlockSize() const
  {
       if (isEmpty())
            throw SystemMatrixException("Error - Matrix is empty.");
       return m_column_blocksize;
  }

  ESCRIPT_DLL_API
  Data solve(Data& in, boost::python::object& options) const;
  
  ESCRIPT_DLL_API
  virtual void nullifyRowsAndCols(escript::Data& row_q, escript::Data& col_q, const double mdv) const;  
  

  ESCRIPT_DLL_API
  virtual void saveMM(const std::string& fileName) const;

  ESCRIPT_DLL_API
  virtual void saveHB(const std::string& fileName) const;

  ESCRIPT_DLL_API
  virtual void resetValues() const;

 protected:

 private:

  ESCRIPT_DLL_API
  virtual void setToSolution(Data& out,Data& in, boost::python::object& options) const;

  ESCRIPT_DLL_API
  virtual void ypAx(Data& y,Data& x) const;

  int m_empty;
  int m_column_blocksize;
  int m_row_blocksize;
  FunctionSpace m_row_functionspace;
  FunctionSpace m_column_functionspace;


};

ESCRIPT_DLL_API Data operator*(const AbstractSystemMatrix& left,const Data& right) ;

typedef boost::shared_ptr<AbstractSystemMatrix> ASM_ptr;

} // end of namespace
#endif