implicit_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2025 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_IMPLICIT_SYSTEM_H
#define LIBMESH_IMPLICIT_SYSTEM_H

// Local Includes
#include "libmesh/explicit_system.h"

// C++ includes
#include <cstddef>
#include <memory>

namespace libMesh
{

// Forward declarations
template <typename T> class LinearSolver;
class StaticCondensation;

class ImplicitSystem : public ExplicitSystem
{
public:

  ImplicitSystem (EquationSystems & es,
                  const std::string & name,
                  const unsigned int number);

  ImplicitSystem (const ImplicitSystem &) = delete;
  ImplicitSystem & operator= (const ImplicitSystem &) = delete;
  ImplicitSystem (ImplicitSystem &&) = default;
  ImplicitSystem & operator= (ImplicitSystem &&) = delete;
  virtual ~ImplicitSystem ();

  typedef ImplicitSystem sys_type;

  sys_type & system () { return *this; }

  typedef ExplicitSystem Parent;

  virtual void clear () override;

  virtual void assemble () override;

  virtual void disable_cache () override;

  virtual std::string system_type () const override { return "Implicit"; }

  virtual LinearSolver<Number> * get_linear_solver() const;

  virtual std::pair<unsigned int, Real>
  get_linear_solve_parameters() const;

#ifdef LIBMESH_ENABLE_DEPRECATED

  virtual void release_linear_solver(LinearSolver<Number> *) const;
#endif // LIBMESH_ENABLE_DEPRECATED

  virtual void assembly (bool /* get_residual */,
                         bool /* get_jacobian */,
                         bool /* apply_heterogeneous_constraints */ = false,
                         bool /* apply_no_constraints */ = false)
  { libmesh_not_implemented(); }

  virtual void assemble_residual_derivatives (const ParameterVector & parameters) override;

  virtual void solve () override
  { libmesh_not_implemented(); }

  virtual std::pair<unsigned int, Real>
  sensitivity_solve (const ParameterVector & parameters) override;

  virtual std::pair<unsigned int, Real>
  weighted_sensitivity_solve (const ParameterVector & parameters,
                              const ParameterVector & weights) override;

  virtual std::pair<unsigned int, Real>
  adjoint_solve (const QoISet & qoi_indices = QoISet()) override;

  virtual std::pair<unsigned int, Real>
  weighted_sensitivity_adjoint_solve (const ParameterVector & parameters,
                                      const ParameterVector & weights,
                                      const QoISet & qoi_indices = QoISet()) override;

  virtual void adjoint_qoi_parameter_sensitivity (const QoISet & qoi_indices,
                                                  const ParameterVector & parameters,
                                                  SensitivityData & sensitivities) override;

  virtual void forward_qoi_parameter_sensitivity (const QoISet & qoi_indices,
                                                  const ParameterVector & parameters,
                                                  SensitivityData & sensitivities) override;

  virtual void qoi_parameter_hessian(const QoISet & qoi_indices,
                                     const ParameterVector & parameters,
                                     SensitivityData & hessian) override;

  virtual void qoi_parameter_hessian_vector_product(const QoISet & qoi_indices,
                                                    const ParameterVector & parameters,
                                                    const ParameterVector & vector,
                                                    SensitivityData & product) override;

  const SparseMatrix<Number> & get_system_matrix() const;

  SparseMatrix<Number> & get_system_matrix();

  SparseMatrix<Number> * matrix;

  bool zero_out_matrix_and_rhs;

  mutable std::unique_ptr<LinearSolver<Number>> linear_solver;

  virtual void create_static_condensation() override;

  StaticCondensation & get_static_condensation();

protected:
  virtual void add_matrices() override;

  template <typename T>
  void setup_static_condensation_preconditioner(T & solver);

private:
   void create_static_condensation_system_matrix();

   StaticCondensation * _sc_system_matrix;
};

inline
StaticCondensation & ImplicitSystem::get_static_condensation()
{
  libmesh_assert(_sc_system_matrix);
  return *_sc_system_matrix;
}

} // namespace libMesh

#endif // LIBMESH_IMPLICIT_SYSTEM_H