pypowsybl.loadflow.Parameters

class Parameters(voltage_init_mode=None, transformer_voltage_control_on=None, use_reactive_limits=None, phase_shifter_regulation_on=None, twt_split_shunt_admittance=None, shunt_compensator_voltage_control_on=None, read_slack_bus=None, write_slack_bus=None, distributed_slack=None, balance_type=None, dc_use_transformer_ratio=None, countries_to_balance=None, component_mode=None, connected_component_mode=None, dc_power_factor=None, hvdc_ac_emulation=None, dc=None, provider_parameters=None)[source]

Parameters for a loadflow execution.

All parameters are first read from your configuration file, then overridden with the constructor arguments.

Please note that loadflow providers may not honor all parameters, according to their capabilities. For example, some providers will not be able to simulate the voltage control of shunt compensators, etc. The exact behaviour of some parameters may also depend on your loadflow provider. Please check the documentation of your provider for that information.

Parameters:

  • voltage_init_mode (pypowsybl._pypowsybl.VoltageInitMode | None) – The resolution starting point. Use UNIFORM_VALUES for a flat start, and DC_VALUES for a DC load flow based starting point.

  • transformer_voltage_control_on (bool | None) – Simulate transformer voltage control. The initial tap position is used as starting point for the resolution.

  • use_reactive_limits (bool | None) – Use reactive limits (named no_generator_reactive_limits with inverted logic before PyPowSyBl 1.3.0).

  • phase_shifter_regulation_on (bool | None) – Simulate phase shifters regulation.

  • twt_split_shunt_admittance (bool | None) – Split shunt admittance of transformers on both sides. Change the modelling of transformer legs. If you want to split the conductance and the susceptance in two, one at each side of the serie impedance, use True.

  • shunt_compensator_voltage_control_on (bool | None) – Simulate voltage control of shunt compensators (named simul_shunt before PyPowSyBl 1.3.0).

  • read_slack_bus (bool | None) – Read slack bus from the network. The slack bus needs to be defined through a dedicate extension. Prefer False if you want to use your loadflow provider selection mechanism, typically the most meshed bus.

  • write_slack_bus (bool | None) – Write selected slack bus to the network. Will tag the slack bus selected by your loadflow provider with an extension.

  • distributed_slack (bool | None) – Distribute active power slack on the network. True means that the active power slack is distributed, on loads or on generators according to balance_type.

  • balance_type (pypowsybl._pypowsybl.BalanceType | None) – How to distribute active power slack. Use PROPORTIONAL_TO_LOAD to distribute slack on loads, PROPORTIONAL_TO_GENERATION_P_MAX or PROPORTIONAL_TO_GENERATION_P to distribute on generators.

  • dc_use_transformer_ratio (bool | None) – In DC mode, take into account transformer ratio. Used only for DC load flows, to include ratios in the equation system.

  • countries_to_balance (Sequence[str] | None) – List of countries participating to slack distribution. Used only if distributed_slack is True.

  • component_mode (pypowsybl._pypowsybl.ComponentMode | None) – Defines which network components should be computed. Use MAIN_SYNCHRONOUS to computes flows only on the main synchronous component, MAIN_CONNECTED to computes flows only on the main connected component, or prefer ALL_CONNECTED for a run on all connected components.

  • connected_component_mode (pypowsybl._pypowsybl.ConnectedComponentMode | None) – Deprecated, use parameter component_mode (MAIN corresponds to component_mode = MAIN_CONNECTED, ALL to component_mode = ALL_CONNECTED).

  • hvdc_ac_emulation (bool | None) – Enable AC emulation of HVDC links.

  • dc_power_factor (float | None) – Power factor used to convert current limits into active power limits in DC calculations.

  • dc (bool | None) – Defines if you want to run an AC power flow (false) or a DC power flow (true).

  • provider_parameters (Dict[str, str] | None) – Define parameters linked to the loadflow provider the names of the existing parameters can be found with method get_provider_parameters_names