spherical_shell.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_geometry_model_spherical_shell_h
#define _aspect_geometry_model_spherical_shell_h

#include <aspect/geometry_model/interface.h>
#include <aspect/simulator_access.h>

namespace aspect
{
  namespace GeometryModel
  {
    namespace internal
    {
      template <int dim>
      class SphericalManifoldWithTopography : public aspect::SphericalManifold<dim>
      {
        public:
          SphericalManifoldWithTopography(const InitialTopographyModel::Interface<dim> &topography,
                                          const double inner_radius,
                                          const double outer_radius);

          SphericalManifoldWithTopography(const SphericalManifoldWithTopography<dim> &) = default;

          virtual std::unique_ptr<Manifold<dim, dim>>
          clone() const override;

          Point<dim>
          push_forward_from_sphere (const Point<dim> &p) const;

          Point<dim>
          pull_back_to_sphere (const Point<dim> &p) const;

          virtual Point<dim>
          get_intermediate_point(const Point<dim> &p1,
                                 const Point<dim> &p2,
                                 const double      w) const override;

          virtual Tensor<1, dim>
          get_tangent_vector(const Point<dim> &x1,
                             const Point<dim> &x2) const override;

          virtual Tensor<1, dim>
          normal_vector(
            const typename Triangulation<dim, dim>::face_iterator &face,
            const Point<dim> &p) const override;

          virtual void
          get_normals_at_vertices(
            const typename Triangulation<dim, dim>::face_iterator &face,
            typename Manifold<dim, dim>::FaceVertexNormals &face_vertex_normals)
          const override;


          virtual void
          get_new_points(const ArrayView<const Point<dim>> &surrounding_points,
                         const Table<2, double>                 &weights,
                         ArrayView<Point<dim>> new_points) const override;

          virtual Point<dim>
          get_new_point(const ArrayView<const Point<dim>> &vertices,
                        const ArrayView<const double>          &weights) const override;

        private:
          const InitialTopographyModel::Interface<dim> *topo;

          const double R0, R1;

          double topography_for_point (const Point<dim> &x_y_z) const;
      };

    }

    template <int dim>
    class SphericalShell : public Interface<dim>, public SimulatorAccess<dim>
    {
      public:
        SphericalShell() = default;

        void initialize () override;

        void create_coarse_mesh (parallel::distributed::Triangulation<dim> &coarse_grid) const override;

        double length_scale () const override;

        double depth(const Point<dim> &position) const override;

        double height_above_reference_surface(const Point<dim> &position) const override;

        Point<dim> representative_point(const double depth) const override;

        double maximal_depth() const override;

        std::set<types::boundary_id>
        get_used_boundary_indicators () const override;

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

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

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

        bool
        has_curved_elements() const override;

        bool
        point_is_in_domain(const Point<dim> &point) const override;

        aspect::Utilities::Coordinates::CoordinateSystem natural_coordinate_system() const override;

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

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


        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        double
        inner_radius () const;

        double
        outer_radius () const;

        double
        opening_angle () const;

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

      private:
        enum CustomMeshRadialSubdivision
        {
          none,
          list,
          slices
        } custom_mesh;

        unsigned int initial_lateral_refinement;

        unsigned int n_slices;

        std::vector<double> R_values_list;

        double R0, R1;

        double phi;

        int n_cells_along_circumference;

        void set_manifold_ids (parallel::distributed::Triangulation<dim> &triangulation) const;

        bool periodic;

        std::unique_ptr<const internal::SphericalManifoldWithTopography<dim>> manifold;

        static constexpr types::manifold_id my_manifold_id = 99;
    };
  }
}


#endif