Skip to main content

MerminPenn

Struct MerminPenn 

Source
pub struct MerminPenn { /* private fields */ }
Expand description

The Mermin-ELF inelastic model: a fit of Mermin oscillators to one optical ELF, extended to finite momentum by the Mermin function, and the DIIMFP, IMFP and stopping power built from it. See the module docs.

Implementations§

Source§

impl MerminPenn

Source

pub fn new(elf: OpticalElf, fit: MerminFit) -> Result<Self, ElectronDataError>

The model of fit, a fit to elf (Fermi energy zero, default tolerance). Oscillators of zero amplitude are carried in the fit report but do not contribute.

Source

pub fn fit( elf: OpticalElf, options: &MerminFitOptions, ) -> Result<Self, ElectronDataError>

Fit elf with options (fit_mermin_oscillators) and build the model from the result.

Source

pub fn with_fermi_energy_ev( self, fermi_ev: f64, ) -> Result<Self, ElectronDataError>

Set the Fermi energy (eV, finite and non-negative), as for the Penn models: energies are kinetic energies above the Fermi level and the kinematics use T' = T + E_F.

Source

pub fn with_relative_tolerance( self, rel_tol: f64, ) -> Result<Self, ElectronDataError>

Set the relative integration tolerance, in [1e-9, 1e-2].

Source

pub fn optical_elf(&self) -> &OpticalElf

The optical ELF the oscillators were fitted to.

Source

pub fn fit_report(&self) -> &MerminFit

The fit: parameters, residuals, f-sum and P_eff.

Source

pub fn fermi_energy_ev(&self) -> f64

The Fermi energy, eV.

Source

pub fn relative_tolerance(&self) -> f64

The relative integration tolerance.

Source

pub fn loss_function(&self, q_per_m: f64, loss_ev: f64) -> f64

Im[-1/ε(q, ω)] of the Mermin-ELF model at momentum transfer q (m⁻¹) and energy loss ω (eV). At q = 0 it is the fitted Drude-Lorentz ELF.

Source

pub fn diimfp_per_m_ev( &self, energy_ev: f64, loss_ev: f64, ) -> Result<f64, ElectronDataError>

The DIIMFP p(T, ω) (S2017 eq. (2), nonrelativistic) in m⁻¹ eV⁻¹ at kinetic energy energy_ev above the Fermi level and loss loss_ev. Zero for ω <= 0 or ω > T.

Source

pub fn imfp_and_stopping( &self, energy_ev: f64, ) -> Result<InelasticPoint, ElectronDataError>

The inverse IMFP (m⁻¹) and the stopping power (eV/m) at kinetic energy energy_ev above the Fermi level.

Source

pub fn imfp_m(&self, energy_ev: f64) -> Result<f64, ElectronDataError>

The inelastic mean free path λ(E), m.

Source

pub fn stopping_power_ev_per_m( &self, energy_ev: f64, ) -> Result<f64, ElectronDataError>

The stopping power S(E), eV/m.

Source

pub fn tabulate( &self, energies_ev: &[f64], ) -> Result<Vec<InelasticPoint>, ElectronDataError>

IMFP and stopping power on a grid of energies, in order. Sequential and deterministic.

Trait Implementations§

Source§

impl Clone for MerminPenn

Source§

fn clone(&self) -> MerminPenn

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MerminPenn

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V