Skip to content
This repository was archived by the owner on May 6, 2024. It is now read-only.

Commit f4202a0

Browse files
reword documentation of what "DB material Z" is
1 parent 105f2c3 commit f4202a0

1 file changed

Lines changed: 14 additions & 3 deletions

File tree

include/SimCore/UserEventInformation.h

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,20 @@ class UserEventInformation : public G4VUserEventInformation {
2525
void decBremCandidateCount() { bremCandidateCount_ -= 1; }
2626

2727
/**
28-
* Set the elemental Z in which the dark brem ocurred
28+
* Set the Z of the element in which the dark brem ocurred
2929
*
30-
* @param[in] z elemental z in which the dark brem ocurred
30+
* @param[in] z atomic Z of element in which the dark brem ocurred
3131
*/
3232
void setDarkBremMaterialZ(double z) { db_material_z_ = z; }
3333

34+
/**
35+
* Get the Z of the element in which the dark brem ocurred
36+
*
37+
* @note This will return -1 if no dark brem ocurred within
38+
* this event.
39+
*
40+
* @param[in] z atomic Z of element in which the dark brem ocurred
41+
*/
3442
double getDarkBremMaterialZ() const { return db_material_z_; }
3543

3644
/**
@@ -151,7 +159,10 @@ class UserEventInformation : public G4VUserEventInformation {
151159
bool last_step_en_{false};
152160

153161
/**
154-
* elemental z in which dark brem occurred (-1 if didn't happen)
162+
* atomic Z of the element in which dark brem occurred (-1 if didn't happen)
163+
*
164+
* The default is -1. and so will provide unphysical results if the
165+
* dark brem did not occur within the event in question.
155166
*/
156167
double db_material_z_{-1.};
157168
};

0 commit comments

Comments
 (0)