master:mod parametersPSCAD MOD Function

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

What master:mod is

MOD Function, a component of PSCAD's Master Library, filed under control blocks.

Definition
master:mod
PSCAD name
MOD Function
Category
Control blocks
Parameters
5, in 1 group
Read from
PSCAD 5.0.0, 2026-11-07

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

comp = project.find_all("master:mod")[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
COMText·MOD FunctionFortran CommentOptional comment line for generated source codeRange 0 to 0
DPathChoice·REALData TypeChoose Real or IntegerWritten as REAL (Real), INTEGER (Integer)
DimInteger·1DimensionEnter the dimension of the input signalRange 1 to 2147483647
NameText··Name for IdentificationEnter a name for identificationRange 0 to 0
prealReal·1.0Second Argument of MOD FunctionAny real literal number for argument p in MOD(a,p). The number cannot be zero. Enter a whole number for integer usage in the allowable integer range.

Related

← master:maxmin_array Minimum/Maximum Value/Location · master:modulo MODULO Function →