Application Program Interface (API)

PSS®E 35.3.0
July 2021

Siemens Industry, Inc.

Siemens Power Technologies International
400 State Street
Schenectady, NY 12301-1058 USA
+1 518-395-5000
www.siemens.com/power-technologies
Copyright © 1990, 2020 Siemens Power Technologies International
Information in this manual and any software described herein is confidential and subject to change without notice and does not repre-
sent a commitment on the part of Siemens Industry, Inc., Siemens Power Technologies International. The software described in this
manual is furnished under a license agreement or nondisclosure agreement and may be used or copied only in accordance with the
terms of the agreement. No part of this manual may be reproduced or transmitted in any form or by any means, electronic or me-
chanical, including photocopying, for any purpose other than the purchaser’s personal use, without the express written permission of
Siemens Industry, Inc., Siemens Power Technologies International. PSS®E high-performance transmission planning software is a reg-
istered trademark of Siemens Industry, Inc., Siemens Power Technologies International in the United States and other countries. The
Windows 7® and Windows 10® operating systems, the Visual C++® development system, Microsoft Office Excel® and Microsoft Visual
Studio® are registered trademarks of Microsoft Corporation in the United States and other countries. The Python programming language
is a trademark of the Python Software Foundation. Other names may be trademarks of their respective owners.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
ii
Table of Contents
Preface .......................................................................................................................................... liii
Power Flow ...................................................................................................................................... 1
Power Flow Operation .............................................................................................................. 2
ACCC ............................................................................................................................... 2
ACCC_2 ............................................................................................................................ 4
ACCC_MULTIPLE_MERGE .................................................................................................... 6
ACCC_MULTIPLE_RUN_REPORT ........................................................................................... 8
ACCC_MULTIPLE_RUN_REPORT_2 ...................................................................................... 11
ACCC_PARALLEL .............................................................................................................. 15
ACCC_PARALLEL_2 .......................................................................................................... 18
ACCC_SINGLE_RUN_REPORT ............................................................................................. 21
ACCC_SINGLE_RUN_REPORT_2 ......................................................................................... 24
ACCC_SINGLE_RUN_REPORT_3 ......................................................................................... 27
ACCC_SINGLE_RUN_REPORT_4 ......................................................................................... 30
ACCC_SINGLE_RUN_REPORT_5 ......................................................................................... 33
ACCC_TRIP_COR .............................................................................................................. 37
ACCC_TRIP_COR_2 .......................................................................................................... 41
ACCC_TRIP_COR_3 .......................................................................................................... 45
ACCC_WITH_COR ............................................................................................................ 50
ACCC_WITH_COR_2 ......................................................................................................... 54
ACCC_WITH_COR_3 ......................................................................................................... 58
ACCC_WITH_DSP ............................................................................................................. 62
ACCC_WITH_DSP_2 ......................................................................................................... 65
ACCC_WITH_DSP_3 ......................................................................................................... 68
ACCC_WITH_TRIP ............................................................................................................ 71
ACCC_WITH_TRIP_2 ......................................................................................................... 74
ACCC_WITH_TRIP_PARALLEL ............................................................................................. 77
ACCOR ........................................................................................................................... 80
ACCOR_2 ........................................................................................................................ 83
ACCOR_3 ........................................................................................................................ 86
ALERT_OUTPUT ............................................................................................................... 89
ALLOW_PSSUSERPF ......................................................................................................... 91
ALPH .............................................................................................................................. 92
APPEND_ACCC ................................................................................................................ 93
APPLY_VAR_LIMITS .......................................................................................................... 95
AREA .............................................................................................................................. 96
AREA_2 .......................................................................................................................... 97
AREA_ZONE .................................................................................................................... 98
ARNM ............................................................................................................................ 99
ARNM_2 ....................................................................................................................... 101
BASE_FREQUENCY ......................................................................................................... 103
BGEN ........................................................................................................................... 104
BRCH ............................................................................................................................ 105
BRCH_2 ........................................................................................................................ 107
BSNM ........................................................................................................................... 109
BUSN ........................................................................................................................... 112
BUS_INPUT ................................................................................................................... 113
BUS_OUTPUT ................................................................................................................ 114

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
iii
 BUS_SIZE_LEVEL ........................................................................................................... 115
CASE ............................................................................................................................ 116
CA_ITERATIONS ............................................................................................................. 117
CHECKVOLTAGELIMITS ................................................................................................... 118
CHECK_POWERFLOW_DATA ............................................................................................ 119
CHKCNTDUPLICON ........................................................................................................ 121
CHKCNTDUPLIDFX ......................................................................................................... 122
CLOSE_POWERFLOW ...................................................................................................... 123
CLOSE_REPORT ............................................................................................................. 124
CMPR ........................................................................................................................... 125
CNTB ............................................................................................................................ 127
CONG ........................................................................................................................... 129
CONL ........................................................................................................................... 130
CONNECTIVITY_CHECK .................................................................................................. 132
CONTROL_AREA_INTERCHANGE ...................................................................................... 133
CSV_TO_RAWX .............................................................................................................. 134
DCCC ........................................................................................................................... 135
DCCC_2 ........................................................................................................................ 137
DCCOR ......................................................................................................................... 139
DCCOR_2 ...................................................................................................................... 141
DCLF ............................................................................................................................ 144
DCLF_2 ........................................................................................................................ 146
DCPSCOPF .................................................................................................................... 148
DC_TAP_ADJUSTMENT ................................................................................................... 151
DELTMPFILES ................................................................................................................ 152
DFAX ........................................................................................................................... 153
DFAX_2 ........................................................................................................................ 155
DFAX_CONTINGENCY .................................................................................................... 157
DFTI ............................................................................................................................. 158
DIFF ............................................................................................................................. 161
DSCN ........................................................................................................................... 165
DUPLICATE_CNTLABEL_CHECK ........................................................................................ 166
ECDI ............................................................................................................................. 167
ECHO ........................................................................................................................... 169
EEQV ........................................................................................................................... 170
EQRD ........................................................................................................................... 172
EXAM ........................................................................................................................... 174
FACT ............................................................................................................................ 175
FDNS ........................................................................................................................... 176
FILE_OVERWRITE ........................................................................................................... 178
FIND ............................................................................................................................ 179
FLAT_START .................................................................................................................. 180
FNSL ............................................................................................................................ 181
GCAP ........................................................................................................................... 183
GCAP_2 ........................................................................................................................ 184
GDIF ............................................................................................................................ 185
GENDSP ....................................................................................................................... 187
GENS ........................................................................................................................... 189
GEOL ........................................................................................................................... 190
GETCONTINGENCYSAVEDCASE ....................................................................................... 191
GIC_PF ......................................................................................................................... 192

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
iv
 GNESTATUS .................................................................................................................. 194
GNET ........................................................................................................................... 195
IMNET .......................................................................................................................... 196
IMOUTAGE .................................................................................................................... 197
IMPC ............................................................................................................................ 198
IMPLEMENT_TRANSFER .................................................................................................. 199
IMPLEMENT_TRANSFER_2 .............................................................................................. 202
INLF ............................................................................................................................. 205
INLF_2 ......................................................................................................................... 207
INTA ............................................................................................................................. 209
INTZ ............................................................................................................................. 210
ISOLATE_LEVELS ........................................................................................................... 211
JOIN ............................................................................................................................. 212
LAMP ........................................................................................................................... 213
LINES_PER_PAGE ........................................................................................................... 214
LINES_PER_PAGE_ONE_DEVICE ....................................................................................... 215
LINE_SHUNT_REPORTING ............................................................................................... 216
LIST ............................................................................................................................. 217
LISTCONTINGENCYSAVEDCASES ..................................................................................... 219
LLRF ............................................................................................................................. 220
LOAD_REDUCTION ......................................................................................................... 222
LOUT ............................................................................................................................ 223
LTAP ............................................................................................................................. 224
MACCC ......................................................................................................................... 225
MACCC_2 ..................................................................................................................... 230
MACCC_3 ..................................................................................................................... 235
MACCC_PARALLEL ......................................................................................................... 240
MACCC_PARALLEL_2 ...................................................................................................... 245
MACCC_TRIP_COR ......................................................................................................... 250
MACCC_TRIP_COR_2 ...................................................................................................... 256
MACCC_TRIP_COR_3 ...................................................................................................... 262
MACCC_TRIP_COR_4 ...................................................................................................... 269
MACCC_WITH_COR ........................................................................................................ 275
MACCC_WITH_COR_2 .................................................................................................... 280
MACCC_WITH_COR_3 .................................................................................................... 286
MACCC_WITH_COR_4 .................................................................................................... 292
MACCC_WITH_TRIP ........................................................................................................ 298
MACCC_WITH_TRIP_2 .................................................................................................... 303
MACCC_WITH_TRIP_3 .................................................................................................... 308
MACCC_WITH_TRIP_PARALLEL ........................................................................................ 313
MACCC_WITH_TRIP_PARALLEL_2 ..................................................................................... 318
MATRIX_GROWTH_FACTOR ............................................................................................ 323
MCRE ........................................................................................................................... 324
MODR .......................................................................................................................... 325
MOVE3WND ................................................................................................................. 327
MOVEBRN ..................................................................................................................... 328
MOVEINDMAC .............................................................................................................. 329
MOVEINDMACS ............................................................................................................. 330
MOVELOAD .................................................................................................................. 331
MOVELOADS ................................................................................................................. 332
MOVEMAC .................................................................................................................... 333

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
v
 MOVEPLNT ................................................................................................................... 334
MOVESHUNT ................................................................................................................ 335
MOVESHUNTS ............................................................................................................... 336
MOVESWS .................................................................................................................... 337
MOVESWSHUNT ............................................................................................................ 338
MOVESWSHUNTS .......................................................................................................... 339
MOV_ALPHA ................................................................................................................. 340
MOV_ITERATIONS .......................................................................................................... 341
MOV_TOLERANCE ......................................................................................................... 342
MSLV ........................................................................................................................... 343
MSUM .......................................................................................................................... 345
MTDC ........................................................................................................................... 346
MULTISECTION_REPORTING ............................................................................................ 347
MWMI .......................................................................................................................... 348
MWOMWMSF ............................................................................................................... 350
MWOMWOSF ................................................................................................................ 351
N11_ACCC .................................................................................................................... 352
N11_ACCC_2 ................................................................................................................ 356
N11_ACCC_3 ................................................................................................................ 360
N11_ACCC_PARALLEL .................................................................................................... 364
N11_ACCC_PARALLEL_2 ................................................................................................. 368
N11_ACCC_PSCOPF ....................................................................................................... 372
N11_ACCC_PSCOPF_2 .................................................................................................... 379
N11_ACCC_PSCOPF_3 .................................................................................................... 386
NETG ........................................................................................................................... 392
NEWCAS ....................................................................................................................... 393
NEWCASE_2 ................................................................................................................. 394
NEWTON_TOLERANCE ................................................................................................... 395
NEW_DIMENSION .......................................................................................................... 396
NON_DIVERGENT .......................................................................................................... 397
NON_TRANS_PERCENT_UNITS ........................................................................................ 398
NSOL ........................................................................................................................... 399
NUMBER_THREADS ........................................................................................................ 401
ORDR ........................................................................................................................... 402
OTDF ........................................................................................................................... 403
OUTPUT_Y_MATRIX ....................................................................................................... 404
OUTS ........................................................................................................................... 405
OWNM ......................................................................................................................... 406
OWNM_2 ..................................................................................................................... 408
OWNM_3 ..................................................................................................................... 410
OWNR .......................................................................................................................... 412
PATH ............................................................................................................................ 413
PHASE_SHIFT_ADJUSTMENT ........................................................................................... 414
POLY ............................................................................................................................ 415
POUT ........................................................................................................................... 418
POWER_OUTPUT ........................................................................................................... 419
PP_ACCC ...................................................................................................................... 420
PP_ACCC_MULTI_CASE ................................................................................................... 422
PRINT_OUTAGED_BRANCHES .......................................................................................... 425
PRINT_WINDING_BUSES ................................................................................................. 426
PROGRESS_OUTPUT ....................................................................................................... 427

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
vi
 PROMPT_OUTPUT .......................................................................................................... 428
PRTI ............................................................................................................................. 429
PSCOPF ........................................................................................................................ 430
PSCOPF_2 ..................................................................................................................... 436
PSEB ............................................................................................................................ 442
PSSEHALT ..................................................................................................................... 443
PSSEHALT_2 .................................................................................................................. 444
PV_ENGINE ................................................................................................................... 445
PV_ENGINE_1A ............................................................................................................. 450
PV_ENGINE_2 ............................................................................................................... 455
PV_ENGINE_3 ............................................................................................................... 461
PV_ENGINE_4 ............................................................................................................... 467
PV_ENGINE_5 ............................................................................................................... 473
PV_ENGINE_6 ............................................................................................................... 479
QV_ENGINE .................................................................................................................. 485
QV_ENGINE_2 ............................................................................................................... 488
QV_ENGINE_3 ............................................................................................................... 491
QV_ENGINE_4 ............................................................................................................... 494
RANK ........................................................................................................................... 498
RANK_BRN_AND_MAC ................................................................................................... 500
RATE ............................................................................................................................ 502
RATE_2 ......................................................................................................................... 504
RATING_SET .................................................................................................................. 506
RAWD ........................................................................................................................... 507
RAWDX ......................................................................................................................... 509
RAWD_2 ....................................................................................................................... 511
RAWX_TO_CSV .............................................................................................................. 513
RDCH ........................................................................................................................... 514
RDCHRAWVERSION ........................................................................................................ 515
RDEQ ........................................................................................................................... 516
READ ............................................................................................................................ 518
READCAPCURVES .......................................................................................................... 519
READRAWVERSION ........................................................................................................ 520
READSUB ...................................................................................................................... 521
READSUBRAWVERSION .................................................................................................. 523
READVDFROMRAWX ...................................................................................................... 525
READX .......................................................................................................................... 526
RECN ............................................................................................................................ 527
REGB ............................................................................................................................ 528
RELIND ......................................................................................................................... 529
RELIND_2 ..................................................................................................................... 532
REMM .......................................................................................................................... 535
REPORT_OUTPUT ........................................................................................................... 536
RESQ ............................................................................................................................ 537
RESQVERSION ............................................................................................................... 538
RESULT_TABLE_OUTPUT ................................................................................................. 539
RETI ............................................................................................................................. 540
RETRY_PSSUSERPF ......................................................................................................... 541
REV29_NAMES .............................................................................................................. 542
RNFI ............................................................................................................................. 543
RSOL ............................................................................................................................ 545

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
vii
 RUNLASTSOLUTION ....................................................................................................... 547
RWCM .......................................................................................................................... 548
RWMA .......................................................................................................................... 549
RWMM ......................................................................................................................... 551
RWSQ ........................................................................................................................... 552
RWSQ_2 ....................................................................................................................... 554
SAVE ............................................................................................................................ 556
SCAL ............................................................................................................................ 557
SCAL_2 ........................................................................................................................ 560
SCAL_3 ........................................................................................................................ 563
SCAL_4 ........................................................................................................................ 566
SENSITIVITY_FLOW ........................................................................................................ 569
SENSITIVITY_FLOWS ...................................................................................................... 573
SENSITIVITY_INTERFACE ................................................................................................. 576
SENSITIVITY_VOLTAGE ................................................................................................... 579
SENSITIVITY_VOLTAGES ................................................................................................. 582
SET_INPUT_DEV ............................................................................................................ 585
SET_PROGRESS_VERBOSE ............................................................................................... 586
SHNT ........................................................................................................................... 587
SHORT_CIRCUIT_COORDINATES ...................................................................................... 588
SHORT_CIRCUIT_MODELING ........................................................................................... 589
SHORT_CIRCUIT_UNITS .................................................................................................. 590
SHORT_CIRCUIT_WARNING ............................................................................................. 591
SHORT_CIRCUIT_Z_COORDINATES ................................................................................... 592
SHORT_CIRCUIT_Z_UNITS ............................................................................................... 593
SHOW .......................................................................................................................... 594
SHOWTABLE ................................................................................................................. 595
SHOWTABLEBYINDEX ..................................................................................................... 596
SIZE ............................................................................................................................. 597
SOLV ............................................................................................................................ 598
SPCB ............................................................................................................................ 600
SPIL ............................................................................................................................. 602
SPLT ............................................................................................................................. 606
SQLI ............................................................................................................................. 607
SRAIND ........................................................................................................................ 609
STOP ............................................................................................................................ 611
STOP_2 ........................................................................................................................ 612
SUBS ............................................................................................................................ 613
SWITCHED_SHUNT_ADJUSTMENT ................................................................................... 614
TAP_ADJUSTMENT ......................................................................................................... 615
TEXT ............................................................................................................................ 616
TFLG ............................................................................................................................ 617
TIES ............................................................................................................................. 618
TIEZ ............................................................................................................................. 619
TIME ............................................................................................................................ 620
TLST ............................................................................................................................. 621
TLTG ............................................................................................................................ 622
TPCH ............................................................................................................................ 626
TRANSFORMER_PERCENT_UNITS ..................................................................................... 629
TRANSMISSION_LINE_UNITS ........................................................................................... 630
TREE ............................................................................................................................ 631

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
viii
 TYSL ............................................................................................................................ 632
USER ............................................................................................................................ 633
VAMM .......................................................................................................................... 634
VAMO .......................................................................................................................... 635
VCHK ........................................................................................................................... 636
VOLTAGE_INPUT ............................................................................................................ 637
VOLTAGE_OUTPUT ......................................................................................................... 638
VSMO .......................................................................................................................... 639
WRITECAPCURVES ......................................................................................................... 640
WRITERAWVERSION ....................................................................................................... 642
WRITESEQVERSION ........................................................................................................ 643
WRITESEQVERSION_2 .................................................................................................... 644
WRITE_OPTIONS_FILE .................................................................................................... 645
XEQV ........................................................................................................................... 646
ZONE ........................................................................................................................... 648
ZONE_2 ........................................................................................................................ 649
ZONE_AREA .................................................................................................................. 650
ZONM .......................................................................................................................... 651
ZONM_2 ...................................................................................................................... 653
Power Flow Data .................................................................................................................. 656
AREA_DATA .................................................................................................................. 656
BRANCH_CHNG ............................................................................................................. 658
BRANCH_CHNG_3 ......................................................................................................... 660
BRANCH_DATA .............................................................................................................. 663
BRANCH_DATA_3 .......................................................................................................... 665
BUS_CHNG_3 ................................................................................................................ 668
BUS_CHNG_4 ................................................................................................................ 670
BUS_DATA .................................................................................................................... 672
BUS_DATA_2 ................................................................................................................. 674
BUS_DATA_3 ................................................................................................................. 676
BUS_DATA_4 ................................................................................................................. 678
BUS_NUMBER ............................................................................................................... 680
CASE_TITLE_DATA ......................................................................................................... 681
CASOLUTION_PARAMETERS ........................................................................................... 682
CASOLUTION_PARAMETERS_2 ........................................................................................ 683
EXTR ............................................................................................................................ 685
FACTS_CHNG_2 ............................................................................................................ 686
FACTS_CHNG_3 ............................................................................................................ 689
FACTS_DATA ................................................................................................................. 692
FACTS_DATA_2 .............................................................................................................. 695
FACTS_DATA_3 .............................................................................................................. 698
GNE_CHNG ................................................................................................................... 701
GNE_DATA .................................................................................................................... 703
IMPEDANCE_CORRECTION_DATA ..................................................................................... 705
IMPEDANCE_CORRECTION_DATA_3 ................................................................................. 706
INDUCTION_MACHINE_CHNG ......................................................................................... 707
INDUCTION_MACHINE_DATA .......................................................................................... 710
LOAD_CHNG_4 ............................................................................................................. 713
LOAD_CHNG_5 ............................................................................................................. 715
LOAD_CHNG_6 ............................................................................................................. 717
LOAD_DATA .................................................................................................................. 719

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
ix
 LOAD_DATA_3 ............................................................................................................... 721
LOAD_DATA_4 ............................................................................................................... 723
LOAD_DATA_5 ............................................................................................................... 725
LOAD_DATA_6 ............................................................................................................... 727
LONG_TITLE_DATA ......................................................................................................... 729
MACHINE_CAP_CURVE_CHNG ........................................................................................ 730
MACHINE_CAP_CURVE_DATA .......................................................................................... 732
MACHINE_CHNG_2 ........................................................................................................ 734
MACHINE_CHNG_3 ........................................................................................................ 736
MACHINE_CHNG_4 ........................................................................................................ 738
MACHINE_DATA ............................................................................................................ 740
MACHINE_DATA_2 ......................................................................................................... 742
MACHINE_DATA_3 ......................................................................................................... 744
MACHINE_DATA_4 ......................................................................................................... 747
MBID2DC ...................................................................................................................... 750
MBID3WND .................................................................................................................. 751
MBIDATRN .................................................................................................................... 752
MBIDBRN ...................................................................................................................... 753
MBIDFACTS ................................................................................................................... 754
MBIDGNE ..................................................................................................................... 755
MBIDINDMAC ................................................................................................................ 756
MBIDLOAD .................................................................................................................... 757
MBIDMAC ..................................................................................................................... 758
MBIDMDC ..................................................................................................................... 759
MBIDMSL ...................................................................................................................... 760
MBIDSHUNT ................................................................................................................. 761
MBIDSWSHUNT ............................................................................................................. 762
MBIDVD ........................................................................................................................ 763
MBIDVSC ...................................................................................................................... 764
MULTI_SECTION_LINE_DATA ........................................................................................... 765
MULTI_SECTION_LINE_EDIT ............................................................................................ 767
MULTI_TERM_DC_BUS_DATA .......................................................................................... 768
MULTI_TERM_DC_CONVR_DATA ...................................................................................... 770
MULTI_TERM_DC_LINE_CHNG ........................................................................................ 773
MULTI_TERM_DC_LINE_DATA .......................................................................................... 775
MULTI_TERM_DC_LINK_DATA ......................................................................................... 777
OWNER_DATA ............................................................................................................... 779
PBUS_ADD_MOD ........................................................................................................... 780
PBUS_DELETE ................................................................................................................ 781
PLANT_CHNG ................................................................................................................ 782
PLANT_CHNG_3 ............................................................................................................ 783
PLANT_CHNG_4 ............................................................................................................ 784
PLANT_DATA ................................................................................................................. 786
PLANT_DATA_3 ............................................................................................................. 787
PLANT_DATA_4 ............................................................................................................. 788
PURG ........................................................................................................................... 790
PURG2DC ..................................................................................................................... 792
PURG3WND .................................................................................................................. 793
PURGAREA .................................................................................................................... 794
PURGATRN .................................................................................................................... 795
PURGBRN ...................................................................................................................... 796

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
x
 PURGCAPCURVE ............................................................................................................ 797
PURGE_MULTI_TERM_DC_BUS ........................................................................................ 798
PURGE_MULTI_TERM_DC_CONVR .................................................................................... 799
PURGE_MULTI_TERM_DC_LINK ....................................................................................... 801
PURGFACTS .................................................................................................................. 802
PURGGNE ..................................................................................................................... 803
PURGINDMAC ............................................................................................................... 804
PURGINDMACS .............................................................................................................. 805
PURGLOAD ................................................................................................................... 806
PURGLOADS .................................................................................................................. 807
PURGMAC ..................................................................................................................... 808
PURGMDC .................................................................................................................... 809
PURGMSL ..................................................................................................................... 810
PURGMUT ..................................................................................................................... 811
PURGOWNER ................................................................................................................ 812
PURGPLNT .................................................................................................................... 813
PURGSHUNT ................................................................................................................. 814
PURGSHUNTS ................................................................................................................ 815
PURGSWS ..................................................................................................................... 816
PURGSWSHUNT ............................................................................................................. 817
PURGVSC ...................................................................................................................... 818
PURGZONE ................................................................................................................... 819
PURG_VOLTAGE_DROOP ................................................................................................. 820
RATINGSETTEXTDATA ..................................................................................................... 821
SHUNT_CHNG ............................................................................................................... 822
SHUNT_DATA ................................................................................................................ 823
SOLUTION_PARAMETERS ................................................................................................ 824
SOLUTION_PARAMETERS_2 ............................................................................................ 826
SOLUTION_PARAMETERS_3 ............................................................................................ 828
SOLUTION_PARAMETERS_4 ............................................................................................ 830
SOLUTION_PARAMETERS_5 ............................................................................................ 832
SWITCHED_SHUNT_CHNG_3 ........................................................................................... 835
SWITCHED_SHUNT_CHNG_4 ........................................................................................... 838
SWITCHED_SHUNT_CHNG_5 ........................................................................................... 841
SWITCHED_SHUNT_DATA ............................................................................................... 844
SWITCHED_SHUNT_DATA_3 ............................................................................................ 847
SWITCHED_SHUNT_DATA_4 ............................................................................................ 850
SWITCHED_SHUNT_DATA_5 ............................................................................................ 853
THREE_WINDING_DATA .................................................................................................. 856
THREE_WND_IMPEDANCE_DATA ..................................................................................... 860
THREE_WND_IMPED_CHNG_3 ........................................................................................ 863
THREE_WND_IMPED_CHNG_4 ........................................................................................ 866
THREE_WND_IMPED_DATA_3 ......................................................................................... 869
THREE_WND_IMPED_DATA_4 ......................................................................................... 872
THREE_WND_WINDING_DATA ......................................................................................... 875
THREE_WND_WINDING_DATA_3 ..................................................................................... 877
THREE_WND_WINDING_DATA_4 ..................................................................................... 879
THREE_WND_WINDING_DATA_5 ..................................................................................... 882
TRANSACTION_ADD_MOD ............................................................................................. 885
TRANSACTION_DELETE .................................................................................................. 886
TRANSFER_CHNG .......................................................................................................... 887

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xi
 TRANSFER_DATA ........................................................................................................... 888
TWO_TERMINAL_DC_LINE_CHNG .................................................................................... 890
TWO_TERMINAL_DC_LINE_DATA ..................................................................................... 892
TWO_TERM_DC_CONVERTER_DATA_3 ............................................................................. 894
TWO_TERM_DC_CONVR_DATA ........................................................................................ 897
TWO_WINDING_CHNG_4 ............................................................................................... 900
TWO_WINDING_CHNG_5 ............................................................................................... 904
TWO_WINDING_CHNG_6 ............................................................................................... 908
TWO_WINDING_DATA .................................................................................................... 913
TWO_WINDING_DATA_3 ................................................................................................ 917
TWO_WINDING_DATA_4 ................................................................................................ 921
TWO_WINDING_DATA_5 ................................................................................................ 925
TWO_WINDING_DATA_6 ................................................................................................ 929
VOLTAGE_DROOP_CHNG ................................................................................................ 934
VOLTAGE_DROOP_DATA ................................................................................................. 936
VSC_DC_CONVERTER_DATA ............................................................................................ 938
VSC_DC_CONVERTER_DATA_3 ........................................................................................ 940
VSC_DC_LINE_CHNG ..................................................................................................... 942
VSC_DC_LINE_DATA ....................................................................................................... 943
ZONE_DATA .................................................................................................................. 944
Node Breaker ................................................................................................................................ 946
Node Breaker Operation ........................................................................................................ 947
CONVERT_SECTION_TO_BUS .......................................................................................... 947
ISOLATE2DCLINEBYBREAKER .......................................................................................... 948
ISOLATE3WTBYBREAKER ................................................................................................ 949
ISOLATEBUSBYBREAKER ................................................................................................. 950
ISOLATEFACTSBYBREAKER .............................................................................................. 951
ISOLATEINDMACHINEBYBREAKER .................................................................................... 952
ISOLATELINEBYBREAKER ................................................................................................ 953
ISOLATELOADBYBREAKER ............................................................................................... 954
ISOLATEMACHINEBYBREAKER ......................................................................................... 955
ISOLATEMSLINEBYBREAKER ............................................................................................ 956
ISOLATEMTDCLINEBYBREAKER ........................................................................................ 957
ISOLATENODEBYBREAKER .............................................................................................. 958
ISOLATESHUNTBYBREAKER ............................................................................................. 959
ISOLATESWDBYBREAKER ................................................................................................ 960
ISOLATESWSHUNTBYBREAKER ........................................................................................ 961
ISOLATESWSHUNTBYBREAKER_2 ..................................................................................... 962
ISOLATEVSCDCLINEBYBREAKER ....................................................................................... 963
RESTORESTATESFROMISOLATE ........................................................................................ 964
STATION_BUILD_CONFIG ................................................................................................ 965
STATION_LIST ................................................................................................................ 966
STATION_POUT ............................................................................................................. 967
STATION_POUT_2 .......................................................................................................... 968
STATION_TREE .............................................................................................................. 969
Node Breaker Data ................................................................................................................ 972
FETCH_ADJVAR_TERM_NODE ......................................................................................... 972
FETCH_INDMACHINE_TERM_NODE ................................................................................. 973
FETCH_LOAD_TERM_NODE ............................................................................................ 974
FETCH_MACHINE_TERM_NODE ....................................................................................... 975
FETCH_SHUNT_TERM_NODE .......................................................................................... 976

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xii
 FETCH_SWS_SHUNT_TERM_NODE .................................................................................. 977
FETCH_SWS_SHUNT_TERM_NODE_2 ............................................................................... 978
PLANT_BUS_SECTION_CHNG .......................................................................................... 979
STATION_2DC_CONV_TERM_CHNG ................................................................................. 980
STATION_ADJVAR_TERM_CHNG ...................................................................................... 981
STATION_BRANCH_TERM_CHNG ..................................................................................... 982
STATION_BRANCH_TERM_MOVE ..................................................................................... 983
STATION_BUS_PURG ...................................................................................................... 984
STATION_CHNG ............................................................................................................. 985
STATION_DATA .............................................................................................................. 986
STATION_FACTS_TERM_CHNG ........................................................................................ 987
STATION_INDMACHINE_TERM_CHNG .............................................................................. 988
STATION_LOAD_TERM_CHNG ......................................................................................... 989
STATION_MACHINE_TERM_CHNG ................................................................................... 990
STATION_MTDC_TERM_CHNG ......................................................................................... 991
STATION_NODE_CHNG .................................................................................................. 992
STATION_NODE_DATA .................................................................................................... 993
STATION_NODE_NUMBER .............................................................................................. 994
STATION_NODE_PURG ................................................................................................... 995
STATION_NUMBER ......................................................................................................... 996
STATION_PURG ............................................................................................................. 997
STATION_SHUNT_TERM_CHNG ....................................................................................... 998
STATION_SWD_CHNG .................................................................................................... 999
STATION_SWD_DATA .................................................................................................... 1001
STATION_SWD_MBID ................................................................................................... 1003
STATION_SWD_MOVE .................................................................................................. 1004
STATION_SWD_PURG ................................................................................................... 1005
STATION_SWS_SHUNT_TERM_CHNG ............................................................................. 1006
STATION_SWS_SHUNT_TERM_CHNG_2 .......................................................................... 1007
STATION_THREE_WND_TERM_CHNG ............................................................................. 1008
STATION_THREE_WND_TERM_MOVE ............................................................................. 1009
STATION_VSCDC_CONV_TERM_CHNG ............................................................................ 1010
SYSTEM_SWD_CHNG ................................................................................................... 1011
SYSTEM_SWD_DATA .................................................................................................... 1013
Optimal Power Flow .................................................................................................................... 1017
Optimal Power Flow Operation ............................................................................................ 1018
ADD_DETAILS_TO_OPF_LOG ......................................................................................... 1018
APPLY_ALTERNATE_STEP_SIZE ....................................................................................... 1019
APPLY_AUTOMATIC_SCALING ....................................................................................... 1020
BAD_ITER_COARSE_LIMIT ............................................................................................. 1021
BAD_ITER_FINE_LIMIT .................................................................................................. 1022
CLAMP_NONOPTIMIZED_GENS ..................................................................................... 1023
CONSTRAIN_INTERFACE_FLOWS ................................................................................... 1024
FINAL_OPF_BARRIER_COEFF ......................................................................................... 1025
IMPORT_ECDI .............................................................................................................. 1026
INITIAL_OPF_BARRIER_COEFF ....................................................................................... 1027
INTERFACE_FLOW_COST_COEFF ................................................................................... 1028
LSTO .......................................................................................................................... 1029
MINIMIZE_ADJ_BUS_SHUNTS ....................................................................................... 1031
MINIMIZE_FUEL_COST ................................................................................................. 1032
MINIMIZE_INTERFACE_FLOWS ...................................................................................... 1033

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xiii
 MINIMIZE_LOAD_ADJUSTMENTS ................................................................................... 1034
MINIMIZE_P_LOSSES .................................................................................................... 1035
MINIMIZE_P_SLACK ..................................................................................................... 1036
MINIMIZE_Q_LOSSES ................................................................................................... 1037
MINIMIZE_Q_SLACK .................................................................................................... 1038
MINIMIZE_REACTIVE_RESERVE ...................................................................................... 1039
MINIMIZE_SERIES_COMP .............................................................................................. 1040
NOPF ......................................................................................................................... 1041
OPEN_BUS_VOLTAGE_LIMITS ........................................................................................ 1042
OPF_BARRIER_STEP_LENGTH ........................................................................................ 1043
OPF_CLAMP_DECAY_FACTOR ....................................................................................... 1044
OPF_FINAL_CLAMP_TOL .............................................................................................. 1045
OPF_FIXED_VOLTAGE_PENALTY .................................................................................... 1046
OPF_FIX_ALL_GENERATORS .......................................................................................... 1047
OPF_FIX_PHASE_SHIFTERS ........................................................................................... 1048
OPF_FIX_SWITCHED_SHUNTS ....................................................................................... 1049
OPF_FIX_TAP_RATIOS ................................................................................................... 1050
OPF_INITIAL_CLAMP_TOL ............................................................................................. 1051
OPF_INTERIOR_SHIFT_FACTOR ...................................................................................... 1052
OPF_LAMBDA_TOLERANCE ........................................................................................... 1053
OPF_LF_CONTROL_PENALTY ......................................................................................... 1054
OPF_MAX_TAP_RATIO_STEP ......................................................................................... 1055
OPF_MIN_TAP_RATIO_STEP .......................................................................................... 1056
OPF_REGULATE_AREA_INT ........................................................................................... 1057
OPF_ROUND_SWITCHED_SHUNTS ................................................................................. 1058
OPF_ROUND_TAP_RATIOS ............................................................................................ 1059
OPF_SCALE_QGEN_LIMITS ........................................................................................... 1060
OPF_STEP_LENGTH_TOLERANCE ................................................................................... 1061
OPF_USE_GENERATOR_VSCHED .................................................................................... 1062
OPTO ......................................................................................................................... 1063
PRODUCE_OPF_LOG_FILE ............................................................................................. 1069
P_LOSSES_COST_COEFF ............................................................................................... 1070
Q_LOSSES_COST_COEFF .............................................................................................. 1071
REACTIVE_RESV_COST_COEFF ...................................................................................... 1072
ROPF .......................................................................................................................... 1073
RWOP ......................................................................................................................... 1074
SET_OPF_REPORT_SUBSYSTEM ..................................................................................... 1075
USE_DUAL_CRITERIA .................................................................................................... 1076
USE_EMERGENCY_FLOW_LIMITS ................................................................................... 1077
USE_EMERGENCY_VOLT_LIMITS .................................................................................... 1078
WRITE_OPF_OPTIONS_FILE ........................................................................................... 1079
Optimal Power Flow Data .................................................................................................... 1082
NEWOPF ..................................................................................................................... 1082
OPF_ADJBRX_INDV ...................................................................................................... 1083
OPF_ADJBRX_SUBSYS .................................................................................................. 1085
OPF_ADJLOAD_TBL ...................................................................................................... 1088
OPF_ADJVAR_INDV ...................................................................................................... 1090
OPF_ADJVAR_INDV_2 .................................................................................................. 1092
OPF_ADJVAR_SUBSYS .................................................................................................. 1094
OPF_APDSP_TBL .......................................................................................................... 1097
OPF_BRFLW_3WT_INDV ............................................................................................... 1099

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xiv
 OPF_BRFLW_BRN_INDV ................................................................................................ 1101
OPF_BRFLW_SUBSYS .................................................................................................... 1103
OPF_BUS_INDV ........................................................................................................... 1106
OPF_BUS_INDV_2 ........................................................................................................ 1108
OPF_BUS_SUBSYS ........................................................................................................ 1110
OPF_CHANGE_3WT_FLOW_ID ....................................................................................... 1113
OPF_CHANGE_ADJVAR_ID ............................................................................................ 1114
OPF_CHANGE_BRN_FLOW_ID ....................................................................................... 1115
OPF_CSTTBL_LIN ......................................................................................................... 1116
OPF_CSTTBL_POLY ...................................................................................................... 1117
OPF_CSTTBL_QUAD ..................................................................................................... 1118
OPF_GENDSP_INDV ..................................................................................................... 1119
OPF_GENDSP_SUBSYS ................................................................................................. 1120
OPF_GENRSV_INDV ..................................................................................................... 1121
OPF_GENRSV_SUBSYS .................................................................................................. 1122
OPF_GEN_RCAP_INDV .................................................................................................. 1124
OPF_GEN_RCAP_SUBSYS .............................................................................................. 1126
OPF_INTFLW_3WT ....................................................................................................... 1129
OPF_INTFLW_BRN ........................................................................................................ 1130
OPF_INTFLW_MAIN ..................................................................................................... 1131
OPF_INTFLW_RESET ..................................................................................................... 1133
OPF_LNCEQN_ADJLOAD ............................................................................................... 1134
OPF_LNCEQN_ADJVAR ................................................................................................. 1135
OPF_LNCEQN_BRFLOW ................................................................................................ 1136
OPF_LNCEQN_INTFLOW ............................................................................................... 1137
OPF_LNCEQN_MAIN .................................................................................................... 1138
OPF_LNCEQN_PGEN .................................................................................................... 1139
OPF_LNCEQN_QGEN ................................................................................................... 1140
OPF_LNCEQN_RESET ................................................................................................... 1141
OPF_LNCEQN_SWSHUNT ............................................................................................. 1142
OPF_LNCEQN_SWSHUNT_2 .......................................................................................... 1143
OPF_LNCEQN_TRAN .................................................................................................... 1144
OPF_LNCEQN_VANG .................................................................................................... 1145
OPF_LNCEQN_VANG_2 ................................................................................................ 1146
OPF_LNCEQN_VMAG ................................................................................................... 1147
OPF_LNCEQN_VMAG_2 ................................................................................................ 1148
OPF_LOAD_INDV ......................................................................................................... 1149
OPF_LOAD_SUBSYS ..................................................................................................... 1150
OPF_PERRSV_GEN ....................................................................................................... 1151
OPF_PERRSV_MAIN ...................................................................................................... 1152
OPF_PERRSV_RESET ..................................................................................................... 1153
PURGE_ALL_OPF_DATA ................................................................................................ 1154
PURGE_OPF_ADJBRX_INDV ........................................................................................... 1155
PURGE_OPF_ADJBRX_SUBSYS ....................................................................................... 1156
PURGE_OPF_ADJLOAD_TBL ........................................................................................... 1157
PURGE_OPF_ADJVAR_INDV ........................................................................................... 1158
PURGE_OPF_ADJVAR_INDV_3 ....................................................................................... 1159
PURGE_OPF_ADJVAR_SUBSYS ....................................................................................... 1160
PURGE_OPF_APDSP_TBL ............................................................................................... 1161
PURGE_OPF_BRFLW_3WT ............................................................................................. 1162
PURGE_OPF_BRFLW_BRN .............................................................................................. 1163

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xv
 PURGE_OPF_BRFLW_SUBSYS ........................................................................................ 1164
PURGE_OPF_BUS_INDV ................................................................................................ 1165
PURGE_OPF_BUS_INDV_3 ............................................................................................ 1166
PURGE_OPF_BUS_SUBSYS ............................................................................................ 1167
PURGE_OPF_CSTTBL_LIN .............................................................................................. 1168
PURGE_OPF_CSTTBL_POLY ........................................................................................... 1169
PURGE_OPF_CSTTBL_QUAD .......................................................................................... 1170
PURGE_OPF_GENDSP_INDV .......................................................................................... 1171
PURGE_OPF_GENDSP_SUBSYS ...................................................................................... 1172
PURGE_OPF_GENRSV_INDV .......................................................................................... 1173
PURGE_OPF_GENRSV_SUBSYS ...................................................................................... 1174
PURGE_OPF_GEN_RCAP_INDV ...................................................................................... 1175
PURGE_OPF_GEN_RCAP_SUBSYS .................................................................................. 1176
PURGE_OPF_INTFLW .................................................................................................... 1177
PURGE_OPF_INTFLW_3WT ............................................................................................ 1178
PURGE_OPF_INTFLW_BRN ............................................................................................ 1179
PURGE_OPF_LNCEQN .................................................................................................. 1180
PURGE_OPF_LNCEQN_ADJLOAD ................................................................................... 1181
PURGE_OPF_LNCEQN_ADJVAR ...................................................................................... 1182
PURGE_OPF_LNCEQN_BRFLOW ..................................................................................... 1183
PURGE_OPF_LNCEQN_INTFLOW .................................................................................... 1184
PURGE_OPF_LNCEQN_PGEN ......................................................................................... 1185
PURGE_OPF_LNCEQN_QGEN ........................................................................................ 1186
PURGE_OPF_LNCEQN_SWSHUNT .................................................................................. 1187
PURGE_OPF_LNCEQN_SWSHUNT_2 ............................................................................... 1188
PURGE_OPF_LNCEQN_TRAN ......................................................................................... 1189
PURGE_OPF_LNCEQN_VANG ........................................................................................ 1190
PURGE_OPF_LNCEQN_VANG_2 ..................................................................................... 1191
PURGE_OPF_LNCEQN_VMAG ........................................................................................ 1192
PURGE_OPF_LNCEQN_VMAG_2 .................................................................................... 1193
PURGE_OPF_LOAD_INDV .............................................................................................. 1194
PURGE_OPF_LOAD_SUBSYS .......................................................................................... 1195
PURGE_OPF_PERRSV .................................................................................................... 1196
PURGE_OPF_PERRSV_GEN ............................................................................................ 1197
Fault Analysis ............................................................................................................................. 1200
Fault Analysis Operation ...................................................................................................... 1201
ANSI .......................................................................................................................... 1201
ANSI_2 ....................................................................................................................... 1203
ANSI_3 ....................................................................................................................... 1205
ASCC .......................................................................................................................... 1208
ASCC_1A .................................................................................................................... 1210
ASCC_2 ...................................................................................................................... 1212
ASCC_3 ...................................................................................................................... 1214
ASCC_SCFILE ............................................................................................................... 1218
BKDY .......................................................................................................................... 1219
CHECK_SEQUENCE_DATA ............................................................................................. 1221
FLAT .......................................................................................................................... 1222
FLAT_2 ....................................................................................................................... 1224
IECS ........................................................................................................................... 1227
IECS_2 ........................................................................................................................ 1229
IECS_3 ........................................................................................................................ 1232

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xvi
 IECS_4 ........................................................................................................................ 1235
IECS_SCFILE ................................................................................................................ 1239
NEWSEQ ..................................................................................................................... 1240
SCEQ .......................................................................................................................... 1241
SCGR .......................................................................................................................... 1243
SCMU ......................................................................................................................... 1245
SCMU_2 ..................................................................................................................... 1252
SCOP .......................................................................................................................... 1259
SEQD ......................................................................................................................... 1261
SEQD_2 ...................................................................................................................... 1262
SEQUENCE_NETWORK_SETUP ....................................................................................... 1263
SQEX ......................................................................................................................... 1264
Fault Analysis Data .............................................................................................................. 1267
MBIDNCS .................................................................................................................... 1267
SEQ_3_WIND_GROUNDING_DATA ................................................................................. 1268
SEQ_3_WIND_WINDING_DATA ...................................................................................... 1269
SEQ_BRANCH_DATA ..................................................................................................... 1270
SEQ_BRANCH_DATA_3 ................................................................................................. 1272
SEQ_BUS_DATA ........................................................................................................... 1274
SEQ_FIXED_SHUNT_DATA ............................................................................................ 1275
SEQ_INDUCTION_MACH_DATA ..................................................................................... 1276
SEQ_INDUCTION_MACH_DATA_2 .................................................................................. 1278
SEQ_LOAD_DATA ......................................................................................................... 1280
SEQ_MACHINE_DATA ................................................................................................... 1282
SEQ_MACHINE_DATA_3 ............................................................................................... 1284
SEQ_MACHINE_DATA_4 ............................................................................................... 1286
SEQ_MACHINE_NCS_DATA ........................................................................................... 1288
SEQ_MACHINE_NCS_DATA_PURG .................................................................................. 1290
SEQ_MUTUAL_DATA .................................................................................................... 1291
SEQ_NCS_FLT_CNTRB_CHNG ........................................................................................ 1293
SEQ_NCS_FLT_CNTRB_DATA ......................................................................................... 1294
SEQ_NCS_FLT_CNTRB_PURG ......................................................................................... 1295
SEQ_NCS_TABLE_DATA ................................................................................................ 1296
SEQ_NCS_TABLE_PURG ................................................................................................ 1297
SEQ_SWITCHED_SHUNT_DATA ...................................................................................... 1298
SEQ_SWITCHED_SHUNT_DATA_3 .................................................................................. 1300
SEQ_THREE_WINDING_DATA ........................................................................................ 1302
SEQ_THREE_WINDING_DATA_3 ..................................................................................... 1304
SEQ_TWO_WINDING_DATA ........................................................................................... 1306
SEQ_TWO_WINDING_DATA_3 ....................................................................................... 1308
Harmonics .................................................................................................................................. 1311
Harmonics Operation .......................................................................................................... 1312
HARMONICS ............................................................................................................... 1312
HAR_NEW ................................................................................................................... 1314
HAR_PURG .................................................................................................................. 1315
HAR_READ .................................................................................................................. 1316
HAR_READX ................................................................................................................ 1317
HAR_WRITE ................................................................................................................. 1318
HAR_WRITEX ............................................................................................................... 1319
Harmonics Data .................................................................................................................. 1322
HAR_2TDC .................................................................................................................. 1322

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xvii
 HAR_2TDC_CHNG ........................................................................................................ 1323
HAR_2TDC_PURG ........................................................................................................ 1324
HAR_BRN .................................................................................................................... 1325
HAR_BRN_CHNG ......................................................................................................... 1326
HAR_BRN_PURG .......................................................................................................... 1327
HAR_CURSRC .............................................................................................................. 1328
HAR_CURSRC_CHNG .................................................................................................... 1329
HAR_CURSRC_CHNG_NAME ......................................................................................... 1330
HAR_CURSRC_CHNG_ONEPT ........................................................................................ 1331
HAR_CURSRC_NAME .................................................................................................... 1332
HAR_CURSRC_ONEPT ................................................................................................... 1333
HAR_CURSRC_PURG ..................................................................................................... 1334
HAR_CURSRC_PURG_ONEPT ......................................................................................... 1335
HAR_FACTS ................................................................................................................. 1336
HAR_FACTS_CHNG ...................................................................................................... 1337
HAR_FACTS_PURG ....................................................................................................... 1338
HAR_IMPCHAR ............................................................................................................ 1339
HAR_IMPCHAR_CHNG .................................................................................................. 1340
HAR_IMPCHAR_CHNG_NAME ....................................................................................... 1341
HAR_IMPCHAR_CHNG_ONEPT ...................................................................................... 1342
HAR_IMPCHAR_NAME .................................................................................................. 1343
HAR_IMPCHAR_ONEPT ................................................................................................. 1344
HAR_IMPCHAR_PURG ................................................................................................... 1345
HAR_IMPCHAR_PURG_ONEPT ....................................................................................... 1346
HAR_INDMC ................................................................................................................ 1347
HAR_INDMC_CHNG ..................................................................................................... 1348
HAR_INDMC_PURG ...................................................................................................... 1349
HAR_LOAD .................................................................................................................. 1350
HAR_LOAD_CHNG ....................................................................................................... 1351
HAR_LOAD_PURG ........................................................................................................ 1352
HAR_MACH ................................................................................................................. 1353
HAR_MACH_CHNG ...................................................................................................... 1354
HAR_MACH_PURG ....................................................................................................... 1355
HAR_MTDC ................................................................................................................. 1356
HAR_MTDC_CHNG ....................................................................................................... 1357
HAR_MTDC_PURG ....................................................................................................... 1358
HAR_TRN .................................................................................................................... 1359
HAR_TRN_CHNG .......................................................................................................... 1360
HAR_TRN_PURG .......................................................................................................... 1361
HAR_VLTSRC ............................................................................................................... 1362
HAR_VLTSRC_CHNG ..................................................................................................... 1363
HAR_VLTSRC_CHNG_NAME .......................................................................................... 1364
HAR_VLTSRC_CHNG_ONEPT ......................................................................................... 1365
HAR_VLTSRC_NAME ..................................................................................................... 1366
HAR_VLTSRC_ONEPT .................................................................................................... 1367
HAR_VLTSRC_PURG ...................................................................................................... 1368
HAR_VLTSRC_PURG_ONEPT .......................................................................................... 1369
HAR_VSCDC ................................................................................................................ 1370
HAR_VSCDC_CHNG ...................................................................................................... 1371
HAR_VSCDC_PURG ...................................................................................................... 1372
GIC ............................................................................................................................................ 1375

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xviii
 GIC Operation ..................................................................................................................... 1376
GIC ............................................................................................................................ 1376
GIC_2 ......................................................................................................................... 1379
GIC_3 ......................................................................................................................... 1385
GIC_4 ......................................................................................................................... 1391
GIC_5 ......................................................................................................................... 1398
GIC_6 ......................................................................................................................... 1405
GIC_7 ......................................................................................................................... 1414
GIC_8 ......................................................................................................................... 1423
GIC_BRANCH_EFIELD_NN ............................................................................................. 1434
GIC_EARTH1D_USR_PURG ............................................................................................ 1436
GIC_EFIELD_WAVESHAPE ............................................................................................. 1437
GIC_EFIELD_WAVESHAPE_REF ...................................................................................... 1438
GIC_EFIELD_WAVESHAPE_SUPP .................................................................................... 1439
GIC_MVARLOSS_SCALING_FACTORS .............................................................................. 1440
GIC_NEW .................................................................................................................... 1441
GIC_PF_OPTIONS ......................................................................................................... 1442
GIC_PURG ................................................................................................................... 1444
GIC_READ ................................................................................................................... 1445
GIC_READ_EFIELD_GRID ............................................................................................... 1446
GIC_THERMAL_IMPACT ................................................................................................ 1447
GIC_THERMAL_IMPACT_1 ............................................................................................. 1448
GIC_WRITE .................................................................................................................. 1449
GIC_WRITE_STN .......................................................................................................... 1450
GIC Data ............................................................................................................................ 1453
GIC_2TDC ................................................................................................................... 1453
GIC_2TDC_CHNG ......................................................................................................... 1454
GIC_2TDC_PURG ......................................................................................................... 1455
GIC_BRN ..................................................................................................................... 1456
GIC_BRN_CHNG .......................................................................................................... 1458
GIC_BRN_PURG ........................................................................................................... 1460
GIC_EARTH1D_USR ...................................................................................................... 1461
GIC_EARTH1D_USR_CHNG ........................................................................................... 1462
GIC_FACTS .................................................................................................................. 1463
GIC_FACTS_CHNG ....................................................................................................... 1464
GIC_FACTS_PURG ........................................................................................................ 1465
GIC_FXSH ................................................................................................................... 1466
GIC_FXSH_CHNG ......................................................................................................... 1467
GIC_FXSH_PURG ......................................................................................................... 1468
GIC_LOAD ................................................................................................................... 1469
GIC_LOAD_CHNG ........................................................................................................ 1470
GIC_LOAD_PURG ......................................................................................................... 1471
GIC_MTDC .................................................................................................................. 1472
GIC_MTDC_CHNG ........................................................................................................ 1473
GIC_MTDC_PURG ......................................................................................................... 1474
GIC_SUBSTN ............................................................................................................... 1475
GIC_SUBSTN_CHNG ..................................................................................................... 1476
GIC_SUBSTN_PURG ...................................................................................................... 1477
GIC_SWSH .................................................................................................................. 1478
GIC_SWSH_CHNG ........................................................................................................ 1479
GIC_SWSH_PURG ......................................................................................................... 1480

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xix
 GIC_TRN ..................................................................................................................... 1481
GIC_TRN_CHNG ........................................................................................................... 1484
GIC_TRN_PURG ........................................................................................................... 1487
GIC_VSCDC ................................................................................................................. 1488
GIC_VSCDC_CHNG ....................................................................................................... 1489
GIC_VSCDC_PURG ....................................................................................................... 1490
Dynamics Simulation ................................................................................................................... 1493
Dynamic Simulation Operation ............................................................................................ 1494
ADDMODELLIBRARY ..................................................................................................... 1494
ASTR .......................................................................................................................... 1495
AULIST ....................................................................................................................... 1498
CHANGE_CHANNEL_OUT_FILE ...................................................................................... 1499
CHANGE_CHRICN ........................................................................................................ 1500
CHANGE_CON ............................................................................................................. 1501
CHANGE_GREF ............................................................................................................ 1502
CHANGE_ICON ............................................................................................................ 1503
CHANGE_STATE ........................................................................................................... 1504
CHANGE_SWSREF ........................................................................................................ 1505
CHANGE_SWSREF_2 .................................................................................................... 1506
CHANGE_VAR .............................................................................................................. 1507
CHANGE_VREF ............................................................................................................ 1508
DCLIST ....................................................................................................................... 1509
DLST .......................................................................................................................... 1510
DOCU ......................................................................................................................... 1511
DROPMODELLIBRARY ................................................................................................... 1514
DROPMODELPROGRAM ................................................................................................ 1515
DYDA ......................................................................................................................... 1516
DYNAMICSMODE ......................................................................................................... 1519
DYNAMICS_SOLUTION_PARAMS ................................................................................... 1520
DYNAMICS_SOLUTION_PARAM_2 .................................................................................. 1522
DYNEXPORTCSV .......................................................................................................... 1524
DYRE_ADD .................................................................................................................. 1525
DYRE_NEW ................................................................................................................. 1526
ERUN ......................................................................................................................... 1527
ESTR_OPEN_CIRCUIT_TEST ........................................................................................... 1528
ESTR_RESPONSE_RATIO_TEST ....................................................................................... 1529
FCLIST ........................................................................................................................ 1531
GRUN ......................................................................................................................... 1532
GSTR .......................................................................................................................... 1533
INCREMENT_GREF ....................................................................................................... 1534
INCREMENT_SWSREF ................................................................................................... 1535
INCREMENT_SWSREF_2 ................................................................................................ 1536
INCREMENT_VREF ....................................................................................................... 1537
LDLIST ........................................................................................................................ 1538
LOAD_ARRAY_CHANNEL ............................................................................................... 1539
MLST ......................................................................................................................... 1540
MRUN ........................................................................................................................ 1542
MSTR ......................................................................................................................... 1543
POWERFLOWMODE ..................................................................................................... 1544
PSAS .......................................................................................................................... 1545
RLLIST ........................................................................................................................ 1546

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xx
 RSTR .......................................................................................................................... 1547
RUN ........................................................................................................................... 1548
RWDY ......................................................................................................................... 1549
SET_CHNFIL_TYPE ....................................................................................................... 1550
SET_DISABLE_RUN ....................................................................................................... 1551
SET_FREQ_RELAY_V_THRESH ........................................................................................ 1552
SET_GENANG .............................................................................................................. 1553
SET_GENANG_2 .......................................................................................................... 1554
SET_GENANG_3 .......................................................................................................... 1556
SET_GENANG_SUBSYS_FLAG ........................................................................................ 1558
SET_GENPWR .............................................................................................................. 1559
SET_GENSPDEV ........................................................................................................... 1560
SET_GENSPDEV_SUBSYS_FLAG ..................................................................................... 1561
SET_LOAD_MODEL_THRESH ......................................................................................... 1562
SET_MODEL_DEBUG_OUTPUT_FLAG ............................................................................. 1563
SET_NETFRQ ............................................................................................................... 1564
SET_NEXT_CHANNEL ................................................................................................... 1565
SET_NEXT_ICON .......................................................................................................... 1566
SET_NEXT_VAR ........................................................................................................... 1567
SET_OSSCAN .............................................................................................................. 1568
SET_OSSCAN_2 ........................................................................................................... 1569
SET_OSSCAN_SUBSYS_FLAG ........................................................................................ 1570
SET_RELANG ............................................................................................................... 1571
SET_RELSCN ............................................................................................................... 1573
SET_RELSCN_SUBSYS_FLAG ......................................................................................... 1574
SET_VLTSCN ................................................................................................................ 1575
SET_VLTSCN_SUBSYS_FLAG .......................................................................................... 1576
SET_VOLTAGE_DIP_CHECK ............................................................................................ 1577
SET_VOLTAGE_REC_CHECK ........................................................................................... 1578
SET_VOLT_VIOL_SUBSYS_FLAG ..................................................................................... 1580
SET_ZSORCE_RECONCILE_FLAG .................................................................................... 1581
SIZE_DS ...................................................................................................................... 1582
SNAP .......................................................................................................................... 1583
STRT .......................................................................................................................... 1584
STRT_2 ....................................................................................................................... 1585
SWSLIST ..................................................................................................................... 1586
TRIG_VOLT_VIOLATION_CHECK ..................................................................................... 1587
WNLIST ...................................................................................................................... 1588
Output Channel Operations ................................................................................................. 1591
Dynamic Simulation Output Channel Operation ............................................................ 1591
CHANGE_CHANNEL ............................................................................................. 1591
CHSB .................................................................................................................. 1592
CRT_PLOT_CHANNEL ........................................................................................... 1595
DELETE_ALL_PLOT_CHANNELS ............................................................................. 1596
DMPC ................................................................................................................. 1597
LIST_CHANNEL_MODELS ...................................................................................... 1599
REMOVE_UNUSED_CHAN_MODELS ....................................................................... 1600
Assign Machine Quantities to Output Channels ............................................................. 1602
MACHINE_APP_R_X_CHANNEL .............................................................................. 1602
MACHINE_ARRAY_CHANNEL ................................................................................. 1604
MACHINE_ITERM_CHANNEL ................................................................................. 1606

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxi
 Assign Branch Quantities to Output Channels ............................................................... 1609
BRANCH_APP_R_X_CHANNEL ............................................................................... 1609
BRANCH_MVA_CHANNEL ..................................................................................... 1611
BRANCH_P_AND_Q_CHANNEL .............................................................................. 1613
BRANCH_P_CHANNEL .......................................................................................... 1615
THREE_WND_APP_R_X_CHANNEL ......................................................................... 1617
THREE_WND_MVA_CHANNEL ............................................................................... 1619
THREE_WND_P_AND_Q_CHANNEL ........................................................................ 1621
THREE_WND_P_CHANNEL .................................................................................... 1623
Assign Other Quantities to Output Channels ................................................................. 1626
BUS_FREQUENCY_CHANNEL ................................................................................. 1626
STATE_CHANNEL ................................................................................................. 1627
VAR_CHANNEL .................................................................................................... 1628
VOLTAGE_AND_ANGLE_CHANNEL ......................................................................... 1629
VOLTAGE_CHANNEL ............................................................................................. 1631
Plant Related Models ........................................................................................................... 1634
ADD_PLANT_MODEL .................................................................................................... 1634
CHANGE_PLMOD_CHRICN ............................................................................................ 1636
CHANGE_PLMOD_CON ................................................................................................ 1637
CHANGE_PLMOD_DATA ............................................................................................... 1638
CHANGE_PLMOD_ICON ................................................................................................ 1640
CHANGE_PLMOD_VAR ................................................................................................. 1641
GMB_ADD_PLANT_MODEL ........................................................................................... 1642
PLMOD_CONSISTENCY ................................................................................................. 1644
PLMOD_PACK .............................................................................................................. 1645
PLMOD_REMOVE ......................................................................................................... 1646
PLMOD_STATUS .......................................................................................................... 1647
PLMOD_UNCONNECTED ............................................................................................... 1648
PLMOD_USER .............................................................................................................. 1649
Wind Related Models .......................................................................................................... 1651
ADD_WIND_MODEL ..................................................................................................... 1651
CHANGE_WNMOD_CHRICN .......................................................................................... 1653
CHANGE_WNMOD_CON ............................................................................................... 1654
CHANGE_WNMOD_ICON .............................................................................................. 1655
CHANGE_WNMOD_VAR ............................................................................................... 1656
WNMOD_CONSISTENCY ............................................................................................... 1657
WNMOD_PACK ............................................................................................................ 1658
WNMOD_REMOVE ....................................................................................................... 1659
WNMOD_STATUS ......................................................................................................... 1660
WNMOD_UNCONNECTED ............................................................................................. 1661
WNMOD_USER ............................................................................................................ 1662
Load Related Models ........................................................................................................... 1664
ADD_LOAD_MODEL ..................................................................................................... 1664
CHANGE_LDMOD_CHRICN ........................................................................................... 1666
CHANGE_LDMOD_CON ................................................................................................ 1667
CHANGE_LDMOD_DATA ............................................................................................... 1668
CHANGE_LDMOD_ICON ............................................................................................... 1670
CHANGE_LDMOD_VAR ................................................................................................. 1671
LDMOD_PACK ............................................................................................................. 1672
LDMOD_REMOVE ........................................................................................................ 1673
LDMOD_STATUS .......................................................................................................... 1674

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxii
 LDMOD_STATUS2 ........................................................................................................ 1675
LDMOD_UNCONNECTED .............................................................................................. 1676
LDMOD_USER ............................................................................................................. 1677
Line Relay Models ............................................................................................................... 1679
ADD_RELAY_MODEL .................................................................................................... 1679
CHANGE_RLMOD_CHRICN ............................................................................................ 1681
CHANGE_RLMOD_CON ................................................................................................ 1682
CHANGE_RLMOD_DATA ............................................................................................... 1683
CHANGE_RLMOD_ICON ............................................................................................... 1685
CHANGE_RLMOD_VAR ................................................................................................. 1686
RLMOD_PACK .............................................................................................................. 1687
RLMOD_REMOVE ......................................................................................................... 1688
RLMOD_STATUS .......................................................................................................... 1689
RLMOD_UNCONNECTED .............................................................................................. 1690
RLMOD_USER .............................................................................................................. 1691
DC Line Related Models ....................................................................................................... 1693
ADD_MTDCLINE_MODEL .............................................................................................. 1693
ADD_TTDCLINE_MODEL ............................................................................................... 1695
ADD_VSDCLINE_MODEL ............................................................................................... 1697
CHANGE_MTDCLMOD_CHRICN ..................................................................................... 1698
CHANGE_MTDCLMOD_CON ......................................................................................... 1699
CHANGE_MTDCLMOD_DATA ......................................................................................... 1700
CHANGE_MTDCLMOD_ICON ......................................................................................... 1702
CHANGE_MTDCLMOD_VAR .......................................................................................... 1703
CHANGE_TTDCLMOD_CHRICN ...................................................................................... 1704
CHANGE_TTDCLMOD_CON .......................................................................................... 1705
CHANGE_TTDCLMOD_DATA ......................................................................................... 1706
CHANGE_TTDCLMOD_ICON .......................................................................................... 1708
CHANGE_TTDCLMOD_VAR ........................................................................................... 1709
CHANGE_VSDCLMOD_CHRICN ...................................................................................... 1710
CHANGE_VSDCLMOD_CON .......................................................................................... 1711
CHANGE_VSDCLMOD_DATA ......................................................................................... 1712
CHANGE_VSDCLMOD_ICON ......................................................................................... 1714
CHANGE_VSDCLMOD_VAR ........................................................................................... 1715
DCLMOD_PACK ........................................................................................................... 1716
DCLMOD_UNCONNECTED ............................................................................................ 1717
DCLMOD_USER ........................................................................................................... 1718
MTDCLMOD_REMOVE .................................................................................................. 1719
MTDCLMOD_STATUS ................................................................................................... 1720
TTDCLMOD_REMOVE ................................................................................................... 1721
TTDCLMOD_STATUS .................................................................................................... 1722
VSDCLMOD_REMOVE ................................................................................................... 1723
VSDCLMOD_STATUS .................................................................................................... 1724
FACTS Device Models .......................................................................................................... 1726
ADD_FACTS_DEVICE_MODEL ........................................................................................ 1726
CHANGE_FCTMOD_CHRICN .......................................................................................... 1728
CHANGE_FCTMOD_CON .............................................................................................. 1729
CHANGE_FCTMOD_DATA ............................................................................................. 1730
CHANGE_FCTMOD_ICON .............................................................................................. 1732
CHANGE_FCTMOD_VAR ............................................................................................... 1733
FCTMOD_PACK ............................................................................................................ 1734

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxiii
 FCTMOD_REMOVE ....................................................................................................... 1735
FCTMOD_STATUS ........................................................................................................ 1736
FCTMOD_UNCONNECTED ............................................................................................ 1737
FCTMOD_USER ............................................................................................................ 1738
GMB_ADD_FACTS_DEV_MODEL .................................................................................... 1739
Switched Shunt Models ....................................................................................................... 1742
ADD_SWSHUNT_MODEL .............................................................................................. 1742
ADD_SWSHUNT_MODEL_2 ........................................................................................... 1744
CHANGE_SWSMOD_CHRICN ......................................................................................... 1746
CHANGE_SWSMOD_CHRICN_2 ..................................................................................... 1747
CHANGE_SWSMOD_CON ............................................................................................. 1748
CHANGE_SWSMOD_CON_2 .......................................................................................... 1749
CHANGE_SWSMOD_ICON ............................................................................................. 1750
CHANGE_SWSMOD_ICON_2 ......................................................................................... 1751
CHANGE_SWSMOD_VAR .............................................................................................. 1752
CHANGE_SWSMOD_VAR_2 ........................................................................................... 1753
GMB_ADD_SWSHUNT_MODEL ...................................................................................... 1754
GMB_ADD_SWSHUNT_MODEL_2 .................................................................................. 1756
SWSMOD_PACK ........................................................................................................... 1758
SWSMOD_REMOVE ...................................................................................................... 1759
SWSMOD_REMOVE_2 .................................................................................................. 1760
SWSMOD_STATUS ....................................................................................................... 1761
SWSMOD_STATUS_2 .................................................................................................... 1762
SWSMOD_UNCONNECTED ............................................................................................ 1763
SWSMOD_USER ........................................................................................................... 1764
Induction Machine Models .................................................................................................. 1766
ADD_INDMAC_MODEL ................................................................................................. 1766
CHANGE_IMMOD_CHRICN ............................................................................................ 1768
CHANGE_IMMOD_CON ................................................................................................ 1769
CHANGE_IMMOD_ICON ............................................................................................... 1770
CHANGE_IMMOD_VAR ................................................................................................. 1771
IMMOD_PACK ............................................................................................................. 1772
IMMOD_REMOVE ........................................................................................................ 1773
IMMOD_STATUS .......................................................................................................... 1774
IMMOD_UNCONNECTED .............................................................................................. 1775
IMMOD_USER ............................................................................................................. 1776
CCT Models ........................................................................................................................ 1778
ADD_CCT2DCO_MODEL ............................................................................................... 1778
ADD_CCT2WTD_MODEL ............................................................................................... 1780
ADD_CCT3WTD_MODEL ............................................................................................... 1782
ADD_CCTBRND_MODEL ............................................................................................... 1784
ADD_CCTBRNO_MODEL ............................................................................................... 1786
ADD_CCTBUSO_MODEL ............................................................................................... 1788
ADD_CCTMCNO_MODEL .............................................................................................. 1789
ADD_CCTMCNP_MODEL ............................................................................................... 1791
ADD_CCTMSCO_MODEL ............................................................................................... 1793
ADD_CCTSWSO_MODEL ............................................................................................... 1794
ADD_CCTSWSO_MODEL_2 ........................................................................................... 1796
CCT2DCOMOD_REMOVE .............................................................................................. 1798
CCT2DCOMOD_STATUS ................................................................................................ 1799
CCT2DCO_LIST ............................................................................................................ 1800

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxiv
 CCT2WTDMOD_REMOVE .............................................................................................. 1801
CCT2WTDMOD_STATUS ............................................................................................... 1802
CCT2WTD_LIST ............................................................................................................ 1803
CCT3WTDMOD_REMOVE .............................................................................................. 1804
CCT3WTDMOD_STATUS ............................................................................................... 1805
CCT3WTD_LIST ............................................................................................................ 1806
CCTBRNDMOD_REMOVE .............................................................................................. 1807
CCTBRNDMOD_STATUS ................................................................................................ 1808
CCTBRND_LIST ............................................................................................................ 1809
CCTBRNOMOD_REMOVE .............................................................................................. 1810
CCTBRNOMOD_STATUS ................................................................................................ 1811
CCTBRNO_LIST ............................................................................................................ 1812
CCTBUSOMOD_REMOVE .............................................................................................. 1813
CCTBUSOMOD_STATUS ................................................................................................ 1814
CCTBUSO_LIST ............................................................................................................ 1815
CCTMCNOMOD_REMOVE ............................................................................................. 1816
CCTMCNOMOD_STATUS ............................................................................................... 1817
CCTMCNO_LIST ........................................................................................................... 1818
CCTMCNPMOD_REMOVE .............................................................................................. 1819
CCTMCNPMOD_STATUS ............................................................................................... 1820
CCTMCNP_LIST ............................................................................................................ 1821
CCTMOD_PACK ........................................................................................................... 1822
CCTMOD_USER ........................................................................................................... 1823
CCTMSCOMOD_REMOVE .............................................................................................. 1824
CCTMSCOMOD_STATUS ............................................................................................... 1825
CCTMSCO_LIST ............................................................................................................ 1826
CCTSWSOMOD_REMOVE .............................................................................................. 1827
CCTSWSOMOD_REMOVE_2 .......................................................................................... 1828
CCTSWSOMOD_STATUS ............................................................................................... 1829
CCTSWSOMOD_STATUS_2 ............................................................................................ 1830
CCTSWSO_LIST ............................................................................................................ 1831
CHANGE_CCT2DCOMOD_CHRICN ................................................................................. 1832
CHANGE_CCT2DCOMOD_CON ...................................................................................... 1833
CHANGE_CCT2DCOMOD_ICON ..................................................................................... 1834
CHANGE_CCT2DCOMOD_VAR ....................................................................................... 1835
CHANGE_CCT2WTDMOD_CHRICN ................................................................................. 1836
CHANGE_CCT2WTDMOD_CON ..................................................................................... 1837
CHANGE_CCT2WTDMOD_ICON ..................................................................................... 1838
CHANGE_CCT2WTDMOD_VAR ...................................................................................... 1839
CHANGE_CCT3WTDMOD_CHRICN ................................................................................. 1840
CHANGE_CCT3WTDMOD_CON ..................................................................................... 1841
CHANGE_CCT3WTDMOD_ICON ..................................................................................... 1842
CHANGE_CCT3WTDMOD_VAR ...................................................................................... 1843
CHANGE_CCTBRNDMOD_CHRICN .................................................................................. 1844
CHANGE_CCTBRNDMOD_CON ...................................................................................... 1845
CHANGE_CCTBRNDMOD_ICON ..................................................................................... 1846
CHANGE_CCTBRNDMOD_VAR ....................................................................................... 1847
CHANGE_CCTBRNOMOD_CHRICN ................................................................................. 1848
CHANGE_CCTBRNOMOD_CON ...................................................................................... 1849
CHANGE_CCTBRNOMOD_ICON ..................................................................................... 1850
CHANGE_CCTBRNOMOD_VAR ....................................................................................... 1851

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxv
 CHANGE_CCTBUSOMOD_CHRICN ................................................................................. 1852
CHANGE_CCTBUSOMOD_CON ...................................................................................... 1853
CHANGE_CCTBUSOMOD_ICON ..................................................................................... 1854
CHANGE_CCTBUSOMOD_VAR ....................................................................................... 1855
CHANGE_CCTMCNOMOD_CHRICN ................................................................................ 1856
CHANGE_CCTMCNOMOD_CON ..................................................................................... 1857
CHANGE_CCTMCNOMOD_ICON .................................................................................... 1858
CHANGE_CCTMCNOMOD_VAR ..................................................................................... 1859
CHANGE_CCTMCNPMOD_CHRICN ................................................................................. 1860
CHANGE_CCTMCNPMOD_CON ..................................................................................... 1861
CHANGE_CCTMCNPMOD_ICON ..................................................................................... 1862
CHANGE_CCTMCNPMOD_VAR ...................................................................................... 1863
CHANGE_CCTMSCOMOD_CHRICN ................................................................................. 1864
CHANGE_CCTMSCOMOD_CON ..................................................................................... 1865
CHANGE_CCTMSCOMOD_ICON ..................................................................................... 1866
CHANGE_CCTMSCOMOD_VAR ...................................................................................... 1867
CHANGE_CCTSWSOMOD_CHRICN ................................................................................. 1868
CHANGE_CCTSWSOMOD_CHRICN_2 ............................................................................. 1869
CHANGE_CCTSWSOMOD_CON ..................................................................................... 1870
CHANGE_CCTSWSOMOD_CON_2 .................................................................................. 1871
CHANGE_CCTSWSOMOD_ICON ..................................................................................... 1872
CHANGE_CCTSWSOMOD_ICON_2 ................................................................................. 1873
CHANGE_CCTSWSOMOD_VAR ...................................................................................... 1874
CHANGE_CCTSWSOMOD_VAR_2 ................................................................................... 1875
Auxiliary Signal Models ....................................................................................................... 1877
ADD_FCTSAUXSIGNAL_MODEL ..................................................................................... 1877
ADD_MTDCAUXSIGNAL_MODEL ................................................................................... 1879
ADD_TTDCAUXSIGNAL_MODEL .................................................................................... 1881
ADD_VSDCAUXSIGNAL_MODEL .................................................................................... 1883
AUXMOD_PACK ........................................................................................................... 1885
AUXMOD_UNCONNECTED ............................................................................................ 1886
AUXMOD_USER ........................................................................................................... 1887
CHANGE_FCTSAUXMOD_CHRICN .................................................................................. 1888
CHANGE_FCTSAUXMOD_CON ...................................................................................... 1890
CHANGE_FCTSAUXMOD_DATA ..................................................................................... 1892
CHANGE_FCTSAUXMOD_ICON ...................................................................................... 1894
CHANGE_FCTSAUXMOD_VAR ....................................................................................... 1896
CHANGE_MTDCAUXMOD_CHRICN ................................................................................ 1898
CHANGE_MTDCAUXMOD_CON ..................................................................................... 1900
CHANGE_MTDCAUXMOD_DATA .................................................................................... 1902
CHANGE_MTDCAUXMOD_ICON .................................................................................... 1904
CHANGE_MTDCAUXMOD_VAR ...................................................................................... 1906
CHANGE_TTDCAUXMOD_CHRICN ................................................................................. 1908
CHANGE_TTDCAUXMOD_CON ...................................................................................... 1910
CHANGE_TTDCAUXMOD_DATA ..................................................................................... 1912
CHANGE_TTDCAUXMOD_ICON ..................................................................................... 1914
CHANGE_TTDCAUXMOD_VAR ...................................................................................... 1916
CHANGE_VSDCAUXMOD_CHRICN ................................................................................. 1918
CHANGE_VSDCAUXMOD_CON ...................................................................................... 1919
CHANGE_VSDCAUXMOD_DATA ..................................................................................... 1920
CHANGE_VSDCAUXMOD_ICON ..................................................................................... 1922

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxvi
 CHANGE_VSDCAUXMOD_VAR ...................................................................................... 1923
FCTSAUXMOD_REMOVE ............................................................................................... 1924
FCTSAUXMOD_STATUS ................................................................................................ 1925
MTDCAUXMOD_REMOVE ............................................................................................. 1926
MTDCAUXMOD_STATUS ............................................................................................... 1927
TTDCAUXMOD_REMOVE .............................................................................................. 1928
TTDCAUXMOD_STATUS ................................................................................................ 1929
VSDCAUXMOD_REMOVE .............................................................................................. 1930
VSDCAUXMOD_STATUS ................................................................................................ 1931
Set Disturbance .................................................................................................................. 1933
DIST_3PHASE_BUS_FAULT ............................................................................................ 1933
DIST_3WIND_CLOSE .................................................................................................... 1935
DIST_3WIND_FAULT ..................................................................................................... 1936
DIST_3WIND_TRIP ........................................................................................................ 1938
DIST_BRANCH_CLOSE .................................................................................................. 1939
DIST_BRANCH_FAULT ................................................................................................... 1940
DIST_BRANCH_TRIP ..................................................................................................... 1942
DIST_BUS_FAULT ......................................................................................................... 1943
DIST_BUS_FAULT_2 ..................................................................................................... 1944
DIST_BUS_FAULT_3 ..................................................................................................... 1946
DIST_BUS_TRIP ............................................................................................................ 1948
DIST_CLEAR_FAULT ...................................................................................................... 1949
DIST_MACHINE_TRIP .................................................................................................... 1951
DIST_SCMU_FAULT ...................................................................................................... 1952
DIST_SCMU_FAULT_2 ................................................................................................... 1954
DIST_SCMU_FAULT_3 ................................................................................................... 1956
DIST_SPCB_FAULT ........................................................................................................ 1958
DIST_SPCB_FAULT_2 .................................................................................................... 1960
Subsystem Definition .................................................................................................................. 1963
Area Subsystems ................................................................................................................. 1964
ASYS .......................................................................................................................... 1964
ASYSDEF .................................................................................................................... 1965
ASYSINIT .................................................................................................................... 1966
Bus Subsystems .................................................................................................................. 1968
BSYS .......................................................................................................................... 1968
BSYSADD .................................................................................................................... 1970
BSYSDEF ..................................................................................................................... 1972
BSYSDELO .................................................................................................................. 1973
BSYSINIT ..................................................................................................................... 1974
BSYSMEM ................................................................................................................... 1975
BSYSO ........................................................................................................................ 1976
BSYSRCL ..................................................................................................................... 1977
Owner Subsystems ............................................................................................................. 1979
OSYS .......................................................................................................................... 1979
OSYSDEF .................................................................................................................... 1980
OSYSINIT .................................................................................................................... 1981
Zone Subsystems ................................................................................................................ 1983
ZSYS .......................................................................................................................... 1983
ZSYSDEF ..................................................................................................................... 1984
ZSYSINIT ..................................................................................................................... 1985
Diagram View ............................................................................................................................. 1987

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxvii
 CHANGEDIAGCONTOUR ....................................................................................................... 1988
CHECKDIAGFILE ................................................................................................................... 1990
CLOSEDIAGFILE ................................................................................................................... 1991
DELETEDIAGCONTOUR ......................................................................................................... 1992
ENABLEDIAGCONTOUR ........................................................................................................ 1993
EXPORTBUSLOCFILE ............................................................................................................. 1995
EXPORTBUSLOCFILE_2 ......................................................................................................... 1996
EXPORTIMAGEFILE ............................................................................................................... 1997
EXPORTIMAGEFILE_2 ........................................................................................................... 1998
GEXMBUS ........................................................................................................................... 1999
GROWBUS .......................................................................................................................... 2000
GROWBUSLEVELS ................................................................................................................ 2001
GROWDIAGRAM .................................................................................................................. 2002
GROWDIAGRAM_2 ............................................................................................................... 2003
GROWSTATION .................................................................................................................... 2005
GRPG ................................................................................................................................. 2006
IMPORTDRAWFILE ............................................................................................................... 2007
IMPORTIMAGEFILE ............................................................................................................... 2008
NEWDIAGFILE ..................................................................................................................... 2009
NEXTDIAGFILEDATASET ........................................................................................................ 2010
OPENACCFILE ...................................................................................................................... 2011
OPENACCFILE_2 .................................................................................................................. 2012
OPENBUSLOCFILE ................................................................................................................ 2013
OPENDIAGFILE .................................................................................................................... 2014
PREVDIAGFILEDATASET ........................................................................................................ 2015
PRINTDIAGFILE .................................................................................................................... 2016
PRINTDIAGFILE_2 ................................................................................................................ 2017
REFRESHDIAGCONTOUR ....................................................................................................... 2018
REFRESHDIAGFILE ................................................................................................................ 2019
RENUMDIAGFILE ................................................................................................................. 2020
SAVEDIAGFILE ..................................................................................................................... 2021
SETDIAGAUTOFILE ............................................................................................................... 2022
SETDIAGFONT ..................................................................................................................... 2023
SETDIAGPREC ...................................................................................................................... 2024
SETDIAGPREC_2 .................................................................................................................. 2025
SETDIAGPROP ..................................................................................................................... 2026
SETDIAGPROP_2 .................................................................................................................. 2029
SETDIAGPROP_3 .................................................................................................................. 2032
SETDIAGPROP_4 .................................................................................................................. 2035
SETDIAGPROP_5 .................................................................................................................. 2038
SETDIAGRESACCC ................................................................................................................ 2041
SETDIAGRESACCC_2 ............................................................................................................ 2042
SETDIAGRESACCC_3 ............................................................................................................ 2043
SETDIAGRESASCC ................................................................................................................ 2044
SETDIAGRESASCC_2 ............................................................................................................ 2046
SETDIAGRESASCC_3 ............................................................................................................ 2048
SETDIAGRESDATA ................................................................................................................ 2050
SETDIAGRESDATA_2 ............................................................................................................. 2053
SETDIAGRESDATA_3 ............................................................................................................. 2054
SETDIAGRESDYN ................................................................................................................. 2055
SETDIAGRESDYN_2 .............................................................................................................. 2056

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxviii
 SETDIAGRESGDIF ................................................................................................................. 2057
SETDIAGRESIEC ................................................................................................................... 2060
SETDIAGRESIEC_2 ................................................................................................................ 2062
SETDIAGRESIEC_3 ................................................................................................................ 2064
SETDIAGRESMUST ............................................................................................................... 2066
SETDIAGRESOPF .................................................................................................................. 2067
SETDIAGRESOPF_2 .............................................................................................................. 2068
SETDIAGRESOPF_3 .............................................................................................................. 2069
SETDIAGRESPFLOWCHECK .................................................................................................... 2070
SETDIAGRESPFLOWCHECK_2 ................................................................................................ 2074
SETDIAGRESPFLOWCHECK_3 ................................................................................................ 2077
SETDIAGRESPFLOWOPTIONS ................................................................................................. 2080
SETDIAGRESPFLOWOPTIONS_2 ............................................................................................. 2082
SETDIAGRESPFLOWOPTIONS_3 ............................................................................................. 2084
SETDIAGRESREL ................................................................................................................... 2086
SETDIAGRESREL_2 ............................................................................................................... 2088
SETDIAGRESREL_3 ............................................................................................................... 2090
SETDIAGRESSCGR ................................................................................................................ 2092
SETDIAGRESTYPEACC ........................................................................................................... 2095
SETDIAGRESTYPEASCC ......................................................................................................... 2096
SETDIAGRESTYPEDATA ......................................................................................................... 2097
SETDIAGRESTYPEDYN .......................................................................................................... 2098
SETDIAGRESTYPEGDIF .......................................................................................................... 2099
SETDIAGRESTYPEGIC ............................................................................................................ 2100
SETDIAGRESTYPEHARM ........................................................................................................ 2101
SETDIAGRESTYPEIEC ............................................................................................................ 2102
SETDIAGRESTYPEMUST ........................................................................................................ 2103
SETDIAGRESTYPEOPF ........................................................................................................... 2104
SETDIAGRESTYPEPFLOW ....................................................................................................... 2105
SETDIAGRESTYPEREL ........................................................................................................... 2106
SETDIAGRESTYPESCGR ......................................................................................................... 2107
SETDIAGRESVRCS ................................................................................................................ 2108
SETDIAGRESVRCS_2 ............................................................................................................. 2111
SETDIAGTITLE ..................................................................................................................... 2114
SWITCHDIAGFILEDATASET .................................................................................................... 2115
UPDATEBUSLOCDIAGFILE ..................................................................................................... 2116
Single Element Data ................................................................................................................... 2117
APIERRSTR .......................................................................................................................... 2118
ARDAT ................................................................................................................................ 2119
AREDAT .............................................................................................................................. 2121
AREINT ............................................................................................................................... 2122
ARENAM ............................................................................................................................. 2123
ARENUM ............................................................................................................................ 2124
AREUSE .............................................................................................................................. 2125
ARITOJ ............................................................................................................................... 2126
BRNCUR .............................................................................................................................. 2127
BRNDAT .............................................................................................................................. 2128
BRNDT2 .............................................................................................................................. 2130
BRNFLO .............................................................................................................................. 2132
BRNINT ............................................................................................................................... 2133
BRNMSC ............................................................................................................................. 2135

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxix
 BRNMVA ............................................................................................................................. 2137
BRNNAM ............................................................................................................................ 2138
BRNSTT .............................................................................................................................. 2139
BSYSISDEF .......................................................................................................................... 2140
BUSDAT .............................................................................................................................. 2141
BUSDT1 .............................................................................................................................. 2142
BUSDT2 .............................................................................................................................. 2144
BUSEXS .............................................................................................................................. 2146
BUSINT ............................................................................................................................... 2147
BUSMSM ............................................................................................................................ 2148
BUSORDPOS ....................................................................................................................... 2149
BUSSECTDAT ....................................................................................................................... 2150
BUSSECTDT1 ....................................................................................................................... 2151
BUSSECTDT2 ....................................................................................................................... 2153
BUSSECTEXS ....................................................................................................................... 2155
BUSSECTINT ........................................................................................................................ 2156
CCTMDLNAM_2DCO ............................................................................................................ 2157
CCTMDLNAM_2WTD ............................................................................................................ 2158
CCTMDLNAM_3WTD ............................................................................................................ 2159
CCTMDLNAM_BRND ............................................................................................................ 2160
CCTMDLNAM_BRNO ............................................................................................................ 2161
CCTMDLNAM_BUSO ............................................................................................................ 2162
CCTMDLNAM_MCNO ........................................................................................................... 2163
CCTMDLNAM_MCNP ............................................................................................................ 2164
CCTMDLNAM_MSCO ............................................................................................................ 2165
CCTMDLNAM_SWSO_2 ........................................................................................................ 2166
CCTMIND_2DCO .................................................................................................................. 2167
CCTMIND_2WTD ................................................................................................................. 2168
CCTMIND_3WTD ................................................................................................................. 2170
CCTMIND_BRND .................................................................................................................. 2172
CCTMIND_BRNO .................................................................................................................. 2174
CCTMIND_BUSO .................................................................................................................. 2176
CCTMIND_MCNO ................................................................................................................. 2177
CCTMIND_MCNP ................................................................................................................. 2178
CCTMIND_MSCO ................................................................................................................. 2179
CCTMIND_SWSO ................................................................................................................. 2180
CCTMIND_SWSO_2 .............................................................................................................. 2182
CHKTRE .............................................................................................................................. 2184
CHNVAL ............................................................................................................................. 2185
DC2AUXMIND ..................................................................................................................... 2186
DC2AUXMNAM ................................................................................................................... 2188
DC2DAT .............................................................................................................................. 2189
DC2DAT_2 .......................................................................................................................... 2191
DC2INT ............................................................................................................................... 2193
DC2INT_2 ........................................................................................................................... 2194
DC2MIND ........................................................................................................................... 2195
DC2MNAM ......................................................................................................................... 2197
DCNAUXMIND ..................................................................................................................... 2198
DCNAUXMNAM ................................................................................................................... 2200
DCNCIN .............................................................................................................................. 2201
DCNCIN_2 .......................................................................................................................... 2202

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxx
 DCNDAT ............................................................................................................................. 2203
DCNDAT_2 .......................................................................................................................... 2205
DCNINT .............................................................................................................................. 2207
DCNINT_2 ........................................................................................................................... 2208
DCNMIND ........................................................................................................................... 2209
DCNMNAM ......................................................................................................................... 2211
DSCVAL .............................................................................................................................. 2212
DSIVAL ............................................................................................................................... 2213
DSRVAL .............................................................................................................................. 2214
FCDAUXMIND ..................................................................................................................... 2215
FCDAUXMNAM ................................................................................................................... 2217
FCDDAT .............................................................................................................................. 2218
FCDDAT_2 .......................................................................................................................... 2221
FCDINT ............................................................................................................................... 2224
FCDINT_2 ........................................................................................................................... 2225
FCDMIND ........................................................................................................................... 2226
FCDMNAM .......................................................................................................................... 2227
FXSDT1 .............................................................................................................................. 2228
FXSDT2 .............................................................................................................................. 2230
FXSINT ............................................................................................................................... 2232
GENCNV ............................................................................................................................. 2233
GENDAT ............................................................................................................................. 2234
GENDT1 ............................................................................................................................. 2235
GENSECTDAT ...................................................................................................................... 2236
GENSECTDT1 ...................................................................................................................... 2237
GETHOMEPATH ................................................................................................................... 2238
GET_MSTATE ....................................................................................................................... 2239
GNECHR ............................................................................................................................. 2240
GNEDAT ............................................................................................................................. 2241
GNEINT .............................................................................................................................. 2242
INDDT1 .............................................................................................................................. 2244
INDDT2 .............................................................................................................................. 2246
INDINT ............................................................................................................................... 2248
INI2DC ............................................................................................................................... 2250
INIBRN ............................................................................................................................... 2251
INIBRN_2 ............................................................................................................................ 2252
INIBRX ................................................................................................................................ 2253
INIBRX_2 ............................................................................................................................ 2254
INIBUS ................................................................................................................................ 2255
INIBUS_2 ............................................................................................................................ 2256
INIBUX ............................................................................................................................... 2257
INIFAX ................................................................................................................................ 2258
INIFXS ................................................................................................................................ 2259
INIIND ................................................................................................................................ 2260
INILOD ............................................................................................................................... 2261
INIMAC ............................................................................................................................... 2262
INIMDC .............................................................................................................................. 2263
INIMSL ............................................................................................................................... 2264
ININAM .............................................................................................................................. 2265
ININAM_2 ........................................................................................................................... 2266
ININAX ............................................................................................................................... 2267

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxi
 INISTABUSSECT ................................................................................................................... 2268
INISTANODE ........................................................................................................................ 2269
INISTASWDEV ...................................................................................................................... 2270
INISWS ............................................................................................................................... 2271
INITIE ................................................................................................................................. 2272
INITIX ................................................................................................................................. 2273
INIVSC ................................................................................................................................ 2274
ISLAND ............................................................................................................................... 2275
ITERAT ................................................................................................................................ 2276
LMODIND ........................................................................................................................... 2277
LMODNAM ......................................................................................................................... 2279
LODCNV ............................................................................................................................. 2280
LODDT1 .............................................................................................................................. 2281
LODDT2 .............................................................................................................................. 2283
LODIND .............................................................................................................................. 2285
LODINT .............................................................................................................................. 2286
LODTYPE ............................................................................................................................ 2287
MACCHR ............................................................................................................................. 2288
MACDAT ............................................................................................................................. 2289
MACDT2 ............................................................................................................................. 2291
MACIND ............................................................................................................................. 2293
MACINT .............................................................................................................................. 2294
MACSTT ............................................................................................................................. 2296
MAXMSM ........................................................................................................................... 2297
MDLIND .............................................................................................................................. 2298
MDLLIBCNT ......................................................................................................................... 2300
MDLNAM ............................................................................................................................ 2301
MDLPGMCNT ...................................................................................................................... 2302
NATONO ............................................................................................................................. 2303
NOTONA ............................................................................................................................ 2304
NOTONASECT ..................................................................................................................... 2305
NXT2DC ............................................................................................................................. 2306
NXTBRN ............................................................................................................................. 2307
NXTBRN3 ............................................................................................................................ 2308
NXTBRN3_2 ........................................................................................................................ 2309
NXTBRN_2 .......................................................................................................................... 2310
NXTBUS .............................................................................................................................. 2311
NXTBUS_2 .......................................................................................................................... 2312
NXTFAX .............................................................................................................................. 2313
NXTFXS .............................................................................................................................. 2314
NXTIND .............................................................................................................................. 2315
NXTLOD ............................................................................................................................. 2316
NXTMAC ............................................................................................................................. 2317
NXTMDC ............................................................................................................................ 2318
NXTMSL ............................................................................................................................. 2319
NXTSTABUSSECT ................................................................................................................. 2320
NXTSTANODE ..................................................................................................................... 2321
NXTSTASWDEV .................................................................................................................... 2322
NXTSWS ............................................................................................................................. 2323
NXTTIE ............................................................................................................................... 2324
NXTTIE3 ............................................................................................................................. 2325

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxii
 NXTVSC .............................................................................................................................. 2326
OKSTRT .............................................................................................................................. 2327
OPENUN ............................................................................................................................. 2328
ORDBUS ............................................................................................................................. 2329
ORDBUSSECT ...................................................................................................................... 2330
OWNDAT ............................................................................................................................ 2331
OWNNAM ........................................................................................................................... 2333
OWNNUM ........................................................................................................................... 2334
OWNUSE ............................................................................................................................ 2335
PRMDAT ............................................................................................................................. 2336
PRMINT .............................................................................................................................. 2338
RATCHR .............................................................................................................................. 2339
RMODIND ........................................................................................................................... 2340
RMODNAM ......................................................................................................................... 2342
SBSGTBKV .......................................................................................................................... 2343
SC3WND ............................................................................................................................. 2344
SCBRN2 .............................................................................................................................. 2346
SCBUS2 .............................................................................................................................. 2347
SCDONE ............................................................................................................................. 2349
SCINIT ................................................................................................................................ 2350
SCMAC2 ............................................................................................................................. 2351
SELCTR ............................................................................................................................... 2352
SETHOMEPATH .................................................................................................................... 2353
SFILES ................................................................................................................................ 2354
SLMODIND ......................................................................................................................... 2355
SLMODNAM ........................................................................................................................ 2357
SOLSTR .............................................................................................................................. 2358
SOLVED .............................................................................................................................. 2359
SOLVED_CA ........................................................................................................................ 2360
STADAT .............................................................................................................................. 2361
STAINT ............................................................................................................................... 2362
STANAME ........................................................................................................................... 2363
STANODEINT ....................................................................................................................... 2364
STANODENAME ................................................................................................................... 2365
STAREA ............................................................................................................................... 2366
STASWDEVDAT .................................................................................................................... 2367
STASWDEVINT ..................................................................................................................... 2369
STASWDEVNAME ................................................................................................................. 2370
STBSKV ............................................................................................................................... 2371
STZONE .............................................................................................................................. 2372
SWSBLK .............................................................................................................................. 2373
SWSBLK_2 .......................................................................................................................... 2374
SWSBLZ .............................................................................................................................. 2376
SWSBLZ2 ............................................................................................................................ 2377
SWSDAT ............................................................................................................................. 2378
SWSDAT_2 .......................................................................................................................... 2379
SWSDT1 ............................................................................................................................. 2380
SWSINT .............................................................................................................................. 2381
SWSINT_2 ........................................................................................................................... 2382
SWSMIND ........................................................................................................................... 2383
SWSMIND_2 ....................................................................................................................... 2385

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxiii
 SWSMNAM ......................................................................................................................... 2387
SWSMNAM_2 ...................................................................................................................... 2388
SYSMSM ............................................................................................................................. 2389
SYSMVA ............................................................................................................................. 2390
SYSTOT .............................................................................................................................. 2391
TITLDT ................................................................................................................................ 2392
TOTBUS .............................................................................................................................. 2393
TR3DAT .............................................................................................................................. 2394
TR3DT2 .............................................................................................................................. 2395
TR3INT ............................................................................................................................... 2397
TR3NAM ............................................................................................................................. 2399
TRNDAT .............................................................................................................................. 2400
TRXDAT .............................................................................................................................. 2401
VOLTAGEDROOPDATA .......................................................................................................... 2402
VOLTAGEDROOPINT ............................................................................................................. 2403
VSCAUXMIND ..................................................................................................................... 2404
VSCAUXMNAM ................................................................................................................... 2406
VSCCDT .............................................................................................................................. 2407
VSCCIN ............................................................................................................................... 2409
VSCINT ............................................................................................................................... 2410
VSCMIND ............................................................................................................................ 2411
VSCMNAM .......................................................................................................................... 2412
WINDMIND ......................................................................................................................... 2413
WINDMNAM ....................................................................................................................... 2415
WNDDAT ............................................................................................................................ 2416
WNDDT2 ............................................................................................................................ 2418
WNDINT ............................................................................................................................. 2420
XFRDAT .............................................................................................................................. 2422
XFRINT ............................................................................................................................... 2424
XFRNAM ............................................................................................................................. 2426
ZNDAT ................................................................................................................................ 2427
ZNITOJ ............................................................................................................................... 2429
ZONNAM ............................................................................................................................ 2430
ZONNUM ............................................................................................................................ 2431
ZONUSE ............................................................................................................................. 2432
Extension Data Access ................................................................................................................. 2433
GET_EXT_ACLINE_CHAR ....................................................................................................... 2434
GET_EXT_ACLINE_INT .......................................................................................................... 2435
GET_EXT_ACLINE_LOGICAL .................................................................................................. 2436
GET_EXT_ACLINE_REAL ........................................................................................................ 2437
GET_EXT_AREA_CHAR .......................................................................................................... 2438
GET_EXT_AREA_INT ............................................................................................................. 2439
GET_EXT_AREA_LOGICAL ..................................................................................................... 2440
GET_EXT_AREA_REAL .......................................................................................................... 2441
GET_EXT_BUS_CHAR ........................................................................................................... 2442
GET_EXT_BUS_INT ............................................................................................................... 2443
GET_EXT_BUS_LOGICAL ....................................................................................................... 2444
GET_EXT_BUS_REAL ............................................................................................................ 2445
GET_EXT_CHAR ................................................................................................................... 2446
GET_EXT_FACTS_CHAR ........................................................................................................ 2447
GET_EXT_FACTS_INT ........................................................................................................... 2448

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxiv
 GET_EXT_FACTS_LOGICAL .................................................................................................... 2449
GET_EXT_FACTS_REAL ......................................................................................................... 2450
GET_EXT_FIXSHUNT_CHAR .................................................................................................. 2451
GET_EXT_FIXSHUNT_INT ...................................................................................................... 2452
GET_EXT_FIXSHUNT_LOGICAL .............................................................................................. 2453
GET_EXT_FIXSHUNT_REAL ................................................................................................... 2454
GET_EXT_GENERATOR_CHAR ................................................................................................ 2455
GET_EXT_GENERATOR_INT ................................................................................................... 2456
GET_EXT_GENERATOR_LOGICAL ........................................................................................... 2457
GET_EXT_GENERATOR_REAL ................................................................................................. 2458
GET_EXT_GNE_CHAR ........................................................................................................... 2459
GET_EXT_GNE_INT .............................................................................................................. 2460
GET_EXT_GNE_LOGICAL ...................................................................................................... 2461
GET_EXT_GNE_REAL ............................................................................................................ 2462
GET_EXT_IATRANS_CHAR ..................................................................................................... 2463
GET_EXT_IATRANS_INT ........................................................................................................ 2464
GET_EXT_IATRANS_LOGICAL ................................................................................................ 2465
GET_EXT_IATRANS_REAL ...................................................................................................... 2466
GET_EXT_INDMACH_CHAR ................................................................................................... 2467
GET_EXT_INDMACH_INT ...................................................................................................... 2468
GET_EXT_INDMACH_LOGICAL .............................................................................................. 2469
GET_EXT_INDMACH_REAL .................................................................................................... 2470
GET_EXT_INT ...................................................................................................................... 2471
GET_EXT_LOAD_CHAR ......................................................................................................... 2472
GET_EXT_LOAD_INT ............................................................................................................ 2473
GET_EXT_LOAD_LOGICAL ..................................................................................................... 2474
GET_EXT_LOAD_REAL .......................................................................................................... 2475
GET_EXT_LOGICAL .............................................................................................................. 2476
GET_EXT_MSLINE_CHAR ...................................................................................................... 2477
GET_EXT_MSLINE_INT ......................................................................................................... 2478
GET_EXT_MSLINE_LOGICAL .................................................................................................. 2479
GET_EXT_MSLINE_REAL ....................................................................................................... 2480
GET_EXT_NTERMDC_CHAR ................................................................................................... 2481
GET_EXT_NTERMDC_INT ...................................................................................................... 2482
GET_EXT_NTERMDC_LOGICAL .............................................................................................. 2483
GET_EXT_NTERMDC_REAL .................................................................................................... 2484
GET_EXT_OWNER_CHAR ...................................................................................................... 2485
GET_EXT_OWNER_INT ......................................................................................................... 2486
GET_EXT_OWNER_LOGICAL .................................................................................................. 2487
GET_EXT_OWNER_REAL ....................................................................................................... 2488
GET_EXT_RATING_CHAR ....................................................................................................... 2489
GET_EXT_RATING_INT .......................................................................................................... 2490
GET_EXT_RATING_LOGICAL .................................................................................................. 2491
GET_EXT_RATING_REAL ....................................................................................................... 2492
GET_EXT_REAL .................................................................................................................... 2493
GET_EXT_ROWCOUNT .......................................................................................................... 2494
GET_EXT_SUBNODE_CHAR ................................................................................................... 2495
GET_EXT_SUBNODE_INT ...................................................................................................... 2496
GET_EXT_SUBNODE_LOGICAL .............................................................................................. 2497
GET_EXT_SUBNODE_REAL .................................................................................................... 2498
GET_EXT_SUBSWD_CHAR ..................................................................................................... 2499

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxv
 GET_EXT_SUBSWD_INT ........................................................................................................ 2500
GET_EXT_SUBSWD_LOGICAL ................................................................................................ 2501
GET_EXT_SUBSWD_REAL ...................................................................................................... 2502
GET_EXT_SUB_CHAR ........................................................................................................... 2503
GET_EXT_SUB_INT ............................................................................................................... 2504
GET_EXT_SUB_LOGICAL ....................................................................................................... 2505
GET_EXT_SUB_REAL ............................................................................................................ 2506
GET_EXT_SWSHUNT_CHAR ................................................................................................... 2507
GET_EXT_SWSHUNT_INT ...................................................................................................... 2508
GET_EXT_SWSHUNT_LOGICAL .............................................................................................. 2509
GET_EXT_SWSHUNT_REAL ................................................................................................... 2510
GET_EXT_SYSSWD_CHAR ..................................................................................................... 2511
GET_EXT_SYSSWD_INT ........................................................................................................ 2512
GET_EXT_SYSSWD_LOGICAL ................................................................................................. 2513
GET_EXT_SYSSWD_REAL ...................................................................................................... 2514
GET_EXT_TRANSFORMER_CHAR ........................................................................................... 2515
GET_EXT_TRANSFORMER_INT ............................................................................................... 2516
GET_EXT_TRANSFORMER_LOGICAL ....................................................................................... 2517
GET_EXT_TRANSFORMER_REAL ............................................................................................ 2518
GET_EXT_TWOTERMDC_CHAR .............................................................................................. 2519
GET_EXT_TWOTERMDC_INT ................................................................................................. 2520
GET_EXT_TWOTERMDC_LOGICAL .......................................................................................... 2521
GET_EXT_TWOTERMDC_REAL ............................................................................................... 2522
GET_EXT_VSCDC_CHAR ....................................................................................................... 2523
GET_EXT_VSCDC_INT ........................................................................................................... 2524
GET_EXT_VSCDC_LOGICAL ................................................................................................... 2525
GET_EXT_VSCDC_REAL ........................................................................................................ 2526
GET_EXT_ZONE_CHAR ......................................................................................................... 2527
GET_EXT_ZONE_INT ............................................................................................................ 2528
GET_EXT_ZONE_LOGICAL .................................................................................................... 2529
GET_EXT_ZONE_REAL .......................................................................................................... 2530
SET_EXT_ACLINE_CHAR ....................................................................................................... 2531
SET_EXT_ACLINE_INT .......................................................................................................... 2532
SET_EXT_ACLINE_LOGICAL ................................................................................................... 2533
SET_EXT_ACLINE_REAL ........................................................................................................ 2534
SET_EXT_AREA_CHAR .......................................................................................................... 2535
SET_EXT_AREA_INT ............................................................................................................. 2536
SET_EXT_AREA_LOGICAL ..................................................................................................... 2537
SET_EXT_AREA_REAL ........................................................................................................... 2538
SET_EXT_BUS_CHAR ............................................................................................................ 2539
SET_EXT_BUS_INT ............................................................................................................... 2540
SET_EXT_BUS_LOGICAL ....................................................................................................... 2541
SET_EXT_BUS_REAL ............................................................................................................. 2542
SET_EXT_CHAR ................................................................................................................... 2543
SET_EXT_FACTS_CHAR ......................................................................................................... 2544
SET_EXT_FACTS_INT ............................................................................................................ 2545
SET_EXT_FACTS_LOGICAL .................................................................................................... 2546
SET_EXT_FACTS_REAL .......................................................................................................... 2547
SET_EXT_FIXSHUNT_CHAR ................................................................................................... 2548
SET_EXT_FIXSHUNT_INT ...................................................................................................... 2549
SET_EXT_FIXSHUNT_LOGICAL .............................................................................................. 2550

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxvi
 SET_EXT_FIXSHUNT_REAL .................................................................................................... 2551
SET_EXT_GENERATOR_CHAR ................................................................................................ 2552
SET_EXT_GENERATOR_INT ................................................................................................... 2553
SET_EXT_GENERATOR_LOGICAL ............................................................................................ 2554
SET_EXT_GENERATOR_REAL ................................................................................................. 2555
SET_EXT_GNE_CHAR ........................................................................................................... 2556
SET_EXT_GNE_INT ............................................................................................................... 2557
SET_EXT_GNE_LOGICAL ....................................................................................................... 2558
SET_EXT_GNE_REAL ............................................................................................................ 2559
SET_EXT_IATRANS_CHAR ..................................................................................................... 2560
SET_EXT_IATRANS_INT ......................................................................................................... 2561
SET_EXT_IATRANS_LOGICAL ................................................................................................. 2562
SET_EXT_IATRANS_REAL ...................................................................................................... 2563
SET_EXT_INDMACH_CHAR ................................................................................................... 2564
SET_EXT_INDMACH_INT ....................................................................................................... 2565
SET_EXT_INDMACH_LOGICAL ............................................................................................... 2566
SET_EXT_INDMACH_REAL .................................................................................................... 2567
SET_EXT_INT ....................................................................................................................... 2568
SET_EXT_LOAD_CHAR .......................................................................................................... 2569
SET_EXT_LOAD_INT ............................................................................................................. 2570
SET_EXT_LOAD_LOGICAL ..................................................................................................... 2571
SET_EXT_LOAD_REAL ........................................................................................................... 2572
SET_EXT_LOGICAL ............................................................................................................... 2573
SET_EXT_MSLINE_CHAR ....................................................................................................... 2574
SET_EXT_MSLINE_INT .......................................................................................................... 2575
SET_EXT_MSLINE_LOGICAL .................................................................................................. 2576
SET_EXT_MSLINE_REAL ........................................................................................................ 2577
SET_EXT_NTERMDC_CHAR ................................................................................................... 2578
SET_EXT_NTERMDC_INT ...................................................................................................... 2579
SET_EXT_NTERMDC_LOGICAL ............................................................................................... 2580
SET_EXT_NTERMDC_REAL .................................................................................................... 2581
SET_EXT_OWNER_CHAR ....................................................................................................... 2582
SET_EXT_OWNER_INT .......................................................................................................... 2583
SET_EXT_OWNER_LOGICAL .................................................................................................. 2584
SET_EXT_OWNER_REAL ........................................................................................................ 2585
SET_EXT_RATING_CHAR ....................................................................................................... 2586
SET_EXT_RATING_INT .......................................................................................................... 2587
SET_EXT_RATING_LOGICAL .................................................................................................. 2588
SET_EXT_RATING_REAL ........................................................................................................ 2589
SET_EXT_REAL .................................................................................................................... 2590
SET_EXT_SUBNODE_CHAR ................................................................................................... 2591
SET_EXT_SUBNODE_INT ....................................................................................................... 2592
SET_EXT_SUBNODE_LOGICAL ............................................................................................... 2593
SET_EXT_SUBNODE_REAL .................................................................................................... 2594
SET_EXT_SUBSWD_CHAR ..................................................................................................... 2595
SET_EXT_SUBSWD_INT ........................................................................................................ 2596
SET_EXT_SUBSWD_LOGICAL ................................................................................................. 2597
SET_EXT_SUBSWD_REAL ...................................................................................................... 2598
SET_EXT_SUB_CHAR ............................................................................................................ 2599
SET_EXT_SUB_INT ............................................................................................................... 2600
SET_EXT_SUB_LOGICAL ....................................................................................................... 2601

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxvii
 SET_EXT_SUB_REAL ............................................................................................................. 2602
SET_EXT_SWSHUNT_CHAR ................................................................................................... 2603
SET_EXT_SWSHUNT_INT ...................................................................................................... 2604
SET_EXT_SWSHUNT_LOGICAL .............................................................................................. 2605
SET_EXT_SWSHUNT_REAL .................................................................................................... 2606
SET_EXT_SYSSWD_CHAR ...................................................................................................... 2607
SET_EXT_SYSSWD_INT ......................................................................................................... 2608
SET_EXT_SYSSWD_LOGICAL ................................................................................................. 2609
SET_EXT_SYSSWD_REAL ....................................................................................................... 2610
SET_EXT_TRANSFORMER_CHAR ............................................................................................ 2611
SET_EXT_TRANSFORMER_INT ............................................................................................... 2612
SET_EXT_TRANSFORMER_LOGICAL ....................................................................................... 2613
SET_EXT_TRANSFORMER_REAL ............................................................................................. 2614
SET_EXT_TWOTERMDC_CHAR ............................................................................................... 2615
SET_EXT_TWOTERMDC_INT .................................................................................................. 2616
SET_EXT_TWOTERMDC_LOGICAL .......................................................................................... 2617
SET_EXT_TWOTERMDC_REAL ............................................................................................... 2618
SET_EXT_VSCDC_CHAR ........................................................................................................ 2619
SET_EXT_VSCDC_INT ........................................................................................................... 2620
SET_EXT_VSCDC_LOGICAL ................................................................................................... 2621
SET_EXT_VSCDC_REAL ......................................................................................................... 2622
SET_EXT_ZONE_CHAR .......................................................................................................... 2623
SET_EXT_ZONE_INT ............................................................................................................. 2624
SET_EXT_ZONE_LOGICAL ..................................................................................................... 2625
SET_EXT_ZONE_REAL .......................................................................................................... 2626
Subsystem Data Retrieval ............................................................................................................ 2627
Character Data .................................................................................................................... 2628
GET_CHAR_LENGTH ..................................................................................................... 2628
Bus Data ............................................................................................................................ 2630
ABUSCHAR .................................................................................................................. 2630
ABUSCOUNT ............................................................................................................... 2632
ABUSCPLX .................................................................................................................. 2633
ABUSINT ..................................................................................................................... 2635
ABUSREAL .................................................................................................................. 2637
ABUSTYPES ................................................................................................................. 2639
Plant Bus Data .................................................................................................................... 2641
AGENBUSCHAR ........................................................................................................... 2641
AGENBUSCOUNT ......................................................................................................... 2643
AGENBUSCPLX ............................................................................................................ 2644
AGENBUSINT ............................................................................................................... 2646
AGENBUSREAL ............................................................................................................ 2648
AGENBUSTYPES ........................................................................................................... 2651
Machine Data ..................................................................................................................... 2653
AMACHCHAR .............................................................................................................. 2653
AMACHCOUNT ............................................................................................................ 2655
AMACHCPLX ............................................................................................................... 2656
AMACHINT .................................................................................................................. 2658
AMACHREAL ............................................................................................................... 2660
AMACHTYPES ............................................................................................................. 2663
Load Bus Data .................................................................................................................... 2665
ALODBUSCHAR ............................................................................................................ 2665

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxviii
 ALODBUSCOUNT ......................................................................................................... 2667
ALODBUSCPLX ............................................................................................................ 2669
ALODBUSINT ............................................................................................................... 2672
ALODBUSREAL ............................................................................................................ 2674
ALODBUSTYPES ........................................................................................................... 2677
Load Data .......................................................................................................................... 2679
ALOADCHAR ............................................................................................................... 2679
ALOADCOUNT ............................................................................................................. 2681
ALOADCPLX ................................................................................................................ 2682
ALOADINT .................................................................................................................. 2685
ALOADREAL ................................................................................................................ 2687
ALOADTYPES ............................................................................................................... 2690
Fixed Shunt Bus Data .......................................................................................................... 2692
AFXSHNTBUSCHAR ...................................................................................................... 2692
AFXSHNTBUSCOUNT ................................................................................................... 2694
AFXSHNTBUSCPLX ....................................................................................................... 2695
AFXSHNTBUSINT ......................................................................................................... 2697
AFXSHNTBUSREAL ....................................................................................................... 2699
AFXSHNTBUSTYPES ..................................................................................................... 2701
Fixed Shunt Data ................................................................................................................ 2703
AFXSHUNTCHAR .......................................................................................................... 2703
AFXSHUNTCOUNT ....................................................................................................... 2705
AFXSHUNTCPLX .......................................................................................................... 2706
AFXSHUNTINT ............................................................................................................. 2708
AFXSHUNTREAL .......................................................................................................... 2710
AFXSHUNTTYPES ........................................................................................................ 2712
Switched Shunt Bus Data .................................................................................................... 2714
ASWSHUNTBUSCHAR ................................................................................................... 2714
ASWSHUNTBUSCOUNT ................................................................................................ 2716
ASWSHUNTBUSCPLX .................................................................................................... 2717
ASWSHUNTBUSINT ...................................................................................................... 2719
ASWSHUNTBUSREAL .................................................................................................... 2721
ASWSHUNTBUSTYPES .................................................................................................. 2723
Switched Shunt Data .......................................................................................................... 2725
ASWSHCHAR ............................................................................................................... 2725
ASWSHCOUNT ............................................................................................................ 2727
ASWSHCPLX ................................................................................................................ 2728
ASWSHINT .................................................................................................................. 2730
ASWSHREAL ................................................................................................................ 2732
ASWSHTYPES .............................................................................................................. 2736
Branch Flow Data ............................................................................................................... 2738
AFLOWCHAR ............................................................................................................... 2738
AFLOWCOUNT ............................................................................................................. 2741
AFLOWCPLX ................................................................................................................ 2743
AFLOWINT .................................................................................................................. 2745
AFLOWREAL ................................................................................................................ 2747
AFLOWTYPES .............................................................................................................. 2750
Branch Data ....................................................................................................................... 2752
ABRNCHAR ................................................................................................................. 2752
ABRNCOUNT ............................................................................................................... 2755
ABRNCPLX .................................................................................................................. 2757

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxix
 ABRNINT ..................................................................................................................... 2759
ABRNREAL .................................................................................................................. 2762
ABRNTYPES ................................................................................................................. 2770
Two-Winding Transformer Data ............................................................................................ 2772
ATRNCHAR .................................................................................................................. 2772
ATRNCOUNT ............................................................................................................... 2775
ATRNCPLX ................................................................................................................... 2777
ATRNINT ..................................................................................................................... 2780
ATRNREAL ................................................................................................................... 2783
ATRNTYPES ................................................................................................................. 2791
Three-Winding Transformer Data .......................................................................................... 2793
ATR3CHAR .................................................................................................................. 2793
ATR3COUNT ................................................................................................................ 2796
ATR3CPLX ................................................................................................................... 2798
ATR3INT ..................................................................................................................... 2801
ATR3REAL ................................................................................................................... 2804
ATR3TYPES ................................................................................................................. 2806
Three-Winding Transformer Winding Data ............................................................................. 2808
AWNDCHAR ................................................................................................................ 2808
AWNDCOUNT .............................................................................................................. 2811
AWNDCPLX ................................................................................................................. 2813
AWNDINT ................................................................................................................... 2815
AWNDREAL ................................................................................................................. 2818
AWNDTYPES ............................................................................................................... 2826
Two-Terminal dc Line Data .................................................................................................. 2828
A2TRMDCCHAR ........................................................................................................... 2828
A2TRMDCCOUNT ......................................................................................................... 2830
A2TRMDCCPLX ............................................................................................................ 2831
A2TRMDCINT .............................................................................................................. 2833
A2TRMDCREAL ............................................................................................................ 2835
A2TRMDCTYPES .......................................................................................................... 2839
Two-Terminal dc Line Converter Data ................................................................................... 2841
A2TRMDCCONVCHAR ................................................................................................... 2841
A2TRMDCCONVCOUNT ................................................................................................ 2844
A2TRMDCCONVCPLX ................................................................................................... 2846
A2TRMDCCONVINT ...................................................................................................... 2848
A2TRMDCCONVREAL ................................................................................................... 2850
A2TRMDCCONVTYPES .................................................................................................. 2853
Multi-Terminal dc Line Data ................................................................................................. 2855
AMULTITRMDCCHAR .................................................................................................... 2855
AMULTITRMDCCOUNT .................................................................................................. 2857
AMULTITRMDCCPLX ..................................................................................................... 2858
AMULTITRMDCINT ....................................................................................................... 2860
AMULTITRMDCREAL ..................................................................................................... 2862
AMULTITRMDCTYPES ................................................................................................... 2864
Multi-Terminal dc Line Converter Data .................................................................................. 2866
AMULTITRMDCCONVCHAR ............................................................................................ 2866
AMULTITRMDCCONVCOUNT ......................................................................................... 2869
AMULTITRMDCCONVCPLX ............................................................................................ 2871
AMULTITRMDCCONVINT ............................................................................................... 2873
AMULTITRMDCCONVREAL ............................................................................................ 2875

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xl
 AMULTITRMDCCONVTYPES .......................................................................................... 2878
VSC dc Line Data ................................................................................................................ 2880
AVSCDCCHAR .............................................................................................................. 2880
AVSCDCCOUNT ........................................................................................................... 2882
AVSCDCCPLX .............................................................................................................. 2883
AVSCDCINT ................................................................................................................. 2885
AVSCDCREAL ............................................................................................................... 2887
AVSCDCTYPES ............................................................................................................. 2889
VSC dc Line Converter Data ................................................................................................. 2891
AVSCDCCONVCHAR ..................................................................................................... 2891
AVSCDCCONVCOUNT ................................................................................................... 2894
AVSCDCCONVCPLX ...................................................................................................... 2896
AVSCDCCONVINT ........................................................................................................ 2898
AVSCDCCONVREAL ...................................................................................................... 2900
AVSCDCCONVTYPES .................................................................................................... 2903
FACTS Device Data .............................................................................................................. 2905
AFACTSCHAR .............................................................................................................. 2905
AFACTSCOUNT ............................................................................................................ 2907
AFACTSCPLX ............................................................................................................... 2909
AFACTSINT .................................................................................................................. 2911
AFACTSREAL ............................................................................................................... 2913
AFACTSTYPES .............................................................................................................. 2917
FACTS Device Bus Data ........................................................................................................ 2919
AFACTSBUSCHAR ......................................................................................................... 2919
AFACTSBUSCOUNT ...................................................................................................... 2922
AFACTSBUSCPLX ......................................................................................................... 2924
AFACTSBUSINT ............................................................................................................ 2926
AFACTSBUSREAL ......................................................................................................... 2929
AFACTSBUSTYPES ........................................................................................................ 2932
Area Data ........................................................................................................................... 2934
AAREACHAR ................................................................................................................ 2934
AAREACOUNT ............................................................................................................. 2936
AAREACPLX ................................................................................................................. 2937
AAREAINT ................................................................................................................... 2939
AAREAREAL ................................................................................................................ 2941
AAREATYPES ............................................................................................................... 2944
Owner Data ........................................................................................................................ 2946
AOWNERCHAR ............................................................................................................ 2946
AOWNERCOUNT .......................................................................................................... 2948
AOWNERCPLX ............................................................................................................. 2949
AOWNERINT ................................................................................................................ 2951
AOWNERREAL ............................................................................................................. 2953
AOWNERTYPES ............................................................................................................ 2956
Zone Data .......................................................................................................................... 2958
AZONECHAR ............................................................................................................... 2958
AZONECOUNT ............................................................................................................. 2960
AZONECPLX ................................................................................................................ 2961
AZONEINT .................................................................................................................. 2963
AZONEREAL ................................................................................................................ 2965
AZONETYPES .............................................................................................................. 2968
Induction Machine Bus Data ................................................................................................ 2970

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xli
 AINDMACBUSCHAR ...................................................................................................... 2970
AINDMACBUSCOUNT ................................................................................................... 2972
AINDMACBUSCPLX ...................................................................................................... 2974
AINDMACBUSINT ......................................................................................................... 2976
AINDMACBUSREAL ...................................................................................................... 2978
AINDMACBUSTYPES ..................................................................................................... 2981
Induction Machine Data ...................................................................................................... 2983
AINDMACCHAR ........................................................................................................... 2983
AINDMACCOUNT ......................................................................................................... 2985
AINDMACCPLX ............................................................................................................ 2987
AINDMACINT .............................................................................................................. 2989
AINDMACREAL ............................................................................................................ 2992
AINDMACTYPES .......................................................................................................... 2995
Substation Data .................................................................................................................. 2997
ASTATIONCHAR ........................................................................................................... 2997
ASTATIONCOUNT ......................................................................................................... 2999
ASTATIONINT .............................................................................................................. 3000
ASTATIONREAL ............................................................................................................ 3002
ASTATIONTYPES .......................................................................................................... 3003
Substation Node Data ......................................................................................................... 3005
ANODECHAR ............................................................................................................... 3005
ANODECOUNT ............................................................................................................ 3007
ANODEINT .................................................................................................................. 3008
ANODEREAL ................................................................................................................ 3010
ANODETYPES .............................................................................................................. 3011
Substation Switching Device Data ........................................................................................ 3013
ASTASWDEVCHAR ........................................................................................................ 3013
ASTASWDEVCOUNT ..................................................................................................... 3015
ASTASWDEVCPLX ........................................................................................................ 3016
ASTASWDEVINT ........................................................................................................... 3018
ASTASWDEVREAL ........................................................................................................ 3020
ASTASWDEVTYPES ....................................................................................................... 3022
Substation Terminal Data .................................................................................................... 3024
ATERMINALCHAR ......................................................................................................... 3024
ATERMINALCOUNT ...................................................................................................... 3026
ATERMINALINT ............................................................................................................ 3027
ATERMINALTYPES ........................................................................................................ 3029
Zero Sequence Mutuals Data ............................................................................................... 3031
AZMUTCHAR ............................................................................................................... 3031
AZMUTCOUNT ............................................................................................................ 3033
AZMUTCPLX ................................................................................................................ 3035
AZMUTINT .................................................................................................................. 3037
AZMUTREAL ................................................................................................................ 3039
AZMUTTYPES .............................................................................................................. 3041
Graphical Analysis Output ........................................................................................................... 3043
POLY_PRINT ........................................................................................................................ 3044
PV_PRINT ............................................................................................................................ 3045
QV_PRINT ........................................................................................................................... 3047
SETFULLVIEWGRAPHAREA .................................................................................................... 3048
SETFULLVIEWSCALE ............................................................................................................. 3051
Scenarios .................................................................................................................................... 3053

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xlii
 CLOSESCENARIOFILE ........................................................................................................... 3054
NEWSCENARIOFILE .............................................................................................................. 3055
OPENSCENARIOFILE ............................................................................................................. 3056
SAVESCENARIOFILE ............................................................................................................. 3057
SCENARIOCLOSE ................................................................................................................. 3058
SCENARIOCOPYFILE ............................................................................................................. 3059
SCENARIOFILEADD .............................................................................................................. 3060
SCENARIOFILECOUNT .......................................................................................................... 3061
SCENARIOFILEGETATTRS ...................................................................................................... 3062
SCENARIOFILEGETCOMMENTS .............................................................................................. 3063
SCENARIOFILELENGTHCOMMENTS ........................................................................................ 3064
SCENARIOFILELIST ............................................................................................................... 3065
SCENARIOFILEREMOVE ........................................................................................................ 3066
SCENARIOFILERENAME ........................................................................................................ 3067
SCENARIOFILESETATTRS ....................................................................................................... 3068
SCENARIOFILESETCOMMENTS .............................................................................................. 3069
SCENARIOGETATTRS ............................................................................................................ 3070
SCENARIOGETCOMMENTS .................................................................................................... 3071
SCENARIOGETOPT ............................................................................................................... 3072
SCENARIOGROUPADD .......................................................................................................... 3074
SCENARIOGROUPCOUNT ...................................................................................................... 3075
SCENARIOGROUPGETCOMMENTS ......................................................................................... 3076
SCENARIOGROUPLENGTHCOMMENTS ................................................................................... 3077
SCENARIOGROUPLIST .......................................................................................................... 3078
SCENARIOGROUPOPEN ........................................................................................................ 3079
SCENARIOGROUPREMOVE .................................................................................................... 3080
SCENARIOGROUPRENAME .................................................................................................... 3081
SCENARIOGROUPSETCOMMENTS .......................................................................................... 3082
SCENARIOISDIRTY ............................................................................................................... 3083
SCENARIOISVALID ............................................................................................................... 3084
SCENARIOLENGTHCOMMENTS ............................................................................................. 3085
SCENARIOMODELGROUP ...................................................................................................... 3086
SCENARIOMOVEFILE ............................................................................................................ 3087
SCENARIONEW .................................................................................................................... 3088
SCENARIOOPEN .................................................................................................................. 3089
SCENARIOSAVE ................................................................................................................... 3090
SCENARIOSETATTRS ............................................................................................................. 3091
SCENARIOSETCOMMENTS .................................................................................................... 3092
SCENARIOSETOPT ................................................................................................................ 3093
SCENARIOTRACKFILEADD ..................................................................................................... 3095
SCENARIOTRACKFILELIST ...................................................................................................... 3096
SCENARIOTRACKFILENUM .................................................................................................... 3097
SCENARIOUNZIP .................................................................................................................. 3098
SCENARIOUNZIPPROBLEMS .................................................................................................. 3099
SCENARIOUNZIPSOLUTIONS ................................................................................................. 3100
SCENARIOZIP ...................................................................................................................... 3101
SCENARIOZIPACTIVE ............................................................................................................ 3102
SCENARIOZIPOPEN .............................................................................................................. 3103
SCENARIOZIPSAVE ............................................................................................................... 3104
Event Studies .............................................................................................................................. 3105
CLOSEEVENTSTUDYFILE ....................................................................................................... 3106

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xliii
 OPENEVENTSTUDYFILE ........................................................................................................ 3107
RUNDYNAMICEVENTSTUDY .................................................................................................. 3108
RUNPOWERFLOWEVENTSTUDY ............................................................................................. 3109
SAVEEVENTSTUDYFILE ......................................................................................................... 3110
SETACTIVEEVENTSTUDY ....................................................................................................... 3111
Measurement Interface ............................................................................................................... 3112
HDAIMPORTDATA ................................................................................................................ 3113
Multiple Element Data ................................................................................................................ 3114
AVOLTAGEDROOPCHAR ........................................................................................................ 3115
AVOLTAGEDROOPCOUNT ..................................................................................................... 3116
AVOLTAGEDROOPINT ........................................................................................................... 3117
AVOLTAGEDROOPREAL ......................................................................................................... 3118
GETMODELLIBRARIES ........................................................................................................... 3120
GETMODELPROGRAMS ......................................................................................................... 3121
LAST_PF ............................................................................................................................. 3122
RXPATH .............................................................................................................................. 3123
TREEDAT ............................................................................................................................. 3124
Using the Vendor Neutral Contingency and RAS Auxiliary File ........................................................ 3126
ACCC_RAS .......................................................................................................................... 3127
ACCC_RAS_2 ....................................................................................................................... 3128
ADD2WINDINGCONTINGENCYELEMENT ................................................................................ 3130
ADD2WINDINGREMEDIALACTIONELEMENT ............................................................................ 3132
ADD3WINDINGCONTINGENCYELEMENT ................................................................................ 3135
ADD3WINDINGREMEDIALACTIONELEMENT ............................................................................ 3138
ADDACLINECONTINGENCYELEMENT ...................................................................................... 3141
ADDACLINEREMEDIALACTIONELEMENT ................................................................................. 3143
ADDBUSCONTINGENCYELEMENT .......................................................................................... 3146
ADDBUSREMEDIALACTIONELEMENT ...................................................................................... 3148
ADDCONTINGENCY .............................................................................................................. 3151
ADDCONTINGENCYELEMENT ................................................................................................ 3152
ADDDCCONVCONTINGENCYELEMENT ................................................................................... 3154
ADDDCCONVREMEDIALACTIONELEMENT ............................................................................... 3156
ADDDCLINECONTINGENCYELEMENT ..................................................................................... 3159
ADDDCLINEREMEDIALACTIONELEMENT ................................................................................. 3161
ADDFIXSHUNTCONTINGENCYELEMENT ................................................................................. 3164
ADDFIXSHUNTREMEDIALACTIONELEMENT ............................................................................. 3166
ADDGENERATORCONTINGENCYELEMENT ............................................................................... 3169
ADDGENERATORREMEDIALACTIONELEMENT .......................................................................... 3171
ADDLOADCONTINGENCYELEMENT ........................................................................................ 3174
ADDLOADREMEDIALACTIONELEMENT ................................................................................... 3176
ADDPYTHONCONTINGENCYELEMENT .................................................................................... 3179
ADDPYTHONREMEDIALACTIONELEMENT ............................................................................... 3181
ADDREMEDIALACTION ......................................................................................................... 3183
ADDREMEDIALACTIONELEMENT ........................................................................................... 3184
ADDSUBCONTINGENCYELEMENT .......................................................................................... 3187
ADDSUBREMEDIALACTIONELEMENT ...................................................................................... 3189
ADDVSCDCCONTINGENCYELEMENT ...................................................................................... 3192
ADDVSCDCREMEDIALACTIONELEMENT .................................................................................. 3194
APPEND_RAS ....................................................................................................................... 3197
READ_RAS .......................................................................................................................... 3198
VALIDATE_RAS .................................................................................................................... 3199

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xliv
 WRITE_RAS ......................................................................................................................... 3200
Non-Engineering ......................................................................................................................... 3202
ALERT ................................................................................................................................. 3203
BEGINREPORT ..................................................................................................................... 3204
CLEARALERTOUTPUT ............................................................................................................ 3205
CLEARPROGRESSOUTPUT ..................................................................................................... 3206
FILEIN ................................................................................................................................ 3207
GETBATDEFAULTS ................................................................................................................ 3208
GETDEFAULTCHAR ............................................................................................................... 3209
GETDEFAULTINT .................................................................................................................. 3210
GETDEFAULTREAL ................................................................................................................ 3211
GETLOADEDMODULES ......................................................................................................... 3212
GETMODFUNCLIST .............................................................................................................. 3213
IOFLUSH ............................................................................................................................. 3214
LAUNCH_PROGRAM ............................................................................................................. 3215
PAGEREPORT ....................................................................................................................... 3216
PROGRESS .......................................................................................................................... 3217
PROMPT ............................................................................................................................. 3218
PSSEINIT ............................................................................................................................. 3219
PSSEVERSION ...................................................................................................................... 3220
REFRESHGUI ....................................................................................................................... 3221
REPORT .............................................................................................................................. 3222
RUNIPLANFILE ..................................................................................................................... 3223
RUNRSPNSFILE .................................................................................................................... 3224
SHOWLOADEDLIBRARIES ...................................................................................................... 3225
SHOWLOADEDMODULES ...................................................................................................... 3226
STARTRECORDING ................................................................................................................ 3227
STOPRECORDING ................................................................................................................. 3228
T_ALERT_OUTPUT ................................................................................................................ 3229
T_PROGRESS_OUTPUT ......................................................................................................... 3231
T_PROMPT_OUTPUT ............................................................................................................ 3233
T_REPORT_OUTPUT ............................................................................................................. 3235
USERIN ............................................................................................................................... 3237
PSSPLOT Module ......................................................................................................................... 3238
ADDFUNCTION .................................................................................................................... 3239
CHANNELFILEEXCELEXPORT ................................................................................................. 3240
DELETESELPLOT .................................................................................................................. 3241
DRAGDROPPLOTDATA ........................................................................................................... 3242
EXPORTPLOT ....................................................................................................................... 3243
INSERTPAGE ........................................................................................................................ 3244
INSERTPLOT ........................................................................................................................ 3245
MULTICHANNEXCELEXPORT ................................................................................................. 3246
NEWPLOTBOOK ................................................................................................................... 3247
OPENCHANDATAFILE ........................................................................................................... 3248
PLOTPAGEPRINTSETUP ......................................................................................................... 3249
PRINTACTIVEPAGE ................................................................................................................ 3250
PRINTSELPLOT ..................................................................................................................... 3251
SETSELECTEDPAGE .............................................................................................................. 3252
SETSELECTEDPLOT ............................................................................................................... 3253
SHOWPLOTEDITOR ............................................................................................................... 3254
XYPLOT .............................................................................................................................. 3255

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xlv
PSSRDB Module .......................................................................................................................... 3256
DVRMATTACHANDLAUNCHWORKBOOK ................................................................................. 3257
DVRMCREATEACCDATABASE ................................................................................................. 3259
DVRMCREATEDYNDATABASE ................................................................................................. 3260
MUSTPY Module ......................................................................................................................... 3261
MUST Analysis Functions ..................................................................................................... 3262
ACCDEFAULTS ............................................................................................................. 3262
ACCONTBYCONT .......................................................................................................... 3264
ACCONTBYMONEL ....................................................................................................... 3266
ACCSOLVE .................................................................................................................. 3268
ACLFDC ...................................................................................................................... 3270
ACLFNS ...................................................................................................................... 3272
ACSOLVE_LFD ............................................................................................................. 3274
ACSOLVE_LFN ............................................................................................................. 3275
ACTIVITYACCONT ........................................................................................................ 3276
ACTIVITYMUST ............................................................................................................ 3277
ACTRANSFERLIMITSTUDY ............................................................................................. 3278
ADDTRANSACTION ...................................................................................................... 3279
APPLYSINGLECONT ...................................................................................................... 3280
AREABUBBLE ............................................................................................................... 3281
AREAIMPACT ............................................................................................................... 3282
AREASINZONES ........................................................................................................... 3284
AREASLACKS ............................................................................................................... 3285
AREASUMMARY .......................................................................................................... 3286
BRANCHSENSITIVITY .................................................................................................... 3287
CDETAILBRANCHES ...................................................................................................... 3289
CDETAILINTERFACES .................................................................................................... 3290
CDETAILVOLTAGEBUSES ............................................................................................... 3291
CHANGEPARAMS ......................................................................................................... 3292
CLEARMULTISTUDY ...................................................................................................... 3299
CNALLTRANSELBRANCHES ............................................................................................ 3300
CNALLTRANSELFLOWGATES .......................................................................................... 3301
CNALLTRANSELINTERFACES .......................................................................................... 3302
CNALLVIOLATED .......................................................................................................... 3303
CNALLVIOLFREQ .......................................................................................................... 3304
CNBASEVIOLATED ....................................................................................................... 3305
CNCINITSELBRANCHES ................................................................................................. 3306
CNCINITSELINTERFACES ............................................................................................... 3307
CNCOMPSELBRANCHES ................................................................................................ 3308
CNCOMPSELINTERFACES .............................................................................................. 3309
CNCOMPSELVOLTAGEBUSES ......................................................................................... 3310
CNCRESULTSSELBRANCHES .......................................................................................... 3311
CNCRESULTSSELINTERFACES ......................................................................................... 3312
CNDETAILSELFLOWGATES ............................................................................................. 3313
CNDETAILSELINTERFACES ............................................................................................. 3314
CNFACTORSSELFLOWGATES .......................................................................................... 3315
CNFREQSELBRANCHES ................................................................................................. 3316
CNFREQSELBRANCHES_TBL .......................................................................................... 3317
CNFREQSELINTERFACES ............................................................................................... 3318
CNFREQSELINTERFACES_TBL ........................................................................................ 3319
CNFREQSELVOLTAGEBUSES .......................................................................................... 3320

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xlvi
 CNGAPPSELBRANCHES ................................................................................................. 3321
CNGAPPSELFLOWGATES ............................................................................................... 3322
CNGAPPSELINTERFACES ............................................................................................... 3323
CNIMPACTSELBRANCHES .............................................................................................. 3324
CNIMPACTSELFLOWGATES ............................................................................................ 3325
CNIMPACTSELINTERFACES ............................................................................................ 3326
CNLISTSELBRANCHES ................................................................................................... 3327
CNLISTSELBRANCHES_TBL ............................................................................................ 3328
CNLISTSELFLOWGATES ................................................................................................. 3329
CNLISTSELFLOWGATES_TBL .......................................................................................... 3330
CNLISTSELINTERFACES ................................................................................................. 3331
CNLISTSELINTERFACES_TBL .......................................................................................... 3332
CNLISTSELVOLTAGEBUSES ............................................................................................ 3333
CNOTDFSELBRANCHES ................................................................................................. 3334
CNOTDFSELINTERFACES ............................................................................................... 3335
CNSELECTBRANCHBYALL .............................................................................................. 3336
CNSELECTBRANCHBYAREAS .......................................................................................... 3337
CNSELECTBRANCHBYBRANCHES ................................................................................... 3338
CNSELECTBRANCHBYBUSES .......................................................................................... 3339
CNSELECTBRANCHBYIMPACT ........................................................................................ 3340
CNSELECTBRANCHBYTIES ............................................................................................. 3341
CNSELECTBRANCHBYVIOL ............................................................................................ 3342
CNSELECTBRANCHBYZONES ......................................................................................... 3343
CNSELECTFGATEBYALL ................................................................................................. 3344
CNSELECTFGATEBYCONT .............................................................................................. 3345
CNSELECTFGATEBYID ................................................................................................... 3346
CNSELECTFGATEBYIMPACT ........................................................................................... 3347
CNSELECTFGATEBYVIOL ............................................................................................... 3348
CNSELECTINTERBYALL .................................................................................................. 3349
CNSELECTINTERBYIMPACT ............................................................................................ 3350
CNSELECTINTERBYNAME .............................................................................................. 3351
CNSELECTINTERBYNUMBER .......................................................................................... 3352
CNSELECTINTERBYVIOL ................................................................................................ 3353
CNSELECTVOLTAGEBUSESBYVIOL .................................................................................. 3354
CNSELECTVOLTBUSBYALL ............................................................................................. 3355
CNSELECTVOLTBUSBYAREAS ......................................................................................... 3356
CNSELECTVOLTBUSBYBUSES ......................................................................................... 3357
CNSELECTVOLTBUSBYZONES ........................................................................................ 3358
CNSELECTVOLTBUSESBYDEVIATION ............................................................................... 3359
CNSENSUBSELBRANCHES ............................................................................................. 3360
CNSENSUBSELFLOWGATES ........................................................................................... 3361
CNSENSUBSELINTERFACES ........................................................................................... 3362
CNSTUDYSELBRANCHES ............................................................................................... 3363
CNSTUDYSELFLOWGATES ............................................................................................. 3364
CNSTUDYSELINTERFACES ............................................................................................. 3365
CNSUBSELBRANCHES ................................................................................................... 3366
CNSUBSELFLOWGATES ................................................................................................. 3367
CNSUBSELINTERFACES ................................................................................................. 3368
CNSUMMARYVIOLATIONS ............................................................................................ 3369
CNTRANSACTSELBRANCHES ......................................................................................... 3370
CNTRANSACTSELFLOWGATES ....................................................................................... 3371

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xlvii
 CNTRANSACTSELINTERFACES ........................................................................................ 3372
CNVARSELBRANCHES ................................................................................................... 3373
CNVARSELINTERFACES ................................................................................................. 3374
CNVARSELVOLTAGEBUSES ............................................................................................ 3375
CNVIOLSELBRANCHES .................................................................................................. 3376
CNVIOLSELBRANCHES_TBL ........................................................................................... 3377
CNVIOLSELFLOWGATES ................................................................................................ 3378
CNVIOLSELFLOWGATES_TBL ......................................................................................... 3379
CNVIOLSELINTERFACES ................................................................................................ 3380
CNVIOLSELINTERFACES_TBL ......................................................................................... 3381
CNVIOLSELVOLTAGEBUSES ........................................................................................... 3382
COMPAREFCITC ........................................................................................................... 3383
CONSTRDEFS .............................................................................................................. 3384
DCCONTBYCONT ......................................................................................................... 3386
DCCONTBYMONEL ....................................................................................................... 3388
DCSOLVE .................................................................................................................... 3390
DCTRANSFERLIMITSTUDY ............................................................................................. 3391
DETAILSELCONTINGENCIES ........................................................................................... 3392
DETAILSELCONTINGENCIESSP ....................................................................................... 3393
DIRECT ....................................................................................................................... 3394
EXCLUDESELECTEDCONTS ............................................................................................ 3395
EXECUTEACCONT ........................................................................................................ 3396
EXITACTIVITYACCONT .................................................................................................. 3397
EXITACTIVITYMUST ...................................................................................................... 3398
FCITC2LINE ................................................................................................................. 3399
FCITCAC ..................................................................................................................... 3400
FCITCACMULT ............................................................................................................. 3401
FCITCACSINGLE ........................................................................................................... 3402
FCITCBASE .................................................................................................................. 3403
FCITCBASEMULT .......................................................................................................... 3404
FCITCBASESINGLE ........................................................................................................ 3405
FCITCMULT ................................................................................................................. 3406
FCITCSINGLE ............................................................................................................... 3407
FCITCSUBS .................................................................................................................. 3408
FCITCTLTG .................................................................................................................. 3409
FCITCWIDE .................................................................................................................. 3410
FLOWGATESENSITIVITY ................................................................................................ 3411
FORGETSTUDYTRANSFER ............................................................................................. 3413
GENDETAILS ............................................................................................................... 3414
GENSENDETAIL ........................................................................................................... 3415
GENSENSUMMARY ...................................................................................................... 3416
ILFDEFAULTS ............................................................................................................... 3417
IMPACTINTRFACEPARTFACT .......................................................................................... 3419
IMPACTSETBASECASE .................................................................................................. 3421
IMPACTSETCONTINGENCY ............................................................................................ 3422
IMPACTTIESPARTFACT .................................................................................................. 3423
IMPACTTOTALPARTFACT ............................................................................................... 3425
INCLUDESELECTEDCONTS ............................................................................................ 3426
INTERFACESENSITIVITY ................................................................................................ 3427
LISTACCONTDETAILS .................................................................................................... 3429
LISTACCONTSUMMARY ................................................................................................ 3430

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xlviii
 LISTAREAS .................................................................................................................. 3431
LISTBUSES .................................................................................................................. 3432
LISTEXCLUDES ............................................................................................................. 3433
LISTGENERATORS ......................................................................................................... 3434
LISTPHASESHIFTERS ..................................................................................................... 3435
LISTSELCONTINGENCIES ............................................................................................... 3436
LISTSELCONTINGENCIES_TBL ........................................................................................ 3437
LISTZONES .................................................................................................................. 3438
LIST_BFLOW ................................................................................................................ 3439
LIST_BIMPACT ............................................................................................................. 3440
LIST_CFLOW ................................................................................................................ 3441
LIST_CIMPACT ............................................................................................................. 3442
LIST_CONTINS ............................................................................................................. 3443
LIST_CONTINS_WISL .................................................................................................... 3444
LIST_LODF .................................................................................................................. 3445
LIST_LODF_WISL ......................................................................................................... 3446
LIST_MONELS ............................................................................................................. 3447
LIST_PTDF ................................................................................................................... 3448
LIST_PTDFC ................................................................................................................. 3449
LIST_SYSTEMS ............................................................................................................. 3450
MDETAILBRANCHES ..................................................................................................... 3451
MDETAILINTERFACES ................................................................................................... 3452
MDETAILVOLTAGEBUSES ............................................................................................... 3453
MODIFYDISPATCH ........................................................................................................ 3454
MONELIMPACT ............................................................................................................ 3455
MONSENSALLSUBBRANCHES ........................................................................................ 3457
MONSENSALLSUBFLOWGATES ...................................................................................... 3458
MONSENSALLSUBINTERFACES ...................................................................................... 3459
MONSENSALLTRANBRANCHES ...................................................................................... 3460
MONSENSALLTRANFLOWGATES .................................................................................... 3461
MONSENSALLTRANINTERFACES .................................................................................... 3462
MONSENSSINGLESUBBRANCHES ................................................................................... 3463
MONSENSSINGLESUBFLOWGATES ................................................................................. 3464
MONSENSSINGLESUBINTERFACES ................................................................................. 3465
MONSENSSUBSPARTBRANCHES .................................................................................... 3466
MONSENSSUBSPARTFLOWGATES .................................................................................. 3467
MONSENSSUBSPARTINTERFACES ................................................................................... 3468
MONSENSTRANBRANCHES ........................................................................................... 3469
MONSENSTRANFLOWGATES ......................................................................................... 3470
MONSENSTRANINTERFACES ......................................................................................... 3471
MULTACFCITC .............................................................................................................. 3472
MULTDCFCITC ............................................................................................................. 3474
MULTIPLEPARALLELTRANSFERS ..................................................................................... 3475
MULTIPLESTUDYTRANSFERS ......................................................................................... 3477
MUSTOPTDEFS ............................................................................................................ 3479
MUSTSTART ................................................................................................................ 3481
MUSTSTOP .................................................................................................................. 3482
PARALLELDETAILTRANSFER ........................................................................................... 3483
PARALLELFCITCSUMMARY ............................................................................................ 3484
PRINTRPT .................................................................................................................... 3485
PSCASE ...................................................................................................................... 3486

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xlix
 RDEXCHGFILE .............................................................................................................. 3487
RDMONCONFILE .......................................................................................................... 3488
RDMUSTFILES ............................................................................................................. 3489
RDSUBFILE .................................................................................................................. 3491
READACCONTFILE ........................................................................................................ 3492
READRAWDATA ............................................................................................................ 3493
REAREABUS ................................................................................................................ 3494
REMOVEEXCLUDES ...................................................................................................... 3495
REZONEBUS ................................................................................................................ 3496
SAVEACCONTFILE ........................................................................................................ 3497
SAVEFLOWGATES ........................................................................................................ 3498
SAVESELECTEDCONTS .................................................................................................. 3499
SAVESUBSYSTEMS ....................................................................................................... 3500
SAVEXCHGFILE ............................................................................................................ 3501
SCEDANALYSIS ............................................................................................................ 3502
SELECTACTIVECONTS ................................................................................................... 3504
SELECTALLCONTS ........................................................................................................ 3505
SELECTCOMPLEXCONTS ............................................................................................... 3506
SELECTCONVERGECONTS ............................................................................................. 3507
SELECTDISABLEDCONTS ............................................................................................... 3508
SELECTEXCLUDEDCONTS .............................................................................................. 3509
SELECTGENCONTS ....................................................................................................... 3510
SELECTHISEVCONTS ..................................................................................................... 3511
SELECTIMBALANCECONTS ............................................................................................ 3512
SELECTISLANDCONTS .................................................................................................. 3513
SELECTLOADCONTS ..................................................................................................... 3514
SELECTLOSEVCONTS .................................................................................................... 3515
SELECTNOTCONVERGECONTS ....................................................................................... 3516
SELECTNOVIOLCONTS .................................................................................................. 3517
SELECTSINGLEBRANCHCONTS ...................................................................................... 3518
SELECTSPECIFICCONTS ................................................................................................. 3519
SELECTVIOLCONTS ...................................................................................................... 3520
SETEXCLUDEDBRANCHES ............................................................................................. 3521
SETEXCLUDEDCONTINGENCIES ..................................................................................... 3522
SETEXCLUDEDFLOWGATES ........................................................................................... 3523
SETEXCLUDEDINTERFACES ........................................................................................... 3524
SETEXCLUDEDVOLTAGEBUSES ...................................................................................... 3525
SGLACFCITC ................................................................................................................ 3526
SGLDCFCITC ................................................................................................................ 3528
SHOWPARAMS ............................................................................................................ 3530
SUBSYSTEMS .............................................................................................................. 3532
SUMMARYCONTINGENCIES .......................................................................................... 3533
SWINGBUSES .............................................................................................................. 3534
VIOLSELCONTINGENCIES .............................................................................................. 3535
VIOLSELCONTINGENCIES_TBL ....................................................................................... 3536
WRITEEXCLUDES ......................................................................................................... 3537
WRITERAWDATA .......................................................................................................... 3538
ZONEBUBBLE .............................................................................................................. 3539
ZONESINAREAS ........................................................................................................... 3540
ZONESUMMARY .......................................................................................................... 3541
MUST Data Retrieval ........................................................................................................... 3543

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
l
 GETEXCLUDEDBRANCHES ............................................................................................. 3543
GETEXCLUDEDCONTINGENCIES .................................................................................... 3544
GETEXCLUDEDFLOWGATES ........................................................................................... 3545
GETEXCLUDEDINTERFACES ........................................................................................... 3546
GETEXCLUDEDVOLTAGEBUSES ...................................................................................... 3547
GETFINALBALANCE ...................................................................................................... 3548
GETFINALFLOW ........................................................................................................... 3549
GETIDOFCONTINGENCYBYNAME ................................................................................... 3550
GETIDOFFLOWGATEBYNAME ........................................................................................ 3551
GETIDOFINTERFACEBYNAME ........................................................................................ 3552
GETIDOFVOLTAGEBUSBYNAME ..................................................................................... 3553
GETINITBALANCE ........................................................................................................ 3554
GETINITIALFLOW ......................................................................................................... 3555
GETIPFFACTOR ............................................................................................................ 3556
GETNAMEOFCONTINGENCYBYID ................................................................................... 3557
GETNAMEOFFLOWGATEBYID ........................................................................................ 3558
GETNAMEOFINTERFACEBYID ........................................................................................ 3559
GETNAMEOFVOLTAGEBUSBYID ..................................................................................... 3560
GETNUMOFEXCLUDEDBRANCHES ................................................................................. 3561
GETNUMOFEXCLUDEDCONTINGENCIES ......................................................................... 3562
GETNUMOFEXCLUDEDFLOWGATES ............................................................................... 3563
GETNUMOFEXCLUDEDINTERFACES ................................................................................ 3564
GETNUMOFEXCLUDEDVOLTAGEBUSES ........................................................................... 3565
GETTPFBALANCE ......................................................................................................... 3566
PSSARRAYS Module ..................................................................................................................... 3568
ACCC_SUMMARY ................................................................................................................. 3569
ACCC_SOLUTION ................................................................................................................. 3572
ACCC_SUMMARY_REPORT .................................................................................................... 3574
SENSITIVITY_FLOW_TO_MW ................................................................................................. 3575
ACCC_SOLUTION_REPORT .................................................................................................... 3576
ACCC_VIOLATIONS_REPORT ................................................................................................. 3577
ASCC_CURRENTS ................................................................................................................. 3578
IECS_CURRENTS .................................................................................................................. 3583
OTDF_FACTORS ................................................................................................................... 3589
PV_SUMMARY ..................................................................................................................... 3591
PV_SUMMARY_REPORT ........................................................................................................ 3593
PV_SOLUTION ..................................................................................................................... 3594
PV_SOLUTION_REPORT ........................................................................................................ 3596
QV_SOLUTION .................................................................................................................... 3597
QV_SOLUTION_REPORT ........................................................................................................ 3598
QV_SUMMARY .................................................................................................................... 3599
QV_SUMMARY_REPORT ....................................................................................................... 3601
PSSEXCEL Module ....................................................................................................................... 3602
ACCC .................................................................................................................................. 3603
iec_data_file ....................................................................................................................... 3607
pv ...................................................................................................................................... 3609
qv ...................................................................................................................................... 3612
EXCELPY Module ......................................................................................................................... 3614
Methods ............................................................................................................................. 3618
Workbook Functions ........................................................................................................... 3624
GICDATA Module ......................................................................................................................... 3625

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
li
PSSPIHIST Module ....................................................................................................................... 3628
PFCONTROL Module .................................................................................................................... 3630
PFDSCNBUS ........................................................................................................................ 3631
PFCNCTBUS ........................................................................................................................ 3632
PFBRCHINT ......................................................................................................................... 3633
PFSUBSWDINT ..................................................................................................................... 3634
PFFXSINT ............................................................................................................................ 3635
PFFXSREAL ......................................................................................................................... 3636
PFSWSINT ........................................................................................................................... 3637
PFSWSREAL ......................................................................................................................... 3638
PFSWSINT_2 ....................................................................................................................... 3639
PFSWSREAL_2 ..................................................................................................................... 3640
PFLODINT ........................................................................................................................... 3641
PFLODREAL ......................................................................................................................... 3642
PFMACINT .......................................................................................................................... 3643
PFMACREAL ........................................................................................................................ 3644
PFPLNTREAL ........................................................................................................................ 3645
PFCNTLVSC ......................................................................................................................... 3647
PSSACCSS Module ....................................................................................................................... 3649
ACCC_FILE_INIT ................................................................................................................... 3650
ACCC_FILE_SIZE .................................................................................................................. 3652
ACCC_FILE_GET_SUM_VOLT ................................................................................................. 3654
ACCC_FILE_CLOSE ............................................................................................................... 3657
ACCC_FILE_SUMMARY ......................................................................................................... 3658
ACCC_FILE_SUMMARY_2 ...................................................................................................... 3662
ACCC_FILE_SUMMARY_3 ...................................................................................................... 3666
ACCC_FILE_SUM_AREAS ....................................................................................................... 3671
ACCC_FILE_CNTG_VOLT ....................................................................................................... 3674
ACCC_FILE_CNTG_FLOW ...................................................................................................... 3677
ACCC_FILE_CNTG_FLOW_2 ................................................................................................... 3680
ACCC_FILE_CNTG_VOLT_FLOW ............................................................................................. 3683
ACCC_FILE_CNTG_VOLT_FLOW_2 .......................................................................................... 3686
ACCC_FILE_CNTG_DSCR ....................................................................................................... 3689
ACCC_FILE_CNTG_LOAD ....................................................................................................... 3692
ACCC_FILE_SOLUTION ......................................................................................................... 3695
ACCC_FILE_SOLUTION_2 ...................................................................................................... 3699
Other Python Modules ................................................................................................................ 3703
Modules Supplied with a GUI ............................................................................................... 3704
Modules that Define Functions ............................................................................................ 3705
Index ......................................................................................................................................... 3706

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
lii
Preface
Structure of Manual
This document defines the PSS®E Application Program Interface (API) to the various engineering functions
in PSS®E.

How API Routines are Described

The description for each API routine starts with a brief explanation of its function, followed by one or more
language specific syntaxes for calling the routine, followed by a detailed description of the arguments used
in those calling sequences. The nomenclature used in the argument descriptions is most consistent with the
Fortran programming language.

The syntaxes for calling the API routines will include at least one of the PSS®E automation file languages,
and will usually include a syntax for use from a Fortran program. The set of syntaxes will include all the
PSS®E automation file languages where the API routine can be used. Some general comments about those
syntaxes may be helpful, as follows:

PSS®E Automation File Languages

Batch commands:this is a free-format input syntax. Items can be separated by a comma or spaces, strings
need only be quoted if they contain spaces or commas, omitted items can be indicated by consecutive com-
mas, arrays are entered as a sequence of scalar values, and a semi-colon can be used to terminate the com-
mand and return the remaining items to default values (it must be a separate data item, i.e., it must be sep-
arated from the previous data item by a space or comma). Except for unquoted filenames, a forward slash
will terminate a line. Commands may be continued over multiple lines. The sequence @! at the beginning
of the line will cause that line to be ignored.

Python commands:Python is an open source language; its syntax is well documented. Some of are argu-
ments are defined as arrays (in keeping with Fortran nomenclature, as mentioned above). Python does not
have arrays, and in general you should interpret arrays to mean lists (although tuples will usually work on
input). Arrays that have some elements as input and some as output in the Fortran syntax are represented in
the Python syntax as two separate arrays (i.e. lists). Keywords can be used for arguments, and any argument
can be omitted. Additionally, any element of an input array can be specified as a keyword, e.g. myarray6=2
specifies that the 6th element of the array myarray has the value 2. If an alias is documented for a specific
array element, it can also be used as a keyword for that element.

Fortran call statements:Fortran is a well-documented language (where it matters, we will use the Fortran
2008 standard). We will not use features that require explicit interfaces without stating so clearly in the
description. Unless specifically stated, arguments cannot be omitted.

IPLAN commands:the IPLAN language is described in the IPLAN manual. For purposes of the CALL statement
it resembles Fortran. Unless specifically stated, arguments cannot be omitted.

Return Codes / Error Codes

Most API routines return a integer return code, where zero indicates success. In Python, where multiple values
are returned (a tuple), the return code will always be the first value. When non-successful (usually non-zero)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
liii
error codes are returned, other returned values are set to None in Python, and are either uninitialized or
unchanged (for input/output values) in other syntaxes.

The Python interface can be made to throw exceptions instead of returning error codes values (the default).
Enter:

psspy.setThrowPsseExceptions(True)

or

psspy.param.throwPsseExceptions = True

To see if the Python interface is set to throw exceptions instead of returning error code values:

val = psspy.getThrowPsseExceptions()

Default Values
When values are omitted, special “no input” values are supplied. These special values – for each variable
type – are meant to indicate that “no input” was supplied. Many of the API routines permit this and will use
documented default values when “no input” values are supplied.

The actual “no input” values can be retrieved from the API routines GETDEFAULTINT, GETDEFAULTREAL, and
GETDEFAULTCHAR (capitalization depends on syntax). Users should never depend on the actual values re-
turned, by these functions. They should be used only for supplying values to the PSS®E API routines.

When automation files are recorded, items that have the default value are omitted in batch commands (i.e.
recorded as ",,") and recorded as _i, _f, _s, or _o (for integer, real/float, character/string, and filename, re-
spectively). In the PSS®E embedded Python environment there will be local variables _i, _f, and _s set to the
values returned from GETDEFAULTxxx routines mentioned above (_o will be treated as blanks). Outside of
PSS®E it is the user’s responsibility to set those variables.

Recording
Two recording formats are available: batch commands and Python.

Not all API routines are recordable. Routines that only retrieve data do not record, for example. If an API
routine is recordable, it will have a batch command format specified; routines without a batch command
format specified are not recordable.

Python Modules
Most of the PSS®E API is defined in the module psspy. Later chapters discuss routines defined in other mod-
ules. In those cases the Chapter name will include the name of the module.

In keeping with normal Python documentation the namespace is not included as part of the syntax for the
individual routines. This may seem confusing to newcomers to Python. For those whose first exposure to
Python is inside of PSS®E, be aware that, normally, you will use the, say, case API routine by entering:

psspy.case(filename)

not

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
liv
case(filename)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
lv
 Chapter 1
Power Flow
This chapter describes the API routines corresponding to the operational and data changing functions of the
PSS®E Power Flow.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1
Power Flow Power Flow Operation

1.1. Power Flow Operation

This section describes the API routines corresponding to the operational functions of the PSS®E Power Flow.
Also included are those routines that control basic program operations and the Open Access option.

1.1.1. ACCC
This API routine is obsolete. It has been replaced by the API routine accc_with_dsp_2 .

Use this API to apply the AC contingency calculation function (activity ACCC).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_ACCC TOL OPTIONS(1)..OPTIONS(7) DFXFILE ACCFILE THRFILE

Python command syntax:

ierr = accc(tol, options, dfxfile, accfile, thrfile)

Fortran command syntax:

CALL ACCCAPI(TOL, OPTIONS, DFXFILE, ACCFILE, THRFILE, IERR)

Where:

Real TOL mismatch tolerance (input; Newton solution convergence tolerance,

TOLN).
Integer OPTIONS (7) array of 7 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
2
Power Flow ACCC

OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) solution method flag (0 by default)
OPTIONS(6) = 0 FDNS
OPTIONS(6) = 1 FNSL
OPTIONS(6) = 2 optimized FDNS
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output file (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data file; blank for none (input; blank
by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 no Distribution Factor Data File specified
IERR = 7 no Contingency Solution Output File specified
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 bus type code and series element status in-
consistencies
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
3
Power Flow ACCC_2

1.1.2. ACCC_2
This API routine is obsolete. It has been replaced by the API routine accc_with_dsp_3 .

Use this API to apply the AC contingency calculation function (activity ACCC).

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_ACCC_2 TOL OPTIONS(1)..OPTIONS(7) DFXFILE ACCFILE THRFILE

Python command syntax:

ierr = accc_2(tol, options, dfxfile, accfile, thrfile)

Fortran command syntax:

CALL ACCC_2(TOL, OPTIONS, DFXFILE, ACCFILE, THRFILE, IERR)

Where:

Real TOL mismatch tolerance (input; Newton solution convergence tolerance,

TOLN).
Integer OPTIONS (9) array of 9 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(6) solution method flag (0 by default)
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) induction motor treatment flag (0 by default)
OPTIONS(9) induction machine failure flag (0 by default)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output file (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data file; blank for none (input; blank
by default).
Integer IERR error code (output).
IERR = 0 no error occurred.
IERR > 0 as for ACCC_WITH_DSP_3.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
4
Power Flow ACCC_2

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
5
Power Flow ACCC_MULTIPLE_MERGE

1.1.3. ACCC_MULTIPLE_MERGE
Use this API to merge a number of AC contingency solution files (acc files) into one acc file. The acc files
must be based on the same base case and MON file.

This API routine was first introduced in release 34.0.0.

Batch command syntax:

BAT_ACCC_MULTIPLE_MERGE OPTION NFILES ACFILES(1)..ACFILES(NFILES) ACCFILE

Python command syntax:

ierr = accc_multiple_merge(option, nfiles, acfiles, accfile)

Fortran command syntax:

CALL ACCC_MULTIPLE_MERGE(OPTION, NFILES, ACFILES, ACCFILE, IERR)

Where:
Integer OPTION Options for merging acc files. (input).
OPTION = 0 Do not merge .acc files if some .acc files have
different solving options, sub files or .mon
files.
OPTION = 1 Merge the.acc files even if some .acc files
have different solving options, sub files
or .mon files.
Integer NFILES The number of contingency acc files to be merged. (input).
Character*260 ACFILES An array of names of acc files. (input).
Character*260 ACCFILE The name of the merged contingency acc file. (input).
Integer IERR error code (output).
IERR = 0 no error occured
IERR = 1 invalid OPTION value
IERR = 2 invalid NFILES value
IERR = 3 error opening a Contingency Solution Output
File
IERR = 4 file is not in the form of a current Contin-
gency Solution Output File
IERR = 5 some input .acc files have different informa-
tion (.sav, .sub, .mon, PSSE version, solution
options)
IERR = 6 error reading or writing Contingency Solution
Output file
IERR = 7 error reading a Contingency Solution Output
File
IERR = 8 error closing a Contingency Solution Output
file
IERR = 9 Prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
6
Power Flow ACCC_MULTIPLE_MERGE

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
7
Power Flow ACCC_MULTIPLE_RUN_REPORT

1.1.4. ACCC_MULTIPLE_RUN_REPORT
This API routine is obsolete. It has been replaced by the API routine accc_multiple_run_report_2 .

Use this API to report the results of up to nine executions of the AC Contingency Calculation function.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_ACCC_MULTIPLE_RUN_REPORT OPTIONS(1)..OPTIONS(14)
VALUES(1)..VALUES(7) NFILES ACFILES(1)..ACFILES(NFILES)

Python command syntax:

ierr = accc_multiple_run_report(options, values, nfiles, acfiles)

Fortran command syntax:

CALL ACCC_MULTIPLE_RUN_REPORT(OPTIONS, VALUES, NFILES, ACFILES, IERR)

Where:
Integer OPTIONS (14) array of 14 elements specifying defining reporting options(input).
OPTIONS(1) column headings code (1 by default)
OPTIONS(1) = 1 Contingency Solution Output File names
OPTIONS(1) = 2 Saved Case File names as contained in the
Contingency Solution Output Files
OPTIONS(2) base case rating set (rating set program op-
tion setting by default)
OPTIONS(2) = 1 rate A
OPTIONS(2) = 2 rate B
OPTIONS(2) = 3 rate C
OPTIONS(3) contingency case rating set (rating set pro-
gram option setting by default)
OPTIONS(3) = 1 rate A
OPTIONS(3) = 2 rate B
OPTIONS(3) = 3 rate C
OPTIONS(4) print monitored elements summary report (0
by default)
OPTIONS(4) = 0 no
OPTIONS(4) = 1 yes
OPTIONS(5) print missing monitored elements report (0
by default)
OPTIONS(5) = 0 no
OPTIONS(5) = 1 yes
OPTIONS(6) print missing monitored voltage buses report
(0 by default)
OPTIONS(6) = 0 no
OPTIONS(6) = 1 yes

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
8
Power Flow ACCC_MULTIPLE_RUN_REPORT

OPTIONS(7) print contingency legend (2 by default)

OPTIONS(7) = 0 no
OPTIONS(7) = 1 complete master legend report only
OPTIONS(7) = 2 reduced legend with each table
OPTIONS(7) = 3 both master legend report and legend with
each table
OPTIONS(8) print missing contingencies report (0 by de-
fault)
OPTIONS(8) = 0 no
OPTIONS(8) = 1 yes
OPTIONS(9) print non-converged contingencies report (0
by default)
OPTIONS(9) = 0 no
OPTIONS(9) = 1 yes
OPTIONS(10) print loading violation reports (0 by default)
OPTIONS(10) = 0 no
OPTIONS(10) = 1 base case and worst case contingency viola-
tions only
OPTIONS(10) = 2 base case and all contingency violations only
OPTIONS(10) = 3 base case, worst case contingency, and all
contingency violations
OPTIONS(11) print voltage violation reports (0 by default)
OPTIONS(11) = 0 no
OPTIONS(11) = 1 base case and worst case contingency viola-
tions only
OPTIONS(11) = 2 base case and all contingency violations only
OPTIONS(11) = 3 base case, worst case contingency, and all
contingency violations
OPTIONS(12) option for processing interfaces in loading vi-
olation reports (1 by default)
OPTIONS(12) = 0 exclude interfaces from loading violation
checking and reporting
OPTIONS(12) = 1 check and report interface loading violations
OPTIONS(13) in loading violation reports, exclude mon-
itored branches and interfaces that show
loading violations in the base case from be-
ing checked and reported in contingency
case reports (0 by default)
OPTIONS(13) = 0 no
OPTIONS(13) = 1 yes
OPTIONS(14) in voltage range violation reports, exclude
monitored buses that show voltage range
violations in the base case from the corre-
sponding check in contingency case reports
(0 by default)
OPTIONS(14) = 0 no

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
9
Power Flow ACCC_MULTIPLE_RUN_REPORT

OPTIONS(14) = 1 yes
Real VALUES (7) array of 7 elements specifying reporting parameters(input).
VALUES(1) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
VALUES(2) system mismatch converged tolerance (MVA)
(5.0 by default)
VALUES(3) in loading violation reports, percent of flow
rating for reporting (100.0 by default)
VALUES(4) in the worst case contingency loading viola-
tion reports, percent of flow rating for count-
ing (> VALUES(3)) (100.0 by default)
VALUES(5) in loading violation reports, minimum con-
tingency case flow change from base case
value for reporting and counting (0.0 by de-
fault)
VALUES(6) in loading violation reports, minimum con-
tingency case percent loading increase from
base case value for reporting and counting
(0.0 by default)
VALUES(7) minimum contingency case voltage change
for reporting and counting in voltage range
violations (0.0 by default)
Integer NFILES number of Contingency Solution Output Files to be processed (1
through 22) (input; no default allowed).
Character*260 ACFILES (NFILES) NFILES names of Contingency Solution Output Files (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 invalid NFILES value
IERR = 4 the percent for counting is less than the per-
cent for reporting
IERR = 5 file is not in the form of a current Contin-
gency Solution Output File
IERR = 6 error opening a Contingency Solution Output
File
IERR = 7 error reading a Contingency Solution Output
File
IERR = 8 error opening a temporary file
IERR = 9 error opening a subfile in the temporary file
IERR = 10 error reading or writing the temporary file
IERR = 11 error closing a subfile in the temporary file
IERR = 12 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
10
Power Flow ACCC_MULTIPLE_RUN_REPORT_2

1.1.5. ACCC_MULTIPLE_RUN_REPORT_2
Use this API to report the results of up to twenty two executions of the AC Contingency Calculation func-
tion.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_ACCC_MULTIPLE_RUN_REPORT_2 OPTIONS(1)..OPTIONS(16)
VALUES(1)..VALUES(7) NFILES ACFILES(1)..ACFILES(NFILES)

Python command syntax:

ierr = accc_multiple_run_report_2(options, values, nfiles, acfiles)

Fortran command syntax:

CALL ACCC_MULTIPLE_RUN_REPORT_2(OPTIONS, VALUES, NFILES, ACFILES, IERR)

Where:

Integer OPTIONS (16) array of 16 elements specifying defining reporting options(input).

OPTIONS(1) column headings code (1 by default)
OPTIONS(1) = 1 Contingency Solution Output File names
OPTIONS(1) = 2 Saved Case File names as contained in the
Contingency Solution Output Files
OPTIONS(2) base case rating set (rating set program op-
tion setting by default)
OPTIONS(2) = 1 rate A
OPTIONS(2) = 2 rate B
OPTIONS(2) = 3 rate C
OPTIONS(3) contingency case rating set (rating set pro-
gram option setting by default)
OPTIONS(3) = 1 rate A
OPTIONS(3) = 2 rate B
OPTIONS(3) = 3 rate C
OPTIONS(4) base case voltage limit when STATUS(1) is 0,
1, 3 or 4
OPTIONS(4) = 1 normal limit
OPTIONS(4) = 2 emergency limit
OPTIONS(5) contingency case voltage limit when
STATUS(1) is 0, 1, 3 or 4
OPTIONS(5) = 1 normal limit
OPTIONS(5) = 2 emergency limit
OPTIONS(6) print monitored elements summary report (0
by default)
OPTIONS(6) = 0 no
OPTIONS(6) = 1 yes

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
11
Power Flow ACCC_MULTIPLE_RUN_REPORT_2

OPTIONS(7) print missing monitored elements report (0

by default)
OPTIONS(7) = 0 no
OPTIONS(7) = 1 yes
OPTIONS(8) print missing monitored voltage buses report
(0 by default)
OPTIONS(8) = 0 no
OPTIONS(8) = 1 yes
OPTIONS(9) print contingency legend (2 by default)
OPTIONS(9) = 0 no
OPTIONS(9) = 1 complete master legend report only
OPTIONS(9) = 2 reduced legend with each table
OPTIONS(9) = 3 both master legend report and legend with
each table
OPTIONS(10) print missing contingencies report (0 by de-
fault)
OPTIONS(10) = 0 no
OPTIONS(10) = 1 yes
OPTIONS(11) print non-converged contingencies report (0
by default)
OPTIONS(11) = 0 no
OPTIONS(11) = 1 yes
OPTIONS(12) print loading violation reports (0 by default)
OPTIONS(12) = 0 no
OPTIONS(12) = 1 base case and worst case contingency viola-
tions only
OPTIONS(12) = 2 base case and all contingency violations only
OPTIONS(12) = 3 base case, worst case contingency, and all
contingency violations
OPTIONS(13) print voltage violation reports (0 by default)
OPTIONS(13) = 0 no
OPTIONS(13) = 1 base case and worst case contingency viola-
tions only
OPTIONS(13) = 2 base case and all contingency violations only
OPTIONS(13) = 3 base case, worst case contingency, and all
contingency violations
OPTIONS(14) option for processing interfaces in loading vi-
olation reports (1 by default)
OPTIONS(14) = 0 exclude interfaces from loading violation
checking and reporting
OPTIONS(14) = 1 check and report interface loading violations
OPTIONS(15) in loading violation reports, exclude mon-
itored branches and interfaces that show
loading violations in the base case from be-

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
12
Power Flow ACCC_MULTIPLE_RUN_REPORT_2

ing checked and reported in contingency

case reports (0 by default)
OPTIONS(15) = 0 no
OPTIONS(15) = 1 yes
OPTIONS(16) in voltage range violation reports, exclude
monitored buses that show voltage range
violations in the base case from the corre-
sponding check in contingency case reports
(0 by default)
OPTIONS(16) = 0 no
OPTIONS(16) = 1 yes
Real VALUES (7) array of 7 elements specifying reporting parameters(input).
VALUES(1) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
VALUES(2) system mismatch converged tolerance (MVA)
(5.0 by default)
VALUES(3) in loading violation reports, percent of flow
rating for reporting (100.0 by default)
VALUES(4) in the worst case contingency loading viola-
tion reports, percent of flow rating for count-
ing (> VALUES(3)) (100.0 by default)
VALUES(5) in loading violation reports, minimum con-
tingency case flow change from base case
value for reporting and counting (0.0 by de-
fault)
VALUES(6) in loading violation reports, minimum con-
tingency case percent loading increase from
base case value for reporting and counting
(0.0 by default)
VALUES(7) minimum contingency case voltage change
for reporting and counting in voltage range
violations (0.0 by default)
Integer NFILES number of Contingency Solution Output Files to be processed (1
through 9) (input; no default allowed).
Character*260 ACFILES (NFILES) NFILES names of Contingency Solution Output Files (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 invalid NFILES value
IERR = 4 the percent for counting is less than the per-
cent for reporting
IERR = 5 file is not in the form of a current Contin-
gency Solution Output File

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
13
Power Flow ACCC_MULTIPLE_RUN_REPORT_2

IERR = 6 error opening a Contingency Solution Output

File
IERR = 7 error reading a Contingency Solution Output
File
IERR = 8 error opening a temporary file
IERR = 9 error opening a subfile in the temporary file
IERR = 10 error reading or writing the temporary file
IERR = 11 error closing a subfile in the temporary file
IERR = 12 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
14
Power Flow ACCC_PARALLEL

1.1.6. ACCC_PARALLEL
This API routine is obsolete. It has been replaced by the API routine accc_parallel_2 .

Use this API routine to run the initial release of the parallel implementation of the AC contingency calcula-
tion function (use ACCC_WITH_DSP_3 to run AC contingency calculation function serially). The API routine
distributes contingency cases among multiple processors evenly, and tests the contingency cases assigned
to each processor in parallel.

This API routine was first introduced in release 33.1.0.

Batch command syntax:

BAT_ACCC_PARALLEL TOL OPTACC(1)..OPTACC(10) LABEL DFXFILE ACCFILE THRFILE

INLFILE

Python command syntax:

ierr = accc_parallel(tol, optacc, label, dfxfile, accfile, thrfile,

inlfile)

Fortran command syntax:

CALL ACCC_PARALLEL(TOL, OPTACC, LABEL, DFXFILE, ACCFILE, THRFILE, INLFILE,

IERR)

Where:
Real TOL Is the mismatch tolerance (input; Newton solution convergence toler-
ance, TOLN, by default).
Integer OPTACC (10) array of elements specifying solution options. The values are as fol-
lows:(input).
OPTACC(1) tap adjustment flag. (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag. (area in-
terchange adjustment option setting by de-
fault)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag. (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag. (dc tap adjustment
option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
15
Power Flow ACCC_PARALLEL

OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag. (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag. (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag. (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage) (0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the stalled or
tripped state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the stalled or tripped state.
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Character*32 LABEL Is the name of the generation dispatch subsystem (blank by default,
no default allowed if OPTIONS(10) is not 0). (input).
Character*260 DFXFILE Is the name of the Distribution Factor Data file. (input; no default al-
lowed).
Character*260 ACCFILE Is the name of the Contingency Solution Output file. (input; no de-
fault allowed).
Character*260 THRFILE Is the name of the Load Throwover Data file. (input; blank by de-
fault).
Character*260 INLFILE Is the name of the Unit Inertia and Governor Data File. (input; blank
by default).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
16
Power Flow ACCC_PARALLEL

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 no Distribution Factor Data File specified
IERR = 9 no Contingency Solution Output File specified
IERR = 10 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 11 buses with bus type code and series element
status inconsistencies
IERR = 12 no ZIP Archive Output File specified
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 error opening Unit Inertia and Governor Data
File
IERR = 55 error opening ZIP Archive Output File
IERR = 56 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
17
Power Flow ACCC_PARALLEL_2

1.1.7. ACCC_PARALLEL_2
Use this API routine to run the second release of the parallel implementation of the AC contingency calcu-
lation function (use ACCC_WITH_DSP_3 to run AC contingency calculation function serially). The API rou-
tine distributes contingency cases among multiple processors evenly, and tests the contingency cases as-
signed to each processor in parallel.

This API routine was first introduced in release 33.4.0.

Batch command syntax:

BAT_ACCC_PARALLEL_2 TOL OPTACC(1)..OPTACC(11) LABEL DFXFILE ACCFILE

THRFILE INLFILE ZIPFILE

Python command syntax:

ierr = accc_parallel_2(tol, optacc, label, dfxfile, accfile, thrfile,

inlfile, zipfile)

Fortran command syntax:

CALL ACCC_PARALLEL_2(TOL, OPTACC, LABEL, DFXFILE, ACCFILE, THRFILE,

INLFILE, ZIPFILE, IERR)

Where:

Real TOL Is the mismatch tolerance (input; Newton solution convergence toler-
ance, TOLN, by default).
Integer OPTACC (11) array of elements specifying solution options. The values are as fol-
lows:(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
18
Power Flow ACCC_PARALLEL_2

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage) (0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
OPTACC(11) ZIP archive flag (0 by default)
OPTACC(11) = 0 do not write a ZIP archive file
OPTACC(11) = 1 write a ZIP archive using the file specified as
ZIPFILE
Character*32 LABEL Is the name of the generation dispatch subsystem (blank by default,
no default allowed if OPTIONS(10) is not 0) (input).
Character*260 DFXFILE Is the name of the Distribution Factor Data file (input; no default al-
lowed).
Character*260 ACCFILE Is the name of the Contingency Solution Output file (input; no de-
fault allowed).
Character*260 THRFILE Is the name of the Load Throwover Data file (input; blank by default).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
19
Power Flow ACCC_PARALLEL_2

Character*260 INLFILE Is the name of the Unit Inertia and Governor Data File (input; blank
by default).
Character*260 ZIPFILE Is the name of the ZIP Archive Output File (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 no Distribution Factor Data File specified
IERR = 9 no Contingency Solution Output File specified
IERR = 10 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 11 buses with bus type code and series element
status inconsistencies
IERR = 12 no ZIP Archive Output File specified
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 error opening Unit Inertia and Governor Data
File
IERR = 55 error opening ZIP Archive Output File
IERR = 56 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
20
Power Flow ACCC_SINGLE_RUN_REPORT

1.1.8. ACCC_SINGLE_RUN_REPORT
This API routine is obsolete. It has been replaced by the API routine accc_single_run_report_2 .

Use this API, the AC Contingency Report function, to report the results of the AC Contingency Calculation
function.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_ACCC_SINGLE_RUN_REPORT STATUS(1)..STATUS(8) INTVAL(1)..INTVAL(5)

REALVAL(1)..REALVAL(7) RFILE

Python command syntax:

ierr = accc_single_run_report(status, intval, realval, rfile)

Fortran command syntax:

CALL ACCC_SINGLE_RUN_REPORT(STATUS, INTVAL, REALVAL, RFILE, IERR)

Where:
Integer STATUS (8) array of 8 elements specifying (input).
STATUS(1) report format (3 by default)
STATUS(1) = 0 spreadsheet overload report
STATUS(1) = 1 spreadsheet loading table
STATUS(1) = 2 available capacity table
STATUS(1) = 3 non-spreadsheet overload report
STATUS(1) = 4 non-spreadsheet loading table
STATUS(1) = 5 non-converged networks report
STATUS(2) base case rating set; used only when
STATUS(1) is 0, 1, 3 or 4 (rating set program
option setting by default)
STATUS(2) = 1 rate A
STATUS(2) = 2 rate B
STATUS(2) = 3 rate C
STATUS(3) contingency case rating set when STATUS(1)
is 0, 1, 3 or 4; base case and contingency
case rating set when STATUS(1) is 2 (rating
set program option setting by default)
STATUS(3) = 1 rate A
STATUS(3) = 2 rate B
STATUS(3) = 3 rate C
STATUS(4) exclude interfaces from report; used only
when STATUS(1) is 0, 1, 2, 3 or 4 (0 by de-
fault)
STATUS(4) = 0 no
STATUS(4) = 1 yes

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
21
Power Flow ACCC_SINGLE_RUN_REPORT

STATUS(5) run voltage limit check; used only when

STATUS(1) is 0, 1, 3 or 4 (0 by default)
STATUS(5) = 0 no
STATUS(5) = 1 yes
STATUS(6) in overload reports, exclude monitored
branches and interfaces that show load-
ing violations in the base case from being
checked and reported in contingency cases;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(6) = 0 no
STATUS(6) = 1 yes
STATUS(7) in voltage range violation reports, exclude
monitored buses that show voltage range
violations in the base case from the corre-
sponding check in contingency case reports;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(7) = 0 no
STATUS(7) = 1 yes
STATUS(8) exclude cases with no overloads from non-
spreadsheet overload report; used only when
STATUS(1) is 3 (0 by default)
STATUS(8) = 0 no
STATUS(8) = 1 yes
Integer INTVAL (5) array of 5 elements specifying (input).
INTVAL(1) number of low voltage range violations filter-
ing criterion (0 by default)
INTVAL(2) number of high voltage range violations fil-
tering criterion (0 by default)
INTVAL(3) number of voltage deviation violations filter-
ing criterion; not applied to base case (0 by
default)
INTVAL(4) number of buses in the largest disconnected
island filtering criterion; not applied to base
case (0 by default)
INTVAL(5) maximum number of elements in the avail-
able capacity table (no limit by default)
Real REALVAL (7) array of 7 elements specifying (input).
REALVAL(1) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
REALVAL(2) system mismatch converged tolerance (MVA)
(5.0 by default)
REALVAL(3) percent of flow rating; used only when
STATUS(1) is 0, 3 or 4 (100.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
22
Power Flow ACCC_SINGLE_RUN_REPORT

REALVAL(4) in overload reports, minimum contingency

case flow change from base case value; used
only when STATUS(1) is 0 or 3 (0.0 by de-
fault)
REALVAL(5) in overload reports, minimum contingency
case percent loading increase from base case
value; used only when STATUS(1) is 0 or 3
(0.0 by default)
REALVAL(6) in voltage range violation reports, minimum
contingency case voltage change from base
case value; used only when STATUS(1) is 0,
1, 3 or 4 (0.0 by default)
REALVAL(7) cutoff threshold for available capacity table;
used only when STATUS(1) is 2 (99999.0 by
default)
Character*260 RFILE Contingency Solution Output File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 invalid INTVAL value
IERR = 3 invalid REALVAL value
IERR = 4 error opening RFILE
IERR = 5 error reading RFILE
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
23
Power Flow ACCC_SINGLE_RUN_REPORT_2

1.1.9. ACCC_SINGLE_RUN_REPORT_2
This API routine is obsolete. It has been replaced by the API routine accc_single_run_report_3 .

This API is the second release of the AC Contingency Report function. Use this API to report the results of
the AC Contingency Calculation function.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_ACCC_SINGLE_RUN_REPORT_2 STATUS(1)..STATUS(9) INTVAL(1)..INTVAL(5)

REALVAL(1)..REALVAL(7) RFILE

Python command syntax:

ierr = accc_single_run_report_2(status, intval, realval, rfile)

Fortran command syntax:

CALL ACCC_SINGLE_RUN_REPORT_2(STATUS, INTVAL, REALVAL, RFILE, IERR)

Where:
Integer STATUS (9) array of 9 elements specifying (input).
STATUS(1) report format (3 by default)
STATUS(1) = 0 spreadsheet overload report
STATUS(1) = 1 spreadsheet loading table
STATUS(1) = 2 available capacity table
STATUS(1) = 3 non-spreadsheet overload report
STATUS(1) = 4 non-spreadsheet loading table
STATUS(1) = 5 non-converged networks report
STATUS(1) = 6 non-spreadsheet corrective actions report
STATUS(2) base case rating set; used only when
STATUS(1) is 0, 1, 3 or 4 (rating set program
option setting by default)
STATUS(2) = 1 rate A
STATUS(2) = 2 rate B
STATUS(2) = 3 rate C
STATUS(3) contingency case rating set when STATUS(1)
is 0, 1, 3 or 4; base case and contingency
case rating set when STATUS(1) is 2 (rating
set program option setting by default)
STATUS(3) = 1 rate A
STATUS(3) = 2 rate B
STATUS(3) = 3 rate C
STATUS(4) exclude interfaces from report; used only
when STATUS(1) is 0, 1, 2, 3, 4 (0 by default)
STATUS(4) = 0 no
STATUS(4) = 1 yes

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
24
Power Flow ACCC_SINGLE_RUN_REPORT_2

STATUS(5) run voltage limit check; used only when

STATUS(1) is 0, 1, 3, 4 (0 by default)
STATUS(5) = 0 no
STATUS(5) = 1 yes
STATUS(6) in overload reports, exclude monitored
branches and interfaces that show load-
ing violations in the base case from being
checked and reported in contingency cases;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(6) = 0 no
STATUS(6) = 1 yes
STATUS(7) in voltage range violation reports, exclude
monitored buses that show voltage range
violations in the base case from the corre-
sponding check in contingency case reports;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(7) = 0 no
STATUS(7) = 1 yes
STATUS(8) exclude cases with no overloads from non-
spreadsheet overload report or non-spread-
sheet corrective actions report; used only
when STATUS(1) is 3 (0 by default)
STATUS(8) = 0 no
STATUS(8) = 1 yes
STATUS(9) report post-tripping action solutions (0 by
default)
STATUS(9) = 0 no
STATUS(9) = 1 yes
Integer INTVAL (5) array of 5 elements specifying (input).
INTVAL(1) number of low voltage range violations filter-
ing criterion (0 by default)
INTVAL(2) number of high voltage range violations fil-
tering criterion (0 by default)
INTVAL(3) number of voltage deviation violations filter-
ing criterion; not applied to base case (0 by
default)
INTVAL(4) number of buses in the largest disconnected
island filtering criterion; not applied to base
case (0 by default)
INTVAL(5) maximum number of elements in the avail-
able capacity table (no limit by default)
Real REALVAL (7) array of 7 elements specifying (input).
REALVAL(1) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
25
Power Flow ACCC_SINGLE_RUN_REPORT_2

REALVAL(2) system mismatch converged tolerance (MVA)

(5.0 by default)
REALVAL(3) percent of flow rating; used only when
STATUS(1) is 0, 3 or 4 (100.0 by default)
REALVAL(4) in overload reports, minimum contingency
case flow change from base case value; used
only when STATUS(1) is 0 or 3 (0.0 by de-
fault)
REALVAL(5) in overload reports, minimum contingency
case percent loading increase from base case
value; used only when STATUS(1) is 0 or 3
(0.0 by default)
REALVAL(6) in voltage range violation reports, minimum
contingency case voltage change from base
case value; used only when STATUS(1) is 0,
1, 3 or 4 (0.0 by default)
REALVAL(7) cutoff threshold for available capacity table;
used only when STATUS(1) is 2 (99999.0 by
default)
Character*260 RFILE Contingency Solution Output File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 invalid INTVAL value
IERR = 3 invalid REALVAL value
IERR = 4 error opening RFILE
IERR = 5 error reading RFILE
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
26
Power Flow ACCC_SINGLE_RUN_REPORT_3

1.1.10. ACCC_SINGLE_RUN_REPORT_3
This API routine is obsolete. It has been replaced by the API routine accc_single_run_report_4 .

This API is the third release of the AC Contingency Report function. Use this API to report the results of the
AC Contingency Calculation function.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_ACCC_SINGLE_RUN_REPORT_3 STATUS(1)..STATUS(10) INTVAL(1)..INTVAL(5)

REALVAL(1)..REALVAL(7) RFILE

Python command syntax:

ierr = accc_single_run_report_3(status, intval, realval, rfile)

Fortran command syntax:

CALL ACCC_SINGLE_RUN_REPORT_3(STATUS, INTVAL, REALVAL, RFILE, IERR)

Where:
Integer STATUS (10) array of 10 elements specifying (input).
STATUS(1) report format (3 by default)
STATUS(1) = 0 spreadsheet overload report
STATUS(1) = 1 spreadsheet loading table
STATUS(1) = 2 available capacity table
STATUS(1) = 3 non-spreadsheet overload report
STATUS(1) = 4 non-spreadsheet loading table
STATUS(1) = 5 non-converged networks report
STATUS(1) = 6 non-spreadsheet corrective actions report
STATUS(2) base case rating set; used only when
STATUS(1) is 0, 1, 3 or 4 (rating set program
option setting by default)
STATUS(2) = 1 rate A
STATUS(2) = 2 rate B
STATUS(2) = 3 rate C
STATUS(3) contingency case rating set when STATUS(1)
is 0, 1, 3 or 4; base case and contingency
case rating set when STATUS(1) is 2 (rating
set program option setting by default)
STATUS(3) = 1 rate A
STATUS(3) = 2 rate B
STATUS(3) = 3 rate C
STATUS(4) exclude interfaces from report; used only
when STATUS(1) is 0, 1, 2, 3, 4 (0 by default)
STATUS(4) = 0 no
STATUS(4) = 1 yes

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
27
Power Flow ACCC_SINGLE_RUN_REPORT_3

STATUS(5) run voltage limit check; used only when

STATUS(1) is 0, 1, 3, 4 (0 by default)
STATUS(5) = 0 no
STATUS(5) = 1 yes
STATUS(6) in overload reports, exclude monitored
branches and interfaces that show load-
ing violations in the base case from being
checked and reported in contingency cases;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(6) = 0 no
STATUS(6) = 1 yes
STATUS(7) in voltage range violation reports, exclude
monitored buses that show voltage range
violations in the base case from the corre-
sponding check in contingency case reports;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(7) = 0 no
STATUS(7) = 1 yes
STATUS(8) exclude cases with no overloads from non-
spreadsheet overload report or non-spread-
sheet corrective actions report; used only
when STATUS(1) is 3 (0 by default)
STATUS(8) = 0 no
STATUS(8) = 1 yes
STATUS(9) report post-tripping action solutions (0 by
default)
STATUS(9) = 0 no
STATUS(9) = 1 yes
STATUS(10) report loss of loads (0 by default)
STATUS(10) = 0 no
STATUS(10) = 1 yes
Integer INTVAL (5) array of 5 elements specifying (input).
INTVAL(1) number of low voltage range violations filter-
ing criterion (0 by default)
INTVAL(2) number of high voltage range violations fil-
tering criterion (0 by default)
INTVAL(3) number of voltage deviation violations filter-
ing criterion; not applied to base case (0 by
default)
INTVAL(4) number of buses in the largest disconnected
island filtering criterion; not applied to base
case (0 by default)
INTVAL(5) maximum number of elements in the avail-
able capacity table (no limit by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
28
Power Flow ACCC_SINGLE_RUN_REPORT_3

Real REALVAL (7) array of 7 elements specifying (input).

REALVAL(1) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
REALVAL(2) system mismatch converged tolerance (MVA)
(5.0 by default)
REALVAL(3) percent of flow rating; used only when
STATUS(1) is 0, 3 or 4 (100.0 by default)
REALVAL(4) in overload reports, minimum contingency
case flow change from base case value; used
only when STATUS(1) is 0 or 3 (0.0 by de-
fault)
REALVAL(5) in overload reports, minimum contingency
case percent loading increase from base case
value; used only when STATUS(1) is 0 or 3
(0.0 by default)
REALVAL(6) in voltage range violation reports, minimum
contingency case voltage change from base
case value; used only when STATUS(1) is 0,
1, 3 or 4 (0.0 by default)
REALVAL(7) cutoff threshold for available capacity table;
used only when STATUS(1) is 2 (99999.0 by
default)
Character*260 RFILE Contingency Solution Output File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 invalid INTVAL value
IERR = 3 invalid REALVAL value
IERR = 4 error opening RFILE
IERR = 5 error reading RFILE
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
29
Power Flow ACCC_SINGLE_RUN_REPORT_4

1.1.11. ACCC_SINGLE_RUN_REPORT_4
This API is the fourth release of the AC Contingency Report function. Use this API to report the results of
the AC Contingency Calculation function.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_ACCC_SINGLE_RUN_REPORT_4 STATUS(1)..STATUS(12) INTVAL(1)..INTVAL(5)

REALVAL(1)..REALVAL(7) RFILE

Python command syntax:

ierr = accc_single_run_report_4(status, intval, realval, rfile)

Fortran command syntax:

CALL ACCC_SINGLE_RUN_REPORT_4(STATUS, INTVAL, REALVAL, RFILE, IERR)

Where:
Integer STATUS (12) array of 12 elements specifying (input).
STATUS(1) report format (3 by default)
STATUS(1) = 0 spreadsheet overload report
STATUS(1) = 1 spreadsheet loading table
STATUS(1) = 2 available capacity table
STATUS(1) = 3 non-spreadsheet overload report
STATUS(1) = 4 non-spreadsheet loading table
STATUS(1) = 5 non-converged networks report
STATUS(1) = 6 non-spreadsheet corrective actions report
STATUS(2) base case rating set; used only when
STATUS(1) is 0, 1, 3 or 4 (rating set program
option setting by default)
STATUS(2) = 1 rate A
STATUS(2) = 2 rate B
STATUS(2) = 3 rate C
STATUS(3) contingency case rating set when STATUS(1)
is 0, 1, 3 or 4; base case and contingency
case rating set when STATUS(1) is 2 (rating
set program option setting by default)
STATUS(3) = 1 rate A
STATUS(3) = 2 rate B
STATUS(3) = 3 rate C
STATUS(4) base case voltage limit when STATUS(1) is 0,
1, 3 or 4
STATUS(4) = 1 normal limit
STATUS(4) = 2 emergency limit
STATUS(5) contingency case voltage limit when
STATUS(1) is 0, 1, 3 or 4

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
30
Power Flow ACCC_SINGLE_RUN_REPORT_4

STATUS(5) = 1 normal limit

STATUS(5) = 2 emergency limit
STATUS(6) exclude interfaces from report; used only
when STATUS(1) is 0, 1, 2, 3, 4 (0 by default)
STATUS(6) = 0 no
STATUS(6) = 1 yes
STATUS(7) run voltage limit check; used only when
STATUS(1) is 0, 1, 3, 4 (0 by default)
STATUS(7) = 0 no
STATUS(7) = 1 yes
STATUS(8) in overload reports, exclude monitored
branches and interfaces that show load-
ing violations in the base case from being
checked and reported in contingency cases;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(8) = 0 no
STATUS(8) = 1 yes
STATUS(9) in voltage range violation reports, exclude
monitored buses that show voltage range
violations in the base case from the corre-
sponding check in contingency case reports;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(9) = 0 no
STATUS(9) = 1 yes
STATUS(10) exclude cases with no overloads from non-
spreadsheet overload report or non-spread-
sheet corrective actions report; used only
when STATUS(1) is 3 (0 by default)
STATUS(10) = 0 no
STATUS(10) = 1 yes
STATUS(11) report post-tripping action solutions (0 by
default)
STATUS(11) = 0 no
STATUS(11) = 1 yes
STATUS(12) report loss of loads (0 by default)
STATUS(12) = 0 no
STATUS(12) = 1 yes
Integer INTVAL (5) array of 5 elements specifying (input).
INTVAL(1) number of low voltage range violations filter-
ing criterion (0 by default)
INTVAL(2) number of high voltage range violations fil-
tering criterion (0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
31
Power Flow ACCC_SINGLE_RUN_REPORT_4

INTVAL(3) number of voltage deviation violations filter-

ing criterion; not applied to base case (0 by
default)
INTVAL(4) number of buses in the largest disconnected
island filtering criterion; not applied to base
case (0 by default)
INTVAL(5) maximum number of elements in the avail-
able capacity table (no limit by default)
Real REALVAL (7) array of 7 elements specifying (input).
REALVAL(1) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
REALVAL(2) system mismatch converged tolerance (MVA)
(5.0 by default)
REALVAL(3) percent of flow rating; used only when
STATUS(1) is 0, 3 or 4 (100.0 by default)
REALVAL(4) in overload reports, minimum contingency
case flow change from base case value; used
only when STATUS(1) is 0 or 3 (0.0 by de-
fault)
REALVAL(5) in overload reports, minimum contingency
case percent loading increase from base case
value; used only when STATUS(1) is 0 or 3
(0.0 by default)
REALVAL(6) in voltage range violation reports, minimum
contingency case voltage change from base
case value; used only when STATUS(1) is 0,
1, 3 or 4 (0.0 by default)
REALVAL(7) cutoff threshold for available capacity table;
used only when STATUS(1) is 2 (99999.0 by
default)
Character*260 RFILE Contingency Solution Output File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 invalid INTVAL value
IERR = 3 invalid REALVAL value
IERR = 4 error opening RFILE
IERR = 5 error reading RFILE
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
32
Power Flow ACCC_SINGLE_RUN_REPORT_5

1.1.12. ACCC_SINGLE_RUN_REPORT_5
This API is the fourth release of the AC Contingency Report function. Use this API to report the results of
the AC Contingency Calculation function.

This API routine was first introduced in release 34.5.0.

Batch command syntax:

BAT_ACCC_SINGLE_RUN_REPORT_5 STATUS(1)..STATUS(14) INTVAL(1)..INTVAL(5)

REALVAL(1)..REALVAL(7) RFILE

Python command syntax:

ierr = accc_single_run_report_5(status, intval, realval, rfile)

Fortran command syntax:

CALL ACCC_SINGLE_RUN_REPORT_5(STATUS, INTVAL, REALVAL, RFILE, IERR)

Where:
Integer STATUS (14) array of 14 elements specifying (input).
STATUS(1) report format (3 by default)
STATUS(1) = 0 spreadsheet overload report
STATUS(1) = 1 spreadsheet loading table
STATUS(1) = 2 available capacity table
STATUS(1) = 3 non-spreadsheet overload report
STATUS(1) = 4 non-spreadsheet loading table
STATUS(1) = 5 non-converged networks report
STATUS(1) = 6 non-spreadsheet corrective actions report
STATUS(2) base case branch rating set; used only when
STATUS(1) is 0, 1, 3 or 4 (rating set program
option setting by default)
STATUS(2) = 1 rate 1
STATUS(2) = 2 rate 2
STATUS(2) = 3 rate 3
STATUS(2) = 4 rate 4
STATUS(2) = 5 rate 5
STATUS(2) = 6 rate 6
STATUS(2) = 7 rate 7
STATUS(2) = 8 rate 8
STATUS(2) = 9 rate 9
STATUS(2) = 10 rate 10
STATUS(2) = 11 rate 11
STATUS(2) = 12 rate 12
STATUS(3) contingency case branch rating set when
STATUS(1) is 0, 1, 3 or 4; base case and con-
tingency case rating set when STATUS(1) is 2
(rating set program option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
33
Power Flow ACCC_SINGLE_RUN_REPORT_5

STATUS(3) = 1 rate 1
STATUS(3) = 2 rate 2
STATUS(3) = 3 rate 3
STATUS(3) = 4 rate 4
STATUS(3) = 5 rate 5
STATUS(3) = 6 rate 6
STATUS(3) = 7 rate 7
STATUS(3) = 8 rate 8
STATUS(3) = 9 rate 9
STATUS(3) = 10 rate 10
STATUS(3) = 11 rate 11
STATUS(3) = 12 rate 12
STATUS(4) base case SWD rating set; used only when
STATUS(1) is 0, 1, 3 or 4 (rating set program
option setting by default)
STATUS(4) = 1 rate 1
STATUS(4) = 2 rate 2
STATUS(4) = 3 rate 3
STATUS(5) contingency case SWD rating set when
STATUS(1) is 0, 1, 3 or 4; base case and con-
tingency case rating set when STATUS(1) is 2
(rating set program option setting by default)
STATUS(5) = 1 rate 1
STATUS(5) = 2 rate 2
STATUS(5) = 3 rate 3
STATUS(6) base case voltage limit when STATUS(1) is 0,
1, 3 or 4
STATUS(6) = 1 normal limit
STATUS(6) = 2 emergency limit
STATUS(7) contingency case voltage limit when
STATUS(1) is 0, 1, 3 or 4
STATUS(7) = 1 normal limit
STATUS(7) = 2 emergency limit
STATUS(8) exclude interfaces from report; used only
when STATUS(1) is 0, 1, 2, 3, 4 (0 by default)
STATUS(8) = 0 no
STATUS(8) = 1 yes
STATUS(9) run voltage limit check; used only when
STATUS(1) is 0, 1, 3, 4 (0 by default)
STATUS(9) = 0 no
STATUS(9) = 1 yes
STATUS(10) in overload reports, exclude monitored
branches and interfaces that show load-
ing violations in the base case from being
checked and reported in contingency cases;

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
34
Power Flow ACCC_SINGLE_RUN_REPORT_5

used only when STATUS(1) is 0 or 3 (0 by de-

fault)
STATUS(10) = 0 no
STATUS(10) = 1 yes
STATUS(11) in voltage range violation reports, exclude
monitored buses that show voltage range
violations in the base case from the corre-
sponding check in contingency case reports;
used only when STATUS(1) is 0 or 3 (0 by de-
fault)
STATUS(11) = 0 no
STATUS(11) = 1 yes
STATUS(12) exclude cases with no overloads from non-
spreadsheet overload report or non-spread-
sheet corrective actions report; used only
when STATUS(1) is 3 (0 by default)
STATUS(12) = 0 no
STATUS(12) = 1 yes
STATUS(13) report post-tripping action solutions (0 by
default)
STATUS(13) = 0 no
STATUS(13) = 1 yes
STATUS(14) report loss of loads (0 by default)
STATUS(14) = 0 no
STATUS(14) = 1 yes
Integer INTVAL (5) array of 5 elements specifying (input).
INTVAL(1) number of low voltage range violations filter-
ing criterion (0 by default)
INTVAL(2) number of high voltage range violations fil-
tering criterion (0 by default)
INTVAL(3) number of voltage deviation violations filter-
ing criterion; not applied to base case (0 by
default)
INTVAL(4) number of buses in the largest disconnected
island filtering criterion; not applied to base
case (0 by default)
INTVAL(5) maximum number of elements in the avail-
able capacity table (no limit by default)
Real REALVAL (7) array of 7 elements specifying (input).
REALVAL(1) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
REALVAL(2) system mismatch converged tolerance (MVA)
(5.0 by default)
REALVAL(3) percent of flow rating; used only when
STATUS(1) is 0, 3 or 4 (100.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
35
Power Flow ACCC_SINGLE_RUN_REPORT_5

REALVAL(4) in overload reports, minimum contingency

case flow change from base case value; used
only when STATUS(1) is 0 or 3 (0.0 by de-
fault)
REALVAL(5) in overload reports, minimum contingency
case percent loading increase from base case
value; used only when STATUS(1) is 0 or 3
(0.0 by default)
REALVAL(6) in voltage range violation reports, minimum
contingency case voltage change from base
case value; used only when STATUS(1) is 0,
1, 3 or 4 (0.0 by default)
REALVAL(7) cutoff threshold for available capacity table;
used only when STATUS(1) is 2 (99999.0 by
default)
Character*260 RFILE Contingency Solution Output File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 invalid INTVAL value
IERR = 3 invalid REALVAL value
IERR = 4 error opening RFILE
IERR = 5 error reading RFILE
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
36
Power Flow ACCC_TRIP_COR

1.1.13. ACCC_TRIP_COR
This API routine is obsolete. It has been replaced by the API routine accc_trip_cor_2 .

Use this API to apply the AC contingency calculation with tripping simulations and corrective actions. When
there are violations in the post-tripping simulation solutions, the corrections actions analysis is launched
to eliminate the violations, with the objective of minimizing the controls adjustments, including load shed-
ding, MW generation dispatch and phase shifter angle adjustments. Rating set program option setting and
100.0 percent of rating set are used to check branch and interface flow overload violations.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_ACCC_TRIP_COR TOL OPTACC(1)..OPTACC(8) OPTTRP(1)..OPTTRP(3)

OPTCOR(1)..OPTCOR(5) VALUES(1)..VALUES(5) LABELS(1)..LABELS(4) DFXFILE
ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = accc_trip_cor(tol, optacc, opttrp, optcor, values, labels, dfxfile,

accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL ACCC_TRIP_COR(TOL, OPTACC, OPTTRP, OPTCOR, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
37
Power Flow ACCC_TRIP_COR

OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Integer OPTCOR (5) array of 5 elements specifying corrective actions options(input).
OPTCOR(1) run corrective actions (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number of power flow solutions (from 0 to
10, 1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
38
Power Flow ACCC_TRIP_COR

OPTCOR(5) = 1 enable
Real VALUES (5) array of 5 elements specifying corrective actions parameters(input).
VALUES(1) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(2) branch flow overload tolerance (0.1 by de-
fault)
VALUES(3) generator control weighting factor (1.0 by
default)
VALUES(4) load control weighting factor (1.0 by default)
VALUES(5) phase shifter control weighting factor (1.0 by
default)
Character*32 LABELS (4) array of 4 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(3) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(4) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTTRP value
IERR = 9 invalid OPTCOR value

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
39
Power Flow ACCC_TRIP_COR

IERR = 10 invalid VALUES value

IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
40
Power Flow ACCC_TRIP_COR_2

1.1.14. ACCC_TRIP_COR_2
This API routine is obsolete. It has been replaced by the API routine accc_trip_cor_3 .

This API is the second release of the function to run AC contingency analysis with tripping simulation and
corrective actions. Following a post contingency solution, trip events are simulated if their tripping condi-
tions are satisfied. Corrective actions are then specified automatically to eliminate the violations in each
post tripping solution with the objective of minimizing the control adjustments including load shedding,
MW generation dispatch, phase shifter angle adjustments, off-line generator controls, tap setting adjust-
ments and switched shunt controls. Please note that flows are checked against rating set program option
setting and 100.0 percent of the rating to determine flow overload violations.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_ACCC_TRIP_COR_2 TOL OPTACC(1)..OPTACC(8) OPTTRP(1)..OPTTRP(3)

OPTCOR(1)..OPTCOR(8) VALUES(1)..VALUES(8) LABELS(1)..LABELS(7) DFXFILE
ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = accc_trip_cor_2(tol, optacc, opttrp, optcor, values, labels,

dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL ACCC_TRIP_COR_2(TOL, OPTACC, OPTTRP, OPTCOR, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
41
Power Flow ACCC_TRIP_COR_2

OPTACC(4) dc tap adjustment flag (dc tap adjustment

option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (RESERVE)
OPTACC(8) = 2 subsystem machines (PMAX)
OPTACC(8) = 3 subsystem machines (INERTIA)
OPTACC(8) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number of power flow solutions (1 by de-
fault)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
42
Power Flow ACCC_TRIP_COR_2

OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (8) array of 8 elements specifying corrective actions parameters(input).
VALUES(1) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(2) branch overload violation tolerance (0.1 by
default)
VALUES(3) generator control weighting factor (1.0 by
default)
VALUES(4) load control weighting factor (1.0 by default)
VALUES(5) phase shifter control weighting factor (1.0 by
default)
VALUES(6) off-line generator control weighting factor
(1.0 by default)
VALUES(7) tap setting adjustment weighting factor (1.0
by default)
VALUES(8) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (7) array of 7 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(3) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(4) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
LABELS(5) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(6) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
43
Power Flow ACCC_TRIP_COR_2

LABELS(7) switched shunt control subsystem (blank by

default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Character*260 TRPFILE name of Tripping Element Data File (input; blank for none; no default
allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTTRP value
IERR = 9 invalid OPTCOR value
IERR = 10 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
44
Power Flow ACCC_TRIP_COR_3

1.1.15. ACCC_TRIP_COR_3
This API is the third release of the function to run AC contingency analysis with tripping simulation and cor-
rective actions. Following a post contingency solution, trip events are simulated if their tripping conditions
are satisfied. Corrective actions are then specified automatically to eliminate the violations in each post
tripping solution with the objective of minimizing the control adjustments including load shedding, MW
generation dispatch, phase shifter angle adjustments, off-line generator controls, tap setting adjustments
and switched shunt controls. Please note that flows are checked against rating set program option setting
and 100.0 percent of the rating to determine flow overload violations.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_ACCC_TRIP_COR_3 TOL OPTACC(1)..OPTACC(10) OPTTRP(1)..OPTTRP(3)

OPTCOR(1)..OPTCOR(8) VALUES(1)..VALUES(8) LABELS(1)..LABELS(7) DFXFILE
ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = accc_trip_cor_3(tol, optacc, opttrp, optcor, values, labels,

dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL ACCC_TRIP_COR_3(TOL, OPTACC, OPTTRP, OPTCOR, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
45
Power Flow ACCC_TRIP_COR_3

OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (RESERVE)
OPTACC(10) = 2 subsystem machines (PMAX)
OPTACC(10) = 3 subsystem machines (INERTIA)
OPTACC(10) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
46
Power Flow ACCC_TRIP_COR_3

OPTCOR(1) = 1 enable
OPTCOR(2) number of power flow solutions (1 by de-
fault)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (8) array of 8 elements specifying corrective actions parameters(input).
VALUES(1) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(2) branch overload violation tolerance (0.1 by
default)
VALUES(3) generator control weighting factor (1.0 by
default)
VALUES(4) load control weighting factor (1.0 by default)
VALUES(5) phase shifter control weighting factor (1.0 by
default)
VALUES(6) off-line generator control weighting factor
(1.0 by default)
VALUES(7) tap setting adjustment weighting factor (1.0
by default)
VALUES(8) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (7) array of 7 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
47
Power Flow ACCC_TRIP_COR_3

LABELS(3) label of load control subsystem (blank by de-

fault, no default allowed if OPTCOR(4) is 1)
LABELS(4) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
LABELS(5) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(6) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(7) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Character*260 TRPFILE name of Tripping Element Data File (input; blank for none; no default
allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTTRP value
IERR = 11 invalid OPTCOR value
IERR = 12 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
48
Power Flow ACCC_TRIP_COR_3

IERR = 52 error opening Distribution Factor Data File

IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
49
Power Flow ACCC_WITH_COR

1.1.16. ACCC_WITH_COR
This API routine is obsolete. It has been replaced by the API routine accc_with_cor_2 .

Use this API to apply the AC contingency calculation with corrective actions. When there are violations in
the post-contingency solutions, the corrections actions analysis is launched to eliminate the violations,
with the objective of minimizing the controls adjustments, including load shedding, MW generation dis-
patch, and phase shifter angle adjustments. Rating set program option setting and 100.0 percent of the
rating set are used to check branch and interface flow overload violations.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_ACCC_WITH_COR TOL OPTACC(1)..OPTACC(8) OPTCOR(1)..OPTCOR(5)

VALUES(1)..VALUES(5) LABELS(1)..LABELS(4) DFXFILE ACCFILE THRFILE
INLFILE

Python command syntax:

ierr = accc_with_cor(tol, optacc, optcor, values, labels, dfxfile,

accfile, thrfile, inlfile)

Fortran command syntax:

CALL ACCC_WITH_COR(TOL, OPTACC, OPTCOR, VALUES, LABELS, DFXFILE, ACCFILE,

THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
50
Power Flow ACCC_WITH_COR

OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Integer OPTCOR (5) array of 5 elements specifying corrective actions options(input).
OPTCOR(1) run corrective actions (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number of power flow solutions (from 0 to
10, 1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load curtailment flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
Real VALUES (5) array of 5 elements specifying corrective actions parameters(input).
VALUES(1) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(2) branch flow overload tolerance (0.1 by de-
fault)
VALUES(3) generator control weighting factor (1.0 by
default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
51
Power Flow ACCC_WITH_COR

VALUES(4) load control weighting factor (1.0 by default)

VALUES(5) phase shifter control weighting factor (1.0 by
default)
Character*32 LABELS (4) array of 4 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(3) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(4) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTCOR value
IERR = 9 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
52
Power Flow ACCC_WITH_COR

IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
53
Power Flow ACCC_WITH_COR_2

1.1.17. ACCC_WITH_COR_2
This API routine is obsolete. It has been replaced by the API routine accc_with_cor_3 .

This API is the second release of function to run AC contingency analysis with corrective actions. Correc-
tive actions are specified automatically to eliminate the violations in each post contingency solution with
the objective of minimizing the controls adjustments including load shedding, MW generation dispatch,
phase shifter angle adjustments, off-line generator controls, tap setting adjustments and switched shunt
controls. Please note that flows are checked against rating set program option setting and 100.0 percent of
the rating to determine flow overload violations.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_ACCC_WITH_COR_2 TOL OPTACC(1)..OPTACC(8) OPTCOR(1)..OPTCOR(8)

VALUES(1)..VALUES(8) LABELS(1)..LABELS(7) DFXFILE ACCFILE THRFILE
INLFILE

Python command syntax:

ierr = accc_with_cor_2(tol, optacc, optcor, values, labels, dfxfile,

accfile, thrfile, inlfile)

Fortran command syntax:

CALL ACCC_WITH_COR_2(TOL, OPTACC, OPTCOR, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, IERR)

Where:

Real TOL mismatch tolerance (input; Newton solution convergence tolerance,

TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
54
Power Flow ACCC_WITH_COR_2

OPTACC(4) dc tap adjustment flag (dc tap adjustment

option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (RESERVE)
OPTACC(8) = 2 subsystem machines (PMAX)
OPTACC(8) = 3 subsystem machines (INERTIA)
OPTACC(8) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective actions (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number of power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
55
Power Flow ACCC_WITH_COR_2

OPTCOR(8) switched shunt control flag (0 by default)

OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (8) array of 8 elements specifying corrective actions parameters(input).
VALUES(1) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(2) branch overload violation tolerance (0.1 by
default)
VALUES(3) generator control weighting factor (1.0 by
default)
VALUES(4) load control weighting factor (1.0 by default)
VALUES(5) phase shifter control weighting factor (1.0 by
default)
VALUES(6) off-line generator control weighting factor
(1.0 by default)
VALUES(7) tap setting adjustment weighting factor (1.0
by default)
VALUES(8) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (7) array of 7 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(3) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(4) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
LABELS(5) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(6) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(7) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 no error occurred

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
56
Power Flow ACCC_WITH_COR_2

IERR = 1 invalid TOL value

IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTCOR value
IERR = 9 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
57
Power Flow ACCC_WITH_COR_3

1.1.18. ACCC_WITH_COR_3
This API is the third release of function to run AC contingency analysis with corrective actions. Corrective
actions are specified automatically to eliminate the violations in each post contingency solution with the
objective of minimizing the controls adjustments including load shedding, MW generation dispatch, phase
shifter angle adjustments, off-line generator controls, tap setting adjustments and switched shunt con-
trols. Please note that flows are checked against rating set program option setting and 100.0 percent of
the rating to determine flow overload violations.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_ACCC_WITH_COR_3 TOL OPTACC(1)..OPTACC(10) OPTCOR(1)..OPTCOR(8)

VALUES(1)..VALUES(8) LABELS(1)..LABELS(7) DFXFILE ACCFILE THRFILE
INLFILE

Python command syntax:

ierr = accc_with_cor_3(tol, optacc, optcor, values, labels, dfxfile,

accfile, thrfile, inlfile)

Fortran command syntax:

CALL ACCC_WITH_COR_3(TOL, OPTACC, OPTCOR, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN, by default).
Integer OPTACC (10) array of 10 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
58
Power Flow ACCC_WITH_COR_3

OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (RESERVE)
OPTACC(10) = 2 subsystem machines (PMAX)
OPTACC(10) = 3 subsystem machines (INERTIA)
OPTACC(10) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective actions (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number of power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
59
Power Flow ACCC_WITH_COR_3

OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (8) array of 8 elements specifying corrective actions parameters(input).
VALUES(1) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(2) branch overload violation tolerance (0.1 by
default)
VALUES(3) generator control weighting factor (1.0 by
default)
VALUES(4) load control weighting factor (1.0 by default)
VALUES(5) phase shifter control weighting factor (1.0 by
default)
VALUES(6) off-line generator control weighting factor
(1.0 by default)
VALUES(7) tap setting adjustment weighting factor (1.0
by default)
VALUES(8) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (7) array of 7 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(3) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(4) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
LABELS(5) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(6) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
60
Power Flow ACCC_WITH_COR_3

LABELS(7) switched shunt control subsystem (blank by

default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of Unit Inertia Data File (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTCOR value
IERR = 11 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
61
Power Flow ACCC_WITH_DSP

1.1.19. ACCC_WITH_DSP
This API routine is obsolete. It has been replaced by the API routine accc_with_dsp_2 .

Use this API to apply the AC contingency calculation function with a generation dispatch function to han-
dle imbalances in power resources and demand due to contingencies.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_ACCC_WITH_DSP TOL OPTACC(1)..OPTACC(8) LABEL DFXFILE ACCFILE

THRFILE INLFILE

Python command syntax:

ierr = accc_with_dsp(tol, optacc, label, dfxfile, accfile, thrfile,

inlfile)

Fortran command syntax:

CALL ACCC_WITH_DSP(TOL, OPTACC, LABEL, DFXFILE, ACCFILE, THRFILE, INLFILE,

IERR)

Where:

Real TOL mismatch tolerance (input; Newton solution convergence tolerance,

TOLN).
Integer OPTACC (8) array of 8 elements specifying solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
62
Power Flow ACCC_WITH_DSP

OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Character*32 LABEL name of the generation dispatch subsystem (input; blank by default,
no default allowed if OPTACC(8) is not 0).
Character*260 DFXFILE name of the Distribution Factor Data file (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output file (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data file (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 no Distribution Factor Data File specified
IERR = 9 no Contingency Solution Output File specified
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
63
Power Flow ACCC_WITH_DSP

IERR = 22 monitored elements exceed limit when

adding multi-section line members
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 error opening Unit Inertia and Governor Data
File
IERR = 55 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
64
Power Flow ACCC_WITH_DSP_2

1.1.20. ACCC_WITH_DSP_2
This API routine is obsolete. It has been replaced by the API routine accc_with_dsp_3 .

Use this API to run the second release of AC contingency calculation function (ACCC, ACCC_WITH_DSP).
The API provides the options to handle induction machines in a contingency analysis.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_ACCC_WITH_DSP_2 TOL OPTIONS(1)..OPTIONS(10) LABEL DFXFILE ACCFILE
THRFILE INLFILE

Python command syntax:

ierr = accc_with_dsp_2(tol, options, label, dfxfile, accfile, thrfile,
inlfile)

Fortran command syntax:

CALL ACCC_WITH_DSP_2(TOL, OPTIONS, LABEL, DFXFILE, ACCFILE, THRFILE,
INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTIONS (10) array of 10 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
65
Power Flow ACCC_WITH_DSP_2

OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) solution method flag (0 by default)
OPTIONS(6) = 0 FDNS
OPTIONS(6) = 1 FNSL
OPTIONS(6) = 2 optimized FDNS
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
OPTIONS(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTIONS(8) = 0 stall
OPTIONS(8) = 1 trip
OPTIONS(9) induction machine failure flag (0 by default)
OPTIONS(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTIONS(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTIONS(10) dispatch mode (0 by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 subsystem machines (reserve)
OPTIONS(10) = 2 subsystem machines (pmax)
OPTIONS(10) = 3 subsystem machines (inertia)
OPTIONS(10) = 4 subsystem machines (governor droop)
Character*32 LABEL name of the generation dispatch subsystem (input; blank by default,
no default allowed if OPTIONS(10) is not 0).
Character*260 DFXFILE name of the Distribution Factor Data file (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output file (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data file (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
66
Power Flow ACCC_WITH_DSP_2

IERR = 4 buses in island(s) without a swing bus; use

activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 no Distribution Factor Data File specified
IERR = 9 no Contingency Solution Output File specified
IERR = 10 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 11 buses with bus type code and series element
status inconsistencies
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 error opening Unit Inertia and Governor Data
File
IERR = 55 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
67
Power Flow ACCC_WITH_DSP_3

1.1.21. ACCC_WITH_DSP_3
Use this API to run the second release of AC contingency calculation function (ACCC, ACCC_WITH_DSP).
The API provides the options to handle induction machines in a contingency analysis.

This API routine was first introduced in release 33.4.0.

Batch command syntax:

BAT_ACCC_WITH_DSP_3 TOL OPTACC(1)..OPTACC(11) LABEL DFXFILE ACCFILE

THRFILE INLFILE ZIPFILE

Python command syntax:

ierr = accc_with_dsp_3(tol, optacc, label, dfxfile, accfile, thrfile,

inlfile, zipfile)

Fortran command syntax:

CALL ACCC_WITH_DSP_3(TOL, OPTACC, LABEL, DFXFILE, ACCFILE, THRFILE,

INLFILE, ZIPFILE, IERR)

Where:
Real TOL Is the mismatch tolerance. (input; Newton solution convergence tol-
erance, TOLN, by default).
Integer OPTACC (11) array of elements specifying solution options. The values are as fol-
lows:(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
68
Power Flow ACCC_WITH_DSP_3

OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
OPTACC(11) ZIP archive flag (0 by default)
OPTACC(11) = 0 do not write a ZIP archive file
OPTACC(11) = 1 write a ZIP archive using the file specified as
ZIPFILE
Character*32 LABEL Is the name of the generation dispatch subsystem (blank by default,
no default allowed if OPTIONS(10) is not 0). (input).
Character*260 DFXFILE Is the name of the Distribution Factor Data file (input; no default al-
lowed).
Character*260 ACCFILE Is the name of the Contingency Solution Output file (input; no de-
fault allowed).
Character*260 THRFILE Is the name of the Load Throwover Data file (input; blank by default).
Character*260 INLFILE Is the name of the Unit Inertia and Governor Data File (input; blank
by default).
Character*260 ZIPFILE Is the name of the ZIP Archive Output File (input; blank by default).
Integer IERR error code (output).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
69
Power Flow ACCC_WITH_DSP_3

IERR = 0 no error occurred

IERR = 1 invalid TOL value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 no Distribution Factor Data File specified
IERR = 9 no AC Contingency Solution Output File spec-
ified
IERR = 10 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 11 buses with bus type code and series element
status inconsistencies
IERR = 12 no ZIP Archive Output File specified
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 error opening Unit Inertia and Governor Data
File
IERR = 55 error opening ZIP Archive Output File
IERR = 56 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
70
Power Flow ACCC_WITH_TRIP

1.1.22. ACCC_WITH_TRIP
This API routine is obsolete. It has been replaced by the API routine accc_with_trip_2 .

Use this API to apply the AC contingency calculation function with a post-contingency tripping function.
This may be used, for example, to simulate switchings that occur when specified monitored quantities are
beyond threshold values.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_ACCC_WITH_TRIP TOL OPTACC(1)..OPTACC(8) OPTTRP(1)..OPTTRP(3) LABEL

DFXFILE ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = accc_with_trip(tol, optacc, opttrp, label, dfxfile, accfile,

thrfile, inlfile, trpfile)

Fortran command syntax:

CALL ACCC_WITH_TRIP(TOL, OPTACC, OPTTRP, LABEL, DFXFILE, ACCFILE, THRFILE,

INLFILE, TRPFILE, IERR)

Where:

Real TOL mismatch tolerance (input; Newton solution convergence tolerance,

TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
71
Power Flow ACCC_WITH_TRIP

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Character*32 LABEL name of the generation dispatch subsystem (input; blank by default;
no default allowed if OPTACC(8) is not 0).
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
72
Power Flow ACCC_WITH_TRIP

IERR = 4 buses in island(s) without a swing bus; use

activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 Invalid OPTTRP value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
73
Power Flow ACCC_WITH_TRIP_2

1.1.23. ACCC_WITH_TRIP_2
Use this API to run the second version of AC contingency calculation function with a post-contingency trip-
ping function. This may be used, for example, to simulate switchings that occur when specified monitored
quantities are beyond threshold values.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_ACCC_WITH_TRIP_2 TOL OPTACC(1)..OPTACC(10) OPTTRP(1)..OPTTRP(3)

LABEL DFXFILE ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = accc_with_trip_2(tol, optacc, opttrp, label, dfxfile, accfile,

thrfile, inlfile, trpfile)

Fortran command syntax:

CALL ACCC_WITH_TRIP_2(TOL, OPTACC, OPTTRP, LABEL, DFXFILE, ACCFILE,

THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
74
Power Flow ACCC_WITH_TRIP_2

OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Character*32 LABEL name of the generation dispatch subsystem (input; blank by default;
no default allowed if OPTACC(8) is not 0).
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
75
Power Flow ACCC_WITH_TRIP_2

Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 Invalid OPTTRP value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-sec-tion line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
76
Power Flow ACCC_WITH_TRIP_PARALLEL

1.1.24. ACCC_WITH_TRIP_PARALLEL
Use this API to run the parallel version of AC contingency calculation function with a post-contingency trip-
ping function (use ACCC_WITH_TRIP_2 to run the function sequentially). The API distributes contingency
cases among multiple processors evenly, and tests the contingency cases and following tripping actions as-
signed to each processor in parallel.

This API routine was first introduced in release 33.4.0.

Batch command syntax:

BAT_ACCC_WITH_TRIP_PARALLEL TOL OPTACC(1)..OPTACC(10)

OPTTRP(1)..OPTTRP(3) LABEL DFXFILE ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = accc_with_trip_parallel(tol, optacc, opttrp, label, dfxfile,

accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL ACCC_WITH_TRIP_PARALLEL(TOL, OPTACC, OPTTRP, LABEL, DFXFILE, ACCFILE,

THRFILE, INLFILE, TRPFILE, IERR)

Where:

Real TOL Is the mismatch tolerance (input; Newton solution convergence toler-
ance, TOLN, by default).
Integer OPTACC (10) array of elements specifying power flow solution options. The values
are as follows:(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable.
OPTACC(1) = 1 enable stepping adjustment.
OPTACC(1) = 2 enable direct adjustment.
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable.
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange.
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange.
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable.
OPTACC(3) = 1 enable.
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable.
OPTACC(4) = 1 enable.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
77
Power Flow ACCC_WITH_TRIP_PARALLEL

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable.
OPTACC(5) = 1 enable.
OPTACC(5) = 2 enable continuous mode, disable discrete
mode.
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS.
OPTACC(6) = 1 FNSL.
OPTACC(6) = 2 optimized FDNS.
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable.
OPTACC(7) = 1 enable.
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage). (0 by default)
OPTACC(8) = 0 stall.
OPTACC(8) = 1 trip.
OPTACC(9) induction machine failure flag. (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state.
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state.
OPTACC(10) dispatch mode. (0 by default)
OPTACC(10) = 0 disable.
OPTACC(10) = 1 subsystem machines (reserve).
OPTACC(10) = 2 subsystem machines (pmax).
OPTACC(10) = 3 subsystem machines (inertia).
OPTACC(10) = 4 subsystem machines (governor droop).
Integer OPTTRP (3) array of elements specifying tripping simulation options. The values
are as follows:(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable.
OPTTRP(1) = 1 enable tripping simulation.
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Character*32 LABEL Is the name of the generation dispatch subsystem (blank by default;
no default allowed if OPTACC(8) is not 0). (input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
78
Power Flow ACCC_WITH_TRIP_PARALLEL

Character*260 DFXFILE Is the name of the Distribution Factor Data File. (input; no default al-
lowed).
Character*260 ACCFILE Is the name of the Contingency Solution Output File. (input; no de-
fault allowed).
Character*260 THRFILE Is the name of the Load Throwover Data File. (input; blank by de-
fault).
Character*260 INLFILE Is the name of the Unit Inertia and Governor Data File. (input; blank
by default).
Character*260 TRPFILE Is the name of the Tripping Element Data File (input, blank for none;
no default allowed if OPTTRP(1) is 1). (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 Invalid OPTTRP value.
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 49 error opening Tripping Element Data File.
IERR = 50 error opening Unit Inertia and Governor Data
File.
IERR = 51 error opening Contingency Solution Output
File.
IERR = 52 error opening Distribution Factor Data File.
IERR = 53 error opening Load Throwover Data File.
IERR = 54 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
79
Power Flow ACCOR

1.1.25. ACCOR
This API routine is obsolete. It has been replaced by the API routine accor_2 .

Use this API to apply corrective actions to the base case using successive linear programming methods. The
corrective actions are to eliminate flow overloads and voltage violations with the objective of minimizing
the control adjustments, including load shedding, MW generations dispatch, and phase shifter angle ad-
justments.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_ACCOR OPTIONS(1)..OPTIONS(10) VALUES(1)..VALUES(7)
LABELS(1)..LABELS(3) DFXFILE

Python command syntax:

ierr = accor(options, values, labels, dfxfile)

Fortran command syntax:

CALL ACCORAPI(OPTIONS, VALUES, LABELS, DFXFILE, IERR)

Where:
Integer OPTIONS (10) array of 10 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
80
Power Flow ACCOR

OPTIONS(5) = 2 enable continuous mode, disable discrete

mode
OPTIONS(6) rating set (rating set program option setting
by default)
OPTIONS(6) = 1 rating A
OPTIONS(6) = 2 rating B
OPTIONS(6) = 3 rating C
OPTIONS(7) number of power flow solutions (from 1 to
10; 1 by default)
OPTIONS(8) generator control flag (1 by default)
OPTIONS(8) = 0 disable
OPTIONS(8) = 1 enable
OPTIONS(9) load control flag (0 by default)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable
OPTIONS(10) phase shifter control flag (1 by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 enable
Real VALUES (7) array of 7 elements specifying AC corrective actions
parameters(input).
VALUES(1) MW mismatch tolerance (Newton solution
convergence tolerance, TOLN by default)
VALUES(2) percent of rating set (100.0 by default)
VALUES(3) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(4) branch flow overload tolerance (0.1 by de-
fault)
VALUES(5) generator control weighting factor (1.0 by
default)
VALUES(6) load control weighting factor (1.0 by default)
VALUES(7) phase shifter control weighting factor (1.0 by
default)
Character*32 LABELS (3) array of 3 elements specifying subsystem labels(input).
LABELS(1) label of generator control subsystem (blank
by default; no default allowed if OPTIONS(8)
is 1)
LABELS(2) label of load control subsystem (blank by de-
fault; no default allowed if OPTIONS(9) is 1)
LABELS(3) label of phase shifter control subsystem
(blank by default; no default allowed if OP-
TIONS(10) is 1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
81
Power Flow ACCOR

IERR = 1 invalid OPTIONS value

IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 No controls
IERR = 6 control subsystem not defined
IERR = 7 Distribution Factor Data File not specified
IERR = 8 largest mismatch exceeds tolerance
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
82
Power Flow ACCOR_2

1.1.26. ACCOR_2
This API routine is obsolete. It has been replaced by the API routine accor_3 .

This API is the second release of corrective action function. Use this API to augment control strategies with
off-line generator control, tap setting adjustments and switched shunt controls.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_ACCOR_2 OPTIONS(1)..OPTIONS(13) VALUES(1)..VALUES(10)

LABELS(1)..LABELS(6) DFXFILE

Python command syntax:

ierr = accor_2(options, values, labels, dfxfile)

Fortran command syntax:

CALL ACCORAPI_2(OPTIONS, VALUES, LABELS, DFXFILE, IERR)

Where:

Integer OPTIONS (13) array of 13 elements specifying solution options(input).

OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
83
Power Flow ACCOR_2

OPTIONS(5) = 2 enable continuous mode, disable discrete

mode
OPTIONS(6) rating set (rating set program option setting
by default)
OPTIONS(6) = 1 rating A
OPTIONS(6) = 2 rating B
OPTIONS(6) = 3 rating C
OPTIONS(7) number of power flow solutions (from 1 to
10; 1 by default)
OPTIONS(8) generator control flag (1 by default)
OPTIONS(8) = 0 disable
OPTIONS(8) = 1 enable
OPTIONS(9) load control flag (0 by default)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable
OPTIONS(10) phase shifter control flag (1 by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 enable
OPTIONS(11) off-line generator control flag (0 by default)
OPTIONS(11) = 0 disable
OPTIONS(11) = 1 enable
OPTIONS(12) tap setting adjustment flag (0 by default)
OPTIONS(12) = 0 disable
OPTIONS(12) = 1 enable
OPTIONS(13) switched shunt control flag (0 by default)
OPTIONS(13) = 0 disable
OPTIONS(13) = 1 enable
Real VALUES (10) array of 10 elements specifying AC corrective actions
parameters(input).
VALUES(1) MW mismatch tolerance (Newton solution
convergence tolerance, TOLN by default)
VALUES(2) percent of rating set (100.0 by default)
VALUES(3) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(4) branch flow overload tolerance (0.1 by de-
fault)
VALUES(5) generator control weighting factor (1.0 by
default)
VALUES(6) load control weighting factor (1.0 by default)
VALUES(7) phase shifter control weighting factor (1.0 by
default)
VALUES(8) off-line generator control weighting factor
(1.0 by default)
VALUES(9) tap setting adjustment weighting factor (1.0
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
84
Power Flow ACCOR_2

VALUES(10) switched shunt control weighting factor (1.0

by default)
Character*32 LABELS (6) array of 6 elements specifying subsystem labels(input).
LABELS(1) label of generator control subsystem (blank
by default; no default allowed if OPTIONS(8)
is 1)
LABELS(2) label of load control subsystem (blank by de-
fault; no default allowed if OPTIONS(9) is 1)
LABELS(3) label of phase shifter control subsystem
(blank by default; no default allowed if OP-
TIONS(10) is 1)
LABELS(4) off-line generator control subsystem
(blank by default; no default allowed if OP-
TIONS(11) is 1)
LABELS(5) tap setting adjustment subsystem (blank by
default; no default allowed if OPTIONS(12) is
1)
LABELS(6) switched shunt control subsystem (blank by
default; no default allowed if OPTIONS(13) is
1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus, use
activity TREE
IERR = 5 No controls
IERR = 6 control subsystem not defined
IERR = 7 Distribution Factor Data File not specified
IERR = 8 largest mismatch exceeds tolerance
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file, run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
85
Power Flow ACCOR_3

1.1.27. ACCOR_3
This API is the third release of corrective action function. Use this API to specify voltage limits in determin-
ing voltage violations.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_ACCOR_3 OPTIONS(1)..OPTIONS(14) VALUES(1)..VALUES(10)

LABELS(1)..LABELS(6) DFXFILE

Python command syntax:

ierr = accor_3(options, values, labels, dfxfile)

Fortran command syntax:

CALL ACCORAPI_3(OPTIONS, VALUES, LABELS, DFXFILE, IERR)

Where:

Integer OPTIONS (14) array of elements specifying solution options. The values are as fol-
lows:(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable.
OPTIONS(1) = 1 enable stepping adjustment.
OPTIONS(1) = 2 enable direct adjustment.
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable.
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange.
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange.
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable.
OPTIONS(3) = 1 enable.
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable.
OPTIONS(4) = 1 enable.
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable.
OPTIONS(5) = 1 enable.
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
86
Power Flow ACCOR_3

OPTIONS(6) rating set (rating set program option setting

by default)
OPTIONS(6) = 1 rating A
OPTIONS(6) = 2 rating B
OPTIONS(6) = 3 rating C
OPTIONS(7) voltage limit
OPTIONS(7) = 1 normal
OPTIONS(7) = 2 emergency
OPTIONS(8) number of power flow solutions (from 1 to
10; 1 by default)
OPTIONS(9) generator control flag (1 by default)
OPTIONS(9) = 0 disable.
OPTIONS(9) = 1 enable.
OPTIONS(10) load control flag. (0 by default)
OPTIONS(10) = 0 disable.
OPTIONS(10) = 1 enable.
OPTIONS(11) phase shifter control flag (1 by default)
OPTIONS(11) = 0 disable.
OPTIONS(11) = 1 enable.
OPTIONS(12) off-line generator control flag (0 by default)
OPTIONS(12) = 0 disable.
OPTIONS(12) = 1 enable.
OPTIONS(13) tap setting adjustment flag (0 by default)
OPTIONS(13) = 0 disable.
OPTIONS(13) = 1 enable.
OPTIONS(14) switched shunt control flag (0 by default)
OPTIONS(14) = 0 disable.
OPTIONS(14) = 1 enable.
Real VALUES (10) array of elements specifying AC corrective actions parameters. The
values are as follows:(input).
VALUES(1) MW mismatch tolerance (Newton solution
convergence tolerance, TOLN by default)
VALUES(2) percent of rating set (100.0 by default)
VALUES(3) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(4) branch flow overload tolerance (0.1 by de-
fault)
VALUES(5) generator control weighting factor (1.0 by
default)
VALUES(6) load control weighting factor (1.0 by default)
VALUES(7) phase shifter control weighting factor (1.0 by
default)
VALUES(8) off-line generator control weighting factor
(1.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
87
Power Flow ACCOR_3

VALUES(9) tap setting adjustment weighting factor (1.0

by default)
VALUES(10) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (6) array of elements specifying subsystem labels (input). The values are
as follows:(input).
LABELS(1) label of generator control subsystem (blank
by default; no default allowed if OPTIONS(9)
is 1).
LABELS(2) label of load control subsystem (blank by de-
fault; no default allowed if OPTIONS(10) is
1).
LABELS(3) label of phase shifter control subsystem
(blank by default; no default allowed if OP-
TIONS(11) is 1).
LABELS(4) off-line generator control subsystem
(blank by default; no default allowed if OP-
TIONS(12) is 1).
LABELS(5) tap setting adjustment subsystem (blank by
default; no default allowed if OPTIONS(13) is
1).
LABELS(6) switched shunt control subsystem (blank by
default; no default allowed if OPTIONS(14) is
1).
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 No controls.
IERR = 6 control subsystem not defined.
IERR = 7 Distribution Factor Data File not specified.
IERR = 8 largest mismatch exceeds tolerance.
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX.
IERR = 22 monitored elements exceed limit when
adding multi-section line members.
IERR = 51 error opening Distribution Factor Data File.
IERR = 52 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
88
Power Flow ALERT_OUTPUT

1.1.28. ALERT_OUTPUT
Use this API to specify the alert device.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_ALERT_OUTPUT ISLCT FILARG OPTIONS(1) OPTIONS(2)

Python command syntax:

ierr = alert_output(islct, filarg, options)

Fortran command syntax:

CALL OPENALERTDEVICE(ISLCT, FILARG, OPTIONS, IERR)

Where:

Integer ISLCT virtual device selector (input).

ISLCT = 1 standard destination. In the PSSE GUI stan-
dard output for alerts is a message box and a
copy to the Alerts/Warnings tab of the output
bar.
ISLCT = 2 direct output to a file.
ISLCT = 3 direct output to a printer.
ISLCT = 4 direct output to progress device.
ISLCT = 5 direct output to report device.
ISLCT = 6 no output.
Character*260 FILARG printer name or filename; ignored if ISLCT is not 2 or 3 (input).
Integer OPTIONS (2) array of 2 elements specifying open and printing options; ignored if
ISLCT is not 2 or 3(input).
OPTIONS(1) file and printer open options: The OP-
TIONS(1) values may be summed to select
multiple options
OPTIONS(1) = 0 open with carriage control format and, for
files, for overwrite of existing files
OPTIONS(1) = 1 open with list format
OPTIONS(1) = 2 open file for append (file output only)
OPTIONS(1) = 2 set printer orientation to portrait mode
(printer output only)
OPTIONS(1) = 4 open printer in immediate print mode (print-
er output only)
OPTIONS(2) number of copies to print (printer only)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = 2 failed to open device

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
89
Power Flow ALERT_OUTPUT

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
90
Power Flow ALLOW_PSSUSERPF

1.1.29. ALLOW_PSSUSERPF
Use this API to specify or return the option to allow or disallow the loading or use of the
Powerflow Customization Interface (PCI) implementation module (pssuserpf).

This API routine was first introduced in release 33.6.0 and 34.0.1.

Batch command syntax:

BAT_ALLOW_PSSUSERPF IVAL

Python command syntax:

ierr = allow_pssuserpf(ival)

ierr,ival = allow_pssuserpf()

Fortran command syntax:

CALL ALLOW_PSSUSERPF(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1 by default;
else output).
IVAL = 0 PCI disabled.
IVAL = 1 PCI enabled.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
91
Power Flow ALPH

1.1.30. ALPH
Use this API to print an alphabetically sorted table of all buses in a specified subsystem of the working case
(activity ALPH).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_ALPH SID ALL

Python command syntax:

ierr = alph(sid, all)

Fortran command syntax:

CALL ALPHNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
92
Power Flow APPEND_ACCC

1.1.31. APPEND_ACCC
Use this API to replicate system conditions of a contingency case solution, as contained in a designated
Saved Case File, in the form of a Contingency Solution Output File. Results may be appended to an existing
Contingency Solution Output File, or an new Contingency Solution Output File may be created.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_APPEND_ACCC OPTION DFXFILE BASFILE CNTFILE ACCFILE LABEL

NUMDESC DESCRPT(1)..DESCRPT(NUMDESC)

Python command syntax:

ierr = append_accc(option, dfxfile, basfile, cntfile, accfile, label,

numdesc, descrpt)

Fortran command syntax:

CALL APPEND_ACCC(OPTION, DFXFILE, BASFILE, CNTFILE, ACCFILE, LABEL,

NUMDESC, DESCRPT, IERR)

Where:

Integer OPTION append flag (input; 1 by default).

OPTION = 0 create a new Contingency Solution Output
File in the file specified in ACCFILE.
OPTION = 1 append results to the existing Contingency
Solution Output File specified in ACCFILE
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 BASFILE name of the Saved Case File containing the pre-contingency power
flow working case. This is the case that was present when the Distri-
bution Factor Data File specified in DFXFILE was constructed; it is al-
so the case from which the contingency case was formed. Its solu-
tion is in the Saved Case File specified in CNTFILE (input; no default
allowed).
Character*260 CNTFILE name of the Saved Case File containing the contingency case solu-
tion for which results are to be placed in the Contingency Solution
Output File specified in ACCFILE. This case must be formed by im-
posing status and/or boundary condition changes on the pre-contin-
gency case specified in BASFILE, and then solving using one or more
of the power flow solution activities (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*32 LABEL 12 character contingency label (input; blank by default).
Integer NUMDESC number of lines of text used to describe the contingency case; must
be between 1 and 16 (input; no default allowed).
Character*160 DESCRPT Are NUMDESC lines of text describing the contingency case (input;
(NUMDESC) blank by default).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
93
Power Flow APPEND_ACCC

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 invalid OPTION value
IERR = 2 invalid NUMDESC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 no base case Saved Case File specified
IERR = 6 no contingency case Saved Case File specified
IERR = 7 Contingency Solution Output File not found
IERR = 8 DFAX File and Contingency Solution Output
File are not compatible
IERR = 9 no Distribution Factor Data File specified
IERR = 10 no Contingency Solution Output File specified
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening pre-contingency Saved Case
File
IERR = 54 error opening contingency case Saved Case
File
IERR = 55 error reading Contingency Solution Output
File
IERR = 56 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
94
Power Flow APPLY_VAR_LIMITS

1.1.32. APPLY_VAR_LIMITS
Use this API to specify or return the option for the default VAR limits setting; either apply automatically, ap-
ply immediately, ignore, or apply on a specific iteration

This API routine was first introduced in release 35.0.0.

Batch command syntax:

BAT_APPLY_VAR_LIMITS IVAL

Python command syntax:

ierr = apply_var_limits(ival)

ierr, ival = apply_var_limits()

Fortran command syntax:

CALL APPLY_VAR_LIMITS(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = -1 ignore
IVAL = 0 apply immediately
IVAL = >0 apply on the specified iteration or when the
largest reactive power mismatch is less than a
pre-programmed tolerance
IVAL = 99 apply automatically
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
95
Power Flow AREA

1.1.33. AREA
This API routine is obsolete. It has been replaced by the API routine area_2 .

Use this API to tabulate area totals by area, as well as the desired area net interchange (activity AREA).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_AREA SID ALL

Python command syntax:

ierr = area(sid, all)

Fortran command syntax:

CALL AREANW(SID, ALL, IERR)

Where:

Integer SID a valid area subsystem identifier. Valid subsystem identifiers range
from 0 to 11. Area subsystem SID must have been previously defined
(input; 0 by default).
Integer ALL all areas or specified subsystem flag (input; 1 by default).
ALL = 1 process all areas.
ALL = 0 process only areas in area subsystem SID.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
96
Power Flow AREA_2

1.1.34. AREA_2
Use this API to tabulate area totals by area, as well as the desired area net interchange (activity AREA).

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_AREA_2 SID ALL OPT

Python command syntax:

ierr = area_2(sid, all, opt)

Fortran command syntax:

CALL AREA_2(SID, ALL, OPT, IERR)

Where:

Integer SID a valid area subsystem identifier. Valid subsystem identifiers range
from 0 to 11. Area subsystem SID must have been previously defined
(input; 0 by default).
Integer ALL all areas or specified subsystem flag (input; 1 by default).
ALL = 1 process all areas.
ALL = 0 process only areas in area subsystem SID.
Integer OPT load and induction machine reporting option (input; 2 by default).
OPT = 1 tabulate loads, induction generators and in-
duction motors connected to area buses
OPT = 2 tabulate loads, induction generators and in-
duction motors assigned to the area
OPT = 3 tabulate three load and induction machine
subtotals for each area: -area load and induc-
tion machines connected to area buses -area
load and induction machines connected to
non-area buses -non-area load and induction
machines connected to area buses
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 Invalid OPT value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
97
Power Flow AREA_ZONE

1.1.35. AREA_ZONE
Use this API to tabulate area totals by area, along with subtotals by zone. The desired net interchange of
each area reported is also tabulated.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_AREA_ZONE SID ALL

Python command syntax:

ierr = area_zone(sid, all)

Fortran command syntax:

CALL AREA_ZONE(SID, ALL, IERR)

Where:

Integer SID a valid area subsystem identifier. Valid subsystem identifiers range
from 0 to 11. Area subsystem SID must have been previously defined
(input; 0 by default).
Integer ALL all areas or specified subsystem flag (input; 1 by default).
ALL = 1 process all areas.
ALL = 0 process only areas in area subsystem SID.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
98
Power Flow ARNM

1.1.36. ARNM
This API routine is obsolete. It has been replaced by the API routine arnm_2 .

Use this API to reassign the buses and loads in a specified subsystem of the working case from their origi-
nal area to a designated area (activity ARNM).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_ARNM SID ALL STATUS(1) STATUS(2) IANEW

Python command syntax:

ierr = arnm(sid, all, status, ianew)

Fortran command syntax:

CALL ARNMNW(SID, ALL, STATUS, IANEW, IERR)

Where:
Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer STATUS (2) array of 2 elements specifying (input).
STATUS(1) Area assignments of buses to IANEW; (0 by
default)
STATUS(1) = 1 Change area assignments of buses to IANEW
STATUS(1) = 0 Leave area assignments of buses unchanged
STATUS(2) Area assignments of loads to IANEW; (0 by
default)
STATUS(2) = 1 Change area assignments of loads to IANEW
STATUS(2) = 0 Leave area assignments of loads unchanged
Integer IANEW new area to be assigned to specified buses and/or loads. IANEW must
be between 1 and 9999 (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 invalid new area number
IERR = 5 area table is full; cannot add area to the work-
ing case

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
99
Power Flow ARNM

IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
100
Power Flow ARNM_2

1.1.37. ARNM_2
This API routine is the second release of the area renumbering function. Use this API routine to reassign the
buses, loads and/or induction machines in a specified subsystem of the working case from their original
area to a designated area (activity ARNM).

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_ARNM_2 SID ALL STATUS(1) STATUS(2) STATUS(3) IANEW

Python command syntax:

ierr = arnm_2(sid, all, status, ianew)

Fortran command syntax:

CALL ARNM_2(SID, ALL, STATUS, IANEW, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer STATUS (3) array of 3 elements specifying (input).
STATUS(1) Area assignments of buses to IANEW; (0 by
default)
STATUS(1) = 1 Change area assignments of buses to IANEW
STATUS(1) = 0 Leave area assignments of buses unchanged
STATUS(2) Area assignments of loads to IANEW; (0 by
default)
STATUS(2) = 1 Change area assignments of loads to IANEW
STATUS(2) = 0 Leave area assignments of loads unchanged
STATUS(3) Area assignments of induction machines to
IANEW; (0 by default)
STATUS(3) = 1 Change area assignments of induction ma-
chines to IANEW
STATUS(3) = 0 Leave area assignments of induction ma-
chines unchanged
Integer IANEW new area to be assigned to specified buses, load, and/or induction
machines. IANEW must be between 1 and 9999 (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
101
Power Flow ARNM_2

IERR = 2 invalid ALL value

IERR = 3 invalid STATUS value
IERR = 4 invalid new area number
IERR = 5 area table is full; cannot add area to the work-
ing case
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
102
Power Flow BASE_FREQUENCY

1.1.38. BASE_FREQUENCY
Use this API to specify or return the value of the base frequency option setting.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_BASE_FREQUENCY RVAL

Python command syntax:

ierr = base_frequency(rval)

ierr, rval = base_frequency()

Fortran command syntax:

CALL BASE_FREQUENCY_API(RVAL, IOCODE, IERR)

Where:

Real RVAL base frequency (usually 50 or 60) (input; if Batch command, or for
Python if specified as an argument, or for Fortran if IOCODE is 0, 60.0
by default; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
RVAL.
IOCODE = 1 return the current value of the option setting
in RVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid RVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
103
Power Flow BGEN

1.1.39. BGEN
Use this API to convert the mismatch at boundary buses to equivalent load and/or generation (activity
BGEN). It is intended to be used following the removal of a subsystem from a solved working case, with the
flows to the deleted subsystem replaced by load and/or generation at those retained buses that were di-
rectly connected to the removed subsystem.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_BGEN SID ALL STATUS

Python command syntax:

ierr = bgen(sid, all, status)

Fortran command syntax:

CALL BGENNW(SID, ALL, STATUS, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer STATUS type of boundary condition modification to be used (input; 0 by de-
fault).
STATUS = 0 generator for inflow; load for outflow.
STATUS = 1 all equivalent generators.
STATUS = 2 all equivalent loads.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
104
Power Flow BRCH

1.1.40. BRCH
This API routine is obsolete. It has been replaced by the API routine brch_2 .

Use this API to tabulate those branches where impedances or other characteristics are such that they may
be detrimental to the rate of convergence of one or more of the power flow solution activities.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_BRCH SID ALL DOTEST(1)..DOTEST(10) TOLVAL(1)..TOLVAL(7)

Python command syntax:

ierr = brch(sid, all, dotest, tolval)

Fortran command syntax:

CALL BRCHNW(SID, ALL, DOTEST, TOLVAL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer DOTEST (10) array of 10 elements specifying options. Each element determines
whether a specific branch check should be applied. For DOTEST(I) =
1, the corresponding branch check is applied; for DOTEST(I) = 0, the
check is bypassed(input).
DOTEST(1) check for small reactances
DOTEST(2) check for large reactances
DOTEST(3) check for large resistance to reactance ratios
(R/X)
DOTEST(4) check for negative reactances
DOTEST(5) check for large ratio of largest to smallest re-
actance at each bus
DOTEST(6) check for high or negative charging
DOTEST(7) check data of parallel transformers
DOTEST(8) check for high tap ratios
DOTEST(9) check for low tap ratios
DOTEST(10) check for zero sequence non-transformer
branch impedances of 0.0
Real TOLVAL (7) array of 7 elements specifying options. Each element contains a limit
or threshold value used in one of the branch checks(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
105
Power Flow BRCH

TOLVAL(1) >0.0 reactance lower limit (0.0005 by de-

fault)
TOLVAL(2) >0.0 reactance upper limit (1.0 by default)
TOLVAL(3) >0.0 R/X threshold (0.66667 by default)
TOLVAL(4) >=10.0 Xmax/Xmin threshold (500.0 by de-
fault)
TOLVAL(5) >=0.0 charging upper limit (5.0 by default)
TOLVAL(6) >0.8 high tap ratio limit (1.1 by default)
TOLVAL(7) >0.0 and < 1.2 low tap ratio limit (0.9 by de-
fault)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid DOTEST value
IERR = 4 invalid TOLVAL value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
106
Power Flow BRCH_2

1.1.41. BRCH_2
Use this API to tabulate those branches where impedances or other characteristics are such that they may
be detrimental to the rate of convergence of one or more of the power flow solution activities.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_BRCH_2 SID ALL DOTEST(1)..DOTEST(11) TOLVAL(1)..TOLVAL(7)

Python command syntax:

ierr = brch_2(sid, all, dotest, tolval)

Fortran command syntax:

CALL BRCH_2(SID, ALL, DOTEST, TOLVAL, IERR)

Where:
Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer DOTEST (11) array of elements specifying options. Each element determines
whether a specific branch check should be applied. For DOTEST(I) =
1, the corresponding branch check is applied; for DOTEST(I) = 0, the
check is bypassed(input).
DOTEST(1) check for small reactances.
DOTEST(2) check for large reactances.
DOTEST(3) check for large resistance to reactance ratios
(R/X).
DOTEST(4) check for negative reactances.
DOTEST(5) check for large ratio of largest to smallest re-
actance at each bus.
DOTEST(6) check for high or negative charging.
DOTEST(7) check data of parallel transformers.
DOTEST(8) check for high tap ratios.
DOTEST(9) check for low tap ratios.
DOTEST(10) check for inconsistent transformer loss data
values (copper loss and no-load loss).
DOTEST(11) check for zero sequence non-transformer
branch impedances of 0.0.
Real TOLVAL (7) array of elements specifying options. Each element contains a limit
or threshold value used in one of the branch checks (input).
TOLVAL(1) >0.0. reactance lower limit (0.0005 by de-
fault).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
107
Power Flow BRCH_2

TOLVAL(2) >0.0. reactance upper limit (1.0 by default).

TOLVAL(3) >0.0. R/X threshold (0.66667 by default).
TOLVAL(4) >=10.0. Xmax/Xmin threshold (500.0 by de-
fault).
TOLVAL(5) >=0.0. charging upper limit (5.0 by default).
TOLVAL(6) >0.8. high tap ratio limit (1.1 by default).
TOLVAL(7) > 0.0 and < 1.2. low tap ratio limit (0.9 by
default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid DOTEST value
IERR = 4 invalid TOLVAL value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
108
Power Flow BSNM

1.1.42. BSNM
Use this API to change the bus numbers of specified network buses in the working case and retain a tabula-
tion, in file form, of bus number changes made (activity BSNM). This API must be referenced with one OPT
0 reference followed by one of the following:
- one OPT 5, 11 or 12 reference.
- one or more OPT 1 references, followed by one OPT 7 reference.
- one or more OPT 2 references, followed by one OPT 7 reference.
- one or more OPT 3 references, followed by one OPT 7 reference.
- one or more OPT 4 references, followed by one OPT 7 reference.
- one OPT 15 reference for each area in the case containing at least one bus, in ascending area number or-
der, followed by one OPT 25 reference.
- zero or more OPT 15 references in the same order as above, followed by one OPT 35 reference.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_BSNM SID ALL OPT STATUS BUSRNG(1) BUSRNG(2) OLDNAM TFILE OUT
OFILE

Python command syntax:

ierr = bsnm(sid, all, opt, status, busrng, oldnam, tfile, out, ofile)

Fortran command syntax:

CALL BSNMNW(SID, ALL, OPT, STATUS, BUSRNG, OLDNAM, TFILE, OUT, OFILE,
IERR)

Where:
Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer OPT method used to renumber the buses (input; no default allowed).
OPT = 0 initialize for renumbering.
OPT = 1 renumber buses based on name/new number
pairs.
OPT = 11 renumber using name translation file.
OPT = 2 renumber buses based on old number/new
number pairs.
OPT = 12 renumber buses using number translation
file.
OPT = 3 pack all buses in specified low/high pairs.
OPT = 4 renumber buses based on the subsystem
specified in the OPT 0 reference.
OPT = 5 renumber all buses.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
109
Power Flow BSNM

OPT = 15 renumber all buses blocking by area.

OPT = 25 apply blocking by area changes.
OPT = 35 cancel blocking by area changes.
OPT = 7 cleanup from renumbering.
Integer STATUS If OPT=15, is the number of the area where the bus number range
is specified in BUSRNG. STATUS must be between 1 and AREAS (the
highest area number allowed at the present size level of PSSE). If
OPT=4: STATUS = 0 indicates a new bus number range is provided.
STATUS = 1 indicates a bus number offset is provided. Otherwise
STATUS is ignored (input).
Integer BUSRNG (2) If OPT = 1: BUSRNG(1) is the new bus number. If OPT = 2: BUSRNG(1)
is the old bus number. BUSRNG(2) is the new bus number. If OPT = 3:
BUSRNG(1) is the bus number at which to start packing sequentially.
BUSRNG(2) is the bus number at which to end packing sequentially.
If OPT = 4 and STATUS = 0: BUSRNG(1) is the starting bus number for
the range into which the subsystem is to be renumbered. BUSRNG(2)
is the ending bus number for the range into which the subsystem is
to be renumbered. If OPT = 4 and STATUS = 1: BUSRNG(1) is amount
by which all buses in the specified subsystem are offset. If OPT = 5:
BUSRNG(1) bus number at which to start renumbering all buses in
the working case. Buses are re-sequenced in increments of 1. If OPT
= 15: BUSRNG(1) is the starting bus number for the range into which
the area is to be renumbered. BUSRNG(2) is the ending bus number
for the range into which the area is to be renumbered (input).
Character*18 OLDNAM extended bus name of the bus to be renumbered when OPT is 1
(when OPT is 1) (input; no default allowed).
Character*260 TFILE bus name/number translation file. This file is only used if OPT = 11
or 12. Data in the translation file must be in the form specified in the
PSSE Program Operation Manual. (when OPT is 11 or 12) (input; no
default allowed).
Integer OUT option selection when OPT is 0 (input; 1 by default).
OUT = 0 direct output to a data file specified by OFILE.
OUT = 1 direct output to the current report device.
OUT = 2 no output.
Character*260 OFILE Bus Renumbering Translation file for the records of activity BSNM
(when OPT is 0 and OUT is 0) (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid OUT value
IERR = 4 invalid OPT 0 call; bus renumbering already
initialized
IERR = 5 prior OPT is not 0 (OPT=1,2,11,12,5,25)
IERR = 6 bus not found (OPT=1,2,11,12)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
110
Power Flow BSNM

IERR = 7 invalid new bus number (OPT=1,2,11,12,4)

IERR = 8 bus number is already assigned to another
bus (OPT=1,2,11,12,4)
IERR = 9 prior OPT not 0 or 3 (OPT=3,4,15,35)
IERR = 10 invalid starting bus number (OPT=3,4,5,15)
IERR = 11 invalid ending bus number (OPT=3,4,15)
IERR = 12 starting bus number is greater than ending
bus number (OPT=3,4,15)
IERR = 13 invalid STATUS value (OPT=4)
IERR = 14 invalid offset value (OPT=4)
IERR = 15 not enough unused bus numbers in specified
bus number range (OPT=4)
IERR = 16 not enough numbers between BUSRNG(1)
and 999997 (OPT=5)
IERR = 17 area specified but no more areas left to
process (OPT=15)
IERR = 18 area out of sequence (OPT=15)
IERR = 19 bus number range of an area overlaps that of
another area (OPT=15)
IERR = 20 bus number range of an area is not large
enough (OPT=15)
IERR = 21 not enough OPT 15 calls (OPT=25)
IERR = 22 invalid OPT 7 call; bus renumbering is not ini-
tialized (OPT=7)
IERR = 23 invalid OPT value
IERR = 24 error opening TFILE (OPT=11,12)
IERR = 25 error opening OFILE
IERR = 26 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
111
Power Flow BUSN

1.1.43. BUSN
Use this API to tabulate unused bus numbers within a specified bus number range (activity BUSN).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_BUSN BUSLO BUSHI

Python command syntax:

ierr = busn(buslo, bushi)

Fortran command syntax:

CALL BUSNAPI(BUSLO, BUSHI, IERR)

Where:

Integer BUSLO low limit of bus number range (input; 1 by default).

Integer BUSHI high limit of bus number range (input; 999,997).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid starting bus number
IERR = 2 starting bus number is greater than ending
bus number
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
112
Power Flow BUS_INPUT

1.1.44. BUS_INPUT
Use this API to specify or return the bus input option setting, for either numbers or names.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_BUS_INPUT IVAL

Python command syntax:

ierr = bus_input(ival)

ierr, ival = bus_input()

Fortran command syntax:

CALL BUS_INPUT_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 bus numbers.
IVAL = 1 extended bus names.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
113
Power Flow BUS_OUTPUT

1.1.45. BUS_OUTPUT
Use this API to specify or return the bus output option setting, for either numbers or names.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_BUS_OUTPUT IVAL

Python command syntax:

ierr = bus_output(ival)

ierr, ival = bus_output()

Fortran command syntax:

CALL BUS_OUTPUT_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 bus numbers.
IVAL = 1 extended bus names.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
114
Power Flow BUS_SIZE_LEVEL

1.1.46. BUS_SIZE_LEVEL
Use this API to specify or return the value of the PSSE size level option setting to a multiple of 1,000 be-
tween 1,000 and 200,000.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_BUS_SIZE_LEVEL IVAL

Python command syntax:

ierr = bus_size_level(ival)

ierr, ival = bus_size_level()

Fortran command syntax:

CALL BUS_SIZE_LEVEL_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1000 by de-
fault; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met
IERR = 4 unable to change bus size. PSSE Xplore is lim-
ited to 50 buses.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
115
Power Flow CASE

1.1.47. CASE
Use this API to open a PSSE Saved Case file and transfers its data into the PSSE working case.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_CASE SFILE

Python command syntax:

ierr = case(sfile)

Fortran command syntax:

CALL CASENW(SFILE, IERR)

Where:

Character*260 SFILE name of the PSSE saved case file If SFILE is "*", CASENW attempts to
reopen the most recently accessed Saved Case File. If no Saved Case
File was accessed in the current execution of PSSE, CASENW returns
an error code (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 SFILE is blank
IERR = 2 error reading from SFILE
IERR = 3 error opening SFILE
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
116
Power Flow CA_ITERATIONS

1.1.48. CA_ITERATIONS
Use this API to specify or return the contingency iterations limit setting.

This API routine was first introduced in release 34.1.0.

Batch command syntax:

BAT_CA_ITERATIONS IVAL

Python command syntax:

ierr = ca_iterations(ival)

ierr, ival = ca_iterations()

Fortran command syntax:

CALL CA_ITERATIONS(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 20 by default;
else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
117
Power Flow CHECKVOLTAGELIMITS

1.1.49. CHECKVOLTAGELIMITS
Use this API to tabulate those buses where voltage magnitude is beyond their normal or emergency volt-
age limits. This check may be performed for all buses in the working case or for all buses in a specified sub-
system.

This API routine was first introduced in release 33.1.0.

Batch command syntax:

BAT_CHECKVOLTAGELIMITS SID ALL OPT THRSH

Python command syntax:

ierr = checkvoltagelimits(sid, all, opt, thrsh)

Fortran command syntax:

CALL CHECKVOLTAGELIMITS(SID, ALL, OPT, THRSH, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer OPT set of voltage limits to be used (input; 1 by default).
OPT = 1 normal limits
OPT = 2 emergency limits
Real THRSH voltage limit threshold (-0.05 < THRSH < 0.05) (input0.0).
THRSH = 0.0 log voltages above upper limit or below lower
limit
THRSH > 0.0 log voltages beyond or within THRSH of a lim-
it
THRSH < 0.0 log voltage outside a limit by more than (-
THRSH)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid OPT value
IERR = 4 invalid THRSH value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
118
Power Flow CHECK_POWERFLOW_DATA

1.1.50. CHECK_POWERFLOW_DATA
Use this API routine to perform data checks on the selected categories of powerflow data for all buses in
the working case or for all buses in a specified subsystem.

This API routine was first introduced in release 33.1.0.

Batch command syntax:

BAT_CHECK_POWERFLOW_DATA SID ALL OPT

Python command syntax:

ierr = check_powerflow_data(sid, all, opt)

Fortran command syntax:

CALL CHECK_POWERFLOW_DATA(SID, ALL, OPT, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer OPT powerflow data category to be checked (input; 0 by default).
OPT = 0 all data categories
OPT = 1 bus data
OPT = 2 load data
OPT = 3 plant data
OPT = 4 generator unit data
OPT = 5 induction machine data
OPT = 6 fixed bus shunt data
OPT = 7 switched shunt data
OPT = 8 non-transformer branch data
OPT = 9 two-winding transformer data
OPT = 10 three-winding transformer data
OPT = 11 transformer impedance table correction data
OPT = 12 multi-section line data
OPT = 13 two-terminal dc line data
OPT = 14 multi-terminal dc line data
OPT = 15 VSC dc line data
OPT = 16 FACTS device data
OPT = 17 GNE device data
OPT = 18 area interchange data
OPT = 19 owner data

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
119
Power Flow CHECK_POWERFLOW_DATA

OPT = 20 zone data

OPT = 21 capability curve data
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid OPT value
IERR = 4 capability curve data is not in the working
case
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
120
Power Flow CHKCNTDUPLICON

1.1.51. CHKCNTDUPLICON
Check duplicate labels in Contingengy (CON) file.

This API routine was first introduced in release 33.10.0 and 34.2.0.

Batch command syntax:

BAT_CHKCNTDUPLICON CONFILE

Python command syntax:

ierr, dnum = chkcntduplicon(confile)

Fortran command syntax:

CALL CHKCNTDUPLICON(CONFILE, DNUM, IERR)

Where:

Character*260 CONFILE contingency file name (input).

integer DNUM total number of duplicated contingency labels in the contingency file
(output; 0 by default).
Integer IERR error code (output).
IERR = 1 no CON file specified
IERR = 2 error opening CON file
IERR = 3 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
121
Power Flow CHKCNTDUPLIDFX

1.1.52. CHKCNTDUPLIDFX
Check duplicate labels in DFAX file.

This API routine was first introduced in release 33.10.0 and 34.2.0.

Batch command syntax:

BAT_CHKCNTDUPLIDFX DFXFILE

Python command syntax:

ierr, dnum = chkcntduplidfx(dfxfile)

Fortran command syntax:

CALL CHKCNTDUPLIDFX(DFXFILE, DNUM, IERR)

Where:

Character*260 DFXFILE contingency file name (input).

integer DNUM total number of duplicated contingency labels in the dfax file (out-
put; 0 by default).
Integer IERR error code (output).
IERR = 1 no DFAX file specified
IERR = 2 error opening DFAX file
IERR = 3 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
122
Power Flow CLOSE_POWERFLOW

1.1.53. CLOSE_POWERFLOW
Removes the current powerflow working case from PSSE's working memory. Thus, the PSSE powerflow ar-
rays are in the same state as they are immediately following PSSE startup. The default PSSE program option
settings are unchanged.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_CLOSE_POWERFLOW

Python command syntax:

ierr = close_powerflow()

Fortran command syntax:

CALL CLOSE_POWERFLOW(IERR)

Where:

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
123
Power Flow CLOSE_REPORT

1.1.54. CLOSE_REPORT
Sets the report output device to the standard output and sets the command line to request device selection
for individual reporting activities (Activity CLOS).

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_CLOSE_REPORT

Python command syntax:

ierr = close_report()

Fortran command syntax:

CALL CLOSEREPORTDEVICE(IERR)

Where:

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
124
Power Flow CMPR

1.1.55. CMPR
Use this API to tabulate certain case totals, as contained in the working case, with those of a designated
Saved Case (activity CMPR). Either system totals, area totals, owner totals, or zone totals may be compared.
It must be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by any number of references with APIOPT=2, followed by one ref-
erence with APIOPT=3.
- One reference with APIOPT=0. This automatically combines the processing of one APIOPT 1 reference, fol-
lowed by one APIOPT 2 reference, followed by one APIOPT 3 reference.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_CMPR SID APIOPT STATUS(1)..STATUS(4) THRSH CFILE

Python command syntax:

ierr = cmpr(sid, apiopt, status, thrsh, cfile)

Fortran command syntax:

CALL CMPRNW(SID, APIOPT, STATUS, THRSH, CFILE, IERR)

Where:

Integer SID a valid area, zone or owner subsystem identifier. Valid subsystem
identifiers range from 0 to 11. Subsystem SID must have been previ-
ously defined (input; used only when APIOPT is 0 or 1; 0).
Integer APIOPT mode of operation in the API (input; 0 by default).
APIOPT = 0 initialize for case totals comparison, run the
comparison specified by STATUS(3), and run
post-processing clean up.
APIOPT = 1 initialize system for system, area, owner, zone
totals.
APIOPT = 2 calculate and report system, area, owner,
zone totals.
APIOPT = 3 postprocessing housekeeping.
Integer STATUS (4) array of 4 elements specifying The value of each element is as
follows(input).
STATUS(1) tabulation method (used only when APIOPT
is 0 or 1; 0 by default)
STATUS(1) = 0 tabulate system totals
STATUS(1) = 1 tabulate area totals for area subsystem SID
STATUS(1) = 2 tabulate owner totals for owner subsystem
SID
STATUS(1) = 3 tabulate zone totals for zone subsystem SID
STATUS(2) units for the difference threshold (used only
when APIOPT is 0 or 2; 0 by default)
STATUS(2) = 0 threshold in engineering units

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
125
Power Flow CMPR

STATUS(2) = 1 threshold in percent

STATUS(3) quantity to be compared (used only when
APIOPT is 0 or 2; 1 by default)
STATUS(3) = 1 compare generation
STATUS(3) = 2 compare load
STATUS(3) = 3 compare losses
STATUS(3) = 4 compare mismatch
STATUS(3) = 5 compare interchange; not valid for
STATUS(1) = 2
STATUS(4) file to restore into the working case upon
completion (used only when APIOPT is 0 or
3; 0 by default)
STATUS(4) = 0 restore the working case
STATUS(4) = 1 restore the comparison file to the working
case
Real THRSH difference threshold, in either engineering units or a percent, based
on the value of STATUS(2) (input; used only when APIOPT is 0 or 2;
0.0).
Character*260 CFILE Saved Case file to be compared against the working case (when
APIOPT is 0 or 1) (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid APIOPT value
IERR = 3 invalid STATUS value
IERR = 4 owner (STATUS(1)=2) interchange
(STATUS(3)=5) combination is invalid
IERR = 5 invalid THRSH value
IERR = 6 CFILE is blank
IERR = 7 error writing the working case to a temporary
file
IERR = 8 unexpected APIOPT value
IERR = 9 error reading the comparison case
IERR = 10 error opening the temporary file
IERR = 11 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
126
Power Flow CNTB

1.1.56. CNTB
Use this API to tabulate the voltage setpoints and desired voltage bands of voltage-controlling equipment
in the working case (activity CNTB). Optionally, new scheduled voltages may be specified.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_CNTB SID ALL APIOPT STATUS(1)..STATUS(3) V(1) V(2)

Python command syntax:

ierr, next, bus, ckt, v = cntb(sid, all, apiopt, status, v)

Fortran command syntax:

CALL CNTBNW(SID, ALL, APIOPT, STATUS, NEXT, BUS, CKT, V, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (used only when APIOPT is 2)
(input; 0 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer APIOPT mode of operation in the API (input).
APIOPT = 1 initialize.
APIOPT = 2 specify voltage setpoint for controlled bus.
APIOPT = 3 specify voltage band for load drop compen-
sating transformer.
Integer STATUS (3) array of 3 elements specifying used to control reporting and process-
ing options(input).
STATUS(1) varies by APIOPT
STATUS(1) = 0 For APIOPT=1, list subsystem controlled
buses with conflicts. For APIOPT=2 or 3, no
change
STATUS(1) = 1 For APIOPT=1, list all subsystem controlled
buses. For APIOPT=2, change voltage set-
points to new setpoint in V(1). For APIOPT=3,
change voltage band to new voltage band in
V(1) and V(2)
STATUS(2) varies by APIOPT
STATUS(2) = 0 For APIOPT=1, report at OPENed output de-
vice. For APIOPT=2 or 3, not used
STATUS(2) = 1 For APIOPT=1, list in progress area and allow
voltage schedule change. For APIOPT=2 or 3,
not used

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
127
Power Flow CNTB

STATUS(3) varies by APIOPT

STATUS(3) = 0 For APIOPT=1, process all controlling ele-
ments and controlled buses. For APIOPT=2 or
3, not used
STATUS(3) = 1 For APIOPT=1, process active controlling ele-
ments and controlled buses. For APIOPT=2 or
3, not used
Integer NEXT returned as the next APIOPT value expected by the API (output).
NEXT = 1 done with this execution of CNTBNW.
NEXT = 2 change voltage setpoint/schedule.
NEXT = 3 change VMIN, VMAX of load drop compensat-
ing transformer.
Integer BUS (3) array of 3 elements specifying a returned three bus values(output).
BUS(1) Returned as controlled bus for which voltage
schedule may be changed when Next=2. Re-
turned as controlled bus for which voltage
schedule may be changed when Next=3
BUS(2) Returned as the from bus of the transformer
when Next=3
BUS(3) Returned as the to bus of the transformer
when Next=3
Character*2 CKT returned as the circuit ID of the transformer returned in BUS(2) and
BUS(3) when NEXT returned as 3 (output).
Real V (2) array of 2 elements specifying Voltage values(input).
V(1) New setpoint when APIOPT=2, new VMIN
when APIOPT=3. Returned as present set-
point when NEXT=2, returned as present
VMIN when NEXT=3
V(2) New VMAX when APIOPT=3. Returned as
present VMAX when NEXT=3
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 invalid new voltage setpoint value (V(1) <=
0.5 or V(1) >= 1.5)
IERR = 5 VMIN is not less than VMAX
IERR = 6 invalid APIOPT value
IERR = 7 unexpected APIOPT value
IERR = 8 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
128
Power Flow CONG

1.1.57. CONG
Use this API to convert generators from their power flow representation in preparation for switching stud-
ies and dynamic simulations (activity CONG).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_CONG OPT

Python command syntax:

ierr = cong(opt)

Fortran command syntax:

CALL CONGAPI(OPT, IERR)

Where:

Integer OPT machine impedance option (input; 0 by default).

OPT = 0 use ZSORCE and IMZSRC.
OPT = 1 use fault analysis subtransient impedance
and IMZPOS.
OPT = 2 use fault analysis transient impedance and
IMZPOS.
OPT = 3 use fault analysis synchronous impedance
and IMZPOS.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid OPT value
IERR = 2 generators are already converted
IERR = 3 generator conversion failed due to a machine
impedance of zero
IERR = 4 generator conversion failed due to the pres-
ence of in-service induction machines that
are in the "stalled" or "tripped" state
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
129
Power Flow CONL

1.1.58. CONL
Use this API to convert the constant MVA load for a specified grouping of network loads to a specified mix-
ture of the constant MVA, constant current, and constant admittance load characteristics (activity CONL).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_CONL SID ALL APIOPT STATUS(1) STATUS(2) LOADIN(1).. LOADIN(2)

LOADIN(3) LOADIN(4)

Python command syntax:

ierr, rlods = conl(sid, all, apiopt, status, loadin)

Fortran command syntax:

CALL CONLNW(SID, ALL, APIOPT, STATUS, LOADIN, RLODS, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; used
only when APIOPT is 2; 0).
Integer ALL all buses or specified subsystem flag (input; used only when APIOPT
is 2; 0).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer APIOPT mode of operation in the API (input; no default allowed).
APIOPT = 1 initialize for load conversion.
APIOPT = 2 convert loads.
APIOPT = 3 postprocessing housekeeping.
Integer STATUS (2) array of 2 elements specifying The value of each element is as
follows(input).
STATUS(1) method of conversion (used only when
APIOPT is 1; 0 by default)
STATUS(1) = 0 convert existing constant MVA load
STATUS(1) = 1 reconstruct loads using present voltage, then
convert
STATUS(1) = 2 reconstruct loads using unity voltage, then
convert
STATUS(2) a special OPF bus type code flag (used only
when APIOPT is 2; 0 by default)
STATUS(2) = 0 all buses in subsystem
STATUS(2) = 1 only Type 1 buses in subsystem
STATUS(2) = 2 only Type 2 and 3 buses in subsystem
Real LOADIN (4) array of 4 elements specifying (input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
130
Power Flow CONL

LOADIN(1) percent of active power load to be converted

to the constant current characteristic
LOADIN(2) percent of active power load to be converted
to the constant admittance characteristic
LOADIN(3) percent of reactive power load to be convert-
ed to the constant current characteristic
LOADIN(4) percent of reactive power load to be convert-
ed to the constant admittance characteristic
Integer RLODS returned as the number of unconverted loads remaining in the work-
ing case. If the value is nonzero after a call with APIOPT = 2, and the
remaining loads are to be converted, the API is called again with ALL
= 1 and APIOPT = 2 (output).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid APIOPT value
IERR = 4 invalid STATUS value
IERR = 5 unexpected APIOPT value
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
131
Power Flow CONNECTIVITY_CHECK

1.1.59. CONNECTIVITY_CHECK
Use this API to specify or return the option to enable or disable the solution connectivity checking option
setting.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_CONNECTIVITY_CHECK IVAL

Python command syntax:

ierr = connectivity_check(ival)

ierr, ival = connectivity_check()

Fortran command syntax:

CALL CONNECTIVITY_CHECK_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1 by default;
else output).
IVAL = 0 no solution connectivity check before power
flow solutions.
IVAL = 1 run solution connectivity check before each
power flow solution.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
132
Power Flow CONTROL_AREA_INTERCHANGE

1.1.60. CONTROL_AREA_INTERCHANGE
Use this API to to specify or return the area interchange control option setting to disabled, or enabled with
tie lines only, or enabled with tie lines and loads.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_CONTROL_AREA_INTERCHANGE IVAL

Python command syntax:

ierr = control_area_interchange(ival)

ierr, ival = control_area_interchange()

Fortran command syntax:

CALL CONTROL_AREA_INTERCHANGE_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, then input of
0 by default; else output).
IVAL = 0 disabled.
IVAL = 1 enabled with interchange determined from
tie lines only.
IVAL = 2 enabled with interchange determined from
tie lines and loads.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
133
Power Flow CSV_TO_RAWX

1.1.61. CSV_TO_RAWX
Use this API to import a rawx (extended raw data) data table from a CSV (comma-separated values) file.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_CSV_TO_RAWX

Python command syntax:

ierr = csv_to_rawx(tblname, sfile)

Fortran command syntax:

CALL CSV_TO_RAWX(TBLNAME, SFILE, IERR)

Where:

Character*100 TBLNAME name of the data table to import into (not case sensitive) (input; no
default allowed).
Character*260 SFILE file path of the CSV input file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid tblname
IERR = 2 error opening SFILE
IERR = 3 error generating RAWX data
IERR = 4 error reading RAWX data
IERR = 10 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
134
Power Flow DCCC

1.1.62. DCCC
This API routine is obsolete. It has been replaced by the API routine dccc_2 .

Use this API to run contingency case solutions using a linear network (dc) model (activity DCCC).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_DCCC OPTIONS(1)..OPTIONS(6) VALUES(1)..VALUES(3) DFXFILE

Python command syntax:

ierr = dccc(options, values, dfxfile)

Fortran command syntax:

CALL DCCCAPI(OPTIONS, VALUES, DFXFILE, IERR)

Where:

Integer OPTIONS (6) array of 6 elements specifying calculation and reporting options. The
value of each element is as follows(input).
OPTIONS(1) contingency case rating set (rating set pro-
gram option setting by default)
OPTIONS(1) = 1 RATEA
OPTIONS(1) = 2 RATEB
OPTIONS(1) = 3 RATEC
OPTIONS(2) base case line flow code (0 by default)
OPTIONS(2) = 0 dc base case
OPTIONS(2) = 1 ac base case
OPTIONS(3) format code (0 by default)
OPTIONS(3) = 0 overload output
OPTIONS(3) = 1 full output
OPTIONS(4) exclude cases with no overloads from the
overload report (0 by default)
OPTIONS(4) = 0 no
OPTIONS(4) = 1 yes
OPTIONS(5) convert MVA ratings to estimated MW ratings
(0 by default)
OPTIONS(5) = 0 no
OPTIONS(5) = 1 yes
OPTIONS(6) code to discontinue activity if MW mismatch
exceeds TOLS(1) (0 by default)
OPTIONS(6) = 0 discontinue
OPTIONS(6) = 1 continue
Real VALUES (3) array of 3 elements specifying tolerances and thresholds. The value
of each element is as follows(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
135
Power Flow DCCC

VALUES(1) required MW mismatch tolerance for contin-

uing (Newton solution convergence toler-
ance, TOLN by default)
VALUES(2) percent of rating for reporting an element as
overloaded (100.0 by default)
VALUES(3) minimum contingency case flow change for
including an element in the overload report
(0.0 by default)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 no Distribution Factor Data File specified
IERR = 4 generators are converted
IERR = 5 buses in island(s) without a swing bus; use
activity TREE
IERR = 6 largest mismatch exceeds mismatch toler-
ance
IERR = 7 error opening file DFXFILE
IERR = 8 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 9 file DFXFILE does not contain distribution fac-
tors; run DFAX with distribution factor option
enabled
IERR = 10 no monitored branches or interfaces defined
IERR = 11 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
136
Power Flow DCCC_2

1.1.63. DCCC_2
Use this API to run contingency case solutions using a linear network (dc) model (activity DCCC).

This API routine was first introduced in release 34.0.0.

Batch command syntax:

BAT_DCCC_2 OPTIONS(1)..OPTIONS(8) VALUES(1)..VALUES(3) DFXFILE

Python command syntax:

ierr = dccc_2(options, values, dfxfile)

Fortran command syntax:

CALL DCCC_2 (OPTIONS, VALUES, DFXFILE, IERR)

Where:

Integer OPTIONS (8) array of elements specifying calculation and reporting options. The
value of each element is as follows.(input).
OPTIONS(1) is the loss estimate option (1 by default)
OPTIONS(1) = 0 exclude loss estimate
OPTIONS(1) = 1 use the present voltage vector to estimate
losses and apply them as "hidden loads".
OPTIONS(2) is the regulating phase shifter code. (0 by de-
fault)
OPTIONS(2) = 0 fixed phase shift angles in the base case and
the contingency cases.
OPTIONS(2) = 1 fixed MW in the base case, fixed phase shift
angles in the contingency cases.
OPTIONS(2) = 2 fixed MW in the base case and the contin-
gency cases.
OPTIONS(3) contingency case rating set; 1 through 12
(rating set program option setting by default)
OPTIONS(4) base case line flow code (0 by default)
OPTIONS(4) = 0 dc base case.
OPTIONS(4) = 1 ac base case.
OPTIONS(5) output format code (0 by default)
OPTIONS(5) = 0 overload output.
OPTIONS(5) = 1 full output.
OPTIONS(6) exclude cases with no overloads from the
overload report (0 by default)
OPTIONS(6) = 0 no.
OPTIONS(6) = 1 yes.
OPTIONS(7) convert MVA ratings to estimated MW rat-
ings. (0 by default)
OPTIONS(7) = 0 no.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
137
Power Flow DCCC_2

OPTIONS(7) = 1 yes.
OPTIONS(8) code to discontinue activity if MW mismatch
exceeds VALUES(1). (0 by default)
OPTIONS(8) = 0 discontinue.
OPTIONS(8) = 1 continue.
Real VALUES (3) array of elements specifying tolerances and thresholds. The value of
each element is as follows.(input).
VALUES(1) required MW mismatch tolerance for contin-
uing (Newton solution convergence toler-
ance, TOLN, by default)
VALUES(2) percent of rating for reporting an element as
overloaded. (100 by default)
VALUES(3) minimum contingency case flow change for
including an element in the overload report.
(0.0 by default)
Character*260 DFXFILE Is the name of Distribution Factor Data File (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 no Distribution Factor Data File specified
IERR = 4 generators are converted
IERR = 5 buses in island(s) without a swing bus; use
activity TREE
IERR = 6 largest mismatch exceeds mismatch toler-
ance
IERR = 7 error opening DFXFILE
IERR = 8 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 9 file DFXFILE does not contain distribution fac-
tors; run DFAX with distribution factor option
enabled.
IERR = 10 no monitored branches or interfaces defined.
IERR = 11 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
138
Power Flow DCCOR

1.1.64. DCCOR
Use this API to apply corrective actions to the base case using linear programming methods. The corrective
actions are to eliminate flow overloads with the objective of minimizing the control adjustments, including
load shedding, MW generations dispatch, and phase shifter angle adjustments.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_DCCOR OPTIONS(1)..OPTIONS(7) VALUES(1)..VALUES(6)

LABELS(1)..LABELS(3) DFXFILE

Python command syntax:

ierr = dccor(options, values, labels, dfxfile)

Fortran command syntax:

CALL DCCORAPI(OPTIONS, VALUES, LABELS, DFXFILE, IERR)

Where:
Integer OPTIONS (7) array of 7 elements specifying DC corrective actions solution
options(input).
OPTIONS(1) rating set (rating set program option setting
by default)
OPTIONS(1) = 1 rating A
OPTIONS(1) = 2 rating B
OPTIONS(1) = 3 rating C
OPTIONS(2) generator control flag (1 by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable
OPTIONS(3) load control flag (0 by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) phase shifter control flag (1 by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) convert MVA ratings to estimated MW ratings
(0 by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(6) code to discontinue activity if MW mismatch
exceeds tolerance (VALUES(1) (0 by default)
OPTIONS(6) = 0 disable (i.e. continue, do not discontinue ac-
tivity)
OPTIONS(6) = 1 enable (i.e. discontinue)
OPTIONS(7) modify network data with corrective actions
solutions (1 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
139
Power Flow DCCOR

OPTIONS(7) = 0 disable (i.e. do not modify network data)

OPTIONS(7) = 1 enable (i.e. allow network data to be modi-
fied)
Real VALUES (6) array of 6 elements specifying DC corrective actions
parameters(input).
VALUES(1) MW mismatch tolerance for continuing
(Newton solution convergence tolerance,
TOLN by default)
VALUES(2) percent of rating set (100.0 by default)
VALUES(3) branch flow overload tolerance (0.1 by de-
fault)
VALUES(4) generator control weighting factor (1.0 by
default)
VALUES(5) load control weighting factor (1.0 by default)
VALUES(6) phase shifter control weighting factor (1.0 by
default)
Character*32 LABELS (3) array of 3 elements specifying subsystem labels(input).
LABELS(1) label of generator control subsystem (blank
by default; no default allowed if OPTIONS(2)
is 1)
LABELS(2) label of load control subsystem (blank by de-
fault; no default allowed if OPTIONS(3) is 1)
LABELS(3) label of phase shifter control subsystem
(blank by default; no default allowed if OP-
TIONS(4) is 1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 No controls
IERR = 6 control subsystem not defined
IERR = 7 Distribution Factor Data File not specified
IERR = 8 largest mismatch exceeds tolerance
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
140
Power Flow DCCOR_2

1.1.65. DCCOR_2
Use this API to apply corrective actions to the base case using linear programming methods. The corrective
actions are to eliminate flow overloads with the objective of minimizing the control adjustments, including
load shedding, MW generations dispatch, and phase shifter angle adjustments.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_DCCOR_2 OPTIONS(1)..OPTIONS(7) VALUES(1)..VALUES(6)

LABELS(1)..LABELS(3) DFXFILE

Python command syntax:

ierr = dccor_2(options, values, labels, dfxfile)

Fortran command syntax:

CALL DCCORAPI_2(OPTIONS, VALUES, LABELS, DFXFILE, IERR)

Where:
Integer OPTIONS (8) array of 8 elements specifying DC corrective actions solution
options(input).
OPTIONS(1) rating set (rating set program option setting
by default)
OPTIONS(1) = 1 rating A
OPTIONS(1) = 2 rating B
OPTIONS(1) = 3 rating C
OPTIONS(2) generator control flag (1 by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable
OPTIONS(3) load control flag (0 by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) phase shifter control flag (1 by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) off-line generator control flag (1 by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(6) convert MVA ratings to estimated MW ratings
(0 by default)
OPTIONS(6) = 0 disable
OPTIONS(6) = 1 enable
OPTIONS(7) code to discontinue activity if MW mismatch
exceeds tolerance (VALUES(1) (0 by default)
OPTIONS(7) = 0 disable (i.e. continue, do not discontinue ac-
tivity)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
141
Power Flow DCCOR_2

OPTIONS(7) = 1 enable (i.e. discontinue)

OPTIONS(8) modify network data with corrective actions
solutions (1 by default)
OPTIONS(8) = 0 disable (i.e. do not modify network data)
OPTIONS(8) = 1 enable (i.e. allow network data to be modi-
fied)
Real VALUES (7) array of 7 elements specifying DC corrective actions
parameters(input).
VALUES(1) MW mismatch tolerance for continuing
(Newton solution convergence tolerance,
TOLN by default)
VALUES(2) percent of rating set (100.0 by default)
VALUES(3) branch flow overload tolerance (0.1 by de-
fault)
VALUES(4) generator control weighting factor (1.0 by
default)
VALUES(5) load control weighting factor (1.0 by default)
VALUES(6) phase shifter control weighting factor (1.0 by
default)
VALUES(7) off-line generator control weighting factor
(1.0 by default)
Character*32 LABELS (4) array of 4 elements specifying subsystem labels(input).
LABELS(1) label of generator control subsystem (blank
by default; no default allowed if OPTIONS(2)
is 1)
LABELS(2) label of load control subsystem (blank by de-
fault; no default allowed if OPTIONS(3) is 1)
LABELS(3) label of phase shifter control subsystem
(blank by default; no default allowed if OP-
TIONS(4) is 1)
LABELS(4) label of off-line generator control subsystem
(blank by default; no default allowed if OP-
TIONS(5) is 1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 No controls
IERR = 6 control subsystem not defined
IERR = 7 Distribution Factor Data File not specified
IERR = 8 largest mismatch exceeds tolerance

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
142
Power Flow DCCOR_2

IERR = 21 file DFXFILE is not in the form of a PSSE-25 or

later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
143
Power Flow DCLF

1.1.66. DCLF
This API routine is obsolete. It has been replaced by the API routine dclf_2 .

Use this API to apply the dc analogy network solution algorithm to the network modeled in the working
case (activity DCLF).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_DCLF SID ALL STATUS(1)..STATUS(4) BRNCH(1)..BRNCH(3) CKT

Python command syntax:

ierr = dclf(sid, all, status, brnch, ckt)

Fortran command syntax:

CALL DCLFAPI(SID, ALL, STATUS, BRNCH, CKT, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer STATUS (4) array of 4 elements specifying The value of each element is as
follows(input).
STATUS(1) rating used in tabulating the report (default
rating set program option setting)
STATUS(1) = 1 RATEA
STATUS(1) = 2 RATEB
STATUS(1) = 3 RATEC
STATUS(2) voltage that should be saved (0 by default)
STATUS(2) = 0 original voltages
STATUS(2) = 1 base case dc power flow voltages
STATUS(2) = 2 change case dc power flow voltages
STATUS(3) status of the changed branch upon comple-
tion (0 by default)
STATUS(3) = 0 leave unchanged
STATUS(3) = 1 save changed status
STATUS(4) action code if the MW mismatch exceeds 0.5
MW (1 by default)
STATUS(4) = 0 discontinue
STATUS(4) = 1 continue

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
144
Power Flow DCLF

Integer BRNCH (3) array of 3 elements specifying The use of each element is as follows.
The values can all be zero or defaulted if no branch is to be changed
for the solution(input).
BRNCH(1) from bus of the branch for which status is to
be changed for the solution (0 by default)
BRNCH(2) to bus of the branch for which status is to be
changed for the solution (0 by default)
BRNCH(3) third bus connected by a three-winding
transformer, or zero for a nontransformer
branch or a two-winding transformer (0 by
default)
Character*2 CKT circuit ID of the branch for which status is to be changed for the solu-
tion (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 bus not found
IERR = 5 branch not found
IERR = 6 three-winding transformer not found
IERR = 7 multi-section line specified but multi-section
line reporting option is disabled
IERR = 8 closing a multi-section line is invalid in DCLF
IERR = 9 returning a Type 4 bus to service is not al-
lowed in DCLF
IERR = 10 closing a three-winding transformer is not al-
lowed in DCLF
IERR = 11 generators are converted
IERR = 12 buses in island(s) without a swing bus; use
activity TREE
IERR = 13 largest mismatch exceeds 0.5 MW
IERR = 14 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
145
Power Flow DCLF_2

1.1.67. DCLF_2
Use this API routine to apply the dc analogy network solution algorithm to the network modeled in the
working case (activity DCLF).

This API routine was first introduced in release 34.0.0.

Batch command syntax:

BAT_DCLF_2 SID ALL STATUS(1)..STATUS(6) BRNCH(1)..BRNCH(3) CKT

Python command syntax:

ierr = dclf_2(sid, all, status, brnch, ckt)

Fortran command syntax:

CALL DCLF_2(SID, ALL, STATUS, BRNCH, CKT, IERR)

Where:

Integer SID Is a valid subsystem identifier. Valid subsystem identifiers range from
0 to 11. Subsystem SID must have been previously defined. (input; 1
by default).
Integer ALL Is the all buses or specified subsystem flag. (input; 1 by default).
Integer STATUS (6) array of elements specifying calculation options. The value of each
element is as follows.(input).
STATUS(1) is the loss estimate option. (1 by default)
STATUS(1) = 0 exclude loss estimate.
STATUS(1) = 1 use the present voltage vector to estimate
losses and apply them as "hidden loads".
STATUS(2) is the regulating phase shifter code (0 by de-
fault)
STATUS(2) = 0 fixed phase shift angles in the base case and
the change case.
STATUS(2) = 1 fixed MW in the base case, fixed phase shift
angles in the change case.
STATUS(2) = 2 fixed MW in the base case and the change
case.
STATUS(3) is rating used in tabulating the report; 1
through 12 (default rating set program op-
tion setting by default).
STATUS(4) is the voltage that should be saved. (0 by de-
fault)
STATUS(4) = 0 original voltages.
STATUS(4) = 1 base case dc power flow voltages.
STATUS(4) = 2 change case dc power flow voltages.
STATUS(5) is status of the changed branch upon com-
pletion (0 by default)
STATUS(5) = 0 leave unchanged.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
146
Power Flow DCLF_2

STATUS(5) = 1 save changed status.

STATUS(6) is action code if the MW mismatch exceeds
0.5 MW. (1 by default)
STATUS(6) = 0 discontinue.
STATUS(6) = 1 continue.
Integer BRNCH (3) array of elements specifying calculation options. The use of each
element is as follows. The values can all be zero or defaulted if no
branch is to be changed for the solution.(input).
BRNCH(1) is the from bus of the branch for which sta-
tus is to be changed for the solution (0 by de-
fault)
BRNCH(2) is the to bus of the branch for which status is
to be changed for the solution (0 by default)
BRNCH(3) is the third bus connected by a three-wind-
ing transformer, or zero for a nontransformer
branch or a two-winding transformer (0 by
default)
Character*2 CKT Is the circuit ID of the branch for which status is to be changed for
the solution (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined.
IERR = 2 invalid ALL value.
IERR = 3 invalid STATUS value.
IERR = 4 bus not found.
IERR = 5 branch not found.
IERR = 6 three-winding transformer not found.
IERR = 7 multi-section line specified but multi-section
line reporting option is disabled.
IERR = 8 closing a multi-section line is invalid in DCLF.
IERR = 9 returning a Type 4 bus to service is not al-
lowed in DCLF.
IERR = 10 closing a three-winding transformer is not al-
lowed in DCLF.
IERR = 11 generators are converted.
IERR = 12 buses in island(s) without a swing bus; use
activity TREE
IERR = 13 largest mismatch exceeds 0.5 MW.
IERR = 14 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
147
Power Flow DCPSCOPF

1.1.68. DCPSCOPF
This API is the DC based Preventive Security Constrained Optimal Power Flow solution (DCPSCOPF). This API
is used to find the settings of controls for a system to comply with base case and contingency case oper-
ation limits. The API is implemented with DC preventive security constrained optimal power flow method
(DCPSCOPF). The objective of the DCPSCOPF is to minimize control adjustments subject to operation lim-
its constraints. The available controls are generation MW outputs of on-line and off-line generators, loads,
phase shifters.

This API routine was first introduced in release 35.2.0.

Batch command syntax:

BAT_DCPSCOPF OPTIONS(1)..OPTIONS(7) VALUES(1)..VALUES(6)

LABELS(1)..LABELS(5) DFXFILE INLFILE THRFILE

Python command syntax:

ierr = dcpscopf(options, values, labels, dfxfile, inlfile, thrfile)

Fortran command syntax:

CALL DCPSCOPFAPI(OPTIONS, VALUES, LABELS, DFXFILE, INLFILE, THRFILE, IERR)

Where:
Integer OPTIONS (7) array of elements specifying power flow options(input).
OPTIONS(1) dispatch mode (0 by default)
OPTIONS(1) = 0 disable.
OPTIONS(1) = 1 subsystem machines (RESERVE).
OPTIONS(1) = 2 subsystem machines (PMAX).
OPTIONS(1) = 3 subsystem machines (INERTIA).
OPTIONS(1) = 4 subsystem machines (GOVERNOR DROOP).
OPTIONS(2) Ignore initial violations in the base case (1 by
default)
OPTIONS(2) = 0 No
OPTIONS(2) = 1 Yes
OPTIONS(3) Abort if MW mismatch exceeds tolerance (0
by default)
OPTIONS(3) = 0 No
OPTIONS(3) = 1 Yes
OPTIONS(4) generator control flag (1 by default)
OPTIONS(4) = 0 disable generation MW dispatch
OPTIONS(4) = 1 enable
OPTIONS(5) load control flag (0 by default)
OPTIONS(5) = 0 disable load shedding control
OPTIONS(5) = 1 enable
OPTIONS(6) phase shifter control flag (1 by default)
OPTIONS(6) = 0 disable phase shifter control
OPTIONS(6) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
148
Power Flow DCPSCOPF

OPTIONS(7) off-line generator control flag (0 by default)

OPTIONS(7) = 0 disable generation MW dispatch of off-line
generators
OPTIONS(7) = 1 enable
Real VALUES (6) array of elements specifying power flow options(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Flow tolerance in linear programming
VALUES(3) Weighting factor of generation MW dispatch
(1.0 by default)
VALUES(4) Weighting factor of load control (1.0 by de-
fault)
VALUES(5) Weighting factor of phase shifter control (1.0
by default)
VALUES(6) Weighting factor of generation MW dispatch
of off-line generators (1.0 by default)
Character*32 LABELS (5) array of elements specifying labels(input).
LABELS(1) The label of generation dispatch system, re-
quired if the dispatch mode of OPTIONS(15)
is not zero. The dispatch mode and the sys-
tem provide for a default dispatch method
for contingencies causing unbalance be-
tween load demand and generation output
(blank for none).
LABELS(2) The label of generation dispatch control sys-
tem. MW injections of the generators within
the system are available for dispatch in the
corrective action mode or preventive security
constrained optimal power flow mode (blank
for none).
LABELS(3) The label of load control system. Loads in the
load control system are available for curtail-
ment in the corrective action mode or pre-
ventive security constrained optimal power
flow mode (blank for none).
LABELS(4) The label of phase shifter adjustment system.
The phase angles of phase shifters in the sys-
tem are regulated either by corrective action
or preventive security constrained optimal
power flow (blank for none).
LABELS(5) The label of generation MW control of off-
line generator control system. MW injections
of the off-line generators within the system
are available for dispatch in the corrective ac-
tion mode or preventive security constrained
optimal power flow mode (blank for none).
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
149
Power Flow DCPSCOPF

Character*260 INLFILE Is the name of Load Throwover Data File (input, blank for none). (in-
put).
Character*260 THRFILE Is the name of Unit Inertia Data File (input, blank for none). (input).
Integer IERR error code (output).
IERR = -1 PSCOPF terminates with active constraints
IERR = 0 No error
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 Generation subsystem not specified
IERR = 7 too many islands in base case
IERR = 8 buses with bus type code and series element
status inconsistencies
IERR = 9 no Distribution Factor Data File specified
IERR = 10 No controls are specified
IERR = 11 No constraints are specified
IERR = 12 Simulation STOP. Duplicated contingency la-
bels in DFAX file
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 error opening Load Throwover Data File
IERR = 53 error opening Unit Inertia and Governor Data
File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
150
Power Flow DC_TAP_ADJUSTMENT

1.1.69. DC_TAP_ADJUSTMENT
Use this API to specify or return the option to enable or disable the dc tap adjustment option setting.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_DC_TAP_ADJUSTMENT IVAL

Python command syntax:

ierr = dc_tap_adjustment(ival)

ierr, ival = dc_tap_adjustment()

Fortran command syntax:

CALL DC_TAP_ADJUSTMENT_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 disabled.
IVAL = 1 enabled.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
151
Power Flow DELTMPFILES

1.1.70. DELTMPFILES
Delete closed temporary files. PSSE creates a subdirectory within the user's "temporary" directory; only files
there are removed.

This API routine was first introduced in release 32.2.0.

Batch command syntax:

BAT_DELTMPFILES

Python command syntax:

ierr = deltmpfiles()

Fortran command syntax:

CALL DELTMPFILES(IERR)

Where:

Integer IERR error code (output).

IERR = 1 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
152
Power Flow DFAX

1.1.71. DFAX
This API routine is obsolete. It has been replaced by the API routine dfax_2 .

Use this API to construct a Distribution Factor Data File (activity DFAX).

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_DFAX OPTIONS(1) OPTIONS(2) SUBFILE MONFILE CONFILE DFXFILE

Python command syntax:

ierr = dfax(options, subfile, monfile, confile, dfxfile)

Fortran command syntax:

CALL DFAXAPI(OPTIONS, SUBFILE, MONFILE, CONFILE, DFXFILE, IERR)

Where:
Integer OPTIONS (2) array of 2 elements specifying calculation options. The value of each
element is as follows(input).
OPTIONS(1) distribution factor option flag (1 by default)
OPTIONS(1) = 0 do not calculate distribution factors (i.e.,
DFAX,AC)
OPTIONS(1) = 1 calculate distribution factors
OPTIONS(2) monitored element sorting flag (0 by de-
fault)
OPTIONS(2) = 0 do not sort (i.e., leave in Monitored Element
Description File order)
OPTIONS(2) = 1 sort
Character*260 SUBFILE name of the Subsystem Description File; blank for none (input; blank
by default).
Character*260 MONFILE name of Monitored Element Description File (input; no default al-
lowed).
Character*260 CONFILE name of Contingency Description Data File (input; no default al-
lowed).
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted
IERR = 3 buses in island(s) without a swing bus; use
activity TREE
IERR = 4 no Distribution Factor Data File specified
IERR = 5 no Monitored Element Data input file speci-
fied

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
153
Power Flow DFAX

IERR = 6 no Contingency Description Data file speci-

fied
IERR = 7 fatal error reading input file
IERR = 8 error opening output file DFXFILE
IERR = 9 error opening input file SUBFILE
IERR = 10 error opening input file MONFILE
IERR = 11 error opening input file CONFILE
IERR = 12 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
154
Power Flow DFAX_2

1.1.72. DFAX_2
Use this API to construct a Distribution Factor Data File (activity DFAX).

This API routine was first introduced in release 33.6.0.

Batch command syntax:

BAT_DFAX_2 OPTIONS(1)..OPTIONS(3) SUBFILE MONFILE CONFILE DFXFILE

Python command syntax:

ierr = dfax_2(options, subfile, monfile, confile, dfxfile)

Fortran command syntax:

CALL DFAXAPI_2(OPTIONS, SUBFILE, MONFILE, CONFILE, DFXFILE, IERR)

Where:

Integer OPTIONS (3) array of elements specifying calculation options. The value of each
element is as follows.(input).
OPTIONS(1) distribution factor option flag. (1 by default)
OPTIONS(1) = 0 do not calculate distribution factors (i.e.,
DFAX,AC).
OPTIONS(1) = 1 calculate distribution factors.
OPTIONS(2) monitored element sorting flag (0 by de-
fault)
OPTIONS(2) = 0 do not sort (i.e., leave in Monitored Element
Description File order).
OPTIONS(2) = 1 sort.
OPTIONS(3) out-of-service monitored branch flag (0 by
default)
OPTIONS(3) = 0 eliminate out-of-service branch from moni-
tored branches.
OPTIONS(3) = 1 keep out-of-service branch in monitored
branches.
Character*260 SUBFILE Is the name of the Subsystem Description File (input; blank by de-
fault).
Character*260 MONFILE Is the name of Monitored Element Description File (input; no default
allowed).
Character*260 CONFILE Is the name of Contingency Description Data File (input; no default
allowed).
Character*260 DFXFILE Is the name of Distribution Factor Data File (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred.
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
155
Power Flow DFAX_2

IERR = 3 buses in island(s) without a swing bus; use

activity TREE
IERR = 4 no Distribution Factor Data File specified
IERR = 5 no Monitored Element Data input file speci-
fied.
IERR = 6 no Contingency Description Data file speci-
fied.
IERR = 7 fatal error reading input file.
IERR = 8 error opening output file DFXFILE.
IERR = 9 error opening input file SUBFILE.
IERR = 10 error opening input file MONFILE.
IERR = 11 error opening input file CONFILE.
IERR = 12 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
156
Power Flow DFAX_CONTINGENCY

1.1.73. DFAX_CONTINGENCY
Use this API to combine one contingency in the first Distribution Factor file with one contingency in the
second Distribution Factor file and so on, till specified contingency level is reached, to create multiple
event contingencies and then export resulting contingencies to user defined report device.

This API routine was first introduced in release 31.0.0.

Python command syntax:

ierr = dfax_contingency(option, confile, dfxfile)

Fortran command syntax:

CALL DFAX_CONTINGENCY(OPTION, CONFILE, DFXFILE, IERR)

Where:

Integer OPTION level of multiple contingencies (input; from 1 to 3; 1).

Character*260 CONFILE name of Contingency Description Data File (input; blank by default).
Character*260 DFXFILE (OPTION) OPTION names of Distribution Factor Data Files where contingencies
are combined each other to build OPTION level contingencies (input;
no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTION value
IERR = 2 Input file is not a Distribution Factor Data File
IERR = 3 error reading Distribution Factor Data File
IERR = 51 error opening Contingency Description Data
File
IERR = 52 error opening Distribution Factor Data File

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
157
Power Flow DFTI

1.1.74. DFTI
Use this API to compare tie lines, as contained in the working case, with those of a designated Saved Case
(activity DFTI). It must be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by any number of references with APIOPT=2, followed by one ref-
erence with APIOPT=3.
- One reference with APIOPT=0. This automatically combines the processing of one APIOPT 1 reference, fol-
lowed by one APIOPT 2 reference, followed by one APIOPT 3 reference.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_DFTI SID APIOPT STATUS(1)..STATUS(5) THRSH CFILE

Python command syntax:

ierr, seqflg = dfti(sid, apiopt, status, thrsh, cfile)

Fortran command syntax:

CALL DFTIAPI(SID, APIOPT, STATUS, THRSH, CFILE, SEQFLG, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; used
only when APIOPT is 0 or 1; 0).
Integer APIOPT mode of operation of DFTIAPI (input; 0 by default).
APIOPT = 0 initialize for case comparison, run the com-
parison specified by STATUS(4), and run post-
processing clean up.
APIOPT = 1 initialize for case comparison.
APIOPT = 2 run a comparison.
APIOPT = 3 post-processing clean up.
Integer STATUS (5) array of 5 elements specifying comparison options(input).
STATUS(1) defines the working case content following
an APIOPT=0 or 3 reference (used only when
APIOPT is 0, 1 or 3; 0 by default)
STATUS(1) = 0 original working case
STATUS(1) = 1 Saved Case specified in CFILE
STATUS(2) flag for method of considering buses in the
two cases to be the same bus (used only
when APIOPT is 0 or 1; 0 by default)
STATUS(2) = 0 same bus numbers
STATUS(2) = 1 same extended bus names
STATUS(2) = 2 same bus numbers and extended bus names
STATUS(3) flag for specifying THRESH (used only when
APIOPT is 0 or 2; 0 by default)
STATUS(3) = 0 engineering units

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
158
Power Flow DFTI

STATUS(3) = 1 percent
STATUS(4) code for the comparison to be run (used only
when APIOPT is 0 or 2; 1 by default)
STATUS(4) = 1 branch status
STATUS(4) = 2 line R, X, B
STATUS(4) = 3 line shunts
STATUS(4) = 4 line ratings
STATUS(4) = 5 metered end
STATUS(4) = 6 line length
STATUS(4) = 7 transformers
STATUS(4) = 8 flow MW or MVAR (from bus)
STATUS(4) = 9 flow MW or MVAR (from & to)
STATUS(4) = 10 line MW or MVAR losses
STATUS(4) = 11 zero sequence R, X, B
STATUS(4) = 12 zero sequence line shunts
STATUS(4) = 13 transformer connection codes
STATUS(4) = 14 flow MW (from bus)
STATUS(4) = 15 flow MVAR (from bus)
STATUS(4) = 16 flow MW (from and to buses)
STATUS(4) = 17 flow MVAR (from and to buses)
STATUS(4) = 18 line MW losses
STATUS(4) = 19 line MVAR losses
STATUS(5) line rating to be compared when STATUS(4)
is 4 (used only when APIOPT is 0 or 2; 0 by
default)
STATUS(5) = 0 all ratings
STATUS(5) = 1 RATEA
STATUS(5) = 2 RATEB
STATUS(5) = 3 RATEC
Real THRSH difference threshold (input; used only when APIOPT is 0 or 2; 0.0).
Character*260 CFILE name of Saved Case File in which tie lines are to be compared to
those of the working case (when APIOPT is 0 or 1) (input; no default
allowed).
Logical SEQFLG (2) array of 2 elements specifying returned when APIOPT=0 or 1(output).
SEQFLG(1) true if there is sequence data in the working
case
SEQFLG(2) true if there is sequence data in the Saved
Case in file CFILE
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid STATUS value
IERR = 3 CFILE is blank

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
159
Power Flow DFTI

IERR = 4 no ties to compare

IERR = 5 invalid APIOPT value
IERR = 6 unexpected APIOPT value
IERR = 7 invalid THRSH value
IERR = 8 error reading the comparison case
IERR = 9 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
160
Power Flow DIFF

1.1.75. DIFF
Use this API to compare specified power flow data and solution results, as contained in the working case,
with those of a designated Saved Case (activity DIFF). It must be referenced first with APIOPT=1, followed
by any number of references with APIOPT=2, followed by one reference with APIOPT=3:

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_DIFF SID ALL APIOPT STATUS(1)..STATUS(4) THRSH(1)..THRSH(3)

CFILE

Python command syntax:

ierr, seqflg = diff(sid, all, apiopt, status, thrsh, cfile)

Fortran command syntax:

CALL DIFFNW(SID, ALL, APIOPT, STATUS, THRSH, CFILE, SEQFLG, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID.
ALL = 1 process all buses.
Integer APIOPT mode of operation in the API (input; no default allowed).
APIOPT = 1 initialize for case comparison.
APIOPT = 2 run case comparison for specified data cate-
gory.
APIOPT = 3 postprocessing housekeeping.
Integer STATUS (4) array of elements specifying STATUS contains various processing op-
tions and has different values or meanings depending on the value
of APIOPT(input).
STATUS(1) working case or threshold option (0 by de-
fault)
STATUS(1) = 0 If APIOPT=1 or 3, leave original case as work-
ing case. If APIOPT=2, thresholds are in en-
ginering units.
STATUS(1) = 1 If APIOPT=1 or 3, leave comparison case
(CFILE) as working case. If APIOPT=2, thresh-
olds are percentages.
STATUS(2) comparison options
STATUS(2) = 0 If APIOPT=1, bus numbers must be the same
to match (default for APIOPT=1 or 3).
STATUS(2) = 1 If APIOPT=1, bus names must be the same to
match. If APIOPT=2, compare bus identifiers
(default for APIOPT=2).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
161
Power Flow DIFF

STATUS(2) = 2 If APIOPT=1, bus numbers and names must

be the same to match. If APIOPT=2, compare
bus type codes.
STATUS(2) = 3 (If APIOPT=2) compare machine statuses.
STATUS(2) = 4 (If APIOPT=2) compare generator MW.
STATUS(2) = 5 (If APIOPT=2) compare generator MW or
MVAR.
STATUS(2) = 6 (If APIOPT=2) compare bus loads.
STATUS(2) = 7 (If APIOPT=2) compare bus shunts.
STATUS(2) = 8 (If APIOPT=2) compare switched shunts.
STATUS(2) = 9 (If APIOPT=2) compare voltage.
STATUS(2) = 10 (If APIOPT=2) compare bus voltage & angle.
STATUS(2) = 11 (If APIOPT=2) compare MBASE & ZSORCE.
STATUS(2) = 12 (If APIOPT=2) compare MBASE & RPOS+jX.
STATUS(2) = 13 (If APIOPT=2) compare MBASE & ZNEG.
STATUS(2) = 14 (If APIOPT=2) compare MBASE & ZZERO.
STATUS(2) = 15 (If APIOPT=2) compare negative sequence
loads.
STATUS(2) = 16 (If APIOPT=2) compare zero sequence loads.
STATUS(2) = 17 (If APIOPT=2) compare branch status.
STATUS(2) = 18 (If APIOPT=2) compare line R, X, & B.
STATUS(2) = 19 (If APIOPT=2) compare line shunts.
STATUS(2) = 20 (If APIOPT=2) compare line ratings.
STATUS(2) = 21 (If APIOPT=2) compare metered end.
STATUS(2) = 22 (If APIOPT=2) compare transformers.
STATUS(2) = 23 (If APIOPT=2) compare from P or Q flow.
STATUS(2) = 24 (If APIOPT=2) compare from and to P or Q
flow.
STATUS(2) = 25 (If APIOPT=2) compare P or Q losses.
STATUS(2) = 26 (If APIOPT=2) compare zero sequence R, X, &
B.
STATUS(2) = 27 (If APIOPT=2) compare zero sequence line
shunts.
STATUS(2) = 28 (If APIOPT=2) compare connection codes.
STATUS(2) = 29 (If APIOPT=2) compare zero sequence mutu-
als.
STATUS(2) = 30 (If APIOPT=2) compare multisection lines.
STATUS(2) = 31 (If APIOPT=2) compare multisection line me-
tered end.
STATUS(2) = 32 (If APIOPT=2) compare load status.
STATUS(2) = 33 (If APIOPT=2) compare line lengths.
STATUS(2) = 34 (If APIOPT=2) compare generator Q.
STATUS(2) = 35 (If APIOPT=2) compare from P flow.
STATUS(2) = 36 (If APIOPT=2) compare from Q flow.
STATUS(2) = 37 (If APIOPT=2) compare from and to P flow.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
162
Power Flow DIFF

STATUS(2) = 38 (If APIOPT=2) compare from and to Q flow.

STATUS(2) = 39 (If APIOPT=2) compare line P losses.
STATUS(2) = 40 (If APIOPT=2) compare line Q losses.
STATUS(2) = 41 (If APIOPT=2) compare shunt status.
STATUS(2) = 42 (If APIOPT=2) compare switched shunt sta-
tus.
STATUS(2) = 43 (If APIOPT=2) compare load scalable flag.
STATUS(2) = 44 (If APIOPT=2) compare MBASE & RPOS+jX'.
STATUS(2) = 45 (If APIOPT=2) compare MBASE & RPOS+jXs.
STATUS(2) = 46 (If APIOPT=2) compare bus substation.
STATUS(2) = 47 (If APIOPT=2) compare node status.
STATUS(2) = 48 (If APIOPT=2) compare switching device sta-
tus.
STATUS(2) = 49 (If APIOPT=2) compare switching device P or
Q flow.
STATUS(2) = 50 (If APIOPT=2) compare switching device P
flow.
STATUS(2) = 51 (If APIOPT=2) compare switching device Q
flow.
STATUS(3) load characteric comparison option (0 by de-
fault)
STATUS(3) = 0 use total nominal load (only used if
APIOPT=2)
STATUS(3) = 1 use contant MVA (only used if APIOPT=2)
STATUS(3) = 2 use constant current (only used if APIOPT=2)
STATUS(3) = 3 use constant admittance (only used if
APIOPT=2)
STATUS(4) line rating to use. (1 by default)
STATUS(4) = 0 use all ratings (only used if APIOPT=2)
STATUS(4) = 1-12 use rating specified (only used if APIOPT=2)
Real THRSH (3) array of 3 elements specifying thresholds (only used when APIOPT is
2)(input).
THRSH(1) difference threshold (0.0 by default)
THRSH(2) voltage or tap ratio threshold (0.0 by default)
THRSH(3) angle threshold (0.0 by default)
Character*260 CFILE saved case to be compared against the data currently in the working
case (only used when APIOPT is 1) (input; no default allowed).
Logical SEQFLG (2) array of 2 elements specifying returned when APIOPT = 1(output).
SEQFLG(1) true if there is sequence data in the working
case
SEQFLG(2) true if there is sequence data in the Saved
Case in file CFILE
Integer IERR error code (output).
IERR = 0 no error occurred

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
163
Power Flow DIFF

IERR = 1 invalid SID value or subsystem SID is not de-

fined
IERR = 2 invalid ALL value
IERR = 3 invalid APIOPT value
IERR = 4 invalid STATUS value
IERR = 5 invalid THRSH value
IERR = 6 CFILE is blank
IERR = 7 unexpected APIOPT value
IERR = 8 error building the case to case translation
files
IERR = 9 error reading the comparison case
IERR = 10 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
164
Power Flow DSCN

1.1.76. DSCN
Use this API to electrically disconnect a bus (activity DSCN).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_DSCN BUS

Python command syntax:

ierr = dscn(bus)

Fortran command syntax:

CALL DSCNAPI(BUS, IERR)

Where:

Integer BUS number of the bus to be disconnected (input; no default allowed).

Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus BUS not found
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
165
Power Flow DUPLICATE_CNTLABEL_CHECK

1.1.77. DUPLICATE_CNTLABEL_CHECK
Use this API to specify or return the option to enable or disable the duplicated contingency labels check
when Distribution Factor Data File (*.dfx) or Contingency Description Data File (*.con) files are used.

This API routine was first introduced in release 33.10.0 and 34.2.0.

Batch command syntax:

BAT_DUPLICATE_CNTLABEL_CHECK STATUS

Python command syntax:

ierr = duplicate_cntlabel_check(status)

ierr, status = duplicate_cntlabel_check()

Fortran command syntax:

CALL DUPLICATE_CNTLABEL_CHECK(STATUS, ICODE, IERR)

Where:

Integer STATUS value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, no default al-
lowed; else output).
STATUS = 0 disable checking duplicated contingency la-
bels in DFAX or CON file.
STATUS = 1 enable checking duplicated contingency la-
bels in DFAX or CON file.
Integer ICODE Indicates the operation mode of the API (no default allowed).
ICODE = 0 set the option setting to the value specified in
STATUS.
ICODE = 1 return the current value of the option setting
in STATUS.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 Invalid STATUS value
IERR = 2 Invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
166
Power Flow ECDI

1.1.78. ECDI
Use this API to place machines in a specified subsystem on- or off-line to satisfy a given subsystem mini-
mum capacity; the in-service machines in the subsystem are then dispatched on the basis of incremental
cost to meet a specified total subsystem generation (activity ECDI).
This API must be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by one reference with APIOPT=2, followed by one or more refer-
ences with APIOPT=3, followed by one reference with APIOPT=4.
- One reference with APIOPT=0. This automatically combines the processing of one APIOPT 1 reference,
followed by one APIOPT 2 reference, followed by one APIOPT 3 reference, followed by one APIOPT 4 refer-
ence.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_ECDI SID ALL APIOPT CFILE STATUS VALUES(1) VALUES(2)

Python command syntax:

ierr = ecdi(sid, all, apiopt, cfile, status, values)

Fortran command syntax:

CALL ECDIAPI(SID, ALL, APIOPT, CFILE, STATUS, VALUES, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; used
only when APIOPT is 0 or 2; 0).
Integer ALL all buses or specified subsystem flag (input; used only when APIOPT
is 0 or 2; 1).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer APIOPT mode of operation of the API (input; 0 by default).
APIOPT = 0 initialize, specify subsystem, process, and
clean up.
APIOPT = 1 initialize for dispatch.
APIOPT = 2 specify subsystem.
APIOPT = 3 apply calculation.
APIOPT = 4 postprocessing housekeeping.
Character*260 CFILE name of the Economic Dispatch Data File (when APIOPT is 0 or 1) (in-
put; no default allowed).
Integer STATUS unit commitment option (input; used only when APIOPT is 0 or 2; 0).
STATUS = 0 start from current commitment profile.
STATUS = 1 new commitment profile (start with all units
off-line).
STATUS = 2 unit commitment disabled.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
167
Power Flow ECDI

Real VALUES (2) array of 2 elements specifying (used only when APIOPT is 0 or 3)(in-
put).
VALUES(1) desired loading (present loading by default)
VALUES(2) desired minimum capacity of units being dis-
patched (0 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid APIOPT value
IERR = 3 invalid ALL value
IERR = 4 invalid STATUS value
IERR = 5 dispatch unable to meet desired power and
capacity
IERR = 6 no dispatch data for any subsystem machines
IERR = 7 negative VALUES value
IERR = 8 unexpected APIOPT value
IERR = 9 error opening CFILE
IERR = 10 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
168
Power Flow ECHO

1.1.79. ECHO
Use this API to enable or disable response echoing (activity ECHO).

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_ECHO IDVFIL

Python command syntax:

ierr = echo(idvfil)

Fortran command syntax:

CALL ECHOAPI(IDVFIL, IERR)

Where:

Character*260 IDVFIL name of Response File to be constructed (blank to disable) (input;

blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 error opening IDVFIL
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
169
Power Flow EEQV

1.1.80. EEQV
Use this API to construct an electrical equivalent of a specified subsystem of the working case (activity EE-
QV).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_EEQV SID ALL STATUS(1)..STATUS(6) DVAL(1) DVAL(2)

Python command syntax:

ierr = eeqv(sid, all, status, dval)

Fortran command syntax:

CALL EEQVNW(SID, ALL, STATUS, DVAL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer STATUS (6) array of 6 elements specifying They are used to control equivalencing
options. A value of 0 means the option is not enabled. A value of 1
means the option is enabled. They are as follows(input).
STATUS(1) retain area boundary buses (0 by default)
STATUS(2) retain zone boundary buses (0 by default)
STATUS(3) suppress the equivalencing option for phase
shifters (0 by default)
STATUS(4) retain controlled buses (0 by default)
STATUS(5) retain existing branches between retained
buses (0 by default)
STATUS(6) net load and shunt at retained buses (0 by
default)
Real DVAL (2) array of 2 elements specifying They are as follows(input).
DVAL(1) minimum active or reactive power genera-
tion for retaining generator buses (0.0 by de-
fault)
DVAL(2) branch threshold tolerance (10.0 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
170
Power Flow EEQV

IERR = 3 invalid STATUS value

IERR = 4 invalid DVAL value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
171
Power Flow EQRD

1.1.81. EQRD
Use this API to build an electrical equivalent of radial and, optionally, two-point Type 1 buses in a specified
subsystem of the working case (activity EQRD).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_EQRD SID ALL STATUS(1)..STATUS(8)

Python command syntax:

ierr = eqrd(sid, all, status)

Fortran command syntax:

CALL EQRDNW(SID, ALL, STATUS, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer STATUS (8) array of 8 elements specifying They are used to control equivalencing
options. A value of 0 means the option is not enabled. A value of 1
means the option is enabled. They are as follows(input).
STATUS(1) build an electrical equivalent of radial buses
only (0 by default)
STATUS(2) suppress the equivalencing option for trans-
formers (0 by default)
STATUS(3) suppress the equivalencing option for zero
impedance lines (0 by default)
STATUS(4) suppress the equivalencing option for con-
trolled buses (0 by default)
STATUS(5) suppress the equivalencing option for mutu-
ally coupled branches (0 by default)
STATUS(6) suppress the equivalencing option for area
boundary buses (0 by default)
STATUS(7) suppress the equivalencing option for zone
boundary buses (0 by default)
STATUS(8) apply transformer impedance correction to
zero sequence network (1 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
172
Power Flow EQRD

IERR = 2 invalid ALL value

IERR = 3 invalid STATUS value
IERR = 4 error writing the working case to a temporary
file
IERR = 5 load table is full; restoring original working
case
IERR = 6 fixed bus shunt table is full; restoring original
working case
IERR = 7 error opening temporary file
IERR = 8 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
173
Power Flow EXAM

1.1.82. EXAM
Use this API to tabulate all power flow data pertaining to a specified bus (activity EXAM).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_EXAM SID ALL

Python command syntax:

ierr = exam(sid, all)

Fortran command syntax:

CALL EXAMNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
174
Power Flow FACT

1.1.83. FACT
Use this API to factorize the network admittance matrix in preparation for switching studies and dynamic
simulations (activity FACT).

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_FACT

Python command syntax:

ierr = fact()

Fortran command syntax:

CALL FACTAPI(IERR)

Where:

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 generators are not converted
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
175
Power Flow FDNS

1.1.84. FDNS
Use this API to apply the fixed slope decoupled Newton-Raphson power flow calculation (activity FDNS).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_FDNS OPTIONS(1)..OPTIONS(8)

Python command syntax:

ierr = fdns(options)

Fortran command syntax:

CALL FDNSAPI(OPTIONS, IERR)

Where:

Integer OPTIONS (8) array of 8 elements specifying solution options(input).

OPTIONS(1) tap adjustment flag (use tap adjustment op-
tion setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (use area
interchange adjustment option setting by de-
fault)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (use phase shift
adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (use dc tap adjust-
ment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (use
switched shunt adjustment option setting by
default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
176
Power Flow FDNS

OPTIONS(6) flat start flag (0 by default)

OPTIONS(6) = 0 do not flat start
OPTIONS(6) = 1 flat start
OPTIONS(6) = 2 flat start, then estimate voltage magnitudes
OPTIONS(6) = 3 flat start, then estimate voltage phase angles
OPTIONS(6) = 4 flat start, then estimate voltage magnitudes
and phase angles
OPTIONS(7) var limit flag (99 by default)
OPTIONS(7) = 0 apply var limits immediately
OPTIONS(7) > 0 apply var limits on iteration n (or sooner if
mismatch gets small)
OPTIONS(7) = -1 ignore var limits
OPTIONS(8) non-divergent solution flag (use non-diver-
gent solution option setting by default)
OPTIONS(8) = 0 disable
OPTIONS(8) = 1 enable
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted
IERR = 3 buses in island(s) without a swing bus; use
activity TREE
IERR = 4 bus type code and series element status in-
consistencies
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
177
Power Flow FILE_OVERWRITE

1.1.85. FILE_OVERWRITE
Use this API to specify or return the option to set the file overwrite option setting to either ask first or over-
write.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_FILE_OVERWRITE IVAL

Python command syntax:

ierr = file_overwrite(ival)

ierr, ival = file_overwrite()

Fortran command syntax:

CALL FILE_OVERWRITE_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1 by default;
else output).
IVAL = 0 ask first.
IVAL = 1 overwrite.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
178
Power Flow FIND

1.1.86. FIND
Use this API to tabulate a list of buses matching a partial extended bus name (activity FIND).

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_FIND NAME BSKV

Python command syntax:

ierr = find(name, bskv)

Fortran command syntax:

CALL FINDAPI(NAME, BSKV, IERR)

Where:

Character*24 NAME bus name, including imbedded asterisks that are treated as wildcard
characters (input; blank by default).
Character*12 BSKV bus base voltage (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 error decoding BSKV
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
179
Power Flow FLAT_START

1.1.87. FLAT_START
Use this API to specify or return the option to enable or disable the voltage flat start option setting.

This API routine was first introduced in release 35.0.0.

Batch command syntax:

BAT_FLAT_START IVAL

Python command syntax:

ierr = flat_start(ival)

ierr, ival = flat_start()

Fortran command syntax:

CALL FLAT_START_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1 by default;
else output).
IVAL = 0 use present voltages as the starting point in
power flow solutions.
IVAL = 1 flat start voltages before power flow solu-
tions.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
180
Power Flow FNSL

1.1.88. FNSL
Use this API to apply the Newton-Raphson power flow calculation (activity FNSL).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_FNSL OPTIONS(1)..OPTIONS(8)

Python command syntax:

ierr = fnsl(options)

Fortran command syntax:

CALL FNSLAPI(OPTIONS, IERR)

Where:

Integer OPTIONS (8) array of 8 elements specifying solution options(input).

OPTIONS(1) tap adjustment flag (use tap adjustment op-
tion setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (use area
interchange adjustment option setting by de-
fault)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (use phase shift
adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (use dc tap adjust-
ment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (use
switched shunt adjustment option setting by
default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
181
Power Flow FNSL

OPTIONS(6) flat start flag (0 by default)

OPTIONS(6) = 0 do not flat start
OPTIONS(6) = 1 flat start
OPTIONS(6) = 2 flat start, then estimate voltage magnitudes
OPTIONS(6) = 3 flat start, then estimate voltage phase angles
OPTIONS(6) = 4 flat start, then estimate voltage magnitudes
and phase angles
OPTIONS(7) var limit flag (99 by default)
OPTIONS(7) = 0 apply var limits immediately
OPTIONS(7) > 0 apply var limits on iteration n (or sooner if
mismatch gets small)
OPTIONS(7) = -1 ignore var limits
OPTIONS(8) non-divergent solution flag (use non-diver-
gent solution option setting by default)
OPTIONS(8) = 0 disable
OPTIONS(8) = 1 enable
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted
IERR = 3 buses in island(s) without a swing bus; use
activity TREE
IERR = 4 bus type code and series element status in-
consistencies
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
182
Power Flow GCAP

1.1.89. GCAP
This API routine is obsolete. It has been replaced by the API routines ReadCapCurves and GCAP_2 .

Use this API to read a data file containing capability curve data and print a report of machine loading and
limit data (activity GCAP). Optionally, machine reactive power limits in the working case may be updated.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_GCAP SID ALL OPT GFILE

Python command syntax:

ierr = gcap(sid, all, opt, gfile)

Fortran command syntax:

CALL GCAPNW(SID, ALL, OPT, GFILE, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID.
ALL = 1 process all buses.
Integer OPT update var limits option (input; 0 by default).
OPT = 0 leave var limits unchanged.
OPT = 1 update var limits in the working case.
Character*260 GFILE Machine Capability Data File (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid OPT value
IERR = 4 error opening GFILE
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
183
Power Flow GCAP_2

1.1.90. GCAP_2
Use this API to print a report of machine loading and reactive power limit data (activity GCAP). Optionally,
machine reactive power limits in the working case may be updated.

This API routine was first introduced in release 35.0.0.

Batch command syntax:

BAT_GCAP_2 SID ALL OPT

Python command syntax:

ierr = gcap_2(sid, all, opt)

Fortran command syntax:

CALL GCAP_2(SID, ALL, OPT, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID.
ALL = 1 process all buses.
Integer OPT update var limits option (input; 0 by default).
OPT = 0 leave var limits unchanged.
OPT = 1 update var limits in the working case.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 capability curve data has not been read into
this case
IERR = 2 invalid SID value or subsystem SID is not de-
fined
IERR = 3 invalid ALL value
IERR = 4 invalid OPT value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
184
Power Flow GDIF

1.1.91. GDIF
Use this API to calculate differences between the working case and a designated Saved Case (activity
GDIF). Results may be programmatically accessed via the internally accessible fetch routines DIFTXT, DIF-
BUS, DIFBRN, DIF3WN, DIF2DC, DIFMDC and DIFFCT.
Usage is: call to GDIFAPI with APIOPT = 0;
multiple calls to fetch routines;
optionally, repeat of above steps for different Saved Case and/or subsystem;
final call to GDIFAPI with APIOPT = 1.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_GDIF SID ALL APIOPT NAMARG FILARG

Python command syntax:

ierr = gdif(sid, all, apiopt, namarg, filarg)

Fortran command syntax:

CALL GDIFAPI(SID, ALL, APIOPT, NAMARG, FILARG, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; used
only when APIOPT is 0; 0).
Integer ALL all buses or specified subsystem flag (input; used only when APIOPT
is 0; 1).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer APIOPT mode of operation of GDIFAPI (input; no default allowed).
APIOPT = 0 apply difference calculations and fill arrays
used by fetch routines.
APIOPT = 1 deallocate arrays used by fetch routines.
Integer NAMARG flag indicating how to match up buses in the two cases (input; used
only when APIOPT is 0; 0).
NAMARG = 0 by bus number only.
NAMARG = 1 by extended bus name only.
NAMARG = 2 by both number and name.
Character*260 FILARG name of Saved Case File to be compared to the working case (when
APIOPT is 0) (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
185
Power Flow GDIF

IERR = 3 invalid APIOPT value

IERR = 4 invalid NAMARG value
IERR = 5 FILARG is blank
IERR = 6 error reading the comparison case
IERR = 7 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
186
Power Flow GENDSP

1.1.92. GENDSP
Use this API to impose a contingency specified in the Distribution Factor Data file and apply the generation
dispatch algorithm used in contingency analysis on the working case. The network can then be solved by
power flow solutions.

This API routine was first introduced in release 31.0.0.

Batch command syntax:

BAT_GENDSP OPTIONS(1) OPTIONS(2) LABELS(1) LABELS(2) DFXFILE THRFILE

INLFILE

Python command syntax:

ierr = gendsp(options, labels, dfxfile, thrfile, inlfile)

Fortran command syntax:

CALL GENDSPAPI(OPTIONS, LABELS, DFXFILE, THRFILE, INLFILE, IERR)

Where:

Integer OPTIONS (2) array of 2 elements specifying options(input).

OPTIONS(1) dispatch mode (1 by default)
OPTIONS(1) = 0 disable dispatch
OPTIONS(1) = 1 subsystem machines (RESERVE)
OPTIONS(1) = 2 subsystem machines (PMAX)
OPTIONS(1) = 3 subsystem machines (INERTIA)
OPTIONS(1) = 4 subsystem machines (GOVERNOR DROOP)
OPTIONS(2) study case (1 by default)
OPTIONS(2) = 0 impose a contingency case on the working
case
OPTIONS(2) = 1 working case
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TIONS(1) is from 1 to 4)
LABELS(2) contingency label (blank by default, no de-
fault allowed if OPTIONS(2) is 0)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid OPTIONS value
IERR = 2 no dispatch subsystem specified

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
187
Power Flow GENDSP

IERR = 3 no contingency specified

IERR = 4 no Distribution Factor Data File specified
IERR = 5 generators are converted
IERR = 6 too many islands in base case
IERR = 7 contingency not found in Distribution Factor
Data File
IERR = 21 file is not in the form of a PSSE-25 or later
DFAX file; run DFAX
IERR = 23 no subsystem defined in Distribution Factor
Data file
IERR = 24 subsystem not found
IERR = 51 error opening Distribution Factor Data File
IERR = 52 error opening Load Throwover Data File
IERR = 53 error opening Unit Inertia and Governor Data
File
IERR = 54 error opening or writing temporary Saved
Case File
IERR = 55 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
188
Power Flow GENS

1.1.93. GENS
Use this API to tabulate the loading and voltage conditions at plant buses (activity GENS).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_GENS SID ALL OPT VREV

Python command syntax:

ierr = gens(sid, all, opt, vrev)

Fortran command syntax:

CALL GENSNW(SID, ALL, OPT, VREV, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer OPT option (input; 4 by default).
OPT = 1 tabulate var limited plants with unequal var
limits.
OPT = 2 tabulate all var limited plants.
OPT = 3 tabulate on-line plants.
OPT = 4 tabulate all plants.
Integer VREV option to select the units in which voltages are tabulated (input; 0 by
default).
VREV = 0 use default voltage units.
VREV = 1 use alternate voltage units.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid OPT value
IERR = 4 invalid VREV value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
189
Power Flow GEOL

1.1.94. GEOL
Use this API to tabulate the loading and voltage conditions at the generator terminals for online machines
at Type 2 and 3 buses in the working case (activity GEOL).

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_GEOL SID ALL OPT

Python command syntax:

ierr = geol(sid, all, opt)

Fortran command syntax:

CALL GEOLNW(SID, ALL, OPT, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer OPT option (input; 1 by default).
OPT = 1 tabulate overloaded machines only.
OPT = 2 tabulate all machines.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid OPT value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
190
Power Flow GETCONTINGENCYSAVEDCASE

1.1.95. GETCONTINGENCYSAVEDCASE
Use this API routine to place the working case in the form of a specified system condition as calculated dur-
ing a previous run of one of the members of the the AC contingency calculation family. This function re-
trieves data from a ZIP Archive Ouptut File that was created during the contingency calculation.

This API routine was first introduced in release 33.4.0.

Batch command syntax:

BAT_GETCONTINGENCYSAVEDCASE PATHZIP ISVFILE

Python command syntax:

ierr = getcontingencysavedcase(pathzip, isvfile)

Fortran command syntax:

CALL GETCONTINGENCYSAVEDCASE(PATHZIP, ISVFILE, IERR)

Where:

Character*260 PATHZIP Is the name of the ZIP Archive Output File (input; no default al-
lowed).
Character*260 ISVFILE Is the name of an Incremental Saved Case File (.isv file) contained in
PATHZIP (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred.
IERR = 1 unable to pick up the base Saved Case File
from the ZIP Archive File.
IERR = 2 error opening the Incremental Saved Case
File.
IERR = 3 error closing the Incremental Saved Case File.
IERR = 4 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
191
Power Flow GIC_PF

1.1.96. GIC_PF
Add activity GIC calculated Mvar Qloss in scaled manner to the working case to arrive at the converged
power flow solution.

This API routine was first introduced in release 34.5.0.

Python command syntax:

ierr = gic_pf(addfile, qpct, method, tap, area, phshift, dctap, swsh,

flat, varlimit, nondiv, pfprogress)

Where:

Character ADDFILE RDCH raw file created by GIC activity that represents Constant Cur-
rent Mvar losses due to GMD corresponding to the working case (in-
put; no default allowed).
real QPCT Percent Mvar loss step size that will be incrementally added to the
working case (input; 100 by default [add all (100%) Mvar losses in
one step]).
character METHOD Power flow solution method (input; last by default).
method = last last power flow method used by working case
method = fnsl full Newton-Raphson
method = fdns fixed slope decoupled Newton-Raphson
method = nsol decoupled Newton-Raphson
integer TAP power flow tap adjustment flag (input; use last solution tap option by
default).
tap = 0 disable
tap = 1 enable stepping adjustment
tap = 2 enable direct adjustment
integer AREA power flow area interchange adjustment flag (input; use last solution
area option by default).
area = 0 disable
area = 1 enable using tie line flows only in calculating
area interchange
area = 2 enable using tie line flows and loads in calcu-
lating area interchange
integer PHSHIFT power flow phase shift adjustment flag (input; use last solution
phshift option by default).
phshift = 0 disable
phshift = 1 enable
integer DCTAP power flow dc tap adjustment flag (input; use last solution dctap op-
tion by default).
dctap = 0 disable
dctap = 1 enable
integer SWSH power flow switched shunt adjustment flag (input; use last solution
swsh option by default).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
192
Power Flow GIC_PF

swsh = 0 disable
swsh = 1 enable
swsh = 2 enable continuous mode, disable discrete
mode
integer FLAT power flow flat start flag (input; use last solution flat option by de-
fault).
flat = 0 do not flat start
flat = 1 flat start
flat = 2 flat start, then estimate voltage magnitudes
flat = 3 flat start, then estimate voltage phase angles
flat = 4 flat start, then estimate voltage magnitudes
and phase angles
integer VARLIMIT power flow var limit flag (input; use last solution varlimit option by
default).
varlimit = 0 apply var limits immediately
varlimit > 0 apply var limits on iteration n (or sooner if
mismatch gets small)
varlimit = -1 ignore var limits
integer NONDIV power flow non-divergent solution flag (not used in NSOL) (input;
use last solution nondiv option by default).
nondiv = 0 disable
nondiv = 1 enable
integer PFPROGRESS flag to show or suppress data change and power flow solution pro-
gres messages (input; 0 by default).
pfprogress = 0 suppress progress
pfprogress = 1 show progress
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 Data change or PF solution error, check
progress for details

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
193
Power Flow GNESTATUS

1.1.97. GNESTATUS
Use this API to specify or return the status of a GNE device.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_GNESTATUS 'NAME' IVAL

Python command syntax:

ierr = gnestatus(name, ival)

ierr, ival = gnestatus(name)

Fortran command syntax:

CALL GNESTATUS(NAME, IVAL, IOCODE, IERR)

Where:

Character*12 NAME name of the GNE device for which the status is to be changed (input;
no default allowed).
Integer IVAL value of the status of the specified GNE device (input; if Batch com-
mand, or for Python if specified as an argument, or for Fortran if
IOCODE is 0, no default allowed; else output).
IVAL = 0 out-of-service.
IVAL = 1 in-service.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the status to the value specified in IVAL.
IOCODE = 1 return the current value of the status in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 GNE device not found
IERR = 2 invalid GNE status value
IERR = 3 invalid IOCODE value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
194
Power Flow GNET

1.1.98. GNET
Use this API to change in-service generation to negative MVA load at all Type 2 and 3 buses in the subsys-
tem specified by the user.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_GNET SID ALL

Python command syntax:

ierr = gnet(sid, all)

Fortran command syntax:

CALL GNETNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
195
Power Flow IMNET

1.1.99. IMNET
Use this API routine to change the status of induction machines that are in-service to out-of-service, and to
replace the power flowing from the network into the machine with constant power load. The routine can
be directed to process either all in-service induction machines, all in-service induction machines within a
specified subsystem, or all in-service induction machines outside of a specified subsystem.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_IMNET SID ALL INOUT

Python command syntax:

ierr = imnet(sid, all, inout)

Fortran command syntax:

CALL IMNET(SID, ALL, INOUT, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only induction machines within, or
outside of, subsystem SID
ALL = 1 process all induction machines
Integer INOUT include or exclude induction machines in subsystem SID (input; 0 by
default).
INOUT = 0 process only machines inside of subsystem
SID
INOUT = 1 process only machines outside of subsystem
SID
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid INOUT value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
196
Power Flow IMOUTAGE

1.1.100. IMOUTAGE
Use this API routine to change the status of induction machines that are in-service, but that have been set
to the "stalled" (for motors) or "tripped" (for generators) state by the power flow solution, to out-of-service.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_IMOUTAGE SID ALL MOTOPT GENOPT

Python command syntax:

ierr = imoutage(sid, all, motopt, genopt)

Fortran command syntax:

CALL IMOUTAGE(SID, ALL, MOTOPT, GENOPT, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only induction machines in subsys-
tem SID
ALL = 1 process all induction machines
Integer MOTOPT "stalled" induction motor option (input; 0 by default).
MOTOPT = 0 set to out-of-service
MOTOPT = 1 leave in-service
Integer GENOPT "tripped" induction generator option (input; 0 by default).
GENOPT = 0 set to out-of-service
GENOPT = 1 leave in-service
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid MOTOPT value
IERR = 4 invalid GENOPT value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
197
Power Flow IMPC

1.1.101. IMPC
Use this API to calculate the impact of transaction events on MW flows using a linear network (dc) model.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_IMPC EVENT DFXFILE ATCFILE

Python command syntax:

ierr = impc(event, dfxfile, atcfile)

Fortran command syntax:

CALL IMPCAPI(EVENT, DFXFILE, ATCFILE, IERR)

Where:

Integer EVENT transaction event number (input; no default allowed).

Character*260 DFXFILE name of DFAX data file (input; no default allowed).
Character*260 ATCFILE name of ATC updates file; blank for none (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no transactions defined
IERR = 2 transaction event not defined
IERR = 3 no name of DFAX data file specified
IERR = 4 error opening ATC updates file
IERR = 5 error opening file DFXFILE
IERR = 6 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 8 no monitored branches or interfaces defined
IERR = 9 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
198
Power Flow IMPLEMENT_TRANSFER

1.1.102. IMPLEMENT_TRANSFER
This API routine is obsolete. It has been replaced by the API routine implement_transfer_2 .

Use this API to apply a specified transfer using the same transfer dispatch methods that are available in the
PV analysis calculation engine.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_IMPLEMENT_TRANSFER OPTIONS(1)..OPTIONS(4) RVAL LABELS(1) LABELS(2)

DFXFILE ECDFILE

Python command syntax:

ierr = implement_transfer(options, rval, labels, dfxfile, ecdfile)

Fortran command syntax:

CALL IMPLEMENT_TRANSFER(OPTIONS, RVAL, LABELS, DFXFILE, ECDFILE, IERR)

Where:
Integer OPTIONS (4) array of 4 elements specifying transfer implementation
options(input).
OPTIONS(1) study (source) system transfer dispatch
method (1 by default)
OPTIONS(1) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(1) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(1) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(1) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(1) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(1) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(1) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(1) = 8 subsystem buses with positive MW machines
via ECDI
OPTIONS(2) opposing (sink) system transfer dispatch
method (1 by default)
OPTIONS(2) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
199
Power Flow IMPLEMENT_TRANSFER

OPTIONS(2) = 2 buses and distribution factors from DFAX file

for buses with positive MW constant MVA
load
OPTIONS(2) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(2) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(2) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(2) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(2) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(2) = 8 subsystem buses with positive MW machines
via ECDI
OPTIONS(3) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(3) = 0 no limits
OPTIONS(3) = 1 honor machine active power limits
OPTIONS(4) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(4) = 0 no limits
OPTIONS(4) = 1 enforce non-negative net active power con-
stant MVA load
Real RVAL transfer increment in MW (input; no default allowed).
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which load is to be decreased (no default al-
lowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which load is to be increased (no default al-
lowed)
Character*260 DFXFILE name of the DFAX data file (input; no default allowed).
Character*260 ECDFILE name of the Economic Dispatch Data file; blank for none (input;
blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid RVAL value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
200
Power Flow IMPLEMENT_TRANSFER

IERR = 4 buses in island(s) without a swing bus; use

activity TREE
IERR = 5 no DFAX data file specified
IERR = 6 no economic dispatch data file specified
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 unable to implement transfer in study system
IERR = 11 unable to implement transfer in opposing sys-
tem
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined
IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 52 error opening DFAX data file
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
201
Power Flow IMPLEMENT_TRANSFER_2

1.1.103. IMPLEMENT_TRANSFER_2
Use this API routine to apply a specified transfer using the same transfer dispatch methods that are avail-
able in the PV analysis calculation engine.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_IMPLEMENT_TRANSFER_2 OPTIONS(1)..OPTIONS(4) RVAL(1)..RVAL(2)

LABELS(1)..LABELS(2) DFXFILE ECDFILE

Python command syntax:

ierr = implement_transfer_2(options, rval, labels, dfxfile, ecdfile)

Fortran command syntax:

CALL IMPLEMENT_TRANSFER_2(OPTIONS, RVAL, LABELS, DFXFILE, ECDFILE, IERR)

Where:

Integer OPTIONS (4) array of elements specifying transfer implementation options (input).
The values are as follows:(input).
OPTIONS(1) study (source) system transfer dispatch
method (1 by default)
OPTIONS(1) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines.
OPTIONS(1) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(1) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(1) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(1) = 5 subsystem buses with positive MW machines
in proportion to their MW output.
OPTIONS(1) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(1) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PMAXMC -
PGENMC).
OPTIONS(1) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(1) = 9 subsystem buses with positive MW machines
via ECDI with unit commitment enabled
OPTIONS(2) opposing (sink) system transfer dispatch
method (1 by default)
OPTIONS(2) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
202
Power Flow IMPLEMENT_TRANSFER_2

OPTIONS(2) = 2 buses and distribution factors from DFAX file

for buses with positive MW constant MVA
load
OPTIONS(2) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(2) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(2) = 5 subsystem buses with positive MW machines
in proportion to their MW output.
OPTIONS(2) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs.
OPTIONS(2) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC).
OPTIONS(2) = 8 subsystem buses with positive MW machines
via ECDI. with unit commitment disabled
OPTIONS(2) = 9 subsystem buses with positive MW machines
via ECDI with unit commitment enabled
OPTIONS(3) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(3) = 0 no limits.
OPTIONS(3) = 1 honor machine active power limits.
OPTIONS(4) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(4) = 0 no limits.
OPTIONS(4) = 1 enforce non-negative net active power con-
stant MVA load.
Real RVAL (2) array of elements specifying transfer implementation options. The
values are as follows:(input).
RVAL(1) the transfer increment in MW
RVAL(2) power factor for load increases in dispatch
methods 2, 3 and 4 (0.0 by default). Specify
RVAL(2) as < 0.0 to retain the original power
factor at each load that is changed.
Character*32 LABELS (2) array of elements specifying subsystem labels (input). The values are
as follows:(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which load is to be decreased
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which load is to be increased
Character*260 DFXFILE Is the name of the Distribution Factor Data file (input; no default al-
lowed).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
203
Power Flow IMPLEMENT_TRANSFER_2

Character*260 ECDFILE Is the name of the Economic Dispatch Data file; blank for none (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred.
IERR = 1 invalid RVAL value.
IERR = 2 invalid OPTIONS value.
IERR = 3 generators are converted.
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 no Distribution Factor Data File specified.
IERR = 6 no Economic Dispatch Data File specified.
IERR = 7 no participating dispatch buses in study sys-
tem.
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error.
IERR = 10 Unable to implement transfer in study sys-
tem.
IERR = 11 Unable to implement transfer in opposing
system
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined.
IERR = 24 subsystem not found.
IERR = 25 specified subsystems overlap.
IERR = 26 no in-service buses in subsystem WORLD.
IERR = 50 error opening Economic Dispatch Data File.
IERR = 52 error opening Distribution Factor Data File.
IERR = 54 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
204
Power Flow INLF

1.1.104. INLF
This API routine is obsolete. It has been replaced by the API routine inlf_2 .

Use this API to apply an inertial or governor response power flow calculation.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_INLF OPTIONS(1)..OPTIONS(7) IFILE

Python command syntax:

ierr = inlf(options, ifile)

Fortran command syntax:

CALL INLFAPI(OPTIONS, IFILE, IERR)

Where:

Integer OPTIONS (7) array of 7 elements specifying solution options(input).

OPTIONS(1) solution type (0 by default)
OPTIONS(1) = 0 inertial
OPTIONS(1) = 1 governor response
OPTIONS(2) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(2) = -1 solution type default (inertial => disable;
governor => stepping)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable stepping adjustment
OPTIONS(2) = 2 enable direct adjustment
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = -1 solution type default (inertial => disable;
governor => enable)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = -1 solution type default (inertial => disable;
governor => enable)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = -1 solution type default (inertial => enable; gov-
ernor => enable)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
205
Power Flow INLF

OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) generator var limit flag (-1 (inertial) or 99
(governor) by default)
OPTIONS(6) = 0 apply var limits immediately
OPTIONS(6) > 0 apply var limits on iteration n (or sooner if
mismatch gets small)
OPTIONS(6) = -1 ignore var limits
OPTIONS(7) missing active power limits flag (only used
in governor response power flow) (0 by de-
fault)
OPTIONS(7) = 0 pre-PSSE-29 approach (0.0 to 1.0 pu for ma-
chines with no Unit Inertia and Governor Da-
ta File record read; working case values for
machines with PMAX defaulted on ECDI data
record)
OPTIONS(7) = 1 0.0 to 1.0 pu for both categories of machines
OPTIONS(7) = 2 working case values for both categories of
machines
Character*260 IFILE name of unit inertia and governor data file; blank for none (input;
blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted
IERR = 3 bus type code and series element status in-
consistencies
IERR = 4 error opening IFILE
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
206
Power Flow INLF_2

1.1.105. INLF_2
Use this API routine to run the second release of the inertial and governor response power flow calculation.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_INLF_2 OPTIONS(1)..OPTIONS(8) IFILE

Python command syntax:

ierr = inlf_2(options, ifile)

Fortran command syntax:

CALL INLF_2(OPTIONS, IFILE, IERR)

Where:

Integer OPTIONS (8) array of 8 elements specifying solution options(input).

OPTIONS(1) solution type (0 by default)
OPTIONS(1) = 0 inertial
OPTIONS(1) = 1 governor response
OPTIONS(2) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(2) = -1 solution type default (inertial => disable;
governor => stepping)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable stepping adjustment
OPTIONS(2) = 2 enable direct adjustment
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = -1 solution type default (inertial => disable;
governor => enable)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = -1 solution type default (inertial => disable;
governor => enable)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = -1 solution type default (inertial => enable; gov-
ernor => enable)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
207
Power Flow INLF_2

OPTIONS(5) = 2 enable continuous mode, disable discrete

mode
OPTIONS(6) generator var limit flag (-1 (inertial) or 99
(governor) by default)
OPTIONS(6) = 0 apply var limits immediately
OPTIONS(6) > 0 apply var limits on iteration n (or sooner if
mismatch gets small)
OPTIONS(6) = -1 ignore var limits
OPTIONS(7) induction motor treatment flag; applied
when an induction motor fails to solve due to
low terminal voltage (0 by default)
OPTIONS(7) = 0 stall
OPTIONS(7) = 1 trip
OPTIONS(8) missing active power limits flag (only used
in governor response power flow) (0 by de-
fault)
OPTIONS(8) = 0 pre-PSSE-29 approach (0.0 to 1.0 pu for ma-
chines with no Unit Inertia and Governor Da-
ta File record read; working case values for
machines with PMAX defaulted on ECDI data
record)
OPTIONS(8) = 1 0.0 to 1.0 pu for both categories of machines
OPTIONS(8) = 2 working case values for both categories of
machines
Character*260 IFILE name of unit inertia and governor data file; blank for none (input;
blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted
IERR = 3 bus type code and series element status in-
consistencies
IERR = 4 error opening IFILE
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
208
Power Flow INTA

1.1.106. INTA
Use this API to summarize tie flows between an interchange area and all other areas in the working case.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_INTA SID ALL

Python command syntax:

ierr = inta(sid, all)

Fortran command syntax:

CALL INTANW(SID, ALL, IERR)

Where:

Integer SID a valid area subsystem identifier. Valid subsystem identifiers range
from 0 to 11. Area subsystem SID must have been previously defined
(input; 0 by default).
Integer ALL all areas or specified subsystem flag (input; 1 by default).
ALL = 0 process only areas in area subsystem SID
ALL = 1 process all areas
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
209
Power Flow INTZ

1.1.107. INTZ
Use this API to summarize tie flows between each zone and all other zones in the working case.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_INTZ SID ALL

Python command syntax:

ierr = intz(sid, all)

Fortran command syntax:

CALL INTZNW(SID, ALL, IERR)

Where:

Integer SID a valid zone subsystem identifier. Valid subsystem identifiers range
from 0 to 11. Zone subsystem SID must have been previously defined
(input; 0 by default).
Integer ALL all zones or specified subsystem flag (input; 1 by default).
ALL = 0 process only zones in zone subsystem SID
ALL = 1 process all zones
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
210
Power Flow ISOLATE_LEVELS

1.1.108. ISOLATE_LEVELS
Use this API to specify or return the maximum number of levels to go outward when isolating an element
by breaker.

This API routine was first introduced in release 34.1.0.

Batch command syntax:

BAT_ISOLATE_LEVELS IVAL IOCODE

Python command syntax:

ierr = isolate_levels(ival, iocode)

Fortran command syntax:

CALL ISOLATE_LEVELS(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 4 by default;
else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
211
Power Flow JOIN

1.1.109. JOIN
The API combines two buses into a single bus.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_JOIN IBUS JBUS STATUS

Python command syntax:

ierr = join(ibus, jbus, status)

ierr, idtrns = join(ibus, jbus, status, nid)

Fortran command syntax:

CALL JOINAPI(IBUS, JBUS, STATUS, NID, IDTRNS, IERR)

Where:

Integer IBUS retained bus number (input).

Integer JBUS eliminated bus number (input).
Integer STATUS line shunt option (input; 1 by default).
STATUS = 0 ignore line shunts of deleted branches
STATUS = 1 add line shunts of deleted branches to shunt
of retained bus
Integer NID number of elements in the IDTRNS array; 0 to suppress setting
IDTRNS; 0 by default
Character*18 IDTRNS (NID) returned as the ID translation originally connected to bus JBUS.
IDTRNS contents: Columns Content 1-2 LD for load. BR for non-trans-
former branch. IM for induction machine MC for machine. SH for
fixed bus shunt T2 for two-winding transformer. T3 for three-wind-
ing transformer. 3-8 For BR and T2 records, bus number at the oth-
er end of the branch. For T3 records, bus number of one of the other
buses connected by the transformer. 9-14 For T3 records, bus num-
ber of the other bus connected by the transformer. 15-16 Old identi-
fier. 17-18 New identifier (output).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 bus not found
IERR = 3 invalid NID value
IERR = 4 IDTRNS is not big enough
IERR = 5 JOIN processing error
IERR = 6 bus is part of a substation
IERR = 7 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
212
Power Flow LAMP

1.1.110. LAMP
Use this API to print power flow solution output, including loadings in amps, in a traditional power flow re-
port format. Bus related information is on the left side of the report and branch related information on the
right side.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_LAMP SID ALL

Python command syntax:

ierr = lamp(sid, all)

Fortran command syntax:

CALL LAMPNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
213
Power Flow LINES_PER_PAGE

1.1.111. LINES_PER_PAGE
Use this API to specify or return the page length limits for the four output devices; also retrieve device
names.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_LINES_PER_PAGE IVAL(1) IVAL(2) IVAL(3) IVAL(4)

Python command syntax:

ierr = lines_per_page(ival)

ierr, ival,devnam = lines_per_page()

Fortran command syntax:

CALL LINES_PER_PAGE_API(IVAL, DEVNAM, IOCODE, IERR)

Where:

Integer IVAL (4) array of 4 elements specifying the page length limits(input).
IVAL(1) lines per page for disk files (no change by de-
fault)
IVAL(2) lines per page for the report window (no
change by default)
IVAL(3) lines per page for the first primary hard copy
device (no change by default)
IVAL(4) lines per page for the second primary hard
copy device (no change by default)
Character*40 DEVNAM (4) array of 4 elements specifying the four devices (when IVAL is out-
put)(output).
DEVNAM(1) 'FILE
DEVNAM(2) 'REPORT WINDOW'
DEVNAM(3) name of first primary hard copy device
DEVNAM(4) name of second primary hard copy device
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option settings to the values specified
in IVAL.
IOCODE = 1 return the current values of the option set-
tings in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 negative IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
214
Power Flow LINES_PER_PAGE_ONE_DEVICE

1.1.112. LINES_PER_PAGE_ONE_DEVICE
Use this API to specify or return the page length limit and device name for one of the four output devices.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_LINES_PER_PAGE_ONE_DEVICE DEVICE IVAL

Python command syntax:

ierr = lines_per_page_one_device(device, ival)

ierr, ival,devnam = lines_per_page_one_device(device)

Fortran command syntax:

CALL LINES_PER_PAGE_ONE_DEVICE_API(DEVICE, IVAL, DEVNAM, IOCODE, IERR)

Where:

Integer DEVICE Indicates which of the four devices is to be processed (input; no de-
fault allowed).
DEVICE = 1 for disk files.
DEVICE = 2 for the report window.
DEVICE = 3 for the first primary hard copy output device.
DEVICE = 4 for the second primary hard copy output de-
vice.
Integer IVAL value of the lines per page option setting of the device correspond-
ing to DEVICE (input; if Batch command, or for Python if specified as
an argument, or for Fortran if IOCODE is 0, no change by default; else
output).
Character*40 DEVNAM returned as the device name of the device corresponding to DEVICE
(when IVAL is output) (output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 negative IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 invalid DEVICE value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
215
Power Flow LINE_SHUNT_REPORTING

1.1.113. LINE_SHUNT_REPORTING
Use this API to specify or return the option to enable or disable the line shunt reporting.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_LINE_SHUNT_REPORTING IVAL

Python command syntax:

ierr = line_shunt_reporting(ival)

ierr, ival = line_shunt_reporting()

Fortran command syntax:

CALL LINE_SHUNT_REPORTING_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 no special reporting of line shunts in POUT,
LOUT and LAMP.
IVAL = 1 include special reporting of line shunts in
POUT, LOUT and LAMP.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
216
Power Flow LIST

1.1.114. LIST
Use this API routine to tabulate the power flow working case in a form suitable for problem data documen-
tation.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_LIST SID ALL OPT VREV

Python command syntax:

ierr = list(sid, all, opt, vrev)

Fortran command syntax:

CALL LISTNW(SID, ALL, OPT, VREV, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer OPT power flow data category to be tabulated (input; 1 by default).
OPT = 1 case summary
OPT = 2 bus data
OPT = 3 switched shunt data
OPT = 4 plant data
OPT = 5 generator unit data
OPT = 6 branch data (single entry)
OPT = 7 branch data (double entry)
OPT = 8 two-winding transformer impedance data
OPT = 9 line shunt data
OPT = 10 dc line data
OPT = 11 area interchange data
OPT = 12 full listing (single entry)
OPT = 13 full listing (double entry)
OPT = 14 impedance table correction data
OPT = 15 multi-section line data
OPT = 16 zone data
OPT = 17 inter-area transfer data
OPT = 18 load data
OPT = 19 owner data
OPT = 20 FACTS device sending end data

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
217
Power Flow LIST

OPT = 21 two-winding transformer winding data

OPT = 22 three-winding transformer impedance data
OPT = 23 three-winding transformer winding data
OPT = 24 three-winding transformer control data
OPT = 25 three-winding transformer general data
OPT = 26 two-winding transformer control data
OPT = 27 FACTS device terminal end data
OPT = 28 fixed bus shunt data
OPT = 29 GNE device data
OPT = 30 induction machine circuit data
OPT = 31 induction machine miscellaneous data
OPT = 32 capability curve data
Integer VREV units used for displaying voltages (input; 0 by default).
VREV = 0 use default voltage units
VREV = 1 use alternate voltage units
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid OPT value
IERR = 4 invalid VREV value
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
218
Power Flow LISTCONTINGENCYSAVEDCASES

1.1.115. LISTCONTINGENCYSAVEDCASES
Use this API routine to obtain a report listing some or all of the system conditions preserved in a ZIP
Archive Output File that was created during a previous run of one of the members of the the AC contin-
gency calculation family.

This API routine was first introduced in release 33.4.0.

Batch command syntax:

BAT_LISTCONTINGENCYSAVEDCASES PATHZIP LABEL

Python command syntax:

ierr = listcontingencysavedcases(pathzip, label)

Fortran command syntax:

CALL LISTCONTINGENCYSAVEDCASES(PATHZIP, LABEL, IERR)

Where:

Character*260 PATHZIP Is the name of the ZIP Archive Output File (input; no default al-
lowed).
Character*32 LABEL Is a label indicating the system condition(s) that are to be tabulat-
ed. blank: list all system conditions. contingency label: list all sys-
tem conditions for the specified contingency label. Base Case: list all
system conditions for the base case; use only for ZIP Archive Output
Files written by the P-V and Q-V analysis functions. (input; no default
allowed).
Integer IERR error code (output).
IERR = 0 no error occurred.
IERR = 1 error opening the file Names.phy in the ZIP
Archive Output File.
IERR = 2 error reading the file Names.phy in the ZIP
Archive Output File.
IERR = 3 error closing the file Names.phy in the ZIP
Archive Output File.
IERR = 4 internal error.
IERR = 5 internal error.
IERR = 6 prerequisite requirements for API are not met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
219
Power Flow LLRF

1.1.116. LLRF
Use this API to apply the line loading relief calculation using a linear network (dc) model. It must first be
called once with APIOPT set to 1, then once for each priority level for which the adjustment method is to
be changed with APIOPT set to 2, and finally once with APIOPT set to 3.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_LLRF APIOPT OPTIONS(1) OPTIONS(2) RVAL DFXFILE

Python command syntax:

ierr = llrf(apiopt, options, rval, dfxfile)

Fortran command syntax:

CALL LLRFAPI(APIOPT, OPTIONS, RVAL, DFXFILE, IERR)

Where:

Integer APIOPT mode of operation (input).

APIOPT = 1 initialize
APIOPT = 2 specify a priority level and the adjustment
method to be applied; must be called once for
each priority level, adjustment method pair to
be specified
APIOPT = 3 specify a line loading relief function, apply
the required calculations, report results, and
terminate
Integer OPTIONS (2) array of 2 elements specifying options and values to be used in the
current calculation phase of LLRFAPI; ignored when APIOPT is 1.
When APIOPT is 2, the elements of OPTIONS define a priority lev-
el and the adjustment method to be used in curtailing or restoring
transactions. When APIOPT is 3, the first element of OPTIONS defines
the line loading relief function to be applied. For the curtail transac-
tions and restore transactions functions, the second element of OP-
TIONS defines the monitored element to be used as the transaction
adjustment target(input).
OPTIONS(1) When APIOPT is 2, priority level When APIOPT
is 3 (no default allowed)
OPTIONS(1) = 0 curtail transactions
OPTIONS(1) = 1 restore transactions
OPTIONS(1) = 2 report distribution factor matrix
OPTIONS(2) When APIOPT is 3, monitored element list in-
dex (1 by default when OPTIONS(1) is 0 or
1).. When APIOPT is 2)
OPTIONS(2) = 0 first in, last out (FILO)
OPTIONS(2) = 1 decreasing order of distribution factor mag-
nitude (DF-ORDER)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
220
Power Flow LLRF

OPTIONS(2) = 2 distribution factor pro rata (DF-PRO RATA)

OPTIONS(2) = 3 pro rata based on the product of distribution
factor and transaction schedule (DF-SCHED-
PRO RATA)
Real RVAL used in the current calculation phase of LLRFAPI; ignored when
APIOPT is 2. When APIOPT is 1, RVAL is the distribution factor toler-
ance used to preclude those transactions with negligible effect on
the target monitored element from the transaction adjustment func-
tions (input; 0.05 by default). When APIOPT is 3, RVAL is the target el-
ement adjustment MW (10.0 by default).
Character*260 DFXFILE name of DFAX data file when APIOPT is 1 (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no transactions defined
IERR = 2 no DFAX data file specified
IERR = 3 invalid OPTIONS value
IERR = 4 invalid RVAL value
IERR = 5 unexpected APIOPT value
IERR = 6 invalid APIOPT value
IERR = 7 error opening file DFXFILE
IERR = 8 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 10 no monitored branches or interfaces defined
IERR = 11 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
221
Power Flow LOAD_REDUCTION

1.1.117. LOAD_REDUCTION
Use this API to tabulate the amount of load reduction in a specified subsystem due to the voltage at the
bus to which the load is connected being below PQBRAK (for constant MVA load) or 0.5 (for constant cur-
rent load.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_LOAD_REDUCTION SID ALL AOZOPT

Python command syntax:

ierr = load_reduction(sid, all, aozopt)

Fortran command syntax:

CALL LOAD_REDUCTION(SID, ALL, AOZOPT, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only loads in subsystem SID
ALL = 1 process all loads
Integer AOZOPT subsystem selection option when area, owner and/or zone are includ-
ed in the subsystem selection criteria (input; 1 by default).
AOZOPT = 1 use the area, owner and/or zone assignments
of the bus to which the load is connected
AOZOPT = 2 use the area, owner and/or zone assignments
of the load
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid AOZOPT value
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
222
Power Flow LOUT

1.1.118. LOUT
Use this API to print the power flow solution results in a traditional power flow report format. Bus related
information is on the left side of the report and branch related information on the right side.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_LOUT SID ALL

Python command syntax:

ierr = lout(sid, all)

Fortran command syntax:

CALL LOUTNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
223
Power Flow LTAP

1.1.119. LTAP
Use this API to insert a bus at a designated location along a line.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_LTAP FRMBUS TOBUS 'CKT' FRACTION NEWNUM 'NEWNAM' NEWKV

Python command syntax:

ierr = ltap(frmbus, tobus, ckt, fraction, newnum, newnam, newkv)

Fortran command syntax:

CALL LTAPAPI(FRMBUS, TOBUS, CKT, FRACTION, NEWNUM, NEWNAM, NEWKV, IERR)

Where:

Integer FRMBUS one of the buses connected by the branch to be tapped (input; no
default allowed).
Integer TOBUS other bus connected by the branch to be tapped (input; no default al-
lowed).
Character*2 CKT circuit identifier of the branch to be tapped (input; '1' by default).
Real FRACTION new bus location relative to bus FRMBUS in per unit of total line
length (input; 0.5).
Integer NEWNUM number to be assigned to the new bus (input; no default allowed).
Character*12 NEWNAM name to be assigned to the new bus (input; blank by default).
Real NEWKV base voltage to be assigned to the new bus (input; base voltage of
bus FRMBUS).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 branch not found
IERR = 3 branch is a transformer
IERR = 4 invalid FRACTION value
IERR = 5 invalid NEWNUM value
IERR = 6 bus number is already assigned to another
bus
IERR = 7 invalid NEWKV value
IERR = 8 bus, branch, or branch ownership tables full
IERR = 9 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
224
Power Flow MACCC

1.1.120. MACCC
This API routine is obsolete. It has been replaced by the API routine maccc_2 .

Use this API to run multiple level contingency analysis. User-specified and automatically-selected contin-
gencies from built-in contingency ranking functions are evaluated individually and in combination with
each other as overlapping outages up to the specified evaluation level.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_MACCC TOL OPTACC(1)..OPTACC(8) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) VALUES(1)..VALUES(3) LABELS(1) LABELS(2) DFXFILE
ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc(tol, optacc, optmac, optrnk, values, labels, dfxfile,

accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCCAPI(TOL, OPTACC, OPTMAC, OPTRNK, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
225
Power Flow MACCC

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1<=OPTMAC
(2)<=3; 1 by default)
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single machine and single branch
outages respectively
OPTMAC(3) = 1 include the contingency combinations, oth-
erwise
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
226
Power Flow MACCC

OPTRNK(2) contingency rating (rating set program op-

tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(10) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(11) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(15) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)
OPTRNK(16) = 0 include only with non-zero rating

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
227
Power Flow MACCC

OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Real VALUES (3) array of 3 elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) percent of rating set (0<= VALUES
(1)<=200.0; 100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(VALUES (3) >=0.0; 0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTMAC value
IERR = 9 invalid OPTRNK value
IERR = 10 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 50 error opening Unit Inertia and Governor Data
File

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
228
Power Flow MACCC

IERR = 51 error opening Contingency Solution Output

File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
229
Power Flow MACCC_2

1.1.121. MACCC_2
Use this API to run the second release of multiple level contingency analysis. User-specified and automati-
cally-selected contingencies from built-in contingency ranking functions are evaluated individually and in
combination with each other as overlapping outages up to the specified evaluation level.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_MACCC_2 TOL OPTACC(1)..OPTACC(10) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) VALUES(1)..VALUES(3) LABELS(1) LABELS(2) DFXFILE
ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_2(tol, optacc, optmac, optrnk, values, labels, dfxfile,

accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCCAPI_2(TOL, OPTACC, OPTMAC, OPTRNK, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
230
Power Flow MACCC_2

OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels)
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
231
Power Flow MACCC_2

OPTMAC(2) = 3 N-3 contingency analysis

OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single machine and single branch
outages respectively
OPTMAC(3) = 1 include the contingency combinations, oth-
erwise
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
232
Power Flow MACCC_2

OPTRNK(10) maximum of branch contingencies from

overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(11) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to eval-uate (>=0; 10
by default)
OPTRNK(15) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Real VALUES (3) array of 3 elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) percent of rating set (0<= VALUES
(1)<=200.0; 100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0.0; 0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
233
Power Flow MACCC_2

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
234
Power Flow MACCC_3

1.1.122. MACCC_3
Use this API to run the third release of multiple level contingency analysis. User-specified and automati-
cally-selected contingencies from built-in contingency ranking functions are evaluated individually and in
combination with each other as overlapping outages up to the specified evaluation level.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_MACCC_2 TOL OPTACC(1)..OPTACC(10) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) VALUES(1)..VALUES(2) LABELS(1) LABELS(2) DFXFILE
ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_3(tol, optacc, optmac, optrnk, values, labels, dfxfile,

accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCCAPI_3(TOL, OPTACC, OPTMAC, OPTRNK, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
235
Power Flow MACCC_3

OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels)
OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 1 N-1 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
236
Power Flow MACCC_3

OPTMAC(2) = 2 N-2 contingency analysis

OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(3) Each element from 3 to 41 of OPTMAC ar-
ray represents a type of contingency combi-
nations in the following order. {S, U, B, SS,
SU, SB, US, UU, UB, BS, BU, BB, SSS, SSB, SSU,
SBS, SBB, SBU, SUS, SUB, SUU, USS, USU,
USB, UUS, UUB, UUU, UBS, UBU, UBB, BSS,
BSU, BSB, SUS, SUB, SUU, BBS, BBU, BBB},
where S, U and B are user specified cases,
single unit (machine) and single branch out-
ages respectively
OPTMAC(3) = 0 (0 by default)
OPTMAC(3) = 1 include the contingency combinations
Integer OPTRNK (15) array of 15 elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(2) = 0 disable
OPTRNK(2) = 1 enable
OPTRNK(3) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(4) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(5) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(6) include branch contingencies from overload
ranking (0 by default)
OPTRNK(6) = 0 disable
OPTRNK(6) = 1 enable
OPTRNK(7) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(8) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(9) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(10) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(10) = 0 disable
OPTRNK(10) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
237
Power Flow MACCC_3

OPTRNK(11) minimum of branch contingencies from volt-

age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(12) maximum of branch contingencies from volt-
age depression ranking to eval-uate (>=0; 10
by default)
OPTRNK(13) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(14) include all branches in voltage depression
ranking (0 by default)
OPTRNK(14) = 0 include only with non-zero rating
OPTRNK(14) = 1 all
OPTRNK(15) include contingencies that create swingless
island (0 by default)
OPTRNK(15) = 0 disable
OPTRNK(15) = 1 enable
Real VALUES (2) array of 2 elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) MW threshold for islanding contingencies
(>=0.0; 0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
238
Power Flow MACCC_3

IERR = 7 too many islands in base case

IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
239
Power Flow MACCC_PARALLEL

1.1.123. MACCC_PARALLEL
Use this API to run the multiple level contingency analysis in parallel when the number of contingency
processors in Program Settings is greater than 1. User-specified and automatically selected contingencies
from built-in contingency ranking functions are evaluated individually and in combination with each other
as overlapping outages up to the specified evaluation level.

This API routine was first introduced in release 33.3.0.

Batch command syntax:

BAT_MACCC_PARALLEL TOL OPTACC(1)..OPTACC(10) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) VALUES(1)..VALUES(3) LABELS(1)..LABELS(2) DFXFILE
ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_parallel(tol, optacc, optmac, optrnk, values, labels,

dfxfile, accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCC_PARALLEL(TOL, OPTACC, OPTMAC, OPTRNK, VALUES, LABELS, DFXFILE,

ACCFILE, THRFILE, INLFILE, IERR)

Where:

Real TOL Is the mismatch tolerance (input; Newton solution convergence toler-
ance, TOLN, by default).
Integer OPTACC (10) array of elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable.
OPTACC(1) = 1 enable stepping adjustment.
OPTACC(1) = 2 enable direct adjustment.
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable.
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange.
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange.
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable.
OPTACC(3) = 1 enable.
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable.
OPTACC(4) = 1 enable.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
240
Power Flow MACCC_PARALLEL

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable.
OPTACC(5) = 1 enable.
OPTACC(5) = 2 enable continuous mode, disable discrete
mode.
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS.
OPTACC(6) = 1 FNSL.
OPTACC(6) = 2 optimized FDNS.
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable.
OPTACC(7) = 1 enable.
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default) (ap-
plied when an induction motor fails to solve
due to low by default)
OPTACC(8) = 0 stall.
OPTACC(8) = 1 trip.
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state.
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable.
OPTACC(10) = 1 subsystem machines (reserve).
OPTACC(10) = 2 subsystem machines (pmax).
OPTACC(10) = 3 subsystem machines (inertia).
OPTACC(10) = 4 subsystem machines (governor droop).
Integer OPTMAC (41) array of elements specifying contingency evaluation level and combi-
nations (input). The values are as follows:(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable.
OPTMAC(1) = 1 enable.
OPTMAC(2) contingency evaluation level.
OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 1 N-1 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
241
Power Flow MACCC_PARALLEL

OPTMAC(3) each element represents a type of contin-

gency combinations in the following order.
(0 by default)
OPTMAC(3) = 0 do not include the contigency combination
OPTMAC(3) = 1 include the "S" contingency combination.
This and the remaining elements of the ar-
ray (i.e. 3-41) individually indicate whether
particular contingency combinations are to
be included. In the following S, U and B re-
fer to user specified cases, single machine
and single branch outages, respectively: {S,
U, B, SS, SU, SB, US, UU, UB, BS, BU, BB, SSS,
SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU, USS,
USU, USB, UUS, UUB, UUU, UBS, UBU, UBB,
BSS, BSU, BSB, SUS, SUB, SUU, BBS, BBU, BBB}
Integer OPTRNK (17) array of elements specifying ranking options. The values are as fol-
lows:(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable.
OPTRNK(1) = 1 enable.
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A.
OPTRNK(2) = 2 rate B.
OPTRNK(2) = 3 rate C.
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable.
OPTRNK(3) = 1 enable.
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable.
OPTRNK(4) = 1 enable.
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable.
OPTRNK(8) = 1 enable.
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
242
Power Flow MACCC_PARALLEL

OPTRNK(10) maximum of branch contingencies from

overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(11) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable.
OPTRNK(12) = 1 enable.
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(15) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)
OPTRNK(16) = 0 include only with non-zero rating.
OPTRNK(16) = 1 all.
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable.
OPTRNK(17) = 1 enable.
Real VALUES (3) array of elements specifying ranking parameters.The values are as
follows: (input).
VALUES(1) small reactance threshold (0<= VAL-
UES(1)<=0.005; 0.0005 by default).
VALUES(2) percent of rating set (0<= VAL-
UES(1)<=200.0; 100.0 by default).
VALUES(3) MW threshold for islanding contingencies
( >=0.0; 0.0 by default).
Character*32 LABELS (2) array of elements specifying subsystem labels. The values are as fol-
lows:(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0).
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Character*260 ACCFILE Is the name of the Contingency Solution Output File (input; no de-
fault allowed).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
243
Power Flow MACCC_PARALLEL

Character*260 THRFILE Is the name of the Load Throwover Data File (input; blank by de-
fault).
Character*260 INLFILE Is the name of the Unit Inertia and Governor Data File (input; blank
by default).
Integer IERR error code (output).
IERR = 0 no error occurred.
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted.
IERR = 4 buses in island(s) without a swing bus; use
activity TREE.
IERR = 5 largest mismatch exceeds mismatch toler-
ance.
IERR = 6 generation subsystem is not defined.
IERR = 7 too many islands in base case.
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value.
IERR = 11 invalid OPTRNK value.
IERR = 12 invalid VALUES value.
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
244
Power Flow MACCC_PARALLEL_2

1.1.124. MACCC_PARALLEL_2
Use this API to run the multiple level contingency analysis in parallel when the number of contingency
processors in Program Settings is greater than 1. User-specified and automatically selected contingencies
from built-in contingency ranking functions are evaluated individually and in combination with each other
as overlapping outages up to the specified evaluation level.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_MACCC_PARALLEL_2 TOL OPTACC(1)..OPTACC(10) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) VALUES(1)..VALUES(3) LABELS(1)..LABELS(2) DFXFILE
ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_parallel_2(tol, optacc, optmac, optrnk, values, labels,

dfxfile, accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCC_PARALLEL_2(TOL, OPTACC, OPTMAC, OPTRNK, VALUES, LABELS,

DFXFILE, ACCFILE, THRFILE, INLFILE, IERR)

Where:

Real TOL Is the mismatch tolerance (input; Newton solution convergence toler-
ance, TOLN, by default).
Integer OPTACC (10) array of elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable.
OPTACC(1) = 1 enable stepping adjustment.
OPTACC(1) = 2 enable direct adjustment.
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable.
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange.
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange.
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable.
OPTACC(3) = 1 enable.
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable.
OPTACC(4) = 1 enable.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
245
Power Flow MACCC_PARALLEL_2

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable.
OPTACC(5) = 1 enable.
OPTACC(5) = 2 enable continuous mode, disable discrete
mode.
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS.
OPTACC(6) = 1 FNSL.
OPTACC(6) = 2 optimized FDNS.
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable.
OPTACC(7) = 1 enable.
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default) (ap-
plied when an induction motor fails to solve
due to low by default)
OPTACC(8) = 0 stall.
OPTACC(8) = 1 trip.
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state.
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable.
OPTACC(10) = 1 subsystem machines (reserve).
OPTACC(10) = 2 subsystem machines (pmax).
OPTACC(10) = 3 subsystem machines (inertia).
OPTACC(10) = 4 subsystem machines (governor droop).
Integer OPTMAC (41) array of elements specifying contingency evaluation level and combi-
nations (input). The values are as follows:(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable.
OPTMAC(1) = 1 enable.
OPTMAC(2) contingency evaluation level.
OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 1 N-1 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
246
Power Flow MACCC_PARALLEL_2

OPTMAC(3) Each element from 3 to 41 of OPTMAC ar-

ray represents a type of contingency combi-
nations in the following order. {S, U, B, SS,
SU, SB, US, UU, UB, BS, BU, BB, SSS, SSB, SSU,
SBS, SBB, SBU, SUS, SUB, SUU, USS, USU,
USB, UUS, UUB, UUU, UBS, UBU, UBB, BSS,
BSU, BSB, SUS, SUB, SUU, BBS, BBU, BBB},
where S, U and B are user specified cases,
single unit (machine) and single branch out-
ages respectively
OPTMAC(3) = 0 (0 by default)
OPTMAC(3) = 1 include the contingency combinations
Integer OPTRNK (15) array of elements specifying ranking options. The values are as fol-
lows:(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable.
OPTRNK(1) = 1 enable.
OPTRNK(2) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(2) = 0 disable.
OPTRNK(2) = 1 enable.
OPTRNK(3) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(4) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(5) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(6) include branch contingencies from overload
ranking (0 by default)
OPTRNK(6) = 0 disable.
OPTRNK(6) = 1 enable.
OPTRNK(7) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(8) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(9) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(10) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(10) = 0 disable.
OPTRNK(10) = 1 enable.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
247
Power Flow MACCC_PARALLEL_2

OPTRNK(11) minimum of branch contingencies from volt-

age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(12) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(13) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(14) include all branches in voltage depression
ranking (0 by default)
OPTRNK(14) = 0 include only with non-zero rating.
OPTRNK(14) = 1 all.
OPTRNK(15) include contingencies that create swingless
island (0 by default)
OPTRNK(15) = 0 disable.
OPTRNK(15) = 1 enable.
Real VALUES (2) array of elements specifying ranking parameters.The values are as
follows: (input).
VALUES(1) small reactance threshold (0<= VAL-
UES(1)<=0.005; 0.0005 by default).
VALUES(2) MW threshold for islanding contingencies
( >=0.0; 0.0 by default).
Character*32 LABELS (2) array of elements specifying subsystem labels. The values are as fol-
lows:(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0).
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Character*260 ACCFILE Is the name of the Contingency Solution Output File (input; no de-
fault allowed).
Character*260 THRFILE Is the name of the Load Throwover Data File (input; blank by de-
fault).
Character*260 INLFILE Is the name of the Unit Inertia and Governor Data File (input; blank
by default).
Integer IERR error code (output).
IERR = 0 no error occurred.
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted.
IERR = 4 buses in island(s) without a swing bus; use
activity TREE.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
248
Power Flow MACCC_PARALLEL_2

IERR = 5 largest mismatch exceeds mismatch toler-

ance.
IERR = 6 generation subsystem is not defined.
IERR = 7 too many islands in base case.
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value.
IERR = 11 invalid OPTRNK value.
IERR = 12 invalid VALUES value.
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
249
Power Flow MACCC_TRIP_COR

1.1.125. MACCC_TRIP_COR
This API routine is obsolete. It has been replaced by the API routine maccc_trip_cor_2 .

Use this API to run multiple AC contingency analysis with tripping simulations and corrective actions. The
user-specified and automatically-selected contingencies are evaluated individually and in combination with
each other as overlapping contingencies. When there are violations in post-tripping simulation solutions,
the corrective actions analysis will be launched to eliminate the violations, with the objective of minimiz-
ing the controls adjustments, including load shedding, MW generation dispatch and phase shifter angle
adjustments.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_MACCC_TRIP_COR TOL OPTACC(1)..OPTACC(8) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) OPTTRP(1)..OPTTRP(3) OPTCOR(1)..OPTCOR(5)
VALUES(1)..VALUES(8) LABELS(1)..LABELS(5) DFXFILE ACCFILE THRFILE
INLFILE TRPFILE

Python command syntax:

ierr = maccc_trip_cor(tol, optacc, optmac, optrnk, opttrp, optcor, values,

labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_TRIP_COR(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, OPTCOR, VALUES,

LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
250
Power Flow MACCC_TRIP_COR

OPTACC(4) dc tap adjustment flag (dc tap adjustment

option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1<=OPTMAC
(2)<=3; 1 by default)
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single machine and single branch
outages respectively
OPTMAC(3) = 1 include the contingency combinations, oth-
erwise
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
251
Power Flow MACCC_TRIP_COR

OPTRNK(1) include ties from contingency subsystem (0

by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(10) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(11) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
252
Power Flow MACCC_TRIP_COR

OPTRNK(15) non-failure cutoff of branch contingencies

from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Integer OPTCOR (5) array of 5 elements specifying corrective actions options(input).
OPTCOR(1) run corrective actions (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number of power flow solutions (from 0 to
10; 1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
Real VALUES (8) array of 8 elements specifying ranking and corrective action
parameters(input).
VALUES(1) small reactance threshold (0<=VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) percent of rating (0<=VALUES (1)<=200.0;
100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0.0; 0.0 by default)
VALUES(4) bus voltage violation tolerance (0.1 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
253
Power Flow MACCC_TRIP_COR

VALUES(5) branch flow overload tolerance (0.1 by de-

fault)
VALUES(6) generator control weighting factor (1.0 by
default)
VALUES(7) load control weighting factor (1.0 by default)
VALUES(8) phase shifter control weighting factor (1.0 by
default)
Character*32 LABELS (5) array of 5 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
LABELS(3) label of generator control subsystem (blank
by default; no default allowed if OPTCOR(3)
is 1)
LABELS(4) label of load control subsystem (blank by de-
fault; no default allowed if OPTCOR(4) is 1)
LABELS(5) label of phase shifter control subsystem
(blank by default; no default allowed if OPT-
COR(5) is 1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTMAC value
IERR = 9 invalid OPTRNK value
IERR = 10 invalid OPTTRP value
IERR = 11 invalid OPTCOR value

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
254
Power Flow MACCC_TRIP_COR

IERR = 12 invalid VALUES value

IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
255
Power Flow MACCC_TRIP_COR_2

1.1.126. MACCC_TRIP_COR_2
This API routine is obsolete. It has been replaced by the API routine maccc_trip_cor_3 .

This API is the second release of function to run multiple AC contingency analysis with tripping simulations
and corrective actions. The user-specified and automatically-selected contingencies are evaluated individ-
ually and in combination each other as overlapping contingencies. Following a post contingency solution,
trip events are simulated if their tripping conditions are satisfied. Corrective actions are then specified au-
tomatically to eliminate the violations in each post tripping solution with the objective of minimizing the
control adjustments including load shedding, MW generation dispatch, phase shifter angle adjustments,
off-line generator controls, tap setting adjustments and switched shunt controls.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_MACCC_TRIP_COR_2 TOL OPTACC(1)..OPTACC(8) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) OPTTRP(1)..OPTTRP(3) OPTCOR(1)..OPTCOR(8)
VALUES(1)..VALUES(11) LABELS(1)..LABELS(8) DFXFILE ACCFILE THRFILE
INLFILE TRPFILE

Python command syntax:

ierr = maccc_trip_cor_2(tol, optacc, optmac, optrnk, opttrp, optcor,

values, labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_TRIP_COR_2(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, OPTCOR, VALUES,

LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
256
Power Flow MACCC_TRIP_COR_2

OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (RESERVE)
OPTACC(8) = 2 subsystem machines (PMAX)
OPTACC(8) = 3 subsystem machines (INERTIA)
OPTACC(8) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) allow multiple contingency analysis (0 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(1) = 2 enabled with failure cutoff disabled
OPTMAC(2) contingency evaluation level (1 by default)
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single unit and single branch out-
ages respectively
OPTMAC(3) = 1 include the contingency combinations

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
257
Power Flow MACCC_TRIP_COR_2

OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).
OPTRNK(1) include ties from subsystem (0 by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) machine overload contingencies (0 by de-
fault)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine overload contingencies
to evaluate (>=0, 1 by default)
OPTRNK(6) maximum of machine overload contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(7) cutoff of machine overload contingencies to
evaluate (>=0, 5 by default)
OPTRNK(8) line overload contingencies (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of line overload contingencies to
evaluate (>=0, 1 by default)
OPTRNK(10) maximum of line overload contingencies to
evaluate (>=0, 10 by default)
OPTRNK(11) cutoff of line overload contingencies (>=0, 5
by default)
OPTRNK(12) voltage collapse line contingencies (0 by de-
fault)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of voltage collapse line contingen-
cies to evaluate (>=0, 1 by default)
OPTRNK(14) maximum of voltage collapse line contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(15) cutoff of voltage collapse line contingencies
(>=0, 5 be default)
OPTRNK(16) include all branches in voltage collapse rank-
ing (0 by default)
OPTRNK(16) = 0 include only with non-zero rating

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
258
Power Flow MACCC_TRIP_COR_2

OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (11) array of 11 elements specifying ranking parameters and corrective
actions parameters(input).
VALUES(1) small reactance threshold, (0<= VALUES
(1)<=0.005, 0.0005 by default)
VALUES(2) percent of flow rating, (0<= VALUES
(2)<=200.0, 100.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
259
Power Flow MACCC_TRIP_COR_2

VALUES(3) MW threshold for islanding contingencies

(>=0, 0.0 by default)
VALUES(4) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(5) branch overload violation tolerance (0.1 by
default)
VALUES(6) generator control weighting factor (1.0 by
default)
VALUES(7) load control weighting factor (1.0 by default)
VALUES(8) phase shifter control weighting factor (1.0 by
default)
VALUES(9) off-line generator control weighting factor
(1.0 by default)
VALUES(10) tap setting adjustment weighting factor (1.0
by default)
VALUES(11) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (8) array of 8 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
LABELS(3) label of generator control subsystem (blank
by default for none, no default allowed if
OPTCOR(3) is 1)
LABELS(4) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(5) label of phase shifter control subsystem
(blank by default for none, no default al-
lowed if OPTCOR(5) is 1)
LABELS(6) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(7) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(8) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank for
none).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
260
Power Flow MACCC_TRIP_COR_2

Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTMAC value
IERR = 9 invalid OPTRNK value
IERR = 10 invalid OPTTRP value
IERR = 11 invalid OPTCOR value
IERR = 12 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
261
Power Flow MACCC_TRIP_COR_3

1.1.127. MACCC_TRIP_COR_3
This API is the third release of function to run multiple AC contingency analysis with tripping simulations
and corrective actions. The user-specified and automatically-selected contingencies are evaluated individ-
ually and in combination each other as overlapping contingencies. Following a post contingency solution,
trip events are simulated if their tripping conditions are satisfied. Corrective actions are then specified au-
tomatically to eliminate the violations in each post tripping solution with the objective of minimizing the
control adjustments including load shedding, MW generation dispatch, phase shifter angle adjustments,
off-line generator controls, tap setting adjustments and switched shunt controls.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_MACCC_TRIP_COR_3 TOL OPTACC(1)..OPTACC(10) OPTMAC(1)..OPTMAC(41)
OPTRNK(1)..OPTRNK(17) OPTTRP(1)..OPTTRP(3) OPTCOR(1)..OPTCOR(8)
VALUES(1)..VALUES(11) LABELS(1)..LABELS(8) DFXFILE ACCFILE THRFILE
INLFILE TRPFILE

Python command syntax:

ierr = maccc_trip_cor_3(tol, optacc, optmac, optrnk, opttrp, optcor,
values, labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_TRIP_COR_3(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, OPTCOR, VALUES,
LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
262
Power Flow MACCC_TRIP_COR_3

OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (RESERVE)
OPTACC(10) = 2 subsystem machines (PMAX)
OPTACC(10) = 3 subsystem machines (INERTIA)
OPTACC(10) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) allow multiple contingency analysis (0 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(1) = 2 enabled with failure cutoff disabled
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
263
Power Flow MACCC_TRIP_COR_3

the event list at the first level is used for any

higher levels)
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single unit and single branch out-
ages respectively
OPTMAC(3) = 1 include the contingency combinations
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).
OPTRNK(1) include ties from subsystem (0 by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) machine overload contingencies (0 by de-
fault)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine overload contingencies
to evaluate (>=0, 1 by default)
OPTRNK(6) maximum of machine overload contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(7) cutoff of machine overload contingencies to
evaluate (>=0, 5 by default)
OPTRNK(8) line overload contingencies (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of line overload contingencies to
evaluate (>=0, 1 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
264
Power Flow MACCC_TRIP_COR_3

OPTRNK(10) maximum of line overload contingencies to

evaluate (>=0, 10 by default)
OPTRNK(11) cutoff of line overload contingencies (>=0, 5
by default)
OPTRNK(12) voltage collapse line contingencies (0 by de-
fault)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of voltage collapse line contingen-
cies to evaluate (>=0, 1 by default)
OPTRNK(14) maximum of voltage collapse line contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(15) cutoff of voltage collapse line contingencies
(>=0, 5 be default)
OPTRNK(16) include all branches in voltage collapse rank-
ing (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
265
Power Flow MACCC_TRIP_COR_3

OPTCOR(6) off-line generator control flag (0 by default)

OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (11) array of 11 elements specifying ranking parameters and corrective
actions parameters(input).
VALUES(1) small reactance threshold, (0<= VALUES
(1)<=0.005, 0.0005 by default)
VALUES(2) percent of flow rating, (0<= VALUES
(2)<=200.0, 100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0, 0.0 by default)
VALUES(4) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(5) branch overload violation tolerance (0.1 by
default)
VALUES(6) generator control weighting factor (1.0 by
default)
VALUES(7) load control weighting factor (1.0 by default)
VALUES(8) phase shifter control weighting factor (1.0 by
default)
VALUES(9) off-line generator control weighting factor
(1.0 by default)
VALUES(10) tap setting adjustment weighting factor (1.0
by default)
VALUES(11) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (8) array of 8 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
LABELS(3) label of generator control subsystem (blank
by default for none, no default allowed if
OPTCOR(3) is 1)
LABELS(4) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
266
Power Flow MACCC_TRIP_COR_3

LABELS(5) label of phase shifter control subsystem

(blank by default for none, no default al-
lowed if OPTCOR(5) is 1)
LABELS(6) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(7) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(8) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank for
none).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid OPTTRP value
IERR = 13 invalid OPTCOR value
IERR = 14 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia Data File

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
267
Power Flow MACCC_TRIP_COR_3

IERR = 51 error opening Contingency Solution Output

File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
268
Power Flow MACCC_TRIP_COR_4

1.1.128. MACCC_TRIP_COR_4
This API is the third release of function to run multiple AC contingency analysis with tripping simulations
and corrective actions. The user-specified and automatically-selected contingencies are evaluated individ-
ually and in combination each other as overlapping contingencies. Following a post contingency solution,
trip events are simulated if their tripping conditions are satisfied. Corrective actions are then specified au-
tomatically to eliminate the violations in each post tripping solution with the objective of minimizing the
control adjustments including load shedding, MW generation dispatch, phase shifter angle adjustments,
off-line generator controls, tap setting adjustments and switched shunt controls.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_MACCC_TRIP_COR_4 TOL OPTACC(1)..OPTACC(10) OPTMAC(1)..OPTMAC(41)
OPTRNK(1)..OPTRNK(17) OPTTRP(1)..OPTTRP(3) OPTCOR(1)..OPTCOR(8)
VALUES(1)..VALUES(11) LABELS(1)..LABELS(8) DFXFILE ACCFILE THRFILE
INLFILE TRPFILE

Python command syntax:

ierr = maccc_trip_cor_4(tol, optacc, optmac, optrnk, opttrp, optcor,
values, labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_TRIP_COR_4(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, OPTCOR, VALUES,
LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
269
Power Flow MACCC_TRIP_COR_4

OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (RESERVE)
OPTACC(10) = 2 subsystem machines (PMAX)
OPTACC(10) = 3 subsystem machines (INERTIA)
OPTACC(10) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) allow multiple contingency analysis (0 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(1) = 2 enabled with failure cutoff disabled
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
270
Power Flow MACCC_TRIP_COR_4

the event list at the first level is used for any

higher levels)
OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(3) Each element from 3 to 41 of OPTMAC ar-
ray represents a type of contingency combi-
nations in the following order. {S, U, B, SS,
SU, SB, US, UU, UB, BS, BU, BB, SSS, SSB, SSU,
SBS, SBB, SBU, SUS, SUB, SUU, USS, USU,
USB, UUS, UUB, UUU, UBS, UBU, UBB, BSS,
BSU, BSB, SUS, SUB, SUU, BBS, BBU, BBB},
where S, U and B are user specified cases,
single unit (machine) and single branch out-
ages respectively
OPTMAC(3) = 0 (0 by default)
OPTMAC(3) = 1 include the contingency combinations
Integer OPTRNK (15) array of 15 elements specifying ranking options(input).
OPTRNK(1) include ties from subsystem (0 by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) machine overload contingencies (0 by de-
fault)
OPTRNK(2) = 0 disable
OPTRNK(2) = 1 enable
OPTRNK(3) minimum of machine overload contingencies
to evaluate (>=0, 1 by default)
OPTRNK(4) maximum of machine overload contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(5) cutoff of machine overload contingencies to
evaluate (>=0, 5 by default)
OPTRNK(6) line overload contingencies (0 by default)
OPTRNK(6) = 0 disable
OPTRNK(6) = 1 enable
OPTRNK(7) minimum of line overload contingencies to
evaluate (>=0, 1 by default)
OPTRNK(8) maximum of line overload contingencies to
evaluate (>=0, 10 by default)
OPTRNK(9) cutoff of line overload contingencies (>=0, 5
by default)
OPTRNK(10) voltage collapse line contingencies (0 by de-
fault)
OPTRNK(10) = 0 disable
OPTRNK(10) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
271
Power Flow MACCC_TRIP_COR_4

OPTRNK(11) minimum of voltage collapse line contingen-

cies to evaluate (>=0, 1 by default)
OPTRNK(12) maximum of voltage collapse line contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(13) cutoff of voltage collapse line contingencies
(>=0, 5 be default)
OPTRNK(14) include all branches in voltage collapse rank-
ing (0 by default)
OPTRNK(14) = 0 include only with non-zero rating
OPTRNK(14) = 1 all
OPTRNK(15) include contingencies that create swingless
island (0 by default)
OPTRNK(15) = 0 disable
OPTRNK(15) = 1 enable
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable tripping simulation
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
272
Power Flow MACCC_TRIP_COR_4

OPTCOR(8) = 1 enable
Real VALUES (10) array of 10 elements specifying ranking parameters and corrective
actions parameters(input).
VALUES(1) small reactance threshold, (0<= VALUES
(1)<=0.005, 0.0005 by default)
VALUES(2) MW threshold for islanding contingencies
(>=0, 0.0 by default)
VALUES(3) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(4) branch overload violation tolerance (0.1 by
default)
VALUES(5) generator control weighting factor (1.0 by
default)
VALUES(6) load control weighting factor (1.0 by default)
VALUES(7) phase shifter control weighting factor (1.0 by
default)
VALUES(8) off-line generator control weighting factor
(1.0 by default)
VALUES(9) tap setting adjustment weighting factor (1.0
by default)
VALUES(10) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (8) array of 8 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
LABELS(3) label of generator control subsystem (blank
by default for none, no default allowed if
OPTCOR(3) is 1)
LABELS(4) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(5) label of phase shifter control subsystem
(blank by default for none, no default al-
lowed if OPTCOR(5) is 1)
LABELS(6) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(7) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(8) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
273
Power Flow MACCC_TRIP_COR_4

Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank for
none).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid OPTTRP value
IERR = 13 invalid OPTCOR value
IERR = 14 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
274
Power Flow MACCC_WITH_COR

1.1.129. MACCC_WITH_COR
This API routine is obsolete. It has been replaced by the API routine maccc_with_cor_2 .

Use this API to run multiple AC contingency analysis with corrective actions. The user-specified and auto-
matically-selected contingencies are evaluated individually and in combination with each other as overlap-
ping contingencies. The corrective actions analysis will be launched for the contingencies with flow and
voltage violations to eliminate the violations with the objective of minimizing the controls adjustments in-
cluding load shedding, MW generation dispatch and phase shifter angle adjustments.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_MACCC_WITH_COR TOL OPTACC(1)..OPTACC(8) OPTMAC(1)..OPTMAC(41)

OPTRNK(1)..OPTRNK(17) OPTCOR(1)..OPTCOR(5) VALUES(1)..VALUES(8)
LABELS(1)..LABELS(5) DFXFILE ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_with_cor(tol, optacc, optmac, optrnk, optcor, values, labels,

dfxfile, accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCC_WITH_COR(TOL, OPTACC, OPTMAC, OPTRNK, OPTCOR, VALUES, LABELS,

DFXFILE, ACCFILE, THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
275
Power Flow MACCC_WITH_COR

OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1<=OPTMAC
(2)<=3; 1 by default)
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single machine and single branch
outages respectively
OPTMAC(3) = 1 include the contingency combinations
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying contingency ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
276
Power Flow MACCC_WITH_COR

OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
(>=0)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(10) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(11) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(15) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
277
Power Flow MACCC_WITH_COR

OPTRNK(16) = 0 include only with non-zero rating

OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTCOR (5) array of 5 elements specifying corrective actions options(input).
OPTCOR(1) run corrective actions (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number of power flow solutions (from 0 to
10; 1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
Real VALUES (8) array of 8 elements specifying ranking and corrective actions
parameters(input).
VALUES(1) small reactance threshold (0<=VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) percent of rating set (0<=VALUES
(1)<=200.0; 100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0.0; 0.0 by default)
VALUES(4) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(5) branch flow overload tolerance (0.1 by de-
fault)
VALUES(6) generator control weighting factor (1.0 by
default)
VALUES(7) load control weighting factor (1.0 by default)
VALUES(8) phase shifter control weighting factor (1.0 by
default)
Character*32 LABELS (5) array of 5 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
278
Power Flow MACCC_WITH_COR

LABELS(3) label of generator control subsystem (blank

by default; no default allowed if OPTCOR(3)
is 1)
LABELS(4) label of load control subsystem (blank by de-
fault; no default allowed if OPTCOR(4) is 1)
LABELS(5) label of phase shifter control subsystem
(blank by default; no default allowed if OPT-
COR(5) is 1)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTMAC value
IERR = 9 invalid OPTRNK value
IERR = 10 invalid OPTCOR value
IERR = 11 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
279
Power Flow MACCC_WITH_COR_2

1.1.130. MACCC_WITH_COR_2
This API routine is obsolete. It has been replaced by the API routine maccc_with_cor_3 .

This API is the second release of function to run multiple AC contingency analysis with corrective actions.
The user-specified and automatically-selected contingencies are evaluated individually and in combination
each other as overlapping contingencies. Corrective actions are specified automatically to eliminate the vi-
olations in each post contingency solution with the objective of minimizing the controls adjustments in-
cluding load shedding, MW generation dispatch, phase shifter angle adjustments, off-line generator con-
trols, tap setting adjustments and switched shunt controls.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_MACCC_WITH_COR_2 TOL OPTACC(1)..OPTACC(8) OPTMAC(1).. OPTMAC(41)

OPTRNK(1)..OPTRNK(17) OPTCOR(1)..OPTCOR(8) VALUES(1)..VALUES(11)
LABELS(1)..LABELS(8) DFXFILE ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_with_cor_2(tol, optacc, optmac, optrnk, optcor, values,

labels, dfxfile, accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCC_WITH_COR_2(TOL, OPTACC, OPTMAC, OPTRNK, OPTCOR, VALUES,

LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, IERR)

Where:

Real TOL mismatch tolerance (input; Newton solution convergence tolerance,

TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
280
Power Flow MACCC_WITH_COR_2

OPTACC(4) dc tap adjustment flag (dc tap adjustment

option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (RESERVE)
OPTACC(8) = 2 subsystem machines (PMAX)
OPTACC(8) = 3 subsystem machines (INERTIA)
OPTACC(8) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) allow multiple contingency analysis (0 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(1) = 2 enabled with failure cutoff disabled
OPTMAC(2) contingency evaluation level (1 by default)
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single unit and single branch out-
ages respectively
OPTMAC(3) = 1 include the contingency combinations
OPTMAC(3) = 0 (0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
281
Power Flow MACCC_WITH_COR_2

Integer OPTRNK (17) array of 17 elements specifying ranking options(input).

OPTRNK(1) include ties from subsystem (0 by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) machine overload contingencies (0 by de-
fault)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine overload contingencies
to evaluate (>=0, 1 by default)
OPTRNK(6) maximum of machine overload contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(7) cutoff of machine overload contingencies to
evaluate (>=0, 5 by default)
OPTRNK(8) line overload contingencies (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of line overload contingencies to
evaluate (>=0, 1 by default)
OPTRNK(10) maximum of line overload contingencies to
evaluate (>=0, 10 by default)
OPTRNK(11) cutoff of line overload contingencies (>=0, 5
by default)
OPTRNK(12) voltage collapse line contingencies (0 by de-
fault)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of voltage collapse line contingen-
cies to evaluate (>=0, 1 by default)
OPTRNK(14) maximum of voltage collapse line contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(15) cutoff of voltage collapse line contingencies
(>=0, 5 be default)
OPTRNK(16) include all branches in voltage collapse rank-
ing (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
282
Power Flow MACCC_WITH_COR_2

OPTRNK(17) include contingencies that create swingless

island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (11) array of 11 elements specifying ranking parameters and corrective
actions parameters(input).
VALUES(1) small reactance threshold, (0<= VALUES
(1)<=0.005, 0.0005 by default)
VALUES(2) percent of flow rating, (0<= VALUES
(2)<=200.0, 100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0, 0.0 by default)
VALUES(4) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(5) branch overload violation tolerance (0.1 by
default)
VALUES(6) generator control weighting factor (1.0 by
default)
VALUES(7) load control weighting factor (1.0 by default)
VALUES(8) phase shifter control weighting factor (1.0 by
default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
283
Power Flow MACCC_WITH_COR_2

VALUES(9) off-line generator control weighting factor

(1.0 by default)
VALUES(10) tap setting adjustment weighting factor (1.0
by default)
VALUES(11) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (8) array of 8 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is 1)
LABELS(2) label of contingency subsystem (blank by de-
fault)
LABELS(3) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(4) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(5) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
LABELS(6) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(7) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(8) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia and Governor Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 invalid OPTMAC value
IERR = 9 invalid OPTRNK value

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
284
Power Flow MACCC_WITH_COR_2

IERR = 10 invalid OPTCOR value

IERR = 11 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
285
Power Flow MACCC_WITH_COR_3

1.1.131. MACCC_WITH_COR_3
This API is the third release of function to run multiple AC contingency analysis with corrective actions.
The user-specified and automatically-selected contingencies are evaluated individually and in combination
each other as overlapping contingencies. Corrective actions are specified automatically to eliminate the vi-
olations in each post contingency solution with the objective of minimizing the controls adjustments in-
cluding load shedding, MW generation dispatch, phase shifter angle adjustments, off-line generator con-
trols, tap setting adjustments and switched shunt controls.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_MACCC_WITH_COR_3 TOL OPTACC(1)..OPTACC(10) OPTMAC(1).. OPTMAC(41)

OPTRNK(1)..OPTRNK(17) OPTCOR(1)..OPTCOR(8) VALUES(1)..VALUES(11)
LABELS(1)..LABELS(8) DFXFILE ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_with_cor_3(tol, optacc, optmac, optrnk, optcor, values,

labels, dfxfile, accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCC_WITH_COR_3(TOL, OPTACC, OPTMAC, OPTRNK, OPTCOR, VALUES,

LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
286
Power Flow MACCC_WITH_COR_3

OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (RESERVE)
OPTACC(10) = 2 subsystem machines (PMAX)
OPTACC(10) = 3 subsystem machines (INERTIA)
OPTACC(10) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) allow multiple contingency analysis (0 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(1) = 2 enabled with failure cutoff disabled
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
287
Power Flow MACCC_WITH_COR_3

OPTMAC(2) = 1 N-1 contingency analysis

OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single unit and single branch out-
ages respectively
OPTMAC(3) = 1 include the contingency combinations
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).
OPTRNK(1) include ties from subsystem (0 by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) machine overload contingencies (0 by de-
fault)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine overload contingencies
to evaluate (>=0, 1 by default)
OPTRNK(6) maximum of machine overload contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(7) cutoff of machine overload contingencies to
evaluate (>=0, 5 by default)
OPTRNK(8) line overload contingencies (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of line overload contingencies to
evaluate (>=0, 1 by default)
OPTRNK(10) maximum of line overload contingencies to
evaluate (>=0, 10 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
288
Power Flow MACCC_WITH_COR_3

OPTRNK(11) cutoff of line overload contingencies (>=0, 5

by default)
OPTRNK(12) voltage collapse line contingencies (0 by de-
fault)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of voltage collapse line contingen-
cies to evaluate (>=0, 1 by default)
OPTRNK(14) maximum of voltage collapse line contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(15) cutoff of voltage collapse line contingencies
(>=0, 5 be default)
OPTRNK(16) include all branches in voltage collapse rank-
ing (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
289
Power Flow MACCC_WITH_COR_3

Real VALUES (11) array of 11 elements specifying ranking parameters and corrective
actions parameters(input).
VALUES(1) small reactance threshold, (0<= VALUES
(1)<=0.005, 0.0005 by default)
VALUES(2) percent of flow rating, (0<= VALUES
(2)<=200.0, 100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0, 0.0 by default)
VALUES(4) bus voltage violation tolerance (0.1 by de-
fault)
VALUES(5) branch overload violation tolerance (0.1 by
default)
VALUES(6) generator control weighting factor (1.0 by
default)
VALUES(7) load control weighting factor (1.0 by default)
VALUES(8) phase shifter control weighting factor (1.0 by
default)
VALUES(9) off-line generator control weighting factor
(1.0 by default)
VALUES(10) tap setting adjustment weighting factor (1.0
by default)
VALUES(11) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (8) array of 8 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is 1)
LABELS(2) label of contingency subsystem (blank by de-
fault)
LABELS(3) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(4) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(5) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
LABELS(6) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(7) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(8) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
290
Power Flow MACCC_WITH_COR_3

Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia and Governor Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid OPTCOR value
IERR = 13 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
291
Power Flow MACCC_WITH_COR_4

1.1.132. MACCC_WITH_COR_4
This API is the third release of function to run multiple AC contingency analysis with corrective actions.
The user-specified and automatically-selected contingencies are evaluated individually and in combination
each other as overlapping contingencies. Corrective actions are specified automatically to eliminate the vi-
olations in each post contingency solution with the objective of minimizing the controls adjustments in-
cluding load shedding, MW generation dispatch, phase shifter angle adjustments, off-line generator con-
trols, tap setting adjustments and switched shunt controls.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_MACCC_WITH_COR_4 TOL OPTACC(1)..OPTACC(10) OPTMAC(1).. OPTMAC(41)

OPTRNK(1)..OPTRNK(17) OPTCOR(1)..OPTCOR(8) VALUES(1)..VALUES(11)
LABELS(1)..LABELS(8) DFXFILE ACCFILE THRFILE INLFILE

Python command syntax:

ierr = maccc_with_cor_4(tol, optacc, optmac, optrnk, optcor, values,

labels, dfxfile, accfile, thrfile, inlfile)

Fortran command syntax:

CALL MACCC_WITH_COR_4(TOL, OPTACC, OPTMAC, OPTRNK, OPTCOR, VALUES,

LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
292
Power Flow MACCC_WITH_COR_4

OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous, disable discrete
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (RESERVE)
OPTACC(10) = 2 subsystem machines (PMAX)
OPTACC(10) = 3 subsystem machines (INERTIA)
OPTACC(10) = 4 subsystem machines (GOVERNOR DROOP)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) allow multiple contingency analysis (0 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(1) = 2 enabled with failure cutoff disabled
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
293
Power Flow MACCC_WITH_COR_4

OPTMAC(2) = -3 N-3 contingency analysis

OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(3) Each element from 3 to 41 of OPTMAC ar-
ray represents a type of contingency combi-
nations in the following order. {S, U, B, SS,
SU, SB, US, UU, UB, BS, BU, BB, SSS, SSB, SSU,
SBS, SBB, SBU, SUS, SUB, SUU, USS, USU,
USB, UUS, UUB, UUU, UBS, UBU, UBB, BSS,
BSU, BSB, SUS, SUB, SUU, BBS, BBU, BBB},
where S, U and B are user specified cases,
single unit (machine) and single branch out-
ages respectively
OPTMAC(3) = 0 (0 by default)
OPTMAC(3) = 1 include the contingency combinations
Integer OPTRNK (15) array of 15 elements specifying ranking options(input).
OPTRNK(1) include ties from subsystem (0 by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) machine overload contingencies (0 by de-
fault)
OPTRNK(2) = 0 disable
OPTRNK(2) = 1 enable
OPTRNK(3) minimum of machine overload contingencies
to evaluate (>=0, 1 by default)
OPTRNK(4) maximum of machine overload contingen-
cies to evaluate (>=0, 10 by default)
OPTRNK(5) cutoff of machine overload contingencies to
evaluate (>=0, 5 by default)
OPTRNK(6) line overload contingencies (0 by default)
OPTRNK(6) = 0 disable
OPTRNK(6) = 1 enable
OPTRNK(7) minimum of line overload contingencies to
evaluate (>=0, 1 by default)
OPTRNK(8) maximum of line overload contingencies to
evaluate (>=0, 10 by default)
OPTRNK(9) cutoff of line overload contingencies (>=0, 5
by default)
OPTRNK(10) voltage collapse line contingencies (0 by de-
fault)
OPTRNK(10) = 0 disable
OPTRNK(10) = 1 enable
OPTRNK(11) minimum of voltage collapse line contingen-
cies to evaluate (>=0, 1 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
294
Power Flow MACCC_WITH_COR_4

OPTRNK(12) maximum of voltage collapse line contingen-

cies to evaluate (>=0, 10 by default)
OPTRNK(13) cutoff of voltage collapse line contingencies
(>=0, 5 be default)
OPTRNK(14) include all branches in voltage collapse rank-
ing (0 by default)
OPTRNK(14) = 0 include only with non-zero rating
OPTRNK(14) = 1 all
OPTRNK(15) include contingencies that create swingless
island (0 by default)
OPTRNK(15) = 0 disable
OPTRNK(15) = 1 enable
Integer OPTCOR (8) array of 8 elements specifying corrective actions options(input).
OPTCOR(1) run corrective action (0 by default)
OPTCOR(1) = 0 disable
OPTCOR(1) = 1 enable
OPTCOR(2) number power flows (1 by default)
OPTCOR(3) generator control flag (1 by default)
OPTCOR(3) = 0 disable
OPTCOR(3) = 1 enable
OPTCOR(4) load control flag (0 by default)
OPTCOR(4) = 0 disable
OPTCOR(4) = 1 enable
OPTCOR(5) phase shifter control flag (1 by default)
OPTCOR(5) = 0 disable
OPTCOR(5) = 1 enable
OPTCOR(6) off-line generator control flag (0 by default)
OPTCOR(6) = 0 disable
OPTCOR(6) = 1 enable
OPTCOR(7) tap setting adjustment flag (0 by default)
OPTCOR(7) = 0 disable
OPTCOR(7) = 1 enable
OPTCOR(8) switched shunt control flag (0 by default)
OPTCOR(8) = 0 disable
OPTCOR(8) = 1 enable
Real VALUES (10) array of 10 elements specifying ranking parameters and corrective
actions parameters(input).
VALUES(1) small reactance threshold, (0<= VALUES
(1)<=0.005, 0.0005 by default)
VALUES(2) MW threshold for islanding contingencies
(>=0, 0.0 by default)
VALUES(3) bus voltage violation tolerance (0.1 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
295
Power Flow MACCC_WITH_COR_4

VALUES(4) branch overload violation tolerance (0.1 by

default)
VALUES(5) generator control weighting factor (1.0 by
default)
VALUES(6) load control weighting factor (1.0 by default)
VALUES(7) phase shifter control weighting factor (1.0 by
default)
VALUES(8) off-line generator control weighting factor
(1.0 by default)
VALUES(9) tap setting adjustment weighting factor (1.0
by default)
VALUES(10) switched shunt control weighting factor (1.0
by default)
Character*32 LABELS (8) array of 8 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default, no default allowed if OP-
TACC(8) is 1)
LABELS(2) label of contingency subsystem (blank by de-
fault)
LABELS(3) label of generator control subsystem (blank
by default, no default allowed if OPTCOR(3)
is 1)
LABELS(4) label of load control subsystem (blank by de-
fault, no default allowed if OPTCOR(4) is 1)
LABELS(5) label of phase shifter control subsystem
(blank by default, no default allowed if OPT-
COR(5) is 1)
LABELS(6) off-line generator control subsystem (blank
by default; no default allowed if OPTCOR(6)
is 1)
LABELS(7) tap setting adjustment subsystem (blank by
default; no default allowed if OPTCOR(7) is 1)
LABELS(8) switched shunt control subsystem (blank by
default; no default allowed if OPTCOR(8) is 1)
Character*260 DFXFILE name of Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia and Governor Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
296
Power Flow MACCC_WITH_COR_4

IERR = 4 buses in island(s) without a swing bus; use

activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid OPTCOR value
IERR = 13 invalid VALUES value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multisection line members
IERR = 50 error opening Unit Inertia Data File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
297
Power Flow MACCC_WITH_TRIP

1.1.133. MACCC_WITH_TRIP
This API routine is obsolete. It has been replaced by the API routine maccc_with_trip_2 .

Use this API to run multiple level contingency analysis with tripping simulation.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_MACCC_WITH_TRIP TOL OPTACC(1)..OPTACC(8) OPTMAC(1).. OPTMAC(41)
OPTRNK(1).. OPTRNK(17) OPTTRP(1)..OPTTRP(3) VALUES(1).. VALUES(3)
LABELS(1) LABELS(2) DFXFILE ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = maccc_with_trip(tol, optacc, optmac, optrnk, opttrp, values,
labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_WITH_TRIP(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, VALUES, LABELS,
DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (8) array of 8 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
298
Power Flow MACCC_WITH_TRIP

OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) dispatch mode (0 by default)
OPTACC(8) = 0 disable
OPTACC(8) = 1 subsystem machines (reserve)
OPTACC(8) = 2 subsystem machines (pmax)
OPTACC(8) = 3 subsystem machines (inertia)
OPTACC(8) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1<=OPTMAC
(2)<=3; 1 by default)
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single machine and single branch
outages respectively
OPTMAC(3) = 1 include the contingency combinations, oth-
erwise
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
299
Power Flow MACCC_WITH_TRIP

OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(10) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(11) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(15) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
300
Power Flow MACCC_WITH_TRIP

OPTRNK(17) include contingencies that create swingless

island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Real VALUES (3) array of 3 elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) percent of rating (0<= VALUES (1)<=200.0;
100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0; 0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
301
Power Flow MACCC_WITH_TRIP

IERR = 7 too many islands in base case

IERR = 8 invalid OPTMAC value
IERR = 9 invalid OPTRNK value
IERR = 10 invalid VALUES value
IERR = 11 invalid OPTTRP value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
302
Power Flow MACCC_WITH_TRIP_2

1.1.134. MACCC_WITH_TRIP_2
Use this API to run the second version of multiple level contingency analysis with tripping simulation.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_MACCC_WITH_TRIP_2 TOL OPTACC(1)..OPTACC(10) OPTMAC(1).. OPTMAC(41)
OPTRNK(1).. OPTRNK(17) OPTTRP(1)..OPTTRP(3) VALUES(1).. VALUES(3)
LABELS(1) LABELS(2) DFXFILE ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = maccc_with_trip_2(tol, optacc, optmac, optrnk, opttrp, values,
labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_WITH_TRIP_2(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, VALUES,
LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
303
Power Flow MACCC_WITH_TRIP_2

OPTACC(5) = 2 enable continuous mode, disable discrete

mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels)
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(2) = -3 N-3 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
304
Power Flow MACCC_WITH_TRIP_2

OPTMAC(3) each element represents a type of contin-

gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single machine and single branch
outages respectively
OPTMAC(3) = 1 include the contingency combinations, oth-
erwise
OPTMAC(3) = 0 (0 by default)
Integer OPTRNK (17) array of 17 elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(10) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
305
Power Flow MACCC_WITH_TRIP_2

OPTRNK(11) non-failure cutoff of branch contingencies

from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(15) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Real VALUES (3) array of 3 elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) percent of rating (0<= VALUES (1)<=200.0;
100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0; 0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
306
Power Flow MACCC_WITH_TRIP_2

Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid VALUES value
IERR = 13 invalid OPTTRP value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-sec-tion line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
307
Power Flow MACCC_WITH_TRIP_3

1.1.135. MACCC_WITH_TRIP_3
Use this API to run the second version of multiple level contingency analysis with tripping simulation.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_MACCC_WITH_TRIP_3 TOL OPTACC(1)..OPTACC(10) OPTMAC(1).. OPTMAC(41)
OPTRNK(1).. OPTRNK(15) OPTTRP(1)..OPTTRP(3) VALUES(1).. VALUES(2)
LABELS(1) LABELS(2) DFXFILE ACCFILE THRFILE INLFILE TRPFILE

Python command syntax:

ierr = maccc_with_trip_3(tol, optacc, optmac, optrnk, opttrp, values,
labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_WITH_TRIP_3(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, VALUES,
LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
TOLN).
Integer OPTACC (10) array of 10 elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable
OPTACC(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
308
Power Flow MACCC_WITH_TRIP_3

OPTACC(5) = 2 enable continuous mode, disable discrete

mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of 41 elements specifying contingency evaluation level and
combinations(input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels)
OPTMAC(2) = -3 N-3 contingency analysis
OPTMAC(2) = -2 N-2 contingency analysis
OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
309
Power Flow MACCC_WITH_TRIP_3

OPTMAC(3) Each element from 3 to 41 of OPTMAC ar-

ray represents a type of contingency combi-
nations in the following order. {S, U, B, SS,
SU, SB, US, UU, UB, BS, BU, BB, SSS, SSB, SSU,
SBS, SBB, SBU, SUS, SUB, SUU, USS, USU,
USB, UUS, UUB, UUU, UBS, UBU, UBB, BSS,
BSU, BSB, SUS, SUB, SUU, BBS, BBU, BBB},
where S, U and B are user specified cases,
single unit (machine) and single branch out-
ages respectively
OPTMAC(3) = 0 (0 by default)
OPTMAC(3) = 1 include the contingency combinations
Integer OPTRNK (15) array of 15 elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(2) = 0 disable
OPTRNK(2) = 1 enable
OPTRNK(3) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(4) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(5) non-failure cutoff of machine contingencies
(>=0; 5 by default)
OPTRNK(6) include branch contingencies from overload
ranking (0 by default)
OPTRNK(6) = 0 disable
OPTRNK(6) = 1 enable
OPTRNK(7) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(8) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(9) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(10) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(10) = 0 disable
OPTRNK(10) = 1 enable
OPTRNK(11) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
310
Power Flow MACCC_WITH_TRIP_3

OPTRNK(12) maximum of branch contingencies from volt-

age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(13) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(14) include all branches in voltage depression
ranking (0 by default)
OPTRNK(14) = 0 include only with non-zero rating
OPTRNK(14) = 1 all
OPTRNK(15) include contingencies that create swingless
island (0 by default)
OPTRNK(15) = 0 disable
OPTRNK(15) = 1 enable
Integer OPTTRP (3) array of 3 elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Real VALUES (2) array of 2 elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VALUES
(1)<=0.005; 0.0005 by default)
VALUES(2) MW threshold for islanding contingencies
(>=0; 0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0)
LABELS(2) label of contingency subsystem (blank by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
311
Power Flow MACCC_WITH_TRIP_3

IERR = 2 invalid OPTACC value

IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid VALUES value
IERR = 13 invalid OPTTRP value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-sec-tion line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
312
Power Flow MACCC_WITH_TRIP_PARALLEL

1.1.136. MACCC_WITH_TRIP_PARALLEL
Use this API to run the multiple level contingency analysis with tripping simulation in parallel when the
number of contingency processors in Program Settings is greater than 1. User-specified and automatically
selected contingencies from built-in contingency ranking functions are evaluated individually and in com-
bination with each other as overlapping outages up to the specified evaluation level.

This API routine was first introduced in release 33.4.0.

Batch command syntax:

BAT_MACCC_WITH_TRIP_PARALLEL TOL OPTACC(1)..OPTACC(10)

OPTMAC(1)..OPTMAC(41) OPTRNK(1)..OPTRNK(17) OPTTRP(1)..OPTTRP(3)
VALUES(1)..VALUES(3) LABELS(1)..LABELS(2) DFXFILE ACCFILE THRFILE INLFILE
TRPFILE

Python command syntax:

ierr = maccc_with_trip_parallel(tol, optacc, optmac, optrnk, opttrp,

values, labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_WITH_TRIP_PARALLEL(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP, VALUES,

LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
by default).
Integer OPTACC (10) array of elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
313
Power Flow MACCC_WITH_TRIP_PARALLEL

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of elements specifying contingency evaluation level and combi-
nations. (input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels by default)
OPTMAC(2) = -3 N-3 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
314
Power Flow MACCC_WITH_TRIP_PARALLEL

OPTMAC(2) = -2 N-2 contingency analysis

OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(3) each element represents a type of contin-
gency combinations in the following order.
{S, U, B, SS, SU, SB, US, UU, UB, BS, BU, BB,
SSS, SSB, SSU, SBS, SBB, SBU, SUS, SUB, SUU,
USS, USU, USB, UUS, UUB, UUU, UBS, UBU,
UBB, BSS, BSU, BSB, SUS, SUB, SUU, BBS,
BBU, BBB}, where S, U and B are user speci-
fied cases, single machine and single branch
outages respectively. (0 by default)
OPTMAC(3) = 0 not include the contingency combinations
OPTMAC(3) = 1 include the contingency combinations
Integer OPTRNK (17) array of elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) contingency rating (rating set program op-
tion setting by default)
OPTRNK(2) = 1 rate A
OPTRNK(2) = 2 rate B
OPTRNK(2) = 3 rate C
OPTRNK(3) convert ratings to MW (0 by default)
OPTRNK(3) = 0 disable
OPTRNK(3) = 1 enable
OPTRNK(4) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(4) = 0 disable
OPTRNK(4) = 1 enable
OPTRNK(5) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(6) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(7) non-failure cutoff of machine contingencies
((>=0; 5 by default)
OPTRNK(8) include branch contingencies from overload
ranking (0 by default)
OPTRNK(8) = 0 disable
OPTRNK(8) = 1 enable
OPTRNK(9) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
315
Power Flow MACCC_WITH_TRIP_PARALLEL

OPTRNK(10) maximum of branch contingencies from

overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(11) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(12) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(12) = 0 disable
OPTRNK(12) = 1 enable
OPTRNK(13) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(14) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(15) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(16) include all branches in voltage depression
ranking (0 by default)
OPTRNK(16) = 0 include only with non-zero rating
OPTRNK(16) = 1 all
OPTRNK(17) include contingencies that create swingless
island (0 by default)
OPTRNK(17) = 0 disable
OPTRNK(17) = 1 enable
Integer OPTTRP (3) array of elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Real VALUES (3) array of elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VAL-
UES(1)<=0.005; 0.0005 by default)
VALUES(2) percent of rating (0<= VALUES (1)<=200.0;
100.0 by default)
VALUES(3) MW threshold for islanding contingencies
(>=0; 0.0 by default)
Character*32 LABELS (2) array of elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
316
Power Flow MACCC_WITH_TRIP_PARALLEL

LABELS(2) label of contingency subsystem (blank by de-

fault) (blank by default)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).
Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1). (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid VALUES value
IERR = 13 invalid OPTTRP value
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
317
Power Flow MACCC_WITH_TRIP_PARALLEL_2

1.1.137. MACCC_WITH_TRIP_PARALLEL_2
Use this API to run the multiple level contingency analysis with tripping simulation in parallel when the
number of contingency processors in Program Settings is greater than 1. User-specified and automatically
selected contingencies from built-in contingency ranking functions are evaluated individually and in com-
bination with each other as overlapping outages up to the specified evaluation level.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_MACCC_WITH_TRIP_PARALLEL_2 TOL OPTACC(1)..OPTACC(10)

OPTMAC(1)..OPTMAC(41) OPTRNK(1)..OPTRNK(17) OPTTRP(1)..OPTTRP(3)
VALUES(1)..VALUES(3) LABELS(1)..LABELS(2) DFXFILE ACCFILE THRFILE INLFILE
TRPFILE

Python command syntax:

ierr = maccc_with_trip_parallel_2(tol, optacc, optmac, optrnk, opttrp,

values, labels, dfxfile, accfile, thrfile, inlfile, trpfile)

Fortran command syntax:

CALL MACCC_WITH_TRIP_PARALLEL_2(TOL, OPTACC, OPTMAC, OPTRNK, OPTTRP,

VALUES, LABELS, DFXFILE, ACCFILE, THRFILE, INLFILE, TRPFILE, IERR)

Where:
Real TOL mismatch tolerance (input; Newton solution convergence tolerance,
by default).
Integer OPTACC (10) array of elements specifying power flow solution options(input).
OPTACC(1) tap adjustment flag (tap adjustment option
setting by default)
OPTACC(1) = 0 disable
OPTACC(1) = 1 enable stepping adjustment
OPTACC(1) = 2 enable direct adjustment
OPTACC(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTACC(2) = 0 disable
OPTACC(2) = 1 enable using tie line flows only in calculating
area interchange
OPTACC(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTACC(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTACC(3) = 0 disable
OPTACC(3) = 1 enable
OPTACC(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTACC(4) = 0 disable
OPTACC(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
318
Power Flow MACCC_WITH_TRIP_PARALLEL_2

OPTACC(5) switched shunt adjustment flag (switched

shunt adjustment option setting by default)
OPTACC(5) = 0 disable
OPTACC(5) = 1 enable
OPTACC(5) = 2 enable continuous mode, disable discrete
mode
OPTACC(6) solution method flag (0 by default)
OPTACC(6) = 0 FDNS
OPTACC(6) = 1 FNSL
OPTACC(6) = 2 optimized FDNS
OPTACC(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTACC(7) = 0 disable
OPTACC(7) = 1 enable
OPTACC(8) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTACC(8) = 0 stall
OPTACC(8) = 1 trip
OPTACC(9) induction machine failure flag (0 by default)
OPTACC(9) = 0 treat contingency as non-converged if any in-
duction machines are placed in the "stalled"
or "tripped" state
OPTACC(9) = 1 treat contingency as solved if it converges,
even if any induction machines are placed in
the "stalled" or "tripped" state
OPTACC(10) dispatch mode (0 by default)
OPTACC(10) = 0 disable
OPTACC(10) = 1 subsystem machines (reserve)
OPTACC(10) = 2 subsystem machines (pmax)
OPTACC(10) = 3 subsystem machines (inertia)
OPTACC(10) = 4 subsystem machines (governor droop)
Integer OPTMAC (41) array of elements specifying contingency evaluation level and combi-
nations. (input).
OPTMAC(1) run multiple contingency analysis (1 by de-
fault)
OPTMAC(1) = 0 disable
OPTMAC(1) = 1 enable
OPTMAC(2) contingency evaluation level (1 by default).
If it is 2 or 3, a newly ordered event list is
built for the next level after solving AC power
flow each case at current level; if it is -2 or -3,
the event list at the first level is used for any
higher levels by default)
OPTMAC(2) = -3 N-3 contingency analysis

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
319
Power Flow MACCC_WITH_TRIP_PARALLEL_2

OPTMAC(2) = -2 N-2 contingency analysis

OPTMAC(2) = 1 N-1 contingency analysis
OPTMAC(2) = 2 N-2 contingency analysis
OPTMAC(2) = 3 N-3 contingency analysis
OPTMAC(3) Each element from 3 to 41 of OPTMAC ar-
ray represents a type of contingency combi-
nations in the following order. {S, U, B, SS,
SU, SB, US, UU, UB, BS, BU, BB, SSS, SSB, SSU,
SBS, SBB, SBU, SUS, SUB, SUU, USS, USU,
USB, UUS, UUB, UUU, UBS, UBU, UBB, BSS,
BSU, BSB, SUS, SUB, SUU, BBS, BBU, BBB},
where S, U and B are user specified cases,
single unit (machine) and single branch out-
ages respectively
OPTMAC(3) = 0 (0 by default)
OPTMAC(3) = 1 include the contingency combinations
Integer OPTRNK (15) array of elements specifying ranking options(input).
OPTRNK(1) include ties from contingency subsystem (0
by default)
OPTRNK(1) = 0 disable
OPTRNK(1) = 1 enable
OPTRNK(2) include machine contingencies from over-
load ranking (0 by default)
OPTRNK(2) = 0 disable
OPTRNK(2) = 1 enable
OPTRNK(3) minimum of machine contingencies to evalu-
ate (>=0; 1 by default)
OPTRNK(4) maximum of machine contingencies to eval-
uate (>=0; 10 by default)
OPTRNK(5) non-failure cutoff of machine contingencies
((>=0; 5 by default)
OPTRNK(6) include branch contingencies from overload
ranking (0 by default)
OPTRNK(6) = 0 disable
OPTRNK(6) = 1 enable
OPTRNK(7) minimum of branch contingencies from
overload ranking to evaluate (>=0; 1 by de-
fault)
OPTRNK(8) maximum of branch contingencies from
overload ranking to evaluate (>=0; 10 by de-
fault)
OPTRNK(9) non-failure cutoff of branch contingencies
from overload ranking (>=0; 5 by default)
OPTRNK(10) include branch contingencies from voltage
depression ranking (0 by default)
OPTRNK(10) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
320
Power Flow MACCC_WITH_TRIP_PARALLEL_2

OPTRNK(10) = 1 enable
OPTRNK(11) minimum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 1
by default)
OPTRNK(12) maximum of branch contingencies from volt-
age depression ranking to evaluate (>=0; 10
by default)
OPTRNK(13) non-failure cutoff of branch contingencies
from voltage depression ranking (>=0; 5 by
default)
OPTRNK(14) include all branches in voltage depression
ranking (0 by default)
OPTRNK(14) = 0 include only with non-zero rating
OPTRNK(14) = 1 all
OPTRNK(15) include contingencies that create swingless
island (0 by default)
OPTRNK(15) = 0 disable
OPTRNK(15) = 1 enable
Integer OPTTRP (3) array of elements specifying tripping simulation options(input).
OPTTRP(1) tripping simulation flag (0 by default)
OPTTRP(1) = 0 disable
OPTTRP(1) = 1 enable
OPTTRP(2) number of tripping events per power flow (1
by default)
OPTTRP(3) number of power flows per contingency (1
by default)
Real VALUES (2) array of elements specifying ranking parameters(input).
VALUES(1) small reactance threshold (0<= VAL-
UES(1)<=0.005; 0.0005 by default)
VALUES(2) MW threshold for islanding contingencies
(>=0; 0.0 by default)
Character*32 LABELS (2) array of elements specifying subsystem labels(input).
LABELS(1) label of generation dispatch subsystem
(blank by default; no default allowed if OP-
TACC(8) is not 0 by default)
LABELS(2) label of contingency subsystem (blank by de-
fault) (blank by default)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of the Contingency Solution Output File (input; no default al-
lowed).
Character*260 THRFILE name of the Load Throwover Data File (input; blank by default).
Character*260 INLFILE name of the Unit Inertia and Governor Data File (input; blank by de-
fault).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
321
Power Flow MACCC_WITH_TRIP_PARALLEL_2

Character*260 TRPFILE name of the Tripping Element Data File (input; blank for none; no de-
fault allowed if OPTTRP(1) is 1). (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid TOL value
IERR = 2 invalid OPTACC value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 invalid OPTMAC value
IERR = 11 invalid OPTRNK value
IERR = 12 invalid VALUES value
IERR = 13 invalid OPTTRP value
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 49 error opening Tripping Element Data File
IERR = 50 error opening Unit Inertia and Governor Data
File
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 54 prerequisite requirements for function not
met.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
322
Power Flow MATRIX_GROWTH_FACTOR

1.1.138. MATRIX_GROWTH_FACTOR
Use this API to specify or return the value of the matrix growth factor option setting.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_MATRIX_GROWTH_FACTOR RVAL

Python command syntax:

ierr = matrix_growth_factor(rval)

ierr, rval = matrix_growth_factor()

Fortran command syntax:

CALL MATRIX_GROWTH_FACTOR_API(RVAL, IOCODE, IERR)

Where:

Real RVAL value of the option setting (input; if Batch command, or for Python
if specified as an argument, or for Fortran if IOCODE is 0, 2.0 by de-
fault; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
RVAL.
IOCODE = 1 return the current value of the option setting
in RVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid RVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
323
Power Flow MCRE

1.1.139. MCRE
Use this API to read a Machine Impedance Data File and add the data specified in it to the working case.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MCRE STATUS(1) STATUS(2) IFILE

Python command syntax:

ierr = mcre(status, ifile)

Fortran command syntax:

CALL MCREAPI(STATUS, IFILE, IERR)

Where:

Integer STATUS (2) array of 2 elements specifying options(input).

STATUS(1) new machine status option (0 by default)
STATUS(1) = 0 set from STAT field on input record
STATUS(1) = 1 set from status of other machines at the bus
STATUS(2) option for treatment of machines with no da-
ta record specified and other machines at the
bus with record specified (0 by default)
STATUS(2) = 0 place out-of-service
STATUS(2) = 1 delete
Character*260 IFILE name of machine impedance data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 generators are converted
IERR = 3 error opening IFILE
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
324
Power Flow MODR

1.1.140. MODR
Use this API to uniformly increase or decrease the line resistances of in-service nontransformer branches. It
must first be called once with APIOPT set to 1, then once for each subsystem to be processed with APIOPT
set to 2, and finally once with APIOPT set to 3.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MODR SID ALL APIOPT IRAT RLOAD FMAX

Python command syntax:

ierr, nchng = modr(sid, all, apiopt, irat, rload, fmax)

Fortran command syntax:

CALL MODRNW(SID, ALL, APIOPT, IRAT, RLOAD, FMAX, NCHNG, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; used
only when APIOPT is 2; 0).
Integer ALL all buses or specified subsystem flag (input; used only when APIOPT
is 2; 1).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer APIOPT mode of operation of the API (input; no default allowed).
APIOPT = 1 initialize system for line resistance modifica-
tion
APIOPT = 2 modify line resistances
APIOPT = 3 postprocessing housekeeping
Integer IRAT rating set on which the present values of branch resistances are
based (input; used only when APIOPT is 1; default rating set program
option setting).
IRAT = 1 RATEA
IRAT = 2 RATEB
IRAT = 3 RATEC
Real RLOAD base line loading in percent. 0.0001 < RLOAD < 2000.0 (input; used
only when APIOPT is 1; 100.0).
Real FMAX line resistance scaling factor in pu 0.0 < FMAX < 0.1 (input; used only
when APIOPT is 1; 0.01).
Integer NCHNG returned as the number of branch resistances changed (output).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
325
Power Flow MODR

IERR = 2 invalid ALL value

IERR = 3 invalid APIOPT value
IERR = 4 invalid IRAT value
IERR = 5 invalid RLOAD value
IERR = 6 invalid FMAX value
IERR = 7 unexpected APIOPT value
IERR = 8 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
326
Power Flow MOVE3WND

1.1.141. MOVE3WND
Use this API to disconnect the third bus of a specified three-winding transformer from the bus to which it is
currently connected, and reconnect it to a designated bus.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MOVE3WND IBUS JBUS1 JBUS2 'CKT' NEWTOBUS2 'NEWCKT'

Python command syntax:

ierr = move3wnd(ibus, jbus1, jbus2, ckt, newtobus2, newckt)

Fortran command syntax:

CALL MOVE3WND(IBUS, JBUS1, JBUS2, CKT, NEWTOBUS2, NEWCKT, IERR)

Where:

Integer IBUS one of the buses connected by the three-winding transformer; the
transformer will remain connected to this bus (input; no default al-
lowed).
Integer JBUS1 other bus connected by the three-winding transformer; the trans-
former will remain connected to this bus (input; no default allowed).
Integer JBUS2 third bus connected by the three-winding transformer; this connec-
tion will be severed and the transformer connected to bus NEWTO-
BUS2 (input; no default allowed).
Character*2 CKT circuit identifier of the three-winding transformer to be rerouted (in-
put; '1' by default).
Integer NEWTOBUS2 number of the bus to which the three-winding transformer is to be
connected (input; no default allowed).
Character*2 NEWCKT new circuit identifier to be assigned to the rerouted three-winding
transformer (input; CKT).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 three-winding transformer not found
IERR = 3 new connection bus must not be the present
from or to buses
IERR = 4 circuit NEWCKT from IBUS to JBUS1 to NEW-
TOBUS2 already exists
IERR = 5 invalid new identifier; cannot start with &, *
or @
IERR = 6 invalid new identifier; must not be blank
IERR = 7 node-breaker terminal connection table is full
IERR = 8 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
327
Power Flow MOVEBRN

1.1.142. MOVEBRN
Use this API to disconnect the to bus of a specified non-transformer branch or two-winding transformer
from the bus to which it is currently connected, and reconnect it to a designated bus.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MOVEBRN IBUS JBUS 'CKT' NEWTOBUS 'NEWCKT'

Python command syntax:

ierr = movebrn(ibus, jbus, ckt, newtobus, newckt)

Fortran command syntax:

CALL MOVEBRN(IBUS, JBUS, CKT, NEWTOBUS, NEWCKT, IERR)

Where:

Integer IBUS one of the buses connected by the branch; the branch will remain
connected to this bus (input; no default allowed).
Integer JBUS other bus connected by the branch; this connection will be severed
and the branch connected to bus NEWTOBUS (input; no default al-
lowed).
Character*2 CKT circuit identifier of the branch to be rerouted (input; '1' by default).
Integer NEWTOBUS number of the bus to which the branch is to be connected (input; no
default allowed).
Character*2 NEWCKT new circuit identifier to be assigned to the rerouted branch (input;
CKT).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 circuit CKT from IBUS to JBUS not found
IERR = 3 new connection bus must not be the present
from or to bus
IERR = 4 circuit NEWCKT from IBUS to NEWTOBUS al-
ready exists
IERR = 5 invalid new identifier; cannot start with &, *
or @
IERR = 6 invalid new identifier; must not be blank
IERR = 7 node-breaker terminal connection table is full
IERR = 8 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
328
Power Flow MOVEINDMAC

1.1.143. MOVEINDMAC
Use this API routine to disconnect the specified induction machine from the bus to which it is currently
connected, and reconnect it to a designated bus.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_MOVEINDMAC IBUS 'ID' NEWBUS 'NEWID'

Python command syntax:

ierr = moveindmac(ibus, id, newbus, newid)

Fortran command syntax:

CALL MOVEINDMAC(IBUS, ID, NEWBUS, NEWID, IERR)

Where:

Integer IBUS bus to which induction machine ID is connected (input; no default al-
lowed).
Character*2 ID machine identifier of the induction machine to be moved (input; '1'
by default).
Integer NEWBUS number of the bus to which the induction machine is to be moved
(input; ID).
Character*2 NEWID new induction machine identifier to be assigned to the relocated in-
duction machine (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 induction machine not found
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 induction machine NEWID at bus NEWBUS al-
ready exists
IERR = 5 invalid new identifier; must not be blank
IERR = 6 node-breaker terminal connection table is full
IERR = 7 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
329
Power Flow MOVEINDMACS

1.1.144. MOVEINDMACS
Use this API routine to disconnect all of the induction machines at the specified bus, and reconnect them
to a designated bus. Bus TOBUS must not have any induction machines connected to it at the time this API
routine is called.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_MOVEINDMACS IBUS NEWBUS

Python command syntax:

ierr = moveindmacs(ibus, newbus)

Fortran command syntax:

CALL MOVEINDMACS(IBUS, NEWBUS, IERR)

Where:

Integer IBUS bus at which one or more induction machines currently exist (input;
no default allowed).
Integer NEWBUS bus to which the induction machines on bus IBUS are to be moved
(input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no induction machines at bus IBUS
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 NEWBUS already has induction machines
(move individual machines)
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
330
Power Flow MOVELOAD

1.1.145. MOVELOAD
Use this API to disconnect the specified load from the bus to which it is currently connected, and reconnect
it to a designated bus.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MOVELOAD IBUS 'ID' NEWBUS 'NEWID'

Python command syntax:

ierr = moveload(ibus, id, newbus, newid)

Fortran command syntax:

CALL MOVELOAD(IBUS, ID, NEWBUS, NEWID, IERR)

Where:

Integer IBUS bus to which the load ID is connected (input; no default allowed).
Character*2 ID load identifier of the load to be moved (input; '1' by default).
Integer NEWBUS number of the bus to which the load is to be moved (input; no de-
fault allowed).
Character*2 NEWID new load identifier to be assigned to the relocated load (input; ID).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 load not found
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 load NEWID at bus NEWBUS already exists
IERR = 5 invalid new identifier; must not be blank
IERR = 6 node-breaker terminal connection table is full
IERR = 7 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
331
Power Flow MOVELOADS

1.1.146. MOVELOADS
Use this API to disconnect all of the load from the specified bus, and reconnect it to a designated bus. Bus
TOBUS must not have any load connected to it at the time this API is called.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MOVELOADS IBUS NEWBUS

Python command syntax:

ierr = moveloads(ibus, newbus)

Fortran command syntax:

CALL MOVELOADS(IBUS, NEWBUS, IERR)

Where:

Integer IBUS bus on which one or more loads currently exist (input; no default al-
lowed).
Integer NEWBUS bus to which the loads on bus IBUS are to be moved (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no loads at bus IBUS
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 NEWBUS already has loads (move individual
loads)
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
332
Power Flow MOVEMAC

1.1.147. MOVEMAC
Use this API to disconnect the specified machine from the bus to which it is currently connected, and re-
connect it to a designated bus.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MOVEMAC IBUS 'ID' NEWBUS 'NEWID'

Python command syntax:

ierr = movemac(ibus, id, newbus, newid)

Fortran command syntax:

CALL MOVEMAC(IBUS, ID, NEWBUS, NEWID, IERR)

Where:

Integer IBUS bus to which the machine ID is connected (input; no default al-
lowed).
Character*2 ID machine identifier of the machine to be moved (input; '1' by default).
Integer NEWBUS number of the bus to which the machine is to be moved (input; ID).
Character*2 NEWID new machine identifier to be assigned to the relocated machine (in-
put; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 machine not found
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 machine NEWID at bus NEWBUS already exists
IERR = 5 plant table full (move machine to an existing
plant)
IERR = 6 invalid new identifier; must not be blank
IERR = 7 node-breaker terminal connection table is full
IERR = 8 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
333
Power Flow MOVEPLNT

1.1.148. MOVEPLNT
Use this API to disconnect all of the machines from the specified bus, and reconnect it to a designated bus.
Bus TOBUS must not have any plant data associated with it at the time this API is called.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MOVEPLNT IBUS NEWBUS

Python command syntax:

ierr = moveplnt(ibus, newbus)

Fortran command syntax:

CALL MOVEPLNT(IBUS, NEWBUS, IERR)

Where:

Integer IBUS bus on which plant data currently exists (input; no default allowed).
Integer NEWBUS bus to which the plant on bus IBUS is to be moved (input; no default
allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no plant at bus IBUS
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 NEWBUS already has plant data (move indi-
vidual machines)
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
334
Power Flow MOVESHUNT

1.1.149. MOVESHUNT
Use this API to disconnect the specified fixed shunt from the bus to which it is currently connected, and re-
connect it to a designated bus.

This API routine was first introduced in release 31.0.0.

Batch command syntax:

BAT_MOVESHUNT IBUS 'ID' NEWBUS 'NEWID'

Python command syntax:

ierr = moveshunt(ibus, id, newbus, newid)

Fortran command syntax:

CALL MOVESHUNT(IBUS, ID, NEWBUS, NEWID, IERR)

Where:

Integer IBUS bus to which the shunt ID is connected (input; no default allowed).
Character*2 ID shunt identifier of the fixed shunt to be moved (input; '1' by default).
Integer NEWBUS number of the bus to which the shunt is to be moved (input; no de-
fault allowed).
Character*2 NEWID new shunt identifier to be assigned to the relocated fixed shunt (in-
put; ID).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 fixed shunt not found
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 shunt NEWID at bus NEWBUS already exists
IERR = 5 invalid new identifier; must not be blank
IERR = 6 node-breaker terminal connection table is full
IERR = 7 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
335
Power Flow MOVESHUNTS

1.1.150. MOVESHUNTS
Use this API to disconnect all of the fixed shunts from the specified bus and reconnect them to a designat-
ed bus. Bus TOBUS must not have any fixed shunt connected to it at the time this API is called.

This API routine was first introduced in release 31.0.0.

Batch command syntax:

BAT_MOVESHUNTS IBUS NEWBUS

Python command syntax:

ierr = moveshunts(ibus, newbus)

Fortran command syntax:

CALL MOVESHUNTS(IBUS, NEWBUS, IERR)

Where:

Integer IBUS bus on which one or more fixed shunts currently exist (input; no de-
fault allowed).
Integer NEWBUS bus to which the fixed shunts on bus IBUS are to be moved (input; no
default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no fixed shunts at bus IBUS
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 NEWBUS already has fixed shunts (move indi-
vidual shunts)
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
336
Power Flow MOVESWS

1.1.151. MOVESWS
This API routine is obsolete. It has been replaced by the API routine MoveSwShunt .

Use this API to disconnect the switched shunt load from the specified bus and reconnect it to a designated
bus.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MOVESWS IBUS NEWBUS

Python command syntax:

ierr = movesws(ibus, newbus)

Fortran command syntax:

CALL MOVESWS(IBUS, NEWBUS, IERR)

Where:

Integer IBUS bus on which a switched shunt currently exists (input; no default al-
lowed).
Integer NEWBUS bus to which the switched shunt on bus IBUS is to be moved (input;
no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no switched shunt at bus IBUS
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
337
Power Flow MOVESWSHUNT

1.1.152. MOVESWSHUNT
Use this API to disconnect the specified switched shunt from the bus to which it is currently connected,
and reconnect it to a designated bus.

This API routine was first introduced in release 35.0.0.

Batch command syntax:

BAT_MOVESWSHUNT IBUS 'ID' NEWBUS 'NEWID'

Python command syntax:

ierr = moveswshunt(ibus, id, newbus, newid)

Fortran command syntax:

CALL MOVESWSHUNT(IBUS, ID, NEWBUS, NEWID, IERR)

Where:

Integer IBUS bus to which switched shunt ID is connected (input; no default al-
lowed).
Character*2 ID shunt identifier of the switched shunt to be moved (input; '1' by de-
fault).
Integer NEWBUS number of the bus to which the shunt is to be moved (input; no de-
fault allowed).
Character*2 NEWID new shunt identifier to be assigned to the relocated switched shunt
(input; ID).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 switched shunt not found
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 switched shunt NEWID at bus NEWBUS al-
ready exists
IERR = 5 invalid new identifier; must not be blank
IERR = 6 node-breaker terminal connection table is full
IERR = 7 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
338
Power Flow MOVESWSHUNTS

1.1.153. MOVESWSHUNTS
Use this API to disconnect all of the switched shunts from the specified bus and reconnect them to a desig-
nated bus. Bus TOBUS must not have any switched shunt connected to it at the time this API is called.

This API routine was first introduced in release 35.0.0.

Batch command syntax:

BAT_MOVESWSHUNTS IBUS NEWBUS

Python command syntax:

ierr = moveswshunts(ibus, newbus)

Fortran command syntax:

CALL MOVESWSHUNTS(IBUS, NEWBUS, IERR)

Where:

Integer IBUS bus on which one or more switched shunts currently exist (input; no
default allowed).
Integer NEWBUS bus to which the switched shunts on bus IBUS are to be moved (in-
put; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no switched shunts at bus IBUS
IERR = 3 IBUS and NEWBUS are the same bus
IERR = 4 NEWBUS already has switched shunts (move
individual switched shunts)
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
339
Power Flow MOV_ALPHA

1.1.154. MOV_ALPHA
Use this API to specify or return the value of the MOV iteration ALPHA option setting.

This API routine was first introduced in release 34.0.0.

Batch command syntax:

BAT_MOV_ALPHA RVAL IOCODE

Python command syntax:

ierr = mov_alpha(rval, iocode)

Fortran command syntax:

CALL MOV_ALPHA(RVAL, IOCODE, IERR)

Where:

Real RVAL MOV iteration ALPHA option setting (input; if Batch command, or for
Python if specified as an argument, or for Fortran if IOCODE is 0, 0.3
by default; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
RVAL.
IOCODE = 1 return the current value of the option setting
in RVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid RVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
340
Power Flow MOV_ITERATIONS

1.1.155. MOV_ITERATIONS
Use this API to specify or return the value of the maximum MOV iterations option setting.

This API routine was first introduced in release 34.0.0.

Batch command syntax:

BAT_MOV_ITERATIONS IVAL IOCODE

Python command syntax:

ierr = mov_iterations(ival, iocode)

Fortran command syntax:

CALL MOV_ITERATIONS(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 20 by default;
else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
341
Power Flow MOV_TOLERANCE

1.1.156. MOV_TOLERANCE
Use this API to specify or return the value of the MOV iteration tolerance option setting.

This API routine was first introduced in release 34.0.0.

Batch command syntax:

BAT_MOV_TOLERANCE RVAL IOCODE

Python command syntax:

ierr = mov_tolerance(rval, iocode)

Fortran command syntax:

CALL MOV_TOLERANCE(RVAL, IOCODE, IERR)

Where:

Real RVAL MOV iteration tolerance (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0.01 by de-
fault; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
RVAL.
IOCODE = 1 return the current value of the option setting
in RVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid RVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
342
Power Flow MSLV

1.1.157. MSLV
Use this API to apply the modified Gauss-Seidel power flow calculation.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MSLV OPTIONS(1)..OPTIONS(6)

Python command syntax:

ierr = mslv(options)

Fortran command syntax:

CALL MSLVAPI(OPTIONS, IERR)

Where:

Integer OPTIONS (6) array of 6 elements specifying solution options(input).

OPTIONS(1) tap adjustment flag (use tap adjustment op-
tion setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable
OPTIONS(2) area interchange adjustment flag (use area
interchange adjustment option setting by de-
fault)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) flat start flag (0 by default)
OPTIONS(3) = 0 do not flat start
OPTIONS(3) = 1 flat start
OPTIONS(3) = 2 flat start, then estimate voltage magnitudes
OPTIONS(3) = 3 flat start, then estimate voltage phase angles
OPTIONS(3) = 4 flat start, then estimate voltage magnitudes
and phase angles
OPTIONS(4) dc tap adjustment flag (use dc tap adjust-
ment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (use
switched shunt adjustment option setting by
default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
343
Power Flow MSLV

OPTIONS(5) = 2 enable continuous mode, disable discrete

mode
OPTIONS(6) var limit flag (0 by default)
OPTIONS(6) = 0 apply var limits
OPTIONS(6) = 1 ignore var limits
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted
IERR = 3 buses in island(s) without a swing bus; use
activity TREE
IERR = 4 bus type code and series element status in-
consistencies
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
344
Power Flow MSUM

1.1.158. MSUM
Use this API to print a summary of mileage by owner.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_MSUM

Python command syntax:

ierr = msum()

Fortran command syntax:

CALL MSUMAPI(IERR)

Where:

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
345
Power Flow MTDC

1.1.159. MTDC
Use this API to produce a report of bus voltages and flows for each in-service multi-terminal dc line.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_MTDC

Python command syntax:

ierr = mtdc()

Fortran command syntax:

CALL MTDCAPI(IERR)

Where:

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 no unblocked multi-terminal dc lines in this
case
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
346
Power Flow MULTISECTION_REPORTING

1.1.160. MULTISECTION_REPORTING
Use this API to specify or return the option to enable or disable multi-section line reporting.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_MULTISECTION_REPORTING IVAL

Python command syntax:

ierr = multisection_reporting(ival)

ierr, ival = multisection_reporting()

Fortran command syntax:

CALL MULTISECTION_LINE_REPORTING_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1 by default;
else output).
IVAL = 0 off.
IVAL = 1 on.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
347
Power Flow MWMI

1.1.161. MWMI
Use this API to apply the MAPP MW-mile calculation
.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_MWMI SID ALL STATUS(1)..STATUS(4) VALUES(1)..VALUES(3) INPFILE

TRNFILE OUTFILE

Python command syntax:

ierr = mwmi(sid, all, status, values, inpfile, trnfile, outfile)

Fortran command syntax:

CALL MWMIAPI(SID, ALL, STATUS, VALUES, INPFILE, TRNFILE, OUTFILE, IERR)

Where:

Integer SID a valid area subsystem identifier. Valid subsystem identifiers range
from 0 to 11. Area subsystem SID must have been previously defined
(input; 0 by default).
Integer ALL all areas or specified subsystem flag (input; 1 by default).
ALL = 0 only areas in area subsystem SID are in the
pool
ALL = 1 all areas are in the pool
Integer STATUS (4) array of 4 elements specifying solution options(input).
STATUS(1) rating used (default rating set program op-
tion setting)
STATUS(1) = 1 RATEA
STATUS(1) = 2 RATEB
STATUS(1) = 3 RATEC
STATUS(2) option to list data (0 by default)
STATUS(2) = 0 no
STATUS(2) = 1 yes
STATUS(3) option to include buyer and seller branches
in the detailed branch output file (0 by de-
fault)
STATUS(3) = 0 no
STATUS(3) = 1 yes
STATUS(4) action code if the MW mismatch exceeds 0.5
MW (0 by default)
STATUS(4) = 0 discontinue
STATUS(4) = 1 continue
Real VALUES (3) array of 3 elements specifying solution parameters(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
348
Power Flow MWMI

VALUES(1) percent load reduction for calculating capaci-

ty for serving load (10.0 by default)
VALUES(2) MW for each transaction; used when no
transactions data file is specified (10.0 by de-
fault)
VALUES(3) distribution factor threshold for detailed
branch (0.0 by default)
Character*260 INPFILE name of MWMI data file (input; no default allowed).
Character*260 TRNFILE name of the transactions raw data file; blank for none (input; blank
by default).
Character*260 OUTFILE name of the detailed branch output file; blank for none (input; blank
by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 invalid VALUES value
IERR = 5 INPFILE is blank
IERR = 6 generators are converted
IERR = 7 buses in island(s) without a swing bus; use
activity TREE
IERR = 8 largest mismatch exceeds 0.5 MW
IERR = 9 error opening INPFILE
IERR = 10 error opening OUTFILE
IERR = 11 error opening TRNFILE
IERR = 12 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
349
Power Flow MWOMWMSF

1.1.162. MWOMWMSF
Use this API to tabulate generation (MW) on MW-mile shift factors for a specified transaction event.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_MWOMWMSF EVENT

Python command syntax:

ierr = mwomwmsf(event)

Fortran command syntax:

CALL MWOMWMSFAPI(EVENT, IERR)

Where:

Integer EVENT transaction event number (input; no default allowed).

Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no transactions defined
IERR = 2 invalid transaction event number
IERR = 3 transaction event not defined
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
350
Power Flow MWOMWOSF

1.1.163. MWOMWOSF
Use this API to tabulate generation (MW) on MW-ohm shift factors for a specified transaction event.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_MWOMWOSF EVENT

Python command syntax:

ierr = mwomwosf(event)

Fortran command syntax:

CALL MWOMWOSFAPI(EVENT, IERR)

Where:

Integer EVENT transaction event number (input; no default allowed).

Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no transactions defined
IERR = 2 invalid transaction event number
IERR = 3 transaction event not defined
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
351
Power Flow N11_ACCC

1.1.164. N11_ACCC
This API routine is obsolete. It has been replaced by the API routine n11_accc_2 .

This API is used to perform N-1-1 contingency analysis. Each pair of N-1-1 contingencies is simulated in the
way that the first N-1 contingency is simulated by a full AC load flow solution with the power flow options
for the first N-1 contingency; the post solution of the first N-1 contingency is used as the base case for the
second N-1 contingency, the second N-1 contingency is imposed and solved by a full AC load flow solution
with power flow options for the second N-1 contingency.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_N11_ACCC OPTIONS(1)..OPTIONS(18) VALUES(1) VALUES(2) LABEL DFXFILE

ACCFILE CONFILE INLFILE THRFILE

Python command syntax:

ierr = n11_accc(options,values,label,dfxfile,accfile,confile,inlfile,
thrfile)

Fortran command syntax:

CALL N11_ACCC(OPTIONS,VALUES,LABEL,DFXFILE,ACCFILE,CONFILE,INLFILE,
THRFILE,IERR)

Where:

Integer OPTIONS (18) array of 18 elements specifying integer specifying power flow
options(input).
OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
352
Power Flow N11_ACCC

OPTIONS(4) dc tap adjustment flag for the first N-1 con-

tingency (dc tap adjustment option setting
by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable stepping adjustment
OPTIONS(9) = 2 enable direct adjustment
OPTIONS(10) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(11) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(11) = 0 disable
OPTIONS(11) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
353
Power Flow N11_ACCC

OPTIONS(12) dc tap adjustment flag for the first N-1 con-

tingency (dc tap adjustment option setting
by default)
OPTIONS(12) = 0 disable
OPTIONS(12) = 1 enable
Real VALUES (2) array of 2 elements specifying a real(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Percent of rating for the first N-1 contin-
gency and second N-1 contingency case
(100.0 by default)
Character*32 LABEL label of generation dispatch system, required if the dispatch mode of
OPTIONS(15) is not zero. The dispatch mode and the system provide
for a default dispatch method for contingencies causing unbalance
between load demand and generation (input).
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of contingency analysis output file (input; no default allowed).
Character*260 CONFILE name of Contingency Description Data File for the second N-1 contin-
gencies (input; blank for none).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Generators are converted
IERR = 4 Buses in island(s) without a swing bus--use
activity TREE
IERR = 5 Largest mismatch exceeds tolerance
IERR = 6 Generation subsystem not specified
IERR = 7 Too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 No Distribution Factor Data input file speci-
fied
IERR = 11 No Contingency Analysis Output File specified
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion
IERR = 21 File is not in the form of a PSSE-25 or later
DFAX file--run DFAX

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
354
Power Flow N11_ACCC

IERR = 22 Monitored elements exceed limit when

adding multi-section line members
IERR = 51 Error opening distribution factor data file
IERR = 52 Error opening load throwover data file
IERR = 53 Error opening inertia data file
IERR = 54 Prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
355
Power Flow N11_ACCC_2

1.1.165. N11_ACCC_2
This API is the second release of N-1-1 contingency analysis solution. This API is used to perform N-1-1 con-
tingency analysis. Each pair of N-1-1 contingencies is simulated in the way that the first N-1 contingency
is simulated by a full AC load flow solution with the power flow options for the first N-1 contingency; the
post solution of the first N-1 contingency is used as the base case for the second N-1 contingency, the sec-
ond N-1 contingency is imposed and solved by a full AC load flow solution with power flow options for the
second N-1 contingency.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_N11_ACCC_2 OPTIONS(1)..OPTIONS(20) VALUES(1) VALUES(2) LABEL DFXFILE

ACCFILE CONFILE INLFILE THRFILE

Python command syntax:

ierr =
n11_accc_2(options,values,label,dfxfile,accfile,confile,inlfile,thrfile)

Fortran command syntax:

CALL
N11_ACCC_2(OPTIONS,VALUES,LABEL,DFXFILE,ACCFILE,CONFILE,INLFILE,THRFILE,IERR)

Where:
Integer OPTIONS (20) array of 20 elements specifying integer specifying power flow
options(input).
OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
356
Power Flow N11_ACCC_2

OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable stepping adjustment
OPTIONS(9) = 2 enable direct adjustment
OPTIONS(10) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(11) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(11) = 0 disable
OPTIONS(11) = 1 enable
OPTIONS(12) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
357
Power Flow N11_ACCC_2

OPTIONS(12) = 0 disable
OPTIONS(12) = 1 enable
OPTIONS(13) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(13) = 0 disable
OPTIONS(13) = 1 enable
OPTIONS(13) = 2 enable continuous, disable discrete
OPTIONS(14) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(14) = 0 stall
OPTIONS(14) = 1 trip
OPTIONS(15) generation dispatch method
OPTIONS(15) = 1 subsystem machines (PMAX)
OPTIONS(15) = 2 subsystem machines (PMAX)
OPTIONS(15) = 3 subsystem machines (INERTIA)
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP)
OPTIONS(16) flag to skip the second N-1 contingencies if
the first N-1 contingency is not clean
OPTIONS(16) = 0 No
OPTIONS(16) = 1 Yes
OPTIONS(17) Rating set for the first N-1 contingency case
OPTIONS(17) = 1 RATE A
OPTIONS(17) = 2 RATE B
OPTIONS(17) = 3 RATE C
OPTIONS(18) Rating set for the second N-1 contingency
case
OPTIONS(18) = 1 RATE A
OPTIONS(18) = 2 RATE B
OPTIONS(18) = 3 RATE C
OPTIONS(19) Voltage limit for the first N-1 contingency
case
OPTIONS(19) = 1 normal
OPTIONS(19) = 2 emergency
OPTIONS(20) Voltage limit for the second N-1 contingency
case
OPTIONS(20) = 1 normal
OPTIONS(20) = 2 emergency
Real VALUES (2) array of 2 elements specifying a real(input).
VALUES(1) Mismatch tolerance (TOLN by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
358
Power Flow N11_ACCC_2

VALUES(2) Percent of rating for the first N-1 contin-

gency and second N-1 contingency case
(100.0 by default)
Character*32 LABEL label of generation dispatch system, required if the dispatch mode of
OPTIONS(15) is not zero. The dispatch mode and the system provide
for a default dispatch method for contingencies causing unbalance
between load demand and generation (input).
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of contingency analysis output file (input; no default allowed).
Character*260 CONFILE name of Contingency Description Data File for the second N-1 contin-
gencies (input; blank for none).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Generators are converted
IERR = 4 Buses in island(s) without a swing bus--use
activity TREE
IERR = 5 Largest mismatch exceeds tolerance
IERR = 6 Generation subsystem not specified
IERR = 7 Too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 No Distribution Factor Data input file speci-
fied
IERR = 11 No Contingency Analysis Output File specified
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion
IERR = 21 File is not in the form of a PSSE-25 or later
DFAX file--run DFAX
IERR = 22 Monitored elements exceed limit when
adding multi-section line members
IERR = 51 Error opening distribution factor data file
IERR = 52 Error opening load throwover data file
IERR = 53 Error opening inertia data file
IERR = 54 Prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
359
Power Flow N11_ACCC_3

1.1.166. N11_ACCC_3
This API is the second release of N-1-1 contingency analysis solution. This API is used to perform N-1-1 con-
tingency analysis. Each pair of N-1-1 contingencies is simulated in the way that the first N-1 contingency
is simulated by a full AC load flow solution with the power flow options for the first N-1 contingency; the
post solution of the first N-1 contingency is used as the base case for the second N-1 contingency, the sec-
ond N-1 contingency is imposed and solved by a full AC load flow solution with power flow options for the
second N-1 contingency.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_N11_ACCC_3 OPTIONS(1)..OPTIONS(16) VALUES LABEL DFXFILE ACCFILE

CONFILE INLFILE THRFILE

Python command syntax:

ierr =
n11_accc_3(options,values,label,dfxfile,accfile,confile,inlfile,thrfile)

Fortran command syntax:

CALL
N11_ACCC_3(OPTIONS,VALUES,LABEL,DFXFILE,ACCFILE,CONFILE,INLFILE,THRFILE,IERR)

Where:
Integer OPTIONS (16) array of 16 elements specifying integer specifying power flow
options(input).
OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
360
Power Flow N11_ACCC_3

OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable stepping adjustment
OPTIONS(9) = 2 enable direct adjustment
OPTIONS(10) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(11) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(11) = 0 disable
OPTIONS(11) = 1 enable
OPTIONS(12) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
361
Power Flow N11_ACCC_3

OPTIONS(12) = 0 disable
OPTIONS(12) = 1 enable
OPTIONS(13) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(13) = 0 disable
OPTIONS(13) = 1 enable
OPTIONS(13) = 2 enable continuous, disable discrete
OPTIONS(14) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(14) = 0 stall
OPTIONS(14) = 1 trip
OPTIONS(15) generation dispatch method
OPTIONS(15) = 1 subsystem machines (PMAX)
OPTIONS(15) = 2 subsystem machines (PMAX)
OPTIONS(15) = 3 subsystem machines (INERTIA)
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP)
OPTIONS(16) flag to skip the second N-1 contingencies if
the first N-1 contingency is not clean
OPTIONS(16) = 0 No
OPTIONS(16) = 1 Yes
Real VALUES (1) array of 1 elements specifying a real(input).
VALUES(1) Mismatch tolerance (TOLN by default)
Character*32 LABEL label of generation dispatch system, required if the dispatch mode of
OPTIONS(15) is not zero. The dispatch mode and the system provide
for a default dispatch method for contingencies causing unbalance
between load demand and generation (input).
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of contingency analysis output file (input; no default allowed).
Character*260 CONFILE name of Contingency Description Data File for the second N-1 contin-
gencies (input; blank for none).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Generators are converted
IERR = 4 Buses in island(s) without a swing bus--use
activity TREE
IERR = 5 Largest mismatch exceeds tolerance

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
362
Power Flow N11_ACCC_3

IERR = 6 Generation subsystem not specified

IERR = 7 Too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 No Distribution Factor Data input file speci-
fied
IERR = 11 No Contingency Analysis Output File specified
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion
IERR = 21 File is not in the form of a PSSE-25 or later
DFAX file--run DFAX
IERR = 22 Monitored elements exceed limit when
adding multi-section line members
IERR = 51 Error opening distribution factor data file
IERR = 52 Error opening load throwover data file
IERR = 53 Error opening inertia data file
IERR = 54 Prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
363
Power Flow N11_ACCC_PARALLEL

1.1.167. N11_ACCC_PARALLEL
Use this API to run the N-1-1 contingency analysis in parallel when the number of contingency processors
in Program Settings is greater than 1. The API distributes contingency cases among multiple processors
evenly, and tests the contingency cases and following tripping actions assigned to each processor in paral-
lel.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_N11_ACCC_PARALLEL OPTIONS(1)..OPTIONS(20) VALUES(1)..VALUES(2) LABEL

DFXFILE ACCFILE CONFILE THRFILE INLFILE

Python command syntax:

ierr = n11_accc_parallel(options, values, label, dfxfile, accfile,

confile, thrfile, inlfile)

Fortran command syntax:

CALL N11_ACCC_PARALLEL(OPTIONS, VALUES, LABEL, DFXFILE, ACCFILE, CONFILE,

THRFILE, INLFILE, IERR)

Where:
Integer OPTIONS (20) array of elements specifying power flow options(input).
OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
364
Power Flow N11_ACCC_PARALLEL

OPTIONS(5) switched shunt adjustment flag for the first

N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete.
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall.
OPTIONS(6) = 1 trip.
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable.
OPTIONS(8) = 1 Enable.
OPTIONS(9) tap adjustment flag for the second N-1 con-
tingency (tap adjustment option setting by
default)
OPTIONS(9) = 0 disable.
OPTIONS(9) = 1 enable stepping adjustment.
OPTIONS(9) = 2 enable direct adjustment.
OPTIONS(10) area interchange adjustment flag for the sec-
ond N-1 contingency (area interchange ad-
justment option setting by default)
OPTIONS(10) = 0 disable.
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange.
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange.
OPTIONS(11) phase shift adjustment flag for the second
N-1 contingency (phase shift adjustment op-
tion setting by default)
OPTIONS(11) = 0 disable.
OPTIONS(11) = 1 enable.
OPTIONS(12) dc tap adjustment flag for the second N-1
contingency (dc tap adjustment option set-
ting by default)
OPTIONS(12) = 0 disable.
OPTIONS(12) = 1 enable.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
365
Power Flow N11_ACCC_PARALLEL

OPTIONS(13) switched shunt adjustment flag for the sec-

ond N-1 contingency (switched shunt adjust-
ment option setting by default)
OPTIONS(13) = 0 disable
OPTIONS(13) = 1 enable
OPTIONS(13) = 2 enable continuous, disable discrete.
OPTIONS(14) induction motor treatment flag for the sec-
ond N-1 contingency (applied when an in-
duction motor fails to solve due to low termi-
nal bus voltage, 0 by default)
OPTIONS(14) = 0 stall
OPTIONS(14) = 1 trip
OPTIONS(15) generation dispatch method
OPTIONS(15) = 0 disable.
OPTIONS(15) = 1 subsystem machines (RESERVE).
OPTIONS(15) = 2 subsystem machines (PMAX).
OPTIONS(15) = 3 subsystem machines (INERTIA).
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP).
OPTIONS(16) flag to skip the second N-1 contingencies if
the first N-1 contingency is not clean
OPTIONS(16) = 0 No
OPTIONS(16) = 1 Yes
OPTIONS(17) Rating set for the first N-1 contingency case
OPTIONS(17) = 1 rate A
OPTIONS(17) = 2 rate B
OPTIONS(17) = 3 rate C
OPTIONS(18) Rating set for the second N-1 contingency
case
OPTIONS(18) = 1 rate A
OPTIONS(18) = 2 rate B
OPTIONS(18) = 3 rate C
OPTIONS(19) voltage limit for the first N-1 contingency
case
OPTIONS(19) = 1 normal
OPTIONS(19) = 2 emergency
OPTIONS(20) voltage limit for the second N-1 contingency
case
OPTIONS(20) = 1 normal
OPTIONS(20) = 2 emergency
Real VALUES (2) array of 2 elements specifying power flow options(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Percent of rating for the first N-1 contin-
gency and second N-1 contingency case
(100.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
366
Power Flow N11_ACCC_PARALLEL

Character*32 LABEL The label of generation dispatch system, required if the dispatch
mode of OPTIONS(15) is not zero. The dispatch mode and the system
provide for a default dispatch method for contingencies causing un-
balance between load demand and generation output. (input).
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Character*260 ACCFILE Is the name of contingency analysis output file (input; no default al-
lowed).
Character*260 CONFILE Is the name of Contingency Description Data File for the second N-1
contingencies (input; blank by default).
Character*260 THRFILE Is the name of Load Throwover Data File (input; blank by default).
Character*260 INLFILE Is the name of Unit Inertia Data File (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Generators are converted
IERR = 4 Buses in island(s) without a swing bus--use
activity TREE
IERR = 5 Largest mismatch exceeds tolerance
IERR = 6 Generation subsystem not specified
IERR = 7 Too many islands in base case.
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 No Distribution Factor Data input file speci-
fied
IERR = 11 No Contingency Solution Output File speci-
fied
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion.
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 error opening Load Throwover Data File
IERR = 53 error opening Unit Inertia and Governor Data
File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
367
Power Flow N11_ACCC_PARALLEL_2

1.1.168. N11_ACCC_PARALLEL_2
Use this API to run the N-1-1 contingency analysis in parallel when the number of contingency processors
in Program Settings is greater than 1. The API distributes contingency cases among multiple processors
evenly, and tests the contingency cases and following tripping actions assigned to each processor in paral-
lel.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_N11_ACCC_PARALLEL_2 OPTIONS(1)..OPTIONS(16) VALUES LABEL DFXFILE

ACCFILE CONFILE THRFILE INLFILE

Python command syntax:

ierr = n11_accc_parallel_2(options, values, label, dfxfile, accfile,

confile, thrfile, inlfile)

Fortran command syntax:

CALL N11_ACCC_PARALLEL_2(OPTIONS, VALUES, LABEL, DFXFILE, ACCFILE,

CONFILE, THRFILE, INLFILE, IERR)

Where:
Integer OPTIONS (16) array of elements specifying power flow options(input).
OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
368
Power Flow N11_ACCC_PARALLEL_2

OPTIONS(5) switched shunt adjustment flag for the first

N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete.
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall.
OPTIONS(6) = 1 trip.
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable.
OPTIONS(8) = 1 Enable.
OPTIONS(9) tap adjustment flag for the second N-1 con-
tingency (tap adjustment option setting by
default)
OPTIONS(9) = 0 disable.
OPTIONS(9) = 1 enable stepping adjustment.
OPTIONS(9) = 2 enable direct adjustment.
OPTIONS(10) area interchange adjustment flag for the sec-
ond N-1 contingency (area interchange ad-
justment option setting by default)
OPTIONS(10) = 0 disable.
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange.
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange.
OPTIONS(11) phase shift adjustment flag for the second
N-1 contingency (phase shift adjustment op-
tion setting by default)
OPTIONS(11) = 0 disable.
OPTIONS(11) = 1 enable.
OPTIONS(12) dc tap adjustment flag for the second N-1
contingency (dc tap adjustment option set-
ting by default)
OPTIONS(12) = 0 disable.
OPTIONS(12) = 1 enable.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
369
Power Flow N11_ACCC_PARALLEL_2

OPTIONS(13) switched shunt adjustment flag for the sec-

ond N-1 contingency (switched shunt adjust-
ment option setting by default)
OPTIONS(13) = 0 disable
OPTIONS(13) = 1 enable
OPTIONS(13) = 2 enable continuous, disable discrete.
OPTIONS(14) induction motor treatment flag for the sec-
ond N-1 contingency (applied when an in-
duction motor fails to solve due to low termi-
nal bus voltage, 0 by default)
OPTIONS(14) = 0 stall
OPTIONS(14) = 1 trip
OPTIONS(15) generation dispatch method
OPTIONS(15) = 0 disable.
OPTIONS(15) = 1 subsystem machines (RESERVE).
OPTIONS(15) = 2 subsystem machines (PMAX).
OPTIONS(15) = 3 subsystem machines (INERTIA).
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP).
OPTIONS(16) flag to skip the second N-1 contingencies if
the first N-1 contingency is not clean
OPTIONS(16) = 0 No
OPTIONS(16) = 1 Yes
Real VALUES (1) array of 1 elements specifying power flow options(input).
VALUES(1) Mismatch tolerance (TOLN by default)
Character*32 LABEL The label of generation dispatch system, required if the dispatch
mode of OPTIONS(15) is not zero. The dispatch mode and the system
provide for a default dispatch method for contingencies causing un-
balance between load demand and generation output. (input).
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Character*260 ACCFILE Is the name of contingency analysis output file (input; no default al-
lowed).
Character*260 CONFILE Is the name of Contingency Description Data File for the second N-1
contingencies (input; blank by default).
Character*260 THRFILE Is the name of Load Throwover Data File (input; blank by default).
Character*260 INLFILE Is the name of Unit Inertia Data File (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Generators are converted
IERR = 4 Buses in island(s) without a swing bus--use
activity TREE
IERR = 5 Largest mismatch exceeds tolerance

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
370
Power Flow N11_ACCC_PARALLEL_2

IERR = 6 Generation subsystem not specified

IERR = 7 Too many islands in base case.
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 No Distribution Factor Data input file speci-
fied
IERR = 11 No Contingency Solution Output File speci-
fied
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion.
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 error opening Load Throwover Data File
IERR = 53 error opening Unit Inertia and Governor Data
File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
371
Power Flow N11_ACCC_PSCOPF

1.1.169. N11_ACCC_PSCOPF
This API routine is obsolete. It has been replaced by the API routine n11_accc_pscopf_2 .

The API is used to perform N-1-1 contingency analysis in either corrective mode or security constrained op-
timal power flow mode (SCOPF). In corrective mode, for each pair of N-1 contingencies a full AC load flow
is performed for the first N-1 contingency; the post contingency solution is checked against the operation
limits and corrective actions are specified to mitigate the limit violations; the post-corrective action solu-
tion is used as the base case for the secondary contingency and a full AC load flow is performed to solve
the second N-1 contingency.
In the SCOPF mode, a primary contingency is imposed and solved with a full AC load flow solution. A se-
cure control is conducted on the system condition existing after the primary contingency with the sec-
ondary contingencies, control adjustments are specified by security constrained optimal power flow to en-
sure security of the system after the primary contingency. The system condition after the primary contin-
gency and adjustments is used as the base case for secondary contingency; a full AC load flow solution is
then performed to solve a secondary N-1 contingency.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_N11_ACCC_PSCOPF OPTIONS(1)..OPTIONS(18) OPTCOR(1)..OPTCOR(9)

VALUES(1)..VALUES(10) LABELS(1)..LABELS(7) DFXFILE ACCFILE CONFILE
INLFILE THRFILE

Python command syntax:

ierr = n11_accc_pscopf(options, optcor, values, labels, dfxfile, accfile,

confile, inlfile, thrfile)

Fortran command syntax:

CALL N11_ACCC_PSCOPF(OPTIONS, OPTCOR, VALUES, LABELS, DFXFILE, ACCFILE,

CONFILE, INLFILE, THRFILE, IERR)

Where:

Integer OPTIONS (18) array of 18 elements specifying integer specifying power flow
options(input).
OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
372
Power Flow N11_ACCC_PSCOPF

OPTIONS(2) = 2 enable using tie line flows and loads in calcu-

lating area interchange
OPTIONS(3) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable stepping adjustment
OPTIONS(9) = 2 enable direct adjustment
OPTIONS(10) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
373
Power Flow N11_ACCC_PSCOPF

OPTIONS(10) = 2 enable using tie line flows and loads in calcu-

lating area interchange
OPTIONS(11) phase shift adjustment flag for the first N-1
contingency (phase shift adjustment option
setting by default)
OPTIONS(11) = 0 disable
OPTIONS(11) = 1 enable
OPTIONS(12) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)
OPTIONS(12) = 0 disable
OPTIONS(12) = 1 enable
OPTIONS(13) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(13) = 0 disable
OPTIONS(13) = 1 enable
OPTIONS(13) = 2 enable continuous, disable discrete
OPTIONS(14) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(14) = 0 stall
OPTIONS(14) = 1 trip
OPTIONS(15) dispatch mode (0 by default)
OPTIONS(15) = 0 disable
OPTIONS(15) = 1 subsystem machines (RESERVE)
OPTIONS(15) = 2 subsystem machines (PMAX)
OPTIONS(15) = 3 subsystem machines (INERTIA)
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP)
OPTIONS(16) flag to skip the second N-1 contingencies if
the first N-1 contingency is not clean
OPTIONS(16) = 0 No
OPTIONS(16) = 1 Yes
OPTIONS(17) Rating set for the first N-1 contingency case
OPTIONS(17) = 1 RATE A
OPTIONS(17) = 2 RATE B
OPTIONS(17) = 3 RATE C
OPTIONS(18) Rating set for the second N-1 contingency
case
OPTIONS(18) = 1 RATE A
OPTIONS(18) = 2 RATE B
OPTIONS(18) = 3 RATE C
Integer OPTCOR (9) array of 9 elements specifying OPTCOR Is an integer specifying con-
trol options(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
374
Power Flow N11_ACCC_PSCOPF

OPTCOR(1) System adjustment mode

OPTCOR(1) = 0 local adjustment only
OPTCOR(1) = 1 Corrective action mode
OPTCOR(1) = 2 Preventive security constrained optimal pow-
er flow mode
OPTCOR(2) maximum iteration number of PSCOPF, re-
quired if OPTCOR(1) is 2
OPTCOR(3) maximum number of a contingency that
does not cause limit violations and instability
issue to be tested in the iterative process of
PSCOPF, required if OPTCOR(1) is 2
OPTCOR(4) generator control flag (1 by default)
OPTCOR(4) = 0 disable generation MW dispatch in the cor-
rective action mode or preventive security
constrained optimal power flow mode
OPTCOR(4) = 1 enable
OPTCOR(5) load control flag (0 by default)
OPTCOR(5) = 0 disable load shedding control in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(5) = 1 enable
OPTCOR(6) phase shifter control flag (1 by default)
OPTCOR(6) = 0 disable phase shifter control in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(6) = 1 enable
OPTCOR(7) off-line generator control flag (0 by default)
OPTCOR(7) = 0 disable generation MW dispatch of off-line
generators in the corrective action mode or
preventive security constrained optimal pow-
er flow mode
OPTCOR(7) = 1 enable
OPTCOR(8) tap setting adjustment flag (0 by default)
OPTCOR(8) = 0 disable tap setting adjustment in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(8) = 1 enable
OPTCOR(9) switched shunt control flag (0 by default)
OPTCOR(9) = 0 disable switch shunt control in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(9) = 1 enable
Real VALUES (10) array of 10 elements specifying VALUES Is a real(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Percentage of rating for the base case (100.0
bye default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
375
Power Flow N11_ACCC_PSCOPF

VALUES(3) Voltage tolerance in linear programming

VALUES(4) Flow tolerance in linear programming
VALUES(5) Weighting factor of generation MW dispatch
(1.0 bye default)
VALUES(6) Weighting factor of load control (1.0 bye de-
fault)
VALUES(7) Weighting factor of phase shifter control (1.0
bye default)
VALUES(8) Weighting factor of generation MW dispatch
of off-line generators (1.0 bye default)
VALUES(9) Weighting factor of tap setting adjustment
(1.0 by default)
VALUES(10) Weighting factor of switched shunt control
(1.0 by default)
Character*32 LABELS (7) array of 7 elements specifying specifiying subsystem labels(input).
LABELS(1) label of generation dispatch system, required
if the dispatch mode of OPTIONS(15) is not
zero. The dispatch mode and the system pro-
vide for a default dispatch method for contin-
gencies causing unbalance between load de-
mand and generation (blank for none by de-
fault)
LABELS(2) label of generation dispatch control system.
MW injections of the generators within the
system are available for dispatch in the cor-
rective action mode or preventive security
constrained optimal power flow mode (blank
for none by default)
LABELS(3) label of load control system. Loads in the
load control system are available for curtail-
ment in the corrective action mode or pre-
ventive security constrained optimal power
flow mode (blank for none by default)
LABELS(4) label of phase shifter adjustment system. The
phase angles of phase shifters in the system
are regulated either by corrective action or
preventive security constrained optimal pow-
er flow (blank for none by default)
LABELS(5) label of generation MW control of off-line
generator control system. MW injections of
the off-line generators within the system are
available for dispatch in the corrective action
mode or preventive security constrained opti-
mal power flow mode (blank for none by de-
fault)
LABELS(6) label of tap adjustment system. The tap posi-
tions of transformers in voltage control mode
are regulated either by corrective action or

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
376
Power Flow N11_ACCC_PSCOPF

preventive security constrained optimal pow-

er flow (blank for none by default)
LABELS(7) label of switched shunt control system. The
admittances of switched shunts in voltage
control mode are regulated either by correc-
tive action or preventive security constrained
optimal power flow (blank for none by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 ACCFILE name of contingency analysis output file (input; no default allowed).
Character*260 CONFILE name of Contingency Description Data File for the second N-1 contin-
gencies (input; blank for none).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Generators are converted
IERR = 4 Buses in island(s) without a swing bus--use
activity TREE
IERR = 5 Largest mismatch exceeds tolerance
IERR = 6 Generation subsystem not specified
IERR = 7 Too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 No Distribution Factor Data input file speci-
fied
IERR = 11 No Contingency Analysis Output File specified
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion
IERR = 15 Invalid OPTCOR value
IERR = 21 File is not in the form of a PSSE-25 or later
DFAX file--run DFAX
IERR = 22 Monitored elements exceed limit when
adding multi-section line members
IERR = 51 Error opening distribution factor data file
IERR = 52 Error opening load throwover data file
IERR = 53 Error opening inertia data file

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
377
Power Flow N11_ACCC_PSCOPF

IERR = 54 Prerequisite requirements for function not

met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
378
Power Flow N11_ACCC_PSCOPF_2

1.1.170. N11_ACCC_PSCOPF_2
The API is the second release of N-1-1 contingency analysis solution in either corrective mode or secu-
rity constrained optimal power flow mode (SCOPF). In corrective mode, for each pair of N-1 contingen-
cies a full AC load flow is performed for the first N-1 ontingency; the post contingency solution is checked
against the operation limits and corrective actions are specified to mitigate the limit violations; the post-
corrective action solution is used as the base case for the secondary contingency and a full AC load flow is
performed to solve the second N-1 contingency.
In the PSCOPF mode, a primary contingency is imposed and solved with a full AC load flow solution. A se-
cure control is conducted on the system condition existing after the primary contingency with the sec-
ondary contingencies, control adjustments are specified by security constrained optimal power flow to en-
sure security of the system after the primary contingency. The system condition after the primary contin-
gency and adjustments is used as the base case for secondary contingency; a full AC load flow solution is
then performed to solve a secondary N-1 contingency.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_N11_ACCC_PSCOPF_2 OPTIONS(1)..OPTIONS(20) OPTCOR(1)..OPTCOR(9)

VALUES(1)..VALUES(10) LABELS(1)..LABELS(7) DFXFILE ACCFILE CONFILE
THRFILE INLFILE

Python command syntax:

ierr = n11_accc_pscopf_2(options, optcor, values, labels, dfxfile,

accfile, confile, inlfile, thrfile)

Fortran command syntax:

CALL N11_ACCC_PSCOPF_2(OPTIONS, OPTCOR, VALUES, LABELS, DFXFILE, ACCFILE,

CONFILE, INLFILE, THRFILE, IERR)

Where:

Integer OPTIONS (20) array of elements specifying power flow options(input).

OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
379
Power Flow N11_ACCC_PSCOPF_2

OPTIONS(3) phase shift adjustment flag for the first N-1

contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete.
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall.
OPTIONS(6) = 1 trip.
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the second N-1 con-
tingency (tap adjustment option setting by
default)
OPTIONS(9) = 0 disable.
OPTIONS(9) = 1 enable stepping adjustment.
OPTIONS(9) = 2 enable direct adjustment.
OPTIONS(10) area interchange adjustment flag for the sec-
ond N-1 contingency (area interchange ad-
justment option setting by default)
OPTIONS(10) = 0 disable.
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange.
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
380
Power Flow N11_ACCC_PSCOPF_2

OPTIONS(11) phase shift adjustment flag for the second

N-1 contingency (phase shift adjustment op-
tion setting by default)
OPTIONS(11) = 0 disable.
OPTIONS(11) = 1 enable.
OPTIONS(12) dc tap adjustment flag for the second N-1
contingency (dc tap adjustment option set-
ting by default)
OPTIONS(12) = 0 disable.
OPTIONS(12) = 1 enable.
OPTIONS(13) switched shunt adjustment flag for the sec-
ond N-1 contingency (switched shunt adjust-
ment option setting by default)
OPTIONS(13) = 0 disable.
OPTIONS(13) = 1 enable.
OPTIONS(13) = 2 enable continuous, disable discrete.
OPTIONS(14) induction motor treatment flag for the sec-
ond N-1 contingency (applied when an in-
duction motor fails to solve due to low termi-
nal bus voltage, 0 by default)
OPTIONS(14) = 0 stall.
OPTIONS(14) = 1 trip.
OPTIONS(15) dispatch mode (0 by default)
OPTIONS(15) = 0 disable.
OPTIONS(15) = 1 subsystem machines (RESERVE).
OPTIONS(15) = 2 subsystem machines (PMAX).
OPTIONS(15) = 3 subsystem machines (INERTIA).
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP).
OPTIONS(16) flag to skip the second N-1 contingencies if
the first N-1 contingency is not clean
OPTIONS(16) = 0 No
OPTIONS(16) = 1 Yes
OPTIONS(17) Rating set for the first N-1 contingency case
OPTIONS(17) = 1 rate A
OPTIONS(17) = 2 rate B
OPTIONS(17) = 3 rate C
OPTIONS(18) Rating set for the second N-1 contingency
case
OPTIONS(18) = 1 rate A
OPTIONS(18) = 2 rate B
OPTIONS(18) = 3 rate C
OPTIONS(19) voltage limit for the first N-1 contingency
case
OPTIONS(19) = 1 normal
OPTIONS(19) = 2 emergency

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
381
Power Flow N11_ACCC_PSCOPF_2

OPTIONS(20) voltage limit for the second N-1 contingency

case
OPTIONS(20) = 1 normal
OPTIONS(20) = 2 emergency
Integer OPTCOR (9) array of elements specifying control options(input).
OPTCOR(1) System adjustment mode
OPTCOR(1) = 0 local adjustment only
OPTCOR(1) = 1 Corrective action mode
OPTCOR(1) = 2 Preventive security constrained optimal pow-
er flow mode
OPTCOR(2) maximum iteration number of PSCOPF, re-
quired if OPTCOR(1) is 2
OPTCOR(3) maximum number of a contingency that
does not cause limit violations and instability
issue to be tested in the iterative process of
PSCOPF, required if OPTCOR(1) is 2.
OPTCOR(4) generator control flag (0 by default)
OPTCOR(4) = 0 disable generation MW dispatch in the cor-
rective action mode or preventive security
constrained optimal power flow mode
OPTCOR(4) = 1 enable
OPTCOR(5) load control flag (0 by default)
OPTCOR(5) = 0 disable load shedding control in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(5) = 1 enable
OPTCOR(6) phase shifter control flag (1 by default)
OPTCOR(6) = 0 disable phase shifter control in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(6) = 1 enable
OPTCOR(7) off-line generator control flag (0 by default)
OPTCOR(7) = 0 disable generation MW dispatch of off-line
generators in the corrective action mode or
preventive security constrained optimal pow-
er flow mode
OPTCOR(7) = 1 enable
OPTCOR(8) tap setting adjustment flag (0 by default)
OPTCOR(8) = 0 disable tap setting adjustment in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(8) = 1 enable
OPTCOR(9) switched shunt control flag (0 by default)
OPTCOR(9) = 0 disable switch shunt control in the correc-
tive action mode or preventive security con-
strained optimal power flow

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
382
Power Flow N11_ACCC_PSCOPF_2

OPTCOR(9) = 1 enable
Real VALUES (10) array of elements specifying power flow settings(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Percentage of rating for the base case (100.0
by default)
VALUES(3) Voltage tolerance in linear programming
VALUES(4) Flow tolerance in linear programming
VALUES(5) Weighting factor of generation MW dispatch
(1.0 by default)
VALUES(6) Weighting factor of load control (1.0 by de-
fault)
VALUES(7) Weighting factor of phase shifter control (1.0
by default)
VALUES(8) Weighting factor of generation MW dispatch
of off-line generators (1.0 by default)
VALUES(9) Weighting factor of tap setting adjustment
(1.0 by default)
VALUES(10) Weighting factor of switched shunt control
(1.0 by default)
Character*32 LABELS (7) array of elements specifying subsystem labels (input).
LABELS(1) The label of generation dispatch system, re-
quired if the dispatch mode of OPTIONS(15)
is not zero. The dispatch mode and the sys-
tem provide for a default dispatch method
for contingencies causing unbalance be-
tween load demand and generation output
(blank for none).
LABELS(2) The label of generation dispatch control sys-
tem. MW injections of the generators within
the system are available for dispatch in the
corrective action mode or preventive security
constrained optimal power flow mode (blank
for none).
LABELS(3) The label of load control system. Loads in the
load control system are available for curtail-
ment in the corrective action mode or pre-
ventive security constrained optimal power
flow mode (blank for none).
LABELS(4) The label of phase shifter adjustment system.
The phase angles of phase shifters in the sys-
tem are regulated either by corrective action
or preventive security constrained optimal
power flow (blank for none).
LABELS(5) The label of generation MW control of off-
line generator control system. MW injections
of the off-line generators within the system
are available for dispatch in the corrective ac-

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
383
Power Flow N11_ACCC_PSCOPF_2

tion mode or preventive security constrained

optimal power flow mode (blank for none).
LABELS(6) The label of tap adjustment system. The tap
positions of transformers in voltage control
mode are regulated either by corrective ac-
tion or preventive security constrained opti-
mal power flow (blank for none).
LABELS(7) The label of switched shunt control sys-
tem. The admittances of switched shunts in
voltage control mode are regulated either
by corrective action or preventive security
constrained optimal power flow (blank for
none).
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Character*260 ACCFILE Is the name of contingency analysis output file (input; no default al-
lowed).
Character*260 CONFILE Is the name of Contingency Description Data File for the second N-1
contingencies (blank for none) (input).
Character*260 THRFILE Is the name of Load Throwover Data File (blank for none). (input).
Character*260 INLFILE Is the name of Unit Inertia Data File (blank for none). (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 no Distribution Factor Data File specified
IERR = 11 no Contingency Analysis Output File specified
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion.
IERR = 15 Invalid OPTCOR value

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
384
Power Flow N11_ACCC_PSCOPF_2

IERR = 21 file DFXFILE is not in the form of a PSSE 25 or

later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 error opening Load Throwover Data File
IERR = 53 error opening Unit Inertia and Governor Data
File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
385
Power Flow N11_ACCC_PSCOPF_3

1.1.171. N11_ACCC_PSCOPF_3
The API is the second release of N-1-1 contingency analysis solution in either corrective mode or secu-
rity constrained optimal power flow mode (SCOPF). In corrective mode, for each pair of N-1 contingen-
cies a full AC load flow is performed for the first N-1 ontingency; the post contingency solution is checked
against the operation limits and corrective actions are specified to mitigate the limit violations; the post-
corrective action solution is used as the base case for the secondary contingency and a full AC load flow is
performed to solve the second N-1 contingency.
In the PSCOPF mode, a primary contingency is imposed and solved with a full AC load flow solution. A se-
cure control is conducted on the system condition existing after the primary contingency with the sec-
ondary contingencies, control adjustments are specified by security constrained optimal power flow to en-
sure security of the system after the primary contingency. The system condition after the primary contin-
gency and adjustments is used as the base case for secondary contingency; a full AC load flow solution is
then performed to solve a secondary N-1 contingency.

This API routine was first introduced in release 35.1.0.

Batch command syntax:

BAT_N11_ACCC_PSCOPF_3 OPTIONS(1)..OPTIONS(16) OPTCOR(1)..OPTCOR(9)

VALUES(1)..VALUES(9) LABELS(1)..LABELS(7) DFXFILE ACCFILE CONFILE THRFILE
INLFILE

Python command syntax:

ierr = n11_accc_pscopf_3(options, optcor, values, labels, dfxfile,

accfile, confile, inlfile, thrfile)

Fortran command syntax:

CALL N11_ACCC_PSCOPF_3(OPTIONS, OPTCOR, VALUES, LABELS, DFXFILE, ACCFILE,

CONFILE, INLFILE, THRFILE, IERR)

Where:

Integer OPTIONS (16) array of elements specifying power flow options(input).

OPTIONS(1) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the first
N-1 contingency (area interchange adjust-
ment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
386
Power Flow N11_ACCC_PSCOPF_3

OPTIONS(3) phase shift adjustment flag for the first N-1

contingency (phase shift adjustment option
setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the first N-1 con-
tingency (dc tap adjustment option setting
by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag for the first
N-1 contingency (switched shunt adjustment
option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete.
OPTIONS(6) induction motor treatment flag for the first
N-1 contingency (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(6) = 0 stall.
OPTIONS(6) = 1 trip.
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the second N-1 con-
tingency (tap adjustment option setting by
default)
OPTIONS(9) = 0 disable.
OPTIONS(9) = 1 enable stepping adjustment.
OPTIONS(9) = 2 enable direct adjustment.
OPTIONS(10) area interchange adjustment flag for the sec-
ond N-1 contingency (area interchange ad-
justment option setting by default)
OPTIONS(10) = 0 disable.
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange.
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
387
Power Flow N11_ACCC_PSCOPF_3

OPTIONS(11) phase shift adjustment flag for the second

N-1 contingency (phase shift adjustment op-
tion setting by default)
OPTIONS(11) = 0 disable.
OPTIONS(11) = 1 enable.
OPTIONS(12) dc tap adjustment flag for the second N-1
contingency (dc tap adjustment option set-
ting by default)
OPTIONS(12) = 0 disable.
OPTIONS(12) = 1 enable.
OPTIONS(13) switched shunt adjustment flag for the sec-
ond N-1 contingency (switched shunt adjust-
ment option setting by default)
OPTIONS(13) = 0 disable.
OPTIONS(13) = 1 enable.
OPTIONS(13) = 2 enable continuous, disable discrete.
OPTIONS(14) induction motor treatment flag for the sec-
ond N-1 contingency (applied when an in-
duction motor fails to solve due to low termi-
nal bus voltage, 0 by default)
OPTIONS(14) = 0 stall.
OPTIONS(14) = 1 trip.
OPTIONS(15) dispatch mode (0 by default)
OPTIONS(15) = 0 disable.
OPTIONS(15) = 1 subsystem machines (RESERVE).
OPTIONS(15) = 2 subsystem machines (PMAX).
OPTIONS(15) = 3 subsystem machines (INERTIA).
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP).
OPTIONS(16) flag to skip the second N-1 contingencies if
the first N-1 contingency is not clean
OPTIONS(16) = 0 No
OPTIONS(16) = 1 Yes
Integer OPTCOR (9) array of elements specifying control options(input).
OPTCOR(1) System adjustment mode
OPTCOR(1) = 0 local adjustment only
OPTCOR(1) = 1 Corrective action mode
OPTCOR(1) = 2 Preventive security constrained optimal pow-
er flow mode
OPTCOR(2) maximum iteration number of PSCOPF, re-
quired if OPTCOR(1) is 2
OPTCOR(3) maximum number of a contingency that
does not cause limit violations and instability
issue to be tested in the iterative process of
PSCOPF, required if OPTCOR(1) is 2.
OPTCOR(4) generator control flag (0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
388
Power Flow N11_ACCC_PSCOPF_3

OPTCOR(4) = 0 disable generation MW dispatch in the cor-

rective action mode or preventive security
constrained optimal power flow mode
OPTCOR(4) = 1 enable
OPTCOR(5) load control flag (0 by default)
OPTCOR(5) = 0 disable load shedding control in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(5) = 1 enable
OPTCOR(6) phase shifter control flag (1 by default)
OPTCOR(6) = 0 disable phase shifter control in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(6) = 1 enable
OPTCOR(7) off-line generator control flag (0 by default)
OPTCOR(7) = 0 disable generation MW dispatch of off-line
generators in the corrective action mode or
preventive security constrained optimal pow-
er flow mode
OPTCOR(7) = 1 enable
OPTCOR(8) tap setting adjustment flag (0 by default)
OPTCOR(8) = 0 disable tap setting adjustment in the correc-
tive action mode or preventive security con-
strained optimal power flow mode
OPTCOR(8) = 1 enable
OPTCOR(9) switched shunt control flag (0 by default)
OPTCOR(9) = 0 disable switch shunt control in the correc-
tive action mode or preventive security con-
strained optimal power flow
OPTCOR(9) = 1 enable
Real VALUES (9) array of elements specifying power flow settings(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Voltage tolerance in linear programming
VALUES(3) Flow tolerance in linear programming
VALUES(4) Weighting factor of generation MW dispatch
(1.0 by default)
VALUES(5) Weighting factor of load control (1.0 by de-
fault)
VALUES(6) Weighting factor of phase shifter control (1.0
by default)
VALUES(7) Weighting factor of generation MW dispatch
of off-line generators (1.0 by default)
VALUES(8) Weighting factor of tap setting adjustment
(1.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
389
Power Flow N11_ACCC_PSCOPF_3

VALUES(9) Weighting factor of switched shunt control

(1.0 by default)
Character*32 LABELS (7) array of elements specifying subsystem labels (input).
LABELS(1) The label of generation dispatch system, re-
quired if the dispatch mode of OPTIONS(15)
is not zero. The dispatch mode and the sys-
tem provide for a default dispatch method
for contingencies causing unbalance be-
tween load demand and generation output
(blank for none).
LABELS(2) The label of generation dispatch control sys-
tem. MW injections of the generators within
the system are available for dispatch in the
corrective action mode or preventive security
constrained optimal power flow mode (blank
for none).
LABELS(3) The label of load control system. Loads in the
load control system are available for curtail-
ment in the corrective action mode or pre-
ventive security constrained optimal power
flow mode (blank for none).
LABELS(4) The label of phase shifter adjustment system.
The phase angles of phase shifters in the sys-
tem are regulated either by corrective action
or preventive security constrained optimal
power flow (blank for none).
LABELS(5) The label of generation MW control of off-
line generator control system. MW injections
of the off-line generators within the system
are available for dispatch in the corrective ac-
tion mode or preventive security constrained
optimal power flow mode (blank for none).
LABELS(6) The label of tap adjustment system. The tap
positions of transformers in voltage control
mode are regulated either by corrective ac-
tion or preventive security constrained opti-
mal power flow (blank for none).
LABELS(7) The label of switched shunt control sys-
tem. The admittances of switched shunts in
voltage control mode are regulated either
by corrective action or preventive security
constrained optimal power flow (blank for
none).
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Character*260 ACCFILE Is the name of contingency analysis output file (input; no default al-
lowed).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
390
Power Flow N11_ACCC_PSCOPF_3

Character*260 CONFILE Is the name of Contingency Description Data File for the second N-1
contingencies (blank for none) (input).
Character*260 THRFILE Is the name of Load Throwover Data File (blank for none). (input).
Character*260 INLFILE Is the name of Unit Inertia Data File (blank for none). (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 generation dispatch subsystem is not defined
IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 no Distribution Factor Data File specified
IERR = 11 no Contingency Analysis Output File specified
IERR = 12 Can not read the Contingency Description Da-
ta File for the second N-1 contingencies
IERR = 13 No second N-1 contingencies are specified
IERR = 14 Invalid base/contingency case flag combina-
tion.
IERR = 15 Invalid OPTCOR value
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 error opening Load Throwover Data File
IERR = 53 error opening Unit Inertia and Governor Data
File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
391
Power Flow NETG

1.1.172. NETG
Use this API to change the in-service generation to negative MVA load at all Type 2 and 3 buses except
those in the subsystem specified by the user.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_NETG SID ALL

Python command syntax:

ierr = netg(sid, all)

Fortran command syntax:

CALL NETGNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses outside of subsystem SID
ALL = 1 process all buses
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
392
Power Flow NEWCAS

1.1.173. NEWCAS
This API routine is obsolete. It has been replaced by the API routine newcase_2 .

Use this API to initialize a new power flow case. All existing working case data will be lost upon execution
of this API.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_NEWCAS BASEMVA TITL1 TITL2

Python command syntax:

ierr = newcas(basemva, titl1, titl2)

Fortran command syntax:

CALL NEWCASNW(BASEMVA, TITL1, TITL2, IERR)

Where:

Real BASEMVA new system base MVA. Valid base MVA values range from 1.0 to
10,000.0 (input; 100.0).
Character*60 TITL1 first line of the new case title (input; blank by default).
Character*60 TITL2 second line of the new case title (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid BASEMVA value
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
393
Power Flow NEWCASE_2

1.1.174. NEWCASE_2
This API is the second release of the function used to initialize a new power flow case. All existing working
case data will be lost upon execution of this API.

This API routine was first introduced in release 31.0.0.

Batch command syntax:

BAT_NEWCASE_2 OPTIONS(1) OPTIONS(2) BASEMVA BASEFREQ TITL1 TITL2

Python command syntax:

ierr = newcase_2(options, basemva, basefreq, titl1, titl2)

Fortran command syntax:

CALL NEWCASE_2(OPTIONS, BASEMVA, BASEFREQ, TITL1, TITL2, IERR)

Where:

Integer OPTIONS (2) array of 2 elements specifying units for ratings (used to set the per-
cent loading program option settings)(input).
OPTIONS(1) units for transformer ratings
OPTIONS(1) > 0 current expressed as MVA
OPTIONS(1) < 0 MVA
OPTIONS(2) units for ratings of non-transformer branches
OPTIONS(2) > 0 current expressed as MVA
OPTIONS(2) < 0 MVA
Real BASEMVA system base MVA. Valid base MVA values range from 1.0 to 10,000.0
(input; 100.0).
Real BASEFREQ system base frequency. Valid base frequency values range from
greater than 0.0 to less than 100.0 (input; present base frequency
option setting).
Character*60 TITL1 first line of the new case title (input; blank by default).
Character*60 TITL2 second line of the new case title (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid BASEMVA value
IERR = 2 invalid BASEFREQ value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
394
Power Flow NEWTON_TOLERANCE

1.1.175. NEWTON_TOLERANCE
Use this API to specify or return the value of the default Newton-Raphson convergence tolerance.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_NEWTON_TOLERANCE RVAL

Python command syntax:

ierr = newton_tolerance(rval)

ierr, rval = newton_tolerance()

Fortran command syntax:

CALL NEWTON_TOLERANCE_API(RVAL, IOCODE, IERR)

Where:

Real RVAL value of the option setting (input; if Batch command, or for Python
if specified as an argument, or for Fortran if IOCODE is 0, 0.1 by de-
fault; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
RVAL.
IOCODE = 1 return the current value of the option setting
in RVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid RVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
395
Power Flow NEW_DIMENSION

1.1.176. NEW_DIMENSION
Use this API to reset PSSE to an increased bus size level.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_NEW_DIMENSION BUSES

Python command syntax:

ierr = new_dimension(buses)

Fortran command syntax:

CALL NEW_DIMENSION(BUSES, IERR)

Where:

Integer BUSES maximum number of buses allowed at the new size level If BUSES is
less than the current maximum number of buses, PSSE's capacity lim-
its are not changed (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid BUSES value
IERR = 2 prerequisite requirements for API are not met
IERR = 3 Unable to change network to new bus size.
PSSE Xplore is limited to 50 buses.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
396
Power Flow NON_DIVERGENT

1.1.177. NON_DIVERGENT
Use this API to specify or return the option to specify or return the option to enable or disable the non-di-
vergent Newton power flow solution.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_NON_DIVERGENT IVAL

Python command syntax:

ierr = non_divergent(ival)

ierr, ival = non_divergent()

Fortran command syntax:

CALL NON_DIVERGENT_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 disable non-divergent Newton solution op-
tion.
IVAL = 1 enable non-divergent Newton solution op-
tion.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
397
Power Flow NON_TRANS_PERCENT_UNITS

1.1.178. NON_TRANS_PERCENT_UNITS
Use this API to set the non-transformer branch percent units option setting to either MVA or current ex-
pressed as MVA.

This API routine was first introduced in release 31.0.0.

Batch command syntax:

BAT_NON_TRANS_PERCENT_UNITS IVAL

Python command syntax:

ierr = non_trans_percent_units(ival)

ierr, ival = non_trans_percent_units()

Fortran command syntax:

CALL NON_TRANS_PERCENT_UNITS_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1 by default;
else output).
IVAL = 0 MVA.
IVAL = 1 current expressed as MVA.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
398
Power Flow NSOL

1.1.179. NSOL
Use this API to apply the decoupled Newton-Raphson power flow calculation.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_NSOL OPTIONS(1) OPTIONS(2) OPTIONS(3) OPTIONS(4) OPTIONS(5)

OPTIONS(6) OPTIONS(7)

Python command syntax:

ierr = nsol(options)

Fortran command syntax:

CALL NSOLAPI(OPTIONS, IERR)

Where:

Integer OPTIONS (7) array of 7 elements specifying solution options(input).

OPTIONS(1) tap adjustment flag (use tap adjustment op-
tion setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (use area
interchange adjustment option setting by de-
fault)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (use phase shift
adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (use dc tap adjust-
ment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (use
switched shunt adjustment option setting by
default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
399
Power Flow NSOL

OPTIONS(6) flat start flag (0 by default)

OPTIONS(6) = 0 do not flat start
OPTIONS(6) = 1 flat start
OPTIONS(6) = 2 flat start, then estimate voltage magnitudes
OPTIONS(6) = 3 flat start, then estimate voltage phase angles
OPTIONS(6) = 4 flat start, then estimate voltage magnitudes
and phase angles
OPTIONS(7) var limit flag (99 by default)
OPTIONS(7) = 0 apply var limits immediately
OPTIONS(7) > 0 apply var limits on iteration n (or sooner if
mismatch gets small)
OPTIONS(7) = -1 ignore var limits
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 generators are converted
IERR = 3 buses in island(s) without a swing bus; use
activity TREE
IERR = 4 bus type code and series element status in-
consistencies
IERR = 5 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
400
Power Flow NUMBER_THREADS

1.1.180. NUMBER_THREADS
Use this API to specify or return the number of processors available for parallel operations.

This API routine was first introduced in release 33.1.0.

Batch command syntax:

BAT_NUMBER_THREADS IVAL

Python command syntax:

ierr = number_threads(ival)

ierr, ival = number_threads()

Fortran command syntax:

CALL NUMBER_THREADS_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting between 1 and the number of processors
of the computer (input; if Batch command, or for Python if specified
as an argument, or for Fortran if IOCODE is 0, 1 by default; else out-
put).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
401
Power Flow ORDR

1.1.181. ORDR
Use this API to calculate a sparsity preserving ordering of buses in preparation for the processing of net-
work matrices.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_ORDR OPT

Python command syntax:

ierr = ordr(opt)

Fortran command syntax:

CALL ORDRAPI(OPT, IERR)

Where:

Integer OPT flag for ordering option (input; 0 by default).

OPT = 0 assume all branches between in-service buses
are in-service
OPT = 1 ignore out-of-service branches in calculating
the bus ordering
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPT value
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
402
Power Flow OTDF

1.1.182. OTDF
Use this API to tabulate vectors of distribution factors using a linear network (dc) model.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_OTDF DFXFILE

Python command syntax:

ierr = otdf(dfxfile)

Fortran command syntax:

CALL OTDFAPI(DFXFILE, IERR)

Where:

Character*260 DFXFILE name of DFAX data file (input; no default allowed).

Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no DFAX data file specified
IERR = 2 generators are converted
IERR = 3 buses in island(s) without a swing bus; use
activity TREE
IERR = 4 error opening file DFXFILE
IERR = 5 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 6 file DFXFILE does not contain distribution fac-
tors; run DFAX with distribution factor option
enabled
IERR = 7 no monitored branches or interfaces defined
IERR = 8 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
403
Power Flow OUTPUT_Y_MATRIX

1.1.183. OUTPUT_Y_MATRIX
Use this API to display the network admittance matrix for a subsystem of the working case in the form of a
list of matrix terms.

This API routine was first introduced in release 30.1.0.

Batch command syntax:

BAT_OUTPUT_Y_MATRIX SID ALL TIES OUT OFILE

Python command syntax:

ierr = output_y_matrix(sid, all, ties, out, ofile)

Fortran command syntax:

CALL OUTPUT_Y_MATRIX(SID, ALL, TIES, OUT, OFILE, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only rows corresponding to buses in
subsystem SID
ALL = 1 process the complete case
Integer TIES option for the omission or inclusion of off-diagonal terms corre-
sponding to ties from the specified subsystem; ignored if ALL is 1 (in-
put; 0 by default).
TIES = 0 omit ties
TIES = 1 include ties
Integer OUT destination selection (input; 1 by default).
OUT = 0 direct output to a data file specified by OFILE
OUT = 1 direct output to the current report device
Character*260 OFILE name of the file to which data records are to be written (when OUT is
0) (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid TIES value
IERR = 4 invalid OUT value
IERR = 5 error opening OFILE
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
404
Power Flow OUTS

1.1.184. OUTS
Use this API to tabulate those components in the working case that are removed from service.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_OUTS SID ALL

Python command syntax:

ierr = outs(sid, all)

Fortran command syntax:

CALL OUTSNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
405
Power Flow OWNM

1.1.185. OWNM
This API routine is obsolete. It has been replaced by the API routine ownm_2 .

Use this API routine to reassign the buses, load, machines, and branches in a specified subsystem of the
working case from their original owner to a designated owner.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_OWNM SID ALL STATUS(1)..STATUS(7) IONEW

Python command syntax:

ierr = ownm(sid, all, status, ionew)

Fortran command syntax:

CALL OWNMAPI(SID, ALL, STATUS, IONEW, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer STATUS (7) array of 7 elements specifying They are used to control reassignment
options(input).
STATUS(1) bus owners to IONEW (0 by default)
STATUS(1) = 0 leave bus ownership unchanged
STATUS(1) = 1 Change bus owners to IONEW
STATUS(2) load owners to IONEW (0 by default)
STATUS(2) = 0 leave load ownership unchanged
STATUS(2) = 1 change load owners to IONEW
STATUS(3) machine owners to IONEW (0 by default)
STATUS(3) = 0 leave machine ownership unchanged
STATUS(3) = 1 change machine owners to IONEW
STATUS(4) branch owners to IONEW (0 by default)
STATUS(4) = 0 leave branch ownership unchanged
STATUS(4) = 1 change branch owners to IONEW
STATUS(5) FACTS device owners to IONEW (0 by default)
STATUS(5) = 0 leave FACTS device ownership unchanged
STATUS(5) = 1 change FACTS device owners to IONEW
STATUS(6) VSC dc line owners to IONEW (0 by default)
STATUS(6) = 0 leave VSC dc line ownership unchanged

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
406
Power Flow OWNM

STATUS(6) = 1 change VSC dc line owners to IONEW

STATUS(7) branch, series FACTS device, VSC dc line op-
tion (1 by default)
STATUS(7) = 1 subsystem branches only
STATUS(7) = 2 subsystem ties only
STATUS(7) = 3 both subsystem branches and ties
Integer IONEW new owner to which the specified equipment items are to be as-
signed. IONEW must be between 1 and 9999 (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 invalid new owner number
IERR = 5 owner table is full; cannot add owner to the
working case
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
407
Power Flow OWNM_2

1.1.186. OWNM_2
This API routine is obsolete. It has been replaced by the API routine ownm_3 .

This API routine is the second release of the owner renumbering function. Use this API routine to reassign
the buses, loads, machines, branches, FACTS devices, VSC dc lines, and/or GNE devices in a specified sub-
system of the working case from their original owner to a designated owner.

This API routine was first introduced in release 32.0.2.

Batch command syntax:

BAT_OWNM_2 SID ALL STATUS(1)..STATUS(8) IONEW

Python command syntax:

ierr = ownm_2(sid, all, status, ionew)

Fortran command syntax:

CALL OWNMAPI_2(SID, ALL, STATUS, IONEW, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer STATUS (8) array of 8 elements specifying They are used to control reassignment
options(input).
STATUS(1) bus owners to IONEW (0 by default)
STATUS(1) = 0 leave bus ownership unchanged
STATUS(1) = 1 Change bus owners to IONEW
STATUS(2) load owners to IONEW (0 by default)
STATUS(2) = 0 leave load ownership unchanged
STATUS(2) = 1 change load owners to IONEW
STATUS(3) machine owners to IONEW (0 by default)
STATUS(3) = 0 leave machine ownership unchanged
STATUS(3) = 1 change machine owners to IONEW
STATUS(4) branch owners to IONEW (0 by default)
STATUS(4) = 0 leave branch ownership unchanged
STATUS(4) = 1 change branch owners to IONEW
STATUS(5) FACTS device owners to IONEW (0 by default)
STATUS(5) = 0 leave FACTS device ownership unchanged
STATUS(5) = 1 change FACTS device owners to IONEW
STATUS(6) VSC dc line owners to IONEW (0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
408
Power Flow OWNM_2

STATUS(6) = 0 leave VSC dc line ownership unchanged

STATUS(6) = 1 change VSC dc line owners to IONEW
STATUS(7) GNE device owners to IONEW (0 by default)
STATUS(7) = 0 leave GNE device ownership unchanged
STATUS(7) = 1 change GNE device owners to IONEW
STATUS(8) branch, series FACTS device, VSC dc line, and
series GNE device option (1 by default)
STATUS(8) = 1 subsystem branches only
STATUS(8) = 2 subsystem ties only
STATUS(8) = 3 both subsystem branches and ties
Integer IONEW new owner to which the specified equipment items are to be as-
signed. IONEW must be between 1 and 9999 (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 invalid new owner number
IERR = 5 owner table is full; cannot add owner to the
working case
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
409
Power Flow OWNM_3

1.1.187. OWNM_3
This API routine is the third release of the owner renumbering function. Use this API routine to reassign the
buses, loads, machines, induction machines, branches, FACTS devices, VSC dc lines, and/or GNE devices in
a specified subsystem of the working case from their original owner to a designated owner.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_OWNM_3 SID ALL STATUS(1)..STATUS(9) IONEW

Python command syntax:

ierr = ownm_3(sid, all, status, ionew)

Fortran command syntax:

CALL OWNM_3(SID, ALL, STATUS, IONEW, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer STATUS (9) array of 9 elements specifying They are used to control reassignment
options(input).
STATUS(1) bus owners to IONEW (0 by default)
STATUS(1) = 0 leave bus ownership unchanged
STATUS(1) = 1 change bus owners to IONEW
STATUS(2) load owners to IONEW (0 by default)
STATUS(2) = 0 leave load ownership unchanged
STATUS(2) = 1 change load owners to IONEW
STATUS(3) machine owners to IONEW (0 by default)
STATUS(3) = 0 leave machine ownership unchanged
STATUS(3) = 1 change machine owners to IONEW
STATUS(4) induction machine owners to IONEW (0 by
default)
STATUS(4) = 0 leave induction machine ownership un-
changed
STATUS(4) = 1 change induction machine owners to IONEW
STATUS(5) branch owners to IONEW (0 by default)
STATUS(5) = 0 leave branch ownership unchanged
STATUS(5) = 1 change branch owners to IONEW
STATUS(6) FACTS device owners to IONEW (0 by default)
STATUS(6) = 0 leave FACTS device ownership unchanged

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
410
Power Flow OWNM_3

STATUS(6) = 1 change FACTS device owners to IONEW

STATUS(7) VSC dc line owners to IONEW (0 by default)
STATUS(7) = 0 leave VSC dc line ownership unchanged
STATUS(7) = 1 change VSC dc line owners to IONEW
STATUS(8) GNE device owners to IONEW (0 by default)
STATUS(8) = 0 leave GNE device ownership unchanged
STATUS(8) = 1 change GNE device owners to IONEW
STATUS(9) branch, series FACTS device, VSC dc line, and
series GNE device option (1 by default)
STATUS(9) = 1 subsystem branches only
STATUS(9) = 2 subsystem ties only
STATUS(9) = 3 both subsystem branches and ties
Integer IONEW new owner to which the specified equipment items are to be as-
signed. IONEW must be between 1 and 9999 (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid STATUS value
IERR = 4 invalid new owner number
IERR = 5 owner table is full; cannot add owner to the
working case
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
411
Power Flow OWNR

1.1.188. OWNR
Use this API to tabulate owner totals by owner.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_OWNR SID ALL

Python command syntax:

ierr = ownr(sid, all)

Fortran command syntax:

CALL OWNRNW(SID, ALL, IERR)

Where:

Integer SID a valid owner subsystem identifier. Valid subsystem identifiers range
from 0 to 11. Owner subsystem SID must have been previously de-
fined (input; 0 by default).
Integer ALL all owners or specified subsystem flag (input; 1 by default).
ALL = 0 process only owners in owner subsystem SID
ALL = 1 process all owners
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
412
Power Flow PATH

1.1.189. PATH
Use this API to specify a directory pathname. Then, whenever
a simple filename preceded by an ampersand (for example, &myfile) is specified as input to a PSSE API,
the file is opened in the directory specified rather than in the user's current directory.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_PATH PATHNAME

Python command syntax:

ierr = path(pathname)

Fortran command syntax:

CALL PATHAPI(PATHNAME, IERR)

Where:

Character*260 PATHNAME name of path to be used (blank to disable) (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 error setting path PATHNAME
IERR = 2 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
413
Power Flow PHASE_SHIFT_ADJUSTMENT

1.1.190. PHASE_SHIFT_ADJUSTMENT
Use this API to specify or return the option to enable or disable the phase shift adjustment.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_PHASE_SHIFT_ADJUSTMENT IVAL

Python command syntax:

ierr = phase_shift_adjustment(ival)

ierr, ival = phase_shift_adjustment()

Fortran command syntax:

CALL PHASE_SHIFT_ADJUSTMENT_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 disabled.
IVAL = 1 enabled.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
414
Power Flow POLY

1.1.191. POLY
Use this API to calculate interchange limits of a study system against two opposing systems using a linear
network (dc) model.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_POLY OPTIONS(1)..OPTIONS(15) VALUES(1)..VALUES(6)

LABELS(1)..LABELS(3) DFXFILE RESFILE

Python command syntax:

ierr = poly(options, values, labels, dfxfile, resfile)

Fortran command syntax:

CALL POLYAPI(OPTIONS, VALUES, LABELS, DFXFILE, RESFILE, IERR)

Where:
Integer OPTIONS (15) array of 15 elements specifying calculation and reporting
options(input).
OPTIONS(1) base case rating set (rating set program op-
tion setting by default)
OPTIONS(1) = 1 RATEA
OPTIONS(1) = 2 RATEB
OPTIONS(1) = 3 RATEC
OPTIONS(2) contingency case rating set (rating set pro-
gram option setting by default)
OPTIONS(2) = 1 RATEA
OPTIONS(2) = 2 RATEB
OPTIONS(2) = 3 RATEC
OPTIONS(3) base case line flow code (0 by default)
OPTIONS(3) = 0 dc base case
OPTIONS(3) = 1 ac base case
OPTIONS(4) phase shifter code (0 by default)
OPTIONS(4) = 0 locked in base case shift solutions
OPTIONS(4) = 1 regulating in base case shift solutions
OPTIONS(5) code for the treatment of base case line flow
constraints in contingency cases (0 by de-
fault)
OPTIONS(5) = 0 ignore
OPTIONS(5) = 1 include
OPTIONS(6) list study system buses (0 by default)
OPTIONS(6) = 0 no
OPTIONS(6) = 1 yes
OPTIONS(7) list opposing system buses (0 by default)
OPTIONS(7) = 0 no

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
415
Power Flow POLY

OPTIONS(7) = 1 yes
OPTIONS(8) list study system tie lines (0 by default)
OPTIONS(8) = 0 no
OPTIONS(8) = 1 yes
OPTIONS(9) add study system tie lines to monitored line
list (0 by default)
OPTIONS(9) = 0 no
OPTIONS(9) = 1 yes
OPTIONS(10) format code (0 by default)
OPTIONS(10) = 0 summary output
OPTIONS(10) = 1 full output
OPTIONS(11) convert MVA ratings to estimated MW ratings
(0 by default)
OPTIONS(11) = 0 no
OPTIONS(11) = 1 yes
OPTIONS(12) discontinue activity if MW mismatch exceeds
VALUES(1) (0 by default)
OPTIONS(12) = 0 discontinue
OPTIONS(12) = 1 continue
OPTIONS(13) graphical option (0 by default)
OPTIONS(13) = 0 plot combined case only
OPTIONS(13) = 1 plot combined case only
OPTIONS(13) = 2 plot for all system conditions
OPTIONS(14) option for plotting constraints (0 by default)
OPTIONS(14) = 0 plot all constraints
OPTIONS(14) = 1 plot only constraints forming the boundary
of the feasible region
OPTIONS(15) graphical format (0 by default)
OPTIONS(15) = 0 single page per case
OPTIONS(15) = 1 two pages per case
Real VALUES (6) array of 6 elements specifying tolerances and thresholds(input).
VALUES(1) required MW mismatch tolerance for contin-
uing (Newton solution convergence toler-
ance, TOLN by default)
VALUES(2) percent of rating for reporting an element as
overloaded (100.0 by default)
VALUES(3) maximum opposing system generation shift
(10000.0 by default)
VALUES(4) maximum opposing system delta inter-
change for plotting (1000.0 by default)
VALUES(5) minimum distribution factor magnitude (0.0
by default)
VALUES(6) study system generation shift (100.0 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
416
Power Flow POLY

Character*32 LABELS (3) array of 3 elements specifying subsystem labels(input).

LABELS(1) study system label (no default allowed)
LABELS(2) first opposing system label (no default al-
lowed)
LABELS(3) second opposing system label (no default al-
lowed)
Character*260 DFXFILE name of DFAX data file (input; no default allowed).
Character*260 RESFILE name of POLY results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 no Distribution Factor Data File specified
IERR = 4 same label specified for at least two subsys-
tems
IERR = 5 no POLY Results Output File specified
IERR = 6 generators are converted
IERR = 7 buses in island(s) without a swing bus; use
activity TREE
IERR = 8 largest mismatch exceeds mismatch toler-
ance
IERR = 9 error opening file DFXFILE
IERR = 10 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 11 file DFXFILE does not contain distribution fac-
tors; run DFAX with distribution factor option
enabled
IERR = 12 no monitored branches or interfaces defined
IERR = 13 no subsystems defined
IERR = 14 subsystem not found
IERR = 15 specified subsystems overlap
IERR = 16 no in-service buses in subsystem WORLD
IERR = 17 no tie lines from study system
IERR = 18 only one subsystem defined
IERR = 19 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
417
Power Flow POUT

1.1.192. POUT
Use this API to print the power flow solution results with boundary condition and flow information on the
left side of the report and other information on the right side.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_POUT SID ALL

Python command syntax:

ierr = pout(sid, all)

Fortran command syntax:

CALL POUTNW(SID, ALL, IERR)

Where:

Integer SID a valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ALL all buses or specified subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
418
Power Flow POWER_OUTPUT

1.1.193. POWER_OUTPUT
Use this API to specify or return the option to display power output in either MVA or kVA.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_POWER_OUTPUT IVAL

Python command syntax:

ierr = power_output(ival)

ierr, ival = power_output()

Fortran command syntax:

CALL POWER_OUTPUT_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 1 by default;
else output).
IVAL = 0 kVA.
IVAL = 1 MVA.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
419
Power Flow PP_ACCC

1.1.194. PP_ACCC
Use this API to report the results of the AC contingency calculation function.

This API routine was first introduced in release 28.0.0.

Batch command syntax:

BAT_PP_ACCC OPTIONS(1)..OPTIONS(5) INTVAL(1)..INTVAL(5)

REALVAL(1)..REALVAL(6) ACCFILE

Python command syntax:

ierr = pp_accc(options, intval, realval, accfile)

Fortran command syntax:

CALL PP_ACCC(OPTIONS, INTVAL, REALVAL, ACCFILE, IERR)

Where:

Integer OPTIONS (5) array of 5 elements specifying reporting options(input).

OPTIONS(1) contingency case rating (rating set program
option setting by default)
OPTIONS(1) = 0 RATEA
OPTIONS(1) = 1 RATEB
OPTIONS(1) = 2 RATEC
OPTIONS(2) report format (3 by default)
OPTIONS(2) = 0 spreadsheet overload report
OPTIONS(2) = 1 spreadsheet loading table
OPTIONS(2) = 2 available capacity table
OPTIONS(2) = 3 non-spreadsheet overload report
OPTIONS(2) = 4 non-spreadsheet loading table
OPTIONS(2) = 5 non-converged networks report
OPTIONS(3) exclude interfaces from report (0 by default)
OPTIONS(3) = 0 no
OPTIONS(3) = 1 yes
OPTIONS(4) run voltage limit check (0 by default)
OPTIONS(4) = 0 no
OPTIONS(4) = 1 yes
OPTIONS(5) exclude cases with no overloads from non-
spreadsheet overload report (0 by default)
OPTIONS(5) = 0 no
OPTIONS(5) = 1 yes
Integer INTVAL (5) array of 5 elements specifying integer reporting parameters(input).
INTVAL(1) number of low voltage range violations (0 by
default)
INTVAL(2) number of high voltage range violations (0
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
420
Power Flow PP_ACCC

INTVAL(3) number of voltage deviation violations (0 by

default)
INTVAL(4) number of buses in the largest disconnected
island (0 by default)
INTVAL(5) maximum number of elements in available
capacity table (no limit by default)
Real REALVAL (6) array of 6 elements specifying real reporting parameters(input).
REALVAL(1) percent of flow rating (100.0 by default)
REALVAL(2) minimum contingency case flow change for
overload report (0.0 by default)
REALVAL(3) cutoff threshold for available capacity table
(99999.0 by default)
REALVAL(4) minimum contingency case voltage change
for range violations (0.0 by default)
REALVAL(5) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
REALVAL(6) system mismatch converged tolerance (MVA)
(5.0 by default)
Character*260 ACCFILE name of the contingency solution output file (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid INTVAL value
IERR = 3 invalid REALVAL value
IERR = 4 error opening RFILE
IERR = 5 error reading RFILE
IERR = 6 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
421
Power Flow PP_ACCC_MULTI_CASE

1.1.195. PP_ACCC_MULTI_CASE
This API routine is obsolete. It has been replaced by the API routine accc_multiple_run_report .

Use this API to report the results of up to nine executions of the AC contingency calculation function.

This API routine was first introduced in release 30.2.0.

Batch command syntax:

BAT_PP_ACCC_MULTI_CASE OPTIONS(1)..OPTIONS(11) VALUES(1)..VALUES(6)

NFILES ACCFILES(1)..ACCFILES(NFILES)

Python command syntax:

ierr = pp_accc_multi_case(options, values, nfiles, accfiles)

Fortran command syntax:

CALL PP_ACCC_MULTI_CASE(OPTIONS, VALUES, NFILES, ACCFILES, IERR)

Where:

Integer OPTIONS (11) array of 11 elements specifying reporting options(input).

OPTIONS(1) column headings code (1 by default)
OPTIONS(1) = 1 contingency solution output file names
OPTIONS(1) = 2 saved case file names as contained in the
contingency solution output files
OPTIONS(2) rating set (rating set program option setting
by default)
OPTIONS(2) = 1 RateA
OPTIONS(2) = 2 RateB
OPTIONS(2) = 3 RateC
OPTIONS(3) print monitored elements summary report (0
by default)
OPTIONS(3) = 0 no
OPTIONS(3) = 1 yes
OPTIONS(4) print missing monitored elements report (0
by default)
OPTIONS(4) = 0 no
OPTIONS(4) = 1 yes
OPTIONS(5) print missing monitored voltage buses report
(0 by default)
OPTIONS(5) = 0 no
OPTIONS(5) = 1 yes
OPTIONS(6) print contingency legend (2 by default)
OPTIONS(6) = 0 no
OPTIONS(6) = 1 complete master legend report only
OPTIONS(6) = 2 reduced legend with each table

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
422
Power Flow PP_ACCC_MULTI_CASE

OPTIONS(6) = 3 both master legend report and legend with

each table
OPTIONS(7) print missing contingencies report (0 by de-
fault)
OPTIONS(7) = 0 no
OPTIONS(7) = 1 yes
OPTIONS(8) print non-converged contingencies report (0
by default)
OPTIONS(8) = 0 no
OPTIONS(8) = 1 yes
OPTIONS(9) print loading violation reports (0 by default)
OPTIONS(9) = 0 no
OPTIONS(9) = 1 base case and worst case contingency viola-
tions only
OPTIONS(9) = 2 base case and all contingency violations only
OPTIONS(9) = 3 base case, worst case contingency, and all
contingency violations
OPTIONS(10) print voltage violation reports (0 by default)
OPTIONS(10) = 0 no
OPTIONS(10) = 1 base case and worst case contingency viola-
tions only
OPTIONS(10) = 2 base case and all contingency violations only
OPTIONS(10) = 3 base case, worst case contingency, and all
contingency violations
OPTIONS(11) option for processing interfaces in loading vi-
olation reports (1 by default)
OPTIONS(11) = 0 exclude interfaces from loading violation
checking and reporting
OPTIONS(11) = 1 check and report interface loading violations
Real VALUES (6) array of 6 elements specifying integer reporting parameters(input).
VALUES(1) percent of flow rating for reporting (100.0 by
default)
VALUES(2) percent of flow rating for counting in worst
case contingency violations report (> VAL-
UES(1)) (100.0 by default)
VALUES(3) minimum contingency case flow change for
reporting and counting (0.0 by default)
VALUES(4) minimum contingency case voltage change
for reporting and counting in voltage range
violations (0.0 by default)
VALUES(5) bus mismatch converged tolerance (MW or
Mvar) (0.5 by default)
VALUES(6) system mismatch converged tolerance (MVA)
(5.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
423
Power Flow PP_ACCC_MULTI_CASE

Integer NFILES number of contingency solution output files to be processed (1

through 9) (input; no default allowed).
Character*260 ACCFILES (NFILES) NFILES names of contingency solution output files (input; no default
allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 invalid NFILES value
IERR = 4 the percent for counting is less than the per-
cent for reporting
IERR = 5 file is not in the form of a current contingency
solution output file
IERR = 6 error opening a contingency solution output
file
IERR = 7 error reading a contingency solution output
file
IERR = 8 error opening a temporary file
IERR = 9 error opening a subfile in the temporary file
IERR = 10 error reading or writing the temporary file
IERR = 11 error closing a subfile in the temporary file
IERR = 12 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
424
Power Flow PRINT_OUTAGED_BRANCHES

1.1.196. PRINT_OUTAGED_BRANCHES
Use this API to specify or return the option to enable or disable whether to print out-of-service branches.

This API routine was first introduced in release 31.0.0.

Batch command syntax:

BAT_PRINT_OUTAGED_BRANCHES IVAL

Python command syntax:

ierr = print_outaged_branches(ival)

ierr, ival = print_outaged_branches()

Fortran command syntax:

CALL PRINT_OUTAGED_BRANCHES_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 do not print out-of-service branches.
IVAL = 1 print out-of-service branches.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
425
Power Flow PRINT_WINDING_BUSES

1.1.197. PRINT_WINDING_BUSES
Use this API to specify or return the option to enable or disable whether to print winding "to" buses of
three-winding transformers.

This API routine was first introduced in release 31.0.0.

Batch command syntax:

BAT_PRINT_WINDING_BUSES IVAL

Python command syntax:

ierr = print_winding_buses(ival)

ierr, ival = print_winding_buses()

Fortran command syntax:

CALL PRINT_WINDING_BUSES_API(IVAL, IOCODE, IERR)

Where:

Integer IVAL value of the option setting (input; if Batch command, or for Python if
specified as an argument, or for Fortran if IOCODE is 0, 0 by default;
else output).
IVAL = 0 do not print winding "to" buses.
IVAL = 1 print winding "to" buses.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to the value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL value
IERR = 2 invalid IOCODE value
IERR = 3 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
426
Power Flow PROGRESS_OUTPUT

1.1.198. PROGRESS_OUTPUT
Use this API to specify the progress output device.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_PROGRESS_OUTPUT ISLCT FILARG OPTIONS(1) OPTIONS(2)

Python command syntax:

ierr = progress_output(islct, filarg, options)

Fortran command syntax:

CALL OPENPROGRESSDEVICE(ISLCT, FILARG, OPTIONS, IERR)

Where:

Integer ISLCT virtual device selector (input).

ISLCT = 1 standard destination. In the PSSE GUI stan-
dard output for progress is the Progress tab of
the output bar.
ISLCT = 2 direct output to a file.
ISLCT = 3 direct output to a printer.
ISLCT = 4 direct output to progress device.
ISLCT = 5 direct output to report device.
ISLCT = 6 no output.
Character*260 FILARG printer name or filename; ignored if ISLCT is not 2 or 3 (input).
Integer OPTIONS (2) array of 2 elements specifying open and printing options; ignored if
ISLCT is not 2 or 3(input).
OPTIONS(1) file and printer open options: The OP-
TIONS(1) values may be summed to select
multiple options
OPTIONS(1) = 0 open with carriage control format and, for
files, for overwrite of existing files
OPTIONS(1) = 1 open with list format
OPTIONS(1) = 2 open file for append (file output only)
OPTIONS(1) = 2 set printer orientation to portrait mode
(printer output only)
OPTIONS(1) = 4 open printer in immediate print mode (print-
er output only)
OPTIONS(2) number of copies to print (printer only)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = 2 failed to open device

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
427
Power Flow PROMPT_OUTPUT

1.1.199. PROMPT_OUTPUT
Use this API to specify the prompt output device.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_PROMPT_OUTPUT ISLCT FILARG OPTIONS(1) OPTIONS(2)

Python command syntax:

ierr = prompt_output(islct, filarg, options)

Fortran command syntax:

CALL OPENPROMPTDEVICE(ISLCT, FILARG, OPTIONS, IERR)

Where:

Integer ISLCT virtual device selector (input).

ISLCT = 1 standard destination. In the PSSE GUI stan-
dard output for prompts is the input window
generated by user input requests.
ISLCT = 2 direct output to a file.
ISLCT = 3 direct output to a printer.
ISLCT = 4 direct output to progress device.
ISLCT = 5 direct output to report device.
ISLCT = 6 no output.
Character*260 FILARG printer name or filename; ignored if ISLCT is not 2 or 3 (input).
Integer OPTIONS (2) array of 2 elements specifying open and printing options; ignored if
ISLCT is not 2 or 3(input).
OPTIONS(1) file and printer open options: The OP-
TIONS(1) values may be summed to select
multiple options
OPTIONS(1) = 0 open with carriage control format and, for
files, for overwrite of existing files
OPTIONS(1) = 1 open with list format
OPTIONS(1) = 2 open file for append (file output only)
OPTIONS(1) = 2 set printer orientation to portrait mode
(printer output only)
OPTIONS(1) = 4 open printer in immediate print mode (print-
er output only)
OPTIONS(2) number of copies to print (printer only)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = 2 failed to open device

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
428
Power Flow PRTI

1.1.200. PRTI
Use this API to print the 16 line long title.

This API routine was first introduced in release 29.0.0.

Batch command syntax:

BAT_PRTI

Python command syntax:

ierr = prti()

Fortran command syntax:

CALL PRTIAPI(IERR)

Where:

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
429
Power Flow PSCOPF

1.1.201. PSCOPF
This API routine is obsolete. It has been replaced by the API routine pscopf_2 .

This API is used to find the settings of controls for a system to comply with base case and contingency case
operation limits. The API is implemented with preventive security constrained optimal power flow method
(PSCOPF). The objective of the PSCOPF is to minimize control adjustments subject to operation limits con-
straints. The available controls are generation MW outputs of on-line and off-line generators, loads, phase
shifters, tap settings and switched shunts.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_PSCOPF OPTIONS(1)..OPTIONS(26) VALUES(1)..VALUES(11)

LABELS(1)..LABELS(7) DFXFILE INLFILE THRFILE

Python command syntax:

ierr = pscopf(options,values,labels,dfxfile,inlfile,thrfile)

Fortran command syntax:

CALL PSCOPFAPI(OPTIONS,VALUES, LABELS,DFXFILE,INLFILE,THRFILE,IERR)

Where:
Integer OPTIONS (26) array of 26 elements specifying integer specifying power flow
options(input).
OPTIONS(1) tap adjustment flag for the base case (tap ad-
justment option setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the
base case (area interchange adjustment op-
tion setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag for the base case
(phase shift adjustment option setting by de-
fault)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the base case (dc
tap adjustment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
430
Power Flow PSCOPF

OPTIONS(5) switched shunt adjustment flag for the base

case (switched shunt adjustment option set-
ting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete
OPTIONS(6) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable stepping adjustment
OPTIONS(9) = 2 enable direct adjustment
OPTIONS(10) area interchange adjustment flag for the con-
tingency case (area interchange adjustment
option setting by default)
OPTIONS(10) = 0 disable
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(11) phase shift adjustment flag for the contin-
gency case (phase shift adjustment option
setting by default)
OPTIONS(11) = 0 disable
OPTIONS(11) = 1 enable
OPTIONS(12) dc tap adjustment flag for the contingency
case (dc tap adjustment option setting by de-
fault)
OPTIONS(12) = 0 disable
OPTIONS(12) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
431
Power Flow PSCOPF

OPTIONS(13) switched shunt adjustment flag for the con-

tingency case (switched shunt adjustment
option setting by default)
OPTIONS(13) = 0 disable
OPTIONS(13) = 1 enable
OPTIONS(13) = 2 enable continuous, disable discrete
OPTIONS(14) induction motor treatment flag for the con-
tingency case (applied when an induction
motor fails to solve due to low terminal bus
voltage, 0 by default)
OPTIONS(14) = 0 stall
OPTIONS(14) = 1 trip
OPTIONS(15) dispatch mode (0 by default)
OPTIONS(15) = 0 disable
OPTIONS(15) = 1 subsystem machines (RESERVE)
OPTIONS(15) = 2 subsystem machines (PMAX)
OPTIONS(15) = 3 subsystem machines (INERTIA)
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP)
OPTIONS(16) Rating set for the base case
OPTIONS(16) = 1 RATE A
OPTIONS(16) = 2 RATE B
OPTIONS(16) = 3 RATE C
OPTIONS(17) Rating set for the contingency case
OPTIONS(17) = 1 RATE A
OPTIONS(17) = 2 RATE B
OPTIONS(17) = 3 RATE C
OPTIONS(18) maximum iteration number of PSCOPF
OPTIONS(18) = 1 RATE A
OPTIONS(18) = 2 RATE B
OPTIONS(18) = 3 RATE C
OPTIONS(19) maximum number of a contingency that
does not cause limit violations and instability
issue to be tested in the iterative process of
PSCOPF
OPTIONS(20) Handle initial violations in the base case
OPTIONS(20) = 0 Ignore the initial violations in the base case
from the PSCOPF analysis
OPTIONS(20) = 1 Clean the initial violations in the base case
OPTIONS(21) generator control flag (1 by default)
OPTIONS(21) = 0 disable generation MW dispatch
OPTIONS(21) = 1 enable
OPTIONS(22) load control flag (0 by default)
OPTIONS(22) = 0 disable load shedding control
OPTIONS(22) = 1 enable
OPTIONS(23) phase shifter control flag (1 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
432
Power Flow PSCOPF

OPTIONS(23) = 0 disable phase shifter control

OPTIONS(23) = 1 enable
OPTIONS(24) off-line generator control flag (0 by default)
OPTIONS(24) = 0 disable generation MW dispatch of off-line
generators
OPTIONS(24) = 1 enable
OPTIONS(25) tap setting adjustment flag (0 by default)
OPTIONS(25) = 0 disable tap setting adjustment
OPTIONS(25) = 1 enable
OPTIONS(26) switched shunt control flag (0 by default)
OPTIONS(26) = 0 disable switch shunt control
OPTIONS(26) = 1 enable
Real VALUES (11) array of 11 elements specifying VALUES Is a real(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Percentage of rating for the base case (100.0
by default)
VALUES(3) Percentage of rating for the contingency cas-
es (100.0 by default)
VALUES(4) Voltage tolerance in linear programming
VALUES(5) Flow tolerance in linear programming
VALUES(6) Weighting factor of generation MW dispatch
(1.0 by default)
VALUES(7) Weighting factor of load control (1.0 by de-
fault)
VALUES(8) Weighting factor of phase shifter control (1.0
by default)
VALUES(9) Weighting factor of generation MW dispatch
of off-line generators (1.0 by default)
VALUES(10) Weighting factor of tap setting adjustment
(1.0 by default)
VALUES(11) Weighting factor of switched shunt control
(1.0 by default)
Character*32 LABELS (7) array of 7 elements specifying a character(input).
LABELS(1) label of generation dispatch system, required
if the dispatch mode of OPTIONS(15) is not
zero. The dispatch mode and the system pro-
vide for a default dispatch method for contin-
gencies causing unbalance between load de-
mand and generation (blank for none by de-
fault)
LABELS(2) label of generation dispatch control system.
MW injections of the generators within the
system are available for dispatch in the cor-
rective action mode or preventive security
constrained optimal power flow mode (blank
for none by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
433
Power Flow PSCOPF

LABELS(3) label of load control system. Loads in the

load control system are available for curtail-
ment in the corrective action mode or pre-
ventive security constrained optimal power
flow mode (blank for none by default)
LABELS(4) label of phase shifter adjustment system. The
phase angles of phase shifters in the system
are regulated either by corrective action or
preventive security constrained optimal pow-
er flow (blank for none by default)
LABELS(5) label of generation MW control of off-line
generator control system. MW injections of
the off-line generators within the system are
available for dispatch in the corrective action
mode or preventive security constrained opti-
mal power flow mode (blank for none by de-
fault)
LABELS(6) label of tap adjustment system. The tap posi-
tions of transformers in voltage control mode
are regulated either by corrective action or
preventive security constrained optimal pow-
er flow (blank for none by default)
LABELS(7) label of switched shunt control system. The
admittances of switched shunts in voltage
control mode are regulated either by correc-
tive action or preventive security constrained
optimal power flow (blank for none by de-
fault)
Character*260 DFXFILE name of the Distribution Factor Data File (input; no default allowed).
Character*260 INLFILE name of Unit Inertia Data File (input; blank for none).
Character*260 THRFILE name of Load Throwover Data File (input; blank for none).
Integer IERR error code (output).
IERR = -2 PSCOPF terminates with active constraints
IERR = -1 PSCOPF reaches the maximum iteration
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Generators are converted
IERR = 4 Buses in island(s) without a swing bus--use
activity TREE
IERR = 5 Largest mismatch exceeds tolerance
IERR = 6 Generation subsystem not specified
IERR = 7 Too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
434
Power Flow PSCOPF

IERR = 9 buses with bus type code and series element

status inconsistencies
IERR = 10 No Distribution Factor Data input file speci-
fied
IERR = 11 No controls are specified
IERR = 12 No constraints are specified
IERR = 13 Invalid base/contingency case flag combina-
tion
IERR = 21 File is not in the form of a PSSE-25 or later
DFAX file--run DFAX
IERR = 22 Monitored elements exceed limit when
adding multi-section line members
IERR = 51 Error opening distribution factor data file
IERR = 52 Error opening load throwover data file
IERR = 53 Error opening inertia data file
IERR = 54 Prerequisite requirements for function not
met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
435
Power Flow PSCOPF_2

1.1.202. PSCOPF_2
This API is the second release of Preventive Security Constrained Optimal Power Flow solution (PSCOPF).
This API is used to find the settings of controls for a system to comply with base case and contingency case
operation limits. The API is implemented with preventive security constrained optimal power flow method
(PSCOPF). The objective of the PSCOPF is to minimize control adjustments subject to operation limits con-
straints. The available controls are generation MW outputs of on-line and off-line generators, loads, phase
shifters, tap settings and switched shunts.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_PSCOPF_2 OPTIONS(1)..OPTIONS(28) VALUES(1)..VALUES(11)

LABELS(1)..LABELS(7) DFXFILE INLFILE THRFILE

Python command syntax:

ierr = pscopf_2(options, values, labels, dfxfile, inlfile, thrfile)

Fortran command syntax:

CALL PSCOPFAPI_2(OPTIONS, VALUES, LABELS, DFXFILE, INLFILE, THRFILE, IERR)

Where:

Integer OPTIONS (28) array of elements specifying power flow options(input).

OPTIONS(1) tap adjustment flag for the base case (tap ad-
justment option by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag for the
base case (area interchange adjustment op-
tion setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange.
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag for the base case
(phase shift adjustment option setting by de-
fault)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag for the base case (dc
tap adjustment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
436
Power Flow PSCOPF_2

OPTIONS(5) switched shunt adjustment flag for the base

case (switched shunt adjustment option set-
ting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable all
OPTIONS(5) = 2 enable continuous, disable discrete.
OPTIONS(6) induction motor treatment flag (applied
when an induction motor fails to solve due to
low terminal bus voltage, 0 by default)
OPTIONS(6) = 0 stall.
OPTIONS(6) = 1 trip.
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 Fixed slope decoupled Newton-Raphson
method
OPTIONS(7) = 1 Full Newton-Raphson method
OPTIONS(7) = 2 Optimized fixed slope decoupled New-
ton-Raphson method
OPTIONS(8) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(8) = 0 Disable
OPTIONS(8) = 1 Enable
OPTIONS(9) tap adjustment flag for the first N-1 contin-
gency (tap adjustment option setting by de-
fault)
OPTIONS(9) = 0 disable.
OPTIONS(9) = 1 enable stepping adjustment.
OPTIONS(9) = 2 enable direct adjustment.
OPTIONS(10) area interchange adjustment flag for the con-
tingency case (area interchange adjustment
option setting by default)
OPTIONS(10) = 0 disable.
OPTIONS(10) = 1 enable using tie line flows only in calculating
area interchange.
OPTIONS(10) = 2 enable using tie line flows and loads in calcu-
lating area interchange.
OPTIONS(11) phase shift adjustment flag for the contin-
gency case (phase shift adjustment option
setting by default)
OPTIONS(11) = 0 disable.
OPTIONS(11) = 1 enable.
OPTIONS(12) dc tap adjustment flag for the contingency
case (dc tap adjustment option setting by de-
fault)
OPTIONS(12) = 0 disable.
OPTIONS(12) = 1 enable.

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
437
Power Flow PSCOPF_2

OPTIONS(13) switched shunt adjustment flag for the con-

tingency case (switched shunt adjustment
option setting by default)
OPTIONS(13) = 0 disable.
OPTIONS(13) = 1 enable.
OPTIONS(13) = 2 enable continuous, disable discrete.
OPTIONS(14) induction motor treatment flag for the con-
tingency case(applied when an induction
motor fails to solve due to low terminal bus
voltage) (0 by default)
OPTIONS(14) = 0 stall.
OPTIONS(14) = 1 trip.
OPTIONS(15) dispatch mode (0 by default)
OPTIONS(15) = 0 disable.
OPTIONS(15) = 1 subsystem machines (RESERVE).
OPTIONS(15) = 2 subsystem machines (PMAX).
OPTIONS(15) = 3 subsystem machines (INERTIA).
OPTIONS(15) = 4 subsystem machines (GOVERNOR DROOP).
OPTIONS(16) Rating set for the base case
OPTIONS(16) = 1 rate A
OPTIONS(16) = 2 rate B
OPTIONS(16) = 3 rate C
OPTIONS(17) Rating set for the contingency case
OPTIONS(17) = 1 rate A
OPTIONS(17) = 2 rate B
OPTIONS(17) = 3 rate C
OPTIONS(18) base case voltage limit
OPTIONS(18) = 1 normal
OPTIONS(18) = 2 emergency
OPTIONS(19) contingency case voltage limit
OPTIONS(19) = 1 normal
OPTIONS(19) = 2 emergency
OPTIONS(20) maximum iteration number of PSCOPF
OPTIONS(21) maximum number of a contingency that
does not cause limit violations and instability
issue to be tested in the iterative process of
PSCOPF
OPTIONS(22) Handle initial violations in the base case
OPTIONS(22) = 0 Ignore the initial violations in the base case
from the PSCOPF analysis
OPTIONS(22) = 1 Clean the initial violations in the base case
OPTIONS(23) generator control flag (1 by default)
OPTIONS(23) = 0 disable generation MW dispatch
OPTIONS(23) = 1 enable
OPTIONS(24) load control flag (0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
438
Power Flow PSCOPF_2

OPTIONS(24) = 0 disable load shedding control

OPTIONS(24) = 1 enable
OPTIONS(25) phase shifter control flag (1 by default)
OPTIONS(25) = 0 disable phase shifter control
OPTIONS(25) = 1 enable
OPTIONS(26) off-line generator control flag (0 by default)
OPTIONS(26) = 0 disable generation MW dispatch of off-line
generators
OPTIONS(26) = 1 enable
OPTIONS(27) tap setting adjustment flag (0 by default)
OPTIONS(27) = 0 disable tap setting adjustment
OPTIONS(27) = 1 enable
OPTIONS(28) switched shunt control flag (0 by default)
OPTIONS(28) = 0 disable switch shunt control
OPTIONS(28) = 1 enable
Real VALUES (11) array of elements specifying power flow options(input).
VALUES(1) Mismatch tolerance (TOLN by default)
VALUES(2) Percentage of rating for the base case (100.0
by default)
VALUES(3) Percentage of rating for the contingency cas-
es (100.0 by default)
VALUES(4) Voltage tolerance in linear programming
VALUES(5) Flow tolerance in linear programming
VALUES(6) Weighting factor of generation MW dispatch
(1.0 by default)
VALUES(7) Weighting factor of load control (1.0 by de-
fault)
VALUES(8) Weighting factor of phase shifter control (1.0
by default)
VALUES(9) Weighting factor of generation MW dispatch
of off-line generators (1.0 by default)
VALUES(10) Weighting factor of tap setting adjustment
(1.0 by default)
VALUES(11) Weighting factor of switched shunt control
(1.0 by default)
Character*32 LABELS (7) array of elements specifying labels(input).
LABELS(1) The label of generation dispatch system, re-
quired if the dispatch mode of OPTIONS(15)
is not zero. The dispatch mode and the sys-
tem provide for a default dispatch method
for contingencies causing unbalance be-
tween load demand and generation output
(blank for none).
LABELS(2) The label of generation dispatch control sys-
tem. MW injections of the generators within

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
439
Power Flow PSCOPF_2

the system are available for dispatch in the

corrective action mode or preventive security
constrained optimal power flow mode (blank
for none).
LABELS(3) The label of load control system. Loads in the
load control system are available for curtail-
ment in the corrective action mode or pre-
ventive security constrained optimal power
flow mode (blank for none).
LABELS(4) The label of phase shifter adjustment system.
The phase angles of phase shifters in the sys-
tem are regulated either by corrective action
or preventive security constrained optimal
power flow (blank for none).
LABELS(5) The label of generation MW control of off-
line generator control system. MW injections
of the off-line generators within the system
are available for dispatch in the corrective ac-
tion mode or preventive security constrained
optimal power flow mode (blank for none).
LABELS(6) The label of tap adjustment system. The tap
positions of transformers in voltage control
mode are regulated either by corrective ac-
tion or preventive security constrained opti-
mal power flow (blank for none).
LABELS(7) The label of switched shunt control sys-
tem. The admittances of switched shunts in
voltage control mode are regulated either
by corrective action or preventive security
constrained optimal power flow (blank for
none).
Character*260 DFXFILE Is the name of the Distribution Factor Data File (input; no default al-
lowed).
Character*260 INLFILE Is the name of Load Throwover Data File (input, blank for none). (in-
put).
Character*260 THRFILE Is the name of Unit Inertia Data File (input, blank for none). (input).
Integer IERR error code (output).
IERR = -2 PSCOPF terminates with active constraints
IERR = -1 PSCOPF reaches the maximum iteration
IERR = 0 No error
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
440
Power Flow PSCOPF_2

IERR = 6 Generation subsystem not specified

IERR = 7 too many islands in base case
IERR = 8 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 9 buses with bus type code and series element
status inconsistencies
IERR = 10 no Distribution Factor Data File specified
IERR = 11 No controls are specified
IERR = 12 No constraints are specified
IERR = 13 Invalid base/contingency case flag combina-
tion.
IERR = 21 file DFXFILE is not in the form of a PSSE 25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening Distribution Factor Data File
IERR = 52 error opening Load Throwover Data File
IERR = 53 error opening Unit Inertia and Governor Data
File
IERR = 54 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
441
Power Flow PSEB

1.1.203. PSEB
Use this API to convert a PSEB command file into a PSSE response file.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_PSEB INPFILE OUTFILE

Python command syntax:

ierr, respfil = pseb(inpfile, outfile)

Fortran command syntax:

CALL PSEBAPI(INPFILE, OUTFILE, RESPFIL, IERR)

Where:

Character*260 INPFILE name of the PSEB command file (input; no default allowed).
Character*260 OUTFILE name of response file; blank to have PSEB assign the filename (input;
blank by default).
Character*260 RESPFIL pathname of the response file constructed by PSEB (output).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 error opening INPFILE
IERR = 2 error opening OUTFILE
IERR = 3 errors detected while reading the PSEB Com-
mand Data input file
IERR = 4 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
442
Power Flow PSSEHALT

1.1.204. PSSEHALT
This API routine is obsolete. It has been replaced by the API routine pssehalt_2 .

Use this API to end the operation of PSSE, closes all associated files and returns to the calling application.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_PSSEHALT DELETE

Python command syntax:

ierr = pssehalt(delete)

Fortran command syntax:

CALL HALTAPI(DELETE, IERR)

Where:

Integer DELETE delete working files flag (input).

DELETE = 1 delete working files
DELETE != 1 keep working files
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
443
Power Flow PSSEHALT_2

1.1.205. PSSEHALT_2
Use this API to end the operation of PSSE, closes all associated files and returns to the calling application.

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_PSSEHALT_2

Python command syntax:

ierr = pssehalt_2()

Fortran command syntax:

CALL HALTAPI_2(IERR)

Where:

Integer IERR error code (output).

IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
444
Power Flow PV_ENGINE

1.1.206. PV_ENGINE
This API routine is obsolete. It has been replaced by the API routine pv_engine_1a .

Use this API routine to run the first release of the PV analysis calculation engine. The same set of automatic
adjustments is applied in base case and contingency case transfer increment solutions.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_PV_ENGINE OPTIONS(1)..OPTIONS(16) VALUES(1)..VALUES(6) LABELS(1)
LABELS(2) DFXFILE THRFILE ECDFILE ACCFILE

Python command syntax:

ierr = pv_engine(options, values, labels, dfxfile, thrfile, ecdfile,
accfile)

Fortran command syntax:

CALL PV_ENGINE(OPTIONS, VALUES, LABELS, DFXFILE, THRFILE, ECDFILE,
ACCFILE, IERR)

Where:
Integer OPTIONS (16) array of 16 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
445
Power Flow PV_ENGINE

OPTIONS(5) = 2 enable continuous mode, disable discrete

mode
OPTIONS(6) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(6) = 0 disable
OPTIONS(6) = 1 enable
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 FDNS
OPTIONS(7) = 1 FNSL
OPTIONS(7) = 2 optimized FDNS
OPTIONS(8) var limit code for the contingency case initial
power flow solution (0 by default)
OPTIONS(8) = 0 apply immediately
OPTIONS(8) = 1 initially ignore, then apply automatically
OPTIONS(9) var limit code for the subsequent transfer in-
crement cases (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) rating set (rating set program option setting
by default)
OPTIONS(10) = 1 RATEA
OPTIONS(10) = 2 RATEB
OPTIONS(10) = 3 RATEC
OPTIONS(11) study (source) system transfer dispatch
method (1 by default)
OPTIONS(11) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(11) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(11) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(11) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(11) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(11) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(11) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(11) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(12) opposing (sink) system transfer dispatch
method (1 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
446
Power Flow PV_ENGINE

OPTIONS(12) = 1 buses and distribution factors from DFAX file

for buses with positive MW machines
OPTIONS(12) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(12) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(12) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(12) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(12) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(12) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(12) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(13) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(13) = 0 no limits
OPTIONS(13) = 1 honor machine active power limits
OPTIONS(14) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(14) = 0 no limits
OPTIONS(14) = 1 enforce non-negative net active power con-
stant MVA load
OPTIONS(15) flag to check for low voltage at any moni-
tored bus (0 by default)
OPTIONS(15) = 0 disable check
OPTIONS(15) = 1 enable check
OPTIONS(16) flag to check for excessive loading on any
monitored branch (0 by default)
OPTIONS(16) = 0 disable check
OPTIONS(16) = 1 enable check
Real VALUES (6) array of 6 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial transfer increment in MW (100.0 by
default)
VALUES(3) transfer increment tolerance in MW (10.0 by
default)
VALUES(4) maximum incremental transfer in MW
(1000.0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
447
Power Flow PV_ENGINE

VALUES(5) low voltage threshold in pu in the low volt-

age check (0.8 by default)
VALUES(6) percent of rating in the excessive branch
loading check (100.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which the load is to be decreased (no default
allowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which the load is to be increased (no default
allowed)
Character*260 DFXFILE name of distribution factor data file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ECDFILE name of economic dispatch data file; blank for none (input; blank by
default).
Character*260 ACCFILE name of PV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 initial transfer increment is less than transfer
increment tolerance
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 ECDI engine in subsystem aaa
IERR = 11 base case ECDI solution did not converge
IERR = 12 no DFAX file specified
IERR = 13 no PV results file specified
IERR = 14 no economic dispatch data file specified
IERR = 15 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 16 bus type code and series element status in-
consistencies

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
448
Power Flow PV_ENGINE

IERR = 21 DFXFILE file is not in the form of a PSSE-25 or

later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined
IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 51 error opening PV results file
IERR = 52 error opening DFAX file
IERR = 53 error opening load throwover data file
IERR = 54 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
449
Power Flow PV_ENGINE_1A

1.1.207. PV_ENGINE_1A
This API routine is obsolete. It has been replaced by the API routine pv_engine_2 .

Use this API routine to run the PV analysis calculation engine. The same set of automatic adjustments and
induction machine treatment is applied in base case and contingency case transfer increment solutions.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_PV_ENGINE_1A OPTIONS(1)..OPTIONS(17) VALUES(1)..VALUES(6) LABELS(1)

LABELS(2) DFXFILE THRFILE ECDFILE ACCFILE

Python command syntax:

ierr = pv_engine_1a(options, values, labels, dfxfile, thrfile, ecdfile,

accfile)

Fortran command syntax:

CALL PV_ENGINE_1A(OPTIONS, VALUES, LABELS, DFXFILE, THRFILE, ECDFILE,

ACCFILE, IERR)

Where:

Integer OPTIONS (17) array of 17 elements specifying solution options(input).

OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
450
Power Flow PV_ENGINE_1A

OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) induction motor treatment flag; applied
when an induction motor fails to solve due to
low terminal voltage (0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
OPTIONS(8) solution method flag (0 by default)
OPTIONS(8) = 0 FDNS
OPTIONS(8) = 1 FNSL
OPTIONS(8) = 2 optimized FDNS
OPTIONS(9) var limit code for the contingency case initial
power flow solution (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) var limit code for the subsequent transfer in-
crement cases (0 by default)
OPTIONS(10) = 0 apply immediately
OPTIONS(10) = 1 initially ignore, then apply automatically
OPTIONS(11) rating set (rating set program option setting
by default)
OPTIONS(11) = 1 RATEA
OPTIONS(11) = 2 RATEB
OPTIONS(11) = 3 RATEC
OPTIONS(12) study (source) system transfer dispatch
method (1 by default)
OPTIONS(12) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(12) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(12) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(12) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(12) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(12) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
451
Power Flow PV_ENGINE_1A

OPTIONS(12) = 7 subsystem buses with positive MW machines

in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(12) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(13) opposing (sink) system transfer dispatch
method (1 by default)
OPTIONS(13) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(13) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(13) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(13) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(13) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(13) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(13) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(13) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(14) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(14) = 0 no limits
OPTIONS(14) = 1 honor machine active power limits
OPTIONS(15) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(15) = 0 no limits
OPTIONS(15) = 1 enforce non-negative net active power con-
stant MVA load
OPTIONS(16) flag to check for low voltage at any moni-
tored bus (0 by default)
OPTIONS(16) = 0 disable check
OPTIONS(16) = 1 enable check
OPTIONS(17) flag to check for excessive loading on any
monitored branch (0 by default)
OPTIONS(17) = 0 disable check
OPTIONS(17) = 1 enable check
Real VALUES (6) array of 6 elements specifying solution values(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
452
Power Flow PV_ENGINE_1A

VALUES(1) mismatch tolerance in MW and Mvar (New-

ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial transfer increment in MW (100.0 by
default)
VALUES(3) transfer increment tolerance in MW (10.0 by
default)
VALUES(4) maximum incremental transfer in MW
(1000.0 by default)
VALUES(5) low voltage threshold in pu in the low volt-
age check (0.8 by default)
VALUES(6) percent of rating in the excessive branch
loading check (100.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which the load is to be decreased (no default
allowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which the load is to be increased (no default
allowed)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ECDFILE name of cconomic dispatch data file; blank for none (input; blank by
default).
Character*260 ACCFILE name of PV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 initial transfer increment is less than transfer
increment tolerance
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 ECDI engine error in subsystem aaa

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
453
Power Flow PV_ENGINE_1A

IERR = 11 base case ECDI solution did not converge

IERR = 12 no DFAX file specified
IERR = 13 no PV results file specified
IERR = 14 no economic dispatch data file specified
IERR = 15 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 16 bus type code and series element status in-
consistencies
IERR = 21 file DFAX file is not in the form of a PSSE-25
or later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined
IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 51 error opening PV results file
IERR = 52 error opening DFAX File
IERR = 53 error opening load throwover data file
IERR = 54 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
454
Power Flow PV_ENGINE_2

1.1.208. PV_ENGINE_2
This API routine is obsolete. It has been replaced by the API routine pv_engine_3 .

Use this API to run PV analysis calculation engine. It provides for a different set of automatic adjustments in
contingency case solutions than is used in the base case transfer increment solutions.

This API routine was first introduced in release 30.3.0.

Batch command syntax:

BAT_PV_ENGINE_2 OPTIONS(1)..OPTIONS(21) VALUES(1)..VALUES(6) LABELS(1)

LABELS(2) DFXFILE THRFILE ECDFILE ACCFILE

Python command syntax:

ierr = pv_engine_2(options, values, labels, dfxfile, thrfile, ecdfile,

accfile)

Fortran command syntax:

CALL PV_ENGINE_2(OPTIONS, VALUES, LABELS, DFXFILE, THRFILE, ECDFILE,

ACCFILE, IERR)

Where:
Integer OPTIONS (21) array of 21 elements specifying solution options(input).
OPTIONS(1) base case tap adjustment flag (tap adjust-
ment option setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) base case area interchange adjustment flag
(area interchange adjustment option setting
by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) base case phase shift adjustment flag (phase
shift adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) base case dc tap adjustment flag (dc tap ad-
justment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) base case switched shunt adjustment flag
(switched shunt adjustment option setting
by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
455
Power Flow PV_ENGINE_2

OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(6) = 0 disable
OPTIONS(6) = 1 enable
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 FDNS
OPTIONS(7) = 1 FNSL
OPTIONS(7) = 2 optimized FDNS
OPTIONS(8) var limit code for the contingency case pow-
er flow solutions (0 by default)
OPTIONS(8) = 0 apply immediately
OPTIONS(8) = 1 initially ignore, then apply automatically
OPTIONS(9) var limit code for the base case transfer in-
crement solutions (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) rating set (rating set program option setting
by default)
OPTIONS(10) = 1 RATEA
OPTIONS(10) = 2 RATEB
OPTIONS(10) = 3 RATEC
OPTIONS(11) study (source) system transfer dispatch
method (1 by default)
OPTIONS(11) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(11) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(11) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(11) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(11) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(11) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(11) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(11) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
456
Power Flow PV_ENGINE_2

OPTIONS(12) opposing (sink) system transfer dispatch

method (1 by default)
OPTIONS(12) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(12) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(12) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(12) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(12) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(12) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(12) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(12) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(13) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(13) = 0 no limits
OPTIONS(13) = 1 honor machine active power limits
OPTIONS(14) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(14) = 0 no limits
OPTIONS(14) = 1 enforce non-negative net active power con-
stant MVA load
OPTIONS(15) flag to check for low voltage at any moni-
tored bus (0 by default)
OPTIONS(15) = 0 disable check
OPTIONS(15) = 1 enable check
OPTIONS(16) flag to check for excessive loading on any
monitored branch (0 by default)
OPTIONS(16) = 0 disable check
OPTIONS(16) = 1 enable check
OPTIONS(17) contingency case tap adjustment flag (base
case tap adjustment flag, OPTIONS (1) by de-
fault)
OPTIONS(17) = 0 disable
OPTIONS(17) = 1 enable stepping adjustment
OPTIONS(17) = 2 enable direct adjustment

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
457
Power Flow PV_ENGINE_2

OPTIONS(18) contingency case area interchange adjust-

ment flag (base case area interchange ad-
justment flag, OPTIONS (2) by default)
OPTIONS(18) = 0 disable
OPTIONS(18) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(18) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(19) contingency case phase shift adjustment flag
(base case phase shift adjustment flag, OP-
TIONS (3) by default)
OPTIONS(19) = 0 disable
OPTIONS(19) = 1 enable
OPTIONS(20) contingency case dc tap adjustment flag
(base case dc tap adjustment flag, OPTIONS
(4) by default)
OPTIONS(20) = 0 disable
OPTIONS(20) = 1 enable
OPTIONS(21) contingency case switched shunt adjustment
flag (base case switched shunt adjustment
flag, OPTIONS (5) by default)
OPTIONS(21) = 0 disable
OPTIONS(21) = 1 enable
OPTIONS(21) = 2 enable continuous mode, disable discrete
mode
Real VALUES (6) array of 6 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial transfer increment in MW (100.0 by
default)
VALUES(3) transfer increment tolerance in MW (10.0 by
default)
VALUES(4) maximum incremental transfer in MW
(1000.0 by default)
VALUES(5) low voltage threshold in pu in the low volt-
age check (0.8 by default)
VALUES(6) percent of rating in the excessive branch
loading check (100.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which the load is to be decreased (no default
allowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
458
Power Flow PV_ENGINE_2

which the load is to be increased (no default

allowed)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ECDFILE name of economic dispatch data file; blank for none (input; blank by
default).
Character*260 ACCFILE name of PV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 initial transfer increment is less than transfer
increment tolerance
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 ECDI engine in subsystem aaa
IERR = 11 base case ECDI solution did not converge
IERR = 12 no DFAX file specified
IERR = 14 no economic dispatch data file specified
IERR = 15 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 16 bus type code and series element status in-
consistencies
IERR = 21 DFXFILE file is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined
IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 51 error opening PV results file
IERR = 52 error opening DFAX file
IERR = 53 error opening load throwover data file

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
459
Power Flow PV_ENGINE_2

IERR = 54 prerequisite requirements for API are not met

IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
460
Power Flow PV_ENGINE_3

1.1.209. PV_ENGINE_3
This API routine is obsolete. It has been replaced by the API routine pv_engine_4 .

Use this API to run the PV analysis calculation engine. It provides for a different set of automatic adjust-
ments in contingency case solutions than is used in the base case transfer increment solutions, and allows
a negative minimum incremental transfer to be specified..

This API routine was first introduced in release 32.0.0.

Batch command syntax:

BAT_PV_ENGINE_3 OPTIONS(1)..OPTIONS(21) VALUES(1)..VALUES(7) LABELS(1)

LABELS(2) DFXFILE THRFILE ECDFILE ACCFILE

Python command syntax:

ierr = pv_engine_3(options, values, labels, dfxfile, thrfile, ecdfile,

accfile)

Fortran command syntax:

CALL PV_ENGINE_3(OPTIONS, VALUES, LABELS, DFXFILE, THRFILE, ECDFILE,

ACCFILE, IERR)

Where:

Integer OPTIONS (21) array of 21 elements specifying solution options(input).

OPTIONS(1) base case tap adjustment flag (tap adjust-
ment option setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) base case area interchange adjustment flag
(area interchange adjustment option setting
by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) base case phase shift adjustment flag (phase
shift adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) base case dc tap adjustment flag (dc tap ad-
justment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
461
Power Flow PV_ENGINE_3

OPTIONS(5) base case switched shunt adjustment flag

(switched shunt adjustment option setting
by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(6) = 0 disable
OPTIONS(6) = 1 enable
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 FDNS
OPTIONS(7) = 1 FNSL
OPTIONS(7) = 2 optimized FDNS
OPTIONS(8) var limit code for the contingency case pow-
er flow solutions (0 by default)
OPTIONS(8) = 0 apply immediately
OPTIONS(8) = 1 initially ignore, then apply automatically
OPTIONS(9) var limit code for the base case transfer in-
crement solutions (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) rating set (rating set program option setting
by default)
OPTIONS(10) = 1 RATEA
OPTIONS(10) = 2 RATEB
OPTIONS(10) = 3 RATEC
OPTIONS(11) study (source) system transfer dispatch
method (1 by default)
OPTIONS(11) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(11) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(11) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(11) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(11) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(11) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
462
Power Flow PV_ENGINE_3

OPTIONS(11) = 7 subsystem buses with positive MW machines

in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(11) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(12) opposing (sink) system transfer dispatch
method (1 by default)
OPTIONS(12) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(12) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(12) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(12) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(12) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(12) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(12) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(12) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(13) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(13) = 0 no limits
OPTIONS(13) = 1 honor machine active power limits
OPTIONS(14) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(14) = 0 no limits
OPTIONS(14) = 1 enforce non-negative net active power con-
stant MVA load
OPTIONS(15) flag to check for low voltage at any moni-
tored bus (0 by default)
OPTIONS(15) = 0 disable check
OPTIONS(15) = 1 enable check
OPTIONS(16) flag to check for excessive loading on any
monitored branch (0 by default)
OPTIONS(16) = 0 disable check
OPTIONS(16) = 1 enable check
OPTIONS(17) contingency case tap adjustment flag (base
case tap adjustment flag, OPTIONS (1) by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
463
Power Flow PV_ENGINE_3

OPTIONS(17) = 0 disable
OPTIONS(17) = 1 enable stepping adjustment
OPTIONS(17) = 2 enable direct adjustment
OPTIONS(18) contingency case area interchange adjust-
ment flag (base case area interchange ad-
justment flag, OPTIONS (2) by default)
OPTIONS(18) = 0 disable
OPTIONS(18) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(18) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(19) contingency case phase shift adjustment flag
(base case phase shift adjustment flag, OP-
TIONS (3) by default)
OPTIONS(19) = 0 disable
OPTIONS(19) = 1 enable
OPTIONS(20) contingency case dc tap adjustment flag
(base case dc tap adjustment flag, OPTIONS
(4) by default)
OPTIONS(20) = 0 disable
OPTIONS(20) = 1 enable
OPTIONS(21) contingency case switched shunt adjustment
flag (base case switched shunt adjustment
flag, OPTIONS (5) by default)
OPTIONS(21) = 0 disable
OPTIONS(21) = 1 enable
OPTIONS(21) = 2 enable continuous mode, disable discrete
mode
Real VALUES (7) array of 7 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial transfer increment in MW (100.0 by
default)
VALUES(3) transfer increment tolerance in MW (10.0 by
default)
VALUES(4) maximum incremental transfer in MW
(1000.0 by default)
VALUES(5) low voltage threshold in pu in the low volt-
age check (0.8 by default)
VALUES(6) percent of rating in the excessive branch
loading check (100.0 by default)
VALUES(7) minimum incremental transfer in MW (< 0.0)
(0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
464
Power Flow PV_ENGINE_3

LABELS(1) label of the study (source) system for which

generation is to be increased and/or for
which the load is to be decreased (no default
allowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which the load is to be increased (no default
allowed)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ECDFILE name of economic dispatch data file; blank for none (input; blank by
default).
Character*260 ACCFILE name of PV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 initial transfer increment is less than transfer
increment tolerance
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 ECDI engine in subsystem aaa
IERR = 11 base case ECDI solution did not converge
IERR = 12 no DFAX File specified
IERR = 13 no PV results file specified
IERR = 14 no economic dispatch data file specified
IERR = 15 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 16 invalid base/contingency case adjustment flag
combination
IERR = 17 bus type code and series element status in-
consistencies
IERR = 21 DFXFILE file is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
465
Power Flow PV_ENGINE_3

IERR = 23 no subsystems defined

IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 51 error opening PV results file
IERR = 52 error opening DFAX file
IERR = 53 error opening load throwover data file
IERR = 54 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
466
Power Flow PV_ENGINE_4

1.1.210. PV_ENGINE_4
This API routine is obsolete. It has been replaced by the API routine pv_engine_5 .

Use this API routine to run the PV analysis calculation engine. It provides for a different set of automatic
adjustments and induction machine treatment in contingency case solutions than is used in the base case
transfer increment solutions, and allows a negative minimum incremental transfer to be specified..

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_PV_ENGINE_4 OPTIONS(1)..OPTIONS(23) VALUES(1)..VALUES(7) LABELS(1)

LABELS(2) DFXFILE THRFILE ECDFILE ACCFILE

Python command syntax:

ierr = pv_engine_4(options, values, labels, dfxfile, thrfile, ecdfile,

accfile)

Fortran command syntax:

CALL PV_ENGINE_4(OPTIONS, VALUES, LABELS, DFXFILE, THRFILE, ECDFILE,

ACCFILE, IERR)

Where:

Integer OPTIONS (23) array of 23 elements specifying solution options(input).

OPTIONS(1) base case tap adjustment flag (tap adjust-
ment option setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) base case area interchange adjustment flag
(area interchange adjustment option setting
by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) base case phase shift adjustment flag (phase
shift adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) base case dc tap adjustment flag (dc tap ad-
justment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
467
Power Flow PV_ENGINE_4

OPTIONS(5) base case switched shunt adjustment flag

(switched shunt adjustment option setting
by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) base case induction motor treatment flag;
applied when an induction motor fails to
solve due to low terminal voltage (0 by de-
fault)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
OPTIONS(8) solution method flag (0 by default)
OPTIONS(8) = 0 FDNS
OPTIONS(8) = 1 FNSL
OPTIONS(8) = 2 optimized FDNS
OPTIONS(9) var limit code for the contingency case pow-
er flow solutions (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) var limit code for the base case transfer in-
crement solutions (0 by default)
OPTIONS(10) = 0 apply immediately
OPTIONS(10) = 1 initially ignore, then apply automatically
OPTIONS(11) rating set (rating set program option setting
by default)
OPTIONS(11) = 1 RATEA
OPTIONS(11) = 2 RATEB
OPTIONS(11) = 3 RATEC
OPTIONS(12) study (source) system transfer dispatch
method (1 by default)
OPTIONS(12) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(12) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(12) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(12) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
468
Power Flow PV_ENGINE_4

OPTIONS(12) = 5 subsystem buses with positive MW machines

in proportion to their MW output
OPTIONS(12) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(12) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(12) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(13) opposing (sink) system transfer dispatch
method (1 by default)
OPTIONS(13) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(13) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(13) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(13) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(13) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(13) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(13) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(13) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(14) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(14) = 0 no limits
OPTIONS(14) = 1 honor machine active power limits
OPTIONS(15) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(15) = 0 no limits
OPTIONS(15) = 1 enforce non-negative net active power con-
stant MVA load
OPTIONS(16) flag to check for low voltage at any moni-
tored bus (0 by default)
OPTIONS(16) = 0 disable check
OPTIONS(16) = 1 enable check
OPTIONS(17) flag to check for excessive loading on any
monitored branch (0 by default)
OPTIONS(17) = 0 disable check

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
469
Power Flow PV_ENGINE_4

OPTIONS(17) = 1 enable check

OPTIONS(18) contingency case tap adjustment flag (base
case tap adjustment flag, OPTIONS (1) by de-
fault)
OPTIONS(18) = 0 disable
OPTIONS(18) = 1 enable stepping adjustment
OPTIONS(18) = 2 enable direct adjustment
OPTIONS(19) contingency case area interchange adjust-
ment flag (base case area interchange ad-
justment flag, OPTIONS (2) by default)
OPTIONS(19) = 0 disable
OPTIONS(19) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(19) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(20) contingency case phase shift adjustment flag
(base case phase shift adjustment flag, OP-
TIONS (3) by default)
OPTIONS(20) = 0 disable
OPTIONS(20) = 1 enable
OPTIONS(21) contingency case dc tap adjustment flag
(base case dc tap adjustment flag, OPTIONS
(4) by default)
OPTIONS(21) = 0 disable
OPTIONS(21) = 1 enable
OPTIONS(22) contingency case switched shunt adjustment
flag (base case switched shunt adjustment
flag, OPTIONS (5) by default)
OPTIONS(22) = 0 disable
OPTIONS(22) = 1 enable
OPTIONS(22) = 2 enable continuous mode, disable discrete
mode
OPTIONS(23) contingency case induction motor treatment
flag; applied when an induction motor fails
to solve due to low terminal voltage (0 by de-
fault)
OPTIONS(23) = 0 stall
OPTIONS(23) = 1 trip
Real VALUES (7) array of 7 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial transfer increment in MW (100.0 by
default)
VALUES(3) transfer increment tolerance in MW (10.0 by
default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
470
Power Flow PV_ENGINE_4

VALUES(4) maximum incremental transfer in MW

(1000.0 by default)
VALUES(5) low voltage threshold in pu in the low volt-
age check (0.8 by default)
VALUES(6) percent of rating in the excessive branch
loading check (100.0 by default)
VALUES(7) minimum incremental transfer in MW (< 0.0)
(0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which the load is to be decreased (no default
allowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which the load is to be increased (no default
allowed)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ECDFILE name of economic dispatch data file; blank for none (input; blank by
default).
Character*260 ACCFILE name of PV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 initial transfer increment is less than transfer
increment tolerance
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 ECDI engine in subsystem aaa
IERR = 11 base case ECDI solution did not converge
IERR = 12 no DFAX file specified
IERR = 13 no PV results file specified
IERR = 14 no economic dispatch data file specified

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
471
Power Flow PV_ENGINE_4

IERR = 15 in-service induction machines are in the

"stalled" or "tripped" state
IERR = 16 bus type code and series element status in-
consistencies
IERR = 17 invalid base/contingency case flag combina-
tion
IERR = 21 DFXFILE file is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined
IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 51 error opening PV results file
IERR = 52 error opening DFAX file
IERR = 53 error opening load throwover data file
IERR = 54 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
472
Power Flow PV_ENGINE_5

1.1.211. PV_ENGINE_5
This API routine is obsolete. It has been replaced by the API routine pv_engine_6 .

Use this API routine to run the PV analysis calculation engine. It provides for a different set of automatic ad-
justments, and for different treatment of induction motors that fail to solve due to low terminal voltage, in
contingency case solutions than is used in the base case transfer increment solutions; it allows a negative
minimum incremental transfer to be specified; for transfer increment methods involving load, it allows a
power factor to be specified; and it provides for dispatching power unbalances resulting from the applica-
tion of contingencies.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_PV_ENGINE_5 OPTIONS(1)..OPTIONS(24) VALUES(1)..VALUES(8)

LABELS(1)..LABELS(3) DFXFILE THRFILE ECDFILE INLFILE ACCFILE

Python command syntax:

ierr = pv_engine_5(options, values, labels, dfxfile, thrfile, ecdfile,

inlfile, accfile)

Fortran command syntax:

CALL PV_ENGINE_5(OPTIONS, VALUES, LABELS, DFXFILE, THRFILE, ECDFILE,

INLFILE, ACCFILE, IERR)

Where:

Integer OPTIONS (24) array of 24 elements specifying solution options(input).

OPTIONS(1) base case tap adjustment flag (tap adjust-
ment option setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) base case area interchange adjustment flag
(area interchange adjustment option setting
by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) base case phase shift adjustment flag (phase
shift adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) base case dc tap adjustment flag (dc tap ad-
justment option setting by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
473
Power Flow PV_ENGINE_5

OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) base case switched shunt adjustment flag
(switched shunt adjustment option setting
by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) base case induction motor treatment flag;
applied when an induction motor fails to
solve due to low terminal voltage (0 by de-
fault)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
OPTIONS(8) solution method flag (0 by default)
OPTIONS(8) = 0 FDNS
OPTIONS(8) = 1 FNSL
OPTIONS(8) = 2 optimized FDNS
OPTIONS(9) var limit code for the contingency case pow-
er flow solutions (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) var limit code for the base case transfer in-
crement solutions (0 by default)
OPTIONS(10) = 0 apply immediately
OPTIONS(10) = 1 initially ignore, then apply automatically
OPTIONS(11) rating set (rating set program option setting
by default)
OPTIONS(11) = 1 RATEA
OPTIONS(11) = 2 RATEB
OPTIONS(11) = 3 RATEC
OPTIONS(12) study (source) system transfer dispatch
method (1 by default)
OPTIONS(12) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(12) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(12) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
474
Power Flow PV_ENGINE_5

OPTIONS(12) = 4 subsystem buses with positive MW constant

MVA load in proportion to their MW load
OPTIONS(12) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(12) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(12) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(12) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(13) opposing (sink) system transfer dispatch
method (1 by default)
OPTIONS(13) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(13) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(13) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(13) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(13) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(13) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(13) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(13) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(14) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(14) = 0 no limits
OPTIONS(14) = 1 honor machine active power limits
OPTIONS(15) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(15) = 0 no limits
OPTIONS(15) = 1 enforce non-negative net active power con-
stant MVA load
OPTIONS(16) flag to check for low voltage at any moni-
tored bus (0 by default)
OPTIONS(16) = 0 disable check
OPTIONS(16) = 1 enable check
OPTIONS(17) flag to check for excessive loading on any
monitored branch (0 by default)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
475
Power Flow PV_ENGINE_5

OPTIONS(17) = 0 disable check

OPTIONS(17) = 1 enable check
OPTIONS(18) dispatch mode for power unbalances result-
ing from the application of contingencies (1
by default)
OPTIONS(18) = 0 disable
OPTIONS(18) = 1 in-service subsystem machines using reserve
OPTIONS(18) = 2 in-service subsystem machines using Pmax
OPTIONS(18) = 3 in-service subsystem machines using inertia
OPTIONS(18) = 4 in-service subsystem machines using gover-
nor droop
OPTIONS(19) contingency case tap adjustment flag (base
case tap adjustment flag, OPTIONS (1) by de-
fault)
OPTIONS(19) = 0 disable
OPTIONS(19) = 1 enable stepping adjustment
OPTIONS(19) = 2 enable direct adjustment
OPTIONS(20) contingency case area interchange adjust-
ment flag (base case area interchange ad-
justment flag, OPTIONS (2) by default)
OPTIONS(20) = 0 disable
OPTIONS(20) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(20) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(21) contingency case phase shift adjustment flag
(base case phase shift adjustment flag, OP-
TIONS (3) by default)
OPTIONS(21) = 0 disable
OPTIONS(21) = 1 enable
OPTIONS(22) contingency case dc tap adjustment flag
(base case dc tap adjustment flag, OPTIONS
(4) by default)
OPTIONS(22) = 0 disable
OPTIONS(22) = 1 enable
OPTIONS(23) contingency case switched shunt adjustment
flag (base case switched shunt adjustment
flag, OPTIONS (5) by default)
OPTIONS(23) = 0 disable
OPTIONS(23) = 1 enable
OPTIONS(23) = 2 enable continuous mode, disable discrete
mode
OPTIONS(24) contingency case induction motor treatment
flag; applied when an induction motor fails
to solve due to low terminal voltage (0 by de-
fault)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
476
Power Flow PV_ENGINE_5

OPTIONS(24) = 0 stall
OPTIONS(24) = 1 trip
Real VALUES (8) array of 8 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial transfer increment in MW (100.0 by
default)
VALUES(3) transfer increment tolerance in MW (10.0 by
default)
VALUES(4) maximum incremental transfer in MW
(1000.0 by default)
VALUES(5) low voltage threshold in pu in the low volt-
age check (0.8 by default)
VALUES(6) percent of rating in the excessive branch
loading check (100.0 by default)
VALUES(7) minimum incremental transfer in MW (< 0.0)
(0.0 by default)
VALUES(8) power factor for load increases in dispatch
methods 2, 3 and 4. Specify as <= 0.0 to re-
tain the original power factor at each load
that is changed (0.0 by default)
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which the load is to be decreased (no default
allowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which the load is to be increased (no default
allowed)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ECDFILE name of economic dispatch data file; blank for none (input; blank by
default).
Character*260 INLFILE name of inertia and governor response file (input).
Character*260 ACCFILE name of PV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
477
Power Flow PV_ENGINE_5

IERR = 5 largest mismatch exceeds mismatch toler-

ance
IERR = 6 initial transfer increment is less than transfer
increment tolerance
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 ECDI engine in subsystem aaa
IERR = 11 base case ECDI solution did not converge
IERR = 12 no DFAX file specified
IERR = 13 no PV results file specified
IERR = 14 no economic dispatch data file specified
IERR = 15 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 16 bus type code and series element status in-
consistencies
IERR = 17 invalid base/contingency case flag combina-
tion
IERR = 21 DFXFILE file is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined
IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 51 error opening PV results file
IERR = 52 error opening DFAX file
IERR = 53 error opening load throwover data file
IERR = 54 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
478
Power Flow PV_ENGINE_6

1.1.212. PV_ENGINE_6
Use this API routine to run the PV analysis calculation engine. It provides for a different set of automatic ad-
justments, and for different treatment of induction motors that fail to solve due to low terminal voltage, in
contingency case solutions than is used in the base case transfer increment solutions; it allows a negative
minimum incremental transfer to be specified; for transfer increment methods involving load, it allows a
power factor to be specified; it provides for dispatching power unbalances resulting from the application of
contingencies; and it allows for the preservation of milestone results in a ZIP Archive Output File.

This API routine was first introduced in release 33.4.0.

Batch command syntax:

BAT_PV_ENGINE_6 OPTIONS(1)..OPTIONS(25) VALUES(1)..VALUES(8)

LABELS(1)..LABELS(3) DFXFILE THRFILE ECDFILE INLFILE ACCFILE ZIPFILE

Python command syntax:

ierr = pv_engine_6(options, values, labels, dfxfile, thrfile, ecdfile,

inlfile, accfile, zipfile)

Fortran command syntax:

CALL PV_ENGINE_6(OPTIONS, VALUES, LABELS, DFXFILE, THRFILE, ECDFILE,

INLFILE, ACCFILE, ZIPFILE, IERR)

Where:

Integer OPTIONS (25) array of 25 elements specifying solution options(input).

OPTIONS(1) base case tap adjustment flag (tap adjust-
ment option setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) base case area interchange adjustment flag
(area interchange adjustment option setting
by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) base case phase shift adjustment flag (phase
shift adjustment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) base case dc tap adjustment flag (dc tap ad-
justment option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
479
Power Flow PV_ENGINE_6

OPTIONS(5) base case switched shunt adjustment flag

(switched shunt adjustment option setting
by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode
OPTIONS(6) base case induction motor treatment flag;
applied when an induction motor fails to
solve due to low terminal voltage (0 by de-
fault)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
OPTIONS(8) solution method flag (0 by default)
OPTIONS(8) = 0 FDNS
OPTIONS(8) = 1 FNSL
OPTIONS(8) = 2 optimized FDNS
OPTIONS(9) var limit code for the contingency case pow-
er flow solutions (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) var limit code for the base case transfer in-
crement solutions (0 by default)
OPTIONS(10) = 0 apply immediately
OPTIONS(10) = 1 initially ignore, then apply automatically
OPTIONS(11) rating set (rating set program option setting
by default)
OPTIONS(11) = 1 RATEA
OPTIONS(11) = 2 RATEB
OPTIONS(11) = 3 RATEC
OPTIONS(12) study (source) system transfer dispatch
method (1 by default)
OPTIONS(12) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(12) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(12) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(12) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
480
Power Flow PV_ENGINE_6

OPTIONS(12) = 5 subsystem buses with positive MW machines

in proportion to their MW output
OPTIONS(12) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(12) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PMAXMC -
PGENMC)
OPTIONS(12) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(13) opposing (sink) system transfer dispatch
method (1 by default)
OPTIONS(13) = 1 buses and distribution factors from DFAX file
for buses with positive MW machines
OPTIONS(13) = 2 buses and distribution factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(13) = 3 buses and distribution factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(13) = 4 subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(13) = 5 subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(13) = 6 subsystem buses with positive MW machines
in proportion to their MBASEs
OPTIONS(13) = 7 subsystem buses with positive MW machines
in proportion to their reserve (PGENMC -
PMINMC)
OPTIONS(13) = 8 subsystem buses with positive MW machines
via ECDI with unit commitment disabled
OPTIONS(14) generation plant limits flag for transfer meth-
ods 1, 3, 5, 6 and 7 (0 by default)
OPTIONS(14) = 0 no limits
OPTIONS(14) = 1 honor machine active power limits
OPTIONS(15) positive load flag for transfer methods 2, 3
and 4 (0 by default)
OPTIONS(15) = 0 no limits
OPTIONS(15) = 1 enforce non-negative net active power con-
stant MVA load
OPTIONS(16) flag to check for low voltage at any moni-
tored bus (0 by default)
OPTIONS(16) = 0 disable check
OPTIONS(16) = 1 enable check
OPTIONS(17) flag to check for excessive loading on any
monitored branch (0 by default)
OPTIONS(17) = 0 disable check

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
481
Power Flow PV_ENGINE_6

OPTIONS(17) = 1 enable check

OPTIONS(18) dispatch mode for power unbalances result-
ing from the application of contingencies (1
by default)
OPTIONS(18) = 0 disable
OPTIONS(18) = 1 in-service subsystem machines using reserve
OPTIONS(18) = 2 in-service subsystem machines using Pmax
OPTIONS(18) = 3 in-service subsystem machines using inertia
OPTIONS(18) = 4 in-service subsystem machines using gover-
nor droop
OPTIONS(19) write ZIP archive flag (0 by default)
OPTIONS(19) = 0 no ZIP archive
OPTIONS(19) = 1 Write ZIP Archive file ZIPFILE; preserve each
system condition at its largest solved incre-
mental transfer level.
OPTIONS(19) = 2 Write ZIP Archive file ZIPFILE; preserve each
system condition at all of its solved incre-
mental transfer levels.
OPTIONS(20) contingency case tap adjustment flag (base
case tap adjustment flag, OPTIONS (1) by de-
fault)
OPTIONS(20) = 0 disable
OPTIONS(20) = 1 enable stepping adjustment
OPTIONS(20) = 2 enable direct adjustment
OPTIONS(21) contingency case area interchange adjust-
ment flag (base case area interchange ad-
justment flag, OPTIONS (2) by default)
OPTIONS(21) = 0 disable
OPTIONS(21) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(21) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(22) contingency case phase shift adjustment flag
(base case phase shift adjustment flag, OP-
TIONS (3) by default)
OPTIONS(22) = 0 disable
OPTIONS(22) = 1 enable
OPTIONS(23) contingency case dc tap adjustment flag
(base case dc tap adjustment flag, OPTIONS
(4) by default)
OPTIONS(23) = 0 disable
OPTIONS(23) = 1 enable
OPTIONS(24) contingency case switched shunt adjustment
flag (base case switched shunt adjustment
flag, OPTIONS (5) by default)
OPTIONS(24) = 0 disable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
482
Power Flow PV_ENGINE_6

OPTIONS(24) = 1 enable
OPTIONS(24) = 2 enable continuous mode, disable discrete
mode
OPTIONS(25) contingency case induction motor treatment
flag; applied when an induction motor fails
to solve due to low terminal voltage (0 by de-
fault)
OPTIONS(25) = 0 stall
OPTIONS(25) = 1 trip
Real VALUES (8) array of 8 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial transfer increment in MW (100.0 by
default)
VALUES(3) transfer increment tolerance in MW (10.0 by
default)
VALUES(4) maximum incremental transfer in MW
(1000.0 by default)
VALUES(5) low voltage threshold in pu in the low volt-
age check (0.8 by default)
VALUES(6) percent of rating in the excessive branch
loading check (100.0 by default)
VALUES(7) minimum incremental transfer in MW (< 0.0)
(0.0 by default)
VALUES(8) power factor for load increases in dispatch
methods 2, 3 and 4. Specify as <= 0.0 to re-
tain the original power factor at each load
that is changed (0.0 by default)
Character*32 LABELS (3) array of 3 elements specifying subsystem labels(input).
LABELS(1) label of the study (source) system for which
generation is to be increased and/or for
which the load is to be decreased (no default
allowed)
LABELS(2) label of the opposing (sink) system for which
generation is to be decreased and/or for
which the load is to be increased (no default
allowed)
LABELS(3) label of the dispatch subsystem; used if OP-
TIONS(18) is 1 through 4 (blank by default)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ECDFILE name of economic dispatch data file; blank for none (input; blank by
default).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
483
Power Flow PV_ENGINE_6

Character*260 INLFILE name of inertia and governor response file (input).

Character*260 ACCFILE name of PV results file (input; no default allowed).
Character*260 ZIPFILE name of ZIP archive output file (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 initial transfer increment is less than transfer
increment tolerance
IERR = 7 no participating dispatch buses in study sys-
tem
IERR = 8 no participating dispatch buses in opposing
system
IERR = 9 subsystem engine error
IERR = 10 ECDI engine in subsystem aaa
IERR = 11 base case ECDI solution did not converge
IERR = 12 no DFAX file specified
IERR = 13 no PV results file specified
IERR = 14 no economic dispatch data file specified
IERR = 15 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 16 bus type code and series element status in-
consistencies
IERR = 17 invalid base/contingency case flag combina-
tion
IERR = 21 DFXFILE file is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 23 no subsystems defined
IERR = 24 subsystem not found
IERR = 25 specified subsystems overlap
IERR = 26 no in-service buses in subsystem WORLD
IERR = 50 error opening economic dispatch data file
IERR = 51 error opening PV results file
IERR = 52 error opening DFAX file
IERR = 53 error opening load throwover data file
IERR = 54 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
484
Power Flow QV_ENGINE

1.1.213. QV_ENGINE
This API routine is obsolete. It has been replaced by the API routine qv_engine_2 .

Use this API to run the QV analysis calculation engine.

This API routine was first introduced in release 30.0.0.

Batch command syntax:

BAT_QV_ENGINE OPTIONS(1)..OPTIONS(10) VALUES(1)..VALUES(4) DFXFILE

THRFILE ACCFILE

Python command syntax:

ierr = qv_engine(options, values, dfxfile, thrfile, accfile)

Fortran command syntax:

CALL QV_ENGINE(OPTIONS, VALUES, DFXFILE, THRFILE, ACCFILE, IERR)

Where:
Integer OPTIONS (10) array of 10 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
485
Power Flow QV_ENGINE

OPTIONS(6) non-divergent solution flag (non-divergent

solution option setting by default)
OPTIONS(6) = 0 disable
OPTIONS(6) = 1 enable
OPTIONS(7) solution method flag (0 by default)
OPTIONS(7) = 0 FDNS
OPTIONS(7) = 1 FNSL
OPTIONS(7) = 2 optimized FDNS
OPTIONS(8) var limit code for the VHI power flow solu-
tion (0 by default)
OPTIONS(8) = 0 apply immediately
OPTIONS(8) = 1 initially ignore, then apply automatically
OPTIONS(9) var limit code for the subsequent voltage
decrement cases (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) study bus number (no default allowed)
Real VALUES (4) array of 4 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial (maximum) pu voltage setpoint at the
study bus (VHI) (1.1 by default)
VALUES(3) minimum pu voltage setpoint at the study
bus (VLO) (0.9 by default)
VALUES(4) pu voltage setpoint decrement (positive) at
the study bus (DLTAV) (0.01 by default)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ACCFILE name of QV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 VHI is not greater than VLO
IERR = 7 study bus not found
IERR = 8 invalid study bus
IERR = 9 error when adding a plant to the study bus

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
486
Power Flow QV_ENGINE

IERR = 10 error when adding a machine to the study

bus
IERR = 11 base case VHI solution did not converge
IERR = 12 no Distribution Factor Data File specified
IERR = 13 no Q-V Solution Output File specified
IERR = 14 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 15 bus type code and series element status in-
consistencies
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening QV Results File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 55 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
487
Power Flow QV_ENGINE_2

1.1.214. QV_ENGINE_2
This API routine is obsolete. It has been replaced by the API routine qv_engine_3 .

Use this API routine to run the QV analysis calculation engine.

This API routine was first introduced in release 33.0.0.

Batch command syntax:

BAT_QV_ENGINE_2 OPTIONS(1)..OPTIONS(11) VALUES(1)..VALUES(4) DFXFILE

THRFILE ACCFILE

Python command syntax:

ierr = qv_engine_2(options, values, dfxfile, thrfile, accfile)

Fortran command syntax:

CALL QV_ENGINE_2(OPTIONS, VALUES, DFXFILE, THRFILE, ACCFILE, IERR)

Where:
Integer OPTIONS (11) array of 11 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(5) = 2 enable continuous mode, disable discrete
mode

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
488
Power Flow QV_ENGINE_2

OPTIONS(6) induction motor treatment flag; applied

when an induction motor fails to solve due to
low terminal voltage (0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
OPTIONS(8) solution method flag (0 by default)
OPTIONS(8) = 0 FDNS
OPTIONS(8) = 1 FNSL
OPTIONS(8) = 2 optimized FDNS
OPTIONS(9) var limit code for the VHI power flow solu-
tion (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) var limit code for the subsequent voltage
decrement cases (0 by default)
OPTIONS(10) = 0 apply immediately
OPTIONS(10) = 1 initially ignore, then apply automatically
OPTIONS(11) study bus number (no default allowed)
Real VALUES (4) array of 4 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial (maximum) pu voltage setpoint at the
study bus (VHI) (1.1 by default)
VALUES(3) minimum pu voltage setpoint at the study
bus (VLO) (0.9 by default)
VALUES(4) pu voltage setpoint decrement (positive) at
the study bus (DLTAV) (0.01 by default)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 ACCFILE name of QV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
489
Power Flow QV_ENGINE_2

IERR = 5 largest mismatch exceeds mismatch toler-

ance
IERR = 6 VHI is not greater than VLO
IERR = 7 study bus not found
IERR = 8 invalid study bus
IERR = 9 error when adding a plant to the study bus
IERR = 10 error when adding a machine to the study
bus
IERR = 11 base case VHI solution did not converge
IERR = 12 no Distribution Factor Data File specified
IERR = 13 no Q-V Solution Output File specified
IERR = 14 in-service induction machines are in the
"stalled" or "tripped" state
IERR = 15 bus type code and series element status in-
consistencies
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 22 monitored elements exceed limit when
adding multi-section line members
IERR = 51 error opening QV Results File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Load Throwover Data File
IERR = 55 prerequisite requirements for API are not met
IERR = 99 terminated by user interrupt or file error

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
490
Power Flow QV_ENGINE_3

1.1.215. QV_ENGINE_3
This API routine is obsolete. It has been replaced by the API routine qv_engine_4 .

Use this API routine to run the QV analysis calculation engine.

This API routine was first introduced in release 33.2.0.

Batch command syntax:

BAT_QV_ENGINE_3 OPTIONS(1)..OPTIONS(12) VALUES(1)..VALUES(4) LABEL

DFXFILE THRFILE INLFILE ACCFILE

Python command syntax:

ierr = qv_engine_3(options, values, label, dfxfile, thrfile, inlfile,

accfile)

Fortran command syntax:

CALL QV_ENGINE_3(OPTIONS, VALUES, LABEL, DFXFILE, THRFILE, INLFILE,

ACCFILE, IERR)

Where:
Integer OPTIONS (12) array of 12 elements specifying solution options(input).
OPTIONS(1) tap adjustment flag (tap adjustment option
setting by default)
OPTIONS(1) = 0 disable
OPTIONS(1) = 1 enable stepping adjustment
OPTIONS(1) = 2 enable direct adjustment
OPTIONS(2) area interchange adjustment flag (area inter-
change adjustment option setting by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(2) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(3) phase shift adjustment flag (phase shift ad-
justment option setting by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
OPTIONS(4) dc tap adjustment flag (dc tap adjustment
option setting by default)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) switched shunt adjustment flag (switched
shunt adjustment option setting by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
491
Power Flow QV_ENGINE_3

OPTIONS(5) = 2 enable continuous mode, disable discrete

mode
OPTIONS(6) induction motor treatment flag; applied
when an induction motor fails to solve due to
low terminal voltage (0 by default)
OPTIONS(6) = 0 stall
OPTIONS(6) = 1 trip
OPTIONS(7) non-divergent solution flag (non-divergent
solution option setting by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
OPTIONS(8) solution method flag (0 by default)
OPTIONS(8) = 0 FDNS
OPTIONS(8) = 1 FNSL
OPTIONS(8) = 2 optimized FDNS
OPTIONS(9) var limit code for the VHI power flow solu-
tion (0 by default)
OPTIONS(9) = 0 apply immediately
OPTIONS(9) = 1 initially ignore, then apply automatically
OPTIONS(10) var limit code for the subsequent voltage
decrement cases (0 by default)
OPTIONS(10) = 0 apply immediately
OPTIONS(10) = 1 initially ignore, then apply automatically
OPTIONS(11) study bus number (no default allowed)
OPTIONS(12) dispatch mode for power unbalances result-
ing from the application of contingencies (1
by default)
OPTIONS(12) = 0 disable
OPTIONS(12) = 1 in-service subsystem machines using reserve
OPTIONS(12) = 2 in-service subsystem machines using Pmax
OPTIONS(12) = 3 in-service subsystem machines using inertia
OPTIONS(12) = 4 in-service subsystem machines using gover-
nor droop
Real VALUES (4) array of 4 elements specifying solution values(input).
VALUES(1) mismatch tolerance in MW and Mvar (New-
ton solution convergence tolerance, TOLN by
default)
VALUES(2) initial (maximum) pu voltage setpoint at the
study bus (VHI) (1.1 by default)
VALUES(3) minimum pu voltage setpoint at the study
bus (VLO) (0.9 by default)
VALUES(4) pu voltage setpoint decrement (positive) at
the study bus (DLTAV) (0.01 by default)
Character*32 LABEL (1) array of 1 elements specifying subsystem label(input).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
492
Power Flow QV_ENGINE_3

LABEL(1) label of the dispatch subsystem; used if OP-

TIONS(12) is 1 through 4 (blank by default)
Character*260 DFXFILE name of DFAX file (input; no default allowed).
Character*260 THRFILE name of load throwover data file; blank for none (input; blank by de-
fault).
Character*260 INLFILE name of inertia and governor response file; blank for none (input;
blank by default).
Character*260 ACCFILE name of QV results file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VALUES value
IERR = 2 invalid OPTIONS value
IERR = 3 generators are converted
IERR = 4 buses in island(s) without a swing bus; use
activity TREE
IERR = 5 largest mismatch exceeds mismatch toler-
ance
IERR = 6 VHI is not greater than VLO
IERR = 7 study bus not found
IERR = 8 invalid study bus
IERR = 9 error when adding a plant to the study bus
IERR = 10 error when addi