Config Reference#
System#
Option |
Value |
Info |
Accepted values |
|---|---|---|---|
freq |
60 |
base frequency [Hz] |
float |
mva |
100 |
system base MVA |
float |
diag_eps |
0.000 |
small value for Jacobian diagonals |
|
warn_abnormal |
1 |
warn initialization out of normal values |
(0, 1) |
PFlow#
Option |
Value |
Info |
Accepted values |
|---|---|---|---|
linsolve |
0 |
solve symbolic factorization each step (enable when KLU segfaults) |
(0, 1) |
tol |
0.000 |
convergence tolerance |
float |
max_iter |
25 |
max. number of iterations |
>=10 |
method |
NR |
calculation method |
('NR', 'dishonest', 'NK') |
n_factorize |
4 |
first N iterations to factorize Jacobian in dishonest method |
>0 |
report |
1 |
write output report |
(0, 1) |
degree |
0 |
use degree in report |
(0, 1) |
init_tds |
0 |
initialize TDS after PFlow |
(0, 1) |
linesearch |
1 |
backtracking line search for NR |
(0, 1) |
TDS#
Option |
Value |
Info |
Accepted values |
|---|---|---|---|
linsolve |
0 |
solve symbolic factorization each step (enable when KLU segfaults) |
(0, 1) |
method |
trapezoid |
DAE solution method: "trapezoid" and "backeuler" use niter-based step heuristic; "trap_adapt" and "qndf" use internal LTE error control (requires fixt=0) |
('trapezoid', 'trap_adapt', 'backeuler', 'qndf') |
tol |
0.000 |
convergence tolerance |
float |
t0 |
0 |
simulation starting time |
>=0 |
tf |
20 |
simulation ending time |
>t0 |
fixt |
1 |
use fixed step size (1) or variable (0); adaptive methods (trap_adapt, qndf) override to 0 |
(0, 1) |
shrinkt |
1 |
allow step shrinking on non-convergence when fixt=1 |
(0, 1) |
honest |
0 |
honest Newton method that updates Jac at each step |
(0, 1) |
tstep |
0.033 |
integration step size |
float |
max_iter |
15 |
maximum number of iterations |
>=10 |
refresh_event |
0 |
refresh events at each step |
(0, 1) |
test_init |
1 |
test if initialization passes |
(0, 1) |
check_conn |
1 |
re-check connectivity after event |
(0, 1) |
criteria |
1 |
use criteria to stop simulation if unstable |
(0, 1) |
ddelta_limit |
180 |
delta diff. limit to be considered unstable, in degree |
|
g_scale |
1 |
scale algebraic residuals with time step size |
positive |
reset_tiny |
1 |
reset tiny residuals to zero to avoid chattering |
(0, 1) |
qrt |
0 |
quasi-real-time stepping |
(0, 1) |
kqrt |
1 |
quasi-real-time scaling factor; kqrt > 1 means slowing down |
positive |
store_z |
0 |
store limiter status in TDS output |
(0, 1) |
store_f |
0 |
store RHS of diff. equations |
(0, 1) |
store_h |
0 |
store RHS of external diff. equations |
(0, 1) |
store_i |
0 |
store RHS of external algeb. equations |
(0, 1) |
limit_store |
0 |
limit in-memory timeseries storage |
(0, 1) |
max_store |
900 |
maximum steps of data stored in memory before offloading |
positive integer |
save_every |
1 |
save one step to memory every N simulation steps |
integer |
save_mode |
auto |
automatically or manually save output data when done |
('auto', 'manual') |
no_tqdm |
0 |
disable tqdm progressbar |
(0, 1) |
chatter_iter |
4 |
minimum iterations to detect chattering |
int>=4 |
linesearch |
1 |
nonmonotone backtracking line search |
(0, 1) |
dtmax |
0 |
maximum step size (0 = auto from freq and tspan) |
>=0 |
dtmin_adapt |
0 |
minimum step size for adaptive methods (0 = auto) |
>=0 |
abstol |
0.000 |
absolute tolerance for adaptive LTE estimation |
float |
reltol |
0.001 |
relative tolerance for adaptive LTE estimation |
float |
EIG#
Option |
Value |
Info |
Accepted values |
|---|---|---|---|
linsolve |
0 |
solve symbolic factorization each step (enable when KLU segfaults) |
(0, 1) |
plot |
0 |
show plot after computation |
(0, 1) |
tol |
0.000 |
numerical tolerance to treat eigenvalues as zeros |
|
gy_tol |
0.000 |
row norm threshold for eliminating dead algebraic variables |
SE#
Option |
Value |
Info |
Accepted values |
|---|---|---|---|
linsolve |
0 |
solve symbolic factorization each step (enable when KLU segfaults) |
(0, 1) |
tol |
0.000 |
convergence tolerance |
float |
max_iter |
100 |
max number of SE iterations |
>=1 |
flat_start |
0 |
use flat start (1.0 pu, 0 rad) as initial guess |
(0, 1) |
report |
1 |
write output report |
(0, 1) |
CPF#
Option |
Value |
Info |
Accepted values |
|---|---|---|---|
linsolve |
0 |
solve symbolic factorization each step (enable when KLU segfaults) |
(0, 1) |
parameterization |
pseudo_arclength |
continuation method |
('natural', 'arclength', 'pseudo_arclength') |
step |
0.100 |
initial continuation step size for lambda |
float |
step_min |
0.000 |
minimum step size |
float |
step_max |
0.500 |
maximum step size |
float |
adapt_step |
1 |
enable adaptive step sizing |
(0, 1) |
tol |
0.000 |
convergence tolerance for corrector |
float |
max_iter |
20 |
max corrector (NR) iterations per step |
>=1 |
max_steps |
500 |
max continuation steps |
>=1 |
stop_at |
NOSE |
termination: 'NOSE', 'FULL', or a float lambda |
('NOSE', 'FULL', 'float') |
report |
1 |
write output report |
(0, 1) |