master:macdefn parametersPSCAD macdefn

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

What master:macdefn is

macdefn (V2 SNC375 Machine model (Obsolete)), a component of PSCAD's Master Library, filed under machines, exciters and governors.

Definition
master:macdefn
PSCAD name
macdefn
Category
Machines, exciters and governors
Parameters
98, in 10 groups; 56 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:macdefn 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:macdefn"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["Bfld"]))           # D: Imag Transfer Admit (Armat-Field), in pu

comp = project.find_all("master:macdefn")[0]
comp.parameters(Bfld="200 [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, "Bfld") 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
BfldRealpu1.0E+2D: Imag Transfer Admit (Armat-Field)Range 0 to 100Used when (itrfa==1)&&(daTyp==1)
GfldRealpu1.0E+2D: Real Transfer Admit (Armat-Field)Range 0 to 100Used when (itrfa==1)&&(daTyp==1)
RaRealpu0.0Stator ResistanceUsed when (daTyp==1)
Tdo_Reals4.3D: Unsat. Transient Time ( Open )Used when (daTyp==1)
Tdo__Reals0.032D: Unsat. Sub-Trans. Time ( Open )Used when (daTyp==1)
Tqo_Reals0.85Q: Unsat. Transient Time ( Open )Range 0.001 to 2Used when (Nqaxw==2)&&(daTyp==1)
Tqo__Reals0.05Q: Unsat. Sub-Trans. Time ( Open )Used when (daTyp==1)
XaRealpu0.13Stator Leakage ReactanceUsed when (daTyp==1)
XdRealpu1.79D: Unsaturated ReactanceUsed when (daTyp==1)
Xd_Realpu0.169D: Unsaturated Transient ReactanceUsed when (daTyp==1)
Xd__Realpu0.135D: Unsat. Sub-Trans. ReactanceUsed when (daTyp==1)
XqRealpu1.71Q: Unsaturated ReactanceUsed when (daTyp==1)
Xq_Realpu0.228Q: Unsaturated Transient ReactanceRange 0.001 to 1Used when (Nqaxw==2)&&(daTyp==1)
Xq__Realpu0.2Q: Unsat. Sub-Trans. ReactanceUsed when (daTyp==1)

Saturation Curve

ParameterUnitDefaultDescription
C1Real·0.0First Point on the SaturationAt least 0
C10Real·4.2
C2Real·0.5Second Point must be on the
C3Real·0.8Currents can be in any
C4Real·1.010 Points Maximum: If less points
C5Real·1.2the current after the last
C6Real·1.5
C7Real·1.8
C8Real·2.2
C9Real·3.2
V1Realpu0.0Curve must be ( 0.0, 0.0 ).At least 0
V10Realpu4.2
V2Realpu0.5Unsaturated Part of the Curve.Range 0 to 1.01
V3Realpu0.8consistent Units.
V4Realpu1.0are available, enter -1.0 for
V5Realpu1.2point.
V6Realpu1.5
V7Realpu1.8
V8Realpu2.2
V9Realpu3.2

Monitoring Internal Variables

ParameterUnitDefaultDescription
Chn1Text··Name for 1st monitored output
Chn2Text··Name for 2nd monitored output
Chn3Text··Name for 3rd monitored output
Chn4Text··Name for 4th monitored output
Chn5Text··Name for 5th monitored output
Chn6Text··Name for 6th monitored output
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
LdaglText··Name: Load Angle; Gen. +
POutText··Name: Real Power; Out +
QOutText··Name: Reactive Power; Out +
TesmtText··Name: Steady Electrical Torque
ThetaText··Name: Rotor Mechanical Angle
TmsmtText··Name: Steady Elect + Frict Torque
VneutText··Name: Neutral Voltage

Basic And Mechanical Data

ParameterUnitDefaultDescription
HReals2.0Inertia Constant
IbaseRealkA10.0Rated RMS Line CurrentAt least 0.001
OmegbRealrad/s376.992Base Angular Frequency
RNeutRealpu1.0E4Neutral Series Resistance
RiRealpu300.0Iron Loss ResistanceRange 66.7 to 300
TLossRealpu0.0Mechanical Friction and Windage
VbaseRealkV10.0Rated RMS Line-to-Neutral VoltageAt least 0.01
XNeutRealpu0.0Neutral Series Reactance

Configuration

ParameterUnitDefaultDescription
IcmpChoice·NOIcon input: control mach P out ?Written as NO (No), YES (Yes)
IcspChoice·NOIcon input: control source P out ?Written as NO (No), YES (Yes)
IfmltChoice·NOIcon inputs: multiplier for Ef and RrsWritten as NO (No), YES (Yes)
ImmdChoice·NOIcon inputs: modify mech. dyn. ?Written as NO (No), YES (Yes)
IsclChoice·NOIcon input: machine scaling factorWritten as NO (No), YES (Yes)
IshnmChoice·NOShow subroutine argument namesWritten as NO (No), YES (Yes)
NameText··Machine name
NqaxwChoice·1No. of Q-axis Dampers:Written as 1 = 1, 2 = 2
daTypChoice·EQUIV_CIRCUITData Entry FormatWritten as EQUIV_CIRCUIT (Equiv. Circuit), GENERATOR (Generator)
icTypChoice·POWERInitial ConditionsWritten as NONE (None), POWER (Power), CURRENTS (Currents)
itrfaChoice·NOD-axis Transfer Admit data available?Written as NO (No), YES (Yes)
izroChoice·NOForce currents = 0 at time = 0 ?Written as NO (No), YES (Yes)

Initial Conditions: Currents ( Opt. Use )

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)
SpdiRealpu1.0Initial Machine SpeedUsed when (icTyp==2)
ThetiRealrad3.141592Initial Rotor Angle ref: StatorUsed when (icTyp==2)

