matrix.hpp

Go to the documentation of this file.

// Copyright (c) 2010, Lawrence Livermore National Security, LLC. Produced at
// the Lawrence Livermore National Laboratory. LLNL-CODE-443211. All Rights
// reserved. See file COPYRIGHT for details.
//
// This file is part of the MFEM library. For more information and source code
// availability see http://mfem.org.
//
// MFEM is free software; you can redistribute it and/or modify it under the
// terms of the GNU Lesser General Public License (as published by the Free
// Software Foundation) version 2.1 dated February 1999.

#ifndef MFEM_MATRIX
#define MFEM_MATRIX

#include "../general/array.hpp"
#include "operator.hpp"
#include <iostream>

namespace mfem
{

// Abstract data types matrix, inverse matrix

class MatrixInverse;

class Matrix : public Operator
{
   friend class MatrixInverse;
public:
   explicit Matrix(int s) : Operator(s) { }

   explicit Matrix(int h, int w) : Operator(h, w) { }

   virtual double &Elem(int i, int j) = 0;

   virtual const double &Elem(int i, int j) const = 0;

   virtual MatrixInverse *Inverse() const = 0;

   virtual void Finalize(int) { }

   virtual void Print (std::ostream & out = std::cout, int width_ = 4) const;

   virtual ~Matrix() { }
};


class MatrixInverse : public Solver
{
public:
   MatrixInverse() { }

   MatrixInverse(const Matrix &mat)
      : Solver(mat.height, mat.width) { }
};

class AbstractSparseMatrix : public Matrix
{
public:
   explicit AbstractSparseMatrix(int s = 0) : Matrix(s) { }

   explicit AbstractSparseMatrix(int h, int w) : Matrix(h, w) { }

   virtual int NumNonZeroElems() const = 0;

   virtual int GetRow(const int row, Array<int> &cols, Vector &srow) const = 0;

   virtual void EliminateZeroRows() = 0;

   virtual void Mult(const Vector &x, Vector &y) const = 0;
   virtual void AddMult(const Vector &x, Vector &y,
                        const double val = 1.) const = 0;
   virtual void MultTranspose(const Vector &x, Vector &y) const = 0;
   virtual void AddMultTranspose(const Vector &x, Vector &y,
                                 const double val = 1.) const = 0;

   virtual ~AbstractSparseMatrix() { }
};

}

#endif