Struct InventoryTally 

pub struct InventoryTally { /* private fields */ }

A BcaTally that records the net atom count change per (slab, Z) and the Yields of a step.

Implementations

impl InventoryTally

pub fn new(n_slabs: usize) -> Self

An empty tally for a grid of n_slabs finite slabs (layer indices at or above n_slabs are the substrate).

pub fn counts(&self) -> impl Iterator<Item = ((usize, u8), i64)> + '_

Net atom count change per (slab, Z), in (slab, Z) order. Zero entries are omitted.

pub fn sputtered_from(&self) -> impl Iterator<Item = ((usize, u8), u64)> + '_

Recoils that left through the front face, per (origin slab, Z), in that order. Only origins in a finite slab are listed (an atom from the substrate was never part of the inventory), so for each Z the sum is at most the Z entry of Yields::sputtered. Each of these atoms is also in counts as a loss in its origin slab.

pub fn yields(&self) -> &Yields

The event counts.

Trait Implementations

impl BcaTally for InventoryTally

fn begin_history(&mut self, _index: u64)

A primary history starts.

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 merge(&mut self, other: Self)

Fold other (a later chunk) into self.

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).

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

A primary history ended; budget is its energy bookkeeping.

impl Clone for InventoryTally

fn clone(&self) -> InventoryTally

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InventoryTally

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

Formats the value using the given formatter.

impl Eq for InventoryTally

impl PartialEq for InventoryTally

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InventoryTally