# Copyright 2019 TerraPower, LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""
Module for reading/writing RZFLUX CCCC interface files.
RZFLUX contains Regular Zone Flux, or multigroup flux by neutron energy group
in each zone. It also can hold some convergence and neutron balance information.
The format is defined in [CCCC-IV]_.
Examples
--------
>>> flux = rzflux.readBinary("RZFLUX")
>>> flux.groupFluxes[2, 0] *= 1.1
>>> rzflux.writeBinary(flux, "RZFLUX2")
>>> rzflux.writeAscii(flux, "RZFLUX2.ascii")
"""
from enum import Enum
import numpy
from armi.nuclearDataIO import cccc
RZFLUX = "RZFLUX"
# See CCCC-IV documentation for definitions
FILE_SPEC_1D_KEYS = (
"TIME",
"POWER",
"VOL",
"EFFK",
"EIVS",
"DKDS",
"TNL",
"TNA",
"TNSL",
"TNBL",
"TNBAL",
"TNCRA",
"X1",
"X2",
"X3",
"NBLOK",
"ITPS",
"NZONE",
"NGROUP",
"NCY",
)
[docs]class Convergence(Enum):
"""Convergence behavior flags for ITPS from RZFLUX file."""
NO_ITERATIONS = 0
CONVERGED = 1
CONVERGING = 2
DIVERGING = 3
[docs]class RzfluxData(cccc.DataContainer):
"""
Data representation that can be read from or written to a RZFLUX file.
Notes
-----
Analogous to a IsotxsLibrary for ISTOXS files.
"""
def __init__(self):
cccc.DataContainer.__init__(self)
# 2D data
self.groupFluxes = None
[docs]class RzfluxStream(cccc.StreamWithDataContainer):
"""
Stream for reading to/writing from with RZFLUX data.
Parameters
----------
flux : RzfluxData
Data structure
fileName: str
path to RZFLUX file
fileMode: str
string indicating if ``fileName`` is being read or written, and
in ascii or binary format
"""
@staticmethod
def _getDataContainer() -> RzfluxData:
return RzfluxData()
[docs] def readWrite(self):
"""Step through the structure of the file and read/write it."""
self._rwFileID()
self._rw1DRecord()
self._rw2DRecord()
def _rwFileID(self):
"""
Read/write file id record.
Notes
-----
The username, version, etc are embedded in this string but it's
usually blank. The number 28 was actually obtained from
a hex editor and may be code specific.
"""
with self.createRecord() as record:
self._metadata["label"] = record.rwString(self._metadata["label"], 28)
def _rw1DRecord(self):
"""Read/write File specifications on 1D record."""
with self.createRecord() as record:
vals = record.rwImplicitlyTypedMap(FILE_SPEC_1D_KEYS, self._metadata)
self._metadata.update(vals)
def _rw2DRecord(self):
"""
Read/write the multigroup fluxes (n/cm^2-s) into a NxG matrix.
Notes
-----
Zones are blocked into multiple records so we have to block or unblock
them.
rwMatrix reverses the indices into FORTRAN data order so be
very careful with the indices.
"""
nz = self._metadata["NZONE"]
ng = self._metadata["NGROUP"]
nb = self._metadata["NBLOK"]
if self._data.groupFluxes is None:
# initialize all-zeros here before reading now that we
# have the matrix dimension metadata available.
self._data.groupFluxes = numpy.zeros(
(ng, nz),
dtype=numpy.float32,
)
for bi in range(nb):
jLow, jUp = cccc.getBlockBandwidth(bi + 1, nz, nb)
numZonesInBlock = jUp - jLow + 1
with self.createRecord() as record:
# pass in shape in fortran (read) order
self._data.groupFluxes[:, jLow : jUp + 1] = record.rwMatrix(
self._data.groupFluxes[:, jLow : jUp + 1],
numZonesInBlock,
ng,
)
readBinary = RzfluxStream.readBinary
readAscii = RzfluxStream.readAscii
writeBinary = RzfluxStream.writeBinary
writeAscii = RzfluxStream.writeAscii