master:nl_tfun parametersPSCAD Non-Linear Transfer Characteristic

Every parameter of the PSCAD Non-Linear Transfer Characteristic (master:nl_tfun): 23 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().

What master:nl_tfun is

Non-Linear Transfer Characteristic, a component of PSCAD's Master Library, filed under lines, cables and towers.

Definition
master:nl_tfun
PSCAD name
Non-Linear Transfer Characteristic
Category
Lines, cables and towers
Parameters
23, in 2 groups
Read from
PSCAD 5.0.0, 2026-11-07

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

comp = project.find_all("master:nl_tfun")[0]
comp.parameters(Dim="2")                 # written as text
  • 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, "Dim") 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·1DimensionEnter the dimension of input/output signalsRange 1 to 2147483647
NChoice·2Number of CoordinatesSelect number of coordinates for the transfer functionWritten as 2 = 2, 3 = 3, 4 = 4, 5 = 5, 6 = 6, 7 = 7, 8 = 8, 9 = 9, 10 = 10
NameText··Name for IdentificationEnter a name for identification

Transfer Characteristic

ParameterUnitDefaultDescription
x1Real·-4.0x1
x10Real·5.0x10Used when (N>9)
x2Real·-3.0x2
x3Real·-2.0x3Used when (N>2)
x4Real·-1.0x4Used when (N>3)
x5Real·0.0x5Used when (N>4)
x6Real·1.0x6Used when (N>5)
x7Real·2.0x7Used when (N>6)
x8Real·3.0x8Used when (N>7)
x9Real·4.0x9Used when (N>8)
y1Real·-4.0y1
y10Real·5.0y10Used when (N>9)
y2Real·-3.0y2
y3Real·-2.0y3Used when (N>2)
y4Real·-1.0y4Used when (N>3)
y5Real·0.0y5Used when (N>4)
y6Real·1.0y6Used when (N>5)
y7Real·2.0y7Used when (N>6)
y8Real·3.0y8Used when (N>7)
y9Real·4.0y9Used when (N>8)

Related

← master:nl-gain Non-Linear Gain · master:fft On-Line Frequency Scanner →