interface.h

Go to the documentation of this file.

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

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

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

#include <boost/serialization/split_member.hpp>
#include <boost/core/demangle.hpp>

#include <typeinfo>


namespace aspect
{
  template <int dim> class Simulator;
  template <int dim> class SimulatorAccess;


  namespace Postprocess
  {

    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        std::pair<std::string,std::string>
        execute (TableHandler &statistics) = 0;

        virtual
        std::list<std::string>
        required_other_postprocessors () const;
    };



    template <int dim>
    class Manager : public Plugins::ManagerBase<Interface<dim>>, public SimulatorAccess<dim>
    {
      public:
        std::list<std::pair<std::string,std::string>>
        execute (TableHandler &statistics);

        template <typename PostprocessorType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,PostprocessorType>::value>>
        DEAL_II_DEPRECATED
        bool
        has_matching_postprocessor () const;

        template <typename PostprocessorType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,PostprocessorType>::value>>
        DEAL_II_DEPRECATED
        const PostprocessorType &
        get_matching_postprocessor () const;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        static
        void
        register_postprocessor (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 (ExcPostprocessorNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered postprocessors.");
    };


    /* -------------------------- inline and template functions ---------------------- */

    template <int dim>
    template <typename PostprocessorType, typename>
    inline
    bool
    Manager<dim>::has_matching_postprocessor () const
    {
      return this->template has_matching_active_plugin<PostprocessorType>();
    }



    template <int dim>
    template <typename PostprocessorType, typename>
    inline
    const PostprocessorType &
    Manager<dim>::get_matching_postprocessor () const
    {
      return this->template get_matching_active_plugin<PostprocessorType>();
    }


#define ASPECT_REGISTER_POSTPROCESSOR(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_POSTPROCESSOR_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::Postprocess::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::Postprocess::Manager<2>::register_postprocessor, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::Postprocess::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::Postprocess::Manager<3>::register_postprocessor, \
                                name, description); \
  }
  }
}


#endif