master:trans_fcn parametersPSCAD Nth Order Transfer Function

Every parameter of the PSCAD Nth Order Transfer Function (master:trans_fcn): 37 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:trans_fcn is

Nth Order Transfer Function, a component of PSCAD's Master Library, filed under control blocks.

Definition
master:trans_fcn
PSCAD name
Nth Order Transfer Function
Category
Control blocks
Parameters
37, in 5 groups; 1 carry a unit
Read from
PSCAD 5.0.0, 2026-11-07

Read and write master:trans_fcn 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:trans_fcn"):   # the exact definition, namespace first
    params = comp.parameters()           # every parameter, as PSCAD holds it
    print(str(params["FBase"]))          # Frequency Scaled to 1 rad/s:, in Hz

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

Configuration

ParameterUnitDefaultDescription
DimInteger·1DimensionRange 1 to 2147483647
FScChoice·NOFrequency ScalingWritten as NO (No), YES (Yes)
NameText··Name for IdentificationEnter a name for identification
OrderChoice·1Order of Transfer Function:Written as 1 = 1, 2 = 2, 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10

Base Frequency

ParameterUnitDefaultDescription
FBaseRealHz1.0Frequency Scaled to 1 rad/s:Range 1E-30 to 1E+36Used when (FSc==1)

Denominator Coefficients

ParameterUnitDefaultDescription
a0Real·1.0Constant CoefficientRange -100000000 to 100000000
a1Real·0.0Coefficient of sRange -100000000 to 100000000
a10Real·0.0Coefficient of s^10Range -100000000 to 100000000Used when (Order>9)
a2Real·0.0Coefficient of s^2Range -100000000 to 100000000Used when (Order>1)
a3Real·0.0Coefficient of s^3Range -100000000 to 100000000Used when (Order>2)
a4Real·0.0Coefficient of s^4Range -100000000 to 100000000Used when (Order>3)
a5Real·0.0Coefficient of s^5Range -100000000 to 100000000Used when (Order>4)
a6Real·0.0Coefficient of s^6Range -100000000 to 100000000Used when (Order>5)
a7Real·0.0Coefficient of s^7Range -100000000 to 100000000Used when (Order>6)
a8Real·0.0Coefficient of s^8Range -100000000 to 100000000Used when (Order>7)
a9Real·0.0Coefficient of s^9Range -100000000 to 100000000Used when (Order>8)

Numerator Coefficients

ParameterUnitDefaultDescription
b0Real·1.0Constant CoefficientRange -100000000 to 100000000
b1Real·0.0Coefficient of sRange -100000000 to 100000000
b10Real·0.0Coefficient of s^10Range -100000000 to 100000000Used when (Order>9)
b2Real·0.0Coefficient of s^2Range -100000000 to 100000000Used when (Order>1)
b3Real·0.0Coefficient of s^3Range -100000000 to 100000000Used when (Order>2)
b4Real·0.0Coefficient of s^4Range -100000000 to 100000000Used when (Order>3)
b5Real·0.0Coefficient of s^5Range -100000000 to 100000000Used when (Order>4)
b6Real·0.0Coefficient of s^6Range -100000000 to 100000000Used when (Order>5)
b7Real·0.0Coefficient of s^7Range -100000000 to 100000000Used when (Order>6)
b8Real·0.0Coefficient of s^8Range -100000000 to 100000000Used when (Order>7)
b9Real·0.0Coefficient of s^9Range -100000000 to 100000000Used when (Order>8)

State Variable Initial Conditions

ParameterUnitDefaultDescription
y0Real·0.0X1 Initial ValueRange -100000000 to 100000000
y1Real·0.0X2 Initial ValueRange -100000000 to 100000000Used when (Order>1)
y2Real·0.0X3 Initial ValueRange -100000000 to 100000000Used when (Order>2)
y3Real·0.0X4 Initial ValueRange -100000000 to 100000000Used when (Order>3)
y4Real·0.0X5 Initial ValueRange -100000000 to 100000000Used when (Order>4)
y5Real·0.0X6 Initial ValueRange -100000000 to 100000000Used when (Order>5)
y6Real·0.0X7 Initial ValueRange -100000000 to 100000000Used when (Order>6)
y7Real·0.0X8 Initial ValueRange -100000000 to 100000000Used when (Order>7)
y8Real·0.0X9 Initial ValueRange -100000000 to 100000000Used when (Order>8)
y9Real·0.0X10 Initial ValueRange -100000000 to 100000000Used when (Order>9)

Related

← master:mult Multiplier · master:Ztrans_fcnZ Nth Order Transfer Function →