shell_matrix.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2026 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_SHELL_MATRIX_H
#define LIBMESH_SHELL_MATRIX_H
 
 
// Local includes
#include "libmesh/libmesh_common.h"
#include "libmesh/reference_counted_object.h"
#include "libmesh/libmesh.h"
#include "libmesh/id_types.h"
#include "libmesh/parallel_object.h"
#include "libmesh/dof_map.h"
#include "libmesh/parallel.h"
 
namespace libMesh
{
 
// forward declarations
template <typename T> class NumericVector;
enum SolverPackage : int;
 
template <typename T>
class ShellMatrix : public ReferenceCountedObject<ShellMatrix<T>>,
                    public ParallelObject
{
public:
  ShellMatrix (const Parallel::Communicator & comm_in);
 
  static std::unique_ptr<ShellMatrix<T>>
  build(const Parallel::Communicator & comm,
        const SolverPackage solver_package = libMesh::default_solver_package());
 
  virtual ~ShellMatrix ();
 
  virtual numeric_index_type m () const = 0;
 
  virtual numeric_index_type n () const = 0;
 
  virtual void vector_mult (NumericVector<T> & dest,
                            const NumericVector<T> & arg) const = 0;
 
  virtual void vector_mult_add (NumericVector<T> & dest,
                                const NumericVector<T> & arg) const = 0;
 
  virtual void get_diagonal (NumericVector<T> & dest) const = 0;
 
  void attach_dof_map (const DofMap & dof_map)
  { _dof_map = &dof_map; }
 
 
  virtual void clear () { libmesh_error_msg ("Not implemented yet"); }
 
  virtual void init () { libmesh_error_msg ("Not implemented yet"); }
 
  void omit_constrained_dofs() { _omit_constrained_dofs = true; }
 
protected:
  DofMap const * _dof_map;
 
  bool _omit_constrained_dofs;
};
 
 
 
//-----------------------------------------------------------------------
// ShellMatrix inline members
template <typename T>
inline
ShellMatrix<T>::ShellMatrix (const Parallel::Communicator & comm_in) :
  ParallelObject(comm_in),
  _dof_map(nullptr),
  _omit_constrained_dofs(false)
{}
 
 
template <typename T>
inline
ShellMatrix<T>::~ShellMatrix ()
{}
 
 
} // namespace libMesh
 
 
#endif // LIBMESH_SHELL_MATRIX_H