armi.reactor.blueprints.reactorBlueprint module¶

Definitions of top-level reactor arrangements like the Core (default), SFP, etc.

Each structure is defined by a name and a geometry xml file.

See documentation of blueprints in The Blueprints Input File. See example in armi.reactor.blueprints.tests.test_reactorBlueprints.

Lattices will form tightly to the pitch of their children by default but you can spread them out by adding the optional lattice pitch key. This can be useful for adding grids with lots of spacing between objects.

This was built on top of an existing system that loaded the core geometry from the global setting cs[‘geometry’]. This system will still allow that to exist but will error out if you define core here and there at the same time.

See also

armi.reactor.geometry.SystemLayoutInput: reads the individual face-map xml files.

class armi.reactor.blueprints.reactorBlueprint.Triplet(x=0.0, y=0.0, z=0.0)[source]¶

Bases: yamlize.objects.Object

A x, y, z triplet for coordinates or lattice pitch.

x¶

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

y¶

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

z¶

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

class armi.reactor.blueprints.reactorBlueprint.SystemBlueprint(name=None, latticeFile=None, origin=None, latticeDimensions=None)[source]¶

Bases: yamlize.objects.Object

The reactor-level structure input blueprint.

A Reactor Level Structure like a core or SFP.

Notes

yamlize does not call an __init__ method, instead it uses __new__ and setattr this is only needed for when you want to make this object from a non-YAML source.

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

latticeFile¶

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

origin¶

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

latticeDimensions¶

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(cs, bp, reactor, geom=None)[source]¶: Build a core/IVS/EVST/whatever and fill it with children.

attributes = <yamlize.attribute_collection.AttributeCollection object>¶

class armi.reactor.blueprints.reactorBlueprint.Systems(*args, **kwargs)[source]¶

Bases: yamlize.maps.KeyedList

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 SystemBlueprint

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

armi.reactor.blueprints.reactorBlueprint.summarizeMaterialData(container)[source]¶

Create a summary of the material objects and source data for a reactor container.

Parameters: container (Core object) – Any Core object with Blocks and Components defined.

armi.reactor.blueprints.reactorBlueprint.migrate(bp, cs)[source]¶

Make a structure representing a Core based on a cs object with a geomFile.

This allows settings-driven core map for backwards compatibility.