armi.matProps.piecewiseFunction module

A piecewise-defined function for used in material YAML files.

Each piece can be of any other type that matProps supports.

class armi.matProps.piecewiseFunction.PiecewiseFunction(mat, prop)

Bases: Function

A piecewise function is composed of many other subfunctions, any of which can be any subclass of the Function type, including PiecewiseFunction.

The PiecewiseFunction uses the Function.inRange method to determine which sub-function should be used for computing the quantity. An example with the YAML format is:

function:
    <var1>:
        min: <min1>
        max: <max1>
    <var2>:
        min: <min2>
        max: <max2>
    type: piecewise
    functions:
    - function:
        <var1>:
            min: <local min1>
            max: <local max1>
        <var2>:
            min: <local min2>
            max: <local max2>
        type: ...
        tabulated data: *alias # it is suggested that the same table is used for the entire range
    - function:
        <var1>:
            min: <local min1>
            max: <local max1>
        <var2>:
            min: <local min2>
            max: <local max2>
        type: ...
        tabulated data: *alias # it is suggested that the same table is used for the entire range

Constructor for PiecewiseFunction object.

Parameters:

• mat (Material) – Material object with which this PiecewiseFunction is associated

• prop (Property) – Property that is represented by this PiecewiseFunction

functions

List of Function objects used to compose PiecewiseFunction object.

clear() → None