thermodynamic_table_lookup.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_material_model_equation_of_state_thermodynamic_table_lookup_h
#define _aspect_material_model_equation_of_state_thermodynamic_table_lookup_h

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


namespace aspect
{
  namespace MaterialModel
  {
    namespace EquationOfState
    {
      template <int dim>
      class ThermodynamicTableLookup : public ::aspect::SimulatorAccess<dim>
      {
        public:
          void
          initialize ();

          virtual unsigned int number_of_lookups() const;

          bool is_compressible () const;

          void
          evaluate(const MaterialModel::MaterialModelInputs<dim> &in,
                   std::vector<MaterialModel::EquationOfStateOutputs<dim>> &eos_outputs) const;

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

          static
          void
          declare_parameters (ParameterHandler &prm);

          void
          parse_parameters (ParameterHandler &prm);

          void
          create_additional_named_outputs (MaterialModel::MaterialModelOutputs<dim> &out) const;

          const MaterialModel::MaterialUtilities::Lookup::MaterialLookup &
          get_material_lookup (unsigned int lookup_index) const;


        private:
          unsigned int n_material_lookups;
          bool use_bilinear_interpolation;
          bool latent_heat;

          std::string data_directory;
          std::vector<std::string> material_file_names;
          std::vector<std::string> derivatives_file_names;

          unsigned int max_latent_heat_substeps;

          enum formats
          {
            perplex,
            hefesto
          };
          formats material_file_format;

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

          std::vector<std::string> unique_phase_names;

          std::vector<std::vector<unsigned int>> unique_phase_indices;

          std::vector<std::string> list_of_dominant_phases;

          std::vector<std::vector<unsigned int>> global_index_of_lookup_phase;

          void evaluate_thermal_enthalpy_derivatives(const MaterialModel::MaterialModelInputs<dim> &in,
                                                     std::vector<MaterialModel::EquationOfStateOutputs<dim>> &eos_outputs) const;

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

          void fill_seismic_velocities (const MaterialModel::MaterialModelInputs<dim> &in,
                                        const std::vector<double> &composite_densities,
                                        const std::vector<std::vector<double>> &volume_fractions,
                                        SeismicAdditionalOutputs<dim> &seismic_out) const;

          void fill_phase_volume_fractions (const MaterialModel::MaterialModelInputs<dim> &in,
                                            const std::vector<std::vector<double>> &volume_fractions,
                                            NamedAdditionalMaterialOutputs<dim> &phase_volume_fractions_out) const;

          void fill_dominant_phases (const MaterialModel::MaterialModelInputs<dim> &in,
                                     const std::vector<std::vector<double>> &volume_fractions,
                                     PhaseOutputs<dim> &dominant_phases_out) const;
      };
    }
  }
}

#endif