armi.nuclearDataIO.cccc.cccc module

Defines containers for the reading and writing standard interface files for reactor physics codes.

armi.nuclearDataIO.cccc.cccc.IMPLICIT_INT = 'IJKLMN'

Letters that trigger implicit integer types in old FORTRAN 77 codes

class armi.nuclearDataIO.cccc.cccc.IORecord(stream, hasRecordBoundaries=True)

Bases: object

A single CCCC record.

Reads or writes information to or from a stream.

Parameters

• stream – A collection of data to be read or written

• hasRecordBoundaries (bool) – A True value means the fortran file was written using access=’sequential’ and contains a 4 byte int count at the beginning and end of each record. Otherwise, if False the fortran file was written using access=’direct’.

Notes

The methods in this object often have rw prefixes, meaning the same method can be used for both reading and writing. We consider this a significant achievement that enforces consistency between the code for reading and writing CCCC records. The tradeoff is that it’s a bit challenging to comprehend at first.

_intSize = 4

_longSize = 8

maxsize = 10

_intFormat = ' {:>+10}'

_intLength = 11

_floatSize = 4

_floatFormat = ' {:+.16E}'

_floatLength = 24

_characterSize = 1

count = 885

open()

Abstract method for opening the stream.

close()

Abstract method for closing the stream.

rwInt(val)

Abstract method for reading or writing an integer.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwBool(val)

Read or write a boolean value from an integer.

rwFloat(val)

Abstract method for reading or writing a floating point (single precision) value.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwDouble(val)

Abstract method for reading or writing a floating point (double precision) value.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwString(val, length)

Abstract method for reading or writing a string.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwList(contents, containedType, length, strLength=0)

A method for reading and writing a (array) of items of a specific type.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the contents should have value, but when the record is being read, contents can be None or anything else; it is ignored.

Warning

If a contents evaluates to True, the array must be the same size as length.

rwMatrix(contents, *shape)

A method for reading and writing a matrix of floating point values.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the contents should have value, but when the record is being read, contents can be None or anything else; it is ignored.

Warning

If a contents is not None, the array must be the same shape as *shape.

rwDoubleMatrix(contents, *shape)

Read or write a matrix of floating point values.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the contents should have value, but when the record is being read, contents can be None or anything else; it is ignored.

Warning

If a contents is not None, the array must be the same shape as *shape.

rwIntMatrix(contents, *shape)

Read or write a matrix of int values.

static _rwMatrix(contents, func, *shape)

Read/write a matrix.

Notes

This can be important for performance when reading large matrices (e.g. scatter matrices). It may be worth investigating numpy.frombuffer on read and something similar on write.

With shape, the first shape argument should be the outermost loop because these are stored in column major order (the FORTRAN way).

Note that numpy.ndarrays can be built with order="F" to have column-major ordering.

So if you have ((MR(I,J),I=1,NCINTI),J=1,NCINTJ) you would pass in the shape as (NCINTJ, NCINTI).

rwImplicitlyTypedMap(keys: List[str], contents) → dict

Read a dict of floats and/or ints with FORTRAN77-style implicit typing.

Length of list is determined by length of list of keys passed in.

class armi.nuclearDataIO.cccc.cccc.BinaryRecordReader(stream, hasRecordBoundaries=True)

Bases: armi.nuclearDataIO.cccc.cccc.IORecord

Writes a single CCCC record in binary format.

Notes

This class reads a single CCCC record in binary format. A CCCC record consists of a leading and ending integer indicating how many bytes the record is. The data contained within the record may be integer, float, double, or string.

open()

Open the record by reading the number of bytes in the record, this value will be used to ensure the entire record was read.

close()

Closes the record by reading the number of bytes from then end of the record, if it does not match the initial value, an exception will be raised.

rwInt(val)

Reads an integer value from the binary stream.

rwBool(val)

Read or write a boolean value from an integer.

rwLong(val)

Reads an integer value from the binary stream.

rwFloat(val)

Reads a single precision floating point value from the binary stream.

rwDouble(val)

Reads a double precision floating point value from the binary stream.

rwString(val, length)

Reads a string of specified length from the binary stream.

class armi.nuclearDataIO.cccc.cccc.BinaryRecordWriter(stream, hasRecordBoundaries=True)

Bases: armi.nuclearDataIO.cccc.cccc.IORecord

a single record from a CCCC file

Reads binary information sequentially.

open()

Abstract method for opening the stream.

close()

Abstract method for closing the stream.

_getPackedNumBytes()

_write_buffer_to_stream(i)

rwInt(val)

Abstract method for reading or writing an integer.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwBool(val)

Read or write a boolean value from an integer.

rwLong(val)

Reads an integer value from the binary stream.

rwFloat(val)

Abstract method for reading or writing a floating point (single precision) value.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwDouble(val)

Abstract method for reading or writing a floating point (double precision) value.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwString(val, length)

Abstract method for reading or writing a string.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

class armi.nuclearDataIO.cccc.cccc.AsciiRecordReader(stream, hasRecordBoundaries=True)

Bases: armi.nuclearDataIO.cccc.cccc.BinaryRecordReader

Reads a single CCCC record in ASCII format.

See also

AsciiRecordWriter

close()

