armi.matProps.constituent module

Basic material composition.

class armi.matProps.constituent.Constituent(name: str, minValue: float, maxValue: float, isBalance: bool)

Bases: object

Makeup of the Material.composition.

Implementation: Materials created from YAML files generate nuclide mass fractions at instantiation. I_ARMI_MAT_FRACS2

signature: Constituent requirements: R_ARMI_MAT_FRACS

An ARMI material is meant to be able to represent real world materials that might be used in the construction of a nuclear reactor. As such, they are not just individual nuclides, but practical materials like a particular concrete, steel, or water. One of the main things that will be needed to describe such a material is the exact nuclide fractions. As such, all materials loaded via YAML are required to include a “composition” field to provide this data.

Constructor for Constituent object.

Parameters:

• name (str) – Name of constituent element

• minValue (float) – Minimum value of constituent

• maxValue (float) – Maximum value of constituent

• isBalance (bool) – Boolean used to denote if constituent is balance element (True) or not (False).

name

Name of the constituent

minValue

Min value of the constituent

maxValue

Max value of the constituent

isBalance

Flag for indicating if the consitituent is intended to the balance of the composition

static parseComposition(node)

Method which parses “composition” node from yaml file and returns container of Contituent objects.

Returns list of Constituent objects. Each element is constructed from a map element in the “composition node”.

Parameters:

node (dict) – YAML object representing composition node.

Returns:

list – List of Constituent objects representing elements of Material.

Return type:

Constituent