armi.reactor.blueprints.blockBlueprint module

This module defines the ARMI input for a block definition, and code for constructing an ARMI Block.

class armi.reactor.blueprints.blockBlueprint.BlockBlueprint(*args, **kwargs)[source]

Bases: KeyedList

Input definition for Block.

Implementation: Create a Block from blueprint file. I_ARMI_BP_BLOCK

signature: BlockBlueprint

Defines a yaml construct that allows the user to specify attributes of a block from within their blueprints file, including a name, flags, a radial grid to specify locations of pins, and the name of a component which drives the axial expansion of the block (see axialExpansionChanger).

In addition, the user may specify key-value pairs to specify the components contained within the block, where the keys are component names and the values are component blueprints (see ComponentBlueprint).

Relies on the underlying infrastructure from the yamlize package for reading from text files, serialization, and internal storage of the data.

Is implemented into a blueprints file by being imported and used as an attribute within the larger Blueprints class.

Includes a construct method, which instantiates an instance of Block with the characteristics as specified in the blueprints.

Initialize a Map.

Parameters:

*args – sequence of key/value pairs.
**kwargs – kwargs for input to OrderedDict.

item_type: alias of ComponentBlueprint

construct(cs, blueprint, axialIndex, axialMeshPoints, height, xsType, materialInput)[source]

Construct an ARMI Block to be placed in an Assembly.

Parameters:

cs (Settings) – Settings object for the appropriate simulation.
blueprint (Blueprints) – Blueprints object containing various detailed information, such as nuclides to model
axialIndex (int) – The Axial index this block exists within the parent assembly
axialMeshPoints (int) – number of mesh points for use in the neutronics kernel
height (float) – initial height of the block
xsType (str) – String representing the xsType of this block.
materialInput (dict) – Double-layered dict. Top layer groups the by-block material modifications under the byBlock key and the by-component material modifications under the component’s name. The inner dict under each key contains material modification names and values.

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>

class armi.reactor.blueprints.blockBlueprint.BlockKeyedList(*args, **kwargs)[source]

Bases: KeyedList

An OrderedDict of BlockBlueprints keyed on the name. Utilizes yamlize for serialization to and from YAML.

This is used within the blocks: main entry of the blueprints.

Initialize a Map.

Parameters:

*args – sequence of key/value pairs.
**kwargs – kwargs for input to OrderedDict.

item_type: alias of BlockBlueprint

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>

class armi.reactor.blueprints.blockBlueprint.BlockList(items=())[source]

Bases: Sequence

A list of BlockBlueprints keyed on the name. Utilizes yamlize for serialization to and from YAML.

This is used to define the blocks: attribute of the assembly definitions.

item_type: alias of BlockBlueprint