box.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_box_h
#define _aspect_geometry_model_box_h

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


namespace aspect
{
  namespace GeometryModel
  {
    template <int dim>
    class Box : public Interface<dim>, public SimulatorAccess<dim>
    {
      public:
        void initialize () override;

        void topography (typename parallel::distributed::Triangulation<dim> &grid) const;

        Point<dim> add_topography (const Point<dim> &x_y_z) const;

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

        virtual
        Point<dim> get_extents () const;

        const std::array<unsigned int, dim> &
        get_repetitions () const;

        virtual
        Point<dim> get_origin () const;

        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;

      private:
        InitialTopographyModel::Interface<dim> *topo_model;

        Point<dim> extents;

        Point<dim> box_origin;

        std::array<bool, dim> periodic;

        std::array<unsigned int, dim> repetitions;
    };
  }
}


#endif