Initial Conditions: Powers ( Opt. Use )

ParameterUnitDefaultDescription
P0Realpu0.0Real Power at Time = 0- ; Out +Used when (icTyp==1)
Q0Realpu0.0React Power at Time = 0- ; Out +Used when (icTyp==1)
VanglRealrad0.0Voltage Phase at Time = 0-Used when (icTyp==1)
VmagnRealpu1.0Voltage Magn. at Time = 0-Used when (icTyp==1)

Initialization Constants ( Opt. Use )

ParameterUnitDefaultDescription
PtconReals0.2Time Const. for Power CorrectionRange 0.05 to 10Used when (Icsp==1)||(Icmp==1)
SysflRealpu100.0System Fault Level (excl. mach.)Range 0.1 to 1000Used when (Icsp==1)||(Icmp==1)
TrmpvReals0.1Time to Ramp Source Limit to RatedRange 0 to 5

Equiv. Circuit Data Format

ParameterUnitDefaultDescription
RfdRealpu1.4068E-03Field ResistanceUsed when (daTyp==0)
RfqRealpu1.4145E-02Q-Axis Damper No. 1 ResistanceUsed when (daTyp==0)
RkdRealpu4.0699E-03D-Axis Damper ResistanceUsed when (daTyp==0)
RkqRealpu8.1942E-03Q-Axis Damper No. 2 ResistanceRange 0.001 to 2Used when (Nqaxw==2)&&(daTyp==0)
XfdRealpu6.1789E-02Field Leakage ReactanceUsed when (daTyp==0)
XfqRealpu0.32928Q-Axis Damper No. 1 Leakage React.Used when (daTyp==0)
XkdRealpu5.4581E-03D-Axis Damper Leakage ReactanceUsed when (daTyp==0)
XkfdRealpu0.0D: Field-Damp Mutual Leak. React.Used when (daTyp==0)
XkfqRealpu0.0Q: Damp-Damp Mutual Leak. React.Range 0 to 2Used when (Nqaxw==2)&&(daTyp==0)
XkqRealpu9.4199E-02Q-Axis Damper No. 2 Leakage React.Range 0.001 to 2Used when (Nqaxw==2)&&(daTyp==0)
Xmd0Realpu1.66D-Axis Unsaturated Magnet. React.Used when (daTyp==0)
XmqRealpu1.58Q-Axis Magnetizing ReactanceUsed when (daTyp==0)

Related

← master:hy_tur Hydro Turbine · master:pm_machine Permanent Magnet Machine →