Build options

class PfBuildOptions(ict_ratio_override=None, merge_zero_z_threshold=0.002, merge_zero_z_xfmr_threshold=0.0, gen_remote_regulation=True, gen_wind_handling=True, gen_regulator_admission=True, gen_q_band_demotion=True, gen_regulator_min_q_range_mvar=1.0, gen_remote_regulator_min_coupling_pu=1.0, seed_q_init=True, load_zip=True, tap_control=True, phase_shift_control=True, switched_shunts=True, statcom=True, upfc=True, vsc_dc_lines=True, lcc_dc_lines=True)

Select supported equipment and controls for a power-flow study.

ict_ratio_override

Solved transformer tap ratios to use with impedance-correction tables. None uses the entered tap ratios.

Type:

dict[tuple[int, int, str], float] | None

merge_zero_z_threshold

Branch impedance limit in per unit on the system base. A nonpositive value disables node consolidation.

Type:

float

merge_zero_z_xfmr_threshold

Two-winding transformer impedance limit in per unit. Zero disables transformer consolidation.

Type:

float

gen_remote_regulation

Enable remote generator voltage regulation. False makes each generator regulate its own terminal bus.

Type:

bool

gen_wind_handling

Apply the entered wind-machine reactive mode. False uses the entered reactive limits without wind-mode adjustments.

Type:

bool

gen_regulator_admission

Check whether a generator can provide the requested voltage regulation before the calculation uses it. A generator that does not meet the configured criteria remains at fixed reactive output.

Type:

bool

gen_regulator_min_q_range_mvar

Minimum reactive range for generator regulation, in Mvar.

Type:

float

gen_remote_regulator_min_coupling_pu

Minimum supported network coupling for remote regulation, in per unit.

Type:

float

seed_q_init

Use saved generator reactive output as a starting value.

Type:

bool

load_zip

Include constant-current and constant-admittance load terms.

Type:

bool

tap_control

Enable supported transformer tap control. False keeps the entered tap ratios.

Type:

bool

phase_shift_control

Enable supported transformer phase control. False keeps the entered phase angles.

Type:

bool

switched_shunts

Enable supported switched-shunt control. False keeps the entered initial susceptance.

Type:

bool

statcom

Include supported STATCOM behavior. False omits STATCOM injections from the calculation.

Type:

bool

upfc

Include supported UPFC behavior. False omits UPFC injections and flow control from the calculation.

Type:

bool

vsc_dc_lines

Include supported VSC DC links. False omits their injections and DC coupling from the calculation.

Type:

bool

lcc_dc_lines

Include supported two-terminal LCC DC links. False omits them from the calculation.

Type:

bool

classmethod full()

Return the default options with all supported features enabled.

classmethod minimal_nr()

Return options with equipment controls, FACTS, and HVDC disabled.

classmethod no_remote()

Keep FACTS and HVDC but make generators regulate locally.

classmethod no_facts_dc()

Keep AC generator and transformer controls without FACTS or HVDC.

describe_disabled()

Return the disabled feature names.

class PfSolveOptions(*, max_iter=50, tol=1e-06, q_tol=1e-08, var_limit_start='immediate', ac_tap_adjust='enabled', lcc_dc_tap_adjust='enabled', phase_shift_adjust='enabled', swshunt_adjust='enabled', low_voltage_load_pu=0.0)

Configure convergence and equipment-control behavior for one solve.

Each field has a concrete default. Callers can pass an instance to lower level APIs or pass the same field names to solve_power_flow().

class PfContinuationOptions(*, limit_mode='enforce', maximum_mode='pin', initial_step=0.1, minimum_voltage_pu=0.2, point_limit=200, corrector_tolerance=1e-09, solve_options=PfSolveOptions(max_iter=50, tol=1e-06, q_tol=1e-08, var_limit_start='immediate', ac_tap_adjust='enabled', lcc_dc_tap_adjust='enabled', phase_shift_adjust='enabled', swshunt_adjust='enabled', low_voltage_load_pu=0.0))

Configure limits and stop conditions for a continuation study.

limit_mode selects enforced or voltage-held treatment of regulating limits. maximum_mode selects a refined or estimated reported maximum. Voltage, point-count, and study-specific power stops bound the calculated curve. solve_options supplies the power-flow settings.

gpf.AdjustmentMode = Literal['enabled', 'disabled']

gpf.LimitEnforcementMode = Literal['off', 'immediate', 'automatic']

gpf.LimitMode = Literal['enforce', 'hold']

gpf.MaximumMode = Literal['pin', 'estimate']