interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 2022 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_mesh_refinement_interface_h
#define _aspect_mesh_refinement_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 <deal.II/distributed/tria.h>


namespace aspect
{
  using namespace dealii;

  template <int dim> class Simulator;
  template <int dim> class SimulatorAccess;


  namespace MeshRefinement
  {

    template <int dim>
    class Interface
    {
      public:
        virtual ~Interface () = default;

        virtual void initialize ();

        virtual
        void
        update ();

        virtual
        void
        execute (Vector<float> &error_indicators) const;

        virtual
        void
        tag_additional_cells () const;

        static
        void
        declare_parameters (ParameterHandler &prm);

        virtual
        void
        parse_parameters (ParameterHandler &prm);
    };






    template <int dim>
    class Manager : public ::aspect::SimulatorAccess<dim>
    {
      public:
        ~Manager () override;

        virtual
        void
        update ();

        virtual
        void
        execute (Vector<float> &error_indicators) const;

        virtual
        void
        tag_additional_cells () const;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm);

        template <typename MeshRefinementType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,MeshRefinementType>::value>>
        bool
        has_matching_mesh_refinement_strategy () const;

        template <typename MeshRefinementType,
                  typename = typename std::enable_if_t<std::is_base_of<Interface<dim>,MeshRefinementType>::value>>
        const MeshRefinementType &
        get_matching_mesh_refinement_strategy () const;

        static
        void
        register_mesh_refinement_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 (ExcMeshRefinementNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered mesh refinement objects.");
      private:
        enum MergeOperation
        { plus, max };

        MergeOperation merge_operation;

        bool normalize_criteria;

        std::vector<double> scaling_factors;

        std::list<std::unique_ptr<Interface<dim>>> mesh_refinement_objects;
    };



    template <int dim>
    template <typename MeshRefinementType, typename>
    inline
    bool
    Manager<dim>::has_matching_mesh_refinement_strategy () const
    {
      for (typename std::list<std::unique_ptr<Interface<dim>>>::const_iterator
           p = mesh_refinement_objects.begin();
           p != mesh_refinement_objects.end(); ++p)
        if (Plugins::plugin_type_matches<MeshRefinementType>(*(*p)))
          return true;

      return false;
    }



    template <int dim>
    template <typename MeshRefinementType, typename>
    inline
    const MeshRefinementType &
    Manager<dim>::get_matching_mesh_refinement_strategy () const
    {
      AssertThrow(has_matching_mesh_refinement_strategy<MeshRefinementType> (),
                  ExcMessage("You asked MeshRefinement::Manager::get_matching_mesh_refinement_strategy() for a "
                             "mesh refinement strategy of type <" + boost::core::demangle(typeid(MeshRefinementType).name()) + "> "
                             "that could not be found in the current model. Activate this "
                             "mesh refinement strategy in the input file."));

      for (typename std::list<std::unique_ptr<Interface<dim>>>::const_iterator
           p = mesh_refinement_objects.begin();
           p != mesh_refinement_objects.end(); ++p)
        if (Plugins::plugin_type_matches<MeshRefinementType>(*(*p)))
          return Plugins::get_plugin_as_type<MeshRefinementType>(*(*p));

      // We will never get here, because we had the Assert above. Just to avoid warnings.
      typename std::list<std::unique_ptr<Interface<dim>>>::const_iterator mesh_refinement_strategy;
      return Plugins::get_plugin_as_type<MeshRefinementType>(*(*mesh_refinement_strategy));
    }



#define ASPECT_REGISTER_MESH_REFINEMENT_CRITERION(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_MESH_REFINEMENT_CRITERION_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::MeshRefinement::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::MeshRefinement::Manager<2>::register_mesh_refinement_criterion, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::MeshRefinement::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::MeshRefinement::Manager<3>::register_mesh_refinement_criterion, \
                                name, description); \
  }
  }
}


#endif