sparse_shell_matrix.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2018 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner

// This library 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; either
// version 2.1 of the License, or (at your option) any later version.

// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.

// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA



#ifndef LIBMESH_SPARSE_SHELL_MATRIX_H
#define LIBMESH_SPARSE_SHELL_MATRIX_H


// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh.h"
#include "libmesh/shell_matrix.h"
#include "libmesh/sparse_matrix.h"

namespace libMesh
{

template <typename T>
class SparseShellMatrix : public ShellMatrix<T>
{
public:
  explicit
  SparseShellMatrix (const SparseMatrix<T> & new_m);

  virtual ~SparseShellMatrix ();

  virtual numeric_index_type m () const override;

  virtual numeric_index_type n () const override;

  virtual void vector_mult (NumericVector<T> & dest,
                            const NumericVector<T> & arg) const override;

  virtual void vector_mult_add (NumericVector<T> & dest,
                                const NumericVector<T> & arg) const override;

  virtual void get_diagonal (NumericVector<T> & dest) const override;

protected:
  const SparseMatrix<T> & _m;
};



//-----------------------------------------------------------------------
// SparseShellMatrix inline members
template <typename T>
inline
SparseShellMatrix<T>::SparseShellMatrix (const SparseMatrix<T> & new_m):
  ShellMatrix<T>(new_m.comm()),
  _m(new_m)
{}



template <typename T>
inline
SparseShellMatrix<T>::~SparseShellMatrix ()
{}



template <typename T>
inline
numeric_index_type SparseShellMatrix<T>::m () const
{
  return _m.m();
}



template <typename T>
inline
numeric_index_type SparseShellMatrix<T>::n () const
{
  return _m.n();
}



template <typename T>
inline
void SparseShellMatrix<T>::get_diagonal(NumericVector<T> & dest) const
{
  _m.get_diagonal(dest);
}


} // namespace libMesh


#endif // LIBMESH_SPARSE_SHELL_MATRIX_H