Struct SummaryTally 

pub struct SummaryTally {

    pub histories: u64,
    pub budget: EnergyBudget,
    pub max_relative_residual: f64,
    pub primaries_stopped: u64,
    pub backscattered: u64,
    pub transmitted: u64,
    pub sputtered: u64,
    pub recoils_transmitted: u64,
    pub lateral: u64,
    pub recoils_lateral: u64,
    pub recoils: u64,
    pub depth_sum: f64,
    pub depth_sq_sum: f64,
    pub bin_width_m: f64,
    pub depth_hist: Vec<u64>,
}

A minimal summary: counts, energy sums and a depth histogram of where primaries stop. Enough to test the engine; the full tallies come later.

Fields

histories: u64

Primary histories run.

budget: EnergyBudget

Sum of the per-history energy budgets.

max_relative_residual: f64

Largest |residual| / incident over all histories.

primaries_stopped: u64

Primaries that came to rest in the target.

backscattered: u64

Primaries that left through the front face.

transmitted: u64

Primaries that left through the back face.

sputtered: u64

Recoils that left through the front face.

recoils_transmitted: u64

Recoils that left through the back face.

lateral: u64

Primaries that left through a lateral face of a voxel grid.

recoils_lateral: u64

Recoils that left through a lateral face of a voxel grid.

recoils: u64

Displaced atoms (recoils created).

depth_sum: f64

Sum of the rest depth of stopped primaries, m.

depth_sq_sum: f64

Sum of squared rest depths of stopped primaries, m².

bin_width_m: f64

Width of a depth bin, m.

depth_hist: Vec<u64>

Stopped-primary counts per depth bin; the last bin collects overflow.

Implementations

impl SummaryTally

pub fn new(bin_width_m: f64, n_bins: usize) -> Self

Empty tally with n_bins depth bins of width bin_width_m.

pub fn mean_depth(&self) -> f64

Mean rest depth of stopped primaries (the projected range), m.

pub fn depth_std(&self) -> f64

Standard deviation of the rest depth of stopped primaries, m.

Trait Implementations

impl BcaTally for SummaryTally

fn recoil(&mut self, _recoil: &Particle)

A target atom was displaced (transfer above E_d); recoil is its state at creation, before it is followed (or stopped, if below the recoil cutoff or if cascades are off).

fn stopped(&mut self, p: &Particle)

A particle came to rest at p.pos with kinetic energy p.energy_ev.

fn escaped(&mut self, p: &Particle, face: Face)

A particle left the target through face; p is its state outside (after refraction by the surface barrier).

fn end_history(&mut self, _index: u64, budget: &EnergyBudget)

A primary history ended; budget is its energy bookkeeping.

fn merge(&mut self, o: Self)

Fold other (a later chunk) into self.

fn begin_history(&mut self, _index: u64)

A primary history starts.

fn electronic( &mut self, _p: &Particle, _from: [f64; 3], _channel: ElectronicChannel, _energy_ev: f64, )

Electronic loss of energy_ev. For ElectronicChannel::NonLocal it was spread along the straight segment from from to p.pos; for ElectronicChannel::Local it was deposited at p.pos.

fn partner(&mut self, _p: &Particle, _impact_parameter_m: f64, _partners: usize)

A collision partner of p, reported before the collision changes p (so p is the incoming state, unlike in the other hooks): impact_parameter_m is the distance from the partner to the incoming straight path, and partners the number of partners of this collision step, each of which is reported by its own call. The amorphous model reports its hard collision and each weak collision as a step of one partner; the crystal flight model reports every simultaneous partner of a step with the same partners.

fn lattice( &mut self, _at: [f64; 3], _layer: usize, _kind: LatticeDeposit, _energy_ev: f64, )

Nuclear energy energy_ev left in the lattice at at in region layer (the layer index of a stack, the flat voxel index of a voxel grid).

impl Clone for SummaryTally

fn clone(&self) -> SummaryTally

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SummaryTally

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

Formats the value using the given formatter.

impl PartialEq for SummaryTally

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for SummaryTally