libMesh
Loading...
Searching...
No Matches
sparse_shell_matrix.h
Go to the documentation of this file.
1// The libMesh Finite Element Library.
2// Copyright (C) 2002-2026 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
31namespace libMesh
32{
33
42template <typename T>
44{
45public:
50 explicit
51 SparseShellMatrix (const SparseMatrix<T> & new_m);
52
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
70protected:
75};
76
77
78
79//-----------------------------------------------------------------------
80// SparseShellMatrix inline members
81template <typename T>
82inline
84 ShellMatrix<T>(new_m.comm()),
85 _m(new_m)
86{}
87
88
89
90template <typename T>
91inline
94
95
96
97template <typename T>
98inline
100{
101 return _m.m();
102}
103
104
105
106template <typename T>
107inline
109{
110 return _m.n();
111}
112
113
114
115template <typename T>
116inline
118{
119 _m.get_diagonal(dest);
120}
121
122
123} // namespace libMesh
124
125
126#endif // LIBMESH_SPARSE_SHELL_MATRIX_H
Provides a uniform interface to vector storage schemes for different linear algebra libraries.
Generic shell matrix, i.e.
virtual numeric_index_type m() const =0
Generic sparse matrix.
This class allows to use any SparseMatrix object as a shell matrix.
virtual numeric_index_type n() const override
virtual ~SparseShellMatrix()
Destructor.
virtual void vector_mult_add(NumericVector< T > &dest, const NumericVector< T > &arg) const override
Multiplies the matrix with arg and adds the result to dest.
const SparseMatrix< T > & _m
The sparse matrix.
virtual void get_diagonal(NumericVector< T > &dest) const override
Copies the diagonal part of the matrix into dest.
virtual void vector_mult(NumericVector< T > &dest, const NumericVector< T > &arg) const override
Multiplies the matrix with arg and stores the result in dest.
SparseShellMatrix(const SparseMatrix< T > &new_m)
Constructor; takes references to the sparse matrix.
virtual numeric_index_type m() const override
The libMesh namespace provides an interface to certain functionality in the library.
dof_id_type numeric_index_type
Definition id_types.h:99