S40RTS_perturbation.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2011-2026 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_initial_temperature_S40RTS_perturbation_h
#define _aspect_initial_temperature_S40RTS_perturbation_h

#include <aspect/initial_temperature/interface.h>
#include <aspect/utilities.h>

namespace aspect
{
  namespace InitialTemperature
  {
    namespace internal
    {
      namespace S40RTS
      {
        class SphericalHarmonicsLookup
        {
          public:
            SphericalHarmonicsLookup(const std::string &filename,
                                     const MPI_Comm comm);

            const std::vector<double> &
            cos_coeffs() const;

            const std::vector<double> &
            sin_coeffs() const;

            unsigned int maxdegree() const;

          private:
            unsigned int order;
            std::vector<double> a_lm;
            std::vector<double> b_lm;
        };

        class SplineDepthsLookup
        {
          public:
            SplineDepthsLookup(const std::string &filename,
                               const MPI_Comm comm);

            const std::vector<double> &
            spline_depths() const;

          private:
            std::vector<double> depths;
        };
      }
    }

    template <int dim>
    class PatchOnS40RTS;


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

        void
        initialize () override;

        virtual
        double get_Vs (const Point<dim> &position) const;

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

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

      private:

        enum VsToDensityMethod
        {
          file,
          constant
        };

        VsToDensityMethod vs_to_density_method;

        std::string data_directory;
        std::string spline_depth_file_name;

        std::string harmonics_coeffs_file_name;

        double vs_to_density_constant;
        double thermal_alpha;
        double no_perturbation_depth;

        bool zero_out_degree_0;

        bool lower_max_degree;

        unsigned int specified_max_degree;

        double reference_temperature;

        std::unique_ptr<internal::S40RTS::SphericalHarmonicsLookup> spherical_harmonics_lookup;

        std::unique_ptr<internal::S40RTS::SplineDepthsLookup> spline_depths_lookup;

        aspect::Utilities::AsciiDataProfile<dim> profile;

        unsigned int vs_to_density_index;

        bool use_material_model_thermal_alpha;

        template <int dim2> friend class PatchOnS40RTS;
    };

  }
}

#endif