interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2011 - 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_mesh_deformation_interface_h
#define _aspect_mesh_deformation_interface_h

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

#include <deal.II/fe/fe_system.h>
#include <deal.II/dofs/dof_handler.h>
#include <deal.II/lac/affine_constraints.h>
#include <deal.II/base/index_set.h>
#include <deal.II/base/mg_level_object.h>
#include <deal.II/lac/la_parallel_vector.h>
#include <deal.II/multigrid/mg_constrained_dofs.h>
#include <deal.II/multigrid/mg_transfer_matrix_free.h>
#include <deal.II/multigrid/mg_transfer_global_coarsening.templates.h>
#include <aspect/simulator/assemblers/interface.h>

namespace aspect
{
  namespace Assemblers
  {
    template <int dim>
    class ApplyStabilization: public Assemblers::Interface<dim>,
      public SimulatorAccess<dim>
    {
      public:
        ApplyStabilization(const double stabilization_theta);

        void
        execute (internal::Assembly::Scratch::ScratchBase<dim>   &scratch,
                 internal::Assembly::CopyData::CopyDataBase<dim> &data) const override;

      private:
        const double free_surface_theta;
    };
  }

  template <int dim> class Simulator;

  namespace MeshDeformation
  {
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual bool needs_surface_stabilization() const;


        virtual
        Tensor<1,dim>
        compute_initial_deformation_on_boundary(const types::boundary_id boundary_indicator,
                                                const Point<dim> &position) const;

        virtual
        void
        compute_velocity_constraints_on_boundary(const DoFHandler<dim> &mesh_deformation_dof_handler,
                                                 AffineConstraints<double> &mesh_velocity_constraints,
                                                 const std::set<types::boundary_id> &boundary_ids) const;
    };



    template <int dim>
    class MeshDeformationHandler: public SimulatorAccess<dim>
    {
      public:
        MeshDeformationHandler(Simulator<dim> &simulator);

        ~MeshDeformationHandler() override;

        void initialize();

        void set_assemblers(const SimulatorAccess<dim> &simulator_access,
                            aspect::Assemblers::Manager<dim> &assemblers) const;

        void update();

        void execute();

        void setup_dofs();

        static
        void declare_parameters (ParameterHandler &prm);

        void parse_parameters (ParameterHandler &prm);

        template <class Archive>
        void save (Archive &ar,
                   const unsigned int version) const;

        template <class Archive>
        void load (Archive &ar,
                   const unsigned int version);

        BOOST_SERIALIZATION_SPLIT_MEMBER()

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

        const std::map<types::boundary_id, std::vector<std::string>> &
        get_active_mesh_deformation_names () const;

        const std::map<types::boundary_id,std::vector<std::unique_ptr<Interface<dim>>>> &
        get_active_mesh_deformation_models () const;

        const std::set<types::boundary_id> &
        get_active_mesh_deformation_boundary_indicators () const;

        const std::set<types::boundary_id> &
        get_boundary_indicators_requiring_stabilization () const;

        const std::set<types::boundary_id> &
        get_free_surface_boundary_indicators () const;

        double get_free_surface_theta () const;

        const LinearAlgebra::Vector &
        get_initial_topography () const;

        const LinearAlgebra::Vector &
        get_mesh_displacements () const;

        const DoFHandler<dim> &
        get_mesh_deformation_dof_handler () const;

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

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


        const Mapping<dim> &
        get_level_mapping(const unsigned int level) const;

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

        DeclException1 (ExcMeshDeformationNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered mesh deformation objects.");

      private:
        void make_initial_constraints ();

        void make_constraints ();

        void compute_mesh_displacements ();

        void compute_mesh_displacements_gmg ();

        void set_initial_topography ();

        void interpolate_mesh_velocity ();

        void update_multilevel_deformation ();

        Simulator<dim> &sim;

        const FESystem<dim> mesh_deformation_fe;

        DoFHandler<dim> mesh_deformation_dof_handler;

        LinearAlgebra::BlockVector mesh_velocity;

        LinearAlgebra::Vector mesh_displacements;

        LinearAlgebra::Vector old_mesh_displacements;

        LinearAlgebra::Vector initial_topography;

        LinearAlgebra::Vector fs_mesh_velocity;

        IndexSet mesh_locally_owned;

        IndexSet mesh_locally_relevant;

        AffineConstraints<double> mesh_velocity_constraints;

        AffineConstraints<double> mesh_vertex_constraints;

        std::map<types::boundary_id,std::vector<std::unique_ptr<Interface<dim>>>> mesh_deformation_objects;

        std::map<types::boundary_id, std::vector<std::string>> mesh_deformation_object_names;

        std::set<types::boundary_id> prescribed_mesh_deformation_boundary_indicators;

        std::set<types::boundary_id> tangential_mesh_deformation_boundary_indicators;

        std::set<types::boundary_id> zero_mesh_deformation_boundary_indicators;

        std::set<types::boundary_id> free_surface_boundary_indicators;

        std::set<types::boundary_id> boundary_indicators_requiring_stabilization;

        bool include_initial_topography;

        double surface_theta;

        MGLevelObject<std::unique_ptr<Mapping<dim>>> level_mappings;

        MGLevelObject<::LinearAlgebra::distributed::Vector<double>> level_displacements;

        MGTransferMF<dim, double> mg_transfer;

        MGConstrainedDoFs mg_constrained_dofs;

        friend class Simulator<dim>;
        friend class SimulatorAccess<dim>;
    };


    template <int dim>
    template <class Archive>
    void MeshDeformationHandler<dim>::save (Archive &ar,
                                            const unsigned int) const
    {
      // let all the mesh deformation plugins save their data in a map and then
      // serialize that
      //TODO: for now we assume the same plugins are active before and after restart.
      std::map<std::string,std::string> saved_text;
      for (const auto &boundary_id_and_mesh_deformation_objects : mesh_deformation_objects)
        for (const auto &p : boundary_id_and_mesh_deformation_objects.second)
          p->save (saved_text);

      ar &saved_text;
    }


    template <int dim>
    template <class Archive>
    void MeshDeformationHandler<dim>::load (Archive &ar,
                                            const unsigned int)
    {
      // get the map back out of the stream; then let the mesh deformation plugins
      // that we currently have get their data from there. note that this
      // may not be the same set ofmesh deformation plugins we had when we saved
      // their data
      std::map<std::string,std::string> saved_text;
      ar &saved_text;

      for (const auto &boundary_id_and_mesh_deformation_objects : mesh_deformation_objects)
        for (const auto &p : boundary_id_and_mesh_deformation_objects.second)
          p->load (saved_text);
    }




    template <int dim>
    template <typename MeshDeformationType, typename>
    inline
    bool
    MeshDeformationHandler<dim>::has_matching_mesh_deformation_object () const
    {
      for (const auto &object_iterator : mesh_deformation_objects)
        for (const auto &p : object_iterator.second)
          if (Plugins::plugin_type_matches<MeshDeformationType>(*p))
            return true;

      return false;
    }



    template <int dim>
    template <typename MeshDeformationType, typename>
    inline
    const MeshDeformationType &
    MeshDeformationHandler<dim>::get_matching_mesh_deformation_object () const
    {
      AssertThrow(has_matching_mesh_deformation_object<MeshDeformationType> (),
                  ExcMessage("You asked MeshDeformation::MeshDeformationHandler::get_matching_mesh_deformation_object() for a "
                             "mesh deformation object of type <" + boost::core::demangle(typeid(MeshDeformationType).name()) + "> "
                             "that could not be found in the current model. Activate this "
                             "mesh deformation in the input file."));

      for (const auto &object_iterator : mesh_deformation_objects)
        for (const auto &p : object_iterator.second)
          if (Plugins::plugin_type_matches<MeshDeformationType>(*p))
            return Plugins::get_plugin_as_type<MeshDeformationType>(*p);

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

    }


    template <int dim>
    std::string
    get_valid_model_names_pattern ();



#define ASPECT_REGISTER_MESH_DEFORMATION_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_MESH_DEFORMATION_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::MeshDeformation::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::MeshDeformation::MeshDeformationHandler<2>::register_mesh_deformation, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::MeshDeformation::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::MeshDeformation::MeshDeformationHandler<3>::register_mesh_deformation, \
                                name, description); \
  }
  }
}

#endif