armi.nuclearDataIO.cccc.labels module

Reads and writes region and composition label data from a LABELS interface file.

LABELS files are produced by DIF3D/VARIANT. They are very similar in structure and format to CCCC files but are not officially in the CCCC documents.

The file structure is listed here:

       RECORD TYPE                        PRESENT IF
       ===============================    ================
       FILE IDENTIFICATION                ALWAYS
       SPECIFICATIONS                     ALWAYS
       LABEL AND AREA DATA                ALWAYS
       FINITE-GEOMETRY TRANSVERSE         NHTS1.GT.0 OR
         DISTANCES                         NGTS2.GT.0
       NUCLIDE SET LABELS                 NSETS.GT.1
       ALIAS ZONE LABELS                  NALIAS.GT.0
       GENERAL CONTROL-ROD MODEL DATA     NBANKS.GT.0

***********(REPEAT FOR ALL BANKS)
*      CONTROL-ROD BANK DATA              NBANKS.GT.0
*
*  *******(REPEAT FOR ALL RODS IN BANK)
*  *   CONTROL-ROD CHANNEL DATA           (LLCHN+LLROD+MMESH).GT.0
**********
       BURNUP DEPENDENT CROSS SECTION     NVARY.GT.0
         SPECIFICATIONS
       BURNUP DEPENDENT GROUPS            MAXBRN.GT.0
       BURNUP DEPENDENT FITTING           MAXORD.GT.0
         COEFFICIENTS

Reference: [DIF3D].

Examples

>>> labelData = LabelStream.readBinary("LABELS")

class armi.nuclearDataIO.cccc.labels.LabelsData[source]

Bases: DataContainer

Data structure containing various region, zone, area, nuclide labels.

This is the data structure that is read from or written to a LABELS file.

class armi.nuclearDataIO.cccc.labels.LabelsStream(data: DataContainer, fileName: str, fileMode: str)[source]

Bases: StreamWithDataContainer

Class for reading and writing the LABELS interface file produced by DIF3D/VARIANT.

Notes

Contains region and composition labels, area data, half heights, nuclide set labels, alias zone labels, control-rod model data, and burnup dependent cross section data.