armi.reactor.blueprints.componentBlueprint module

This module defines the ARMI input for a component definition, and code for constructing an ARMI Component.

Special logic is required for handling component links.

class armi.reactor.blueprints.componentBlueprint.ComponentDimension(value)

Bases: yamlize.objects.Object

Dummy object for ensuring well-formed component links are specified within the YAML input.

This can be either a number (float or int), or a conformation string (name.dimension).

classmethod from_yaml(loader, node, _rtd=None)

Override the Yamlizable.from_yaml to inject custom interpretation of component dimension.

This allows us to create a new object with either a string or numeric value.

classmethod to_yaml(dumper, self, _rtd=None)

Override the Yamlizable.to_yaml to remove the object-like behavior, otherwise we’d end up with a {value: ...} dictionary.

This allows someone to programmatically edit the component dimensions without using the ComponentDimension class.

attributes = <yamlize.attribute_collection.AttributeCollection object>

class armi.reactor.blueprints.componentBlueprint.ComponentBlueprint

Bases: yamlize.objects.Object

This class defines the inputs necessary to build ARMI component objects. It uses yamlize to enable serialization to and from YAML.

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

shape

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

material

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

Tinput

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

Thot

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

isotopics

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

centers

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

orientation

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

mergeWith

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

construct(blueprint, matMods)

Construct a component

area

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

attributes = <yamlize.attribute_collection.AttributeCollection object>

axialPitch

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

azimuthal_differential

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

base

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

heightInner

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

heightOuter

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

helixDiameter

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

holeOD

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

id

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

inner_axial

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

inner_minor_radius

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

inner_phi

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

inner_radius

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

inner_theta

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

ip

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

lengthInner

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

lengthOuter

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

major_radius

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

modArea

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

mult

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

nHoles

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

od

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

op

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

outer_minor_radius

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

outer_phi

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

outer_radius

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

outer_theta

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

radius_differential

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

reference_volume

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

volume

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

widthInner

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

widthOuter

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