celeritas::SetupOptions Struct Reference

Control options for initializing Celeritas. More...

#include <SetupOptions.hh>

Public Types
Type aliases
using	size_type = unsigned int
using	real_type = double
using	SPConstAction = std::shared_ptr< CoreStepActionInterface const >
using	AlongStepFactory = std::function< SPConstAction(AlongStepFactoryInput const &)>
using	IntAccessor = std::function< int()>
using	VecString = std::vector< std::string >

Public Member Functions
	operator bool () const

Static Public Member Functions
static constexpr size_type	no_max_steps ()
	Don't limit the number of steps.

Public Attributes
IntAccessor	get_num_streams
	Set the number of streams (defaults to run manager # threads)
SDSetupOptions	sd
	Sensitive detector options.
I/O
std::string	geometry_file
	GDML filename (optional: defaults to exporting existing Geant4)
std::string	output_file {"celeritas.out.json"}
	Filename for JSON diagnostic output, empty to disable.
std::string	physics_output_file
	Filename for ROOT dump of physics data.
std::string	offload_output_file
	Filename to dump a ROOT/HepMC3 copy of offloaded tracks as events.
std::string	geometry_output_file
	Filename to dump a GDML file for debugging inside frameworks.
Celeritas stepper options
size_type	max_num_tracks {}
	Number of track "slots" to be transported simultaneously.
size_type	max_num_events {}
	Maximum number of events in use (DEPRECATED: remove in v0.7)
size_type	max_steps = no_max_steps()
	Limit on number of steps per track before killing.
size_type	max_step_iters = no_max_steps()
	Limit on number of step iterations before aborting.
size_type	initializer_capacity {}
	Maximum number of track initializers (primaries+secondaries)
real_type	secondary_stack_factor {3.0}
	At least the average number of secondaries per track slot.
size_type	auto_flush {}
	Number of tracks to buffer before offloading (if unset: max num tracks)
Track reordering options
TrackOrder	track_order {TrackOrder::size_}
Stepping actions
AlongStepFactory	make_along_step
Field options
size_type	max_field_substeps {10}
Physics options
VecString	ignore_processes
	Do not use Celeritas physics for the given Geant4 process names.
CUDA options
size_type	cuda_stack_size {}
	Per-thread stack size (may be needed for VecGeom) [B].
size_type	cuda_heap_size {}
	Dynamic heap size (may be needed for VecGeom) [B].
bool	action_times {false}
	Sync the GPU at every kernel for timing.
bool	default_stream {false}
	Launch all kernels on the default stream for debugging (REMOVED)
Diagnostic setup
std::string	slot_diagnostic_prefix
	Filename base for slot diagnostics.
std::function< void(CoreParams const &)>	add_user_actions
	Add additional diagnostic user actions [EXPERIMENTAL].

Detailed Description

Control options for initializing Celeritas.

The interface for the "along-step factory" (input parameters and output) is described in AlongStepFactoryInterface .

Note

This class will be replaced in v1.0 by celeritas::inp::FrameworkInput .

---

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

• SetupOptions.hh