gplates.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_boundary_velocity_gplates_h
#define _aspect_boundary_velocity_gplates_h

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

#include <array>
#include <deal.II/base/function_lib.h>


namespace aspect
{
  namespace BoundaryVelocity
  {
    using namespace dealii;

    namespace internal
    {
      template <int dim>
      class GPlatesLookup
      {
        public:

          GPlatesLookup(const Tensor<1,2> &surface_point_one,
                        const Tensor<1,2> &surface_point_two);

          std::string
          screen_output(const Tensor<1,2> &surface_point_one,
                        const Tensor<1,2> &surface_point_two) const;

          void load_file(const std::string &filename,
                         const MPI_Comm comm);

          Tensor<1,dim> surface_velocity(const Point<dim> &position) const;

        private:
          std::array<std::unique_ptr<Functions::InterpolatedUniformGridData<2>>, 2> velocities;

          double delta_phi, delta_theta;

          Tensor<2,3> rotation_matrix;

          std::array<double,3>
          angles_from_matrix (const Tensor<2,3> &rotation_matrix) const;

          double
          rotation_axis_from_matrix (Tensor<1,3> &rotation_axis,
                                     const Tensor<2,3> &rotation_matrix) const;

          template <int in, int out>
          Tensor<1,out> convert_tensor (const Tensor<1,in> &old_tensor) const;

          Tensor<1,3>
          cartesian_surface_coordinates(const Tensor<1,3> &sposition) const;

          Tensor<1,dim>
          cartesian_velocity_at_surface_point(const std::array<double,3> &spherical_point) const;

          Tensor<1,3> sphere_to_cart_velocity(const Tensor<1,2> &s_velocities,
                                              const std::array<double,3> &s_position) const;

          bool
          gplates_1_4_or_higher(const boost::property_tree::ptree &pt) const;
      };
    }

    template <int dim>
    class GPlates : public Interface<dim>, public SimulatorAccess<dim>
    {
      public:
        GPlates ();

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

        // avoid -Woverloaded-virtual warning until the deprecated function
        // is removed from the interface:
        using Interface<dim>::boundary_velocity;

        void
        initialize () override;

        void
        update () override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

      private:
        int current_file_number;

        double first_data_file_model_time;

        int first_data_file_number;

        bool decreasing_file_order;

        double data_file_time_step;

        double time_weight;

        bool time_dependent;

        std::string data_directory;

        std::string velocity_file_name;

        double velocity_scaling_factor;

        std::string point1;
        std::string point2;

        Tensor<1,2> pointone;
        Tensor<1,2> pointtwo;

        double lithosphere_thickness;

        std::unique_ptr<internal::GPlatesLookup<dim>> lookup;

        std::unique_ptr<internal::GPlatesLookup<dim>> old_lookup;

        void
        update_data (const bool load_both_files);

        void
        end_time_dependence ();

        std::string
        create_filename (const int timestep) const;
    };
  }
}


#endif