interface.h

Go to the documentation of this file.

// ------------------------------------------------------
//
// SPDX-License-Identifier: GPL-2.0-or-later
//
// SPDX-FileCopyrightText: Copyright (C) 2013-2025 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_adiabatic_conditions_interface_h
#define _aspect_adiabatic_conditions_interface_h

#include <aspect/plugins.h>
#include <aspect/geometry_model/interface.h>
#include <aspect/simulator_access.h>
#include <deal.II/base/parameter_handler.h>
#include <deal.II/distributed/tria.h>


namespace aspect
{
  namespace AdiabaticConditions
  {
    template <int dim>
    class Interface: public SimulatorAccess<dim>, public Plugins::InterfaceBase
    {
      public:
        virtual
        bool
        is_initialized () const = 0;

        virtual
        double temperature (const Point<dim> &p) const = 0;

        virtual
        double pressure (const Point<dim> &p) const = 0;

        virtual
        double density (const Point<dim> &p) const = 0;

        virtual
        double density_derivative (const Point<dim> &p) const = 0;

        DEAL_II_DEPRECATED
        virtual
        void get_adiabatic_temperature_profile(std::vector<double> &values) const;

        DEAL_II_DEPRECATED
        virtual
        void get_adiabatic_pressure_profile(std::vector<double> &values) const;

        DEAL_II_DEPRECATED
        virtual
        void get_adiabatic_density_profile(std::vector<double> &values) const;

        DEAL_II_DEPRECATED
        virtual
        void get_adiabatic_density_derivative_profile(std::vector<double> &values) const;
    };


    template <int dim>
    void
    register_adiabatic_conditions (const std::string &name,
                                   const std::string &description,
                                   void (*declare_parameters_function) (ParameterHandler &),
                                   std::unique_ptr<Interface<dim>> (*factory_function) ());

    template <int dim>
    std::unique_ptr<Interface<dim>>
    create_adiabatic_conditions (ParameterHandler &prm);


    template <int dim>
    void
    declare_parameters (ParameterHandler &prm);


    template <int dim>
    void
    write_plugin_graph (std::ostream &output_stream);


#define ASPECT_REGISTER_ADIABATIC_CONDITIONS_MODEL(classname, name, description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_ADIABATIC_CONDITIONS_MODEL_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::AdiabaticConditions::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::AdiabaticConditions::register_adiabatic_conditions<2>, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::AdiabaticConditions::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::AdiabaticConditions::register_adiabatic_conditions<3>, \
                                name, description); \
  }
  }
}


#endif