armi.reactor.geometry module

Reads the input files that define where the major systems are and what’s in them.

This includes the core-map, showing which assemblies are where in a core, and may also include a spent fuel pool, pumps, heat exchangers, etc.

The blueprints input files define the low-level dimensions and compositions of parts, and this file maps those definitions to locations throughout the reactor model.

It may eventually also describe the pin-maps within assemblies for solid fuel.

Historically, this file was called the “Geometry Input File”, but that’s too generic so we changed it to reduce new user confusion.

Where the original geom.xml file had just one set of assemblies in the core and other systems were pointed to in the blueprints file, we eventually anticipate moving all systems definitions to this geometry file.

See also

reactor.blueprints.reactorBlueprint

armi.reactor.geometry.loadFromCs(cs)[source]

Function to load Geoemtry based on supplied CaseSettings.

class armi.reactor.geometry.SystemLayoutInput[source]

Bases: object

Geometry file. Contains 2-D mapping of geometry.

ROOT_TAG = 'reactor'
readGeomFromFile(fName)[source]

Read the 2-d geometry input file.

See also

fromReactor()

Build SystemLayoutInput from a Reactor object.

readGeomFromStream(stream)[source]

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.

modifyEqPaths(modifiedPaths)[source]

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='')[source]

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()[source]

Convert geometry input to full core.

Notes

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

armi.reactor.geometry.fromReactor(reactor)[source]

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

See also

readGeomFromFile()

Builds a SystemLayoutInput from an XML file.