armi.reactor.systemLayoutInput module

The legacy SystemLayoutInput class and supporting code.

This module contains the soon-to-be defunct SystemLayoutInput class, which used to be used for specifying assembly locations in the core. This has been replaced by the systems: and grids: sections of Blueprints, but still exists to facilitate input migrations.

See also

reactor.blueprints.reactorBlueprint, reactor.blueprints.gridBlueprint

class armi.reactor.systemLayoutInput.SystemLayoutInput

Bases: object

Geometry file. Contains 2-D mapping of geometry.

This approach to specifying core layout has been deprecated in favor of the armi.reactor.blueprints.gridBlueprints.GridBlueprints and systems: section of armi.reactor.blueprints.Blueprints

ROOT_TAG = 'reactor'

readGeomFromFile(fName)

Read the 2-d geometry input file.

See also

fromReactor

Build SystemLayoutInput from a Reactor object.

readGeomFromStream(stream)

Read geometry info from a stream.

This populates the object with info from any source.

Notes

There are two formats of geometry: yaml and xml. This tries xml first (legacy), and if it fails it tries yaml.

toGridBlueprints(name: str = 'core')

Migrate old-style SystemLayoutInput to new GridBlueprint.

Returns a list of GridBlueprint objects. There will at least be one entry, containing the main core layout. If equilibrium fuel paths are specified, it will occupy the second element.

modifyEqPaths(modifiedPaths)

Modifies the geometry object by updating the equilibrium path indices and equilibrium path cycles.

Parameters:

modifiedPaths (dict, required) – This is a dictionary that contains the indices that are mapped to the eqPathIndex and eqPathCycle. modifiedPath[indices] = (eqPathIndex, eqPathCycle)

writeGeom(outputFileName, suffix='')

Write data out as a geometry xml file.

Parameters:

• outputFileName (str) – Geometry file name

• suffix (str) – Added suffix to the geometry output file name

growToFullCore()

Convert geometry input to full core.

Notes

This only works for Hex 1/3rd core geometry inputs.

classmethod fromReactor(reactor)

Build SystemLayoutInput object based on the current state of a Reactor.

See also

readGeomFromFile

Builds a SystemLayoutInput from an XML file.

classmethod loadFromCs(cs)

Function to load Geoemtry based on supplied CaseSettings.