steinberger.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_material_model_steinberger_h
#define _aspect_material_model_steinberger_h

#include <aspect/material_model/interface.h>
#include <aspect/material_model/equation_of_state/thermodynamic_table_lookup.h>

#include <aspect/simulator_access.h>
#include <deal.II/fe/component_mask.h>

namespace aspect
{
  namespace MaterialModel
  {
    using namespace dealii;

    namespace internal
    {
      class LateralViscosityLookup
      {
        public:
          LateralViscosityLookup(const std::string &filename,
                                 const MPI_Comm comm);

          double lateral_viscosity(double depth) const;

          int get_nslices() const;
        private:
          std::vector<double> values;

          double min_depth;
          double delta_depth;
          double max_depth;
      };

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

          double radial_viscosity(double depth) const;

        private:
          std::vector<double> values;

          double min_depth;
          double delta_depth;
          double max_depth;
      };
    }

    template <int dim>
    class Steinberger: public MaterialModel::Interface<dim>, public ::aspect::SimulatorAccess<dim>
    {
      public:
        void
        initialize () override;

        void update() override;

        virtual double viscosity (const double                  temperature,
                                  const double                  pressure,
                                  const std::vector<double>    &compositional_fields,
                                  const SymmetricTensor<2,dim> &strain_rate,
                                  const Point<dim>             &position) const;
        bool is_compressible () const override;
        void
        evaluate(const MaterialModel::MaterialModelInputs<dim> &in,
                 MaterialModel::MaterialModelOutputs<dim> &out) const override;

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;
        void
        create_additional_named_outputs (MaterialModel::MaterialModelOutputs<dim> &out) const override;


      private:
        double thermal_conductivity (const double temperature,
                                     const double pressure,
                                     const Point<dim> &position) const;

        bool has_background_field;

        std::unique_ptr<ComponentMask> composition_mask;

        EquationOfState::ThermodynamicTableLookup<dim> equation_of_state;

        bool use_lateral_average_temperature;

        double thermal_conductivity_value;

        enum ConductivityFormulation
        {
          constant,
          p_T_dependent
        } conductivity_formulation;

        std::vector<double> conductivity_transition_depths;
        std::vector<double> reference_thermal_conductivities;
        std::vector<double> conductivity_pressure_dependencies;
        std::vector<double> conductivity_reference_temperatures;
        std::vector<double> conductivity_exponents;
        std::vector<double> saturation_scaling;
        double maximum_conductivity;

        std::vector<double> viscosity_prefactors;
        MaterialUtilities::CompositionalAveragingOperation viscosity_averaging_scheme;

        std::vector<double> average_temperature;
        unsigned int n_lateral_slices;

        double min_eta;
        double max_eta;
        double max_lateral_eta_variation;

        std::string data_directory;
        std::string radial_viscosity_file_name;
        std::string lateral_viscosity_file_name;

        std::unique_ptr<internal::LateralViscosityLookup> lateral_viscosity_lookup;

        std::unique_ptr<internal::RadialViscosityLookup> radial_viscosity_lookup;

        void fill_prescribed_outputs (const unsigned int i,
                                      const std::vector<double> &volume_fractions,
                                      const MaterialModel::MaterialModelInputs<dim> &in,
                                      MaterialModel::MaterialModelOutputs<dim> &out) const;

    };
  }
}

#endif