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.

name: Optional[str] = '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.