Containers¶
Many of the readers provided in this project and by read() rely on
custom classes for storing physically-similar data. This includes detector
data, where tallies can be stored next to underlying spatial and/or energy grids,
or depleted material data with isotopes and burnup data. Below are links to
reference documentation for all of the helper classes used in serpentTools
Note
With the exception of the detectors, these classes are not well suited to be created and populated outside of the readers. Much of the data accessing methods are stable, but providing data may change in future versions
Detectors¶
Warning
Serpent 1 detectors are not supported as of 0.8.0
Note
Energy grids are stored in order of increasing energy, exactly as they appear in the output file. The three columns of this array correspond to lower bound, upper bound, and mid-point of that energy group
Class for storing detector data with multiple bins |
|
Class for storing detector data with Cartesian grid |
|
Class for storing detector data with a hexagonal grid |
|
Class for storing detector data with a cylindrical mesh |
|
Class for storing detector data with multiple bins |
Supporting Classes¶
Class that stores data for a single branch. |
|
Base class for storing material data from a depleted material file |
|
Class for storing homogenized universe specifications and retrieving them |
|
Convenient identifier for universes |
|
Base class for storing cross section data an xsplot file |
Branching Collector¶
The xs module provides classes that condense HomogUniv
data read in the serpentTools.BranchingReader. The goal of
of these is to arrange the data in a structure that is more beneficial
for nodal diffusion codes.
Main class that collects and arranges branched data |
|
Class for storing cross sections for a single universe across branches |