TID analysis

Module type name (to be used for the module commands): tid

Note

For backwards compatibility the previous dose name can also be used.

Description

The tid module computes the total (cumulative) “ionizing dose” (TID) in the selected volumes specified with the command addVolume.

If a volume interface is added with the command addVolumeInterface, the dose is also tallied by particle species. In this case, the contribution is subdivided into the individual contributions of the particle species as detected at the interface, i.e. not the local particle depositing the energy at the current step, but the (progenitor) particle that crossed the user interface and finally led to the current step. This allows for example to distinguish dose from gammas / neutrons whose dose is locally deposited via their secondary particles.

Script example:

/gras/analysis/tid/addModule dose1
/gras/analysis/tid/dose1/addVolume volume_name1
/gras/analysis/tid/dose1/addVolumeInterface volume_name2 volume_name2
/gras/analysis/tid/dose1/setUnit Rad

Available Units

The module accepts as units all the G4 units under the “Energy” and “Dose” categories. Additional GRAS units that can be used are:

  • MeV/g

  • mGy

  • Rad (rad is also accepted, but it is recommended not to be used do distinguish it from the “Angle” unit)

Where required (“Dose” units), the detector mass is automatically obtained from the inserted geometry volume.

Specific Module commands

/gras/analysis/tid/<moduleName>/tallyIndividualVolumes [true || false]

Specify if tallies per individual volume should be created

Output

Scalars (only in CSV file)

TID (or EDep, depending on Unit category)

  • TID (or Energy Deposition) of the simulation in all the specified volumes

  • Always active

  • Precision Calculations This variable is registered for precision calculations if activated

TID FOR INDIVIDUAL VOLUMES (or EDep FOR INDIVIDUAL VOLUMES)

  • TID (or Energy Deposition) per individual volume specified

  • Activated by the specific command

TID PER PARTICLE SPECIES (or EDep PER PARTICLE SPECIES)

  • TID (or Energy Deposition) per particle type in all the specified volumes

  • Activated by adding at least one volume interface

Histograms (in CSV and ROOT files)

Controlled by the bookHisto command (default is active).

TID SPECTRUM (or EDep SPECTRUM)

  • Name (for the setHistoByName command): <moduleName>_tid

  • Spectrum of the TID (Energy Deposition) per event in all the specified volumes

  • Always active

TID VS PRIMARY KINETIC ENERGY (or EDep VS PRIMARY KINETIC ENERGY)

  • Name (for the setHistoByName command): <moduleName>_tid_vs_primary_kine

  • Spectrum of TID (or Energy Deposition) of event in all the specified volumes per primary kinetic energy

  • Always active

TID SPECTRUM VS PRIMARY KINETIC ENERGY (or EDep SPECTRUM VS PRIMARY KINETIC ENERGY)

  • Name (for the setHistoByName command): <moduleName>_tid_spectrum_vs_primary_kine

  • 2D Spectrum of TID (or Energy Deposition) of event in all the specified volumes VS the primary kinetic energy

  • Activated by the book2DHistoVsPrimary command (or the obsolete bookHistosVsPrimary command)

Tuples (only in ROOT file)

Controlled by the bookTuples (default is active).

<moduleName> Event tid

  • Name: <moduleName>_tuple_tid

  • TID (or Energy Depostion) information by event

  • Columns:

    • tid: tid (or energy deposition) of the event

    • weight: weight of the event

    • primarykine: primary kinetic energy of the event

  • Always active

<moduleName> Event tid per particle

  • Name: <moduleName>_tuple_tid_per_particle

  • TID (or Energy Depostion) information by event

  • Columns: tid, weight, primarykine, pdg

    • tid: tid (or energy deposition) of the event

    • weight: weight of the event

    • primarykine: primary kinetic energy of the event

    • pdg: pdg of (progenitor) particle on the interface

  • Activated by adding at least one volume interface

<moduleName> Step tid (useful to analyse the weak sectors in the shielding)

  • Name: <moduleName>_tuple_tid_per_step

  • Energy Depostion information by step

  • Columns:

    • edep: energy deposition of step

    • weight: weight of the event

    • primarykine: primary kinetic energy of the event

    • int_posx: x position of (progenitor) particle on the interface

    • int_posy: y position of (progenitor) particle on the interface

    • int_posz: z position of (progenitor) particle on the interface

    • int_kine: kinetic energy of (progenitor) particle on the interface

    • int_pdg: pdg of (progenitor) particle on the interface

    • pdg: pdg of local particle

  • Activated by adding at least one volume interface and by the detailedTuples command set to true.

GRAS/trunk/r2242