smooth.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_fault_composition_smooth_h
#define _world_builder_features_fault_composition_smooth_h

#include <world_builder/features/fault_models/composition/interface.h>
#include <world_builder/features/feature_utilities.h>
#include <world_builder/world.h>


namespace WorldBuilder
{
  namespace Features
  {
    using namespace FeatureUtilities;
    namespace FaultModels
    {
      namespace Composition
      {
        class Smooth: public Interface
        {
          public:
            Smooth(WorldBuilder::World *world);

            ~Smooth();

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

            void parse_entries(Parameters &prm) override final;


            double get_composition(const Point<3> &position,
                                   const double depth,
                                   const unsigned int composition_number,
                                   double composition,
                                   const double feature_min_depth,
                                   const double feature_max_depth,
                                   const WorldBuilder::Utilities::PointDistanceFromCurvedPlanes &distance_from_planes,
                                   const AdditionalParameters &additional_parameters) const override final;

          private:
            // linear temperature submodule parameters
            double min_distance;
            double side_distance;
            std::vector<double> center_fraction;
            // currently not using the side composition, but maybe useful if you want another composition towards the end
            std::vector<double> side_fraction;
            std::vector<unsigned int> compositions;
            Operations operation;

        };
      }
    }
  }
}

#endif