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: yamlize.maps.KeyedList

Input definition for Block.

Initialize a Map.

Parameters

  • *args – sequence of key/value pairs.

  • **kwargs – kwargs for input to OrderedDict.

item_type

alias of armi.reactor.blueprints.componentBlueprint.ComponentBlueprint

key_attr

Represents an attribute of a Python class, and a key/value pair in YAML.

Variables

  • name (str) – name of the attribute within the Python class

  • key (str) – name of the attribute within the YAML representation

  • type (type or ANY) – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.

  • default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

  • storage_name (str) – '_yamlized_' + name, stored as a separate attribute for speed.

name

Represents an attribute of a Python class, and a key/value pair in YAML.

Variables

  • name (str) – name of the attribute within the Python class

  • key (str) – name of the attribute within the YAML representation

  • type (type or ANY) – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.

  • default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

  • storage_name (str) – '_yamlized_' + name, stored as a separate attribute for speed.

gridName

Represents an attribute of a Python class, and a key/value pair in YAML.

Variables

  • name (str) – name of the attribute within the Python class

  • key (str) – name of the attribute within the YAML representation

  • type (type or ANY) – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.

  • default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

  • storage_name (str) – '_yamlized_' + name, stored as a separate attribute for speed.

flags

Represents an attribute of a Python class, and a key/value pair in YAML.

Variables

  • name (str) – name of the attribute within the Python class

  • key (str) – name of the attribute within the YAML representation

  • type (type or ANY) – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.

  • default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

  • storage_name (str) – '_yamlized_' + name, stored as a separate attribute for speed.

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

Construct an ARMI Block to be placed in an Assembly.

Parameters

  • cs (CaseSettings) – CaseSettings 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>
inletLossCoeff

Represents an attribute of a Python class, and a key/value pair in YAML.

Variables

  • name (str) – name of the attribute within the Python class

  • key (str) – name of the attribute within the YAML representation

  • type (type or ANY) – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.

  • default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

  • storage_name (str) – '_yamlized_' + name, stored as a separate attribute for speed.

pressureLossCoeffs

Represents an attribute of a Python class, and a key/value pair in YAML.

Variables

  • name (str) – name of the attribute within the Python class

  • key (str) – name of the attribute within the YAML representation

  • type (type or ANY) – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.

  • default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

  • storage_name (str) – '_yamlized_' + name, stored as a separate attribute for speed.

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

Bases: yamlize.maps.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 armi.reactor.blueprints.blockBlueprint.BlockBlueprint

key_attr

Represents an attribute of a Python class, and a key/value pair in YAML.

Variables

  • name (str) – name of the attribute within the Python class

  • key (str) – name of the attribute within the YAML representation

  • type (type or ANY) – type of the attribute within the Python class. When ANY, the type is a pass-through and whatever YAML determines it should be will be applied.

  • default (value or NODEFAULT) – default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

  • storage_name (str) – '_yamlized_' + name, stored as a separate attribute for speed.

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>
class armi.reactor.blueprints.blockBlueprint.BlockList(items=())[source]

Bases: yamlize.sequences.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 armi.reactor.blueprints.blockBlueprint.BlockBlueprint