armi.physics.fuelPerformance.plugin module

Generic Fuel Performance Plugin

class armi.physics.fuelPerformance.plugin.FuelPerformancePlugin

Bases: armi.plugins.ArmiPlugin

Plugin for fuel performance.

static exposeInterfaces(cs)

Expose the fuel performance interfaces.

static defineSettings()

Define settings for fuel performance.

static defineSettingsValidators(inspector)

Define settings inspections for fuel performance.

static defineParameters()

Function for defining additional parameters.

Returns

Keys should be subclasses of ArmiObject, values being a ParameterDefinitionCollection should be added to the key’s perameter definitions.

Return type

dict

Example

>>> pluginBlockParams = parameters.ParameterDefinitionCollection()
>>> with pluginBlockParams.createBuilder() as pb:
...     pb.defParam("plugBlkP1", ...)
...     # ...
...
>>> pluginAssemParams = parameters.ParameterDefinitionCollection()
>>> with pluginAssemParams.createBuilder() as pb:
...     pb.defParam("plugAsmP1", ...)
...     # ...
...
>>> return {
...     blocks.Block: pluginBlockParams,
...     assemblies.Assembly: pluginAssemParams
... }

static afterConstructionOfAssemblies(assemblies, cs)

After new assemblies are built, set some state information.

armi.physics.fuelPerformance.plugin._setBOLBond(assemblies)

Set initial bond fractions for each block in the core.