Line data    Source code

       1             : // The libMesh Finite Element Library.
       2             : // Copyright (C) 2002-2025 Benjamin S. Kirk, John W. Peterson, Roy H. Stogner
       3             : 
       4             : // This library is free software; you can redistribute it and/or
       5             : // modify it under the terms of the GNU Lesser General Public
       6             : // License as published by the Free Software Foundation; either
       7             : // version 2.1 of the License, or (at your option) any later version.
       8             : 
       9             : // This library is distributed in the hope that it will be useful,
      10             : // but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             : // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
      12             : // Lesser General Public License for more details.
      13             : 
      14             : // You should have received a copy of the GNU Lesser General Public
      15             : // License along with this library; if not, write to the Free Software
      16             : // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
      17             : 
      18             : 
      19             : 
      20             : #ifndef LIBMESH_SPARSE_SHELL_MATRIX_H
      21             : #define LIBMESH_SPARSE_SHELL_MATRIX_H
      22             : 
      23             : 
      24             : // Local includes
      25             : #include "libmesh/libmesh_common.h"
      26             : #include "libmesh/reference_counted_object.h"
      27             : #include "libmesh/libmesh.h"
      28             : #include "libmesh/shell_matrix.h"
      29             : #include "libmesh/sparse_matrix.h"
      30             : 
      31             : namespace libMesh
      32             : {
      33             : 
      34             : /**
      35             :  * This class allows to use any SparseMatrix object as a shell matrix.
      36             :  * All overridden virtual functions are documented in
      37             :  * shell_matrix.h.
      38             :  *
      39             :  * \author Tim Kroeger
      40             :  * \date 2008
      41             :  */
      42             : template <typename T>
      43             : class SparseShellMatrix : public ShellMatrix<T>
      44             : {
      45             : public:
      46             :   /**
      47             :    * Constructor; takes references to the sparse matrix.  The sparse
      48             :    * matrix itself has to be stored elsewhere.
      49             :    */
      50             :   explicit
      51             :   SparseShellMatrix (const SparseMatrix<T> & new_m);
      52             : 
      53             :   /**
      54             :    * Destructor.
      55             :    */
      56             :   virtual ~SparseShellMatrix ();
      57             : 
      58             :   virtual numeric_index_type m () const override;
      59             : 
      60             :   virtual numeric_index_type n () const override;
      61             : 
      62             :   virtual void vector_mult (NumericVector<T> & dest,
      63             :                             const NumericVector<T> & arg) const override;
      64             : 
      65             :   virtual void vector_mult_add (NumericVector<T> & dest,
      66             :                                 const NumericVector<T> & arg) const override;
      67             : 
      68             :   virtual void get_diagonal (NumericVector<T> & dest) const override;
      69             : 
      70             : protected:
      71             :   /**
      72             :    * The sparse matrix.
      73             :    */
      74             :   const SparseMatrix<T> & _m;
      75             : };
      76             : 
      77             : 
      78             : 
      79             : //-----------------------------------------------------------------------
      80             : // SparseShellMatrix inline members
      81             : template <typename T>
      82             : inline
      83           0 : SparseShellMatrix<T>::SparseShellMatrix (const SparseMatrix<T> & new_m):
      84             :   ShellMatrix<T>(new_m.comm()),
      85           0 :   _m(new_m)
      86           0 : {}
      87             : 
      88             : 
      89             : 
      90             : template <typename T>
      91             : inline
      92           0 : SparseShellMatrix<T>::~SparseShellMatrix ()
      93           0 : {}
      94             : 
      95             : 
      96             : 
      97             : template <typename T>
      98             : inline
      99           0 : numeric_index_type SparseShellMatrix<T>::m () const
     100             : {
     101           0 :   return _m.m();
     102             : }
     103             : 
     104             : 
     105             : 
     106             : template <typename T>
     107             : inline
     108           0 : numeric_index_type SparseShellMatrix<T>::n () const
     109             : {
     110           0 :   return _m.n();
     111             : }
     112             : 
     113             : 
     114             : 
     115             : template <typename T>
     116             : inline
     117           0 : void SparseShellMatrix<T>::get_diagonal(NumericVector<T> & dest) const
     118             : {
     119           0 :   _m.get_diagonal(dest);
     120           0 : }
     121             : 
     122             : 
     123             : } // namespace libMesh
     124             : 
     125             : 
     126             : #endif // LIBMESH_SPARSE_SHELL_MATRIX_H