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 runmean
is the tally meanerror
is the relative errorfom
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
impl TfcResult
pub fn absolute_error(&self) -> f64
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
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§
Auto Trait Implementations§
impl Freeze for TfcResult
impl RefUnwindSafe for TfcResult
impl Send for TfcResult
impl Sync for TfcResult
impl Unpin for TfcResult
impl UnwindSafe for TfcResult
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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
impl<T> Pointable for T
§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self
from the equivalent element of its
superset. Read more§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self
is actually part of its subset T
(and can be converted to it).§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset
but without any property checks. Always succeeds.§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self
to the equivalent element of its superset.