Struct VoxelReport 

pub struct VoxelReport {
    pub grid: VoxelTallyGrid,
    pub histories: u64,
    pub voxels: Vec<VoxelRecord>,
    pub outside: VoxelCell,
    pub species_z: Vec<u8>,
    pub outside_defects: Vec<SpeciesDefects>,
}

A VoxelTally as plain data. Voxels are in increasing flat-index order (i + nx (j + ny k)).

Fields

grid: VoxelTallyGrid

The grid the voxels refer to.

histories: u64

Primary histories tallied.

voxels: Vec<VoxelRecord>

Occupied voxels.

outside: VoxelCell

Sum of the events outside the grid.

species_z: Vec<u8>

Atomic number of each species index; empty when defects were not tallied (VoxelTally::with_species).

outside_defects: Vec<SpeciesDefects>

Defects outside the grid, per species index.

Implementations

impl VoxelReport

pub fn defect_totals(&self) -> Vec<SpeciesDefects>

Per-species defects summed over the occupied voxels (not including Self::outside_defects); empty without species.

pub fn grand_defect_totals(&self) -> Vec<SpeciesDefects>

Per-species defects over the grid and the outside.

pub fn totals(&self) -> VoxelCell

Sum over the occupied voxels (not including Self::outside), added in flat-index order.

pub fn grand_totals(&self) -> VoxelCell

Sum over the grid and the outside: everything the tally received.

pub fn profile(&self, axis: usize) -> Vec<VoxelCell>

Per-slab sums along axis (0 = x): entry n adds every occupied voxel whose index on that axis is n. This is the laterally integrated profile, comparable to a 1D depth tally of the same bins.

pub fn write_csv<W: Write>(&self, w: W) -> Result<()>

Write the CSV export: a # key = value header, a column row, then one row per occupied voxel (indices, centre in m, tallies; energies in eV). See the module docs.

pub fn write_export_csv<W: Write>( &self, w: W, p: &ExportProvenance, ) -> Result<()>

Write the damage-export file: the Self::write_csv layout under the EXPORT_BANNER, with the provenance and units keys in the header (docs/damage-export-format.md). Floats are the shortest text that reads back to the same bits, so Self::read_export_csv returns the report unchanged.

pub fn to_export_csv(&self, p: &ExportProvenance) -> String

The damage-export file as a string.

pub fn to_csv(&self) -> String

The CSV export as a string.

pub fn read_csv(text: &str) -> Result<Self, VoxelTallyError>

Read back a file written by Self::write_csv.

pub fn read_export_csv( text: &str, ) -> Result<(Self, ExportProvenance), VoxelTallyError>

Read back a file written by Self::write_export_csv, with its provenance. Errors if the banner, the format version or any provenance key is missing.

pub fn write_vtk<W: Write>(&self, w: W) -> Result<()>

Write the legacy ASCII VTK export: an UNSTRUCTURED_GRID with one VTK_VOXEL cell per occupied voxel and the tallies as cell scalars. The grid and the history count are in the title line. See the module docs.

pub fn to_vtk(&self) -> String

The VTK export as a string.

pub fn read_vtk(text: &str) -> Result<Self, VoxelTallyError>

Read back a file written by Self::write_vtk. The result has an empty Self::outside, which the VTK file does not carry.

Trait Implementations

impl Clone for VoxelReport

fn clone(&self) -> VoxelReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VoxelReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for VoxelReport

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for VoxelReport

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for VoxelReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for VoxelReport