How ioniels/rf-track_uh_thermionicrfgun works
This repository models a University of Hawai‘i thermionic RF gun: it qualifies XFdtd-derived RF fields, emits electrons from a LaB6 cathode, tracks them through the gun, and produces exit-beam data plus cathode-return heating results. The main run path is documented in the README; a separate back-bombardment study orchestrates event analysis, deposition, and thermal solving. The graph also shows field-map reduction and qualification, emission iteration, diagnostics, and COMSOL interchange. Some links are documented capabilities rather than inspected call sites; unsampled implementation details are not inferred.
Main entry points: simulation.py Run orchestration · back_bombardment_macropulse.py Macropulse study · run_thermionic_tm010.py Gun run CLI · artifact.py Field artifact
Components 26
Field Maps
- XFdtd reader
rf_gun/fieldmaps/xfdtd_h5.py - Map reduction
rf_gun/fieldmaps/pipeline.py - Map qualification
rf_gun/fieldmaps/workflow.py - Field artifact
rf_gun/fieldmaps/artifact.py - Field models
rf_gun/fieldmaps/models.py
Gun Simulation
- Gun run CLI
run_thermionic_tm010.py - Thermionic emission
rf_gun/emission_models.py - Source sampling
rf_gun/emission_sampling.py - Emission iteration
rf_gun/emission_iteration.py - Cathode fields
rf_gun/cathode_fields.py - RF-Track transport
rf_gun/rftrack_volume.py - Run orchestration
rf_gun/simulation.py
Return Heating
- Cathode geometry
rf_gun/cathode_geometry.py - Return events
rf_gun/back_bombardment_events.py - Energy deposition
rf_gun/back_bombardment_deposition.py - Macropulse study
rf_gun/studies/back_bombardment_macropulse.py - Thermal solver
rf_gun/thermal.py
Material Models
- Material registry
rf_gun/materials/registry.py - Material properties
rf_gun/materials/base.py
Results
- COMSOL exchange
rf_gun/comsol_io.py - Run data I/O
rf_gun/io.py - Beam diagnostics
rf_gun/diagnostics.py - Plots and reports
rf_gun/plotting/save_run.py
Other components
- XFdtd volume
- Run operator
- Downstream beamline
Connections 30
- XFdtd volume → XFdtd reader: supplies volume
- XFdtd reader → Map reduction: reads slabs
rf_gun/fieldmaps/pipeline.py - Map reduction → Map qualification: checks quality
- Map reduction → Field artifact: writes artifact
rf_gun/fieldmaps/pipeline.py - Map qualification → Field artifact: qualifies map
- Field artifact → Field models: stores fields
rf_gun/fieldmaps/artifact.py - Run operator → Gun run CLI: starts run
- Field artifact → Run orchestration: loads qualified map
- Gun run CLI → Run orchestration: runs pipeline
- Run orchestration → Thermionic emission: evaluates emission
rf_gun/simulation.py - Run orchestration → Source sampling: samples source
rf_gun/simulation.py - Run orchestration → Emission iteration: optionally iterates
rf_gun/simulation.py - Run orchestration → Cathode fields: uses cathode fields
rf_gun/simulation.py - Run orchestration → RF-Track transport: builds transport
rf_gun/simulation.py - RF-Track transport → Run data I/O: saves beam data
- RF-Track transport → Return events: provides losses
rf_gun/back_bombardment_events.py - Return events → Cathode geometry: classifies impacts
rf_gun/back_bombardment_events.py - Gun run CLI → Beam diagnostics: records diagnostics
- Run data I/O → Plots and reports: feeds run plots
rf_gun/plotting/save_run.py - Run operator → Macropulse study: starts study
- Macropulse study → Return events: analyzes returns
rf_gun/studies/back_bombardment_macropulse.py - Macropulse study → Energy deposition: computes deposition
rf_gun/studies/back_bombardment_macropulse.py - Macropulse study → Thermal solver: solves heating
rf_gun/studies/back_bombardment_macropulse.py - Macropulse study → Material registry: loads material
rf_gun/studies/back_bombardment_macropulse.py - Energy deposition → Material properties: uses properties
rf_gun/back_bombardment_deposition.py - Thermal solver → Material registry: uses thermal data
rf_gun/thermal.py - Material registry → Material properties: resolves properties
rf_gun/materials/registry.py - Macropulse study → COMSOL exchange: compares thermal results
rf_gun/studies/back_bombardment_macropulse.py - COMSOL exchange → Run operator: exchanges heat data
- Gun run CLI → Downstream beamline: exports exit beam