master:sync_machine parametersPSCAD Synchronous Machine

Every parameter of the PSCAD Synchronous Machine (master:sync_machine): 129 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:sync_machine is

The synchronous machine, with its d and q axis data, inertia and the initialisation that starts it as a source and moves it to a machine.

Definition
master:sync_machine
PSCAD name
Synchronous Machine
Category
Machines, exciters and governors
Parameters
129, in 12 groups; 62 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Most used master:sync_machine parameters

ParameterUnitDescription
HsInertia Constantinertia constant
DpuMechanical Friction and Windagefriction and windage
IbasekARated RMS Line Currentrated line current
Cnfg·Data Entry Format:data entered as generator or equivalent circuit

Read and write master:sync_machine 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:sync_machine"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["H"]))              # Inertia Constant, in s

comp = project.find_all("master:sync_machine")[0]
comp.parameters(H="4 [s]")               # 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, "H") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.

Generator Data Format

ParameterUnitDefaultDescription
AGFCReal·1.0Air Gap FactorAt least 0
GfldRealpu1.0E+2D: Real Transfer Admittance (Armat-Field)Range 0 to 100Used when (itrfa==1)
RaRealpu0.002Armature Resistance [Ra]Range 0 to 1E+20Used when (CfRa==1)
TaReals0.332Armature Time Constant [Ta]Range 1E-20 to 1E+20Used when (CfRa==0)
Tdo_Reals4.3D: Unsaturated Transient Time ( Open ) [Tdo_]At least 0
Tdo__Reals0.032D: Unsaturated Sub-Transient Time ( Open ) [Tdo__]At least 0
Tqo_Reals0.85Q: Unsaturated Transient Time ( Open ) [Tqo_]Range 0.001 to 2Used when (Nqaxw==2)
Tqo__Reals0.05Q: Unsaturated Sub-Transient Time ( Open ) [Tqo__]At least 0
XdRealpu1.79D: Unsaturated Reactance [Xd]At least 0
Xd_Realpu0.169D: Unsaturated Transient Reactance [Xd_]At least 0
Xd__Realpu0.135D: Unsaturated Sub-Transient Reactance [Xd__]At least 0
XkfRealpu1.0E+2D: Imag Transfer Admittance (Armat-Field)Range 0 to 100Used when (itrfa==1)
XpRealpu0.130Potier Reactance [Xp]At least 0
XqRealpu1.71Q: Unsaturated Reactance [Xq]At least 0
Xq_Realpu0.228Q: Unsaturated Transient Reactance [Xq_]Range 0.001 to 1Used when (Nqaxw==2)
Xq__Realpu0.2Q: Unsaturated Sub-Transient Reactance [Xq__]At least 0

Configuration

ParameterUnitDefaultDescription
CfRaChoice·RESISTANCEArmature Resistance as:Select the form of the armature resistance: resistance or time constant.Written as TIMECONS (Time-Cons), RESISTANCE (Resistance)Used when Cnfg==0
CnfgChoice·GENERATORData Entry Format:Select Generator or Equivalent circuit formatsWritten as GENERATOR (Generator), EQUIV_CCT (Equiv cct)
IsclChoice·YESMachine Scaling Factor?Select Yes or No to scale the machine. Helpful if multiple identical machines are connected at the same bus.Written as NO (No), YES (Yes)
MMChoice·ENABLEMultimass Interface:[Enables Speed Ctrl]Enable or Disable the multimass interface. Enabling multimass allows the use of speed control mode.Written as DISABLE, ENABLE
MSatChoice·DISABLEDSaturationEnable or Disable the D-axis saturationWritten as DISABLED (Disabled), ENABLED_ON_D (Enabled on D), ENABLED_ON_BOTH_D_Q (Enabled on both D & Q)
NameText·SyncMachineMachine nameRange 0 to 0
NeutChoice·DISABLEExternal Neutral ConnectionSelect enable or disable depending on whether access to neutral connection is required. Make sure externally connected devices to neutral are scaled properly if machine scaling is used.Written as DISABLE (Disable), ENABLE (Enable)
NqaxwChoice·ONENo. of Q-axis Damper WindingsSelect number of Q-axis damper windingsWritten as ONE (One), TWO (Two)
ViewChoice·SINGLE_LINEGraphics DisplaySelect graphics view: single line view or three phase viewWritten as 3_PHASE (3 phase view), SINGLE_LINE (Single line view)
icTypChoice·POWERSType of Settings for Initial ConditionSelect the tyoe settings for initial condition: none, powers or currentsWritten as NONE (None), POWERS (Powers), CURRENTS (Currents)

Monitoring Internal Variables - Advanced

ParameterUnitDefaultDescription
Chn1Text··Name for 1st monitored outputRange 0 to 0
Chn2Text··Name for 2nd monitored outputRange 0 to 0
Chn3Text··Name for 3rd monitored outputRange 0 to 0
Chn4Text··Name for 4th monitored outputRange 0 to 0
Chn5Text··Name for 5th monitored outputRange 0 to 0
Chn6Text··Name for 6th monitored outputRange 0 to 0
Mon1Integer·1Monitor internal storage NEXC +Range 1 to 375
Mon2Integer·1Monitor internal storage NEXC +Range 1 to 375
Mon3Integer·1Monitor internal storage NEXC +Range 1 to 375
Mon4Integer·1Monitor internal storage NEXC +Range 1 to 375
Mon5Integer·1Monitor internal storage NEXC +Range 1 to 375
Mon6Integer·1Monitor internal storage NEXC +Range 1 to 375

