linear_implicit_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2019 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_LINEAR_IMPLICIT_SYSTEM_H
#define LIBMESH_LINEAR_IMPLICIT_SYSTEM_H
 
// Local Includes
#include "libmesh/implicit_system.h"
 
// C++ includes
#include <cstddef>
 
namespace libMesh
{
 
 
// Forward Declarations
template <typename T> class LinearSolver;
template <typename T> class ShellMatrix;
 
 
class LinearImplicitSystem : public ImplicitSystem
{
public:
 
  LinearImplicitSystem (EquationSystems & es,
                        const std::string & name,
                        const unsigned int number);
 
  virtual ~LinearImplicitSystem ();
 
  typedef LinearImplicitSystem sys_type;
 
  typedef ImplicitSystem Parent;
 
  sys_type & system () { return *this; }
 
  virtual void clear () override;
 
  virtual void init_data () override;
 
  virtual void reinit () override;
 
  virtual void assemble () override { ImplicitSystem::assemble(); }
 
  virtual void restrict_solve_to (const SystemSubset * subset,
                                  const SubsetSolveMode subset_solve_mode=SUBSET_ZERO) override;
 
  virtual void solve () override;
 
  virtual LinearSolver<Number> * get_linear_solver() const override;
 
  virtual void release_linear_solver(LinearSolver<Number> *) const override;
 
  virtual void assembly(bool get_residual,
                        bool get_jacobian,
                        bool apply_heterogeneous_constraints = false,
                        bool apply_no_constraints = false) override;
 
  virtual std::string system_type () const override { return "LinearImplicit"; }
 
  std::unique_ptr<LinearSolver<Number>> linear_solver;
 
  unsigned int n_linear_iterations() const { return _n_linear_iterations; }
 
  Real final_linear_residual() const { return _final_linear_residual; }
 
  void attach_shell_matrix (ShellMatrix<Number> * shell_matrix);
 
  void detach_shell_matrix () { attach_shell_matrix(nullptr); }
 
  ShellMatrix<Number> * get_shell_matrix() { return _shell_matrix; }
 
protected:
 
  unsigned int _n_linear_iterations;
 
  Real _final_linear_residual;
 
  ShellMatrix<Number> * _shell_matrix;
 
  const SystemSubset * _subset;
 
  SubsetSolveMode _subset_solve_mode;
};
 
} // namespace libMesh
 
#endif // LIBMESH_LINEAR_IMPLICIT_SYSTEM_H