libMesh
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_SHELL_MATRIX_H
21 #define LIBMESH_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/id_types.h"
29 #include "libmesh/parallel_object.h"
30 
31 namespace libMesh
32 {
33 
34 // forward declarations
35 template <typename T> class NumericVector;
36 
37 
46 template <typename T>
47 class ShellMatrix : public ReferenceCountedObject<ShellMatrix<T>>,
48  public ParallelObject
49 {
50 public:
54  ShellMatrix (const Parallel::Communicator & comm_in
55  LIBMESH_CAN_DEFAULT_TO_COMMWORLD);
56 
60  virtual ~ShellMatrix ();
61 
66  virtual numeric_index_type m () const = 0;
67 
72  virtual numeric_index_type n () const = 0;
73 
78  virtual void vector_mult (NumericVector<T> & dest,
79  const NumericVector<T> & arg) const = 0;
80 
84  virtual void vector_mult_add (NumericVector<T> & dest,
85  const NumericVector<T> & arg) const = 0;
86 
90  virtual void get_diagonal (NumericVector<T> & dest) const = 0;
91 };
92 
93 
94 
95 //-----------------------------------------------------------------------
96 // ShellMatrix inline members
97 template <typename T>
98 inline
100  ParallelObject(comm_in)
101 {}
102 
103 
104 
105 template <typename T>
106 inline
108 {}
109 
110 
111 } // namespace libMesh
112 
113 
114 #endif // LIBMESH_SHELL_MATRIX_H
virtual void get_diagonal(NumericVector< T > &dest) const =0
Copies the diagonal part of the matrix into dest.
virtual void vector_mult(NumericVector< T > &dest, const NumericVector< T > &arg) const =0
Multiplies the matrix with arg and stores the result in dest.
virtual ~ShellMatrix()
Destructor.
Definition: shell_matrix.h:107
Encapsulates the MPI_Comm object.
Definition: parallel.h:657
The libMesh namespace provides an interface to certain functionality in the library.
virtual numeric_index_type m() const =0
dof_id_type numeric_index_type
Definition: id_types.h:92
virtual numeric_index_type n() const =0
This class forms the base class for all other classes that are expected to be implemented in parallel...
virtual void vector_mult_add(NumericVector< T > &dest, const NumericVector< T > &arg) const =0
Multiplies the matrix with arg and adds the result to dest.
ShellMatrix(const Parallel::Communicator &comm_in LIBMESH_CAN_DEFAULT_TO_COMMWORLD)
Constructor; does nothing.
Definition: shell_matrix.h:99