Struct IonTally 

pub struct IonTally { /* private fields */ }

Range, damage and escape tally for the BCA engine. See the module docs.

Implementations

impl IonTally

pub fn new( stack: &Stack, species_z: &[u8], config: IonTallyConfig, ) -> Result<Self, MaterialError>

Empty tally for stack, with the particle species of the engine (species_z, as returned by crate::ion::bca::Bca::species_z: index 0 is the beam).

Every element of every layer must have E_d and E_b set (the engine requires the same).

pub fn histories(&self) -> u64

Histories tallied so far.

pub fn report(&self, fit_dual_pearson: bool) -> IonReport

The plain-data result. With fit_dual_pearson the depth histogram is also fitted with DualPearson::fit (slower: a few thousand evaluations over the histogram).

Trait Implementations

impl BcaTally for IonTally

fn merge(&mut self, o: Self)

Field-wise merge.

Panics

If other was built with a different stack, species list or configuration.

fn begin_history(&mut self, _index: u64)

A primary history starts.

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 recoil(&mut self, r: &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 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.

impl Clone for IonTally

fn clone(&self) -> IonTally

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IonTally

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

Formats the value using the given formatter.

impl PartialEq for IonTally

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for IonTally