Struct MeshtalReader

pub struct MeshtalReader { /* private fields */ }
Expand description

A generalised reader for legacy meshtal files of any type

Supports COL, CF, UKAEA Cell-under-Voxel, IJ, IK, and JK output formats for both rectangular and cylindrical meshes.

The reader operates in two stages to minimise time wasted on erroneous inputs:

  • Quickly check mesh tally IDs and auto-detect their formatting
  • Extract the data using the appropriate parsing strategy

Notes:

  • CuV results are weighted by volume of each contributing cell
  • VoidRecord::Off will fill in missing void voxels with 0.0 flux
  • Run-on numbers without whitespace are handled e.g. 1.00E+00-2.00E+00
  • Broken exponential formatting is handled e.g. 1.00+002 => 1.00E+002
  • Rectangualr mesh origin set to match FMESH input cards

Minimal Example:

let path = Path::new("path/to/file.msht");
let mut reader = MeshtalReader::new();
let mesh_list = reader.parse(path).unwrap();

Implementations§

§

impl MeshtalReader

High level methods

pub fn new() -> Self

Just calls Default::default(), nothing special to be initialised

pub fn parse(&mut self, path: &Path) -> Result<Vec<Mesh>, Error>

Parses all mesh data from a mcnp meshtal file

May need to implement something to ensure precision consistency for the energy and time group values used

pub fn set_target_id(&mut self, target_id: u32)

Setter for specifying which mesh to target

pub fn disable_progress(&mut self)

Do not print the tqdm progress indicators

Trait Implementations§

§

impl Debug for MeshtalReader

§

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

Formats the value using the given formatter. Read more
§

impl Default for MeshtalReader

§

fn default() -> Self

Returns the “default value” for a type. 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> 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> Same for T

Source§

type Output = T

Should always be Self
§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

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

Checks if self is actually part of its subset T (and can be converted to it).
§

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

The inclusion map: converts self to the equivalent element of its superset.
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.