armi.reactor.blueprints.blockBlueprint module¶

This module defines the ARMI input for a block definition, and code for constructing an ARMI Block.

armi.reactor.blueprints.blockBlueprint._configureGeomOptions()[source]¶

class armi.reactor.blueprints.blockBlueprint.BlockBlueprint(*args, **kwargs)[source]¶

Bases: yamlize.maps.KeyedList

Input definition for Block.

Initialize a Map.

Parameters

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

item_type¶: alias of armi.reactor.blueprints.componentBlueprint.ComponentBlueprint

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

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

gridName¶

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

flags¶

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

_geomOptions = {<class 'armi.reactor.components.basicShapes.Rectangle'>: <class 'armi.reactor.blocks.CartesianBlock'>, <class 'armi.reactor.components.volumetricShapes.RadialSegment'>: <class 'armi.reactor.blocks.ThRZBlock'>, <class 'armi.reactor.components.basicShapes.Hexagon'>: <class 'armi.reactor.blocks.HexBlock'>}¶

_getBlockClass(outerComponent)[source]¶

Get the ARMI Block class for the specified outerComponent.

Parameters: outerComponent (Component) – Largest component in block.

construct(cs, blueprint, axialIndex, axialMeshPoints, height, xsType, materialInput)[source]¶

Construct an ARMI Block to be placed in an Assembly.

Parameters

cs (CaseSettings) – CaseSettings object for the appropriate simulation.
blueprint (Blueprints) – Blueprints object containing various detailed information, such as nuclides to model
axialIndex (int) – The Axial index this block exists within the parent assembly
axialMeshPoints (int) – number of mesh points for use in the neutronics kernel
height (float) – initial height of the block
xsType (str) – String representing the xsType of this block.
materialInput (dict) – dict containing material modification names and values

_getGridDesign(blueprint)[source]¶

Get the appropriate grid design

This happens when a lattice input is provided on the block. Otherwise all components are ambiguously defined in the block.

static _mergeComponents(b)[source]¶

attributes = <yamlize.attribute_collection.KeyedListAttributeCollection object>¶

inletLossCoeff¶

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

pressureLossCoeffs¶

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.blockBlueprint._setBlueprintNumberOfAxialMeshes(meshPoints, factor)[source]¶: Set the blueprint number of axial mesh based on the axial mesh refinement factor.

class armi.reactor.blueprints.blockBlueprint.BlockKeyedList(*args, **kwargs)[source]¶

Bases: yamlize.maps.KeyedList

An OrderedDict of BlockBlueprints keyed on the name. Utilizes yamlize for serialization to and from YAML.

This is used within the blocks: main entry of the blueprints.

Initialize a Map.

Parameters

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

item_type¶: alias of BlockBlueprint

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.blockBlueprint.BlockList(items=())[source]¶

Bases: yamlize.sequences.Sequence

A list of BlockBlueprints keyed on the name. Utilizes yamlize for serialization to and from YAML.

This is used to define the blocks: attribute of the assembly definitions.

item_type¶: alias of BlockBlueprint

__items¶

__round_trip_data¶