celeritas::SDSetupOptions Struct Reference

Control options for initializing Celeritas SD callbacks. More...

#include <SetupOptions.hh>

Classes
struct	StepPoint

Public Member Functions
	operator bool () const
	True if SD is enabled.

Public Attributes
bool	enabled {true}
	Call back to Geant4 sensitive detectors.
bool	ignore_zero_deposition {true}
	Skip steps that do not deposit energy locally.
bool	energy_deposition {true}
	Save energy deposition.
bool	locate_touchable {true}
	Set TouchableHandle for PreStepPoint.
bool	track {true}
	Create a track with the dynamic particle type and post-step data.
StepPoint	pre
	Options for saving and converting beginning-of-step data.
StepPoint	post
	Options for saving and converting end-of-step data.
std::unordered_set< G4LogicalVolume const * >	force_volumes
	Manually list LVs that don't have an SD on the master thread.
std::unordered_set< G4LogicalVolume const * >	skip_volumes
	List LVs that should not have automatic hit mapping.

Detailed Description

Control options for initializing Celeritas SD callbacks.

By default, Celeritas connects to Geant4 sensitive detectors so that it reconstructs full-fidelity hits with all available step information.

• If your problem has no SDs, you must set enabled to false.
• By default, steps that do not deposit energy do not generate any hits.
• To improve performance and memory usage, determine what quantities (time, position, direction, touchable, ...) are required by your setup's sensitive detectors and set all other attributes to false.
• Reconstructing the full geometry status using locate_touchable is the most expensive detector option. Disable it unless your SDs require (e.g.) the volume's copy number to locate a detector submodule.
• Some reconstructed track attributes (such as post-step material) are currently never set because they are rarely used in practice. Contact the Celeritas team or submit a pull request to add this functionality.

Various attributes on the step, track, and pre/post step points may be available depending on the selected options.

• Disabling track will leave G4Step::GetTrack as nullptr .
• Enabling track will set the Charge attribute on the pre-step.
• Requested post-step data including GlobalTime, Position, KineticEnergy, and MomentumDirection will be copied to the Track when the combination of options is enabled.
• Some pre-step properties (Material and MaterialCutsCouple, and sensitive detector) are always updated. Post-step values for those are not set.
• Track and Parent IDs will never be a valid value since Celeritas track counters are independent from Geant4 track counters. Similarly, special Geant4 user-defined UserInformation and AuxiliaryTrackInformation are never set.

The force_volumes option can be used for unusual cases (i.e., when using a custom run manager) that do not define SDs on the "master" thread. Similarly, the skip_volumes option allows optimized GPU-defined SDs to be used in place of a Geant4 callback. For both options, the FindVolumes helper function can be used to determine LV pointers from the volume names.

Note

These setup options affect only the HitManager construction that is responsible for reconstructing CPU hits and sending directly to the Geant4 detectors. It does not change the underlying physics.

---

The documentation for this struct was generated from the following file:

• SetupOptions.hh