entropy_model.h

Go to the documentation of this file.

/*
  Copyright (C) 2016 - 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_material_model_entropy_model_h
#define _aspect_material_model_entropy_model_h

#include <aspect/material_model/interface.h>

#include <aspect/utilities.h>
#include <aspect/simulator_access.h>
#include <aspect/material_model/thermal_conductivity/interface.h>
#include <aspect/material_model/rheology/ascii_depth_profile.h>
#include <aspect/material_model/rheology/drucker_prager.h>
#include <aspect/material_model/steinberger.h>
#include <aspect/material_model/utilities.h>

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

        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;

        mutable boost::signals2::signal<void (const SimulatorAccess<dim> &,
                                              const unsigned int iteration_count)> post_multicomponent_equilibrium;

      private:

        double angle_of_internal_friction;
        double cohesion;

        double multicomponent_max_iteration;
        double multicomponent_tolerance;

        double min_eta;
        double max_eta;
        double max_lateral_eta_variation;

        std::unique_ptr<ThermalConductivity::Interface<dim>> thermal_conductivity;

        double  equilibrate_temperature (const std::vector<double> &temperature,
                                         const std::vector<double> &chemical_composition,
                                         const std::vector<double> &entropy,
                                         const std::vector<double> &specific_heat,
                                         const double pressure,
                                         std::vector<double> &composition_equilibrated_S) const;
        std::string data_directory;
        std::vector<std::string> material_file_names;
        std::string lateral_viscosity_file_name;

        std::vector<std::unique_ptr<MaterialUtilities::Lookup::EntropyReader>> entropy_reader;

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

        Rheology::DruckerPrager<dim> drucker_prager_plasticity;

        std::unique_ptr<Rheology::AsciiDepthProfile<dim>> depth_dependent_rheology;
    };
  }
}

#endif