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_PLUME_MODELS_VELOCITY_INTERFACE_H
#define WORLD_BUILDER_FEATURES_PLUME_MODELS_VELOCITY_INTERFACE_H


#include "world_builder/parameters.h"
#include "world_builder/objects/natural_coordinate.h"


namespace WorldBuilder
{
  class World;
  class Parameters;
  template <unsigned int dim> class Point;

  namespace Features
  {

    namespace PlumeModels
    {
      namespace Velocity
      {
        class ObjectFactory;

        class Interface
        {
          public:
            Interface();

            virtual
            ~Interface();

            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
            std::array<double,3> get_velocity(const Point<3> &position,
                                              const Objects::NaturalCoordinate &position_in_natural_coordinates,
                                              const double depth,
                                              const double gravity,
                                              std::array<double,3> velocity,
                                              const double feature_min_depth,
                                              const double feature_max_depth,
                                              const double relative_distance_from_center) const = 0;
            static void registerType(const std::string &name,
                                     void ( * /*declare_entries*/)(Parameters &, const std::string &),
                                     ObjectFactory *factory);


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

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

          protected:
            WorldBuilder::World *world;

            std::string 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 &)> &get_declare_map()
            {
              static std::map<std::string, void ( *)(Parameters &,const std::string &)> declares;
              return declares;
            }

        };


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

#define WB_REGISTER_FEATURE_PLUME_VELOCITY_MODEL(classname,name) \
  class classname##Factory : public ObjectFactory { \
    public: \
      classname##Factory() \
      { \
        Interface::registerType(#name, classname::declare_entries, 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 Velocity
    } // namespace PlumeModels
  } // namespace Features
} // namespace WorldBuilder

#endif