interface.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_prescribed_solution_interface_h
#define _aspect_prescribed_solution_interface_h

#include <aspect/plugins.h>
#include <aspect/simulator_access.h>

#include <deal.II/base/point.h>
#include <deal.II/base/parameter_handler.h>

#include <boost/core/demangle.hpp>
#include <typeinfo>


namespace aspect
{
  namespace PrescribedSolution
  {
    template <int dim>
    class Interface : public Plugins::InterfaceBase
    {
      public:
        virtual
        void constrain_solution (const typename DoFHandler<dim>::active_cell_iterator &cell,
                                 const std::vector<Point<dim>> &positions,
                                 const std::vector<unsigned int> &component_indices,
                                 std::vector<bool> &should_be_constrained,
                                 std::vector<double> &solution) = 0;
    };

    template <int dim>
    class Manager : public Plugins::ManagerBase<Interface<dim>>, public SimulatorAccess<dim>
    {
      public:
        DeclException1 (ExcPrescribedSolutionNameNotFound,
                        std::string,
                        << "Could not find entry <"
                        << arg1
                        << "> among the names of registered prescribed solution objects.");

        void constrain_solution (AffineConstraints<double> &current_constraints) const;

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

        static
        void
        write_plugin_graph (std::ostream &output_stream);

        static
        void
        declare_parameters (ParameterHandler &prm);

        void
        parse_parameters (ParameterHandler &prm) override;
    };


    template <int dim>
    std::string
    get_valid_model_names_pattern ();

#define ASPECT_REGISTER_PRESCRIBED_SOLUTION(classname,name,description) \
  template class classname<2>; \
  template class classname<3>; \
  namespace ASPECT_REGISTER_PRESCRIBED_SOLUTION_ ## classname \
  { \
    aspect::internal::Plugins::RegisterHelper<aspect::PrescribedSolution::Interface<2>,classname<2>> \
    dummy_ ## classname ## _2d (&aspect::PrescribedSolution::Manager<2>::register_prescribed_solution_plugin, \
                                name, description); \
    aspect::internal::Plugins::RegisterHelper<aspect::PrescribedSolution::Interface<3>,classname<3>> \
    dummy_ ## classname ## _3d (&aspect::PrescribedSolution::Manager<3>::register_prescribed_solution_plugin, \
                                name, description); \
  }
  }
}


#endif