ParticleCut.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 <unordered_map>

#include <corsika/framework/core/ParticleProperties.hpp>
#include <corsika/framework/core/PhysicalUnits.hpp>
#include <corsika/framework/process/SecondariesProcess.hpp>
#include <corsika/framework/process/ContinuousProcess.hpp>
#include <corsika/framework/core/Step.hpp>

#include <corsika/modules/writers/WriterOff.hpp>

namespace corsika {
  template <typename TOutput = WriterOff>
  class ParticleCut : public SecondariesProcess<ParticleCut<TOutput>>,
                      public ContinuousProcess<ParticleCut<TOutput>>,
                      public TOutput {

  public:
    template <typename... TArgs>
    ParticleCut(HEPEnergyType const eEleCut, HEPEnergyType const ePhoCut,
                HEPEnergyType const eHadCut, HEPEnergyType const eMuCut, bool const inv,
                TArgs&&... args);

    template <typename... TArgs>
    ParticleCut(HEPEnergyType const eCut, bool const inv, TArgs&&... OutputArgs);

    template <typename... TArgs>
    ParticleCut(std::unordered_map<Code const, HEPEnergyType const> const& eCuts,
                bool const inv, TArgs&&... outputArgs);

    template <typename TStackView>
    void doSecondaries(TStackView&);

    template <typename TParticle>
    ProcessReturn doContinuous(
        Step<TParticle>&,
        const bool limitFlag = false); // this is not used for ParticleCut

    template <typename TParticle, typename TTrajectory>
    LengthType getMaxStepLength(TParticle const&, TTrajectory const&) {
      return meter * std::numeric_limits<double>::infinity();
    }

    void printThresholds() const;

    HEPEnergyType getElectronKineticECut() const { return cut_electrons_; }
    HEPEnergyType getPhotonKineticECut() const { return cut_photons_; }
    HEPEnergyType getMuonKineticECut() const { return cut_muons_; }
    HEPEnergyType getHadronKineticECut() const { return cut_hadrons_; }

    YAML::Node getConfig() const override;

  private:
    bool checkCutParticle(Code const, HEPEnergyType const, TimeType const) const;

    bool isBelowEnergyCut(Code const, HEPEnergyType const) const;

  private:
    HEPEnergyType cut_electrons_;
    HEPEnergyType cut_photons_;
    HEPEnergyType cut_muons_;
    HEPEnergyType cut_hadrons_;
    bool doCutInv_;
    std::unordered_map<Code const, HEPEnergyType const> cuts_;
  }; // namespace corsika

} // namespace corsika

#include <corsika/detail/modules/ParticleCut.inl>