newton.h

Go to the documentation of this file.

// ---------------------------------------------------------------------
//
// Copyright (C) 2010 - 2019 by the deal.II authors
//
// This file is part of the deal.II library.
//
// The deal.II library is free software; you can use it, 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.
// The full text of the license can be found in the file LICENSE.md at
// the top level directory of deal.II.
//
// ---------------------------------------------------------------------


#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/smartpointer.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 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:
    SmartPointer<OperatorBase, Newton<VectorType>> residual;

    SmartPointer<OperatorBase, Newton<VectorType>> inverse_derivative;

    SmartPointer<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