armi.reactor.reactors module

Reactor objects represent the highest level in the hierarchy of structures that compose the system to be modeled.

class armi.reactor.reactors.Reactor(name, blueprints)

Bases: Composite

Top level of the composite structure, potentially representing all components in a reactor.

This class contains the core and any ex-core structures that are to be represented in the ARMI model. Historically, the Reactor contained only the core. To support better representation of ex-core structures, the old Reactor functionality was moved to the newer Core class, which has a Reactor parent.

Implementation: The user-specified reactor. I_ARMI_R

signature: Reactor requirements: R_ARMI_R

The Reactor is the top level of the composite structure, which can represent all components within a reactor core. The reactor contains a Core, which contains a collection of Assembly objects arranged in a hexagonal or Cartesian grid. Each Assembly consists of a stack of Block objects, which are each composed of one or more Component objects. Each Interface is able to interact with the reactor and its child Composites by retrieving data from it or writing new data to it. This is the main medium through which input information and the output of physics calculations is exchanged between interfaces and written to an ARMI database.

pDefs = <armi.reactor.parameters.parameterDefinitions.ParameterDefinitionCollection object>

add(container)

incrementAssemNum()

Increase the max assembly number by one and returns the current value.

Notes

The “max assembly number” is not currently used in the Reactor. So the idea is that we return the current number, then iterate it for the next assembly.

Obviously, this method will be unused for non-assembly-based reactors.

Returns:

The new max Assembly number.

Return type:

int

normalizeNames()

Renumber and rename all the Assemblies and Blocks.

This method normalizes the names in the Core then the SFP.

Returns:

The new max Assembly number.

Return type:

int

paramCollectionType

alias of ReactorParameterCollection

armi.reactor.reactors.loadFromCs(cs) → Reactor

Load a Reactor based on the input settings.

Parameters:

cs (Settings) – A relevant settings object

Returns:

Reactor loaded from settings file

Return type:

Reactor

armi.reactor.reactors.factory(cs, bp) → Reactor

Build a reactor from input settings and blueprints.