armi.reactor.blueprints.isotopicOptions module¶

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

class armi.reactor.blueprints.isotopicOptions.NuclideFlag(nuclideName, burn, xs)[source]¶

Bases: yamlize.objects.Object

This class defines a nuclide options for use within the ARMI simulation, defining whether or not it should be included in the burn chain and cross sections.

nuclideName¶

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

burn¶

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

xs¶

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

prepForCase(activeSet, inertSet, undefinedBurnChainActiveNuclides)[source]¶: Take in the string nuclide or element name, try to expand it out to its bases correctly.

attributes = <yamlize.attribute_collection.AttributeCollection object>¶

class armi.reactor.blueprints.isotopicOptions.NuclideFlags(*args, **kwargs)[source]¶

Bases: yamlize.maps.KeyedList

An OrderedDict of NuclideFlags, keyed by their nuclideName.

Initialize a Map.

Parameters

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

item_type¶: alias of NuclideFlag

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

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>¶

class armi.reactor.blueprints.isotopicOptions.CustomIsotopic(name, inputFormat, density)[source]¶

Bases: yamlize.maps.Map

User specified, custom isotopics input defined by a name (such as MOX), and key/pairs of nuclide names and numeric values consistent with the input format.

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.yamlizable.Yamlizablefloat

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

inputFormat¶

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 density¶

attributes = <yamlize.attribute_collection.MapAttributeCollection object>¶

classmethod from_yaml(loader, node, rtd)[source]¶: Override the Yamlizable.from_yaml to inject custom data validation logic, and complete initialization of the object.

classmethod from_yaml_key_val(loader, key_node, val_node, key_attr, rtd)[source]¶: Override the Yamlizable.from_yaml to inject custom data validation logic, and complete initialization of the object.

apply(material)[source]¶

Apply specific isotopic compositions to a component.

Generically, materials have composition-dependent bulk properties such as mass density. Note that this operation does not update these material properties. Use with care.

Parameters: material (Material) – An ARMI Material instance.

class armi.reactor.blueprints.isotopicOptions.CustomIsotopics(*args, **kwargs)[source]¶

Bases: yamlize.maps.KeyedList

OrderedDict of CustomIsotopic objects, keyed by their name.

Initialize a Map.

Parameters

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

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>¶

item_type¶: alias of CustomIsotopic

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

apply(material, customIsotopicsName)[source]¶

Apply specific isotopic compositions to a component.

Generically, materials have composition-dependent bulk properties such as mass density. Note that this operation does not update these material properties. Use with care.

Parameters

material (Material) – Material instance to adjust.
customIsotopicName (str) – String corresponding to the CustomIsoptopic.name.