LayeredSphericalAtmosphereBuilder.hpp

/*
 * (c) Copyright 2020 CORSIKA Project, corsika-project@lists.kit.edu
 *
 * This software is distributed under the terms of the GNU General Public
 * Licence version 3 (GPL Version 3). See file LICENSE for a full version of
 * the license.
 */

#pragma once

#include <corsika/framework/core/PhysicalUnits.hpp>
#include <corsika/framework/geometry/Point.hpp>
#include <corsika/media/Environment.hpp>
#include <corsika/media/IMediumModel.hpp>
#include <corsika/media/NuclearComposition.hpp>
#include <corsika/media/VolumeTreeNode.hpp>

// for detail namespace, NoExtraModelInner, NoExtraModel and traits
#include <corsika/detail/media/LayeredSphericalAtmosphereBuilder.hpp>

#include <memory>
#include <stack>
#include <tuple>
#include <type_traits>
#include <functional>

namespace corsika {

  template <typename TMediumInterface = IMediumModel,
            template <typename> typename MExtraEnvirnoment = detail::NoExtraModel>
  struct make_layered_spherical_atmosphere_builder;

  template <typename TMediumInterface = IMediumModel,
            template <typename> typename TMediumModelExtra = detail::NoExtraModel,
            typename... TModelArgs>
  class LayeredSphericalAtmosphereBuilder {

    LayeredSphericalAtmosphereBuilder() = delete;
    LayeredSphericalAtmosphereBuilder(const LayeredSphericalAtmosphereBuilder&) = delete;
    LayeredSphericalAtmosphereBuilder(const LayeredSphericalAtmosphereBuilder&&) = delete;
    LayeredSphericalAtmosphereBuilder& operator=(
        const LayeredSphericalAtmosphereBuilder&) = delete;

    // friend, to allow construction
    template <typename, template <typename> typename>
    friend struct make_layered_spherical_atmosphere_builder;

  protected:
    LayeredSphericalAtmosphereBuilder(TModelArgs... args, Point const& center,
                                      LengthType const planetRadius)
        : center_(center)
        , planetRadius_(planetRadius)
        , additionalModelArgs_{args...} {}

  public:
    typedef typename VolumeTreeNode<TMediumInterface>::VTN_type volume_tree_node;
    typedef typename VolumeTreeNode<TMediumInterface>::VTNUPtr volume_tree_node_uptr;

    void setNuclearComposition(NuclearComposition const& composition);
    volume_tree_node* addExponentialLayer(GrammageType const b,
                                          LengthType const scaleHeight,
                                          LengthType const upperBoundary);
    void addLinearLayer(GrammageType const b, LengthType const scaleHeight,
                        LengthType const upperBoundary);

    void addTabularLayer(std::function<MassDensityType(LengthType)> const& funcRho,
                         unsigned int const nBins, LengthType const deltaHeight,
                         LengthType const upperBoundary);

    int getSize() const { return layers_.size(); }

    void assemble(Environment<TMediumInterface>& env);
    Environment<TMediumInterface> assemble();

    LengthType getPlanetRadius() const { return planetRadius_; }

  private:
    void checkRadius(LengthType const r) const;

    std::unique_ptr<NuclearComposition> composition_;
    Point center_;
    LengthType previousRadius_{LengthType::zero()};
    LengthType planetRadius_;
    std::tuple<TModelArgs...> const additionalModelArgs_;

    std::stack<volume_tree_node_uptr> layers_; // innermost layer first

  }; // end class LayeredSphericalAtmosphereBuilder

} // namespace corsika

#include <corsika/detail/media/LayeredSphericalAtmosphereBuilder.inl>