armi.matProps.prop module

In the parlance of matProps, a material ‘Property’ is a physical characteristic of the material that can be described mathematically. For instance, density, specific heat, specific gravity, coefficient of linear expansion, etc.

class armi.matProps.prop.Property(name: str, symbol: str, units: str, tex: str = None)

Bases: object

A Property of a material. Most properties are computed as temperature-dependent functions.

Constructor for Property class.

Parameters:

• name (str) – Name of the property.

• symbol (str) – Symbol of the property.

• units (str) – String representing the units of the property.

• tex (str (optional)) – TeX symbol used to represent the property. Defaults to symbol.

name: str

Name of the Property, used to retrieve the property from the data file

symbol: str

Symbol of the property, same as the module-level attribute and Material attribute

units: str

Units of the Property

TeX: str

math-style TeX symbol

armi.matProps.prop.contains(name: str)

Checks to see if a string representing a desired property is in the global properties list.

Parameters:

name (str) – Name of the property whose value is searched for in global properties list.

Returns:

True if name is in properties, False otherwise.

Return type:

bool

armi.matProps.prop.defProp(symbol: str, name: str, units: str, tex: str = None)

Method which constructs and adds Property objects to global properties object.

Parameters:

• name (str) – Name of the property.

• symbol (str) – Symbol of the property.

• units (str) – String representing the units of the property.

• tex (str (optional)) – TeX symbol used to represent the property. Defaults to symbol.

armi.matProps.prop.initialize()

Construct the global list of default properties in matProps.