armi.settings.fwSettings.tightCouplingSettings module

The data structures and schema of the tight coupling settings.

These are advanced/compound settings that are carried along in the normal cs object but aren’t simple key/value pairs.

class armi.settings.fwSettings.tightCouplingSettings.TightCouplingSettings

Bases: dict

Dictionary with keys of Interface functions and a dictionary value.

Notes

The dictionary value for each Interface function is required to contain a parameter and a convergence key with string and float values, respectively. No other keys are allowed.

Examples

couplingSettings = TightCouplingSettings({‘globalFlux’: {‘parameter’: ‘keff’, ‘convergence’: 1e-05}})

armi.settings.fwSettings.tightCouplingSettings.serializeTightCouplingSettings(tightCouplingSettingsDict: Union[armi.settings.fwSettings.tightCouplingSettings.TightCouplingSettings, Dict]) → Dict[str, Dict]

Return a serialized form of the TightCouplingSettings as a dictionary.

Notes

Attributes that are not set (i.e., set to None) will be skipped.

class armi.settings.fwSettings.tightCouplingSettings.TightCouplingSettingDef(name)

Bases: armi.settings.setting.Setting

Custom setting object to manage the tight coupling settings for each interface.

Notes

This uses the tightCouplingSettingsValidator schema to validate the inputs and will automatically coerce the value into a TightCouplingSettings dictionary.

dump()

Return a serialized version of the TightCouplingSettings object.

armi.settings.fwSettings.tightCouplingSettings.tightCouplingSettingsValidator(tightCouplingSettingsDict: Dict[str, Dict]) → armi.settings.fwSettings.tightCouplingSettings.TightCouplingSettings

Returns a TightCouplingSettings object if validation is successful.