Output Variable Names

ParameterUnitDefaultDescription
CneutText··Name: Neutral Current to Ground [kA]Range 0 to 0Used when Neut==0
LangText··Name: Load Angle; Gen. + [rad]Range 0 to 0
POutText··Name: Real Power; Out + [pu]Range 0 to 0
PQsclChoice·TOTAL_NUMBER_OF_MACHINESReal/Reactive power pu output is based on base MVA ofWritten as SINGLE_MACHINE (single machine), TOTAL_NUMBER_OF_MACHINES (total number of machines)Used when Iscl==1
QOutText··Name: Reactive Power; Out + [pu]Range 0 to 0
TesmtText··Name: Steady Electrical Torque [pu]Range 0 to 0
ThetaText··Name: Rotor Mechanical Angle [rad]Range 0 to 0
VneutText··Name: Neutral Voltage [kV]Range 0 to 0Used when Neut==0
WangText··Name: Internal Phase A Angle with respect to sin(wt) [rad]Range 0 to 0

Basic Data

ParameterUnitDefaultDescription
DRealpu0.0Mechanical Friction and WindageAt least 0Used when MM==1
HReals2.0Inertia ConstantAt least 1E-38Used when MM==1
IbaseRealkA10.0Rated RMS Line CurrentAt least 0.001Used when (IorMVA==0)
IorMVAChoice·CURRENTRating Specified asSelect Current or MVA to specify the ratingWritten as CURRENT (Current), MVA
MVARealMVA300.0Rated MVAAt least 0.001Used when (IorMVA==1)
NOMReal·1.0Number of Coherent MachinesRange 0 to 1000Used when (Iscl==1)
OMORealrad/s376.99111843Base Angular FrequencyAt least 0
RNeutRealpu1.0E4Neutral Series ResistanceAt least 0Used when Neut==0
RiRealpu300.0Iron Loss ResistanceRange 0 to 300
VbaseRealkV10.0Rated RMS Line-to-Neutral VoltageAt least 0.01
XNeutRealpu0.0Neutral Series ReactanceAt least 0Used when Neut==0

Variable Initialization Data

ParameterUnitDefaultDescription
EnabInteger·1Lock-rotor[0] - Normal mode[1] transitionWhen the value of this input is 0 it will run in speed control mode, when it is 1 it will run in torque control mode.Range -2147483648 to 2147483647
fldmltReal·1.0Field Voltage MultiplierField voltage multiplier used when accelrated flux build up at start is set.At least 1E-38
hmultReal·1.0Inertia Scaling FactorInertia scaling factor used when controlling mechanical dynamics is set.At least 1E-38
machswInteger·1Source[0] to Machine[1] transitionWhen the value of this input is 0, it will run as a source. when the value is 1, it will run as a machine.Range 0 to 1
nfldswInteger·0Disable/Enable Ef MultiplicationWhen the value of this signal is set to 1,it will allow field voltage multiplicationRange 0 to 1
nftrswInteger·0Enable/Disable Inertia ControlWhen the value of this input is set to 1, it will allow using the inertia scaling factor.Range 0 to 1
npadjmInteger·0Enable/Disable P Control of Locked Rotor MachineWhen the value of this input is set to 1, it will allow controlling the power of the machine when running at speed control mode.Range 0 to 1
npadjsInteger·0Enable/Disable P Control of SourceWhen the value of this input is 1, it will allow controlling the power when running as a sourceRange 0 to 1
psetRealMW0.0Initializing Real PowerEnter the desired value of output power when controlling of source/machine output is set.
sdmftrReal·1.0Damper Friction FactorDamper friction scaling factor used when controlling mechanical dynamics is setAt least 1E-38
sdmspdReal·1.0Factor for Damping SpeedFactor for damping speed used when controlling mechanical dynamics is set.At least 1E-38

Configuration - Advanced

ParameterUnitDefaultDescription
IcmpChoice·NOControl Machine P Out?Select Yes or No to control the power when running as a machineWritten as NO (No), YES (Yes)
IcspChoice·NOControl Source P Out ?Select Yes or No to control the power when running as a sourceWritten as NO (No), YES (Yes)
IfmltChoice·NOAccelarated Flux Build-up at Start?Select Yes or No to allow modifying field voltageWritten as NO (No), YES (Yes)
ImmdChoice·NOModify Mechanical Dynamics?Select Yes or No to allow modifying mechanical dynamics such as inertia and dampingWritten as NO (No), YES (Yes)
itrfaChoice·NOD-axis Transfer Admittance Data Available?Select Yes or NoWritten as NO (No), YES (Yes)
izroChoice·NOForce Currents = 0 at t = 0?Select Yes or No to force the currents to be zero at time zeroWritten as NO (No), YES (Yes)

