Public API

G4JLApplication(<keyword arguments>)

Initialize a G4JLApplication with its associated tyopes and methods.

Arguments

• detector::G4JLDetector: detector description object
• simdata=G4JLNoData(): simulation data object
• generator=G4JLParticleGun(): primary particle generator
• field=nothing: magnetic field
• evtdisplay=nothing: event display (visualization)
• nthreads=0: number of Geant4 worker threads ( >0 implies MT)
• verbose=0 : default verbority level (physics, ...)
• runmanager_type=G4RunManager: run manager type
• builder_type=G4JLDetectorConstruction: detector builder type (the default should be fine most cases)
• physics_type=FTFP_BERT: physics list type
• stepaction_type=G4JLSteppingAction: stepping action type (the default should be fine most cases)
• trackaction_type=G4JLTrackingAction: rtacking action type (the default should be fine most cases)
• runaction_type=G4JLRunAction: run action type (the default should be fine most cases)
• eventaction_type=G4JLEventAction: event action type (the default should be fine most cases)
• stepaction_method=nothing: stepping action method with signature (::G4Step, ::G4JLApplication)::Nothing
• pretrackaction_method=nothing: pre-tracking action method with signature (::G4Track, ::G4JLApplication)::Nothing
• posttrackaction_method=nothing: post-tracking action method with signature (::G4Track, ::G4JLApplication)::Nothing
• beginrunaction_method=nothing: begin run action method with signature (::G4Run, ::G4JLApplication)::Nothing
• endrunaction_method=nothing: end run action method with signature (::G4Run, ::G4JLApplication)::Nothing
• begineventaction_method=nothing: begin event action method with signature (::G4Event, ::G4JLApplication)::Nothing
• endeventaction_method=nothing: end event action method with signature (::G4Event, ::G4JLApplication)::Nothing
• stackaction_method=nothing: stacking classification of new track with signature (::G4Track, ::G4JLApplication)::G4ClassificationOfNewTrack
• statechange_method=nothing: state change notifycation method with signature (from::G4ApplicationState, to::G4ApplicationState, ::G4JLApplication)::Bool
• sdetectors::Vector{}=[]: vector of pairs lv::String => sd::G4JLSensitiveDetector to associate logical volumes to sensitive detector
• scorers::Vector{}=[]: vector of G4JLScoringMeshs

G4JLDetectorGDML(gdmlfile::String; check_overlap::Bool, validate_schema::Bool, init_method::Union{Function,Nothing})

Initialize a G4JLDetector from a GDML file. The GDML file is parsed at this moment.

Arguments

• gdmlfile::String: GDML file name
• check_overlap::Bool=false: check for overlaps
• validate_schema::Bool=true: validate the schema
• init_method::Union{Function,Nothing}=nothing: initialization method to be called when the detector is constructed

Custom Magnetic Field

G4JLUniformMagField(field::G4ThreeVector)

Create a Uniform magnetic field

Arguments

• field::G4ThreeVector: magnetic field vector

G4JLMagneticField(name::String, data::DATA; <keyword arguments>) where DATA<:G4JLGeneratorData

Create a G4JLMagneticField with its name and associated DATA structure

Arguments

• name::String: magnetic field name
• data::DATA: data structure associated to the magnetic field
• getfield_method=nothing: user provided getfield function with signature: (result::G4ThreeVector, position::G4ThreeVector, ::DATA)

G4JLPrimaryGenerator(name::String, data::DATA; <keyword arguments>) where DATA<:G4JLGeneratorData

Creatre a G4JLPrimaryGenerator with its name and associated DATA structure

Arguments

G4JLScoringMesh(name, mesh; <keyword arguments>)

Create a scoring mesh to be added to the Geant4 application.

Arguments

• name::String: scoring mech name
• mesh::AbstractMesh: mesh instance. Either a BoxMesh or CylinderMesh
• bins::Tuple: tuple with number on bins in x, y, z (default 30, 30, 30)
• translation::Tuple: position (x,y,z) with respect the mesh respect to the world volume. Default is (0,0,0).
• rotation::Tuple: rotation of the mesh with respect the world volume. Default (0,0,0)
• quantities::Vector: vector of quanties to be scored (e.g. energyDeposit, doseDeposit, nOfStep)

G4JLSensitiveDetector(name::String, data::DATA; <keyword arguments>) where DATA<:G4JLSDData

Initialize a G4JLSensitiveDetector with its name and associated DATA structure.

Arguments

• name::String: Sensitive detector name
• data::DATA: Data structure associted to the sensitive detector
• processhits_method=nothing: processHit function with signature: (data::DATA, step::G4Step, ::G4TouchableHistory)::Bool
• initialize_method=nothing: intialize function with signature: (data::DATA, ::G4HCofThisEvent)::Nothing
• endofevent_method=nothing: endOfEvent function with signature: (data::DATA, ::G4HCofThisEvent)::Nothing

G4JL_println(::AbstractString)

Print the string to the Geant4 output in a thread safe manner prefixing the string with the thread ID.

Arguments

• s::AbstractString: string to be printed

GetVolume(name::String)

Get the the G4LogicalVolume with this name.

Arguments

• name::String: logical volume name

GetWorldVolume()

Get the world volume of the currently instantiated detector geometry.

beamOn(app::G4JLApplication, nevents::Int)

Start a new run with nevents events. In case of multi-threading, the function enters a GC safe state before starting the run.

Arguments

• app::G4JLApplication: Geant4 application
• nevents::Int: number of events

configure(app::G4JLApplication)

Configure the Geant4 application. It sets the declared user actions, event generator, and physcis list.

Arguments

• app::G4JLApplication: Geant4 application

getSDdata(app::G4JLApplication, name::String)

Get the data associated to the Sentitive Detector with a given name taking into account the current worker thread ID

Arguments

• app::G4JLApplication: Geant4 application
• name::String: sensitive detector name

getSIMdata(app::G4JLApplication)

Get the Simulation Data taking into account the current worker thread ID

Arguments

• app::G4JLApplication: Geant4 application

getfield(pos::G4ThreeVector, bfield::G4JLMagneticField)

Function to exercise a custom magnetic field

Arguments

• pos::G4ThreeVector: position
• bfield::G4JLMagneticField: magnetic field object

initialize(app::G4JLApplication)

Initialize the Geant4 application. It initializes the G4RunManager, which constructs the detector geometry, and sets the declared sensitive detectors. In case of multi-threading, the function enters a GC safe state before initializing the application, which will be calling thebuild()` functions by the worker threads.

Arguments

• app::G4JLApplication: Geant4 application

move!(o)

Move ownerhip of C++ object to receiver. The object cannot not be used anymore after this call.

reinitialize(app::G4JLApplication, det::G4JLDetector)

Re-initialize the Geant4 application with a new detector defintion.

Arguments

• app::G4JLApplication: Geant4 application
• det::G4JLDetector: new detector definition