Struct ShellChannelTable 

pub struct ShellChannelTable { /* private fields */ }

The energy-loss table of one inner-shell ionisation channel, with the identity of its shell.

The wrapped CrossSectionTable holds the channel’s inverse mean free path and the inverse CDF of its loss ω, built from that shell’s own optical ELF (crate::electron::inelastic::inner_shell); the wrapper adds the shell (Z, subshell), its binding energy B and the provenance of B (for example SubshellBindingTable::provenance). Built by crate::electron::inelastic::table::build_shell_channel_tables and consumed by crate::electron::transport::Transport::with_inner_shells.

Invariants

• Z >= 1; B finite and positive; a non-blank one-line binding provenance.
• The table samples SamplingAxis::InelasticEnergyLoss.
• Every stored loss is at least B: a shell contributes only above its edge (de Vera et al. 2022, eq. (2), the step Θ(E - B)), so the secondary energy ω - B is never negative. Since a loss is also at most the row energy, every row with a nonzero rate lies at an energy of at least B.

File form

TOML: format_version (SHELL_CHANNEL_FORMAT_VERSION), z, subshell (the ENDF label, e.g. "K", "L3"), binding_energy_ev, binding_provenance, and a [table] holding the CrossSectionTable cache form (with its own format_version). The wrapper version is checked first, unknown keys are rejected, and the same checks as ShellChannelTable::new run on read.

Implementations

impl ShellChannelTable

pub fn new( z: u8, subshell: Subshell, binding_energy_ev: f64, binding_provenance: &str, table: CrossSectionTable, ) -> Result<Self, ElectronDataError>

A validated channel table: shell subshell of element z with binding energy binding_energy_ev (whose origin binding_provenance states) and its loss table. See the type docs for the invariants.

pub fn z(&self) -> u8

Atomic number of the shell’s element.

pub fn subshell(&self) -> Subshell

The subshell.

pub fn binding_energy_ev(&self) -> f64

Binding energy B, eV.

pub fn binding_provenance(&self) -> &str

Where B came from.

pub fn table(&self) -> &CrossSectionTable

The channel’s loss table.

pub fn format_version(&self) -> u32

Format version of the wrapper (SHELL_CHANNEL_FORMAT_VERSION).

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

Parse and validate the TOML file form.

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

Serialize to the TOML file form.

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

Load a TOML file.

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

Write a TOML file.

Trait Implementations

impl Clone for ShellChannelTable

fn clone(&self) -> ShellChannelTable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ShellChannelTable

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ShellChannelTable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&ShellChannelTable> for InnerShell

fn from(t: &ShellChannelTable) -> Self

The shell a stored channel table belongs to.

impl PartialEq for ShellChannelTable

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for ShellChannelTable

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 ShellChannelTable