Initial Conditions

ParameterUnitDefaultDescription
IdiRealpu0.0D-axis Armature Current; In +Used when icTyp==2
IfiRealpu0.0Initial Field CurrentUsed when icTyp==2
IqiRealpu0.0Q-axis Armature Current; In +Used when icTyp==2
P0RealMW0.0Terminal Real Power at Time = 0- ; Out +Used when icTyp==1
PhetaRealrad0.0Terminal Voltage Phase at Time = 0-
PtconReals0.2Time Constant for Power CorrectionRange 0.05 to 10Used when (Icsp==1) || (Icmp==1)
Q0RealMVAR0.0Terminal Reactive Power at Time = 0- ; Out +Used when icTyp==1
SpdiRealpu1.0Initial Machine SpeedUsed when icTyp==2
SysflRealpu100.0System Fault Level (excluding machine)Range 0.1 to 1000Used when (Icsp==1) || (Icmp==1)
ThetiRealrad3.141592Initial Rotor Angle ref: StatorUsed when icTyp==2
TrmpvReals0.1Time to Ramp Source Limit to RatedRange 0 to 5
VTRealpu1.0Terminal Voltage Magnitude at Time = 0-

Interface To Machine Controllers

ParameterUnitDefaultDescription
IexcChoice·NOOutput Exciter Initialization Data?Select Yes or No to output exciter initialization dataWritten as NO (No), YES (Yes)
IgovChoice·NOOutput Governor Initialization Data?Select Yes or No to output governor initialization dataWritten as NO (No), YES (Yes)
OspdChoice·RAD_SOutput SpeedSelect the unit of output speed: rad/s or puWritten as RAD_S (rad/s), PU (pu)
TermChoice·NONESupply Terminal Conditions to ExciterSelect what terminal conditions to be supplied to the exciter: none, voltage, current, voltage and currentWritten as NONE (None), VT (Vt), IT (It), VT_IT (Vt&It)
TsReals0.02Smoothing Time ConstantTime constant used for smoothing out terminal measurements before supplying to exciterAt least 0Used when (Term>0)

Output Variables For Controler Initialization

ParameterUnitDefaultDescription
InExcText·InitExSource[0] to Machine[1] TransitionRange 0 to 0
InGovText·InitGvLocked Rotor[0] - Normal[1] TransitionRange 0 to 0

Saturation Curve

ParameterUnitDefaultDescription
NpntsChoice·10Number of Data Points AvailableWritten as 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10
X1Real·0.0Point 1 - CurrentAt least 0
X10Real·4.2Point 10 - Current
X2Real·0.5Point 2 - CurrentAt least 0
X3Real·0.8Point 3 - Current
X4Real·1.0Point 4 - Current
X5Real·1.2Point 5 - Current
X6Real·1.5Point 6 - Current
X7Real·1.8Point 7 - Current
X8Real·2.2Point 8 - Current
X9Real·3.2Point 9 - Current
Y1Realpu0.0Point 1 - PU VoltageAt least 0
Y10Realpu4.2Point 10 - PU Voltage
Y2Realpu0.5Point 2 - PU VoltageRange 0 to 1.01
Y3Realpu0.8Point 3 - PU Voltage
Y4Realpu1.0Point 4 - PU Voltage
Y5Realpu1.2Point 5 - PU Voltage
Y6Realpu1.5Point 6 - PU Voltage
Y7Realpu1.8Point 7 - PU Voltage
Y8Realpu2.2Point 8 - PU Voltage
Y9Realpu3.2Point 9 - PU Voltage

Equivalent Circuit Data Format

ParameterUnitDefaultDescription
R2DRealpu1.4068E-03Field ResistanceAt least 0
R2QRealpu1.4145E-02Q-Axis Damper No. 1 ResistanceAt least 0
R3DRealpu4.0699E-03D-Axis Damper ResistanceAt least 0
R3QRealpu8.1942E-03Q-Axis Damper No. 2 ResistanceRange 0.001 to 2Used when (Nqaxw==2)
Rs1Realpu0.002Armature ResistanceRange 0 to 1E+20
X230Realpu0.0D: Field-Damp Mutual Leakage ReactanceAt least 0
X231Realpu0.0Q: Damp-Damp Mutual Leakage ReactanceRange 0 to 2Used when (Nqaxw==2)
X2DRealpu6.1789E-02Field Leakage ReactanceAt least 0
X2QRealpu0.32928Q-Axis Damper No. 1 Leakage ReactanceAt least 0
X3DRealpu5.4581E-03D-Axis Damper Leakage ReactanceAt least 0
X3QRealpu9.4199E-02Q-Axis Damper No. 2 Leakage ReactanceRange 0.001 to 2Used when (Nqaxw==2)
XMD0Realpu1.66D-Axis Unsaturated Magnetizing ReactanceAt least 0
XMQRealpu1.58Q-Axis Magnetizing ReactanceAt least 0
XS1Realpu0.14Stator Leakage ReactanceAt least 0

Related

← master:sqc100 Squirrel Cage Induction Machine · master:th_gov Thermal Governor →