serpentTools.xs.BranchedUniv

class serpentTools.xs.BranchedUniv(univID, collector, ndims=None)

Class for storing cross sections for a single universe across branches

New in version 0.7.0.

Parameters
  • univID (str or int) – Unique ID for this universe

  • collector (BranchCollector) – Class that parses and places branched coefficient data

  • ndims (int or iterable) – Number of perturbation dimensions

filePath

Location of the file that stores the data on this object

Type

str

univID

Unique ID for this universe

Type

str or int

collector

Class that parses and places branched coefficient data

Type

BranchCollector

xsTables

Dictionary with keys representing specific values, e.g. 'infTot' and 'b1Diffcoeff'. Corresponding values are BranchedDataTable objects that store cross section and group constant data across perturbation states

Type

dict

__getitem__(key)

Access the xsTables dictionary

property axis

Tuple describing axis of underlying data

Note

When setting, the universe index of the axis should not be changed. The changes are passed on to BranchCollector.axis with an indicator for universe placed in the correct spot

Examples

>>> col.axis
('Universe', 'BOR', 'TFU', 'Burnup', 'Group')
>>> u0 = col.universes[0]
>>> u0.axis == col.axis[1:]
True
>>> u0.axis = ['boron conc', 'fuel temp', 'burnup', 'group']
>>> u0.axis
('boron conc', 'fuel temp', 'burnup', 'group')
>>> col.axis
('Universe', 'boron conc', 'fuel temp', 'burnup', 'group')
property burnups

Vector of burnups from coefficient file

items()

Iterate over names of cross sections and associated objects

property perturbations

Iterable indicating the specific perturbation types

property states

Iterable describing the names or values of each perturbation branch. Length is equal to that of perturbations, and the i-th index of states indicates the values perturbation perturbations[i] experiences.