repeat_on_nonlinear_fail.h

Go to the documentation of this file.

/*
  Copyright (C) 2018 - 2024 by the authors of the ASPECT code.

  This file is part of ASPECT.

  ASPECT is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2, or (at your option)
  any later version.

  ASPECT 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 General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with ASPECT; see the file LICENSE.  If not see
  <http://www.gnu.org/licenses/>.
*/


#ifndef _aspect_time_stepping_repeat_on_nonlinear_fail_h
#define _aspect_time_stepping_repeat_on_nonlinear_fail_h

#include <aspect/time_stepping/interface.h>

namespace aspect
{
  namespace TimeStepping
  {
    template <int dim>
    class RepeatOnNonlinearFail : public Interface<dim>, public SimulatorAccess<dim>
    {
      public:
        RepeatOnNonlinearFail ();

        double
        execute() override;

        void nonlinear_solver_has_failed() const;

        std::pair<Reaction, double>
        determine_reaction(const TimeStepInfo &info) override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

      private:
        double cut_back_factor;

        mutable bool nonlinear_solver_just_failed;

        unsigned int maximum_number_of_repeats;

        unsigned int current_number_of_repeats;
    };
  }
}


#endif