Skip to main content

RadialProfile

Struct RadialProfile 

Source
pub struct RadialProfile {
    pub histories: u64,
    pub depth_lo_m: f64,
    pub depth_hi_m: f64,
    pub edges_m: Vec<f64>,
    pub energy_ev: Vec<f64>,
    pub std_err_ev: Vec<f64>,
    pub beyond_ev: f64,
    pub beyond_std_err_ev: f64,
    pub total_ev: f64,
    pub total_std_err_ev: f64,
}
Expand description

A radial energy-deposition profile in a depth slab, summed over all histories, with per-bin standard errors. Bin i is the annulus edges_m[i] <= r < edges_m[i + 1].

Fields§

§histories: u64

Histories accumulated.

§depth_lo_m: f64

Lower depth of the slab, m.

§depth_hi_m: f64

Upper depth of the slab (excluded), m.

§edges_m: Vec<f64>

Bin edges, m; one more than bins, starting at 0.

§energy_ev: Vec<f64>

Energy per bin, eV.

§std_err_ev: Vec<f64>

Standard error of each bin’s energy, eV.

§beyond_ev: f64

Energy deposited in the slab beyond the last edge, eV.

§beyond_std_err_ev: f64

Its standard error, eV.

§total_ev: f64

Energy deposited in the slab, eV: the bins plus beyond_ev.

§total_std_err_ev: f64

Its standard error, eV (from the per-history slab totals).

Implementations§

Source§

impl RadialProfile

Source

pub const TOTAL_REL_TOLERANCE: f64 = 1e-6

Relative tolerance of the check that total_ev equals the bin energies plus beyond_ev (see RadialProfile::validate).

RadialAccumulator sums the same deposits into the bins and into the slab total, but in a different order, so the two agree only to floating-point rounding: a naive sum of n non-negative terms is off by at most about n ε relative (ε ≈ 1.1e-16), well below 1e-6 for any feasible number of histories.

Source

pub fn validate(&self) -> Result<(), PsfError>

Checks that the profile is consistent: edges start at 0 and increase, one energy and one error per bin, all finite, errors non-negative; the depth slab finite with depth_lo_m < depth_hi_m; beyond_ev, total_ev and their errors finite and non-negative; and total_ev equal to the bin energies plus beyond_ev within RadialProfile::TOTAL_REL_TOLERANCE relative.

Source

pub fn len(&self) -> usize

Number of bins.

Source

pub fn is_empty(&self) -> bool

Whether there are no bins.

Source

pub fn area_m2(&self, i: usize) -> f64

Area of the annulus of bin i, m².

Source

pub fn center_m(&self, i: usize) -> f64

Representative radius of bin i, m: the geometric mean of its edges, and half the outer edge for the central disc.

Source

pub fn density_ev_per_m2(&self) -> Vec<f64>

Mean areal energy density of each bin, eV/m².

Source

pub fn density_std_err_ev_per_m2(&self) -> Vec<f64>

Standard error of each bin’s areal density, eV/m².

Trait Implementations§

Source§

impl Clone for RadialProfile

Source§

fn clone(&self) -> RadialProfile

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 RadialProfile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for RadialProfile

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for RadialProfile

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for RadialProfile

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for RadialProfile

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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