Struct InelasticTableOptions 

pub struct InelasticTableOptions {
    pub energy_ev: Vec<f64>,
    pub axis: EnergyAxis,
    pub probability: Vec<f64>,
    pub density_tolerance: f64,
    pub refine_tolerance: Option<f64>,
    pub rate_refinement: Option<RateRefinement>,
}

Grids and tolerances of a table build.

Fields

energy_ev: Vec<f64>

Incident kinetic energies on the axis of Self::axis, eV (strictly increasing, >= 2 points): above the model’s Fermi level by default, above the band bottom with EnergyAxis::BandBottom.

axis: EnergyAxis

The axis energy_ev is on (EnergyAxis::ModelFermiLevel by default).

probability: Vec<f64>

Starting cumulative-probability grid of the stored inverse CDFs (from exactly 0 to exactly 1); the final grid when refine_tolerance is None.

density_tolerance: f64

Tolerance of the loss-density model (DEFAULT_DENSITY_TOLERANCE).

refine_tolerance: Option<f64>

Target of the probability-grid refinement, relative to the mean loss of each row (None: no refinement).

rate_refinement: Option<RateRefinement>

Extra rows that resolve the inelastic rate just above the Fermi level (module docs, “Rate refinement”; #339). None (the default): the table has exactly the rows of energy_ev. Only valid with EnergyAxis::BandBottom; refused on the model’s own axis.

Implementations

impl InelasticTableOptions

pub fn new(energy_ev: Vec<f64>) -> Self

The defaults on the given energy grid.

pub fn with_axis(self, axis: EnergyAxis) -> Self

The same options with the table stored on axis.

pub fn with_rate_refinement(self, refinement: RateRefinement) -> Self

The same options with the rate refinement refinement (module docs, “Rate refinement”); needs EnergyAxis::BandBottom.

Trait Implementations

impl Clone for InelasticTableOptions

fn clone(&self) -> InelasticTableOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for InelasticTableOptions

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

Formats the value using the given formatter.

impl PartialEq for InelasticTableOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for InelasticTableOptions