celeritas::inp Namespace Reference

Configure Celeritas input. More...

Classes
struct	BetheHeitlerModel
	Bethe-Heitler relativistic pair production from gammas. More...
struct	BremsProcess
	Construct a physics process for bremsstrahlung. More...
struct	Control
	Set up control/tuning parameters that do not affect physics. More...
struct	Counters
	Output track diagnostic counters. More...
struct	DecayPhysics
	Decay processes and options. More...
struct	Device
	Set up GPU capabilities and debugging options. More...
struct	DeviceDebug
	When using GPU, change execution options that make it easier to debug. More...
struct	Diagnostics
	Set up Celeritas built-in diagnostics. More...
struct	EmPhysics
	Electromagnetic physics processes and options. More...
struct	ExportFiles
	Write out problem data to separate files for debugging. More...
struct	FileImport
	Options for loading problem data from a ROOT/JSON file. More...
struct	FrameworkInput
	Describe how to import data into celeritas via an Input data structure. More...
struct	GeantDataImport
	Options for loading cross section data from Geant4 data files. More...
struct	GeantImport
	Options for importing data from in-memory Geant4. More...
struct	GeantSDStepPointAttributes
	Options for saving attributes at each step point. More...
struct	GeantSensitiveDetector
	Control options for Geant4 sensitive detector integration. More...
struct	HadronicPhysics
	Hadronic physics processes and options. More...
struct	IsotropicAngle
	Generate angles isotropically. More...
struct	McTruth
	Write out MC truth data. More...
struct	Model
	Set up geometry/material model. More...
struct	MonodirectionalAngle
	Generate angles in a single direction. More...
struct	Monoenergetic
	Generate primaries at a single energy value. More...
struct	MuBremsModel
	Muon bremsstrahlung model. More...
struct	MuPairProductionModel
	Pair production from muons. More...
struct	NoField
	Build a problem without magnetic fields. More...
struct	OpticalPhysics
	Optical physics processes and options. More...
struct	PairProductionProcess
	Construct a physics process for electron/positron pair production. More...
struct	Physics
	Set up physics options. More...
struct	PointShape
	Generate at a single point. More...
struct	PrimaryGenerator
	Generate from a hardcoded distribution of primary particles. More...
struct	Problem
	Celeritas problem input definition. More...
struct	ReadFileEvents
	Read all events from the given file. More...
struct	RelBremsModel
	Relativistic bremsstrahlung model. More...
struct	SampleFileEvents
	Sample random events from an input file. More...
struct	Scoring
	Enable scoring of hits or other quantities. More...
struct	SeltzerBergerModel
	Seltzer-Berger bremsstrahlung model. More...
struct	SimpleCalo
	Integrate energy deposition in each volume over all events. More...
struct	SlotDiagnostic
	Export (possibly large!) diagnostic output about track slot contents. More...
struct	StandaloneInput
	Celeritas setup for standalone apps. More...
struct	StateCapacity
	Set up per-process state/buffer capacities. More...
struct	StepDiagnostic
	Accumulate distributions of the number of steps per particle type. More...
struct	System
	Set up system parameters defined once at program startup. More...
struct	Timers
	Set up Celeritas timers. More...
struct	Tracking
	Specify non-physical parameters which can affect the physics. More...
struct	TrackingLimits
	Hard cutoffs for counters. More...
struct	UniformBoxShape
	Sample uniformly in a box. More...
struct	UniformField
	Create a uniform nonzero field. More...
struct	UpdateImport
	Update control and diagnostic options from an external input file. More...

Typedefs
using	ShapeDistribution = std::variant< PointShape, UniformBoxShape >
	Choose a spatial distribution for the primary generator.
using	AngleDistribution = std::variant< IsotropicAngle, MonodirectionalAngle >
	Choose an angular distribution for the primary generator.
using	EnergyDistribution = Monoenergetic
	Choose an angular distribution for the primary generator.
using	Events = std::variant< PrimaryGenerator, SampleFileEvents, ReadFileEvents >
	Mechanism for generating events for tracking.
using	RZMapField = ::celeritas::RZMapFieldInput
	Build a separable R-Z magnetic field from a file.
using	Field = std::variant< NoField, UniformField, RZMapField >
	Field type.
using	GeantSetup = GeantPhysicsOptions
	Set up a Geant4 run manager and problem.
Model aliases
Todo: rename em/model to match
using	MuBremsstrahlungModel = MuBremsModel
using	RelativisticBremModel = RelBremsModel
Process aliases
Todo: rename em/model to match, merge muon and electron proceses
using	BremsstrahlungProcess = BremsProcess
using	GammaConversionProcess = PairProductionProcess
using	MuPairProductionProcess = PairProductionProcess

Detailed Description

Configure Celeritas input.

Note that many of these input structs match up with the runtime classes that they help construct. Future restructuring of the code may result in more direct correspondence.

Typedef Documentation

GeantSetup

using celeritas::inp::GeantSetup = typedef GeantPhysicsOptions

Set up a Geant4 run manager and problem.

Note

We should change celer-g4 so it just uses GeantSetup as an outer wrapper, rather than trying to be a Geant4 example.

Most of the "physics options" will be deleted. Only a few options specific to Geant4, such as gamma_general , will be left.

RZMapField

using celeritas::inp::RZMapField = typedef ::celeritas::RZMapFieldInput

Build a separable R-Z magnetic field from a file.

Todo:

Move field input here