spherical.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_COORDINATE_SYSTEMS_SPHERICAL_H
#define WORLD_BUILDER_COORDINATE_SYSTEMS_SPHERICAL_H

#include "world_builder/coordinate_systems/interface.h"

#include <string>

namespace WorldBuilder
{

  namespace CoordinateSystems
  {
    //WB_REGISTER_COORDINATE_SYSTEM_HEADER(Spherical)

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

        ~Spherical() override final;

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

        void parse_entries(Parameters &prm) override final;


        CoordinateSystem natural_coordinate_system() const override final;

        DepthMethod depth_method() const override final;

        std::array<double,3> cartesian_to_natural_coordinates(const std::array<double,3> &position) const override final;

        std::array<double,3> natural_to_cartesian_coordinates(const std::array<double,3> &position) const override final;


        double distance_between_points_at_same_depth(const Point<3> &point_1, const Point<3> &point_2) const override final;

        virtual
        double max_model_depth() const override final;

        DepthMethod used_depth_method;

      private:
        double radius_sphere;
    };
  } // namespace CoordinateSystems
} // namespace WorldBuilder

#endif