grain_size.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2014-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_material_model_grain_size_h
#define _aspect_material_model_grain_size_h

#include <aspect/material_model/interface.h>
#include <aspect/material_model/reaction_model/grain_size_evolution.h>

#include <aspect/material_model/utilities.h>
#include <aspect/simulator_access.h>
#include <aspect/material_model/rheology/drucker_prager.h>

#include <deal.II/matrix_free/fe_point_evaluation.h>

#include <array>

namespace aspect
{
  namespace MaterialModel
  {
    template <int dim>
    class DislocationViscosityOutputs : public NamedAdditionalMaterialOutputs<dim>
    {
      public:
        DislocationViscosityOutputs(const unsigned int n_points);

        std::vector<double> get_nth_output(const unsigned int idx) const override;

        std::vector<double> dislocation_viscosities;

        std::vector<double> diffusion_viscosities;
    };



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

        bool is_compressible () const override;

        void evaluate(const typename Interface<dim>::MaterialModelInputs &in,
                      typename Interface<dim>::MaterialModelOutputs &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;

        double enthalpy (const double      temperature,
                         const double      pressure,
                         const std::vector<double> &compositional_fields,
                         const Point<dim> &position) const;

        std::array<std::pair<double, unsigned int>,2>
        enthalpy_derivative (const typename Interface<dim>::MaterialModelInputs &in) const;

      private:
        double reference_rho;
        double reference_T;
        double eta;
        double thermal_alpha;
        double reference_specific_heat;

        double reference_compressibility;

        double k_value;

        double dislocation_viscosity_iteration_threshold;
        unsigned int dislocation_viscosity_iteration_number;
        std::vector<double> dislocation_creep_exponent;
        std::vector<double> dislocation_activation_energy;
        std::vector<double> dislocation_activation_volume;
        std::vector<double> dislocation_creep_prefactor;
        std::vector<double> diffusion_creep_exponent;
        std::vector<double> diffusion_activation_energy;
        std::vector<double> diffusion_activation_volume;
        std::vector<double> diffusion_creep_prefactor;
        std::vector<double> diffusion_creep_grain_size_exponent;

        double max_temperature_dependence_of_eta;
        double min_eta;
        double max_eta;
        double min_specific_heat;
        double max_specific_heat;
        double min_thermal_expansivity;
        double max_thermal_expansivity;
        unsigned int max_latent_heat_substeps;
        double minimum_grain_size;

        double diffusion_viscosity (const double temperature,
                                    const double adiabatic_temperature,
                                    const double adiabatic_pressure,
                                    const double grain_size,
                                    const double second_strain_rate_invariant,
                                    const unsigned int phase_index) const;

        double dislocation_viscosity (const double temperature,
                                      const double adiabatic_temperature,
                                      const double adiabatic_pressure,
                                      const SymmetricTensor<2,dim> &strain_rate,
                                      const unsigned int phase_index,
                                      const double diffusion_viscosity,
                                      const double viscosity_guess = 0) const;

        double density (const double temperature,
                        const double pressure,
                        const std::vector<double> &compositional_fields,
                        const Point<dim> &position) const;

        double compressibility (const double temperature,
                                const double pressure,
                                const std::vector<double> &compositional_fields,
                                const Point<dim> &position) const;

        double specific_heat (const double temperature,
                              const double pressure,
                              const std::vector<double> &compositional_fields,
                              const Point<dim> &position) const;

        double thermal_expansion_coefficient (const double      temperature,
                                              const double      pressure,
                                              const std::vector<double> &compositional_fields,
                                              const Point<dim> &position) const;

        double seismic_Vp (const double      temperature,
                           const double      pressure,
                           const std::vector<double> &compositional_fields,
                           const Point<dim> &position) const;

        double seismic_Vs (const double      temperature,
                           const double      pressure,
                           const std::vector<double> &compositional_fields,
                           const Point<dim> &position) const;


        unsigned int
        get_phase_index (const MaterialUtilities::PhaseFunctionInputs<dim> &in) const;


        std::vector<unsigned int> n_phase_transitions;

        std::shared_ptr<MaterialUtilities::PhaseFunction<dim>> phase_function;


        std::string datadirectory;
        std::vector<std::string> material_file_names;
        std::vector<std::string> derivatives_file_names;
        unsigned int n_material_data;
        bool use_table_properties;
        bool use_enthalpy;
        bool use_bilinear_interpolation;


        enum formats
        {
          perplex,
          hefesto
        };
        formats material_file_format;

        std::vector<std::unique_ptr<MaterialModel::MaterialUtilities::Lookup::MaterialLookup>> material_lookup;

        mutable std::unique_ptr<FEPointEvaluation<1, dim>> temperature_evaluator;
        mutable std::unique_ptr<FEPointEvaluation<1, dim>> pressure_evaluator;

        /*
         * Object for computing plastic stresses, viscosities, and additional outputs,
         * as well as an object for the required input parameters.
         *
         * This variable is read from the parameter file through a parameter called 'Use Drucker-Prager rheology'.
         */
        bool enable_drucker_prager_rheology;
        bool use_adiabatic_pressure_for_yielding;
        Rheology::DruckerPrager<dim> drucker_prager_plasticity;
        Rheology::DruckerPragerParameters drucker_prager_parameters;

        std::unique_ptr<ReactionModel::GrainSizeEvolution<dim>> grain_size_evolution;
    };

  }
}

#endif