master:surge1 parametersPSCAD Surge Generator

Every parameter of the PSCAD Surge Generator (master:surge1): 13 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:surge1 is

Surge Generator (Surge Generator (CIGRE, IEC or IEEE Std.)), a component of PSCAD's Master Library, filed under passive branches, loads and filters.

Definition
master:surge1
PSCAD name
Surge Generator
Category
Passive branches, loads and filters
Parameters
13, in 3 groups; 9 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:surge1 in Python

import mhi.pscad

pscad = mhi.pscad.connect()              # the PSCAD that is open; launch() starts one
project = pscad.project("my_case")       # a case loaded in the workspace

for comp in project.find_all("master:surge1"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["ALPHA"]))          # Alpha, in 1/us

comp = project.find_all("master:surge1")[0]
comp.parameters(ALPHA="0.0286 [1/us]")   # a value that carries a unit is written with it
  • A parameter is named exactly as in the table, letter case included: parameters() gives every one of them in a dictionary, and a name the component does not have is refused.
  • A value that carries a unit comes back as a number whose unit is only in its text, so read it as text first (str(...)) or the unit is lost. PSCAD keeps a written unit as it is given: "2500 [mohm]" stays in mohm.
  • A Choice is read and written as its symbol (the capitals in "Written as"), not as the words PSCAD shows in the dialog.
  • find_all() takes the exact definition only. A wildcard or a bare name without master: comes back empty; the Builder's px_find walks the pages for those.

The Builder's runtime does the same with the unit handled for you: px_get(comp, "ALPHA") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

IEC/IEEE

ParameterUnitDefaultDescription
ALPHAReal1/us0.0143AlphaAt least 0Used when SW==-1
BETAReal1/us4.87BetaAt least 0Used when SW==-1
SWChoice·12_50_USSurge WaveformSelect the waveform from supplied list or defined parametersWritten as 12_50_US (1.2/50 [us]), 8_20_US (8/20 [us]), 1_50_US (1/50 [us]), 250_2500_US (250/2500 [us]), 250_1500_US (250/1500 [us]), 10_700_US (10/700 [us]), 5_320_US (5/320 [us]), CUSTOM_WAVEFORM_ALPHA_BETA (Custom Waveform: alpha, beta), CUSTOM_WAVEFORM_WAVEFRONT_TAIL_TIMES (Custom Waveform: wavefront/tail times)
WFTRealus1.2Wavefront TimeAt least 0Used when SW==-2
WFTMChoice·10%_PEAKWavefront Time is Based on10% to 90% of peak or 30% to 90% of peakWritten as 10%_PEAK (10% to 90% of peak), 30%_PEAK (30% to 90% of peak)Used when SW==-2
WTTRealus50Wavetail TimeAt least 0Used when SW==-2

Configuration

ParameterUnitDefaultDescription
IpkRealkA31Peak Current AmplitudeAt least 0
NameText··Name for IdentificationEnter a name for identification
STDChoice·IEC_IEEESurge Waveform StandardSelect the basis for waveform from IEC/IEEE or CIGRE standardsWritten as IEC_IEEE (IEC/IEEE), CIGRE
TstartReals0.0Starting TimeAt least 0

CIGRE

ParameterUnitDefaultDescription
SMRealkA/us26Maximum SteepnessAt least 1E-308
WFT2Realus3.0Wavefront TimeAt least 1E-308
WTT2Realus75.0Wavetail TimeAt least 1E-308

Related

← master:surge Surge Generator · master:reactive_load Three phase inductive load →