SAVANI_perturbation.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_initial_temperature_SAVANI_perturbation_h
#define _aspect_initial_temperature_SAVANI_perturbation_h
 
#include <aspect/initial_temperature/interface.h>
#include <aspect/utilities.h>
 
namespace aspect
{
  namespace InitialTemperature
  {
    namespace internal
    {
      namespace SAVANI
      {
        class SphericalHarmonicsLookup;
        class SplineDepthsLookup;
      }
    }
 
    template <int dim>
    class SAVANIPerturbation : public Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        SAVANIPerturbation ();
 
 
        void
        initialize () override;
 
        //TODO
        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::SAVANI::SphericalHarmonicsLookup> spherical_harmonics_lookup;
 
        std::unique_ptr<internal::SAVANI::SplineDepthsLookup> spline_depths_lookup;
 
        aspect::Utilities::AsciiDataProfile<dim> profile;
 
        unsigned int vs_to_density_index;
 
        bool use_material_model_thermal_alpha;
 
    };
 
  }
}
 
#endif