armi.reactor.blueprints.assemblyBlueprint module

This module defines the blueprints input object for assemblies.

In addition to defining the input format, the AssemblyBlueprint class is responsible for constructing Assembly objects. An attempt has been made to decouple Assembly construction from the rest of ARMI as much as possible. For example, an assembly does not require a reactor to be constructed, or a geometry file (but uses contained Block geometry type as a surrogate).

class armi.reactor.blueprints.assemblyBlueprint.Modifications(*args, **kwargs)[source]

Bases: yamlize.maps.Map

The names of material modifications and lists of the modification values for each block in the assembly.

Initialize a Map.

Parameters

  • *args – sequence of key/value pairs.

  • **kwargs – kwargs for input to OrderedDict.

key_type

alias of yamlize.yamlizable.Yamlizablestr

value_type

alias of yamlize.sequences.Sequence

attributes = <yamlize.attribute_collection.MapAttributeCollection object>
class armi.reactor.blueprints.assemblyBlueprint.ByComponentModifications(*args, **kwargs)[source]

Bases: yamlize.maps.Map

The name of a component within the block and an associated Modifications object.

Initialize a Map.

Parameters

  • *args – sequence of key/value pairs.

  • **kwargs – kwargs for input to OrderedDict.

key_type

alias of yamlize.yamlizable.Yamlizablestr

value_type

alias of armi.reactor.blueprints.assemblyBlueprint.Modifications

attributes = <yamlize.attribute_collection.MapAttributeCollection object>
class armi.reactor.blueprints.assemblyBlueprint.MaterialModifications(*args, **kwargs)[source]

Bases: yamlize.maps.Map

A yamlize map for reading and holding material modifications.

A user may specify material modifications directly as keys/values on this class, in which case these material modifications will be blanket applied to the entire block.

If the user wishes to specify material modifications specific to a component within the block, they should use the by component attribute, specifying the keys/values underneath the name of a specific component in the block.

Initialize a Map.

Parameters

  • *args – sequence of key/value pairs.

  • **kwargs – kwargs for input to OrderedDict.

key_type

alias of yamlize.yamlizable.Yamlizablestr

value_type

alias of yamlize.sequences.Sequence

byComponent

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.MapAttributeCollection object>
class armi.reactor.blueprints.assemblyBlueprint.AssemblyBlueprint(*args, **kwargs)[source]

Bases: yamlize.objects.Object

A data container for holding information needed to construct an ARMI assembly.

This class utilizes yamlize to enable serialization to and from the blueprints YAML file.

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.

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.

specifier

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.

blocks

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.

height

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.

axialMeshPoints

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.

radialMeshPoints

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.

azimuthalMeshPoints

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.

materialModifications

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.

xsTypes

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.

classmethod getAssemClass(blocks)[source]

Get the ARMI Assembly class for the specified blocks

Parameters

blocks (list of Blocks) – Blocks for which to determine appropriate containing Assembly type

construct(cs, blueprint)[source]

Construct an instance of this specific assembly blueprint.

Parameters

  • cs (CaseSettings) – CaseSettings object which containing relevant modeling options.

  • blueprint (Blueprint) – Root blueprint object containing relevant modeling options.

attributes = <yamlize.attribute_collection.AttributeCollection object>
fuelVent

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.

hotChannelFactors

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.assemblyBlueprint.AssemblyKeyedList(*args, **kwargs)[source]

Bases: yamlize.maps.KeyedList

Effectively and OrderedDict of assembly items, keyed on the assembly name.

This uses yamlize KeyedList for YAML serialization.

Initialize a Map.

Parameters

  • *args – sequence of key/value pairs.

  • **kwargs – kwargs for input to OrderedDict.

item_type

alias of armi.reactor.blueprints.assemblyBlueprint.AssemblyBlueprint

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.

heights

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.

axialMeshPoints

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.

property bySpecifier

Used by the reactor to _loadAssembliesIntoCore later, specifiers are two character strings

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>