interface.h

Go to the documentation of this file.

/*
  Copyright (C) 2018-2024 by the authors of the World Builder code.

  This file is part of the World Builder.

   This program is free software: you can redistribute it and/or modify
   it under the terms of the GNU Lesser General Public License as published
   by the Free Software Foundation, either version 2 of the License, or
   (at your option) any later version.

   This program 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 Lesser General Public License for more details.

   You should have received a copy of the GNU Lesser General Public License
   along with this program.  If not, see <https://www.gnu.org/licenses/>.
*/

#ifndef WORLD_BUILDER_FEATURES_INTERFACE_H
#define WORLD_BUILDER_FEATURES_INTERFACE_H


#include "world_builder/grains.h"
#include "world_builder/utilities.h"
#include "world_builder/objects/distance_from_surface.h"

namespace WorldBuilder
{
  class World;
  class Parameters;


  namespace Features
  {
    class ObjectFactory;

    class Interface
    {
      public:
        Interface();

        virtual
        ~Interface();

        void
        get_coordinates(const std::string &name,
                        Parameters &prm,
                        const CoordinateSystem coordinate_system);

        static
        void declare_entries(Parameters &prm,
                             const std::string &parent_name,
                             const std::vector<std::string> &required_entries);

        virtual
        void parse_entries(Parameters &prm) = 0;


        virtual
        void properties(const Point<3> &position_in_cartesian_coordinates,
                        const Objects::NaturalCoordinate &position_in_natural_coordinates,
                        const double depth,
                        const std::vector<std::array<unsigned int,3>> &properties,
                        const double gravity,
                        const std::vector<size_t> &entry_in_output,
                        std::vector<double> &output) const = 0;

        static void registerType(const std::string &name,
                                 void ( * /*declare_entries*/)(Parameters &, const std::string &, const std::vector<std::string> &required_entries),
                                 void ( *make_snippet)(Parameters &),
                                 ObjectFactory *factory);

        std::string get_name() const
        {
          return name;
        };


        static std::unique_ptr<Interface> create(const std::string &name, WorldBuilder::World *world);

        virtual
        Objects::PlaneDistances
        distance_to_feature_plane(const Point<3> &position_in_cartesian_coordinates,
                                  const Objects::NaturalCoordinate &position_in_natural_coordinates,
                                  const double depth) const;


      protected:
        WorldBuilder::World *world;

        std::string name;

        size_t tag_index;

        WorldBuilder::Utilities::InterpolationType interpolation_type;

        std::size_t original_number_of_coordinates;

        std::vector<Point<2> > coordinates;

        WorldBuilder::Objects::BezierCurve bezier_curve;


        std::string temperature_submodule_name;

        std::string composition_submodule_name;


      private:
        static std::map<std::string, ObjectFactory *> &get_factory_map()
        {
          static std::map<std::string, ObjectFactory *> factories;
          return factories;
        }

        static std::map<std::string, void ( *)(Parameters &,
                                               const std::string &,
                                               const std::vector<std::string>& required_entries)> &get_declare_map()
        {
          static std::map<std::string, void ( *)(Parameters &,
                                                 const std::string &,
                                                 const std::vector<std::string>& required_entries)> declares;
          return declares;
        }

        static std::map<std::string, void ( *)(Parameters &)> &get_snippet_map()
        {
          static std::map<std::string, void ( *)(Parameters &)> declares;
          return declares;
        }
    };


    class ObjectFactory
    {
      public:
        virtual std::unique_ptr<Interface> create(World *world) = 0;
    };

#define WB_REGISTER_FEATURE(classname,name) \
  class classname##Factory : public ObjectFactory { \
    public: \
      classname##Factory() \
      { \
        Interface::registerType(#name, classname::declare_entries, classname::make_snippet, this); \
      } \
      std::unique_ptr<Interface> create(World *world) override final { \
        return std::unique_ptr<Interface>(new classname(world)); \
      } \
  }; \
  static classname##Factory global_##classname##Factory;

  } // namespace Features
} // namespace WorldBuilder

#endif