libMesh
sparse_shell_matrix.h
Go to the documentation of this file.
1 // The libMesh Finite Element Library.
2 // Copyright (C) 2002-2017 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 
42 template <typename T>
43 class SparseShellMatrix : public ShellMatrix<T>
44 {
45 public:
50  explicit
51  SparseShellMatrix (const SparseMatrix<T> & new_m);
52 
56  virtual ~SparseShellMatrix ();
57 
58  virtual numeric_index_type m () const libmesh_override;
59 
60  virtual numeric_index_type n () const libmesh_override;
61 
62  virtual void vector_mult (NumericVector<T> & dest,
63  const NumericVector<T> & arg) const libmesh_override;
64 
65  virtual void vector_mult_add (NumericVector<T> & dest,
66  const NumericVector<T> & arg) const libmesh_override;
67 
68  virtual void get_diagonal (NumericVector<T> & dest) const libmesh_override;
69 
70 protected:
75 };
76 
77 
78 
79 //-----------------------------------------------------------------------
80 // SparseShellMatrix inline members
81 template <typename T>
82 inline
84  ShellMatrix<T>(new_m.comm()),
85  _m(new_m)
86 {}
87 
88 
89 
90 template <typename T>
91 inline
93 {}
94 
95 
96 
97 template <typename T>
98 inline
100 {
101  return _m.m();
102 }
103 
104 
105 
106 template <typename T>
107 inline
109 {
110  return _m.n();
111 }
112 
113 
114 
115 template <typename T>
116 inline
118 {
119  _m.get_diagonal(dest);
120 }
121 
122 
123 } // namespace libMesh
124 
125 
126 #endif // LIBMESH_SPARSE_SHELL_MATRIX_H
virtual numeric_index_type m() const libmesh_override
Numeric vector.
Definition: dof_map.h:66
The libMesh namespace provides an interface to certain functionality in the library.
Generic sparse matrix.
Definition: dof_map.h:65
dof_id_type numeric_index_type
Definition: id_types.h:92
virtual void vector_mult_add(NumericVector< T > &dest, const NumericVector< T > &arg) const libmesh_override
Multiplies the matrix with arg and adds the result to dest.
virtual void vector_mult(NumericVector< T > &dest, const NumericVector< T > &arg) const libmesh_override
Multiplies the matrix with arg and stores the result in dest.
const SparseMatrix< T > & _m
The sparse matrix.
SparseShellMatrix(const SparseMatrix< T > &new_m)
Constructor; takes references to the sparse matrix.
const Parallel::Communicator & comm() const
This class allows to use any SparseMatrix object as a shell matrix.
virtual numeric_index_type n() const libmesh_override
virtual ~SparseShellMatrix()
Destructor.
Generic shell matrix, i.e.
virtual void get_diagonal(NumericVector< T > &dest) const libmesh_override
Copies the diagonal part of the matrix into dest.