newton.h

Go to the documentation of this file.

// -----------------------------------------------------------------------------
//
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception OR LGPL-2.1-or-later
// Copyright (C) 2010 - 2025 by the deal.II authors
//
// This file is part of the deal.II library.
//
// Detailed license information governing the source code and contributions
// can be found in LICENSE.md and CONTRIBUTING.md at the top level directory.
//
// -----------------------------------------------------------------------------
 
 
#ifndef dealii_newton_h
#define dealii_newton_h
 
#include <deal.II/base/config.h>
 
#include <deal.II/algorithms/any_data.h>
#include <deal.II/algorithms/operator.h>
 
#include <deal.II/base/event.h>
#include <deal.II/base/observer_pointer.h>
 
#include <deal.II/lac/solver_control.h>
 
DEAL_II_NAMESPACE_OPEN
 
// Forward declaration
#ifndef DOXYGEN
class ParameterHandler;
#endif
 
namespace Algorithms
{
  template <typename VectorType>
  class DEAL_II_DEPRECATED Newton : public OperatorBase
  {
  public:
    Newton(OperatorBase &residual, OperatorBase &inverse_derivative);
 
    static void
    declare_parameters(ParameterHandler &param);
 
    void
    parse_parameters(ParameterHandler &param);
 
    void
    initialize(OutputOperator<VectorType> &output);
 
    virtual void
    operator()(AnyData &out, const AnyData &in) override;
 
    virtual void
    notify(const Event &) override;
 
    double
    threshold(double new_value);
 
    ReductionControl control;
 
  private:
    ObserverPointer<OperatorBase, Newton<VectorType>> residual;
 
    ObserverPointer<OperatorBase, Newton<VectorType>> inverse_derivative;
 
    ObserverPointer<OutputOperator<VectorType>, Newton<VectorType>> data_out;
 
    bool assemble_now;
 
    unsigned int n_stepsize_iterations;
 
    double assemble_threshold;
 
  public:
    bool debug_vectors;
    unsigned int debug;
  };
} // namespace Algorithms
 
DEAL_II_NAMESPACE_CLOSE
 
#endif