compositing.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_compositing_h
#define _aspect_material_model_compositing_h

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

#include <map>
#include <vector>


namespace aspect
{
  namespace MaterialModel
  {
    namespace Property
    {
      enum MaterialProperty
      {
        viscosity,
        density,
        thermal_expansion_coefficient,
        specific_heat,
        thermal_conductivity,
        compressibility,
        entropy_derivative_pressure,
        entropy_derivative_temperature,
        reaction_terms
      };
    }

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

        void
        evaluate (const typename Interface<dim>::MaterialModelInputs &in,
                  typename Interface<dim>::MaterialModelOutputs &out) const override;

        void
        create_additional_named_outputs (typename Interface<dim>::MaterialModelOutputs &outputs) const override;

        static void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;

        bool is_compressible () const override;

        const Interface<dim> &
        get_model_for_property(const Property::MaterialProperty property) const;


      private:
        void
        copy_required_properties(const unsigned int model_index,
                                 const typename Interface<dim>::MaterialModelOutputs &base_output,
                                 typename Interface<dim>::MaterialModelOutputs &out) const;

        std::map<Property::MaterialProperty, unsigned int> model_property_map;

        std::vector<std::string>                             model_names;
        std::vector<std::unique_ptr<Interface<dim>>> models;
    };


    template <typename TestType, int dim>
    inline
    bool
    material_model_matches_or_uses (const MaterialModel::Interface<dim> &plugin,
                                    const Property::MaterialProperty property)
    {
      // Direct match
      if (Plugins::plugin_type_matches<TestType>(plugin))
        return true;

      // Search inside compositing material model
      if (const auto *compositing =
            dynamic_cast<const MaterialModel::Compositing<dim> *>(&plugin))
        {
          const auto &submodel = compositing->get_model_for_property(property);
          if (Plugins::plugin_type_matches<TestType>(submodel))
            return true;
        }

      return false;
    }


    template <typename TestType, int dim>
    inline
    const TestType &
    get_material_model_matches_or_uses (const MaterialModel::Interface<dim> &plugin,
                                        const Property::MaterialProperty property)
    {
      // Direct match
      if (Plugins::plugin_type_matches<TestType>(plugin))
        return Plugins::get_plugin_as_type<TestType>(plugin);

      // Search inside compositing material model
      if (const auto *compositing =
            dynamic_cast<const MaterialModel::Compositing<dim> *>(&plugin))
        {
          const auto &submodel = compositing->get_model_for_property(property);
          return Plugins::get_plugin_as_type<TestType>(submodel);
        }

      AssertThrow(false,
                  ExcMessage("Could not find requested plugin type."));

      return *static_cast<const TestType *>(nullptr);
    }

  }
}

#endif