Struct CrossSectionTable 

pub struct CrossSectionTable { /* private fields */ }

A precomputed cross-section table for one material and one process, cacheable on disk (format version CACHE_FORMAT_VERSION).

Contents and dimensions

With N incident energies and M probability points:

• energy_ev[N]: incident electron energies, eV; finite, positive, strictly increasing, N >= 2.
• inverse_mfp_per_m[N]: inverse mean free path λ⁻¹(E) = n σ(E) for the process, in m⁻¹; finite and non-negative. Zero means no interaction at that energy (for example below a threshold).
• probability[M]: the cumulative-probability axis shared by every row; finite, strictly increasing, starting at exactly 0 and ending at exactly 1, M >= 2.
• quantiles[N][..]: inverse-CDF ordinates (the cache stores the inverse CDF, not the forward CDF). quantiles[i][j] is the value x of the sampled variable at which the cumulative distribution at energy energy_ev[i] reaches probability[j]. A row is non-decreasing and lies in the axis’s domain ([0, π] rad for the elastic polar angle, [0, energy_ev[i]] eV for the inelastic energy loss). A row whose inverse mean free path is zero must be empty: there is no distribution to store, and CrossSectionTable::inverse_cdf returns ElectronDataError::ZeroRate for it. Every other row has exactly M entries.

The file also records the model identity, the material, the provenance, the sampling axis and its unit (ordinate_unit, which must match the axis), and the format version.

Sampling

CrossSectionTable::inverse_cdf evaluates a stored row at a probability u by linear interpolation between neighbouring probability points (exact at the stored points). Interpolation between incident energies is left to the transport code, which owns that choice.

Implementations

impl CrossSectionTable

pub fn new(parts: CrossSectionTableParts) -> Result<Self, ElectronDataError>

Build a validated table. See the type docs for the invariants.

pub fn from_toml_str(text: &str) -> Result<Self, ElectronDataError>

Parse and validate the TOML cache form.

pub fn to_toml_string(&self) -> Result<String, ElectronDataError>

Serialize to the TOML cache form.

pub fn from_toml_file(path: impl AsRef<Path>) -> Result<Self, ElectronDataError>

Load a TOML cache file.

pub fn write_toml_file( &self, path: impl AsRef<Path>, ) -> Result<(), ElectronDataError>

Write a TOML cache file.

pub fn format_version(&self) -> u32

Format version of this table (CACHE_FORMAT_VERSION).

pub fn model(&self) -> &str

Model identity.

pub fn material(&self) -> &str

Material identity.

pub fn provenance(&self) -> &str

Provenance string.

pub fn axis(&self) -> SamplingAxis

The sampled variable.

pub fn energy_ev(&self) -> &[f64]

Incident energies, eV.

pub fn inverse_mfp_per_m(&self) -> &[f64]

Inverse mean free paths, m⁻¹, one per energy.

pub fn probability(&self) -> &[f64]

The cumulative-probability axis.

pub fn quantiles(&self, i: usize) -> Option<&[f64]>

The inverse-CDF ordinates at grid energy i, or None for a zero-rate row (or an index past the end).

pub fn inverse_cdf(&self, i: usize, u: f64) -> Result<f64, ElectronDataError>

The inverse CDF of grid row i at cumulative probability u in [0, 1], in the axis’s unit. A zero-rate row is ElectronDataError::ZeroRate: the caller must not sample an interaction that cannot happen.

pub fn parts(&self) -> &CrossSectionTableParts

The validated contents.

Trait Implementations

impl Clone for CrossSectionTable

fn clone(&self) -> CrossSectionTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrossSectionTable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CrossSectionTable

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for CrossSectionTable

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for CrossSectionTable

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CrossSectionTable