master:hysteresis_reactor parametersPSCAD Hysteresis Reactor
Every parameter of the PSCAD Hysteresis Reactor (master:hysteresis_reactor): 25 names, with the unit, the default and the meaning PSCAD gives each one. Copy a name into parameters().
What master:hysteresis_reactor is
Hysteresis Reactor, a component of PSCAD's Master Library, filed under control blocks.
- Definition
master:hysteresis_reactor- PSCAD name
- Hysteresis Reactor
- Category
- Control blocks
- Parameters
- 25, in 4 groups; 12 carry a unit
- Read from
- PSCAD 5.0.0, 2026-11-07
Read and write master:hysteresis_reactor 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:hysteresis_reactor"): # the exact definition, namespace first
params = comp.parameters() # every parameter, as PSCAD holds it
print(str(params["Bnom"])) # Nominal Flux Density, in T
comp = project.find_all("master:hysteresis_reactor")[0]
comp.parameters(Bnom="3.4 [T]") # 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, "Bnom") and px_set(...), which also records the old value so the case is put back at the end. Getting started shows them.
Internal Outputs
| Parameter | Unit | Default | Description |
|---|---|---|---|
B1Text | · | · | Name for Flux Density [T]Range 0 to 0Used when Hys==2 |
FLUXText | · | · | Name for Flux Linkage [kWb-N]Range 0 to 0 |
H1Text | · | · | Name for Magnetic Field IntensityRange 0 to 0Used when Hys==2 |
IMAGText | · | · | Name for Magnetizing Current [kA]Range 0 to 0 |
Magnetic Characteristics of the Material
| Parameter | Unit | Default | Description |
|---|---|---|---|
BETAReal | · | 0.96 | Parameter to Adjust K with MThis parameter adjusts domian pinning parameter with magnetization for better representation of shoulder areaRange 0 to 0.98 |
CReal | · | 0.1 | Domain Flexing ParameterThis parameter represents the contribution of reversible magnetization processRange 0.001 to 0.5 |
F1Real | · | 2730.0 | Coefficient 1 of Anhysteretic CurveAt least 0 |
F2Real | · | 3209.0 | Coefficient 2 of Anhysteretic CurveAt least 0 |
F3Real | · | 20294.0 | Coefficient 3 of Anhysteretic CurveAt least 0 |
FbReal | · | 2.0 | Coefficient 4 of Anhysteretic CurveAt least 1 |
KReal | A/m | 5.0e-5 | Domain Pinning ParameterThis parameter has a direct impact on the width of the loopAt least 1E-07 |
MsatReal | A/m | 1.72e6 | Saturated Anhysteretic MagnetizationAt least 100000 |
alphaReal | · | 1.325e-05 | Interdomain CouplingAt least 1E-08 |
Saturation
| Parameter | Unit | Default | Description |
|---|---|---|---|
BnomReal | T | 1.7 | Nominal Flux DensityEnter the nominal flux density corresponding to saturation curveAt least 1E-307Used when (Hys==2) |
FremnAReal | pu | 0.0 | Remanent FluxEnter the remanent flux as a per unit value of the peak flux at rated voltageRange -1.5 to 1.5 |
HysChoice | · | BASIC_MODEL | HysteresisSelect the hysteresis model from available optionsWritten as BASIC_MODEL (Basic model), JILES_ATHERTON (Jiles_Atherton) |
Im1Real | % | 0.4 | Magnetizing CurrentEnter the magnetizing current as a percentage of base currentRange 0.0001 to 50Used when Hys==1 |
LW2Real | % | 10 | Loop WidthEnter the loop width as a percentage of magnetizing currentRange 0 to 100Used when Hys==1 |
XairReal | pu | 0.2 | Air Core ReactanceEnter the air core reactance based on transformer base impedanceRange 0.001 to 10 |
XkneeReal | pu | 1.17 | Knee VoltageEnter the knee point voltage corresponding to saturation curveAt least 1E-307Used when Hys==1 |
materialChoice | · | DEFAULT | Magnetic MaterialSelect the magnetic materialWritten as CUSTOM_MATERIAL (custom material), DEFAULT (default)Used when (Hys==2) |
Configuration
| Parameter | Unit | Default | Description |
|---|---|---|---|
NLLReal | pu | 0.0 | Eddy Current LossesEnter the eddy current loss portion of no load losses based on transformer rating, hysteresis loss may also be added here if hysteresis is not modelledRange 0 to 1 |
TmvaReal | MVA | 100.0 | Base MVA per PhaseEnter the apparent power of the reactor per phaseAt least 1E-06 |
V1Real | kV | 230.0 | Base Voltage Across the ReactorEnter the RMS voltage rating across the reactorAt least 0.0001 |
fReal | Hz | 60.0 | Base Operation FrequencyEnter the base frequencyAt least 0.0001 |
Related
← master:pwm_hcc Hysteresis Current Control PWM · master:impulse Impulse Generator →