armi.operators package

Operators build and hold the ARMI reactor model and perform operations on it.

Different operators may perform different calculation loops upon the reactor model. Operators can be thought of as schedulers for the interactions between the various ARMI physics packages and the reactor object(s).

Operators are generally created by a armi.cases object and are chosen by the runType setting. Custom operators may be introduced via the armi.plugins system.

The ARMI framework comes with two general-purpose Operators, which can be used for very real analysis given a proper set of plugins. The Operator is the Standard operator, which loops over cycles and timenodes. The OperatorSnapshots is the Snapshots operator, which loops over specific point in time from a previous Standard run and performs additional analysis (e.g. for detailed follow-on analysis/transients).

See also

armi.cases

Builds operators

armi.reactor

The reactor model that the operator operates upon

armi.interfaces

Code that operators schedule to perform the real analysis or math on the reactor model

armi.operators.factory(cs)

Choose an operator subclass and instantiate it object based on settings.

armi.operators.getOperatorClassFromSettings(cs)

Choose a operator class based on user settings (possibly from plugin).

Parameters:

cs (Settings) –

Returns:

Operator

Return type:

Operator

Raises:

ValueError – If the Operator class cannot be determined from the settings.

Subpackages

• armi.operators.tests package
  • Submodules
    • armi.operators.tests.test_operatorSnapshots module
      • TestOperatorSnapshots
      • TestOperatorSnapshotsSettings
    • armi.operators.tests.test_operators module
      • InterfaceA
      • InterfaceB
      • InterfaceC
      • OperatorTests
      • TestCreateOperator
      • TestTightCoupling
      • CyclesSettingsTests
      • TestInterfaceAndEventHeaders

Submodules

• armi.operators.operator module
  • Operator
    • Operator.inspector
    • Operator.burnSteps
    • Operator.maxBurnSteps
    • Operator.stepLengths
    • Operator.cycleLengths
    • Operator.powerFractions
    • Operator.availabilityFactors
    • Operator.cycleNames
    • Operator.atEOL
    • Operator.initializeInterfaces()
    • Operator.operate()
    • Operator.printInterfaceSummary()
    • Operator.interactAllInit()
    • Operator.interactAllBOL()
    • Operator.interactAllBOC()
    • Operator.interactAllEveryNode()
    • Operator.interactAllEOC()
    • Operator.interactAllEOL()
    • Operator.interactAllCoupled()
    • Operator.interactAllError()
    • Operator.createInterfaces()
    • Operator.addInterface()
    • Operator.removeAllInterfaces()
    • Operator.removeInterface()
    • Operator.getInterface()
    • Operator.interfaceIsActive()
    • Operator.getInterfaces()
    • Operator.getActiveInterfaces()
    • Operator.reattach()
    • Operator.detach()
    • Operator.loadState()
    • Operator.snapshotRequest()
    • Operator.setStateToDefault()
    • Operator.couplingIsActive()
• armi.operators.operatorMPI module
  • OperatorMPI
    • OperatorMPI.operate()
    • OperatorMPI.workerOperate()
    • OperatorMPI.workerQuit()
    • OperatorMPI.collapseAllStderrs()
• armi.operators.runTypes module
  • RunTypes
    • RunTypes.STANDARD
    • RunTypes.SNAPSHOTS
    • RunTypes.EQUILIBRIUM
• armi.operators.settingsValidation module
• armi.operators.snapshots module
  • OperatorSnapshots
    • OperatorSnapshots.createInterfaces()
    • OperatorSnapshots.setStateToDefault()
    • OperatorSnapshots.atEOL