repeat_on_nonlinear_fail.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2018-2026 by the ASPECT authors.
//
// This file is part of ASPECT.
//
// Detailed license information governing the source code and
// contributions can be found in the folder LICENSES and in
// LICENSE and CONTRIBUTING.md at the top level directory.
//
// ------------------------------------------------------


#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