IAP GITLAB

Skip to content
Snippets Groups Projects
Commit c5748994 authored by Maximilian Reininghaus's avatar Maximilian Reininghaus :vulcan:
Browse files

some doxygen

parent 96729f9f
No related branches found
No related tags found
1 merge request!468Resolve "Add FLUKA"
...@@ -25,8 +25,6 @@ ...@@ -25,8 +25,6 @@
#include <corsika/framework/core/EnergyMomentumOperations.hpp> #include <corsika/framework/core/EnergyMomentumOperations.hpp>
#include <corsika/framework/core/PhysicalUnits.hpp> #include <corsika/framework/core/PhysicalUnits.hpp>
#include <FLUKA.hpp>
#include <corsika/modules/fluka/ParticleConversion.hpp> #include <corsika/modules/fluka/ParticleConversion.hpp>
namespace corsika::fluka { namespace corsika::fluka {
......
...@@ -21,11 +21,24 @@ ...@@ -21,11 +21,24 @@
#include <corsika/framework/random/RNGManager.hpp> #include <corsika/framework/random/RNGManager.hpp>
namespace corsika::fluka { 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 { class InteractionModel {
public: 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> template <typename TEnvironment>
InteractionModel(TEnvironment const&); InteractionModel(TEnvironment const&);
//! Return the cross-section of a given combination of projectile/target.
CrossSectionType getCrossSection(Code projectileId, Code targetId, CrossSectionType getCrossSection(Code projectileId, Code targetId,
FourMomentum const& projectileP4, FourMomentum const& projectileP4,
FourMomentum const& targetP4) const; FourMomentum const& targetP4) const;
...@@ -33,6 +46,7 @@ namespace corsika::fluka { ...@@ -33,6 +46,7 @@ namespace corsika::fluka {
bool isValid(Code projectileID, Code targetID, HEPEnergyType sqrtS) const; bool isValid(Code projectileID, Code targetID, HEPEnergyType sqrtS) const;
bool isValid(Code projectileID, int material, HEPEnergyType sqrtS) const; bool isValid(Code projectileID, int material, HEPEnergyType sqrtS) const;
//! convert target Code to FLUKA material number
int getMaterialIndex(Code targetID) const; int getMaterialIndex(Code targetID) const;
template <typename TSecondaryView> template <typename TSecondaryView>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment