From 52625005dac25286bfd220ee6433289c8ac39f87 Mon Sep 17 00:00:00 2001
From: Maximilian Reininghaus <maximilian.reininghaus@kit.edu>
Date: Mon, 13 Jun 2022 16:41:18 +0200
Subject: [PATCH] brief documentation
---
corsika/modules/sibyll/InteractionModel.hpp | 13 +++++++++----
1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/corsika/modules/sibyll/InteractionModel.hpp b/corsika/modules/sibyll/InteractionModel.hpp
index 46de19fba..c5fc50087 100644
--- a/corsika/modules/sibyll/InteractionModel.hpp
+++ b/corsika/modules/sibyll/InteractionModel.hpp
@@ -15,11 +15,16 @@
#include <corsika/modules/sibyll/NuclearInteractionModel.hpp>
namespace corsika::sibyll {
+ /**
+ * This class combines sibyll::HadronInteractionModel, which can only handle hadron
+ * projectiles, and sibyll::NuclearInteractionModel, which can handle only nucleus
+ * projectile, into a single process. The getCrossSection() and doInteraction() methods
+ * forward to the underlying models, depending on the projectile type.
+ */
class InteractionModel {
public:
- using nuclear_model_type =
- NuclearInteractionModel<HadronInteractionModel>;
-
+ using nuclear_model_type = NuclearInteractionModel<HadronInteractionModel>;
+
template <typename TEnvironment>
InteractionModel(TEnvironment const&);
@@ -32,7 +37,7 @@ namespace corsika::sibyll {
HadronInteractionModel& getHadronInteractionModel();
HadronInteractionModel const& getHadronInteractionModel() const;
- nuclear_model_type& getNuclearInteractionModel();
+ nuclear_model_type& getNuclearInteractionModel();
nuclear_model_type const& getNuclearInteractionModel() const;
private:
--
GitLab