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
| Parameter | Unit | Description |
|---|---|---|
H | s | Inertia Constantinertia constant |
D | pu | Mechanical Friction and Windagefriction and windage |
Ibase | kA | Rated 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 withoutmaster:comes back empty; the Builder'spx_findwalks 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 Format16
- Configuration10
- Monitoring Internal Variables - Advanced12
- Output Variable Names9
- Basic Data11
- Variable Initialization Data11
- Configuration - Advanced6
- Initial Conditions12
- Interface To Machine Controllers5
- Output Variables For Controler Initialization2
- Saturation Curve21
- Equivalent Circuit Data Format14
Generator Data Format
| Parameter | Unit | Default | Description |
|---|---|---|---|
AGFCReal | · | 1.0 | Air Gap FactorAt least 0 |
GfldReal | pu | 1.0E+2 | D: Real Transfer Admittance (Armat-Field)Range 0 to 100Used when (itrfa==1) |
RaReal | pu | 0.002 | Armature Resistance [Ra]Range 0 to 1E+20Used when (CfRa==1) |
TaReal | s | 0.332 | Armature Time Constant [Ta]Range 1E-20 to 1E+20Used when (CfRa==0) |
Tdo_Real | s | 4.3 | D: Unsaturated Transient Time ( Open ) [Tdo_]At least 0 |
Tdo__Real | s | 0.032 | D: Unsaturated Sub-Transient Time ( Open ) [Tdo__]At least 0 |
Tqo_Real | s | 0.85 | Q: Unsaturated Transient Time ( Open ) [Tqo_]Range 0.001 to 2Used when (Nqaxw==2) |
Tqo__Real | s | 0.05 | Q: Unsaturated Sub-Transient Time ( Open ) [Tqo__]At least 0 |
XdReal | pu | 1.79 | D: Unsaturated Reactance [Xd]At least 0 |
Xd_Real | pu | 0.169 | D: Unsaturated Transient Reactance [Xd_]At least 0 |
Xd__Real | pu | 0.135 | D: Unsaturated Sub-Transient Reactance [Xd__]At least 0 |
XkfReal | pu | 1.0E+2 | D: Imag Transfer Admittance (Armat-Field)Range 0 to 100Used when (itrfa==1) |
XpReal | pu | 0.130 | Potier Reactance [Xp]At least 0 |
XqReal | pu | 1.71 | Q: Unsaturated Reactance [Xq]At least 0 |
Xq_Real | pu | 0.228 | Q: Unsaturated Transient Reactance [Xq_]Range 0.001 to 1Used when (Nqaxw==2) |
Xq__Real | pu | 0.2 | Q: Unsaturated Sub-Transient Reactance [Xq__]At least 0 |
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
CfRaChoice | · | RESISTANCE | Armature 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 | · | GENERATOR | Data Entry Format:Select Generator or Equivalent circuit formatsWritten as GENERATOR (Generator), EQUIV_CCT (Equiv cct) |
IsclChoice | · | YES | Machine 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 | · | ENABLE | Multimass Interface:[Enables Speed Ctrl]Enable or Disable the multimass interface. Enabling multimass allows the use of speed control mode.Written as DISABLE, ENABLE |
MSatChoice | · | DISABLED | SaturationEnable 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 | · | SyncMachine | Machine nameRange 0 to 0 |
NeutChoice | · | DISABLE | External 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 | · | ONE | No. of Q-axis Damper WindingsSelect number of Q-axis damper windingsWritten as ONE (One), TWO (Two) |
ViewChoice | · | SINGLE_LINE | Graphics DisplaySelect graphics view: single line view or three phase viewWritten as 3_PHASE (3 phase view), SINGLE_LINE (Single line view) |
icTypChoice | · | POWERS | Type 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
| Parameter | Unit | Default | Description |
|---|---|---|---|
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 | · | 1 | Monitor internal storage NEXC +Range 1 to 375 |
Mon2Integer | · | 1 | Monitor internal storage NEXC +Range 1 to 375 |
Mon3Integer | · | 1 | Monitor internal storage NEXC +Range 1 to 375 |
Mon4Integer | · | 1 | Monitor internal storage NEXC +Range 1 to 375 |
Mon5Integer | · | 1 | Monitor internal storage NEXC +Range 1 to 375 |
Mon6Integer | · | 1 | Monitor internal storage NEXC +Range 1 to 375 |
Output Variable Names
| Parameter | Unit | Default | Description |
|---|---|---|---|
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_MACHINES | Real/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
| Parameter | Unit | Default | Description |
|---|---|---|---|
DReal | pu | 0.0 | Mechanical Friction and WindageAt least 0Used when MM==1 |
HReal | s | 2.0 | Inertia ConstantAt least 1E-38Used when MM==1 |
IbaseReal | kA | 10.0 | Rated RMS Line CurrentAt least 0.001Used when (IorMVA==0) |
IorMVAChoice | · | CURRENT | Rating Specified asSelect Current or MVA to specify the ratingWritten as CURRENT (Current), MVA |
MVAReal | MVA | 300.0 | Rated MVAAt least 0.001Used when (IorMVA==1) |
NOMReal | · | 1.0 | Number of Coherent MachinesRange 0 to 1000Used when (Iscl==1) |
OMOReal | rad/s | 376.99111843 | Base Angular FrequencyAt least 0 |
RNeutReal | pu | 1.0E4 | Neutral Series ResistanceAt least 0Used when Neut==0 |
RiReal | pu | 300.0 | Iron Loss ResistanceRange 0 to 300 |
VbaseReal | kV | 10.0 | Rated RMS Line-to-Neutral VoltageAt least 0.01 |
XNeutReal | pu | 0.0 | Neutral Series ReactanceAt least 0Used when Neut==0 |
Variable Initialization Data
| Parameter | Unit | Default | Description |
|---|---|---|---|
EnabInteger | · | 1 | Lock-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.0 | Field Voltage MultiplierField voltage multiplier used when accelrated flux build up at start is set.At least 1E-38 |
hmultReal | · | 1.0 | Inertia Scaling FactorInertia scaling factor used when controlling mechanical dynamics is set.At least 1E-38 |
machswInteger | · | 1 | Source[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 | · | 0 | Disable/Enable Ef MultiplicationWhen the value of this signal is set to 1,it will allow field voltage multiplicationRange 0 to 1 |
nftrswInteger | · | 0 | Enable/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 | · | 0 | Enable/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 | · | 0 | Enable/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 |
psetReal | MW | 0.0 | Initializing Real PowerEnter the desired value of output power when controlling of source/machine output is set. |
sdmftrReal | · | 1.0 | Damper Friction FactorDamper friction scaling factor used when controlling mechanical dynamics is setAt least 1E-38 |
sdmspdReal | · | 1.0 | Factor for Damping SpeedFactor for damping speed used when controlling mechanical dynamics is set.At least 1E-38 |
Configuration - Advanced
| Parameter | Unit | Default | Description |
|---|---|---|---|
IcmpChoice | · | NO | Control Machine P Out?Select Yes or No to control the power when running as a machineWritten as NO (No), YES (Yes) |
IcspChoice | · | NO | Control Source P Out ?Select Yes or No to control the power when running as a sourceWritten as NO (No), YES (Yes) |
IfmltChoice | · | NO | Accelarated Flux Build-up at Start?Select Yes or No to allow modifying field voltageWritten as NO (No), YES (Yes) |
ImmdChoice | · | NO | Modify Mechanical Dynamics?Select Yes or No to allow modifying mechanical dynamics such as inertia and dampingWritten as NO (No), YES (Yes) |
itrfaChoice | · | NO | D-axis Transfer Admittance Data Available?Select Yes or NoWritten as NO (No), YES (Yes) |
izroChoice | · | NO | Force 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
| Parameter | Unit | Default | Description |
|---|---|---|---|
IdiReal | pu | 0.0 | D-axis Armature Current; In +Used when icTyp==2 |
IfiReal | pu | 0.0 | Initial Field CurrentUsed when icTyp==2 |
IqiReal | pu | 0.0 | Q-axis Armature Current; In +Used when icTyp==2 |
P0Real | MW | 0.0 | Terminal Real Power at Time = 0- ; Out +Used when icTyp==1 |
PhetaReal | rad | 0.0 | Terminal Voltage Phase at Time = 0- |
PtconReal | s | 0.2 | Time Constant for Power CorrectionRange 0.05 to 10Used when (Icsp==1) || (Icmp==1) |
Q0Real | MVAR | 0.0 | Terminal Reactive Power at Time = 0- ; Out +Used when icTyp==1 |
SpdiReal | pu | 1.0 | Initial Machine SpeedUsed when icTyp==2 |
SysflReal | pu | 100.0 | System Fault Level (excluding machine)Range 0.1 to 1000Used when (Icsp==1) || (Icmp==1) |
ThetiReal | rad | 3.141592 | Initial Rotor Angle ref: StatorUsed when icTyp==2 |
TrmpvReal | s | 0.1 | Time to Ramp Source Limit to RatedRange 0 to 5 |
VTReal | pu | 1.0 | Terminal Voltage Magnitude at Time = 0- |
Interface To Machine Controllers
| Parameter | Unit | Default | Description |
|---|---|---|---|
IexcChoice | · | NO | Output Exciter Initialization Data?Select Yes or No to output exciter initialization dataWritten as NO (No), YES (Yes) |
IgovChoice | · | NO | Output Governor Initialization Data?Select Yes or No to output governor initialization dataWritten as NO (No), YES (Yes) |
OspdChoice | · | RAD_S | Output SpeedSelect the unit of output speed: rad/s or puWritten as RAD_S (rad/s), PU (pu) |
TermChoice | · | NONE | Supply 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) |
TsReal | s | 0.02 | Smoothing Time ConstantTime constant used for smoothing out terminal measurements before supplying to exciterAt least 0Used when (Term>0) |
Output Variables For Controler Initialization
| Parameter | Unit | Default | Description |
|---|---|---|---|
InExcText | · | InitEx | Source[0] to Machine[1] TransitionRange 0 to 0 |
InGovText | · | InitGv | Locked Rotor[0] - Normal[1] TransitionRange 0 to 0 |
Saturation Curve
| Parameter | Unit | Default | Description |
|---|---|---|---|
NpntsChoice | · | 10 | Number of Data Points AvailableWritten as 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10 |
X1Real | · | 0.0 | Point 1 - CurrentAt least 0 |
X10Real | · | 4.2 | Point 10 - Current |
X2Real | · | 0.5 | Point 2 - CurrentAt least 0 |
X3Real | · | 0.8 | Point 3 - Current |
X4Real | · | 1.0 | Point 4 - Current |
X5Real | · | 1.2 | Point 5 - Current |
X6Real | · | 1.5 | Point 6 - Current |
X7Real | · | 1.8 | Point 7 - Current |
X8Real | · | 2.2 | Point 8 - Current |
X9Real | · | 3.2 | Point 9 - Current |
Y1Real | pu | 0.0 | Point 1 - PU VoltageAt least 0 |
Y10Real | pu | 4.2 | Point 10 - PU Voltage |
Y2Real | pu | 0.5 | Point 2 - PU VoltageRange 0 to 1.01 |
Y3Real | pu | 0.8 | Point 3 - PU Voltage |
Y4Real | pu | 1.0 | Point 4 - PU Voltage |
Y5Real | pu | 1.2 | Point 5 - PU Voltage |
Y6Real | pu | 1.5 | Point 6 - PU Voltage |
Y7Real | pu | 1.8 | Point 7 - PU Voltage |
Y8Real | pu | 2.2 | Point 8 - PU Voltage |
Y9Real | pu | 3.2 | Point 9 - PU Voltage |
Equivalent Circuit Data Format
| Parameter | Unit | Default | Description |
|---|---|---|---|
R2DReal | pu | 1.4068E-03 | Field ResistanceAt least 0 |
R2QReal | pu | 1.4145E-02 | Q-Axis Damper No. 1 ResistanceAt least 0 |
R3DReal | pu | 4.0699E-03 | D-Axis Damper ResistanceAt least 0 |
R3QReal | pu | 8.1942E-03 | Q-Axis Damper No. 2 ResistanceRange 0.001 to 2Used when (Nqaxw==2) |
Rs1Real | pu | 0.002 | Armature ResistanceRange 0 to 1E+20 |
X230Real | pu | 0.0 | D: Field-Damp Mutual Leakage ReactanceAt least 0 |
X231Real | pu | 0.0 | Q: Damp-Damp Mutual Leakage ReactanceRange 0 to 2Used when (Nqaxw==2) |
X2DReal | pu | 6.1789E-02 | Field Leakage ReactanceAt least 0 |
X2QReal | pu | 0.32928 | Q-Axis Damper No. 1 Leakage ReactanceAt least 0 |
X3DReal | pu | 5.4581E-03 | D-Axis Damper Leakage ReactanceAt least 0 |
X3QReal | pu | 9.4199E-02 | Q-Axis Damper No. 2 Leakage ReactanceRange 0.001 to 2Used when (Nqaxw==2) |
XMD0Real | pu | 1.66 | D-Axis Unsaturated Magnetizing ReactanceAt least 0 |
XMQReal | pu | 1.58 | Q-Axis Magnetizing ReactanceAt least 0 |
XS1Real | pu | 0.14 | Stator Leakage ReactanceAt least 0 |
Related
- All 345 definitions in the component reference
- Control tuning: overshoot, rise time and damping
- PSCAD automation with Python: getting started
← master:sqc100 Squirrel Cage Induction Machine · master:th_gov Thermal Governor →