armi.reactor.converters.parameterSweeps.generalParameterSweepConverters module

Module for general core parameter sweeps

class armi.reactor.converters.parameterSweeps.generalParameterSweepConverters.ParameterSweepConverter(cs, parameter)

Bases: armi.reactor.converters.geometryConverters.GeometryConverter

Abstract parameter sweep converter object.

PRIORITY = None

convert(r=None)

Run the conversion.

Parameters

r (Reactor object) – The reactor to convert.

Returns

convReactor – the converted reactor (converters only, not changers)

Return type

Reactor object

class armi.reactor.converters.parameterSweeps.generalParameterSweepConverters.SettingsModifier(cs, settingToModify, parameter)

Bases: armi.reactor.converters.parameterSweeps.generalParameterSweepConverters.ParameterSweepConverter

Modifies basic setting parameters.

convert(r=None)

Run the conversion.

Parameters

r (Reactor object) – The reactor to convert.

Returns

convReactor – the converted reactor (converters only, not changers)

Return type

Reactor object

class armi.reactor.converters.parameterSweeps.generalParameterSweepConverters.CustomModifier(cs, parameter)

Bases: armi.reactor.converters.parameterSweeps.generalParameterSweepConverters.ParameterSweepConverter

Invoke the shuffle logic applyCustomPerturbation method to make a custom setting.

convert(r=None)

Run the conversion.

Parameters

r (Reactor object) – The reactor to convert.

Returns

convReactor – the converted reactor (converters only, not changers)

Return type

Reactor object

class armi.reactor.converters.parameterSweeps.generalParameterSweepConverters.NeutronicConvergenceModifier(cs, parameter)

Bases: armi.reactor.converters.parameterSweeps.generalParameterSweepConverters.ParameterSweepConverter

Adjusts the neutronics convergence parameters.

convert(r=None)

Run the conversion.

Parameters

r (Reactor object) – The reactor to convert.

Returns

convReactor – the converted reactor (converters only, not changers)

Return type

Reactor object