armi.physics.thermalHydraulics.plugin module

Generic Thermal/Hydraulics Plugin

Thermal/hydraulics is concerned with temperatures, flows, pressures, and heat transfer.

class armi.physics.thermalHydraulics.plugin.ThermalHydraulicsPlugin

Bases: armi.plugins.ArmiPlugin

Plugin for thermal/hydraulics.

static exposeInterfaces(cs)

Expose the T/H interfaces.

static defineSettings()

Define settings for T/H.

static defineSettingsValidators(inspector)

Define settings inspections for T/H.

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.