pypowsybl.network.scalable.ScalingParameters

class ScalingParameters(scaling_convention=None, constant_power_factor=None, reconnect=None, allows_generator_out_of_active_power_limits=None, priority=None, scaling_type=None, ignored_injection_ids=None)[source]

Parameters to modify active power with a Scalable.

Parameters:

  • scaling_convention (pypowsybl._pypowsybl.ScalingConvention | None) – The scaling convention to use. The default is GENERATOR_CONVENTION and can be changed to LOAD_CONVENTION.

  • constant_power_factor (bool | None) – If True, the scaling is done with a constant power factor (False by default)

  • reconnect (bool | None) – If True, scaling can reconnect the underlying injection if it is disconnected (False by default)

  • allows_generator_out_of_active_power_limits (bool | None) – If True, the scalable can modify the active power of a generator even if it is out of its active power limits (False by default)

  • priority (pypowsybl._pypowsybl.Priority | None) –

    representing the priority of the scaling for ProportionalScalable. It can be either :

    • RESPECT_OF_VOLUME_ASKED (the scaling will distribute the power asked as much as possible by iterating if elements get saturated, even if it means not respecting potential percentages)

    • RESPECT_OF_DISTRIBUTION (the scaling will respect the percentages even if it means not scaling all what is asked)

    • ONESHOT (the scaling will distribute the power asked as is, in one iteration even if elements get saturated and even if it means not respecting potential percentages).

    (ONESHOT by default)

  • scaling_type (pypowsybl._pypowsybl.ScalingType | None) – The type of scaling to use. The default is DELTA_P and can be changed to TARGET_P.

  • ignored_injection_ids (List[str] | None) – List of injection ids to ignore when scaling.

Methods

__init__([scaling_convention, ...])