class Parameters(with_feeder_result=None, with_limit_violations=None, with_voltage_result=None, min_voltage_drop_proportional_threshold=None, study_type=None, provider_parameters=None, with_fortescue_result=None)[source]#

Parameters for a short-circuit analysis execution.

Please check the PowSyBl short-circuit APIs documentation, for detailed information.

  • with_fortescue_result (bool) – indicates whether the currents and voltages are to be given in three-phase magnitude or detailed with magnitude and angle on each phase. This parameter also applies to the feeder results and voltage results.

  • with_feeder_result (bool) – indicates whether the contributions of each feeder to the short-circuit current at the fault node should be calculated.

  • with_limit_violations (bool) – indicates whether limit violations should be returned after the calculation. If true, a

  • in (list of buses where the calculated short-circuit current is higher than the maximum admissible current (stored) –

  • ip_min (ip_max in the identifiableShortCircuit extension) or lower than the minimum admissible current (stored in) –

  • extension). (in the identifiableShortCircuit) –

  • with_voltage_result (bool) – indicates whether the voltage profile should be calculated on every node of the network

  • min_voltage_drop_proportional_threshold (float) – specifies a threshold for filtering the voltage results. Only nodes where the voltage drop due to the short circuit is greater than this property are retained.

  • study_type (pypowsybl._pypowsybl.ShortCircuitStudyType) – specifies the type of short-circuit study. It can be SUB_TRANSIENT, TRANSIENT or STEADY_STATE.

  • provider_parameters (Dict[str, str]) –


__init__([with_feeder_result, ...])