plume.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_H
#define WORLD_BUILDER_FEATURES_PLUME_H


#include "world_builder/features/interface.h"
#include "world_builder/objects/surface.h"


namespace WorldBuilder
{
  class Parameters;
  class World;

  namespace Features
  {
    namespace PlumeModels
    {
      namespace Composition
      {
        class Interface;
      }  // namespace Composition
      namespace Grains
      {
        class Interface;
      }  // namespace Grains
      namespace Temperature
      {
        class Interface;
      }  // namespace Temperature
      namespace Velocity
      {
        class Interface;
      }  // namespace Velocity
    }  // namespace PlumeModels

    class Plume final: public Interface
    {
      public:
        Plume(WorldBuilder::World *world);

        ~Plume() override final;

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

        static
        void make_snippet(Parameters &prm);

        void parse_entries(Parameters &prm) override final;


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

      private:
        std::vector<std::unique_ptr<Features::PlumeModels::Temperature::Interface> > temperature_models;

        std::vector<std::unique_ptr<Features::PlumeModels::Composition::Interface> > composition_models;

        std::vector<std::unique_ptr<Features::PlumeModels::Velocity::Interface> > velocity_models;

        std::vector<std::unique_ptr<Features::PlumeModels::Grains::Interface> > grains_models;


        double min_depth;
        double max_depth;

        std::vector<double> depths;
        std::vector<double> semi_major_axis_lengths;
        std::vector<double> eccentricities;
        std::vector<double> rotation_angles;
    };


  } // namespace Features
} // namespace WorldBuilder

#endif