interface.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2011-2025 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_termination_criteria_interface_h
#define _aspect_termination_criteria_interface_h

#include <aspect/global.h>
#include <aspect/plugins.h>

#include <memory>
#include <deal.II/base/parameter_handler.h>
#include <aspect/simulator_access.h>


namespace aspect
{
  template <int dim> class Simulator;


  namespace TerminationCriteria
  {

    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        bool
        execute () = 0;

        virtual double check_for_last_time_step (const double time_step) const;
    };






    template <int dim>
    class Manager : public Plugins::ManagerBase<Interface<dim>>, public SimulatorAccess<dim>
    {
      public:
        virtual
        bool
        execute () const;

        double check_for_last_time_step (const double time_step) const;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        static
        void
        register_termination_criterion (const std::string &name,
                                        const std::string &description,
                                        void (*declare_parameters_function) (ParameterHandler &),
                                        std::unique_ptr<Interface<dim>> (*factory_function) ());

        static
        void
        write_plugin_graph (std::ostream &output_stream);

        DeclException1 (ExcTerminationCriteriaNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered termination criteria objects.");
    };



#define ASPECT_REGISTER_TERMINATION_CRITERION(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_TERMINATION_CRITERION_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::TerminationCriteria::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::TerminationCriteria::Manager<2>::register_termination_criterion, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::TerminationCriteria::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::TerminationCriteria::Manager<3>::register_termination_criterion, \
                                name, description); \
  }
  }
}


#endif