Closes the record by reading the number of bytes from then end of the record, if it does not match the initial value, an exception will be raised.

_getPackedNumBytes()

_write_buffer_to_stream(i)

rwInt(val)

Reads an integer value from the binary stream.

rwFloat(val)

Reads a single precision floating point value from the binary stream.

rwDouble(val)

Reads a double precision floating point value from the binary stream.

rwString(val, length)

Reads a string of specified length from the binary stream.

class armi.nuclearDataIO.cccc.cccc.AsciiRecordWriter(stream, hasRecordBoundaries=True)

Bases: armi.nuclearDataIO.cccc.cccc.IORecord

Writes a single CCCC record in ASCII format.

Since there is no specific format of an ASCII CCCC record, the format is roughly the same as the BinaryRecordWriter, except that the AsciiRecordReader puts a space in front of all values (ints, floats, and strings), and puts a newline character \n at the end of all records.

open()

Abstract method for opening the stream.

close()

Abstract method for closing the stream.

rwInt(val)

Abstract method for reading or writing an integer.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwFloat(val)

Abstract method for reading or writing a floating point (single precision) value.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwDouble(val)

Abstract method for reading or writing a floating point (double precision) value.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

rwString(val, length)

Abstract method for reading or writing a string.

Notes

The method has a seemingly odd signature, because it is used for both reading and writing. When writing, the val should have value, but when the record is being read, val can be None or anything else; it is ignored.

class armi.nuclearDataIO.cccc.cccc.DataContainer

Bases: object

Data representation that can be read/written to/from with a cccc.Stream.

This is an optional convenience class expected to be used in concert with StreamWithDataStructure.

class armi.nuclearDataIO.cccc.cccc.Stream(fileName, fileMode)

Bases: object

An abstract CCCC IO stream.

Warning

This is more of a stream Parser/Serializer than an actual stream.

Notes

A concrete instance of this class should implement the readWrite() method.

Create an instance of a Stream.

Parameters

• fileName (str) – name of the file to be read

• fileMode (str) – the file mode, i.e. ‘w’ for writing ASCII, ‘r’ for reading ASCII, ‘wb’ for writing binary, and ‘rb’ for reading binary.

_fileModes = {'r': <class 'armi.nuclearDataIO.cccc.cccc.AsciiRecordReader'>, 'rb': <class 'armi.nuclearDataIO.cccc.cccc.BinaryRecordReader'>, 'w': <class 'armi.nuclearDataIO.cccc.cccc.AsciiRecordWriter'>, 'wb': <class 'armi.nuclearDataIO.cccc.cccc.BinaryRecordWriter'>}

readWrite()

This method should be implemented on any sub-classes to specify the order of records.

createRecord(hasRecordBoundaries=True)

classmethod readBinary(fileName: str)

Read data from a binary file into a data structure

classmethod readAscii(fileName: str)

Read data from an ASCII file into a data structure

classmethod _read(fileName, fileMode)

classmethod writeBinary(data: armi.nuclearDataIO.cccc.cccc.DataContainer, fileName: str)

Write the contents of a data container to a binary file

classmethod writeAscii(data: armi.nuclearDataIO.cccc.cccc.DataContainer, fileName: str)

Write the contents of a data container to an ASCII file

classmethod _write(lib, fileName, fileMode)

class armi.nuclearDataIO.cccc.cccc.StreamWithDataContainer(data: armi.nuclearDataIO.cccc.cccc.DataContainer, fileName: str, fileMode: str)

Bases: armi.nuclearDataIO.cccc.cccc.Stream

A cccc.Stream that reads/writes to a specialized data container.

This is a relatively common pattern so some of the boilerplate is handled here.

Warning

This is more of a stream Parser/Serializer than an actual stream.

Notes

It should be possible to fully merge this with Stream, which may make this a little less confusing.

Create an instance of a Stream.

Parameters

• fileName (str) – name of the file to be read

• fileMode (str) – the file mode, i.e. ‘w’ for writing ASCII, ‘r’ for reading ASCII, ‘wb’ for writing binary, and ‘rb’ for reading binary.

static _getDataContainer() → armi.nuclearDataIO.cccc.cccc.DataContainer

classmethod _read(fileName: str, fileMode: str)

classmethod _write(data: armi.nuclearDataIO.cccc.cccc.DataContainer, fileName: str, fileMode: str)

classmethod _readWrite(data: armi.nuclearDataIO.cccc.cccc.DataContainer, fileName: str, fileMode: str)

armi.nuclearDataIO.cccc.cccc.getBlockBandwidth(m, nintj, nblok)

Return block bandwidth JL, JU from CCCC interface files.

It is common for CCCC files to block data in various records with a description along the lines of:

WITH M AS THE BLOCK INDEX, JL=(M-1)*((NINTJ-1)/NBLOK +1)+1
AND JU=MIN0(NINTJ,JUP) WHERE JUP=M*((NINTJ-1)/NBLOK +1)

This function computes JL and JU for these purposes. It also converts JL and JU to zero based indices rather than 1 based ones, as is almost always wanted when dealing with python/numpy matrices.

The term bandwidth refers to a kind of sparse matrix representation. Some rows only have columns JL to JH in them rather than 0 to JMAX. The non-zero band from JL to JH is what we’re talking about here.