Skip to content

Commit

Permalink
add rational for existence of energy function
Browse files Browse the repository at this point in the history
explain in doxygen comment why this function exists basically copying the rational written for the produce function as well.
  • Loading branch information
tomeichlersmith committed Oct 11, 2023
1 parent b4a72c4 commit 7047cba
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions DQM/src/DQM/DarkBremInteraction.cxx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ namespace dqm {
/**
* calculate total energy from 3-momentum and mass
*
* Since the dark brem model does not include a nucleus, it only is able to
* conserve momentum, so we need to reconstruct the incident particle's 3-momentum
* and then use the known particle mass to calculate its total energy.
*
* @param[in] p 3-momentum
* @param[in] m mass
* @return total energy
Expand Down

0 comments on commit 7047cba

Please sign in to comment.