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_geometry_model_interface_h
#define _aspect_geometry_model_interface_h

#include <aspect/plugins.h>
#include <deal.II/base/parameter_handler.h>
#include <deal.II/distributed/tria.h>
#include <array>
#include <aspect/utilities.h>
#include <aspect/coordinate_systems.h>

#include <set>


namespace aspect
{
  namespace GeometryModel
  {
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        void create_coarse_mesh (parallel::distributed::Triangulation<dim> &coarse_grid) const = 0;

        virtual
        double length_scale () const = 0;

        virtual
        double depth(const Point<dim> &position) const = 0;

        virtual
        double height_above_reference_surface(const Point<dim> &position) const = 0;

        Utilities::NaturalCoordinate<dim>
        cartesian_to_other_coordinates(const Point<dim> &position,
                                       const Utilities::Coordinates::CoordinateSystem &coordinate_system) const;

        virtual
        aspect::Utilities::Coordinates::CoordinateSystem natural_coordinate_system() const = 0;

        virtual
        std::array<double,dim> cartesian_to_natural_coordinates(const Point<dim> &position) const;

        virtual
        Point<dim> natural_to_cartesian_coordinates(const std::array<double,dim> &position) const;

        virtual
        Point<dim> representative_point(const double depth) const = 0;

        virtual
        double maximal_depth() const = 0;


        virtual
        std::set<types::boundary_id>
        get_used_boundary_indicators () const = 0;

        virtual
        std::map<std::string,types::boundary_id>
        get_symbolic_boundary_names_map () const;

        types::boundary_id
        translate_symbolic_boundary_name_to_id (const std::string &name) const;

        std::vector<types::boundary_id>
        translate_symbolic_boundary_names_to_ids (const std::vector<std::string> &names) const;

        std::string
        translate_id_to_symbol_name (const types::boundary_id boundary_id) const;

        virtual
        std::set<std::pair<std::pair<types::boundary_id, types::boundary_id>, unsigned int>>
        get_periodic_boundary_pairs () const;

        virtual
        void
        adjust_positions_for_periodicity (Point<dim> &position,
                                          const ArrayView<Point<dim>> &connected_positions = {},
                                          const ArrayView<Tensor<1,dim>> &connected_velocities = {}) const;

        virtual
        bool
        has_curved_elements() const;

        virtual
        bool
        point_is_in_domain(const Point<dim> &p) const = 0;

        virtual
        void
        make_periodicity_constraints(const DoFHandler<dim> &dof_handler,
                                     AffineConstraints<double> &constraints) const;

        virtual
        void
        make_periodicity_constraints_on_level(
          const DoFHandler<dim> &dof_handler,
          const unsigned int level,
          AffineConstraints<double> &constraints) const;
    };



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

    template <int dim>
    std::unique_ptr<Interface<dim>>
    create_geometry_model (ParameterHandler &prm);

    template <int dim>
    void
    declare_parameters (ParameterHandler &prm);

    template <int dim>
    void
    write_plugin_graph (std::ostream &output_stream);



#define ASPECT_REGISTER_GEOMETRY_MODEL(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_GEOMETRY_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::GeometryModel::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::GeometryModel::register_geometry_model<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::GeometryModel::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::GeometryModel::register_geometry_model<3>, \
                                name, description); \
  }
  }
}


#endif