armi.matProps.constituent module

Basic material composition.

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

Bases: object

Makeup of the Material.composition.

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)[source]

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