Module electron 

The electron run description: one TOML document whose [electron] table describes the beam, the transport choices, the elastic and inelastic models, the per-material electron data and the tallies, next to the same [materials] and [target] tables as an ion run.

This module only exposes what the library already does (crate::electron, crate::tally::electron); it adds no physics. The schema is documented, with the rules for extending it, in docs/cli.md (section “Electron runs”). In short:

[electron.beam]
energy_ev = 10000.0

[electron.transport]
cutoff_ev = 50.0

[electron.elastic]
potential = "thomas-fermi-yukawa"

[electron.materials.Si]
optical_elf = "si_elf.toml"

[target]
substrate = "Si"

[run]
histories = 1000
seed = 1

ElectronInput::resolve_in validates the description, reads the data files it names and checks their provenance with the loaders of crate::electron::data (an optical ELF without a provenance is refused; so are band, phonon and polaron parameters without one), and returns the engine’s types (ResolvedElectron). Building the cross-section tables and running the transport is the caller’s (lindhard-cli).

Like the ion input, every table rejects unknown keys and the echoed input (ResolvedElectron::input) has every default filled in, so a result can be reproduced from its own header.

Structs

BinsNm

A uniform binning in nm.

CartesianSpec

[electron.tally.cartesian].

CorrelationPolarizationSpec

[electron.elastic.correlation_polarization].

CylindricalSpec

[electron.tally.cylindrical].

DataFile

A data file a run read, identified for provenance.

DoseSpec

[electron.tally.dose]: dose in each layer per unit incident fluence (always on once the table is present), optional depth-dose profile and interface transmission.

EPairSpec

[electron.materials.<name>.e_pair]: the energy needed per electron-hole pair, a per-material input that must carry its citation (for example the Klein 1968 rule for a semiconductor, or a measured value for SiO2). Pairs per incident electron are the ionisation energy divided by it, a post-processing step; nothing in transport depends on it.

ElasticChoice

The elastic choices after validation.

ElasticSpec

[electron.elastic].

ElectronBeamSpec

[electron.beam].

ElectronInput

The whole electron run description.

ElectronMaterialSpec

[electron.materials.<name>]: the electron data of one material.

ElectronRunSpec

[run] of an electron run.

ElectronSpec

[electron].

ElectronTallySpec

[electron.tally].

ExposureSpec

[electron.tally.exposure]: the per-electron deposit in target volumes and the compound-Poisson distribution of a finite exposure (crate::tally::exposure).

ExposureVolumeSpec

One [[electron.tally.exposure.volumes]] entry.

InelasticSpec

[electron.inelastic].

InnerShellsSpec

[electron.materials.<name>.inner_shells]: inner-shell ionisation channels of this material (single-pole Penn only). Each listed subshell of every element of the material becomes a channel with a hydrogenic optical ELF (crate::electron::inelastic::hydrogenic_shell_elfs) built from a binding-energy table (crate::electron::data::SubshellBindingTable).

MerminFitSpec

[electron.materials.<name>.mermin_fit]: the options of the oscillator fit of the mermin-melf model to this material’s optical ELF (MerminFitOptions, crate::electron::inelastic::fit_mermin_oscillators). Absent: exactly MerminFitOptions::default. Only n_oscillators and weighting are exposed; the starting point and the iteration cap keep their defaults.

PhononSpec

A Fröhlich LO-phonon channel: explicit parameters, or a preset the library carries with its citation.

PolarizabilitySpec

One element’s dipole polarizability and its source.

PolaronSpec

A polaron-trapping channel (PolaronTrapping).

PsfSpec

[electron.tally.psf]: the radial profile of the energy deposited in a depth slab, on log radial bins, and the PSF fits to it (crate::tally::psf).

ResolvedEPair

E_pair of a material, validated.

ResolvedElectron

A validated electron input, in the engine’s types.

ResolvedElectronMaterial

The electron data of one material after loading and validation.

ResolvedInnerShells

The inner-shell channels of one material after loading and validation.

TableGridSpec

[electron.tables]: the energy grid both tables of every layer share.

TransportSpec

[electron.transport]: the TransportConfig.

Enums

BandSpec

Band parameters of a material (BandStructure).

BeamProfileSpec

[electron.beam.profile]: the lateral profile of the beam on the front face, selected by model; lengths in nm.

BoundaryChoice

Face model.

CutoffReferenceChoice

Where the cutoff is measured from.

ElasticModelChoice

Elastic model. Only the Mott cross section from the radial-Dirac partial waves exists.

EscapeRuleChoice

Escape rule at the faces.

ExposureBeamSpec

Beam profile of [electron.tally.exposure].

ExposureShapeSpec

Shape of a volume of [electron.tally.exposure].

MerminWeightingChoice

Weighting of the residuals of the Mermin oscillator fit (FitWeighting).

PotentialChoice

Atomic potential of the elastic model.

PsfFitSpec

A PSF form to fit (fits of [electron.tally.psf]).

PsfNormalizationSpec

How the energy scale of a PSF fit is set (normalization).

SecondaryChoice

Secondary-electron model.