world.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_WORLD_H
#define WORLD_BUILDER_WORLD_H

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

#include <random>

namespace WorldBuilder
{

  namespace Features
  {
    class Interface;
  } // namespace Features

  class World
  {
    public:
      World(std::string filename, bool has_output_dir = false, const std::string &output_dir = "", unsigned long random_number_seed = 1, const bool limit_debug_consistency_checks = true);

      ~World();


      static void declare_entries(Parameters &prm);

      void parse_entries(Parameters &prm);

      unsigned int properties_output_size(const std::vector<std::array<unsigned int,3>> &properties) const;

      std::vector<double> properties(const std::array<double, 2> &point,
                                     const double depth,
                                     const std::vector<std::array<unsigned int,3>> &properties) const;

      std::vector<double> properties(const std::array<double, 3> &point,
                                     const double depth,
                                     const std::vector<std::array<unsigned int,3>> &properties) const;

      double temperature(const std::array<double, 2> &point, const double depth) const;

      double temperature(const std::array<double, 3> &point, const double depth) const;

      [[deprecated("Replaced by a temperature function without the gravity. This function will be removed in future versions.")]]
      double temperature(const std::array<double, 2> &point, const double depth, const double gravity_norm) const;

      [[deprecated("Replaced by a temperature function without the gravity. This function will be removed in future versions.")]]
      double temperature(const std::array<double, 3> &point, const double depth, const double gravity_norm) const;

      double composition(const std::array<double, 2> &point, const double depth, const unsigned int composition_number) const;

      double composition(const std::array<double, 3> &point, const double depth, const unsigned int composition_number) const;

      WorldBuilder::grains grains(const std::array<double, 2> &point,
                                  const double depth,
                                  const unsigned int composition_number,
                                  size_t number_of_grains) const;

      WorldBuilder::grains grains(const std::array<double, 3> &point,
                                  const double depth,
                                  const unsigned int composition_number,
                                  size_t number_of_grains) const;
      Objects::PlaneDistances
      distance_to_plane(const std::array<double, 3> &point,
                        const double depth,
                        const std::string &name) const;

      int MPI_RANK;

      int MPI_SIZE;

      std::mt19937 &get_random_number_engine();

      Parameters parameters;

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

      Point<2> surface_coord_conversions;

      double potential_mantle_temperature;

      double surface_temperature;

      bool force_surface_temperature;

      double thermal_expansion_coefficient;

      double specific_heat;

      double thermal_diffusivity;

      double maximum_distance_between_coordinates;

      std::string interpolation;

      std::vector<std::string> feature_tags;

    private:
      unsigned int dim;


      std::mt19937 random_number_engine;

      bool limit_debug_consistency_checks;



  };
} // namespace WorldBuilder

#endif