Struct TfcResult

pub struct TfcResult {
    pub nps: u64,
    pub value: f64,
    pub error: f64,
    pub fom: f64,
}
Expand description

Tally fluctuation chart results

In the MCTAL file, records for the table follow on as many lines as needed.

<nps> <mean> <error> <fom>

  • nps are the number of particle histories run
  • mean is the tally mean
  • error is the relative error
  • fom is the tally Figure of Merit

These are stored in a vector under [TallyFluctuation] results.

Fields§

§nps: u64

Number of particles

§value: f64

Average value

§error: f64

Relative uncertainty

§fom: f64

Figure-of-Merit value

Implementations§

§

impl TfcResult

pub fn absolute_error(&self) -> f64

Absolute error on the result

For example:

let result = TfcResult {
    value: 50.0,
    error: 0.10,
    ..Default::default()
};
/// 10% relative error => 50.0 +/-5.0
assert_eq!(result.absolute_error(), 5.0);

pub fn relative_error(&self) -> f64

Relative error on the result

The MCNP tally outputs are provided and stored as the relative uncertainty anyway. However, having both absolute_error() and relative_error() methods makes intent explicit.

For example:

let result = TfcResult {
    value: 50.0,
    error: 0.10,
    ..Default::default()
};

/// 10% relative error => 50.0 +/-5.0
assert_eq!(result.relative_error(), 0.1);
assert_eq!(result.absolute_error(), 5.0);

Trait Implementations§

§

impl Clone for TfcResult

§

fn clone(&self) -> TfcResult

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
§

impl Debug for TfcResult

§

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

Formats the value using the given formatter. Read more
§

impl Default for TfcResult

§

fn default() -> TfcResult

Returns the “default value” for a type. Read more
§

impl Serialize for TfcResult

§

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

Serialize this value into the given Serde serializer. 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
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> 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.