Struct FullElectronTally 

pub struct FullElectronTally { /* private fields */ }

Deposition, emission and energy-balance tally for the electron transport loop. See the module docs.

Implementations

impl FullElectronTally

pub fn new<G: Geometry>( transport: &Transport<G>, config: ElectronTallyConfig, ) -> Result<Self, ElectronTallyError>

Empty tally for runs of transport (its per-layer stopping thresholds classify stopped events, its secondary model decides which hook carries an inelastic deposit, its stack sets the number of layers).

pub fn config(&self) -> &ElectronTallyConfig

The configuration.

pub fn histories(&self) -> u64

Primary histories tallied so far.

pub fn with_voxel_grid(self, grid: VoxelTallyGrid) -> Self

Also tally the deposited energy per voxel of grid, for FullElectronTally::voxel_report. The grid is independent of the target: use VoxelTallyGrid::from_voxel_grid to tally on the voxels of a crate::geometry::VoxelGrid target.

pub fn voxel_report(&self) -> Option<VoxelReport>

The per-voxel deposition as a VoxelReport (CSV and VTK export of crate::tally::voxel), or None without FullElectronTally::with_voxel_grid.

Each voxel’s energy is split by how it was deposited: electronic_ev is the energy left at inelastic events (the ElectronEnergyBudget::inelastic_ev channel), lattice_ev the LO-phonon emission and polaron-trapping energy, and rest_ev the energy of electrons that fell below the stopping threshold (ElectronEnergyBudget::residual_ev); their sum over all voxels and outside is ElectronEnergyBudget::deposited_ev. implanted and displacements are zero: the electron tally records neither, and the per-species defect fields (species_z, defects, outside_defects) are empty: the electron tally has no species axis. Deposits are point events at the collision (as for CartesianGrid), so a flight crossing voxel faces is not split.

pub fn report(&self) -> ElectronReport

The plain-data result.

Trait Implementations

impl Clone for FullElectronTally

fn clone(&self) -> FullElectronTally

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FullElectronTally

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl ElectronTally for FullElectronTally

fn merge(&mut self, o: Self)

Field-wise merge.

Panics

If other was built with a different configuration, cutoff, thresholds, secondary model or stack.

fn begin_history(&mut self, index: u64, start: &ElectronState)

A primary history starts. With BoundaryModel::StepBarrier, start is the primary in vacuum, before it meets the front face.

fn step(&mut self, _from: [f64; 3], end: &ElectronState, _length_m: f64)

A flight segment of length_m ended at end.pos (at a collision, a layer face or the target face). It started at from with energy end.energy_ev (the energy does not change in flight).

fn table_lookup( &mut self, at: &ElectronState, channel: TableChannel, coverage: GridCoverage, )

The rate of channel’s table in layer at.layer was evaluated at at.energy_ev, which lies coverage against that table’s grid.

fn elastic(&mut self, after: &ElectronState, _theta: f64)

An elastic collision deflected the electron by theta rad.

fn inelastic(&mut self, after: &ElectronState, w_ev: f64)

An inelastic collision took w_ev from the electron. after carries the new direction if the secondary model deflected it.

fn secondary( &mut self, primary: &ElectronState, event: &SecondaryEvent, created: Option<&ElectronState>, )

Called right after ElectronTally::inelastic (and ElectronTally::inner_shell, for a shell event) for every inelastic event when a SecondaryModel is on: the event’s energy bookkeeping, and the secondary that was created (None if none was). The secondary is transported later, between ElectronTally::begin_secondary and ElectronTally::end_secondary.

fn phonon( &mut self, after: &ElectronState, kind: PhononEvent, hbar_omega_ev: f64, _theta: f64, )

A Fröhlich LO-phonon event changed the energy by -ħω (emission) or +ħω (absorption), hbar_omega_ev given, and deflected the electron by theta rad. after is the state after the event.

fn polaron_trapped(&mut self, at: &ElectronState)

The electron was trapped as a polaron at at and deposits its whole remaining energy at.energy_ev there. The history (or the secondary) then ends with Fate::PolaronTrapped (no ElectronTally::stopped call).

fn interface(&mut self, at: &ElectronState, from_layer: usize, to_layer: usize)

The electron crossed from layer from_layer into to_layer; at is its state on the face, inside the new layer (after refraction, with BoundaryModel::StepBarrier).

fn barrier(&mut self, at: &ElectronState, _boundary: Boundary, delta_u_ev: f64)

With BoundaryModel::StepBarrier: the electron got through the face boundary, and its kinetic energy changed by delta_u_ev (the step U' - U). at is its state just past the face (in vacuum, for a surface). Comes before ElectronTally::interface or ElectronTally::escaped.

fn reflected(&mut self, at: &ElectronState, _boundary: Boundary)

With BoundaryModel::StepBarrier: the electron was reflected at the face boundary; at is its state after the reflection. At the primary’s entry this is followed by ElectronTally::escaped.

fn begin_secondary(&mut self, start: &ElectronState, _generation: u32)

A secondary of the given generation (1 for a secondary of the primary, 2 for one of a secondary, …) starts at start.

fn end_secondary(&mut self, fate: Fate)

The current secondary ended with fate.

fn stopped(&mut self, at: &ElectronState)

The electron fell below the stopping threshold (or was trapped) at at. A stop has at.energy_ev below the threshold of at.layer, a trapped electron at least that energy (Transport::stopping_thresholds_ev).

fn escaped(&mut self, at: &ElectronState, face: Face)

The electron left the target through face; at.energy_ev is the energy it leaves with (its vacuum energy, with the step barrier).

fn absorbed(&mut self, at: &ElectronState)

The electron was absorbed at the back face (EscapeRule::FrontOnly).

fn end_history(&mut self, _index: u64, fate: Fate)

The history ended (its last secondary included); fate is the primary’s.

fn inner_shell( &mut self, _after: &ElectronState, _shell: &InnerShell, _w_ev: f64, )

Called right after ElectronTally::inelastic for every inelastic event drawn from an inner-shell channel (Transport::with_inner_shells), with or without a secondary model: the shell (its element, subshell and binding energy) and the loss w_ev (the same as passed to ElectronTally::inelastic). Not called for valence events. Comes before ElectronTally::secondary.

impl PartialEq for FullElectronTally

fn eq(&self, other: &FullElectronTally) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for FullElectronTally