uniform_raw.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_UNIFORM_RAW_H
#define WORLD_BUILDER_FEATURES_PLUME_MODELS_VELOCITY_UNIFORM_RAW_H


#include "world_builder/features/plume_models/velocity/interface.h"
#include "world_builder/features/feature_utilities.h"
#include "world_builder/objects/surface.h"


namespace WorldBuilder
{

  namespace Features
  {
    using namespace FeatureUtilities;
    namespace PlumeModels
    {
      namespace Velocity
      {
        class UniformRaw final: public Interface
        {
          public:
            UniformRaw(WorldBuilder::World *world);

            ~UniformRaw() override final;

            static
            void declare_entries(Parameters &prm, const std::string &parent_name = "");

            void parse_entries(Parameters &prm) override final;


            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 override final;


          private:
            // uniform raw velocity submodule parameters
            double min_depth;
            double max_depth;
            std::array<double,3> velocity;
            Operations operation;

        };
      } // namespace Velocity
    } // namespace PlumeModels
  } // namespace Features
} // namespace WorldBuilder

#endif