master:pm_machine parametersPSCAD Permanent Magnet Machine

Every parameter of the PSCAD Permanent Magnet Machine (master:pm_machine): 20 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:pm_machine is

Permanent Magnet Machine (Permanent Magnet Synchronous Machine), a component of PSCAD's Master Library, filed under machines, exciters and governors.

Definition
master:pm_machine
PSCAD name
Permanent Magnet Machine
Category
Machines, exciters and governors
Parameters
20, in 3 groups; 14 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:pm_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:pm_machine"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["D"]))              # Mechanical Damping, in pu

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

Machine Data

ParameterUnitDefaultDescription
DRealpu0.01Mechanical DampingEnter damping coefficient; used only when multimass interface is disabled and in torque control modeAt least 0
FLDFRealpu1.0Magnetic StrengthEnter the magnetic strength the fieldAt least 0
JReals0.7267Angular Moment of Inertia (J=2H)Enter angular moment of inertia; used only when multimass interface is disabled and in torque control modeAt least 0
RkdRealpu0.055D: Damper Winding Resistance [Rkd]Enter the D-axis damper winding resistanceAt least 0
RkqRealpu0.183Q: Damper Winding Resistance [Rkq]Enter the Q-axis damper winding resistanceAt least 0
RsRealpu0.017Stator Winding ResistanceEnter the winding resistance of statorAt least 0
XdRealpu0.55D: Unsaturated Reactance [Xd]Enter the D-axis unsaturated reactanceAt least 0
XkdRealpu0.62D: Damper Winding Reactance [Xkd]Enter the D-axis damper winding reactanceAt least 0
XkqRealpu1.175Q: Damper Winding Reactance [Xkq]Enter the Q-axis damper winding reactanceAt least 0
XlsRealpu0.064Stator Leakage ReactanceEnter the leakage reactance of the statorAt least 0
XqRealpu1.11Q: Unsaturated Reactance [Xq]Enter the Q-axis unsaturated reactanceAt least 0

Configuration

ParameterUnitDefaultDescription
FRealHz60.0Rated FrequencyEnter the rated frequency of the machineAt least 0
MMChoice·ENABLEMultimass InterfaceSelect Enable or DisableWritten as DISABLE (Disable), ENABLE (Enable)
MVARealMVA0.003Rated MVAEnter the rated MVA of the machine
NameText·PMMachineName for IdentificationEnter a name for identificationRange 0 to 0
NeutChoice·DISABLEExternal Connection to NeutralWritten as DISABLE (Disable), ENABLE (Enable)
VRATRealkV0.2Rated Voltage (L-L)Enter the rated line-line voltage of the machine

Internal Outputs

ParameterUnitDefaultDescription
SpdText··Mechanical Speed [pu]Range 0 to 0
THETAText··Rotor PositionRange 0 to 0
TelText··Electrical Torque [pu]Range 0 to 0

Related

← master:macdefn macdefn · master:spim_uw Single Phase Induction Machine →