interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2019 - 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_interface_h
#define _aspect_time_stepping_interface_h
 
#include <aspect/global.h>
#include <aspect/simulator_access.h>
#include <aspect/termination_criteria/interface.h>
 
namespace aspect
{
  namespace TimeStepping
  {
 
    enum class Reaction
    {
      refine_and_repeat_step,
      repeat_step,
      refine_and_advance,
      advance
    };
 
    struct TimeStepInfo
    {
      double next_time_step_size;
 
      bool reduced_by_termination_plugin;
    };
 
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        double
        execute() = 0;
 
        virtual
        std::pair<Reaction, double>
        determine_reaction(const TimeStepInfo &info);
    };
 
 
    template <int dim>
    class Manager : public Plugins::ManagerBase<Interface<dim>>, public SimulatorAccess<dim>
    {
      public:
        void initialize_simulator (const Simulator<dim> &simulator_object) override;
 
 
        void
        update() override;
 
        double get_next_time_step_size() const;
 
        bool should_repeat_time_step() const;
 
        bool should_refine_mesh() const;
 
        bool need_checkpoint_on_terminate() const;
 
        bool should_simulation_terminate_now() const;
 
        static
        void
        declare_parameters (ParameterHandler &prm);
 
        void
        parse_parameters (ParameterHandler &prm) override;
 
        template <class Archive>
        void
        serialize (Archive &ar, const unsigned int)
        {
          ar &termination_manager;
        }
 
        static
        void
        write_plugin_graph (std::ostream &output_stream);
 
        static
        void
        register_time_stepping_model (const std::string &name,
                                      const std::string &description,
                                      void (*declare_parameters_function) (ParameterHandler &),
                                      std::unique_ptr<Interface<dim>> (*factory_function) ());
 
      private:
 
        Reaction current_reaction;
 
        double next_time_step_size;
 
        double minimum_time_step_size;
 
        bool do_checkpoint_on_terminate;
 
        TerminationCriteria::Manager<dim> termination_manager;
    };
 
 
 
#define ASPECT_REGISTER_TIME_STEPPING_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_TIME_STEPPING_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::TimeStepping::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::TimeStepping::Manager<2>::register_time_stepping_model, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::TimeStepping::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::TimeStepping::Manager<3>::register_time_stepping_model, \
                                name, description); \
  }
 
  }
}
 
#endif