armi.reactor package

The reactor package houses the data model used in ARMI to represent the reactor during its simulation. It contains definitions of the reactor, assemblies, blocks, components, etc.

The key classes of the reactor package are shown below:

See Developer Docs.

class armi.reactor.ReactorPlugin

Bases: armi.plugins.ArmiPlugin

Plugin exposing built-in reactor components, blocks, assemblies, etc.

static defineBlockTypes()

Function for providing novel Block types from a plugin.

This should return a list of tuples containing (compType, blockType), where blockType is a new Block subclass to register, and compType is the corresponding Component type that should activate it. For instance a HexBlock would be created when the largest component is a Hexagon:

return [(Hexagon, HexBlock)]

static defineAssemblyTypes()

Function for providing novel Assembly types from a plugin.

This should return a list of tuples containing (blockType, assemType), where assemType is a new Assembly subclass to register, and blockType is the corresponding Block subclass that, if present in the assembly, should trigger it to be of the corresponding assemType.

Warning

The utility of subclassing Assembly is suspect, and may soon cease to be supported. In practice, Assembly subclasses provide very little functionality beyond that on the base class, and even that functionality can probably be better suited elsewhere. Moving this code around would let us eliminate the specialized Assembly subclasses altogether. In such a case, this API will be removed from the framework.

Subpackages

• armi.reactor.blueprints package
  • Submodules
    • armi.reactor.blueprints.assemblyBlueprint module
    • armi.reactor.blueprints.blockBlueprint module
    • armi.reactor.blueprints.componentBlueprint module
    • armi.reactor.blueprints.gridBlueprint module
    • armi.reactor.blueprints.isotopicOptions module
    • armi.reactor.blueprints.reactorBlueprint module
• armi.reactor.components package
  • Submodules
    • armi.reactor.components.basicShapes module
    • armi.reactor.components.complexShapes module
    • armi.reactor.components.component module
    • armi.reactor.components.componentParameters module
    • armi.reactor.components.volumetricShapes module
• armi.reactor.converters package
  • Subpackages
    • armi.reactor.converters.parameterSweeps package
      • Submodules
        • armi.reactor.converters.parameterSweeps.generalParameterSweepConverters module
  • Submodules
    • armi.reactor.converters.blockConverters module
    • armi.reactor.converters.geometryConverters module
    • armi.reactor.converters.meshConverters module
    • armi.reactor.converters.pinTypeBlockConverters module
    • armi.reactor.converters.uniformMesh module
      • Requirements
• armi.reactor.parameters package
  • Basic Usage
  • Design Considerations
  • Submodules
    • armi.reactor.parameters.exceptions module
    • armi.reactor.parameters.parameterCollections module
    • armi.reactor.parameters.parameterDefinitions module
    • armi.reactor.parameters.resolveCollections module

Submodules

• armi.reactor.assemblies module
• armi.reactor.assemblyLists module
• armi.reactor.assemblyParameters module
• armi.reactor.blockParameters module
• armi.reactor.blocks module
• armi.reactor.composites module
• armi.reactor.flags module
• armi.reactor.geometry module
• armi.reactor.grids module
• armi.reactor.reactorParameters module
• armi.reactor.reactors module
• armi.reactor.systemLayoutInput module
• armi.reactor.zones module