nonlinear_implicit_system.h

Go to the documentation of this file.

// The libMesh Finite Element Library.
// Copyright (C) 2002-2024 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_NONLINEAR_IMPLICIT_SYSTEM_H
#define LIBMESH_NONLINEAR_IMPLICIT_SYSTEM_H

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

// C++ includes

namespace libMesh
{


// Forward declarations
class DiffSolver;
template<typename T> class NonlinearSolver;


class NonlinearImplicitSystem : public ImplicitSystem
{
public:

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

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

  typedef NonlinearImplicitSystem sys_type;

  typedef ImplicitSystem Parent;

  class ComputeResidual
  {
  public:
    virtual ~ComputeResidual () = default;
    virtual void residual (const NumericVector<Number> & X,
                           NumericVector<Number> & R,
                           sys_type & S) = 0;
  };


  class ComputeJacobian
  {
  public:
    virtual ~ComputeJacobian () = default;

    virtual void jacobian (const NumericVector<Number> & X,
                           SparseMatrix<Number> & J,
                           sys_type & S) = 0;
  };


  class ComputeBounds
  {
  public:
    virtual ~ComputeBounds () = default;

    virtual void bounds (NumericVector<Number> & XL,
                         NumericVector<Number> & XU,
                         sys_type & S) = 0;
  };

  class ComputeVectorSubspace
  {
  public:
    virtual ~ComputeVectorSubspace () = default;

    virtual void operator()(std::vector<NumericVector<Number> *> & sp,
                            sys_type & s) = 0;
  };

  class ComputeResidualandJacobian
  {
  public:
    virtual ~ComputeResidualandJacobian () = default;

    virtual void residual_and_jacobian (const NumericVector<Number> & X,
                                        NumericVector<Number> * R,
                                        SparseMatrix<Number> * J,
                                        sys_type & S) = 0;
  };

  class ComputePostCheck
  {
  public:
    virtual ~ComputePostCheck () = default;

    virtual void postcheck (const NumericVector<Number> & old_soln,
                            NumericVector<Number> & search_direction,
                            NumericVector<Number> & new_soln,
                            bool & changed_search_direction,
                            bool & changed_new_soln,
                            sys_type & S) = 0;
  };

  class ComputePreCheck
  {
  public:
    virtual ~ComputePreCheck () = default;

    virtual void precheck(const NumericVector<Number> & precheck_soln,
                          NumericVector<Number> & search_direction,
                          bool & changed,
                          sys_type & S) = 0;
  };

  sys_type & system () { return *this; }

  virtual void clear () override;

  virtual void reinit () override;

  virtual void solve () override;

  virtual std::pair<unsigned int, Real>
  get_linear_solve_parameters() 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 "NonlinearImplicit"; }

  std::unique_ptr<NonlinearSolver<Number>> nonlinear_solver;

  std::unique_ptr<DiffSolver> diff_solver;

  unsigned int n_nonlinear_iterations() const { return _n_nonlinear_iterations; }

  Real final_nonlinear_residual() const { return _final_nonlinear_residual; }

  unsigned get_current_nonlinear_iteration_number() const;


protected:

  void set_solver_parameters();

  unsigned int _n_nonlinear_iterations;

  Real _final_nonlinear_residual;
};

} // namespace libMesh

#endif // LIBMESH_NONLINEAR_IMPLICIT_SYSTEM_H