armi.physics.fuelCycle.fuelHandlerInterface module

A place for the FuelHandler’s Interface.

class armi.physics.fuelCycle.fuelHandlerInterface.FuelHandlerInterface(r, cs)

Bases: Interface

Moves and/or processes fuel in a Standard Operator.

Fuel management traditionally runs at the beginning of a cycle, before power or temperatures have been updated. This allows pre-run fuel management steps for highly customized fuel loadings. In typical runs, no fuel management occurs at the beginning of the first cycle and the as-input state is left as is.

Implementation: ARMI provides a shuffle logic interface. I_ARMI_SHUFFLE

signature: FuelHandlerInterface requirements: R_ARMI_SHUFFLE

This interface allows for a user to define custom shuffle logic that modifies to the core model. Being based on the Interface class, it has direct access to the current core model. User logic is able to be executed from within the manageFuel() method, which will use the fuelHandlerFactory() to search for a Python file specified by the case setting shuffleLogic. If it exists, the fuel handler with name specified by the user via the fuelHandlerName case setting will be imported, and any actions in its outage method will be executed at the interactBOC() hook. If no class with the name specified by the fuelHandlerName setting is found in the file with path shuffleLogic, an error is returned. See the user manual for how the custom shuffle logic file should be constructed.

name: str | None = 'fuelHandler'

The name of the interface. This is undefined for the base class, and must be overridden by any concrete class that extends this one.

static specifyInputs(cs)

interactBOC(cycle=None)

Move and/or process fuel.

Also, if requested, first have the lattice physics system update XS.

interactEOC(cycle=None)

interactEOL()

Make reports at EOL.

manageFuel(cycle)

Perform the fuel management for this cycle.

makeShuffleReport()

Create a data file listing all the shuffles that occurred in a case.

This can be used to export shuffling to an external code or to perform explicit repeat shuffling in a restart. It creates a *SHUFFLES.txt file based on the Reactor.moves structure

See also

readMoves

reads this file and parses it.

workerOperate(cmd)

Delegate mpi command to the fuel handler object.