From c5748994f7d6e7a531db6f0064ef625d69d0a701 Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@kit.edu>
Date: Tue, 14 Mar 2023 19:02:52 +0100
Subject: [PATCH] some doxygen
---
corsika/detail/modules/fluka/InteractionModel.inl | 2 --
corsika/modules/fluka/InteractionModel.hpp | 14 ++++++++++++++
2 files changed, 14 insertions(+), 2 deletions(-)
diff --git a/corsika/detail/modules/fluka/InteractionModel.inl b/corsika/detail/modules/fluka/InteractionModel.inl
index 8983d3980..87f03804c 100644
--- a/corsika/detail/modules/fluka/InteractionModel.inl
+++ b/corsika/detail/modules/fluka/InteractionModel.inl
@@ -25,8 +25,6 @@
#include <corsika/framework/core/EnergyMomentumOperations.hpp>
#include <corsika/framework/core/PhysicalUnits.hpp>
-
-#include <FLUKA.hpp>
#include <corsika/modules/fluka/ParticleConversion.hpp>
namespace corsika::fluka {
diff --git a/corsika/modules/fluka/InteractionModel.hpp b/corsika/modules/fluka/InteractionModel.hpp
index 206319f85..9ba608aa7 100644
--- a/corsika/modules/fluka/InteractionModel.hpp
+++ b/corsika/modules/fluka/InteractionModel.hpp
@@ -21,11 +21,24 @@
#include <corsika/framework/random/RNGManager.hpp>
namespace corsika::fluka {
+ /**
+ * This class exposes the (hadronic) interactions of FLUKA. FLUKA needs to be
+ * initialized with a predefined set of target materials and a flag describing the type
+ * of interactions (elastic, inelastic, electromagnetic dissociation). Currently, only
+ * inelastic events are supported.
+ *
+ */
class InteractionModel {
public:
+ /**
+ * Create a new InteractionModel. The FLUKA materials are collected from the elements
+ * present in the environment. Each element is its own FLUKA material, no FLUKA
+ * compounds are used.
+ */
template <typename TEnvironment>
InteractionModel(TEnvironment const&);
+ //! Return the cross-section of a given combination of projectile/target.
CrossSectionType getCrossSection(Code projectileId, Code targetId,
FourMomentum const& projectileP4,
FourMomentum const& targetP4) const;
@@ -33,6 +46,7 @@ namespace corsika::fluka {
bool isValid(Code projectileID, Code targetID, HEPEnergyType sqrtS) const;
bool isValid(Code projectileID, int material, HEPEnergyType sqrtS) const;
+ //! convert target Code to FLUKA material number
int getMaterialIndex(Code targetID) const;
template <typename TSecondaryView>
--
GitLab