Struct VoxelTally 

pub struct VoxelTally { /* private fields */ }

A sparse voxel tally; see the module docs.

Implementations

impl VoxelTally

pub fn new(grid: VoxelTallyGrid) -> Self

An empty tally on grid.

pub fn with_species(self, species_z: &[u8]) -> Self

Also tally vacancies, interstitials and replacements per species. species_z is crate::ion::bca::Bca::species_z of the run: entry s is the atomic number of species index s.

pub fn species_z(&self) -> &[u8]

The species Z this tally keeps defects for (empty: none).

pub fn grid(&self) -> &VoxelTallyGrid

The grid this tally bins on.

pub fn occupied(&self) -> usize

Number of stored (occupied) voxels.

pub fn report(&self) -> VoxelReport

The merged tally as plain data: occupied voxels in flat-index order.

Trait Implementations

impl BcaTally for VoxelTally

fn merge(&mut self, o: Self)

Voxel-by-voxel merge.

Panics

If other was built on a different grid or for different species.

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 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 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 VoxelTally

fn clone(&self) -> VoxelTally

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoxelTally

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

Formats the value using the given formatter.