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 geomType string as a surrogate).

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

Bases: yamlize.maps.Map

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.AssemblyBlueprint[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.

name

name of the attribute within the Python class

Type: str

key¶

name of the attribute within the YAML representation

Type: str

type¶

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.

Type: type or ANY

default¶

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name¶

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

specifier¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

blocks¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

height¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

axialMeshPoints¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

materialModifications¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

xsTypes¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

classmethod getAssemClass(blocks)[source]¶

Get the ARMI Assembly class for the specified geomType

Parameters: geomType (str) – Geometry type string.

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.

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

hotChannelFactors¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

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 AssemblyBlueprint

key_attr¶

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

name¶

name of the attribute within the Python class

Type: str

key¶

name of the attribute within the YAML representation

Type: str

type¶

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.

Type: type or ANY

default¶

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name¶

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

heights¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

axialMeshPoints¶

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

name

name of the attribute within the Python class

Type: str

key

name of the attribute within the YAML representation

Type: str

type

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.

Type: type or ANY

default

default value if not supplied in YAML. If default=NODEFAULT, then the attribute must be supplied.

Type: value or NODEFAULT

storage_name

'_yamlized_' + name, stored as a separate attribute for speed.

Type: str

property bySpecifier¶: Used by the reactor to _loadAssembliesIntoCore later, specifiers are two character strings

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>¶