Application Program Interface (API) PSS®E 35.3.0: July 2021
Uploaded by
Vinay ChoudharyApplication Program Interface (API) PSS®E 35.3.0: July 2021
Uploaded by
Vinay ChoudharyApplication 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 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
493
Power Flow QV_ENGINE_4
1.1.216. QV_ENGINE_4
Use this API routine to run the QV analysis calculation engine.
This API routine was first introduced in release 33.4.0.
Batch command syntax:
BAT_QV_ENGINE_4 OPTIONS(1)..OPTIONS(13) VALUES(1)..VALUES(4) LABEL
DFXFILE THRFILE INLFILE ACCFILE ZIPFILE
Python command syntax:
ierr = qv_engine_4(options, values, label, dfxfile, thrfile, inlfile,
accfile, zipfile)
Fortran command syntax:
CALL QV_ENGINE_4(OPTIONS, VALUES, LABEL, DFXFILE, THRFILE, INLFILE,
ACCFILE, ZIPFILE, 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
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
494
Power Flow QV_ENGINE_4
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
OPTIONS(13) write ZIP archive flag (0 by default)
OPTIONS(13) = 0 no ZIP archive
OPTIONS(13) = 1 Write ZIP Archive file ZIPFILE; preserve each
system condition at its lowest solved study
bus voltage level.
OPTIONS(13) = 2 Write ZIP Archive file ZIPFILE; preserve each
system condition at all solved study bus volt-
age levels.
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)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
495
Power Flow QV_ENGINE_4
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).
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).
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
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
496
Power Flow QV_ENGINE_4
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 error opening inertia and governor response
data file
IERR = 55 error opening ZIP archive output file
IERR = 56 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
497
Power Flow RANK
1.1.217. RANK
Use this API to estimate the severity of designated single branch outage contingencies and builds a contin-
gency solution output file with contingencies specified in decreasing order of their estimated severities.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RANK SID ALL IVAL(1)..IVAL(7) RVAL(1)..RVAL(4) SSFILE MNFILE
ACCFILE
Python command syntax:
ierr = rank(sid, all, ival, rval, ssfile, mnfile, accfile)
Fortran command syntax:
CALL RANKNW(SID, ALL, IVAL, RVAL, SSFILE, MNFILE, ACCFILE, 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 IVAL (7) array of 7 elements specifying ranking options(input).
IVAL(1) allow ties from specified subsystem as con-
tingencies (0 = no, 1 = yes; 0 by default)
IVAL(2) number of branch contingencies from over-
load ranking to include (>= 0) (0 by default)
IVAL(3) rating set (1=RATEA, 2=RATEB, 3=RATEC)
(rating set program option setting by default)
IVAL(4) convert ratings to estimated MW ratings (0 =
no, 1 = yes; 0 by default)
IVAL(5) number of voltage depression contingencies
to include (>=0) (0 by default)
IVAL(6) code indicating the set of branches to in-
clude in the voltage depression performance
index (0 by default)
IVAL(6) = 0 include all branches
IVAL(6) = 1 include only those with a nonzero rating
IVAL(7) include contingencies that create swingless
islands (0 by default)
IVAL(7) = 0 no
IVAL(7) = 1 yes
Real RVAL (4) array of 4 elements specifying ranking parameters(input).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
498
Power Flow RANK
RVAL(1) MW mismatch threshold (>= 0.0) (Newton
solution convergence tolerance, TOLN by de-
fault)
RVAL(2) small reactance threshold (THRSHZ <=
RVAL(2) <= 0.005) (0.0005 by default)
RVAL(3) percent of rating (0.0 <= RVAL(3) <= 200.0)
(100.0 by default)
RVAL(4) MW threshold for islanding contingencies
(>= 0.0) (100.0 by default)
Character*260 SSFILE name of the subsystem description file, or blank for no subsystem
(input; blank by default).
Character*260 MNFILE name of the monitored element description file (if IVAL(2) > 0 (i.e., if
the branch outage overload ranker is enabled) ) (input; no default al-
lowed).
Character*260 ACCFILE name of the contingency solution output file, or blank for output to
the progress window (input; blank by default).
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 IVAL value
IERR = 4 invalid RVAL value
IERR = 5 MNFILE is blank
IERR = 6 no contingency types enabled
IERR = 7 error opening SSFILE or MNFILE
IERR = 8 generators are converted
IERR = 9 buses in island(s) without a swing bus; use
activity TREE
IERR = 10 largest mismatch exceeds mismatch toler-
ance
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
499
Power Flow RANK_BRN_AND_MAC
1.1.218. RANK_BRN_AND_MAC
Use this API to estimate the severity of designated single element outage contingencies and builds a con-
tingency description data file with contingencies specified in decreasing order of their estimated severities.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_RANK_BRN_AND_MAC SID ALL IVAL(1)..IVAL(8) RVAL(1)..RVAL(4) SSFILE
MNFILE ACCFILE
Python command syntax:
ierr = rank_brn_and_mac(sid, all, ival, rval, ssfile, mnfile, accfile)
Fortran command syntax:
CALL RANKAPI(SID, ALL, IVAL, RVAL, SSFILE, MNFILE, ACCFILE, 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 IVAL (8) array of 8 elements specifying ranking options(input).
IVAL(1) allow ties from specified subsystem as con-
tingencies (0 by default)
IVAL(1) = 0 no
IVAL(1) = 1 yes
IVAL(2) number of branch contingencies from over-
load ranking to include (>= 0) (0 by default)
IVAL(3) rating set (1=RATEA, 2=RATEB, 3=RATEC)
(rating set program option setting by default)
IVAL(4) convert ratings to estimated MW ratings (0
by default)
IVAL(4) = 0 no
IVAL(4) = 1 yes
IVAL(5) number of voltage depression contingencies
to include (>=0) (0 by default)
IVAL(6) code indicating the set of branches to in-
clude in the voltage depression performance
index (0 by default)
IVAL(6) = 0 include all branches
IVAL(6) = 1 include only those with a nonzero rating
IVAL(7) include contingencies that create swingless
islands (0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
500
Power Flow RANK_BRN_AND_MAC
IVAL(7) = 0 no
IVAL(7) = 1 yes
IVAL(8) number of machine contingencies from over-
load ranking to include (>=0) (0 by default)
Real RVAL (4) array of 4 elements specifying ranking parameters(input).
RVAL(1) MW mismatch threshold (>= 0.0) (Newton
solution convergence tolerance, TOLN by de-
fault)
RVAL(2) small reactance threshold (THRSHZ <=
RVAL(2) <= 0.005) (0.0005 by default)
RVAL(3) percent of rating (0.0 <= RVAL(3) <= 200.0)
(100.0 by default)
RVAL(4) MW threshold for islanding contingencies
(>= 0.0) (100.0 by default)
Character*260 SSFILE name of the subsystem description file, or blank for no subsystem
(input; blank by default).
Character*260 MNFILE name of the monitored element description file (if IVAL(2) > 0 (i.e., if
the branch outage overload ranker is enabled) or if IVAL(8) > 0 (i.e.,
if the machine outage overload ranker is enabled) ) (input; no default
allowed).
Character*260 ACCFILE name of the contingency description data file, or blank for output to
the progress window (input; blank by default).
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 IVAL value
IERR = 4 invalid RVAL value
IERR = 5 MNFILE is blank
IERR = 6 no contingency types enabled
IERR = 7 error opening SSFILE or MNFILE
IERR = 8 generators are converted
IERR = 9 buses in island(s) without a swing bus; use
activity TREE
IERR = 10 largest mismatch exceeds mismatch toler-
ance
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
501
Power Flow RATE
1.1.219. RATE
This API routine is obsolete. It has been replaced by the API routine rate_2 .
Use this API to check branch loadings.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RATE SID ALL LINFLG RATING FMAX
Python command syntax:
ierr = rate(sid, all, linflg, rating, fmax)
Fortran command syntax:
CALL RATENW(SID, ALL, LINFLG, RATING, FMAX, 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 branches connected to buses in
subsystem SID
ALL = 1 process all branches
Integer LINFLG branch check to be applied (input; 1 by default).
LINFLG = 1 check all lines
LINFLG = 2 check non-transformer branches
LINFLG = 3 check transformers
LINFLG = 4 check all lines, all ratings
Integer RATING rating to be used (input; default rating set program option setting).
RATING = 1 RATEA
RATING = 2 RATEB
RATING = 3 RATEC
Real FMAX line loading limit, in percent; 0.0 =< FMAX =< 500.0 (input; 100.0).
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 LINFLG value
IERR = 4 invalid RATING value
IERR = 5 invalid FMAX 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
502
Power Flow RATE
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
503
Power Flow RATE_2
1.1.220. RATE_2
Use this API to check branch loadings.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_RATE_2 SID ALL LINFLG TRNFLG BRKFLG RATING FMAX
Python command syntax:
ierr = rate_2(sid, all, linflg, trnflg, brkflg, rating, fmax)
Fortran command syntax:
CALL RATE_2(SID, ALL, LINFLG, TRNFLG, BRKFLG, RATING, FMAX, 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 branches connected to buses in
subsystem SID
ALL = 1 process all branches
Integer LINFLG include non-transformer branches that are not breakers or switches
in the branch check to be applied (input; 1 by default).
LINFLG = 0 no
LINFLG = 1 yes
Integer TRNFLG include transformer branches in the branch check to be applied (in-
put; 1 by default).
TRNFLG = 0 no
TRNFLG = 1 yes
Integer BRKFLG include branches that are breakers or switches in the branch check to
be applied (input; 1 by default).
BRKFLG = 0 no
BRKFLG = 1 yes
Integer RATING rating to be used (input; default rating set program option setting).
RATING = 0 all rating sets
RATING = 1 RATEA
RATING = 2 RATEB
RATING = 3 RATEC
Real FMAX line loading limit, in percent; 0.0 =< FMAX =< 500.0 (input; 100.0).
Integer IERR error code (output).
IERR = 0 no error
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
504
Power Flow RATE_2
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 invalid LINFLG value
IERR = 4 invalid TRNFLG value
IERR = 5 invalid BRKFLG value
IERR = 6 invalid RATING value
IERR = 7 invalid FMAX 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
505
Power Flow RATING_SET
1.1.221. RATING_SET
Use this API to specify or return the current rating set, from 1 to 12.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_RATING_SET IVAL
Python command syntax:
ierr = rating_set(ival)
ierr, ival = rating_set()
Fortran command syntax:
CALL RATING_SET_API(IVAL, IOCODE, IERR)
Where:
Integer IVAL value of the current rating set, from 1 to 12 (input; if Batch com-
mand, or for Python if specified as an argument, or for Fortran if
IOCODE is 0, 1 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
506
Power Flow RAWD
1.1.222. RAWD
This API routine is obsolete. It has been replaced by the API routine rawd_2 .
Use this API to replicate the working case in the form of a power flow raw data file.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RAWD SID ALL STATUS(1)..STATUS(6) OUT OFILE
Python command syntax:
ierr = rawd(sid, all, status, out, ofile)
Fortran command syntax:
CALL RAWDAPI(SID, ALL, STATUS, 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 buses in subsystem SID
ALL = 1 process all buses when STATUS(4) = 0; area
ties only when STATUS(4) = 1
Integer STATUS (6) array of 6 elements specifying options(input).
STATUS(1) include records for Type 4 buses (1 by de-
fault)
STATUS(1) = 0 no
STATUS(1) = 1 yes
STATUS(2) include records for out-of-service branches
(1 by default)
STATUS(2) = 0 no
STATUS(2) = 1 yes
STATUS(3) include records for equipment in the subsys-
tem (1 by default)
STATUS(3) = 0 no
STATUS(3) = 1 yes
STATUS(4) include records for subsystem ties (0 by de-
fault)
STATUS(4) = 0 no
STATUS(4) = 1 yes
STATUS(5) use bus names as bus identifiers (0 by de-
fault)
STATUS(5) = 0 no
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
507
Power Flow RAWD
STATUS(5) = 1 yes
STATUS(6) Raw Data File type (0 by default)
STATUS(6) = 0 for activity READ with IC=0
STATUS(6) = 1 for activity READ with IC=1
STATUS(6) = 2 for activity RDCH
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 STATUS 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
508
Power Flow RAWDX
1.1.223. RAWDX
Use this API to replicate the working case in the form of an extended power flow raw data file.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_RAWDX SID ALL STATUS(1)..STATUS(6) OUT OFILE
Python command syntax:
ierr = rawdx(sid, all, status, out, ofile)
Fortran command syntax:
CALL RAWDXAPI(SID, ALL, STATUS, 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 buses in subsystem SID
ALL = 1 process all buses when STATUS(4) = 0; area
ties only when STATUS(4) = 1
Integer STATUS (6) array of 6 elements specifying options(input).
STATUS(1) include records for Type 4 buses (1 by de-
fault)
STATUS(1) = 0 no
STATUS(1) = 1 yes
STATUS(2) include records for out-of-service branches
(1 by default)
STATUS(2) = 0 no
STATUS(2) = 1 yes
STATUS(3) include records for equipment in the subsys-
tem (1 by default)
STATUS(3) = 0 no
STATUS(3) = 1 yes
STATUS(4) include records for subsystem ties (0 by de-
fault)
STATUS(4) = 0 no
STATUS(4) = 1 yes
STATUS(5) include load record option (honored when
ALL=0) (0 by default)
STATUS(5) = 0 for all loads at subsystem buses
STATUS(5) = 1 for subsystem loads at all buses
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
509
Power Flow RAWDX
STATUS(5) = 2 for all loads at subsystem buses and subsys-
tem loads at non-subsystem buses
STATUS(6) Raw Data File type (0 by default)
STATUS(6) = 0 for activity READX with IC=0
STATUS(6) = 1 for activity READX with IC=1
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 STATUS 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
510
Power Flow RAWD_2
1.1.224. RAWD_2
Use this API to replicate the working case in the form of a power flow raw data file.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_RAWD_2 SID ALL STATUS(1)..STATUS(7) OUT OFILE
Python command syntax:
ierr = rawd_2(sid, all, status, out, ofile)
Fortran command syntax:
CALL RAWDAPI_2(SID, ALL, STATUS, 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 buses in subsystem SID
ALL = 1 process all buses when STATUS(4) = 0; only
area tie branches when STATUS(4) = 1
Integer STATUS (7) array of 7 elements specifying options(input).
STATUS(1) include records for Type 4 buses (1 by de-
fault)
STATUS(1) = 0 no
STATUS(1) = 1 yes
STATUS(2) include records for out-of-service branches
(1 by default)
STATUS(2) = 0 no
STATUS(2) = 1 yes
STATUS(3) include records for equipment in the subsys-
tem (1 by default)
STATUS(3) = 0 no
STATUS(3) = 1 yes
STATUS(4) include records for subsystem tie branches (0
by default)
STATUS(4) = 0 no
STATUS(4) = 1 yes
STATUS(5) include load record option (honored when
ALL=0) (0 by default)
STATUS(5) = 0 for all loads at subsystem buses
STATUS(5) = 1 for subsystem loads at all buses
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
511
Power Flow RAWD_2
STATUS(5) = 2 for all loads at subsystem buses and subsys-
tem loads at non-subsystem buses
STATUS(6) use bus names as bus identifiers (0 by de-
fault)
STATUS(6) = 0 no
STATUS(6) = 1 yes
STATUS(7) Raw Data File type (0 by default)
STATUS(7) = 0 for activity READ with IC=0
STATUS(7) = 1 for activity READ with IC=1
STATUS(7) = 2 for activity RDCH; include all data categories
STATUS(7) = 3 for activity RDCH; exclude the substation da-
ta category
STATUS(7) = 4 for activity RDCH; include only the substation
data category
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 STATUS 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
512
Power Flow RAWX_TO_CSV
1.1.225. RAWX_TO_CSV
Use this API to export rawx (extended raw data) table to a CSV (comma-separated values) file.
This API routine was first introduced in release 35.1.0.
Batch command syntax:
BAT_RAWX_TO_CSV
Python command syntax:
ierr = rawx_to_csv(tblname, ofile)
Fortran command syntax:
CALL RAWX_TO_CSV(TBLNAME, OFILE, IERR)
Where:
Character*100 TBLNAME name of the data table to export (not case sensitive) (input; no de-
fault allowed).
Character*260 OFILE file path of the CSV output file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid tblname
IERR = 2 error opening OFILE
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
513
Power Flow RDCH
1.1.226. RDCH
Use this API to read power flow change data into the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RDCH NUMNAM IFILE
Python command syntax:
ierr = rdch(numnam, ifile)
Fortran command syntax:
CALL RDCHAPI(NUMNAM, IFILE, IERR)
Where:
Integer NUMNAM flag for bus number or name specification on records (input; 0 by de-
fault).
NUMNAM = 0 bus numbers
NUMNAM = 1 bus names
Character*260 IFILE name of power flow data file, Options (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid NUMNAM
IERR = 10 error opening IFILE
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
514
Power Flow RDCHRAWVERSION
1.1.227. RDCHRAWVERSION
Use this API to read a Power Flow Change Raw Data File into the working case. Allowed raw file formats are
PSSE-15 through current format.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_RDCHRAWVERSION NUMNAM VERNUM IFILE
Python command syntax:
ierr = rdchrawversion(numnam, vernum, ifile)
Fortran command syntax:
CALL RDCHRAWVERSION(NUMNAM, VERNUM, IFILE, IERR)
Where:
Integer NUMNAM flag for bus number or name specification on records (input; 0 by de-
fault).
NUMNAM = 0 bus numbers
NUMNAM = 1 bus names
Character*14 VERNUM version number corresponding to the format of IFILE VERNUM is in
the format of a PSSE release number. Example: If IFILE format is of
PSSE-29.5.1: VERNUM = '29' or = '29.5' or = '29.5.1' (input; no default
allowed).
Character*260 IFILE name of power flow raw data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid NUMNAM value
IERR = 2 invalid VERNUM value
IERR = 3 unable to convert file
IERR = 4 error opening temporary file
IERR = 5 invalid revision number
IERR = 10 error opening IFILE
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
515
Power Flow RDEQ
1.1.228. RDEQ
Use this API to build an electrical equivalent of radial and, optionally, two-point Type 1 buses outside of a
specified subsystem of the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RDEQ SID ALL STATUS(1)..STATUS(8)
Python command syntax:
ierr = rdeq(sid, all, status)
Fortran command syntax:
CALL RDEQNW(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 = 0 process only buses outside of subsystem SID
ALL = 1 process all buses
Integer STATUS (8) array of 8 elements specifying 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
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
516
Power Flow RDEQ
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
517
Power Flow READ
1.1.229. READ
Use this API to read a power flow raw data file and add all the data specified in it to the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_READ NUMNAM IFILE
Python command syntax:
ierr = read(numnam, ifile)
Fortran command syntax:
CALL READAPI(NUMNAM, IFILE, IERR)
Where:
Integer NUMNAM flag for bus number or name specification on records (input; 0 by de-
fault).
NUMNAM = 0 bus numbers
NUMNAM = 1 bus names
Character*260 IFILE filename of the power flow raw data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid NUMNAM value
IERR = 2 invalid revision number
IERR = 3 unable to convert file
IERR = 4 error opening temporary file
IERR = 10 error opening IFILE
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
518
Power Flow READCAPCURVES
1.1.230. READCAPCURVES
Use this API to read data contained in a Machine Capability Curve Data File into the working case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_READCAPCURVES FILE
Python command syntax:
ierr = readcapcurves(file)
Fortran command syntax:
CALL READCAPCURVES(FILE, IERR)
Where:
Character*260 FILE filename of the Machine Capability Curve Data File (input; no default
allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 error opening FILE
IERR = 2 invalid revision 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
519
Power Flow READRAWVERSION
1.1.231. READRAWVERSION
Use this API to read a power flow raw data file and add all the data specified in it to the working case. Al-
lowed raw file formats are PSSE-15 through current format.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_READRAWVERSION NUMNAM VERNUM IFILE
Python command syntax:
ierr = readrawversion(numnam, vernum, ifile)
Fortran command syntax:
CALL READRAWVERSION(NUMNAM, VERNUM, IFILE, IERR)
Where:
Integer NUMNAM flag for bus number or name specification on records (input; 0 by de-
fault).
NUMNAM = 0 bus numbers
NUMNAM = 1 bus names
Character*14 VERNUM version number corresponding to the format of IFILE. VERNUM is in
the format of a PSSE release number. Example: If IFILE format is of
PSSE-29.5.1: VERNUM = '29' or = '29.5' or = '29.5.1' (input; no default
allowed).
Character*260 IFILE name of power flow raw data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid NUMNAM value
IERR = 2 invalid VERNUM value
IERR = 3 unable to convert file
IERR = 4 error opening temporary file
IERR = 5 invalid revision number
IERR = 10 error opening IFILE
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
520
Power Flow READSUB
1.1.232. READSUB
Use this API to read a power flow raw data file and add subsystem data specified in it to the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_READSUB NUMNAM IFILE STATUS(1) STATUS(2) STATUS(3) USEKV
BASEKV(1) BASEKV(2) SIDAREA SIDOWNER SIDZONE
Python command syntax:
ierr = readsub(numnam, ifile, status, usekv, basekv, sidarea, sidowner,
sidzone)
Fortran command syntax:
CALL READSUB(NUMNAM, IFILE, STATUS, USEKV, BASEKV, SIDAREA, SIDOWNER,
SIDZONE, IERR)
Where:
Integer NUMNAM flag for bus number or name specification on records (input; 0 by de-
fault).
NUMNAM = 0 bus numbers
NUMNAM = 1 bus names
Character*260 IFILE name of the power flow raw data file (input; no default allowed).
Integer STATUS (3) array of 3 elements specifying options(input).
STATUS(1) append flag (0 by default)
STATUS(1) = 0 initialize working case before reading data
STATUS(1) = 1 append data to that already in the working
case
STATUS(2) boundary bus identification flag (0 by de-
fault)
STATUS(2) = 0 do not change type codes of boundary buses
STATUS(2) = 1 change type codes of boundary buses in
preparation for the equivalencing calculation
STATUS(3) data option (1 by default)
STATUS(3) = 1 add only data from within subsystem
STATUS(3) = 2 add only ties from subsystem
STATUS(3) = 3 add subsystem data plus ties
Integer USEKV subsystem base voltage flag (input; 0 by default).
USEKV = 0 do not use base voltage as a subsystem selec-
tion criterion
USEKV = 1 use base voltage as a subsystem selection cri-
terion
Real BASEKV (2) array of 2 elements specifying the base voltage range(input).
BASEKV(1) minimum base voltage (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
521
Power Flow READSUB
BASEKV(2) maximum base voltage (BASEKV (1) by de-
fault)
Integer SIDAREA area subsystem identifier (0 through 11), or -1 to bypass subsystem
specification by area (input; -1).
Integer SIDOWNER owner subsystem identifier (0 through 11), or -1 to bypass subsystem
specification by owner (input; -1).
Integer SIDZONE zone subsystem identifier (0 through 11), or -1 to bypass subsystem
specification by zone (input; -1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid NUMNAM value
IERR = 2 invalid STATUS value
IERR = 3 invalid USEKV value
IERR = 4 invalid BASEKV value(s)
IERR = 5 BASEKV(1) is greater than BASEKV(2)
IERR = 6 invalid SIDAREA value or area subsystem SI-
DAREA is not defined
IERR = 7 invalid SIDOWNER value or owner subsystem
SIDOWNER is not defined
IERR = 8 invalid SIDZONE value or zone subsystem SID-
ZONE is not defined
IERR = 9 no subsystem specified
IERR = 10 error opening IFILE
IERR = 11 invalid revision number
IERR = 12 prerequisite requirements for API are not met
IERR = 14 unable to convert file
IERR = 15 error opening temporary file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
522
Power Flow READSUBRAWVERSION
1.1.233. READSUBRAWVERSION
Use this API to read a power flow raw data file and add subsystem data specified in it to the working case.
Allowed raw file formats are PSSE-15 through current format.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_READSUBRAWVERSION NUMNAM VERNUM IFILE STATUS(1) STATUS(2)
STATUS(3) USEKV BASEKV(1) BASEKV(2) SIDAREA SIDOWNER SIDZONE
Python command syntax:
ierr = readsubrawversion(numnam, vernum, ifile, status, usekv, basekv,
sidarea, sidowner, sidzone)
Fortran command syntax:
CALL READSUBRAWVERSION(NUMNAM, VERNUM, IFILE, STATUS, USEKV, BASEKV,
SIDAREA, SIDOWNER, SIDZONE, IERR)
Where:
Integer NUMNAM flag for bus number or name specification on records (input; 0 by de-
fault).
NUMNAM = 0 bus numbers
NUMNAM = 1 bus names
Character*14 VERNUM version number corresponding to the format of IFILE. VERNUM is in
the format of a PSSE release number. Example: If IFILE format is of
PSSE-29.5.1: VERNUM = '29' or = '29.5' or = '29.5.1' (input; no default
allowed).
Character*260 IFILE filename of the power flow raw data file (input; no default allowed).
Integer STATUS (3) array of 3 elements specifying options(input).
STATUS(1) append flag (0 by default)
STATUS(1) = 0 initialize working case before reading data
STATUS(1) = 1 append data to that already in the working
case
STATUS(2) boundary bus identification flag (0 by de-
fault)
STATUS(2) = 0 do not change type codes of boundary buses
STATUS(2) = 1 change type codes of boundary buses in
preparation for the equivalencing calculation
STATUS(3) data option (1 by default)
STATUS(3) = 1 add only data from within subsystem
STATUS(3) = 2 add only ties from subsystem
STATUS(3) = 3 add subsystem data plus ties
Integer USEKV subsystem base voltage flag (input; 0 by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
523
Power Flow READSUBRAWVERSION
USEKV = 0 do not use base voltage as a subsystem selec-
tion criterion
USEKV = 1 use base voltage as a subsystem selection cri-
terion
Real BASEKV (2) array of 2 elements specifying the base voltage range(input).
BASEKV(1) minimum base voltage (0.0 by default)
BASEKV(2) maximum base voltage (BASEKV (1) by de-
fault)
Integer SIDAREA area subsystem identifier (0 through 11), or -1 to bypass subsystem
specification by area (input; -1).
Integer SIDOWNER owner subsystem identifier (0 through 11), or -1 to bypass subsystem
specification by owner (input; -1).
Integer SIDZONE zone subsystem identifier (0 through 11), or -1 to bypass subsystem
specification by zone (input; -1).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid NUMNAM value
IERR = 2 invalid STATUS value
IERR = 3 invalid USEKV value
IERR = 4 invalid BASEKV value(s)
IERR = 5 BASEKV(1) is greater than BASEKV(2)
IERR = 6 invalid SIDAREA value or area subsystem SI-
DAREA is not defined
IERR = 7 invalid SIDOWNER value or owner subsystem
SIDOWNER is not defined
IERR = 8 invalid SIDZONE value or zone subsystem SID-
ZONE is not defined
IERR = 9 no subsystem specified
IERR = 10 error opening IFILE
IERR = 11 invalid revision number
IERR = 12 prerequisite requirements for API are not met
IERR = 13 invalid VERNUM value
IERR = 14 unable to convert file
IERR = 15 error opening temporary file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
524
Power Flow READVDFROMRAWX
1.1.234. READVDFROMRAWX
Use this API to read voltage droop controls defined in Rawx file as user defined data into working case.
This API routine was first introduced in release 35.3.0.
Batch command syntax:
BAT_READVDFROMRAWX OPTION
Python command syntax:
ierr = readvdfromrawx(option)
Fortran command syntax:
CALL READVDFROMRAWX(OPTION, IERR)
Where:
Integer OPTION 1 to append voltage droop controls in Rawx file to existing voltage
droop controls, 0 to delete all existing voltage droop controls (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTION value
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
525
Power Flow READX
1.1.235. READX
Use this API to read an extended power flow raw data file and add all the data specified in it to the working
case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_READX SFILE
Python command syntax:
ierr = readx(sfile)
Fortran command syntax:
CALL READXAPI(SFILE, IERR)
Where:
Character*260 SFILE filename of the extended power flow raw data file (input; no default
allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid revision number
IERR = 2 unable to convert file
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
526
Power Flow RECN
1.1.236. RECN
Use this API to electrically reconnect a bus.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RECN IBUS
Python command syntax:
ierr = recn(ibus)
Fortran command syntax:
CALL RECNAPI(IBUS, IERR)
Where:
Integer IBUS bus number of bus to be reconnected (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 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
527
Power Flow REGB
1.1.237. REGB
Use this API to tabulate those buses where voltages are controlled by generation, switched shunts, and/or
other voltage controlling equipment.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_REGB SID ALL
Python command syntax:
ierr = regb(sid, all)
Fortran command syntax:
CALL REGBNW(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
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
528
Power Flow RELIND
1.1.238. RELIND
This API routine is obsolete. It has been replaced by the API routine relind_2 .
Use this API to run probabilistic reliability assessment for transmission systems. Probabilistic indices on sys-
tem problems are calculated in entire system or a given subsystem, these problems include flow overload-
ing, voltage violation and loss of load, etc.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_RELIND OPTIONS(1)..OPTIONS(7) VALUES(1)..VALUES(3) LABEL ACCFILE
DFXFILE PRBFILE STSFILE
Python command syntax:
ierr = relind(options, values, label, accfile, dfxfile, prbfile, stsfile)
Fortran command syntax:
CALL RELINDAPI(OPTIONS, VALUES, LABEL, ACCFILE, DFXFILE, PRBFILE, STSFILE,
IERR)
Where:
Integer OPTIONS (7) array of 7 elements specifying options(input).
OPTIONS(1) report format (1 by default)
OPTIONS(1) = 1 system problem summary report
OPTIONS(1) = 2 system loss of load report
OPTIONS(1) = 3 bus loss of load report
OPTIONS(1) = 4 branch flow overloading report
OPTIONS(1) = 5 bus voltage violation report
OPTIONS(1) = 6 contingency summary
OPTIONS(1) = 7 system problem indices
OPTIONS(1) = 8 system loss of load indices
OPTIONS(1) = 9 bus loss of load indices
OPTIONS(1) = 10 branch overload problem indices
OPTIONS(1) = 11 bus voltage problem indices
OPTIONS(1) = 12 contingency summary with outage statistics
OPTIONS(2) mode (1 by default)
OPTIONS(2) = 1 post contingency mode
OPTIONS(2) = 2 post tripping mode
OPTIONS(2) = 3 post corrective action mode
OPTIONS(3) rating set (rating set program option setting
by default)
OPTIONS(3) = 1 RATEA
OPTIONS(3) = 2 RATEB
OPTIONS(3) = 3 RATEC
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
529
Power Flow RELIND
OPTIONS(4) include ties from study subsystem (0 by de-
fault)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) include interfaces (0 by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(6) Outage Statistics Data File (0 by default)
OPTIONS(6) = 0 disable
OPTIONS(6) = 1 enable
OPTIONS(7) normalize probability (0 by default)
OPTIONS(7) = 0 disable
OPTIONS(7) = 1 enable
Real VALUES (3) array of 3 elements specifying reliability assessment
parameters(input).
VALUES(1) percent of rating set (>=0 and <=200.0,
100.0 by default)
VALUES(2) probability cutoff (>=0; 0.0001 by default)
VALUES(3) frequency cutoff (>=0; 0.0001 by default)
Character*32 LABEL name of the study subsystem (input; blank by default, probabilistic
reliability assessment is carried out in entire system).
Character*260 ACCFILE contingency solution output file (input; no default allowed).
Character*260 DFXFILE DFAX data file (input; no default allowed).
Character*260 PRBFILE outage statistics data file (input; blank for none if OPTIONS(1) is
between 1 and 6, inclusive; no default allowed if OPTIONS(1) is
greater).
Character*260 STSFILE output outage statistics data file (input; blank for none if OPTIONS(6)
is zero or OPTIONS(1) is from 1 to 6; otherwise no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid OPTIONS value
IERR = 2 no dispatch subsystem specified
IERR = 3 no Contingency Solution Output File specified
IERR = 4 no Distribution Factor Data File specified
IERR = 5 no Outage Statistic Data File specified
IERR = 6 no Output Outage Statistic Data File specified
IERR = 7 generators are converted
IERR = 8 buses in island(s) without a swing bus--use
activity TREE
IERR = 9 subsystem not found in Distribution Factor
Data File
IERR = 10 Contingency Solution Output File is not creat-
ed by Multiple Level Contingency Analysis of
PSSE 31 or later
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
530
Power Flow RELIND
IERR = 11 case data is not the one used in contingency
analysis
IERR = 12 Distribution Factor Data File is not the one
used in contingency analysis
IERR = 13 error reading Contingency Solution Output
file
IERR = 51 error opening Contingency Solution Output
File
IERR = 52 error opening Distribution Factor Data File
IERR = 53 error opening Outage Statistic Data File
IERR = 54 error opening Output Outage Statistic Data
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
531
Power Flow RELIND_2
1.1.239. RELIND_2
Use this API to run probabilistic reliability assessment for transmission systems. Probabilistic indices on sys-
tem problems are calculated in entire system or a given subsystem, these problems include flow overload-
ing, voltage violation and loss of load, etc.
This API routine was first introduced in release 33.2.0.
Batch command syntax:
BAT_RELIND_2 OPTREL(1)..OPTREL(8) RELREL(1)..RELREL(3) CHAARG ACCFILE
DFXFILE PRBFILE STSFILE
Python command syntax:
ierr = relind_2(optrel, relrel, chaarg, accfile, dfxfile, prbfile,
stsfile)
Fortran command syntax:
CALL RELINDAPI_2(OPTREL, RELREL, CHAARG, ACCFILE, DFXFILE, PRBFILE,
STSFILE, IERR)
Where:
Integer OPTREL (8) array of elements specifying output options(input).
OPTREL(1) report format (1 by default)
OPTREL(1) = 1 system problem summary report
OPTREL(1) = 2 system loss of load report
OPTREL(1) = 3 bus loss of load report
OPTREL(1) = 4 branch flow overloading report
OPTREL(1) = 5 bus voltage violation report
OPTREL(1) = 6 contingency summary
OPTREL(1) = 7 system problem indices
OPTREL(1) = 8 system loss of load indices
OPTREL(1) = 9 bus loss of load indices
OPTREL(1) = 10 branch overload problem indices
OPTREL(1) = 11 bus voltage problem indices
OPTREL(1) = 12 contingency summary with outage statistics
OPTREL(2) output mode (1 by default)
OPTREL(2) = 1 post contingency mode
OPTREL(2) = 2 post tripping mode
OPTREL(2) = 3 post corrective action mode
OPTREL(3) rating set (rating set program option setting
by default)
OPTREL(3) = 1 RATEA
OPTREL(3) = 2 RATEB
OPTREL(3) = 3 RATEC
OPTREL(4) voltage limit.
OPTREL(4) = 1 normal
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
532
Power Flow RELIND_2
OPTREL(4) = 2 emergency
OPTREL(5) include ties from study subsystem (0 by de-
fault)
OPTREL(5) = 0 disable
OPTREL(5) = 1 enable
OPTREL(6) include interfaces (0 by default)
OPTREL(6) = 0 disable
OPTREL(6) = 1 enable
OPTREL(7) output Outage Statistics Data File (0 by de-
fault)
OPTREL(7) = 0 disable
OPTREL(7) = 1 enable
OPTREL(8) normalize probability (0 by default)
OPTREL(8) = 0 disable
OPTREL(8) = 1 enable
Real RELREL (3) array of elements specifying reliability assessment parameters(input).
RELREL(1) percent of rating set, (>=0 and <=200.0,
100.0 by default)
RELREL(2) probability cutoff (>=0; 0.0001 by default).
RELREL(3) frequency cutoff (>=0; 0.0001 by default).
Character*32 CHAARG name of the study subsystem (blank by default, probabilistic reliabili-
ty assessment is carried out in entire system). (input).
Character*260 ACCFILE contingency solution output file (input; no default allowed).
Character*260 DFXFILE DFAX data file (input; no default allowed).
Character*260 PRBFILE outage statistics data file (blank for none if OPTIONS(1) is between 1
and 6, inclusive; no default allowed if OPTIONS(1) is greater). (input).
Character*260 STSFILE output outage statistics data file (blank for none if OPTIONS(6) is ze-
ro or OPTIONS(1) is from 1 to 6; otherwise no default allowed). (in-
put).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 no dispatch subsystem specified
IERR = 3 no contingency solution output file specified
IERR = 4 no DFAX data file specified
IERR = 5 no outage statistic data file specified
IERR = 6 no output outage statistic data file specified
IERR = 7 generators are converted
IERR = 8 buses in island(s) without a swing bus; use
activity TREE
IERR = 9 subsystem not found in DFAX data file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
533
Power Flow RELIND_2
IERR = 10 contingency solution output file is not creat-
ed by Multiple Level Contingency Analysis of
PSSE 31 or later
IERR = 11 case data is not the one used in contingency
analysis
IERR = 12 DFAX data file is not the one used in contin-
gency analysis
IERR = 13 error reading contingency solution output file
IERR = 51 error opening contingency solution output
file
IERR = 52 error opening DFAX data file
IERR = 53 error opening outage statistic data file
IERR = 54 error opening output outage statistic data 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
534
Power Flow REMM
1.1.240. REMM
Use this API to read transaction event data from a transactions raw data file and add it to PSSE working
memory.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_REMM OPT IFILE
Python command syntax:
ierr = remm(opt, ifile)
Fortran command syntax:
CALL REMMAPI(OPT, IFILE, IERR)
Where:
Integer OPT flag for new or change data records (input; 0 by default).
OPT = 0 new data; replaces existing transactions data.
OPT = 1 change data; modifies existing transactions
data.
Character*260 IFILE name of transactions raw data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPT value
IERR = 2 no transactions defined; change mode invalid
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
535
Power Flow REPORT_OUTPUT
1.1.241. REPORT_OUTPUT
Use this API to specify the report output device.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_REPORT_OUTPUT ISLCT FILARG OPTIONS(1) OPTIONS(2)
Python command syntax:
ierr = report_output(islct, filarg, options)
Fortran command syntax:
CALL OPENREPORTDEVICE(ISLCT, FILARG, OPTIONS, IERR)
Where:
Integer ISLCT virtual device selector (input).
ISLCT = 1 standard destination. In the PSSE GUI stan-
dard output for reports is the Report 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
536
Power Flow RESQ
1.1.242. RESQ
Use this API to read sequence data from a sequence data file and add it to the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RESQ IFILE
Python command syntax:
ierr = resq(ifile)
Fortran command syntax:
CALL RESQAPI(IFILE, IERR)
Where:
Character*260 IFILE name of the power flow sequence data file (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 error opening IFILE
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
537
Power Flow RESQVERSION
1.1.243. RESQVERSION
Use this API to read a network sequence data file and add all the data specified in it to the working case.
Allowed seq file formats are PSSE-15 through the current format.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_RESQVERSION VERNUM IFILE
Python command syntax:
ierr = resqversion(vernum, ifile)
Fortran command syntax:
CALL RESQVERSION(VERNUM, IFILE, IERR)
Where:
Character*14 VERNUM version number corresponding to the format of the IFILE. VERNUM is
in the format of a PSSE release number. Example: If IFILE format is of
PSSE-29.5.1: VERNUM = '29' or = '29.5' or = '29.5.1' (input; no default
allowed).
Character*260 IFILE name of the power flow sequence data file (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 2 invalid VERNUM value
IERR = 3 unable to convert file
IERR = 4 error opening temporary file
IERR = 5 invalid revision number
IERR = 10 error opening IFILE
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
538
Power Flow RESULT_TABLE_OUTPUT
1.1.244. RESULT_TABLE_OUTPUT
Use this API to the result table output option.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_RESULT_TABLE_OUTPUT IVAL
Python command syntax:
ierr = result_table_output(ival)
ierr, ival = result_table_output()
Fortran command syntax:
CALL RESULT_TABLE_OUTPUT(IVAL, ICODE, IERR)
Where:
Integer IVAL option setting (input; no default allowed).
IVAL = 0 no result table output
IVAL = 1 text result table output only
IVAL = 2 spreadsheet result table output only
IVAL = 3 both text and spreadsheet table output
Integer ICODE operation mode of the API (no default allowed).
ICODE = 0 set the option setting to the value specified in
IVAL
ICODE = 1 return the current value of the option setting
in IVAL
Integer IERR error code (output).
IERR = 0 no error
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
539
Power Flow RETI
1.1.245. RETI
Use this API to read the long title from an input file into the working case.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_RETI IFILE
Python command syntax:
ierr = reti(ifile)
Fortran command syntax:
CALL RETIAPI(IFILE, IERR)
Where:
Character*260 IFILE name of long title data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 error opening IFILE
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
540
Power Flow RETRY_PSSUSERPF
1.1.246. RETRY_PSSUSERPF
Use this API to allow the loading or use of the Powerflow Customization Interface (PCI) implementation
module (pssuserpf) after a failure.
For efficiency reasons loading the PCI module is only attempted once. You may reset the flag controlling
this with this API.
This API routine was first introduced in release 33.8.0.
Batch command syntax:
BAT_RETRY_PSSUSERPF
Python command syntax:
ierr = retry_pssuserpf()
Fortran command syntax:
CALL RETRYPSSUSERPF_FC(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
541
Power Flow REV29_NAMES
1.1.247. REV29_NAMES
Use this API to set the extended bus name input format to either the PSSE-29 or PSSE-30 format.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_REV29_NAMES IVAL
Python command syntax:
ierr = rev29_names(ival)
Fortran command syntax:
CALL REV29_NAMES_API(IVAL, IERR)
Where:
Integer IVAL extended bus name option flag (input; 0 by default).
IVAL = 0 PSSE-30 format (12 characters plus base volt-
age)
IVAL = 1 PSSE-29 or earlier format (8 characters plus
base voltage)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL 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
542
Power Flow RNFI
1.1.248. RNFI
Use this API to reproduce the results of a working case bus renumbering operation in auxiliary data input
files.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_RNFI FTYPE TRNFILE INPFILE OUTFILE
Python command syntax:
ierr = rnfi(ftype, trnfile, inpfile, outfile)
Fortran command syntax:
CALL RNFIAPI(FTYPE, TRNFILE, INPFILE, OUTFILE, IERR)
Where:
Integer FTYPE type of data file to be processed (input; 1 by default).
FTYPE = 1 sequence data file
FTYPE = 2 drawing coordinate data file
FTYPE = 3 dynamics data file
FTYPE = 4 machine impedance data file
FTYPE = 5 economic dispatch data file
FTYPE = 6 inertia and governor response data file
FTYPE = 7 breaker duty data file
FTYPE = 8 fault dspecification data file
FTYPE = 9 fault control data file
FTYPE = 10 machine capability Curve data file
FTYPE = 11 load throwover data file
FTYPE = 12 ANSI fault specification data file
FTYPE = 13 subsystem description data file
FTYPE = 14 monitored element data file
FTYPE = 15 contingency description data file
FTYPE = 16 tripping element data file
Character*260 TRNFILE name of bus renumbering translation file (input; no default allowed).
Character*260 INPFILE name of data file to be renumbered (input; no default allowed).
Character*260 OUTFILE name of data file (blank for output to the report window) (input;
blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid FTYPE value
IERR = 2 error opening translation file
IERR = 3 error opening input data file
IERR = 4 error opening output data file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
543
Power Flow RNFI
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
544
Power Flow RSOL
1.1.249. RSOL
Use this API to perform a robust power flow solution (activity RSOL).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_RSOL OPTIONS(1)...OPTIONS(10) REALAR(1)...REALAR(2)
Python command syntax:
ierr = rsol(options, realar)
Fortran command syntax:
CALL RSOLAPI(OPTIONS, REALAR, IERR)
Where:
Integer OPTIONS (10) array of 10 elements specifying (input).
OPTIONS(1) Initial solution method (0 by default)
OPTIONS(1) = 0 Fixed Slope Decoupled Newton-Raphson (FD-
NS)
OPTIONS(1) = 1 Full Newton-Raphson (FNSL)
OPTIONS(1) = 2 Decoupled Newton-Raphson (NSOL)
OPTIONS(2) Initial tap adjustment flag (0 by default)
OPTIONS(2) = 0 disable
OPTIONS(2) = 1 enable stepping adjustment
OPTIONS(2) = 2 enable direct adjustment
OPTIONS(3) Initial area interchange adjustment flag (0 by
default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable using tie line flows only in calculating
area interchange
OPTIONS(3) = 2 enable using tie line flows and loads in calcu-
lating area interchange
OPTIONS(4) Initial phase shift adjustment flag (0 by de-
fault)
OPTIONS(4) = 0 disable
OPTIONS(4) = 1 enable
OPTIONS(5) Initial dc tap adjustment flag (0 by default)
OPTIONS(5) = 0 disable
OPTIONS(5) = 1 enable
OPTIONS(6) Initial switch shunt adjustment flag (0 by de-
fault)
OPTIONS(6) = 0 disable
OPTIONS(6) = 1 enable
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
545
Power Flow RSOL
OPTIONS(6) = 2 enable continuous mode, disable discrete
mode
OPTIONS(7) Initial flat start flag (0 by default)
OPTIONS(7) = 0 do not flat start
OPTIONS(7) = 1 flat start
OPTIONS(7) = 2 flat start, then estimate voltage magnitudes
OPTIONS(7) = 3 flat start, then estimate voltage phase angles
OPTIONS(7) = 4 flat start, then estimate voltage magnitudes
and phase angles
OPTIONS(8) Initial var limit flag (0 by default)
OPTIONS(8) = 0 apply var limits immediately
OPTIONS(8) > 0 apply var limits on iteration n (or sooner if
mismatch gets small)
OPTIONS(8) = -1 ignore var limits
OPTIONS(9) Initial non-divergent flag (0 by default)
OPTIONS(9) = 0 disable
OPTIONS(9) = 1 enable
OPTIONS(10) Solution failure option (0 by default)
OPTIONS(10) = 0 do not restore solution or settings on solu-
tion failure
OPTIONS(10) = 1 restore original solution and settings on solu-
tion failure
OPTIONS(10) = 2 restore best found (lowest mismatch) solu-
tion and settings on solution failure
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) Bus mismatch threshold for smoothing
(200.0 by default)
REALAR(2) Var band (0.4 by default)
Integer IERR error code (output).
IERR = 0 No error occurred
IERR = 1 Prerequisites for api not met
IERR = 2 Invalid OPTIONS value
IERR = 3 Invalid realar value
IERR = 4 Solution error occured
IERR = 5 Error getting mismatch
IERR = 6 Error creating temporary case files
IERR = 7 Error reading from temporary case files
IERR = 8 Error writing to temporary case files
IERR = 9 Error deleting temporary case files
IERR = 10 Error creating script file
IERR = 11 Error writing to script file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
546
Power Flow RUNLASTSOLUTION
1.1.250. RUNLASTSOLUTION
Use this API to run the last known power flow solution. A power flow solution is 'know' if the solution
method and parameters are contained within the SAV or RAW file. It is useful for solving a case from an
outside source for which there is no documentation on solution methods.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_RUNLASTSOLUTION
Python command syntax:
ierr = runlastsolution()
Fortran command syntax:
CALL RUNLASTSOLUTION(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
547
Power Flow RWCM
1.1.251. RWCM
Use this API to replicate the working case in IEEE common tape format.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RWCM OPT OUT OFILE
Python command syntax:
ierr = rwcm(opt, out, ofile)
Fortran command syntax:
CALL RWCMAPI(OPT, OUT, OFILE, IERR)
Where:
Integer OPT dc line/FACTS/GNE device option (input; 0 by default).
OPT = 0 ignore dc lines, FACTS devices, and GNE de-
vices
OPT = 1 add powers to loads
Integer OUT selection option (input; 1 by default).
OUT = 0 direct output to the data file specified by
OFILE
OUT = 1 direct output to the current report device
Character*260 OFILE name of the output file (when OUT is 0) (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPT value
IERR = 2 invalid OUT value
IERR = 3 buses in case with 5 or 6 digit bus numbers
IERR = 4 n buses in case but IEEE common format can
handle only 9999
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
548
Power Flow RWMA
1.1.252. RWMA
Use this API to replicate machine parametric data from the working case in the form of a machine imped-
ance data file.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RWMA SID ALL STATUS(1) STATUS(2) STATUS(3) OUT OFILE
Python command syntax:
ierr = rwma(sid, all, status, out, ofile)
Fortran command syntax:
CALL RWMANW(SID, ALL, STATUS, 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 buses in subsystem SID
ALL = 1 process all buses
Integer STATUS (3) array of 3 elements specifying control options(input).
STATUS(1) include records for out-of-service machines
(0 by default)
STATUS(1) = 0 exclude them
STATUS(1) = 1 include them
STATUS(2) used when calculating P fractions (0 by de-
fault)
STATUS(2) = 0 use PGEN
STATUS(2) = 1 use MBASE
STATUS(2) = 2 use PMAX
STATUS(3) used when calculating Q fractions (0 by de-
fault)
STATUS(3) = 0 use QGEN
STATUS(3) = 1 use MBASE
STATUS(3) = 2 use QMAX
Integer OUT option 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 output filename (when OUT is 0) (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
549
Power Flow RWMA
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 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
550
Power Flow RWMM
1.1.253. RWMM
Use this API to replicate transaction event data in the form of a transactions data file.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RWMM OUT OFILE
Python command syntax:
ierr = rwmm(out, ofile)
Fortran command syntax:
CALL RWMMAPI(OUT, OFILE, IERR)
Where:
Integer OUT selection option (input; 1 by default).
OUT = 0 direct output to the 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 occurred
IERR = 1 invalid OUT value
IERR = 2 error opening OFILE
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
551
Power Flow RWSQ
1.1.254. RWSQ
This API routine is obsolete. It has been replaced by the API routine rwsq_2 .
Use this API to replicate the sequence data contained in the working case in the form of a sequence data
file.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RWSQ SID ALL STATUS(1)..STATUS(4) OUT OFILE
Python command syntax:
ierr = rwsq(sid, all, status, out, ofile)
Fortran command syntax:
CALL RWSQNW(SID, ALL, STATUS, 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 buses in subsystem SID
ALL = 1 process all buses when STATUS(4) is 0; area
ties only when STATUS(4) is 1
Integer STATUS (4) array of 4 elements specifying options(input).
STATUS(1) include records for Type 4 buses (1 by de-
fault)
STATUS(1) = 0 no
STATUS(1) = 1 yes
STATUS(2) include records for out-of-service branches
(1 by default)
STATUS(2) = 0 no
STATUS(2) = 1 yes
STATUS(3) include records for equipment in the subsys-
tem (1 by default)
STATUS(3) = 0 no
STATUS(3) = 1 yes
STATUS(4) include records for subsystem ties (0 by de-
fault)
STATUS(4) = 0 no
STATUS(4) = 1 yes
Integer OUT option selection (input; 1 by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
552
Power Flow RWSQ
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 STATUS 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
553
Power Flow RWSQ_2
1.1.255. RWSQ_2
Use this API to replicate the sequence data contained in the working case in the form of a sequence data
file.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_RWSQ_2 SID ALL STATUS(1)..STATUS(5) OUT OFILE
Python command syntax:
ierr = rwsq_2(sid, all, status, out, ofile)
Fortran command syntax:
CALL RWSQNW_2(SID, ALL, STATUS, 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 buses in subsystem SID
ALL = 1 process all buses when STATUS(4) is 0; area
ties only when STATUS(4) is 1
Integer STATUS (5) array of 5 elements specifying options(input).
STATUS(1) include records for Type 4 buses (1 by de-
fault)
STATUS(1) = 0 no
STATUS(1) = 1 yes
STATUS(2) include records for out-of-service branches
(1 by default)
STATUS(2) = 0 no
STATUS(2) = 1 yes
STATUS(3) include records for equipment in the subsys-
tem (1 by default)
STATUS(3) = 0 no
STATUS(3) = 1 yes
STATUS(4) include records for subsystem ties (0 by de-
fault)
STATUS(4) = 0 no
STATUS(4) = 1 yes
STATUS(5) sequence data file type (0 by default)
STATUS(5) = 0 for activity RESQ with IC=0
STATUS(5) = 1 for activity RESQ with IC=1
Integer OUT option selection (input; 1 by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
554
Power Flow RWSQ_2
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 STATUS 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
555
Power Flow SAVE
1.1.256. SAVE
Use this API to save the PSSE working case in a saved case file.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SAVE SFILE
Python command syntax:
ierr = save(sfile)
Fortran command syntax:
CALL SAVENW(SFILE, IERR)
Where:
Character*260 SFILE name of the PSSE saved case file If SFILE is "*", SAVENW attempts to
use the most recently accessed Saved Case File. If no Saved Case File
was accessed in the current execution of PSSE, SAVENW 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 writing to 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
556
Power Flow SCAL
1.1.257. SCAL
This API routine is obsolete. It has been replaced by the API routine scal_4 .
Use this API to uniformly increase or decrease any or all specified bus quantities for a specified group of
buses (activity SCAL). It must be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by one reference with APIOPT=2.
- One reference with APIOPT=0. This automatically combines the processing of one APIOPT 1 reference, fol-
lowed by one APIOPT 2 reference.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SCAL SID ALL APIOPT STATUS(1)..STATUS(4) SCALVAL(1)..SCALVAL(7)
Python command syntax:
ierr, totals, moto = scal(sid, all, apiopt, status, scalval)
Fortran command syntax:
CALL SCALNW(SID, ALL, APIOPT, TOTALS, MOTO, STATUS, SCALVAL, 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 APIOPT mode of operation in the API (input; 0 by default).
APIOPT = 0 initialize for scaling, then run the scaling and
post-processing housekeeping.
APIOPT = 1 initialize for scaling.
APIOPT = 2 run the scaling and post-processing house-
keeping.
Real TOTALS (11) array of 11 elements specifying returned when APIOPT = 0 or 1. They
are as follows(output).
TOTALS(1) load Mvar total
TOTALS(2) load MW total
TOTALS(3) generation MW total
TOTALS(4) shunt MW total
TOTALS(5) reactor Mvar total
TOTALS(6) capacitor Mvar total
TOTALS(7) motor load MW total
TOTALS(8) generator PMAX
TOTALS(9) generator PMIN
TOTALS(10) motor load PMIN
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
557
Power Flow SCAL
TOTALS(11) motor load PMAX
Integer MOTO returned when APIOPT = 0 or 1 (output).
MOTO = 0 no motors in the specified subsystem.
MOTO = 1 motors present in the specified subsystem.
Integer STATUS (4) array of 4 elements specifying that are used to control scaling. The
first three elements are checked and used when APIOPT = 0 or 2; the
fourth element is checked and saved when APIOPT = 0 or 1. They are
as follows(input).
STATUS(1) method used to scale active power load, gen-
eration and motor data, and bus shunt data
(0 by default)
STATUS(1) = 0 no scaling
STATUS(1) = 1 specify new total powers
STATUS(1) = 2 specify percent changes
STATUS(1) = 3 specify incremental powers
STATUS(2) flag to enforce machine power limits (0 by
default)
STATUS(2) = 0 ignore machine power limits
STATUS(2) = 1 enforce machine power limits
STATUS(3) flag to specify the scaling rule to be enforced
when changing the reactive power load (0 by
default)
STATUS(3) = 0 no change
STATUS(3) = 1 constant P/Q ratio
STATUS(3) = 2 new total Q load
STATUS(3) = 3 percent change
STATUS(3) = 4 new power factor
STATUS(3) = 5 incremental Q load
STATUS(4) bus type code flag for load scaling; normally
defaulted except when used by OPF (0 by de-
fault)
STATUS(4) = 0 all buses in subsystem
STATUS(4) = 1 only Type 1 buses in subsystem
STATUS(4) = 2 only Type 2 and 3 buses in subsystem
Real SCALVAL (7) array of 7 elements specifying used as scaling targets. Based on
the value of STATUS(1), entries (1) through (6) are either total
powers(input).
SCALVAL(1) load MW total/percent/increment
SCALVAL(2) generation MW total/percent/increment
SCALVAL(3) shunt MW total/percent/increment
SCALVAL(4) reactor Mvar total/percent/increment
SCALVAL(5) capacitor Mvar total/percent/increment
SCALVAL(6) motor load MW total/percent/increment
SCALVAL(7) reactive load scaling parameter
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
558
Power Flow SCAL
If STATUS(3)
SCALVAL(7) = 2 new total Mvar load (present total Mvar load
by default)."
SCALVAL(7) = 3 percent change (0.0 by default)."
SCALVAL(7) = 4 new power factor (1.0 by default)."
SCALVAL(7) = 5 incremental Mvar load change (0.0 by de-
fault)."
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
559
Power Flow SCAL_2
1.1.258. SCAL_2
This API routine is obsolete. It has been replaced by the API routine scal_4 .
Use this API routine to uniformly increase or decrease any or all specified bus quantities for a specified
group of buses. It must be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by one reference with APIOPT=2.
- One reference with APIOPT=0. This automatically combines the processing of one APIOPT 1 reference, fol-
lowed by one APIOPT 2 reference.
This API routine was first introduced in release 33.1.0.
Batch command syntax:
BAT_SCAL_2 SID ALL APIOPT STATUS(1)..STATUS(5) SCALVAL(1)..SCALVAL(7)
Python command syntax:
ierr, totals, moto= scal_2(sid, all, apiopt, status, scalval)
Fortran command syntax:
CALL SCAL_2(SID, ALL, APIOPT, TOTALS, MOTO, STATUS, SCALVAL, 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 APIOPT mode of operation in the API (input; 0 by default).
APIOPT = 0 initialize for scaling, then run the scaling and
post-processing housekeeping.
APIOPT = 1 initialize for scaling.
APIOPT = 2 run the scaling and post-processing house-
keeping.
Real TOTALS (11) array of elements specifying returned when APIOPT = 0 or 1. They are
as follows.(output).
TOTALS(1) load Mvar total.
TOTALS(2) load MW total.
TOTALS(3) generation MW total.
TOTALS(4) shunt MW total.
TOTALS(5) reactor Mvar total.
TOTALS(6) capacitor Mvar total.
TOTALS(7) motor load MW total.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
560
Power Flow SCAL_2
TOTALS(8) generator PMAX.
TOTALS(9) generator PMIN.
TOTALS(10) motor load PMIN.
TOTALS(11) motor load PMAX.
Integer MOTO returned when APIOPT = 0 or 1. It indicates the presence of motors
that are modeled as conventional generators with negative active
power settings. (output).
MOTO = 0 no motors in the specified subsystem.
MOTO = 1 motors present in the specified subsystem.
Integer STATUS (5) array of elements specifying control scaling. The first and fifth el-
ements are checked and saved when APIOPT = 0 or 1; the second,
third and fourth elements are checked and used when APIOPT = 0 or
2. They are as follows.(input).
STATUS(1) interruptible load scaling option (0 by de-
fault)
STATUS(1) = 0 scale both interruptible and non-interruptible
scalable loads.
STATUS(1) = 1 scale only non-interruptible scalable loads.
STATUS(1) = 2 scale only interruptible scalable loads.
STATUS(2) method used to scale active power load, gen-
eration and motor data, and bus shunt data
(0 by default)
STATUS(2) = 0 no scaling.
STATUS(2) = 1 specify new total powers.
STATUS(2) = 2 specify percent changes.
STATUS(2) = 3 specify incremental powers.
STATUS(3) flag to enforce machine power limits (0 by
default)
STATUS(3) = 0 ignore machine power limits.
STATUS(3) = 1 enforce machine power limits.
STATUS(4) flag to specify the scaling rule to be enforced
when changing the reactive power load (0 by
default)
STATUS(4) = 0 no change.
STATUS(4) = 1 constant P/Q ratio.
STATUS(4) = 2 new total Q load.
STATUS(4) = 3 percent change.
STATUS(4) = 4 new power factor.
STATUS(4) = 5 incremental Q load.
STATUS(5) is the bus type code flag for load scaling; nor-
mally defaulted except when used by OPF (0
by default)
STATUS(5) = 0 all buses in subsystem.
STATUS(5) = 1 only Type 1 buses in subsystem.
STATUS(5) = 2 only Type 2 and 3 buses in subsystem.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
561
Power Flow SCAL_2
Real SCALVAL (7) array of elements specifying scaling targets. Based on the value of
STATUS(1), entries (1) through (6) are either total powers (present
total power by default), percent changes (0.0 by default), or incre-
mental changes (0.0 by default). If STATUS(4) = 2, SCALVAL(7) = new
total Mvar load (present total Mvar load by default). If STATUS(4) =
3, SCALVAL(7) = percent change (0.0 by default). If STATUS(4) = 4,
SCALVAL(7) = new power factor (1.0 by default). If STATUS(4) = 5,
SCALVAL(7) = incremental Mvar load change (0.0 by default).(input).
SCALVAL(1) load MW total/percent/increment.
SCALVAL(2) generation MW total/percent/increment.
SCALVAL(3) shunt MW total/percent/increment.
SCALVAL(4) reactor Mvar total/percent/increment.
SCALVAL(5) capacitor Mvar total/percent/increment.
SCALVAL(6) motor load MW total/percent/increment.
SCALVAL(7) reactive load scaling parameter.
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
562
Power Flow SCAL_3
1.1.259. SCAL_3
This API routine is obsolete. It has been replaced by the API routine scal_4 .
Use this API routine to uniformly increase or decrease any or all specified bus quantities for a specified
group of buses. It must be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by one reference with APIOPT=2.
- One reference with APIOPT=0. This automatically combines the processing of one APIOPT 1 reference, fol-
lowed by one APIOPT 2 reference.
This API routine was first introduced in release 35.1.0.
Batch command syntax:
BAT_SCAL_3 SID ALL APIOPT STATUS(1)..STATUS(5) SCALVAL(1)..SCALVAL(7)
Python command syntax:
ierr, totals, moto= scal_3(sid, all, apiopt, status, scalval)
Fortran command syntax:
CALL SCAL_3(SID, ALL, APIOPT, TOTALS, MOTO, STATUS, SCALVAL, 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 APIOPT mode of operation in the API (input; 0 by default).
APIOPT = 0 initialize for scaling, then run the scaling and
post-processing housekeeping.
APIOPT = 1 initialize for scaling.
APIOPT = 2 run the scaling and post-processing house-
keeping.
Real TOTALS (11) array of elements specifying returned when APIOPT = 0 or 1. They are
as follows.(output).
TOTALS(1) load Mvar total.
TOTALS(2) load MW total.
TOTALS(3) generation MW total.
TOTALS(4) shunt MW total.
TOTALS(5) reactor Mvar total.
TOTALS(6) capacitor Mvar total.
TOTALS(7) motor load MW total.
TOTALS(8) generator PMAX.
TOTALS(9) generator PMIN.
TOTALS(10) motor load PMIN.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
563
Power Flow SCAL_3
TOTALS(11) motor load PMAX.
Integer MOTO returned when APIOPT = 0 or 1. It indicates the presence of motors
that are modeled as conventional generators with negative active
power settings. (output).
MOTO = 0 no motors in the specified subsystem.
MOTO = 1 motors present in the specified subsystem.
Integer STATUS (5) array of elements specifying scaling options. The first and second ele-
ments are checked and saved when APIOPT = 0 or 1; the third, fourth
and fifth elements are checked and used when APIOPT = 0 or 2. They
are as follows.(input).
STATUS(1) interruptible load scaling option (0 by de-
fault)
STATUS(1) = 0 scale both interruptible and non-interruptible
loads.
STATUS(1) = 1 scale only non-interruptible loads.
STATUS(1) = 2 scale only interruptible loads.
STATUS(2) base loaded generation scaling option (0 by
default)
STATUS(2) = 0 scale all subsystem machines and ignore
their base load flags.
STATUS(2) = 1 scale all subsystem machines and honor their
base load flags.
STATUS(2) = 2 scale only non-base loaded subsystem ma-
chines.
STATUS(2) = 3 scale only base loaded subsystem machines
and ignore their base load flags.
STATUS(2) = 4 scale only base loaded subsystem machines
and honor their base load flags.
STATUS(3) method used to scale active power load, gen-
eration and motor data, and bus shunt data
(0 by default)
STATUS(3) = 0 no scaling.
STATUS(3) = 1 specify new total powers.
STATUS(3) = 2 specify percent changes.
STATUS(3) = 3 specify incremental powers.
STATUS(4) flag to enforce machine power limits (0 by
default)
STATUS(4) = 0 ignore machine power limits.
STATUS(4) = 1 enforce machine power limits.
STATUS(5) flag to specify the scaling rule to be enforced
when changing the reactive power load (0 by
default)
STATUS(5) = 0 no change.
STATUS(5) = 1 constant P/Q ratio.
STATUS(5) = 2 new total Q load.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
564
Power Flow SCAL_3
STATUS(5) = 3 percent change.
STATUS(5) = 4 new power factor.
STATUS(5) = 5 incremental Q load.
Real SCALVAL (7) array of elements specifying scaling targets. Based on the value of
STATUS(1), entries (1) through (6) are either total powers (present
total power by default), percent changes (0.0 by default), or incre-
mental changes (0.0 by default). If STATUS(5) = 2, SCALVAL(7) = new
total Mvar load (present total Mvar load by default). If STATUS(5) =
3, SCALVAL(7) = percent change (0.0 by default). If STATUS(5) = 4,
SCALVAL(7) = new power factor (1.0 by default). If STATUS(5) = 5,
SCALVAL(7) = incremental Mvar load change (0.0 by default).(input).
SCALVAL(1) load MW total/percent/increment.
SCALVAL(2) generation MW total/percent/increment.
SCALVAL(3) shunt MW total/percent/increment.
SCALVAL(4) reactor Mvar total/percent/increment.
SCALVAL(5) capacitor Mvar total/percent/increment.
SCALVAL(6) motor load MW total/percent/increment.
SCALVAL(7) reactive load scaling parameter.
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
565
Power Flow SCAL_4
1.1.260. SCAL_4
Use this API routine to uniformly increase or decrease any or all specified bus quantities for a specified
group of buses. It must be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by one reference with APIOPT=2.
- One reference with APIOPT=0. This automatically combines the processing of one APIOPT 1 reference, fol-
lowed by one APIOPT 2 reference.
This API routine was first introduced in release 35.2.0.
Batch command syntax:
BAT_SCAL_4 SID ALL APIOPT STATUS(1)..STATUS(6) SCALVAL(1)..SCALVAL(7)
Python command syntax:
ierr, totals, moto= scal_4(sid, all, apiopt, status, scalval)
Fortran command syntax:
CALL SCAL_4(SID, ALL, APIOPT, TOTALS, MOTO, STATUS, SCALVAL, 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 APIOPT mode of operation in the API (input; 0 by default).
APIOPT = 0 initialize for scaling, then run the scaling and
post-processing housekeeping.
APIOPT = 1 initialize for scaling.
APIOPT = 2 run the scaling and post-processing house-
keeping.
Real TOTALS (11) array of elements specifying returned when APIOPT = 0 or 1. They are
as follows.(output).
TOTALS(1) load Mvar total.
TOTALS(2) load MW total.
TOTALS(3) generation MW total.
TOTALS(4) shunt MW total.
TOTALS(5) reactor Mvar total.
TOTALS(6) capacitor Mvar total.
TOTALS(7) motor load MW total.
TOTALS(8) generator PMAX.
TOTALS(9) generator PMIN.
TOTALS(10) motor load PMIN.
TOTALS(11) motor load PMAX.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
566
Power Flow SCAL_4
Integer MOTO returned when APIOPT = 0 or 1. It indicates the presence of motors
that are modeled as conventional generators with negative active
power settings. (output).
MOTO = 0 no motors in the specified subsystem.
MOTO = 1 motors present in the specified subsystem.
Integer STATUS (6) array of elements specifying scaling options. The first, second and
third elements are checked and saved when APIOPT = 0 or 1; the
fourth, fifth and sixth elements are checked and used when APIOPT =
0 or 2. They are as follows.(input).
STATUS(1) interruptible load scaling option (0 by de-
fault)
STATUS(1) = 0 scale both interruptible and non-interruptible
loads.
STATUS(1) = 1 scale only non-interruptible loads.
STATUS(1) = 2 scale only interruptible loads.
STATUS(2) load component scaling opotion (0 by de-
fault)
STATUS(2) = 0 scale in-service net load
STATUS(2) = 1 scale only in-service load
STATUS(2) = 2 scale only in-servicve distributed generation
STATUS(3) base loaded generation scaling option (0 by
default)
STATUS(3) = 0 scale all subsystem machines and ignore
their base load flags.
STATUS(3) = 1 scale all subsystem machines and honor their
base load flags.
STATUS(3) = 2 scale only non-base loaded subsystem ma-
chines.
STATUS(3) = 3 scale only base loaded subsystem machines
and ignore their base load flags.
STATUS(3) = 4 scale only base loaded subsystem machines
and honor their base load flags.
STATUS(4) method used to scale active power load, gen-
eration and motor data, and bus shunt data
(0 by default)
STATUS(4) = 0 no scaling.
STATUS(4) = 1 specify new total powers.
STATUS(4) = 2 specify percent changes.
STATUS(4) = 3 specify incremental powers.
STATUS(5) flag to enforce machine power limits (0 by
default)
STATUS(5) = 0 ignore machine power limits.
STATUS(5) = 1 enforce machine power limits.
STATUS(6) flag to specify the scaling rule to be enforced
when changing the reactive power load (0 by
default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
567
Power Flow SCAL_4
STATUS(6) = 0 no change.
STATUS(6) = 1 constant P/Q ratio.
STATUS(6) = 2 new total Q load.
STATUS(6) = 3 percent change.
STATUS(6) = 4 new power factor.
STATUS(6) = 5 incremental Q load.
Real SCALVAL (7) array of elements specifying scaling targets. Based on the value of
STATUS(1), entries (1) through (6) are either total powers (present
total power by default), percent changes (0.0 by default), or incre-
mental changes (0.0 by default). If STATUS(5) = 2, SCALVAL(7) = new
total Mvar load (present total Mvar load by default). If STATUS(5) =
3, SCALVAL(7) = percent change (0.0 by default). If STATUS(5) = 4,
SCALVAL(7) = new power factor (1.0 by default). If STATUS(5) = 5,
SCALVAL(7) = incremental Mvar load change (0.0 by default).(input).
SCALVAL(1) load MW total/percent/increment.
SCALVAL(2) generation MW total/percent/increment.
SCALVAL(3) shunt MW total/percent/increment.
SCALVAL(4) reactor Mvar total/percent/increment.
SCALVAL(5) capacitor Mvar total/percent/increment.
SCALVAL(6) motor load MW total/percent/increment.
SCALVAL(7) reactive load scaling parameter.
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 invalid power factor in SCALVAL(7)
IERR = 7 generator or motor totals beyond limits
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
568
Power Flow SENSITIVITY_FLOW
1.1.261. SENSITIVITY_FLOW
This API is used to calculate sensitivity factors of a branch flow to MW power at buses, MW power at gener-
ator buses, MW at load buses, phase angle of phase shifters, tap postion of tap changing transformers as
well as admittance of switched shunts:
This API routine was first introduced in release 32.1.0.
Batch command syntax:
BAT_SENSITIVITY_FLOW FLWOPT(1) .. FLWOPT(5) OPTIONS(1) .. OPTIONS(9)
VALUES(1) VALUES(2) BRNCKT LABELS(1) LABELS(2) DFXFILE
Python command syntax:
ierr = sensitivity_flow(flwopt,options,values,brnckt,labels,dfxfile)
Fortran command syntax:
CALL SENSITIVITY_FLOW(FLWOPT,OPTIONS,VALUES,BRNCKT,LABELS,DFXFILE,IERR)
Where:
Integer FLWOPT (5) array of 5 elements specifying (input).
FLWOPT(1) from bus of the branch for which sensitivity
factors are calculated (no default is allowed)
FLWOPT(2) to bus of the branch (no default is allowed)
FLWOPT(3) third bus connected by a three-winding
transformer, or zero for a non-transformer
branch or a two-winding transformer (0 by
default)
FLWOPT(4) network model on which sensitivity anlayiss
is based
FLWOPT(4) = 0 DC network model
FLWOPT(4) = 1 AC network model
FLWOPT(5) branch flow type to which the sensitivity fac-
tors are calculated (If DC network is used, on-
ly the branch MW flow is valid for sensitivity
analysis. 0 by default)
FLWOPT(5) = 0 MW flow
FLWOPT(5) = 1 MVar flow
FLWOPT(5) = 2 MVA flow
FLWOPT(5) = 3 Amps flow
Integer OPTIONS (9) array of 9 elements specifying options for sensitvity analysis to a
branch flow(input).
OPTIONS(1) flag to calculate sensitivity factors at buses
OPTIONS(1) = 0 Disable, do not calculate sensitivity factors at
buses
OPTIONS(1) = 1 Enable, calculate sensitivity factors at buses
OPTIONS(2) flag to calculate sensitivity factors at genera-
tor buses
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
569
Power Flow SENSITIVITY_FLOW
OPTIONS(2) = 0 Disable
OPTIONS(2) = 1 Enable
OPTIONS(3) flag to calculate sensitivity factors at load
buses
OPTIONS(3) = 0 Disable
OPTIONS(3) = 1 Enable
OPTIONS(4) flag to calculate sensitivity factors of the
branch flow to phase shifters
OPTIONS(4) = 0 Disable
OPTIONS(4) = 1 Enable
OPTIONS(5) flag to calculate sensitivity factors of the
branch flow to tap changing transformers
(ignore if DC network model is used)
OPTIONS(5) = 0 Disable
OPTIONS(5) = 1 Enable
OPTIONS(6) flag to calculate sensitivity factors of the
branch flow to switched shunts (ignore if DC
network model is used)
OPTIONS(6) = 0 Disable
OPTIONS(6) = 1 Enable
OPTIONS(7) flag to specifiy the transfer from the com-
ponents to which sensitivity factors of the
branch flow are calculated to the opposing
subsystem (the flag is ignored if none of the
bus, generator, or load sensitivity calculation
flags is selected)
OPTIONS(7) = 0 Import. The positive transfer is from the com-
ponents to the opposing subsystem
OPTIONS(7) = 1 Export. The positive transfer is from the op-
posing subsystem to the components
OPTIONS(8) opposing subsystem type
OPTIONS(8) = 0 Slack bus
OPTIONS(8) = 1 Single bus
OPTIONS(8) = 2 Subsystem
OPTIONS(9) ignored if opposing subsystem type is slack
bus. It is a bus number when opposing sub-
system type is a single bus, or one of the fol-
lowing seven dispatch modes if the opposing
subsystem type is a subsystem (1 by default)
OPTIONS(9) = 1 Buses & participating factors from DFAX file
for buses with positive MW machines
OPTIONS(9) = 2 Buses & participating factors from DFAX file
for buses with positive MW constant MVA
load
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
570
Power Flow SENSITIVITY_FLOW
OPTIONS(9) = 3 Buses & participating factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(9) = 4 Subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(9) = 5 Subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(9) = 6 Subsystem buses with positive MW machines
in proportion to their MBASE
OPTIONS(9) = 7 Subsystem buses with positive MW machines
in proportion to their reserves (Pmaxmc-
Pgenmc)
Real VALUES (2) array of 2 elements specifying sensitivity analysis parameters(input).
VALUES(1) mismatch tolerance for continuing sensitivity
analysis in AC mode, ignored in DC mode
VALUES(2) sensitivity cutoff. Sensitivity factors less than
the cutoff are not presented
Character*2 BRNCKT branch circuit ID (input).
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the subsystem containing compo-
nents to which the sensitivity factors of the
branch flow are calcualted
LABELS(2) opposing subsystem label when the oppos-
ing subsystem type is a subsystem
Character*260 DFXFILE DFAX file name (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 The branch can not be found
IERR = 4 Generators are converted
IERR = 5 Buses in island(s) without a swing bus--use
activity TREE
IERR = 6 Dispatch bus does not exist
IERR = 7 No Distribution Factor Data input file speci-
fied
IERR = 8 Subsystem containing components to which
sensitivity factors are calculated is not speci-
fied
IERR = 9 Opposing subsystem is not specified
IERR = 10 Largest mismatch exceeds mismatch toler-
ance
IERR = 11 The branch bus does not exist
IERR = 12 The branch is out-of-service
IERR = 13 The branch is a zero impedance line
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
571
Power Flow SENSITIVITY_FLOW
IERR = 14 The branch is a multi-section line but the Re-
port Multi-Section line option is disabled
IERR = 15 Invalid FLWOPT value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file, run DFAX
IERR = 22 Error linearizing Jacobian matrix in AC net-
work model
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
572
Power Flow SENSITIVITY_FLOWS
1.1.262. SENSITIVITY_FLOWS
This API is used to calculate sensitivity factors of flows on the branches in a subsystem to MW power at
buses, MW power at generator buses, MW power at load buses, phase angle of phase shifters, tap postion
of tap changing transformers as well as admittance of switched shunts.
This API routine was first introduced in release 32.1.0.
Batch command syntax:
BAT_SENSITIVITY_FLOWS FLWOPT(1) FLWOPT(2) OPTIONS(1) .. OPTIONS(9)
VALUES(1) VALUES(2) LABELS(1) .. LABELS(3) DFXFILE
Python command syntax:
ierr = sensitivity_flows(flwopt,options,values,labels,dfxfile)
Fortran command syntax:
CALL SENSITIVITY_FLOWS(FLWOPT,OPTIONS,VALUES,LABELS,DFXFILE,IERR)
Where:
Integer FLWOPT (2) array of 2 elements specifying options for sensitivity analysis for
branches in a subsystem(input).
FLWOPT(1) network model on which sensitivity analysis
is based
FLWOPT(1) = 0 DC network model
FLWOPT(1) = 1 AC network model
FLWOPT(2) branch flow type to which the sensitivity
factors are calculated (when DC network is
used, only the branch MW flow is valid for
sensitivity analysis.)
FLWOPT(2) = 0 MW flow
FLWOPT(2) = 1 MVar flow
FLWOPT(2) = 2 MVA flow
FLWOPT(2) = 3 Amps flow
Integer OPTIONS (9) array of 9 elements specifying options for sensitvity analysis to a
branch flow(input).
OPTIONS(1) flag to calculate sensitivity factors at buses
OPTIONS(1) = 0 Disable, do not calculate sensitivity factors at
buses
OPTIONS(1) = 1 Enable, calculate sensitivity factors at buses
OPTIONS(2) flag to calculate sensitivity factors at genera-
tor buses
OPTIONS(2) = 0 Disable
OPTIONS(2) = 1 Enable
OPTIONS(3) flag to calculate sensitivity factors at load
buses
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
573
Power Flow SENSITIVITY_FLOWS
OPTIONS(3) = 0 Disable
OPTIONS(3) = 1 Enable
OPTIONS(4) flag to calculate sensitivity factors of the
branch flow to phase shifters
OPTIONS(4) = 0 Disable
OPTIONS(4) = 1 Enable
OPTIONS(5) flag to calculate sensitivity factors of the
branch flow to tap changing transformers
(ignore if DC network model is used)
OPTIONS(5) = 0 Disable
OPTIONS(5) = 1 Enable
OPTIONS(6) flag to calculate sensitivity factors of the
branch flow to switched shunts (ignore if DC
network model is used)
OPTIONS(6) = 0 Disable
OPTIONS(6) = 1 Enable
OPTIONS(7) flag to specifiy the transfer from the com-
ponents to which sensitivity factors of the
branch flow are calculated to the opposing
subsystem (the flag is ignored if none of the
bus, generator, or load sensitivity calculation
flags is selected)
OPTIONS(7) = 0 Import. The positive transfer is from the com-
ponents to the opposing subsystem
OPTIONS(7) = 1 Export. The positive transfer is from the op-
posing subsystem to the components
OPTIONS(8) opposing subsystem type
OPTIONS(8) = 0 Slack bus
OPTIONS(8) = 1 Single bus
OPTIONS(8) = 2 Subsystem
OPTIONS(9) ignored if opposing subsystem type is slack
bus. It is a bus number when opposing sub-
system type is a single bus, or one of the fol-
lowing seven dispatch modes if the opposing
subsystem type is a subsystem (1 by default)
OPTIONS(9) = 1 Buses & participating factors from DFAX file
for buses with positive MW machines
OPTIONS(9) = 2 Buses & participating factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(9) = 3 Buses & participating factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(9) = 4 Subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(9) = 5 Subsystem buses with positive MW machines
in proportion to their MW output
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
574
Power Flow SENSITIVITY_FLOWS
OPTIONS(9) = 6 Subsystem buses with positive MW machines
in proportion to their MBASE
OPTIONS(9) = 7 Subsystem buses with positive MW machines
in proportion to their reserves (Pmaxmc-
Pgenmc)
Real VALUES (2) array of 2 elements specifying sensitivity analysis parameters(input).
VALUES(1) mismatch tolerance for continuing sensitivity
analysis in AC mode, ignored in DC mode
VALUES(2) sensitivity cutoff. Sensitivity factors less than
the cutoff are not presented
Character*32 LABELS (3) array of 3 elements specifying subsystem labels(input).
LABELS(1) label of the subsystem containing compo-
nents to which the sensitivity factors of the
branch flow are calcualted
LABELS(2) label of opposing subsystem when the op-
posing subsystem type is a subsystem
LABELS(3) label of the subsystem including branches for
which sensitivity factors are calculated
Character*260 DFXFILE DFAX file name (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 The branch can not be found
IERR = 4 Generators are converted
IERR = 5 Buses in island(s) without a swing bus--use
activity TREE
IERR = 6 Dispatch bus does not exist
IERR = 7 No Distribution Factor Data input file speci-
fied
IERR = 8 Subsystem containing components to which
sensitivity factors are calculated is not speci-
fied
IERR = 9 Opposing subsystem is not specified
IERR = 10 Largest mismatch exceeds mismatch toler-
ance
IERR = 11 Invalid FLWOPT value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file, run DFAX
IERR = 22 Error linearizing Jacobian matrix in AC net-
work model
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
575
Power Flow SENSITIVITY_INTERFACE
1.1.263. SENSITIVITY_INTERFACE
This API is used to calculate sensitivity factors of an interface flow to MW power at buses, MW power at
generator buses, MW power at load buses, phase angle of phase shifters, tap position of tap changing
transformers as well as admittance of switched shunts.
This API routine was first introduced in release 32.1.0.
Batch command syntax:
BAT_SENSITIVITY_INTERFACE MODE OPTIONS(1) .. OPTIONS(9) VALUES(1)
VALUES(2) LABELS(1) .. LABELS(3) DFXFILE
Python command syntax:
ierr = sensitivity_interface(mode,options,values,labels,dfxfile)
Fortran command syntax:
CALL SENSITIVITY_INTERFACE(MODE,OPTIONS,VALUES,LABELS,DFXFILE,IERR)
Where:
Integer MODE network model on which sensitivity analysis is based (input; 0 by de-
fault).
MODE = 0 DC network model
MODE = 1 AC network model
Integer OPTIONS (9) array of 9 elements specifying options for sensitvity analysis to a
branch flow(input).
OPTIONS(1) flag to calculate sensitivity factors at buses
OPTIONS(1) = 0 Disable, do not calculate sensitivity factors at
buses
OPTIONS(1) = 1 Enable, calculate sensitivity factors at buses
OPTIONS(2) flag to calculate sensitivity factors at genera-
tor buses
OPTIONS(2) = 0 Disable
OPTIONS(2) = 1 Enable
OPTIONS(3) flag to calculate sensitivity factors at load
buses
OPTIONS(3) = 0 Disable
OPTIONS(3) = 1 Enable
OPTIONS(4) flag to calculate sensitivity factors of the
branch flow to phase shifters
OPTIONS(4) = 0 Disable
OPTIONS(4) = 1 Enable
OPTIONS(5) flag to calculate sensitivity factors of the
branch flow to tap changing transformers
(ignore if DC network model is used)
OPTIONS(5) = 0 Disable
OPTIONS(5) = 1 Enable
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
576
Power Flow SENSITIVITY_INTERFACE
OPTIONS(6) flag to calculate sensitivity factors of the
branch flow to switched shunts (ignore if DC
network model is used)
OPTIONS(6) = 0 Disable
OPTIONS(6) = 1 Enable
OPTIONS(7) flag to specifiy the transfer from the com-
ponents to which sensitivity factors of the
branch flow are calculated to the opposing
subsystem (the flag is ignored if none of the
bus, generator, or load sensitivity calculation
flags is selected)
OPTIONS(7) = 0 Import. The positive transfer is from the com-
ponents to the opposing subsystem
OPTIONS(7) = 1 Export. The positive transfer is from the op-
posing subsystem to the components
OPTIONS(8) opposing subsystem type
OPTIONS(8) = 0 Slack bus
OPTIONS(8) = 1 Single bus
OPTIONS(8) = 2 Subsystem
OPTIONS(9) ignored if opposing subsystem type is slack
bus. It is a bus number when opposing sub-
system type is a single bus, or one of the fol-
lowing seven dispatch modes if the opposing
subsystem type is a subsystem (1 by default)
OPTIONS(9) = 1 Buses & participating factors from DFAX file
for buses with positive MW machines
OPTIONS(9) = 2 Buses & participating factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(9) = 3 Buses & participating factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(9) = 4 Subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(9) = 5 Subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(9) = 6 Subsystem buses with positive MW machines
in proportion to their MBASE
OPTIONS(9) = 7 Subsystem buses with positive MW machines
in proportion to their reserves (Pmaxmc-
Pgenmc)
Real VALUES (2) array of 2 elements specifying sensitivity analysis parameters(input).
VALUES(1) mismatch tolerance for continuing sensitivity
analysis in AC mode, ignored in DC mode
VALUES(2) sensitivity cutoff. Sensitivity factors less than
the cutoff are not presented
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
577
Power Flow SENSITIVITY_INTERFACE
Character*32 LABELS (3) array of 3 elements specifying subsystem/interface labels(input).
LABELS(1) label of the subsystem containing compo-
nents to which the sensitivity factors of the
interface flow are calculated
LABELS(2) label of opposing subsystem when the op-
posing subsystem type is a subsystem
LABELS(3) label of the interface for which sensitivity
factors are calculated
Character*260 DFXFILE DFAX file name (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 Interface is not specified
IERR = 4 Generators are converted
IERR = 5 Buses in island(s) without a swing bus--use
activity TREE
IERR = 6 Dispatch bus does not exist
IERR = 7 No Distribution Factor Data input file speci-
fied
IERR = 8 Subsystem containing components to which
sensitivity factors are calculated is not speci-
fied
IERR = 9 Opposing subsystem is not specified
IERR = 10 Largest mismatch exceeds mismatch toler-
ance
IERR = 11 Invalid MODE value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file, run DFAX
IERR = 22 Error in linearizing Jacobian matrix with AC
network model
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
578
Power Flow SENSITIVITY_VOLTAGE
1.1.264. SENSITIVITY_VOLTAGE
This API is used to calculate sensitivity factors of a bus voltage to MW and MVar power at buses, MW power
at generator buses, MW and MVar at load buses, phase angle of phase shifters, tap postion of tap changing
transformers as well as admittance of switched shunts.
This API routine was first introduced in release 32.1.0.
Batch command syntax:
BAT_SENSITIVITY_VOLTAGE IBUS OPTIONS(1) .. OPTIONS(9) VALUES(1) VALUES(2)
LABELS(1) LABELS(2) DFXFILE
Python command syntax:
ierr = sensitivity_voltage(ibus,options,values,labels,dfxfile)
Fortran command syntax:
CALL SENSITIVITY_VOLTAGE(IBUS,OPTIONS,VALUES,LABELS,DFXFILE,IERR)
Where:
Integer IBUS bus number for which sensitivity factors are calculated (input).
Integer OPTIONS (9) array of 9 elements specifying options for sensitvity analysis to a
branch flow(input).
OPTIONS(1) flag to calculate sensitivity factors at buses
OPTIONS(1) = 0 Disable, do not calculate sensitivity factors at
buses
OPTIONS(1) = 1 Enable, calculate sensitivity factors at buses
OPTIONS(2) flag to calculate sensitivity factors at genera-
tor buses
OPTIONS(2) = 0 Disable
OPTIONS(2) = 1 Enable
OPTIONS(3) flag to calculate sensitivity factors at load
buses
OPTIONS(3) = 0 Disable
OPTIONS(3) = 1 Enable
OPTIONS(4) flag to calculate sensitivity factors of the
branch flow to phase shifters
OPTIONS(4) = 0 Disable
OPTIONS(4) = 1 Enable
OPTIONS(5) flag to calculate sensitivity factors of the
branch flow to tap changing transformers
(ignore if DC network model is used)
OPTIONS(5) = 0 Disable
OPTIONS(5) = 1 Enable
OPTIONS(6) flag to calculate sensitivity factors of the
branch flow to switched shunts (ignore if DC
network model is used)
OPTIONS(6) = 0 Disable
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
579
Power Flow SENSITIVITY_VOLTAGE
OPTIONS(6) = 1 Enable
OPTIONS(7) flag to specifiy the transfer from the com-
ponents to which sensitivity factors of the
branch flow are calculated to the opposing
subsystem (the flag is ignored if none of the
bus, generator, or load sensitivity calculation
flags is selected)
OPTIONS(7) = 0 Import. The positive transfer is from the com-
ponents to the opposing subsystem
OPTIONS(7) = 1 Export. The positive transfer is from the op-
posing subsystem to the components
OPTIONS(8) opposing subsystem type
OPTIONS(8) = 0 Slack bus
OPTIONS(8) = 1 Single bus
OPTIONS(8) = 2 Subsystem
OPTIONS(9) ignored if opposing subsystem type is slack
bus. It is a bus number when opposing sub-
system type is a single bus, or one of the fol-
lowing seven dispatch modes if the opposing
subsystem type is a subsystem (1 by default)
OPTIONS(9) = 1 Buses & participating factors from DFAX file
for buses with positive MW machines
OPTIONS(9) = 2 Buses & participating factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(9) = 3 Buses & participating factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(9) = 4 Subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(9) = 5 Subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(9) = 6 Subsystem buses with positive MW machines
in proportion to their MBASE
OPTIONS(9) = 7 Subsystem buses with positive MW machines
in proportion to their reserves (Pmaxmc-
Pgenmc)
Real VALUES (2) array of 2 elements specifying sensitivity analysis parameters(input).
VALUES(1) mismatch tolerance for continuing sensitivity
analysis in AC mode, ignored in DC mode
VALUES(2) sensitivity cutoff. Sensitivity factors less than
the cutoff are not presented
Character*32 LABELS (2) array of 2 elements specifying subsystem labels(input).
LABELS(1) label of the subsystem containing compo-
nents to which the sensitivity factors of the
bus voltage are calcualted
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
580
Power Flow SENSITIVITY_VOLTAGE
LABELS(2) opposing subsystem label when the oppos-
ing subsystem type is a subsystem
Character*260 DFXFILE DFAX file name (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 The bus does not exist
IERR = 4 Generators are converted
IERR = 5 Buses in island(s) without a swing bus--use
activity TREE
IERR = 6 Dispatch bus does not exist
IERR = 7 No Distribution Factor Data input file speci-
fied
IERR = 8 Subsystem containing components to which
sensitivity factors are calculated is not speci-
fied
IERR = 9 Opposing subsystem is not specified
IERR = 10 Largest mismatch exceeds mismatch toler-
ance
IERR = 11 The bus is a type 2 or type 3 bus
IERR = 12 Invalid IBUS value
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file, run DFAX
IERR = 22 Error linearizing Jacobian matrix in AC net-
work model
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
581
Power Flow SENSITIVITY_VOLTAGES
1.1.265. SENSITIVITY_VOLTAGES
This API is used to calculate sensitivity factors of bus voltages in a subsystem to MW and MVar power at
buses, MW power at generator buses, MW and MVar at load buses, phase angle of phase shifters, tap pos-
tion of tap changing transformers as well as admittance of switched shunts.
This API routine was first introduced in release 32.1.0.
Batch command syntax:
BAT_SENSITIVITY_VOLTAGES OPTIONS(1) .. OPTIONS(9) VALUES(1) VALUES(2)
LABELS(1) .. LABELS(3) DFXFILE
Python command syntax:
ierr = sensitivity_voltages(options,values,labels,dfxfile)
Fortran command syntax:
CALL SENSITIVITY_VOLTAGES(OPTIONS,VALUES,LABELS,DFXFILE,IERR)
Where:
Integer OPTIONS (9) array of 9 elements specifying options for sensitvity analysis to a
branch flow(input).
OPTIONS(1) flag to calculate sensitivity factors at buses
OPTIONS(1) = 0 Disable, do not calculate sensitivity factors at
buses
OPTIONS(1) = 1 Enable, calculate sensitivity factors at buses
OPTIONS(2) flag to calculate sensitivity factors at genera-
tor buses
OPTIONS(2) = 0 Disable
OPTIONS(2) = 1 Enable
OPTIONS(3) flag to calculate sensitivity factors at load
buses
OPTIONS(3) = 0 Disable
OPTIONS(3) = 1 Enable
OPTIONS(4) flag to calculate sensitivity factors of the
branch flow to phase shifters
OPTIONS(4) = 0 Disable
OPTIONS(4) = 1 Enable
OPTIONS(5) flag to calculate sensitivity factors of the
branch flow to tap changing transformers
(ignore if DC network model is used)
OPTIONS(5) = 0 Disable
OPTIONS(5) = 1 Enable
OPTIONS(6) flag to calculate sensitivity factors of the
branch flow to switched shunts (ignore if DC
network model is used)
OPTIONS(6) = 0 Disable
OPTIONS(6) = 1 Enable
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
582
Power Flow SENSITIVITY_VOLTAGES
OPTIONS(7) flag to specifiy the transfer from the com-
ponents to which sensitivity factors of the
branch flow are calculated to the opposing
subsystem (the flag is ignored if none of the
bus, generator, or load sensitivity calculation
flags is selected)
OPTIONS(7) = 0 Import. The positive transfer is from the com-
ponents to the opposing subsystem
OPTIONS(7) = 1 Export. The positive transfer is from the op-
posing subsystem to the components
OPTIONS(8) opposing subsystem type
OPTIONS(8) = 0 Slack bus
OPTIONS(8) = 1 Single bus
OPTIONS(8) = 2 Subsystem
OPTIONS(9) ignored if opposing subsystem type is slack
bus. It is a bus number when opposing sub-
system type is a single bus, or one of the fol-
lowing seven dispatch modes if the opposing
subsystem type is a subsystem (1 by default)
OPTIONS(9) = 1 Buses & participating factors from DFAX file
for buses with positive MW machines
OPTIONS(9) = 2 Buses & participating factors from DFAX file
for buses with positive MW constant MVA
load
OPTIONS(9) = 3 Buses & participating factors from DFAX file
for buses with either positive MW machines
or positive MW constant MVA load
OPTIONS(9) = 4 Subsystem buses with positive MW constant
MVA load in proportion to their MW load
OPTIONS(9) = 5 Subsystem buses with positive MW machines
in proportion to their MW output
OPTIONS(9) = 6 Subsystem buses with positive MW machines
in proportion to their MBASE
OPTIONS(9) = 7 Subsystem buses with positive MW machines
in proportion to their reserves (Pmaxmc-
Pgenmc)
Real VALUES (2) array of 2 elements specifying sensitivity analysis parameters(input).
VALUES(1) mismatch tolerance for continuing sensitivity
analysis in AC mode, ignored in DC mode
VALUES(2) sensitivity cutoff. Sensitivity factors less than
the cutoff are not presented
Character*32 LABELS (3) array of 3 elements specifying subsystem labels(input).
LABELS(1) label of the subsystem containing compo-
nents to which the sensitivity factors of the
branch flow are calcualted
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
583
Power Flow SENSITIVITY_VOLTAGES
LABELS(2) label of opposing subsystem when the op-
posing subsystem type is a subsystem
LABELS(3) label of the subsystem including branches for
which sensitivity factors are calculated
Character*260 DFXFILE DFAX file name (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 Invalid OPTIONS value
IERR = 2 Invalid VALUES value
IERR = 3 The bus does not exist
IERR = 4 Generators are converted
IERR = 5 Buses in island(s) without a swing bus--use
activity TREE
IERR = 6 Dispatch bus does not exist
IERR = 7 No Distribution Factor Data input file speci-
fied
IERR = 8 Subsystem containing components to which
sensitivity factors are calculated is not speci-
fied
IERR = 9 Opposing subsystem is not specified
IERR = 10 Largest mismatch exceeds mismatch toler-
ance
IERR = 21 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file, run DFAX
IERR = 22 Error linearizing Jacobian matrix in AC net-
work model
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
584
Power Flow SET_INPUT_DEV
1.1.266. SET_INPUT_DEV
Use this API to set the terminal input device to a file.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_SET_INPUT_DEV IDVFIL
Python command syntax:
ierr = set_input_dev(idvfil)
Fortran command syntax:
CALL IDEVAPI(IDVFIL, IERR)
Where:
Character*260 IDVFIL name of response file to be used for terminal (input).
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
585
Power Flow SET_PROGRESS_VERBOSE
1.1.267. SET_PROGRESS_VERBOSE
Use this API to to set the option progress message verbose value. This value is used to show or not show
some repetitive progress messages when reading sequence data file.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Batch command syntax:
BAT_SET_PROGRESS_VERBOSE IVAL
Python command syntax:
ierr = set_progress_verbose(ival)
Fortran command syntax:
CALL SET_PROGRESS_VERBOSE(IVAL, IERR)
Where:
Integer IVAL value of the option setting (input-1).
IVAL = -1 show all messages
IVAL = 0 do not show repetitive messages
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid IVAL 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
586
Power Flow SHNT
1.1.268. SHNT
Use this API to tabulate fixed and/or switched bus shunts contained in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SHNT SID ALL OPT
Python command syntax:
ierr = shnt(sid, all, opt)
Fortran command syntax:
CALL SHNTNW(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 option to select the type of bus shunts tabulated (input; 1 by de-
fault).
OPT = 1 all shunts
OPT = 2 fixed bus shunts
OPT = 3 switched shunts
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
587
Power Flow SHORT_CIRCUIT_COORDINATES
1.1.269. SHORT_CIRCUIT_COORDINATES
Use this API to specify or return the option to set the fault analysis voltage and current output coordinates
to either rectangular or polar coordinates.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SHORT_CIRCUIT_COORDINATES IVAL
Python command syntax:
ierr = short_circuit_coordinates(ival)
ierr, ival = short_circuit_coordinates()
Fortran command syntax:
CALL SHORT_CIRCUIT_COORDINATES_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 rectangular coordinates.
IVAL = 1 polar coordinates.
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
588
Power Flow SHORT_CIRCUIT_MODELING
1.1.270. SHORT_CIRCUIT_MODELING
Use this API to specify or return the option for the fault analysis modeling setting; either normal three-
phase or center tapped two-phase.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SHORT_CIRCUIT_MODELING IVAL
Python command syntax:
ierr = short_circuit_modeling(ival)
ierr, ival = short_circuit_modeling()
Fortran command syntax:
CALL SHORT_CIRCUIT_MODELING_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 center tapped two-phase.
IVAL = 1 normal three-phase.
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
589
Power Flow SHORT_CIRCUIT_UNITS
1.1.271. SHORT_CIRCUIT_UNITS
Use this API to specify or return the option to set the fault analysis voltage and current output units to ei-
ther per unit or physical units.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SHORT_CIRCUIT_UNITS IVAL
Python command syntax:
ierr = short_circuit_units(ival)
ierr, ival = short_circuit_units()
Fortran command syntax:
CALL SHORT_CIRCUIT_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, 0 by default;
else output).
IVAL = 0 per unit.
IVAL = 1 physical units.
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
590
Power Flow SHORT_CIRCUIT_WARNING
1.1.272. SHORT_CIRCUIT_WARNING
Use this API to specify or return the option to enable or disable the fault analysis warning option setting.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SHORT_CIRCUIT_WARNING IVAL
Python command syntax:
ierr = short_circuit_warning(ival)
ierr, ival = short_circuit_warning()
Fortran command syntax:
CALL SHORT_CIRCUIT_WARNING_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 disable printing of RESQ/TRSQ/solution warn-
ings.
IVAL = 1 print RESQ/TRSQ/solution warnings.
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
591
Power Flow SHORT_CIRCUIT_Z_COORDINATES
1.1.273. SHORT_CIRCUIT_Z_COORDINATES
Use this API to specify or return the option to set the fault analysis output impedance coordinates to either
rectangular or polar coordinates.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SHORT_CIRCUIT_Z_COORDINATES IVAL
Python command syntax:
ierr = short_circuit_z_coordinates(ival)
ierr, ival = short_circuit_z_coordinates()
Fortran command syntax:
CALL SHORT_CIRCUIT_Z_COORDINATES(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 rectangular coordinates.
IVAL = 1 polar coordinates.
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
592
Power Flow SHORT_CIRCUIT_Z_UNITS
1.1.274. SHORT_CIRCUIT_Z_UNITS
Use this API to specify or return the option to set the fault analysis output impedance units to either per
unit or ohms.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SHORT_CIRCUIT_Z_UNITS IVAL
Python command syntax:
ierr = short_circuit_z_units(ival)
ierr, ival = short_circuit_z_units()
Fortran command syntax:
CALL SHORT_CIRCUIT_Z_UNITS(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 per unit.
IVAL = 1 physical units.
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
593
Power Flow SHOW
1.1.275. SHOW
Use this API to tabulate summaries of Saved Case and/or Snapshot Files.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SHOW OPTION SFILE
Python command syntax:
ierr = show(option, sfile)
Fortran command syntax:
CALL SHOWAPI(OPTION, SFILE, IERR)
Where:
Integer OPTION code for the type(s) of files to report (input; 1 by default).
OPTION = 0 file specified in SFILE
OPTION = 1 all .savx, .sav and .snp files
OPTION = 2 all .savx and .sav files
OPTION = 3 all .snp files
Character*260 SFILE name of saved case or snapshot file (when OPTION is 0) (input; no
default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTION value
IERR = 2 SFILE is blank when OPTION is 0
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
594
Power Flow SHOWTABLE
1.1.276. SHOWTABLE
Directs a report table to output console. Use API_NAME instead to redirect report table output to the
Progress Window or Report Window.
This API routine was first introduced in release 35.0.0.
Python command syntax:
ierr = showtable(tblnam, direction)
Fortran command syntax:
CALL SHOWTABLE(TBLNAM, DIRECTION, IERR)
Where:
Character*512 TBLNAM (input).
Integer DIRECTION (input).
DIRECTION = 1 Progress window
DIRECTION = 2 Report window
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
595
Power Flow SHOWTABLEBYINDEX
1.1.277. SHOWTABLEBYINDEX
This API routine was first introduced in release 35.0.0.
Python command syntax:
ierr = showtablebyindex(tblid, direction)
Fortran command syntax:
CALL SHOWTABLEBYINDEX(TBLID, DIRECTION, IERR)
Where:
Integer TBLID (input).
Integer DIRECTION (input).
DIRECTION = 1 Progress window
DIRECTION = 2 Report window
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
596
Power Flow SIZE
1.1.278. SIZE
Use this API to obtain a summary of the number of components in the working case (activity SIZE).
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SIZE
Python command syntax:
ierr = size()
Fortran command syntax:
CALL SIZEAPI(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
597
Power Flow SOLV
1.1.279. SOLV
Use this API to apply the Gauss-Seidel power flow calculation.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SOLV OPTIONS(1)..OPTIONS(6)
Python command syntax:
ierr = solv(options)
Fortran command syntax:
CALL SOLVAPI(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
598
Power Flow SOLV
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
599
Power Flow SPCB
1.1.280. SPCB
Use this API to calculate positive sequence equivalents of branch unbalances.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SPCB IBUS JBUS CKT OPTIONS(1)..OPTIONS(4) VALUES(1)..VALUES(5)
Python command syntax:
ierr = spcb(ibus, jbus, ckt, options, values)
Fortran command syntax:
CALL SPCBAPI(IBUS, JBUS, CKT, OPTIONS, VALUES, IERR)
Where:
Integer IBUS from bus of branch subjected to unbalance (input; no default al-
lowed).
Integer JBUS to bus of branch subjected to unbalance (input; no default allowed).
Character*2 CKT circuit identifier of branch subjected to unbalance (input; '1' by de-
fault).
Integer OPTIONS (4) array of 4 elements specifying unbalance OPTIONS(input).
OPTIONS(1) unbalance code (0 by default)
OPTIONS(1) = 0 no unbalance; Thevenin impedances only
OPTIONS(1) = 1 one phase open
OPTIONS(1) = 2 two phases open
OPTIONS(1) = 3 in-line fault
OPTIONS(1) = 4 one breaker open
OPTIONS(1) = 5 no unbalance
OPTIONS(2) path to ground code (used when OPTIONS(1)
is 1 or 4) (0 by default)
OPTIONS(2) = 0 no path to ground
OPTIONS(2) = 1 include a path to ground
OPTIONS(3) type of in-line fault code (used when OP-
TIONS(1) is 3) (1 by default)
OPTIONS(3) = 1 line-to-ground
OPTIONS(3) = 2 line-to-line-to-ground
OPTIONS(3) = 3 three-phase
OPTIONS(4) open end code (used when OPTIONS(1) is 4)
(1 by default)
OPTIONS(4) = 0 breaker at to bus is open
OPTIONS(4) = 1 breaker at from bus is open
Real VALUES (3) array of 3 elements specifying unbalance parameters(input).
VALUES(1) fault location as fraction of line from from
bus; 0.0 < VALUES(1) < 1.0 (used when OP-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
600
Power Flow SPCB
TIONS(1) is 1 or 4 and OPTIONS(2) is 1; or
when OPTIONS(1) is 3) (0.5 by default)
VALUES(2) & (3) Rl-g and Xl-g (used when OPTIONS(1)
is 1 or 4 and OPTIONS(2) is 1; or when OP-
TIONS(1) is 3 and OPTIONS(3) is 1 or 2) (0.0
by default)
VALUES(3) & (5) Rl-l and Xl-l (used when OPTIONS(1) is
3 and OPTIONS(3) is 2) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid with two phase modeling option en-
abled
IERR = 2 bus not found
IERR = 3 invalid OPTIONS value
IERR = 4 invalid VALUES value
IERR = 5 SEQD temporary file is not open
IERR = 6 SEQD results are not compatible with the
working case
IERR = 7 terminated due to invalid fault specification
or application
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
601
Power Flow SPIL
1.1.281. SPIL
Use this API to calculate transmission interchange limits using a linear network (dc) model.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SPIL OPTIONS(1)..OPTIONS(16) VALUES(1)..VALUES(7)
LABELS(1)..LABELS(8) DFXFILE PRTFILE
Python command syntax:
ierr = spil(options, values, labels, dfxfile, prtfile)
Fortran command syntax:
CALL SPILAPI(OPTIONS, VALUES, LABELS, DFXFILE, PRTFILE, IERR)
Where:
Integer OPTIONS (16) array of 16 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) list study system buses (0 by default)
OPTIONS(5) = 0 no
OPTIONS(5) = 1 yes
OPTIONS(6) list opposing system buses (0 by default)
OPTIONS(6) = 0 no
OPTIONS(6) = 1 yes
OPTIONS(7) list study system tie lines (0 by default)
OPTIONS(7) = 0 no
OPTIONS(7) = 1 yes
OPTIONS(8) add study system tie lines to monitored line
list (0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
602
Power Flow SPIL
OPTIONS(8) = 0 no
OPTIONS(8) = 1 yes
OPTIONS(9) format code (0 by default)
OPTIONS(9) = 0 summary output
OPTIONS(9) = 1 full output
OPTIONS(10) interchange limit code (0 by default)
OPTIONS(10) = 0 incremental transfer capability
OPTIONS(10) = 1 total transfer capability
OPTIONS(11) apply summary minimum distribution factor,
VALUES(4), to solution reports (0 by default)
OPTIONS(11) = 0 no
OPTIONS(11) = 1 yes
OPTIONS(12) convert MVA ratings to estimated MW ratings
(0 by default)
OPTIONS(12) = 0 no
OPTIONS(12) = 1 yes
OPTIONS(13) code to discontinue activity if MW mismatch
exceeds VALUES(1) (0 by default)
OPTIONS(13) = 0 discontinue
OPTIONS(13) = 1 continue
OPTIONS(14) summary table contingency descriptions (1
by default)
OPTIONS(14) = 0 contingency labels
OPTIONS(14) = 1 contingency events
OPTIONS(14) = 2 both contingency labels and events
OPTIONS(15) number of elements to include in flow tables
(60000 by default)
OPTIONS(16) summary table maximum times for reporting
the same element (5 by default)
Real VALUES (7) array of 7 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) summary table maximum import or export
(>0.) (99999.0 by default)
VALUES(4) summary table minimum distribution factor
magnitude (0.0 by default)
VALUES(5) minimum contingency case pre-shift flow
change (0.0 by default)
VALUES(6) minimum contingency case distribution fac-
tor change (0.0 by default)
VALUES(7) 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
603
Power Flow SPIL
Character*32 LABELS (8) array of 8 elements specifying subsystem and interface labels(input).
LABELS(1) study system label (no default allowed)
LABELS(2) opposing system label (no default allowed)
LABELS(3) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(4) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(5) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(6) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(7) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(8) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
Character*260 DFXFILE name of DFAX data file (input; no default allowed).
Character*260 PRTFILE name of subsystem participation 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 invalid VALUES value
IERR = 3 no DFAX data file specified
IERR = 4 same label specified for study and opposing
systems
IERR = 5 generators are converted
IERR = 6 buses in island(s) without a swing bus; use
activity TREE
IERR = 7 largest mismatch exceeds mismatch toler-
ance
IERR = 8 error opening file DFXFILE
IERR = 9 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 10 file DFXFILE does not contain distribution fac-
tors; run DFAX with distribution factor option
enabled
IERR = 11 no monitored branches or interfaces defined
IERR = 12 no subsystems defined
IERR = 13 subsystem not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
604
Power Flow SPIL
IERR = 14 specified subsystems overlap
IERR = 15 no in-service buses in subsystem WORLD
IERR = 16 no tie lines from study system
IERR = 17 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
605
Power Flow SPLT
1.1.282. SPLT
Use this API to add a bus to the working case and place a zero impedance line between bus BUS and the
new bus. No other equipment is connected to the new bus by this API.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SPLT BUS NEWNUM 'NEWNAM' NEWKV
Python command syntax:
ierr = splt(bus, newnum, newnam, newkv)
Fortran command syntax:
CALL SPLTAPI(BUS, NEWNUM, NEWNAM, NEWKV, IERR)
Where:
Integer BUS number of the bus to be split (input; no default allowed).
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 BUS).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 invalid NEWNUM value
IERR = 3 bus number is already assigned to another
bus
IERR = 4 invalid NEWKV value
IERR = 5 bus, branch, or branch ownership tables are
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
606
Power Flow SQLI
1.1.283. SQLI
Use this API to tabulate the sequence data in a form suitable for problem data documentation.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SQLI SID ALL OPT
Python command syntax:
ierr = sqli(sid, all, opt)
Fortran command syntax:
CALL SQLINW(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 category of sequence data to be tabulated (input; 1 by default).
OPT = 1 full listing
OPT = 2 bus load data
OPT = 3 generator data
OPT = 4 branch data
OPT = 5 two-winding positive sequence data
OPT = 6 mutual coupling data
OPT = 7 switched shunt data
OPT = 8 three-winding general data
OPT = 9 line shunt data
OPT = 10 fixed shunt data
OPT = 11 induction machine data
OPT = 12 two-winding zero sequence data
OPT = 13 three-winding positive sequence data
OPT = 14 three-winding zero sequence data
OPT = 15 non-conventional source machine data
OPT = 16 non-conventional source table 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
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
607
Power Flow SQLI
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
608
Power Flow SRAIND
1.1.284. SRAIND
Use this API to run the substation reliability analysis. It applies failure modes and affects analysis of arbi-
trary bus-breaker configurations and measures the impact of substation equipment failures upon the pow-
er transfer capability of the substation.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_SRAIND OPTIONS(1)..OPTIONS(3) VALUES(1)..VALUES(5)
LABELS(1)..LABELS(3) DFXFILE PRBFILE
Python command syntax:
ierr = sraind(options, values, labels, dfxfile, prbfile)
Fortran command syntax:
CALL SRAINDAPI(OPTIONS, VALUES, LABELS, DFXFILE, PRBFILE, IERR)
Where:
Integer OPTIONS (3) array of 3 elements specifying options(input).
OPTIONS(1) report format (1 by default)
OPTIONS(1) = 1 contingency report
OPTIONS(1) = 2 bus load curtailment report
OPTIONS(1) = 3 substation load curtailment report
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) include system ties (0 by default)
OPTIONS(3) = 0 disable
OPTIONS(3) = 1 enable
Real VALUES (5) array of 5 elements specifying substation reliability assessment
parameters(input).
VALUES(1) percent of flow rating (>=0, 100.0 by de-
fault)
VALUES(2) frequency cutoff (>=0, 0.0001 by default)
VALUES(3) percent of peak load (>=0, 100.0 by default)
VALUES(4) switching time in hours (>=0, 0.0 by default)
VALUES(5) breaker failure rate in hours per year (>=0,
0.0 by default)
Character*32 LABELS (3) array of 3 elements specifying subsystem labels(input).
LABELS(1) label of substation subsystem (no default is
allowed)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
609
Power Flow SRAIND
LABELS(2) label of source subsystem (no default is al-
lowed)
LABELS(3) label of sink subsystem (no default is al-
lowed)
Character*260 DFXFILE name of DFAX data file (input; no default allowed).
Character*260 PRBFILE name of outage statistic data 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 substation/source/sink subsytem not specified
IERR = 4 no DFAX data file specified
IERR = 5 no outage Statistic Data File specified
IERR = 6 file is not in the form of a PSSE-25 or later
DFAX file; run DFAX
IERR = 7 subsystem not found in DFAX data file
IERR = 8 source/sink buses not in substation subsystem
IERR = 9 source and sink systems overlap
IERR = 51 error opening DFAX data file
IERR = 52 error opening outage statistic data file
IERR = 53 file system errors
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
610
Power Flow STOP
1.1.285. STOP
This API routine is obsolete. It has been replaced by the API routine stop_2 .
Use this API to end the operation of PSSE.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_STOP DELETE
Python command syntax:
ierr = stop(delete)
Fortran command syntax:
CALL STOPAPI(DELETE, IERR)
Where:
Integer DELETE delete working files (input; 0 by default).
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
611
Power Flow STOP_2
1.1.286. STOP_2
Use this API to end the operation of PSSE.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_STOP_2
Python command syntax:
ierr = stop_2()
Fortran command syntax:
CALL STOPAPI_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
612
Power Flow SUBS
1.1.287. SUBS
Use this API to summarize conditions in the working case by tabulating the conditions at each swing sys-
tem bus, conditions at each area slack area bus, number of components, generation/ load/shunt totals, and
loss/line shunt/charging totals by voltage levels.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SUBS SID ALL
Python command syntax:
ierr = subs(sid, all)
Fortran command syntax:
CALL SUBSNW(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
613
Power Flow SWITCHED_SHUNT_ADJUSTMENT
1.1.288. SWITCHED_SHUNT_ADJUSTMENT
Use this API to specify or return the option to enable or disable switched shunt adjustment.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_ADJUSTMENT IVAL
Python command syntax:
ierr = switched_shunt_adjustment(ival)
ierr, ival = switched_shunt_adjustment()
Fortran command syntax:
CALL SWITCHED_SHUNT_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.
IVAL = 2 continuous mode switched shunts enabled,
discrete mode switched shunts locked.
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
614
Power Flow TAP_ADJUSTMENT
1.1.289. TAP_ADJUSTMENT
Use this API to specify or return the option for the default tap adjustment setting; either disabled, stepping
or direct.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_TAP_ADJUSTMENT IVAL
Python command syntax:
ierr = tap_adjustment(ival)
ierr, ival = tap_adjustment()
Fortran command syntax:
CALL 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 locked (i.e., tap adjustment is disabled).
IVAL = 1 tap adjustment using the stepping method
enabled.
IVAL = 2 tap adjustment using the direct method en-
abled.
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
615
Power Flow TEXT
1.1.290. TEXT
This API does nothing. Its purpose is to provide recordable documentation.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_TEXT 'CARG'
Python command syntax:
ierr = text(carg)
Fortran command syntax:
CALL TEXT_API(CARG, IERR)
Where:
Character*220 CARG string of text (input; blank by default).
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
616
Power Flow TFLG
1.1.291. TFLG
Use this API to set or reset the adjustment control mode flags for all automatically adjustable transformers
contained in the specified subsystem.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TFLG SID ALL OPT
Python command syntax:
ierr = tflg(sid, all, opt)
Fortran command syntax:
CALL TFLGNW(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 option to select the adjustment control mode flags of those trans-
formers being processed (input; 1 by default).
OPT = 0 disable
OPT = 1 enable
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
617
Power Flow TIES
1.1.292. TIES
Use this API to tabulate the flows on all area tie lines, with tie flows grouped by area.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TIES SID ALL
Python command syntax:
ierr = ties(sid, all)
Fortran command syntax:
CALL TIESNW(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
618
Power Flow TIEZ
1.1.293. TIEZ
Use this API to tabulate the flows on all zone tie lines, with tie flows grouped by zone.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TIEZ SID ALL
Python command syntax:
ierr = tiez(sid, all)
Fortran command syntax:
CALL TIEZNW(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
619
Power Flow TIME
1.1.294. TIME
Use this API to tabulate timing statistics.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_TIME INIT
Python command syntax:
ierr = time(init)
Fortran command syntax:
CALL TIMEAPI(INIT, IERR)
Where:
Integer INIT timing flag (input; positive).
INIT <= 0 do not initialize
INIT > 0 initialize
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
620
Power Flow TLST
1.1.295. TLST
Use this API to tabulate those transformers in the working case where off-nominal turns ratio or phase
shift angle may be adjusted by the power flow solution activities.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TLST SID ALL OPT VREV
Python command syntax:
ierr = tlst(sid, all, opt, vrev)
Fortran command syntax:
CALL TLSTNW(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 option to select the transformers tabulated (input; 0 by default).
OPT = 0 all
OPT = 1 violations only
Integer VREV option to change voltage units from the default units to the alternate
units (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
621
Power Flow TLTG
1.1.296. TLTG
Use this API to calculate transmission interchange limits using a linear network (dc) model.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_TLTG OPTIONS(1)..OPTIONS(17) VALUES(1)..VALUES(7)
LABELS(1)..LABELS(8) DFXFILE
Python command syntax:
ierr = tltg(options, values, labels, dfxfile)
Fortran command syntax:
CALL TLTGAPI(OPTIONS, VALUES, LABELS, DFXFILE, IERR)
Where:
Integer OPTIONS (17) array of 17 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
OPTIONS(7) = 1 yes
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
622
Power Flow TLTG
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) interchange limit code (0 by default)
OPTIONS(11) = 0 incremental transfer capability
OPTIONS(11) = 1 total transfer capability
OPTIONS(12) apply summary minimum distribution factor,
VALUES(4), to solution reports (0 by default)
OPTIONS(12) = 0 no
OPTIONS(12) = 1 yes
OPTIONS(13) convert MVA ratings to estimated MW ratings
(0 by default)
OPTIONS(13) = 0 no
OPTIONS(13) = 1 yes
OPTIONS(14) code to discontinue activity if MW mismatch
exceeds VALUES(1) (0 by default)
OPTIONS(14) = 0 discontinue
OPTIONS(14) = 1 continue
OPTIONS(15) summary table contingency descriptions (1
by default)
OPTIONS(15) = 0 contingency labels
OPTIONS(15) = 1 contingency events
OPTIONS(15) = 2 both contingency labels and events
OPTIONS(16) number of elements to include in flow tables
(60000 by default)
OPTIONS(17) summary table maximum times for reporting
the same element (5 by default)
Real VALUES (7) array of 7 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) summary table maximum import or export
(>0.) (99999.0 by default)
VALUES(4) summary table minimum distribution factor
magnitude (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
623
Power Flow TLTG
VALUES(5) minimum contingency case pre-shift flow
change (0.0 by default)
VALUES(6) minimum contingency case distribution fac-
tor change (0.0 by default)
VALUES(7) study system generation shift (100.0 by de-
fault)
Character*32 LABELS (8) array of 8 elements specifying subsystem and interface labels(input).
LABELS(1) study system label (no default allowed)
LABELS(2) opposing system label (no default allowed)
LABELS(3) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(4) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(5) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(6) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(7) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
LABELS(8) interface label for optional interface limits
summary table (blank for none) (blank by de-
fault)
Character*260 DFXFILE name of DFAX 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 DFAX data file specified
IERR = 4 same label specified for study and opposing
systems
IERR = 5 generators are converted
IERR = 6 buses in island(s) without a swing bus; use
activity TREE
IERR = 7 largest mismatch exceeds mismatch toler-
ance
IERR = 8 error opening file DFXFILE
IERR = 9 file DFXFILE is not in the form of a PSSE-25 or
later DFAX file; run DFAX
IERR = 10 file DFXFILE does not contain distribution fac-
tors; run DFAX with distribution factor option
enabled
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
624
Power Flow TLTG
IERR = 11 no monitored branches or interfaces defined
IERR = 12 no subsystems defined
IERR = 13 subsystem not found
IERR = 14 specified subsystems overlap
IERR = 15 no in-service buses in subsystem WORLD
IERR = 16 no tie lines from study system
IERR = 17 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
625
Power Flow TPCH
1.1.297. TPCH
Use this API to check the adjustment data associated with voltage or flow controlling transformers. It must
be referenced using one of the following procedures:
- One reference with APIOPT=1, followed by any number of either APIOPT=2 references and/or pairs of ref-
erences with APIOPT=2 and then 3, followed by one reference with APIOPT=4.
- 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 if NTRN from the APIOPT 2 reference
is greater than zero, followed by one APIOPT 4 reference.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TPCH SID ALL APIOPT OPT STATUS(1) STATUS(2) THRSH(1) THRSH(2)
Python command syntax:
ierr, ttyp, ntrn = tpch(sid, all, apiopt, opt, status, thrsh)
Fortran command syntax:
CALL TPCHNW(SID, ALL, APIOPT, OPT, STATUS, THRSH, TTYP, NTRN, 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 ALL all buses or specified subsystem flag (input; used only when APIOPT
is 0 or 1; 1).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer APIOPT mode of operation (input; 0 by default).
APIOPT = 0 initialize, check, modify adjustment data, and
terminate
APIOPT = 1 initialize for check and data modification
APIOPT = 2 check transformers
APIOPT = 3 modify adjustment data
APIOPT = 4 terminate transformer checks
Integer OPT option to select the type of adjustment (input; used only when
APIOPT is 0 or 2; 1).
OPT = 1 tap step = 0. (V/Mvar)
OPT = 2 0. < step < minimum (V/ Mvar)
OPT = 3 tap step > maximum (V/ Mvar)
OPT = 4 voltage band < 2*step (V)
OPT = 5 voltage band < minimum (V)
OPT = 6 voltage band > maximum (V)
OPT = 8 flow band < minimum (MW/Mvar)
OPT = 9 flow band > maximum (MW/Mvar)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
626
Power Flow TPCH
Integer STATUS (2) array of 2 elements specifying data modification options (used only
when APIOPT is 0 or 3)(input).
STATUS(1) modify steps or voltage bands, when OPT = 4
(1 by default)
STATUS(1) = 1 modify steps
STATUS(1) = 2 modify voltage bands
STATUS(2) used to indicate which transformers to
change where OPTs 1, 2, 3, 8 or 9 (0 by de-
fault)
STATUS(2) = 0 change both types
STATUS(2) = 1 change voltage controlling transformers
when OPT = 1, 2 or 3; change MW control-
ling transformers when OPT = 8 or 9
STATUS(2) = 2 change Mvar controlling transformers
Real THRSH (2) array of 2 elements specifying data checking and modification
parameters(input).
THRSH(1) threshold to use in initial test (used only
when APIOPT is 0 or 2; defaults: 0.00625
when OPT is 2 or 3; 0.02 when OPT is 5 or 6;
5.0 when OPT is 8 or 9)
THRSH(2) new tap step, voltage band, or flow band
(used only when APIOPT is 0 or 3)
If OPT
THRSH(2) = 1 new tap step (0.00625 by default)""
THRSH(2) = 2,3 new tap step (THRSH(1) by default)""
THRSH(2) = 5,6 new voltage band (THRSH(1) by default)""
THRSH(2) = 8,9 new flow band (THRSH(1) by default)""
Logical TTYP returned when APIOPT = 0, 2 or 3 and is TRUE. if both voltage (or MW
if OPT = 8 or 9) and Mvar controlling transformers were found (out-
put).
Integer NTRN returned when APIOPT = 0, 2 or 3 and is the number of transformers
that need adjustment when applying the adjustment type indicated
by OPT (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 OPT value
IERR = 5 invalid STATUS value
IERR = 6 invalid THRSH value
IERR = 7 unexpected APIOPT value
IERR = 8 no controlling transformers in case
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
627
Power Flow TPCH
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
628
Power Flow TRANSFORMER_PERCENT_UNITS
1.1.298. TRANSFORMER_PERCENT_UNITS
Use this API to specify or return the option to set the transformer percent units to either MVA or current ex-
pressed as MVA.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_TRANSFORMER_PERCENT_UNITS IVAL
Python command syntax:
ierr = transformer_percent_units(ival)
ierr, ival = transformer_percent_units()
Fortran command syntax:
CALL TRANSFORMER_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, 0 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
629
Power Flow TRANSMISSION_LINE_UNITS
1.1.299. TRANSMISSION_LINE_UNITS
Use this API to to specify or return the option set the transmission line units to either per unit or ohms.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_TRANSMISSION_LINE_UNITS IVAL
Python command syntax:
ierr = transmission_line_units(ival)
ierr, ival = transmission_line_units()
Fortran command syntax:
CALL TRANSMISSION_LINE_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, 0 by default;
else output).
IVAL = 0 per unit.
IVAL = 1 ohms and microfarads.
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
630
Power Flow TREE
1.1.300. TREE
Use this API to check for the existence of in-service ac islands that do not contain a Type 3 (swing) bus. Fol-
lowing each successful call, it returns BUSES as the number of buses in a swingless island (0 for no more
swingless islands). When a BUSES value of 0 is returned, no further calls are needed.
The API must be called once with APIOPT set to 1. If BUSES is returned as 0 (i.e., there are no swingless
islands), no further calls are needed. Otherwise, if BUSES is greater than zero, it must be called one or
more times with APIOPT set to 2 and OPTION set to indicate the disposition of the current swingless island.
APIOPT 2 calls are required until either BUSES is returned as zero or an APIOPT 2 call is made with OPTION
set to a negative value.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_TREE APIOPT OPTION
Python command syntax:
ierr, buses = tree(apiopt, option)
Fortran command syntax:
CALL TREEAPI(APIOPT, OPTION, BUSES, IERR)
Where:
Integer APIOPT mode of operation (input; no default allowed).
APIOPT = 1 initialize and check for the presence of a
swingless island
APIOPT = 2 process previously detected island as dictat-
ed by OPTION; then check for the presence of
another swingless island
Integer OPTION option for the handling of previously detected swingless island (in-
put; used only when APIOPT is 2; -1).
OPTION < 0 leave this island alone and terminate activity
TREE
OPTION = 0 leave this island alone and check for another
swingless island
OPTION > 0 disconnect this island, then check for another
swingless island
Integer BUSES returned as the number of buses in this swingless island; 0 if no more
swingless islands (output).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid APIOPT value
IERR = 2 unexpected APIOPT 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
631
Power Flow TYSL
1.1.301. TYSL
Use this API to run switching study network solutions.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TYSL OPT
Python command syntax:
ierr = tysl(opt)
Fortran command syntax:
CALL TYSLAPI(OPT, IERR)
Where:
Integer OPT flat start flag (input; 0 by default).
OPT = 0 use present voltage vector as starting point
OPT = 1 flat start
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPT value
IERR = 2 generators are not converted
IERR = 3 network is not ordered
IERR = 4 error reading the admittance matrix tempo-
rary file; one of the following occurred: Ad-
mittance matrix temporary file is not open;
Reading matrix pointers: different sizes speci-
fied than were used in writing them; Reading
matrix terms: different sizes specified than
were used in writing them
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
632
Power Flow USER
1.1.302. USER
Use this API to run the user-written activity, subroutine USERAC.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_USER
Python command syntax:
ierr = user()
Fortran command syntax:
CALL USERAPI(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
633
Power Flow VAMM
1.1.303. VAMM
Use this API to tabulate the vector absolute MW-mile report.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_VAMM
Python command syntax:
ierr = vamm()
Fortran command syntax:
CALL VAMMAPI(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no transactions 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
634
Power Flow VAMO
1.1.304. VAMO
Use this API to tabulate the vector absolute MW-ohm report.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_VAMO
Python command syntax:
ierr = vamo()
Fortran command syntax:
CALL VAMOAPI(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no transactions 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
635
Power Flow VCHK
1.1.305. VCHK
Use this API to tabulate those buses where voltage magnitude is outside a specified range.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_VCHK SID ALL VLO VHI
Python command syntax:
ierr = vchk(sid, all, vlo, vhi)
Fortran command syntax:
CALL VCHKNW(SID, ALL, VLO, VHI, 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
Real VLO lower limit of the voltage band (input; 0.95).
Real VHI upper limit of the voltage band (input; 1.05).
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
636
Power Flow VOLTAGE_INPUT
1.1.306. VOLTAGE_INPUT
Use this API to specify or return the voltage input option setting; either per unit or kV.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_VOLTAGE_INPUT IVAL
Python command syntax:
ierr = voltage_input(ival)
ierr, ival = voltage_input()
Fortran command syntax:
CALL VOLTAGE_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 per unit.
IVAL = 1 kV.
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
637
Power Flow VOLTAGE_OUTPUT
1.1.307. VOLTAGE_OUTPUT
Use this API to specify or return the voltage output option setting; either per unit or kV.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_VOLTAGE_OUTPUT IVAL
Python command syntax:
ierr = voltage_output(ival)
ierr, ival = voltage_output()
Fortran command syntax:
CALL VOLTAGE_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 per unit.
IVAL = 1 kV.
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
638
Power Flow VSMO
1.1.308. VSMO
Use this API to tabulate the vector MW-ohm report.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_VSMO
Python command syntax:
ierr = vsmo()
Fortran command syntax:
CALL VSMOAPI(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 no transactions 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
639
Power Flow WRITECAPCURVES
1.1.309. WRITECAPCURVES
Use this API to write the capability curve data in the working case in the form of a Capability Curve Raw Da-
ta File.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_WRITECAPCURVES SID ALL STATUS(1) STATUS(2) OUT OFILE
Python command syntax:
ierr = writecapcurves(sid, all, status, out, ofile)
Fortran command syntax:
CALL WRITECAPCURVES(SID, ALL, STATUS, 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 machines or those in the specified subsystem (input; 1 by default).
ALL = 0 process only machines in subsystem SID
ALL = 1 process all machines
Integer STATUS (2) array of 2 elements specifying options(input).
STATUS(1) include records for out-of-service machines
(1 by default)
STATUS(1) = 0 no
STATUS(1) = 1 yes
STATUS(2) 'IC" value on the first record (0 by default)
STATUS(2) = 0 for API routine ReadCapCurves with IC=0
STATUS(2) = 1 for API routine ReadCapCurves with IC=1
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 STATUS value
IERR = 4 invalid OUT value
IERR = 5 capability curve data is not in the working
case
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
640
Power Flow WRITECAPCURVES
IERR = 6 error opening OFILE
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
641
Power Flow WRITERAWVERSION
1.1.310. WRITERAWVERSION
Use this API to replicate the working case in the form of power flow raw data file compatible with PSSE 15
or later.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_WRITERAWVERSION 'VERNUM' OUT OFILE
Python command syntax:
ierr = writerawversion(vernum, out, ofile)
Fortran command syntax:
CALL WRITERAWVERSION(VERNUM, OUT, OFILE, IERR)
Where:
Integer or Character*14 VERNUM value of OFILE version number VERNUM ='15' or later. Example:
If OFILE format is to be PSSE 29.5.1: VERNUM='29' or ='29.5' or
='29.5.1' (input; no default allowed).
Integer OUT output destination (input; 1 by default).
OUT = 0 to OFILE
OUT = 1 to current report device
Character*260 OFILE name of the power flow raw data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VERNUM value
IERR = 2 invalid OUT value
IERR = 3 memory allocation Error
IERR = 4 error reading data
IERR = 5 error saving temporary 'sav' file
IERR = 6 error opening temporary 'sav' file
IERR = 7 error deleting temporary 'sav' file
IERR = 8 rrror opening OFILE
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
642
Power Flow WRITESEQVERSION
1.1.311. WRITESEQVERSION
This API routine is obsolete. It has been replaced by the API routine writeseqversion_2 .
Use this API to replicate the working case in the form of a network sequence data file compatible with PSSE
27 or later.
This API routine was first introduced in release 32.0.4.
Batch command syntax:
BAT_WRITESEQVERSION 'VERNUM' OUT OFILE
Python command syntax:
ierr = writeseqversion(vernum, out, ofile)
Fortran command syntax:
CALL WRITESEQVERSION(VERNUM, OUT, OFILE, IERR)
Where:
Integer or Character*14 VERNUM value of OFILE version number VERNUM ='27' or later. Example:
If OFILE format is to be PSSE 29.5.1: VERNUM='29' or ='29.5' or
='29.5.1' (input; no default allowed).
Integer OUT output destination (input; 1 by default).
OUT = 0 to OFILE
OUT = 1 to current report device
Character*260 OFILE name of the network sequence data file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VERNUM value
IERR = 2 invalid OUT value
IERR = 3 error opening OFILE
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
643
Power Flow WRITESEQVERSION_2
1.1.312. WRITESEQVERSION_2
Use this API to replicate the working case in the form of a network sequence data file compatible with PSSE
27 or later.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_WRITESEQVERSION_2 'VERNUM' OUT OFILE GZOPTN
Python command syntax:
ierr = writeseqversion_2(vernum, out, ofile, gzoptn)
Fortran command syntax:
CALL WRITESEQVERSION_2(VERNUM, OUT, OFILE, GZOPTN, IERR)
Where:
Integer or Character*14 VERNUM value of OFILE version number VERNUM ='27' or later. Example:
If OFILE format is to be PSSE 29.5.1: VERNUM='29' or ='29.5' or
='29.5.1' (input; no default allowed).
Integer OUT output destination (input; 1 by default).
OUT = 0 to OFILE
OUT = 1 to current report device
Character*260 OFILE name of the network sequence data file (input; no default allowed).
Integer GZOPTN generator reactance option (input; 0 by default).
GZOPTN = 0 save subtransient reactance
GZOPTN = 1 save transient reactance
GZOPTN = 2 save synchronous reactance
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VERNUM value
IERR = 2 invalid OUT value
IERR = 3 error opening OFILE
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
644
Power Flow WRITE_OPTIONS_FILE
1.1.313. WRITE_OPTIONS_FILE
Use this API to save the present values of the PSSE-25 program option settings to the file psse.opt.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_WRITE_OPTIONS_FILE
Python command syntax:
ierr = write_options_file()
Fortran command syntax:
CALL WRITE_OPTIONS_FILE_API(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
645
Power Flow XEQV
1.1.314. XEQV
Use this API to build an electrical equivalent of the portion of the working case outside of a specified sub-
system of the working case.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_XEQV SID ALL STATUS(1)..STATUS(6) DVAL(1) DVAL(2)
Python command syntax:
ierr = xeqv(sid, all, status, dval)
Fortran command syntax:
CALL XEQV(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 = 0 process only buses outside of subsystem SID
ALL = 1 process all buses
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
646
Power Flow XEQV
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
647
Power Flow ZONE
1.1.315. ZONE
This API routine is obsolete. It has been replaced by the API routine zone_2 .
Use this API to tabulate zone totals by zone.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ZONE SID ALL
Python command syntax:
ierr = zone(sid, all)
Fortran command syntax:
CALL ZONENW(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 = 4 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
648
Power Flow ZONE_2
1.1.316. ZONE_2
Use this API to tabulate zone totals by zone.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_ZONE_2 SID ALL OPT
Python command syntax:
ierr = zone_2(sid, all, opt)
Fortran command syntax:
CALL ZONE_2(SID, ALL, OPT, 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 OPT load reporting option (input; 2 by default).
OPT = 1 tabulate load connected to zone buses
OPT = 2 tabulate load assigned to the zone
OPT = 3 tabulate three load subtotals for each zone:
zone load connected to zone buses; zone load
connected to non-zone buses; non-zone load
connected to zone 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
649
Power Flow ZONE_AREA
1.1.317. ZONE_AREA
Use this API to tabulate zone totals by zone, along with subtotals by area.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_ZONE_AREA SID ALL
Python command syntax:
ierr = zone_area(sid, all)
Fortran command syntax:
CALL ZONE_AREA(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
650
Power Flow ZONM
1.1.318. ZONM
This API routine is obsolete. It has been replaced by the API routine zonm_2 .
Use this API to reassign the buses and loads in a specified subsystem of the working case from their origi-
nal zone to a designated zone.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ZONM SID ALL STATUS(1) STATUS(2) IZNEW
Python command syntax:
ierr = zonm(sid, all, status, iznew)
Fortran command syntax:
CALL ZONMNW(SID, ALL, STATUS, IZNEW, 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 (2) array of 2 elements specifying reporting options(input).
STATUS(1) zone assignments of buses to IZNEW (0 by
default)
STATUS(1) = 0 don't change zone assignments of buses to
IZNEW
STATUS(1) = 1 change zone assignments of buses to IZNEW
STATUS(2) zone assignments of loads to IZNEW (0 by
default)
STATUS(2) = 0 Don't change zone assignments of loads to
IZNEW
STATUS(2) = 1 Change zone assignments of loads to IZNEW
Integer IZNEW new zone to be assigned to specified buses and/or loads. IZNEW 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
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
651
Power Flow ZONM
IERR = 4 invalid new zone number
IERR = 5 zone table is full; cannot add zone 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
652
Power Flow ZONM_2
1.1.319. ZONM_2
Use this API routine to reassign the buses, loads and/or induction machines in a specified subsystem of the
working case from their original zone to a designated zone.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_ZONM_2 SID ALL STATUS(1) STATUS(2) STATUS(3) IZNEW
Python command syntax:
ierr = zonm_2(sid, all, status, iznew)
Fortran command syntax:
CALL ZONM_2(SID, ALL, STATUS, IZNEW, 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 (3) array of 3 elements specifying reporting options(input).
STATUS(1) zone assignments of buses to IZNEW (0 by
default)
STATUS(1) = 0 leave zone assignments of buses unchanged
STATUS(1) = 1 change zone assignments of buses to IZNEW
STATUS(2) zone assignments of loads to IZNEW (0 by
default)
STATUS(2) = 0 leave zone assignments of loads unchanged
STATUS(2) = 1 change zone assignments of loads to IZNEW
STATUS(3) zone assignments of induction machines to
IZNEW (0 by default)
STATUS(3) = 0 leave zone assignments of induction ma-
chines unchanged
STATUS(3) = 1 change zone assignments of induction ma-
chines to IZNEW
Integer IZNEW new zone to be assigned to specified buses, load, and/or induction
machines. IZNEW 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
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
653
Power Flow ZONM_2
IERR = 3 invalid STATUS value
IERR = 4 invalid new zone number
IERR = 5 zone table is full; cannot add zone 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
654
Power Flow ZONM_2
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
655
Power Flow Power Flow Data
1.2. Power Flow Data
This section describes the API routines used to add, modify, or remove power flow data, other than substation
data.
For most categories of power flow data, there are a pair of API routines for specifying data; one of these
contains "_DATA" as part of the API name, and the other contains "_CHNG" in its API name. The "_DATA" API
routines may be used to add a new network element to the working case, or to modify the data of an existing
network element. The "_CHNG" API routines may be used only to modify the data of an existing network
element; specifying a network element that does not already exist in the working case to one of the "_CHNG"
API routines is treated as a fatal error by the API routine.
Generally, when an API is adding a new element to the working case, data items that are defaulted are set
to the value listed in the data item’s description. When an API is modifying the data of an existing element,
defaulted data items are unchanged.
1.2.1. AREA_DATA
Use this API to modify area data in the working case (see PSSE Program Operation Manual, Areas, Zones
and Owners).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_AREA_DATA IAREA IBUS REALAR(1) REALAR(2) 'ARNAME'
Python command syntax:
ierr = area_data(iarea, ibus, realar, arname)
Fortran command syntax:
CALL AREA_API_2(IAREA, IBUS, REALAR, ARNAME, IERR)
Where:
Integer IAREA area number between 1 and 9999 (input; no default allowed).
Integer IBUS area slack bus number (input; no default allowed).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) PDES, desired MW area interchange (0.0 by
default)
REALAR(2) PTOL, desired MW interchange tolerance (0.1
* SBASE by default; for example, when sys-
tem base MVA is 100.0, the default value of
PTOL is 10 MW)
Character*12 ARNAME area name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
656
Power Flow AREA_DATA
IERR = 1 invalid area number
IERR = 2 area table is full
IERR = 3 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Area slack bus not
found. - Slack bus is not in this area. - No
plant at slack bus. - Type code of slack bus is
not 2 or 3. - A Type 3 bus is in the area but it
is not the area slack bus. - No equipment is
assigned to area
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
657
Power Flow BRANCH_CHNG
1.2.2. BRANCH_CHNG
This API routine is obsolete. It has been replaced by the API routine branch_chng_3 .
Use this API routine to modify the data of an existing non-transformer branch in the working case (see
PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_BRANCH_CHNG IBUS JBUS 'CKT' INTGAR(1)..INTGAR(6)
REALAR(1)..REALAR(15)
Python command syntax:
ierr = branch_chng(ibus, jbus, ckt, intgar, realar)
Fortran command syntax:
CALL BRANCH_CHNG(IBUS, JBUS, CKT, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) ST, branch status (alias is ST) (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (alias is METBUS) (IBUS by default)
INTGAR(3) O1, first owner number (alias is O1) (owner
of bus IBUS by default)
INTGAR(4) O2, second owner number (alias is O2) (0 by
default)
INTGAR(5) O3, third owner number (alias is O3) (0 by
default)
INTGAR(6) O4, fourth owner number (alias is O4) (0 by
default)
Real REALAR (15) array of 15 elements specifying (input).
REALAR(1) R, nominal branch resistance (alias is R) (0.0
by default)
REALAR(2) X, nominal branch reactance (alias is X)
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALAR(3) B, total line charging (alias is B) (0.0 by de-
fault)
REALAR(4) RATEA, rating set A line rating (alias is RATEA)
(0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
658
Power Flow BRANCH_CHNG
REALAR(5) RATEB, rating set B line rating (alias is RATEB)
(0.0 by default)
REALAR(6) RATEC, rating set C line rating (alias is RATEC)
(0.0 by default)
REALAR(7) GI, real line shunt at bus IBUS end (alias is GI)
(0.0 by default)
REALAR(8) BI, reactive line shunt at bus IBUS end (alias
is BI) (0.0 by default)
REALAR(9) GJ, real line shunt at bus JBUS end (alias is
GJ) (0.0 by default)
REALAR(10) BJ, reactive line shunt at bus JBUS end (alias
is BJ) (0.0 by default)
REALAR(11) LEN, line length (alias is LEN) (0.0 by default)
REALAR(12) F1, first owner fraction (alias is F1) (1.0 by
default)
REALAR(13) F2, second owner fraction (alias is F2) (1.0
by default)
REALAR(14) F3, third owner fraction (alias is F3) (1.0 by
default)
REALAR(15) F4, fourth owner fraction (alias is F4) (1.0 by
default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a two-winding trans-
former
IERR = 9 branch not found
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - branch reactance is
0.0 - line length is negative - zero impedance
line table is full; branch is treated as a normal
line - invalid metered end bus - invalid branch
status - invalid owner number - invalid owner-
ship fraction - no ownership data is specified
- multi-section line grouping deleted - branch
ownership table is full--only first n owners re-
tained - branch is no longer treated as a zero
impedance line - owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
659
Power Flow BRANCH_CHNG_3
1.2.3. BRANCH_CHNG_3
Use this API routine to modify the data of an existing non-transformer branch in the working case (see
PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_BRANCH_CHNG_3 IBUS JBUS CKT INTGAR(1)..INTGAR(6)
REALAR(1)..REALAR(12) RATINGS(1)..RATINGS(12) NAMEAR
Python command syntax:
ierr = branch_chng_3(ibus, jbus, ckt, intgar, realar, ratings, namear)
Fortran command syntax:
CALL BRANCH_CHNG_3(IBUS, JBUS, CKT, INTGAR, REALAR, RATINGS, NAMEAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) ST, branch status (alias is ST) (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (alias is METBUS) (IBUS by default)
INTGAR(3) O1, first owner number (alias is O1) (owner
of bus IBUS by default)
INTGAR(4) O2, second owner number (alias is O2) (0 by
default)
INTGAR(5) O3, third owner number (alias is O3) (0 by
default)
INTGAR(6) O4, fourth owner number (alias is O4) (0 by
default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) R, nominal branch resistance (alias is R) (0.0
by default)
REALAR(2) X, nominal branch reactance (alias is X)
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALAR(3) B, total line charging (alias is B) (0.0 by de-
fault)
REALAR(4) GI, real line shunt at bus IBUS end (alias is GI)
(0.0 by default)
REALAR(5) BI, reactive line shunt at bus IBUS end (alias
is BI) (0.0 by default)
REALAR(6) GJ, real line shunt at bus JBUS end (alias is
GJ) (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
660
Power Flow BRANCH_CHNG_3
REALAR(7) BJ, reactive line shunt at bus JBUS end (alias
is BJ) (0.0 by default)
REALAR(8) LEN, line length (alias is LEN) (0.0 by default)
REALAR(9) F1, first owner fraction (alias is F1) (1.0 by
default)
REALAR(10) F2, second owner fraction (alias is F2) (1.0
by default)
REALAR(11) F3, third owner fraction (alias is F3) (1.0 by
default)
REALAR(12) F4, fourth owner fraction (alias is F4) (1.0 by
default)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1, rating set 1 line rating (alias is RATE1)
(0.0 by default)
RATINGS(2) RATE2, rating set 2 line rating (alias is RATE2)
(0.0 by default)
RATINGS(3) RATE3, rating set 3 line rating (alias is RATE3)
(0.0 by default)
RATINGS(4) RATE4, rating set 4 line rating (alias is RATE4)
(0.0 by default)
RATINGS(5) RATE5, rating set 5 line rating (alias is RATE5)
(0.0 by default)
RATINGS(6) RATE6, rating set 6 line rating (alias is RATE6)
(0.0 by default)
RATINGS(7) RATE7, rating set 7 line rating (alias is RATE7)
(0.0 by default)
RATINGS(8) RATE8, rating set 8 line rating (alias is RATE8)
(0.0 by default)
RATINGS(9) RATE9, rating set 9 line rating (alias is RATE9)
(0.0 by default)
RATINGS(10) RATE10, rating set 10 line rating (alias is
RATE10) (0.0 by default)
RATINGS(11) RATE11, rating set 11 line rating (alias is
RATE11) (0.0 by default)
RATINGS(12) RATE12, rating set 12 line rating (alias is
RATE12) (0.0 by default)
Character*40 NAMEAR branch name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a two-winding trans-
former
IERR = 4 branch from a bus to itself
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
661
Power Flow BRANCH_CHNG_3
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &
IERR = 7 branch table is full
IERR = 8 branch ownership table is full
IERR = 9 branch not found
IERR = 10 prerequisite requirements for API are not met
IERR = 11 branch exists but it is a system switching de-
vice
IERR = 13 node-breaker terminal connection table is full
IERR = -1 data error, warning and information mes-
sages; one or more of: - branch reactance is
0.0 - line length is negative - zero impedance
line table is full; branch is treated as a normal
line - invalid metered end bus - invalid branch
status - invalid owner number - invalid owner-
ship fraction - no ownership data is specified
- multi-section line grouping deleted - branch
ownership table is full--only first n owners re-
tained - branch is no longer treated as a ze-
ro impedance line - owner table is full - rat-
ing is negative - branch exists but is a system
switching device - name is already assigned
to a branch - name contains invalid charac-
ters - non-transformer branch connects buses
with different base voltages
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
662
Power Flow BRANCH_DATA
1.2.4. BRANCH_DATA
This API routine is obsolete. It has been replaced by the API routine branch_data_3 .
Use this API to modify the data of an existing non-transformer branch in the working case or to add a
new non-transformer branch to the working case (see PSSE Program Operation Manual, Non-Transformer
Branch Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_BRANCH_DATA IBUS JBUS 'CKT' INTGAR(1)..INTGAR(6)
REALAR(1)..REALAR(15)
Python command syntax:
ierr = branch_data(ibus, jbus, ckt, intgar, realar)
Fortran command syntax:
CALL BRANCH_API_2(IBUS, JBUS, CKT, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) ST, branch status (alias is ST) (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (alias is METBUS) (IBUS by default)
INTGAR(3) O1, first owner number (alias is O1) (owner
of bus IBUS by default)
INTGAR(4) O2, second owner number (alias is O2) (0 by
default)
INTGAR(5) O3, third owner number (alias is O3) (0 by
default)
INTGAR(6) O4, fourth owner number (alias is O4) (0 by
default)
Real REALAR (15) array of 15 elements specifying (input).
REALAR(1) R, nominal branch resistance (alias is R) (0.0
by default)
REALAR(2) X, nominal branch reactance (alias is X)
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALAR(3) B, total line charging (alias is B) (0.0 by de-
fault)
REALAR(4) RATEA, rating set A line rating (alias is RATEA)
(0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
663
Power Flow BRANCH_DATA
REALAR(5) RATEB, rating set B line rating (alias is RATEB)
(0.0 by default)
REALAR(6) RATEC, rating set C line rating (alias is RATEC)
(0.0 by default)
REALAR(7) GI, real line shunt at bus IBUS end (alias is GI)
(0.0 by default)
REALAR(8) BI, reactive line shunt at bus IBUS end (alias
is BI) (0.0 by default)
REALAR(9) GJ, real line shunt at bus JBUS end (alias is
GJ) (0.0 by default)
REALAR(10) BJ, reactive line shunt at bus JBUS end (alias
is BJ) (0.0 by default)
REALAR(11) LEN, line length (alias is LEN) (0.0 by default)
REALAR(12) F1, first owner fraction (alias is F1) (1.0 by
default)
REALAR(13) F2, second owner fraction (alias is F2) (1.0
by default)
REALAR(14) F3, third owner fraction (alias is F3) (1.0 by
default)
REALAR(15) F4, fourth owner fraction (alias is F4) (1.0 by
default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a two-winding trans-
former
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &
IERR = 7 branch table is full
IERR = 8 branch ownership table is full
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - branch reactance is
0.0 - line length is negative - zero impedance
line table is full; branch is treated as a normal
line - invalid metered end bus - invalid branch
status - invalid owner number - invalid owner-
ship fraction - no ownership data is specified
- multi-section line grouping deleted - branch
ownership table is full--only first n owners re-
tained - branch is no longer treated as a zero
impedance line - owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
664
Power Flow BRANCH_DATA_3
1.2.5. BRANCH_DATA_3
Use this API to modify the data of an existing non-transformer branch in the working case or to add a
new non-transformer branch to the working case (see PSSE Program Operation Manual, Non-Transformer
Branch Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_BRANCH_DATA_3 IBUS JBUS CKT INTGAR(1)..INTGAR(6)
REALAR(1)..REALAR(12) RATINGS(1)..RATINGS(12) NAMEAR
Python command syntax:
ierr = branch_data_3(ibus, jbus, ckt, intgar, realar, ratings, namear)
Fortran command syntax:
CALL BRANCH_DATA_3(IBUS, JBUS, CKT, INTGAR, REALAR, RATINGS, NAMEAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) ST, branch status (alias is ST) (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (alias is METBUS) (IBUS by default)
INTGAR(3) O1, first owner number (alias is O1) (owner
of bus IBUS by default)
INTGAR(4) O2, second owner number (alias is O2) (0 by
default)
INTGAR(5) O3, third owner number (alias is O3) (0 by
default)
INTGAR(6) O4, fourth owner number (alias is O4) (0 by
default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) R, nominal branch resistance (alias is R) (0.0
by default)
REALAR(2) X, nominal branch reactance (alias is X)
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALAR(3) B, total line charging (alias is B) (0.0 by de-
fault)
REALAR(4) GI, real line shunt at bus IBUS end (alias is GI)
(0.0 by default)
REALAR(5) BI, reactive line shunt at bus IBUS end (alias
is BI) (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
665
Power Flow BRANCH_DATA_3
REALAR(6) GJ, real line shunt at bus JBUS end (alias is
GJ) (0.0 by default)
REALAR(7) BJ, reactive line shunt at bus JBUS end (alias
is BJ) (0.0 by default)
REALAR(8) LEN, line length (alias is LEN) (0.0 by default)
REALAR(9) F1, first owner fraction (alias is F1) (1.0 by
default)
REALAR(10) F2, second owner fraction (alias is F2) (1.0
by default)
REALAR(11) F3, third owner fraction (alias is F3) (1.0 by
default)
REALAR(12) F4, fourth owner fraction (alias is F4) (1.0 by
default)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1, rating set 1 line rating (alias is RATE1)
(0.0 by default)
RATINGS(2) RATE2, rating set 2 line rating (alias is RATE2)
(0.0 by default)
RATINGS(3) RATE3, rating set 3 line rating (alias is RATE3)
(0.0 by default)
RATINGS(4) RATE4, rating set 4 line rating (alias is RATE4)
(0.0 by default)
RATINGS(5) RATE5, rating set 5 line rating (alias is RATE5)
(0.0 by default)
RATINGS(6) RATE6, rating set 6 line rating (alias is RATE6)
(0.0 by default)
RATINGS(7) RATE7, rating set 7 line rating (alias is RATE7)
(0.0 by default)
RATINGS(8) RATE8, rating set 8 line rating (alias is RATE8)
(0.0 by default)
RATINGS(9) RATE9, rating set 9 line rating (alias is RATE9)
(0.0 by default)
RATINGS(10) RATE10, rating set 10 line rating (alias is
RATE10) (0.0 by default)
RATINGS(11) RATE11, rating set 11 line rating (alias is
RATE11) (0.0 by default)
RATINGS(12) RATE12, rating set 12 line rating (alias is
RATE12) (0.0 by default)
Character*40 NAMEAR branch name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
666
Power Flow BRANCH_DATA_3
IERR = 3 branch exists but it is a two-winding trans-
former
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &
IERR = 7 branch table is full
IERR = 8 branch ownership table is full
IERR = 10 prerequisite requirements for API are not met
IERR = 11 branch exists but it is a system switching de-
vice
IERR = 13 node-breaker terminal connection table is full
IERR = -1 data error, warning and information mes-
sages; one or more of: - branch reactance is
0.0 - line length is negative - zero impedance
line table is full; branch is treated as a normal
line - invalid metered end bus - invalid branch
status - invalid owner number - invalid owner-
ship fraction - no ownership data is specified
- multi-section line grouping deleted - branch
ownership table is full--only first n owners re-
tained - branch is no longer treated as a ze-
ro impedance line - owner table is full - rat-
ing is negative - name already assigned to a
branch - name contains invalid characters -
non-transformer branch connects buses with
different base voltages
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
667
Power Flow BUS_CHNG_3
1.2.6. BUS_CHNG_3
This API routine is obsolete. It has been replaced by the API routine bus_chng_4 .
Use this API routine to modify the data of an existing bus in the working case (see PSSE Program Operation
Manual, Bus Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_BUS_CHNG_3 IBUS INTGAR(1)..INTGAR(4) REALAR(1)..REALAR(7) 'NAME'
Python command syntax:
ierr = bus_chng_3(ibus, intgar, realar, name)
Fortran command syntax:
CALL BUS_CHNG_3(IBUS, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IDE, bus type code (1 by default)
INTGAR(2) AREA, area number (1 by default)
INTGAR(3) ZONE, zone number (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
Real REALAR (7) array of 7 elements specifying (input).
REALAR(1) BASKV, bus base voltage in kV (0.0 by de-
fault)
REALAR(2) VM, bus voltage magnitude in pu (1.0 by de-
fault)
REALAR(3) VA, bus voltage phase angle (0.0 by default)
REALAR(4) NMAXV, normal bus voltage magnitude high
limit in pu (1.1 by default)
REALAR(5) NMINV, normal bus voltage magnitude low
limit in pu (0.9 by default)
REALAR(6) EMAXV, emergency bus voltage magnitude
high limit in pu (1.1 by default)
REALAR(7) EMINV, emergency bus voltage magnitude
low limit in pu (0.9 by default)
Character*12 NAME bus name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid bus number
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
668
Power Flow BUS_CHNG_3
IERR = 3 working case is not initialized
IERR = 4 bus not found
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid base voltage.
- Invalid bus type code. - Invalid area, zone or
owner number. - Bus name is more than 12
characters. - New area number but bus is the
area swing for its old area. - Bus type code is
3 but is not the swing bus for its area. - Area
table is full. - Zone table is full. - Owner table
is full. - High voltage limit is not greater than
the low voltage limit. - Normal voltage limit is
less restrictive than the emergency limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
669
Power Flow BUS_CHNG_4
1.2.7. BUS_CHNG_4
Use this API routine to modify the data of an existing bus in the working case (see PSSE Program Operation
Manual, Bus Data).
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_BUS_CHNG_4 IBUS INODE INTGAR(1)..INTGAR(4) REALAR(1)..REALAR(7)
'NAME'
Python command syntax:
ierr = bus_chng_4(ibus, inode, intgar, realar, name)
Fortran command syntax:
CALL BUS_CHNG_4(IBUS, INODE, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INODE bus section node number (input; no default allowed).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IDE, bus type code (1 by default)
INTGAR(2) AREA, area number (1 by default)
INTGAR(3) ZONE, zone number (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
Real REALAR (7) array of 7 elements specifying (input).
REALAR(1) BASKV, bus base voltage in kV (0.0 by de-
fault)
REALAR(2) VM, bus voltage magnitude in pu (1.0 by de-
fault)
REALAR(3) VA, bus voltage phase angle (0.0 by default)
REALAR(4) NMAXV, normal bus voltage magnitude high
limit in pu (1.1 by default)
REALAR(5) NMINV, normal bus voltage magnitude low
limit in pu (0.9 by default)
REALAR(6) EMAXV, emergency bus voltage magnitude
high limit in pu (1.1 by default)
REALAR(7) EMINV, emergency bus voltage magnitude
low limit in pu (0.9 by default)
Character*12 NAME bus name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid bus number
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
670
Power Flow BUS_CHNG_4
IERR = 3 working case is not initialized
IERR = 4 bus not found
IERR = 5 invalid node number
IERR = 6 bus does not belong to a substation
IERR = 7 inode is not found in the substation
IERR = 8 inode is not connected to any bus section of
bus
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid base voltage.
- Invalid bus type code. - Invalid area, zone or
owner number. - Bus name is more than 12
characters. - New area number but bus is the
area swing for its old area. - Bus type code is
3 but is not the swing bus for its area. - Area
table is full. - Zone table is full. - Owner table
is full. - High voltage limit is not greater than
the low voltage limit. - Normal voltage limit is
less restrictive than the emergency limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
671
Power Flow BUS_DATA
1.2.8. BUS_DATA
This API routine is obsolete. It has been replaced by the API routine bus_data_2 .
Use this API to modify the data of an existing bus in the working case or to add a new bus to the working
case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_BUS_DATA IBUS INTGAR(1)..INTGAR(4) REALAR(1)..REALAR(5) 'NAME'
Python command syntax:
ierr = bus_data(ibus, intgar, realar, name)
Fortran command syntax:
CALL BUS_API(IBUS, INTGAR, REALAR, NAME, IERR, NERR)
Where:
Integer IBUS bus number (input).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IDE, bus type code
INTGAR(2) AREA, area number
INTGAR(3) ZONE, zone number
INTGAR(4) OWNER, owner number
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) GL, fixed shunt admittance (conductance)
REALAR(2) BL, fixed shunt admittance (susceptance)
REALAR(3) BASKV, bus base voltage in kV
REALAR(4) VM, bus voltage magnitude in pu
REALAR(5) VA, bus voltage phase angle
Character*12 NAME bus name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid bus number
IERR = 2 bus table is full
IERR = 3 working case is not initialized
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid base voltage.
- Invalid bus type code. - Invalid area, zone or
owner number. - Bus name is more than 12
characters. - New area number but bus is the
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
672
Power Flow BUS_DATA
area swing for its old area. - Bus type code is
3 but is not the swing bus for its area. - Area
table is full. - Zone table is full. - Owner table
is full
Integer NERR number of entries in PBUF02 containing error messages (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
673
Power Flow BUS_DATA_2
1.2.9. BUS_DATA_2
This API routine is obsolete. It has been replaced by the API routine bus_data_3 .
Use this API to modify the data of an existing bus in the working case or to add a new bus to the working
case (see PSSE Program Operation Manual, Bus Data).
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_BUS_DATA_2 IBUS INTGAR(1)..INTGAR(4) REALAR(1)..REALAR(3) 'NAME'
Python command syntax:
ierr = bus_data_2(ibus, intgar, realar, name)
Fortran command syntax:
CALL BUS_API_2(IBUS, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IDE, bus type code (1 by default)
INTGAR(2) AREA, area number (1 by default)
INTGAR(3) ZONE, zone number (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
Real REALAR (3) array of 3 elements specifying (input).
REALAR(1) BASKV, bus base voltage in kV (0.0 by de-
fault)
REALAR(2) VM, bus voltage magnitude in pu (1.0 by de-
fault)
REALAR(3) VA, bus voltage phase angle (0.0 by default)
Character*12 NAME bus name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid bus number
IERR = 2 bus table is full
IERR = 3 working case is not initialized
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid base voltage.
- Invalid bus type code. - Invalid area, zone or
owner number. - Bus name is more than 12
characters. - New area number but bus is the
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
674
Power Flow BUS_DATA_2
area swing for its old area. - Bus type code is
3 but is not the swing bus for its area. - Area
table is full. - Zone table is full. - Owner table
is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
675
Power Flow BUS_DATA_3
1.2.10. BUS_DATA_3
This API routine is obsolete. It has been replaced by the API routine bus_data_4 .
Use this API routine to modify the data of an existing bus in the working case, or to add a new bus to the
working case (see PSSE Program Operation Manual, Bus Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_BUS_DATA_3 IBUS INTGAR(1)..INTGAR(4) REALAR(1)..REALAR(7) 'NAME'
Python command syntax:
ierr = bus_data_3(ibus, intgar, realar, name)
Fortran command syntax:
CALL BUS_API_3(IBUS, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IDE, bus type code (1 by default)
INTGAR(2) AREA, area number (1 by default)
INTGAR(3) ZONE, zone number (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
Real REALAR (7) array of 7 elements specifying (input).
REALAR(1) BASKV, bus base voltage in kV (0.0 by de-
fault)
REALAR(2) VM, bus voltage magnitude in pu (1.0 by de-
fault)
REALAR(3) VA, bus voltage phase angle (0.0 by default)
REALAR(4) NMAXV, normal bus voltage magnitude high
limit in pu (1.1 by default)
REALAR(5) NMINV, normal bus voltage magnitude low
limit in pu (0.9 by default)
REALAR(6) EMAXV, emergency bus voltage magnitude
high limit in pu (1.1 by default)
REALAR(7) EMINV, emergency bus voltage magnitude
low limit in pu (0.9 by default)
Character*12 NAME bus name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid bus number
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
676
Power Flow BUS_DATA_3
IERR = 2 bus table is full
IERR = 3 working case is not initialized
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid base voltage.
- Invalid bus type code. - Invalid area, zone or
owner number. - Bus name is more than 12
characters. - New area number but bus is the
area swing for its old area. - Bus type code is
3 but is not the swing bus for its area. - Area
table is full. - Zone table is full. - Owner table
is full. - High voltage limit is not greater than
the low voltage limit. - Normal voltage limit is
less restrictive than the emergency limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
677
Power Flow BUS_DATA_4
1.2.11. BUS_DATA_4
Use this API routine to modify the data of an existing bus in the working case, or to add a new bus to the
working case (see PSSE Program Operation Manual, Bus Data).
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_BUS_DATA_4 IBUS INODE INTGAR(1)..INTGAR(4) REALAR(1)..REALAR(7)
'NAME'
Python command syntax:
ierr = bus_data_4(ibus, inode, intgar, realar, name)
Fortran command syntax:
CALL BUS_API_4(IBUS, INODE, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INODE bus section node number (input; no default allowed).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IDE, bus type code (1 by default)
INTGAR(2) AREA, area number (1 by default)
INTGAR(3) ZONE, zone number (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
Real REALAR (7) array of 7 elements specifying (input).
REALAR(1) BASKV, bus base voltage in kV (0.0 by de-
fault)
REALAR(2) VM, bus voltage magnitude in pu (1.0 by de-
fault)
REALAR(3) VA, bus voltage phase angle (0.0 by default)
REALAR(4) NMAXV, normal bus voltage magnitude high
limit in pu (1.1 by default)
REALAR(5) NMINV, normal bus voltage magnitude low
limit in pu (0.9 by default)
REALAR(6) EMAXV, emergency bus voltage magnitude
high limit in pu (1.1 by default)
REALAR(7) EMINV, emergency bus voltage magnitude
low limit in pu (0.9 by default)
Character*12 NAME bus name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid bus number
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
678
Power Flow BUS_DATA_4
IERR = 2 bus table is full
IERR = 3 working case is not initialized
IERR = 5 invalid node number
IERR = 6 bus does not belong to a substation
IERR = 7 inode is not found in the substation
IERR = 8 inode is not connected to any bus section of
bus
IERR = 9 inode must be 0 for bus not in the case
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid base voltage.
- Invalid bus type code. - Invalid area, zone or
owner number. - Bus name is more than 12
characters. - New area number but bus is the
area swing for its old area. - Bus type code is
3 but is not the swing bus for its area. - Area
table is full. - Zone table is full. - Owner table
is full. - High voltage limit is not greater than
the low voltage limit. - Normal voltage limit is
less restrictive than the emergency limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
679
Power Flow BUS_NUMBER
1.2.12. BUS_NUMBER
Use this API to change the bus number of an existing bus in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_BUS_NUMBER IBUS NEWBUS
Python command syntax:
ierr = bus_number(ibus, newbus)
Fortran command syntax:
CALL BUS_NUMBER_API_2(IBUS, NEWBUS, IERR)
Where:
Integer IBUS current bus number of the bus for which the number is to be
changed (input; no default allowed).
Integer NEWBUS new bus number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 invalid new bus number
IERR = 3 bus number NEWBUS is already assigned to
another bus
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - None
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
680
Power Flow CASE_TITLE_DATA
1.2.13. CASE_TITLE_DATA
Use this API to change the two line case title in the working case (see PSSE Program Operation Manual,
Case Identification Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CASE_TITLE_DATA 'LINE1' 'LINE2'
Python command syntax:
ierr = case_title_data(line1, line2)
Fortran command syntax:
CALL CASE_TITLE_API_2(LINE1, LINE2, IERR)
Where:
Character*60 LINE1 first title line (input; unchanged).
Character*60 LINE2 second title line (input; unchanged).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Title line exceeds 60
characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
681
Power Flow CASOLUTION_PARAMETERS
1.2.14. CASOLUTION_PARAMETERS
Use this API to modify the contingency analysis solution parameters.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_CASOLUTION_PARAMETERS INTGAR(1)..INTGAR(9) REALAR(1)..REALAR(4)
Python command syntax:
ierr = casolution_parameters(intgar, realar)
Fortran command syntax:
CALL CASOLUTION_PARAMETER_API(INTGAR, REALAR, IERR)
Where:
Integer INTGAR (9) array of 9 elements specifying (input).
INTGAR(1) RATBAS, base case rating (1 by default)
INTGAR(2) RATCNT, contingency case rating (2 by de-
fault)
INTGAR(3) MWRATE, Convert MVA to MW for DC solu-
tion (1 by default)
INTGAR(4) VLTBAS, base case voltage limit (1 by default)
INTGAR(5) VLTCNT, contingency case voltage limit (2 by
default)
INTGAR(6) SCRCAS, enable AC contingency case screen-
ing (0 by default)
INTGAR(7) INCLOS, include loss estimates in DC solution
(0 by default)
INTGAR(8) ROSOLN, Enable Robust Power flow solution
for non-converged cases (0 by default)
INTGAR(9) BASLOD, Base loaded machine option (0 by
default)
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) RATPCT, percent of loading (100 by default)
REALAR(2) LOADCT, loading cutoff (2 by default)
REALAR(3) CHAGMW, flow change cutoff in MW (100 by
default)
REALAR(4) TOTGEN,Total generation dispatch limit
(10000 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal 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
682
Power Flow CASOLUTION_PARAMETERS_2
1.2.15. CASOLUTION_PARAMETERS_2
Use this API to modify the contingency analysis solution parameters.
This API routine was first introduced in release 35.2.0.
Batch command syntax:
BAT_CASOLUTION_PARAMETERS INTGAR(1)..INTGAR(10) REALAR(1)..REALAR(4)
Python command syntax:
ierr = casolution_parameters_2(intgar, realar)
Fortran command syntax:
CALL CASOLUTION_PARAMETER_API_2(INTGAR, REALAR, IERR)
Where:
Integer INTGAR (10) array of 10 elements specifying (input).
INTGAR(1) RATBAS, base case rating (1 by default)
INTGAR(2) RATCNT, contingency case rating (2 by de-
fault)
INTGAR(3) MWRATE, Convert MVA to MW for DC solu-
tion (1 by default)
INTGAR(4) VLTBAS, base case voltage limit (1 by default)
INTGAR(5) VLTCNT, contingency case voltage limit (2 by
default)
INTGAR(6) SCRCAS, enable AC contingency case screen-
ing (0 by default)
INTGAR(7) INCLOS, include loss estimates in DC solution
(0 by default)
INTGAR(8) ROSOLN, Enable Robust Power flow solution
for non-converged cases (0 by default)
INTGAR(9) BASLOD, Base loaded machine option (0 by
default)
INTGAR(10) RASFLG, enable RAS (0 by default)
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) RATPCT, percent of loading (100 by default)
REALAR(2) LOADCT, loading cutoff (2 by default)
REALAR(3) CHAGMW, flow change cutoff in MW (100 by
default)
REALAR(4) TOTGEN,Total generation dispatch limit
(10000 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal 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
683
Power Flow CASOLUTION_PARAMETERS_2
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
684
Power Flow EXTR
1.2.16. EXTR
Use this API to purge specified buses and all branches connected to them from the working case (activity
EXTR).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_EXTR SID ALL STATUS(1) STATUS(2)
Python command syntax:
ierr = extr(sid, all, status)
Fortran command syntax:
CALL EXTRNW(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 (when ALL
is 0) (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; 0 by default).
ALL = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer STATUS (2) array of 2 elements specifying They are used to control subsystem re-
moval 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) remove generator entries for out-of-service
plants (0 by default)
STATUS(2) change codes of boundary buses (0 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 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
685
Power Flow FACTS_CHNG_2
1.2.17. FACTS_CHNG_2
This API routine is obsolete. It has been replaced by the API routine facts_chng_3 .
Use this API routine to modify the data of an existing FACTS device in the working case (see PSSE Program
Operation Manual, FACTS Device Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_FACTS_CHNG_2 'NAME' INTGAR(1)..INTGAR(6) REALAR(1)..REALAR(13)
'MNAME'
Python command syntax:
ierr, realaro = facts_chng_2(name, intgar, realari, mname)
Fortran command syntax:
CALL FACTS_CHNG_2(NAME, INTGAR, REALAR, MNAME, IERR)
Where:
Character*12 NAME name of the FACTS device (input; no default allowed).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) I, sending end bus number (no default al-
lowed)
INTGAR(2) J, terminal end bus number (0 for STATCON)
(0 by default)
INTGAR(3) MODE, control mode (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
INTGAR(5) VSREF, series voltage reference code for
modes 4 and 7 (0 for sending end voltage; 1
for series current) (0 by default)
INTGAR(6) REMOT, remote bus number (0 for sending
end bus) (0 by default)
Real REALAR (19) (first thirteen are input values; last six are output values) (input (out-
put).).
Real REALARI (13) array of 13 elements specifying corresponding to values REALAR(1)
through REALAR(13) as described above(input).
REALARI(1) PDES, desired real power at terminal bus (0.0
by default)
REALARI(2) QDES, desired reactive power at terminal bus
(0.0 by default)
REALARI(3) VSET, sending bus voltage setpoint (1.0 by
default)
REALARI(4) SHMX, sending end maximum shunt current
(MVA at rated voltage) (99.99 * SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
686
Power Flow FACTS_CHNG_2
REALARI(5) TRMX, maximum bridge real power transfer
(99.99 * SBASE by default)
REALARI(6) VTMN, minimum terminal bus voltage mag-
nitude (0.9 by default)
REALARI(7) VTMX, maximum terminal bus voltage mag-
nitude (1.1 by default)
REALARI(8) VSMX, maximum series voltage magnitude
(1.0 by default)
REALARI(9) IMX, maximum series current (MVA at rated
voltage) (0.0 by default)
REALARI(10) LINX, pu reactance of temporary series ele-
ment (0.05 by default)
REALARI(11) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
REALARI(12) SET1, real component of constant Z (MODE =
3), magnitude of constant V (MODE = 4), or
VD (MODE = 7 or 8) (0.0 by default)
REALARI(13) SET2, imaginary component of constant Z
(MODE = 3), angle of constant V (MODE =
4), or VQ (MODE = 7 or 8) (0.005 by default
when MODE = 3; 0.0 otherwise)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(14)
through REALAR(19) as described above(output).
REALARO(1) real component of present effective series Z
(returned)
REALARO(2) imaginary component of present effective
series Z (returned)
REALARO(3) magnitude of present series voltage, FDVREF
reference (returned)
REALARO(4) le of present series voltage, FDVREF refer-
ence (returned)
REALARO(5) real component of present series voltage, FD-
VREF reference (returned)
REALARO(6) imaginary component of present series volt-
age, FDVREF reference (returned)
Character*12 MNAME name of the FACTS device that is the master device for this IPFC slave
device (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 2 no sending end bus is specified
IERR = 3 bus not found
IERR = 4 the same bus is specified for the sending and
terminal end buses
IERR = 5 blank FACTS device name is invalid
IERR = 6 FACTS device not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
687
Power Flow FACTS_CHNG_2
IERR = 7 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid FACTS de-
vice control mode. - Invalid owner number.
- Invalid series voltage reference code. - Reg-
ulated bus not found. - Shunt element speci-
fied as remotely regulating itself. - Type code
of regulated bus is not 1 or 2. - Shunt ele-
ment voltage setpoint must be positive. - Ter-
minal bus voltage limit must be positive. - VT-
MX is less than VTMN. - Series voltage limit
must be positive. - Shunt current limit must
not be negative. - Bridge real power trans-
fer limit must not be negative. - Series cur-
rent limit must not be negative. - Series reac-
tance must be positive. - Shunt current limit is
not 0.0 for an IPFC device. - Bridge real pow-
er transfer limit is not 0.0 for an IPFC device.
- Impedance setpoint has reactance of 0.0. -
RMPCT is not positive. - Master IPFC FACTS de-
vice not found. - Bus is dummy bus of a mul-
ti-section line. - Multi-section line grouping
deleted. - Owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
688
Power Flow FACTS_CHNG_3
1.2.18. FACTS_CHNG_3
Use this API routine to modify the data of an existing FACTS device in the working case (see PSSE Program
Operation Manual, FACTS Device Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_FACTS_CHNG_3 'NAME' INTGAR(1)..INTGAR(7) REALAR(1)..REALAR(13)
'MNAME'
Python command syntax:
ierr, realaro = facts_chng_3(name, intgar, realari, mname)
Fortran command syntax:
CALL FACTS_CHNG_3(NAME, INTGAR, REALAR, MNAME, IERR)
Where:
Character*12 NAME name of the FACTS device (input; no default allowed).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) I, sending end bus number (no default al-
lowed)
INTGAR(2) J, terminal end bus number (0 for STATCON)
(0 by default)
INTGAR(3) MODE, control mode (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
INTGAR(5) VSREF, series voltage reference code for
modes 4 and 7 (0 for sending end voltage; 1
for series current) (0 by default)
INTGAR(6) IREG, regulated bus number (0 by default)
INTGAR(7) NODE, regulated node number (0 by default)
Real REALAR (19) (first thirteen are input values; last six are output values) (input (out-
put).).
Real REALARI (13) array of 13 elements specifying corresponding to values REALAR(1)
through REALAR(13) as described above(input).
REALARI(1) PDES, desired real power at terminal bus (0.0
by default)
REALARI(2) QDES, desired reactive power at terminal bus
(0.0 by default)
REALARI(3) VSET, sending bus voltage setpoint (1.0 by
default)
REALARI(4) SHMX, sending end maximum shunt current
(MVA at rated voltage) (99.99 * SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
689
Power Flow FACTS_CHNG_3
REALARI(5) TRMX, maximum bridge real power transfer
(99.99 * SBASE by default)
REALARI(6) VTMN, minimum terminal bus voltage mag-
nitude (0.9 by default)
REALARI(7) VTMX, maximum terminal bus voltage mag-
nitude (1.1 by default)
REALARI(8) VSMX, maximum series voltage magnitude
(1.0 by default)
REALARI(9) IMX, maximum series current (MVA at rated
voltage) (0.0 by default)
REALARI(10) LINX, pu reactance of temporary series ele-
ment (0.05 by default)
REALARI(11) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
REALARI(12) SET1, real component of constant Z (MODE =
3), magnitude of constant V (MODE = 4), or
VD (MODE = 7 or 8) (0.0 by default)
REALARI(13) SET2, imaginary component of constant Z
(MODE = 3), angle of constant V (MODE =
4), or VQ (MODE = 7 or 8) (0.005 by default
when MODE = 3; 0.0 otherwise)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(14)
through REALAR(19) as described above(output).
REALARO(1) real component of present effective series Z
(returned)
REALARO(2) imaginary component of present effective
series Z (returned)
REALARO(3) magnitude of present series voltage, FDVREF
reference (returned)
REALARO(4) le of present series voltage, FDVREF refer-
ence (returned)
REALARO(5) real component of present series voltage, FD-
VREF reference (returned)
REALARO(6) imaginary component of present series volt-
age, FDVREF reference (returned)
Character*12 MNAME name of the FACTS device that is the master device for this IPFC slave
device (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 2 no sending end bus is specified
IERR = 3 bus not found
IERR = 4 the same bus is specified for the sending and
terminal end buses
IERR = 5 blank FACTS device name is invalid
IERR = 6 FACTS device not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
690
Power Flow FACTS_CHNG_3
IERR = 7 node-breaker terminal connection table is full
IERR = 8 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid FACTS de-
vice control mode. - Invalid owner number. -
Invalid series voltage reference code. - Regu-
lated bus not found. - Remote regulated bus
is specified for a type 3 bus. - Type code of
regulated bus is not 1 or 2. - Shunt element
voltage setpoint must be positive. - Termi-
nal bus voltage limit must be positive. - VT-
MX is less than VTMN. - Series voltage limit
must be positive. - Shunt current limit must
not be negative. - Bridge real power trans-
fer limit must not be negative. - Series cur-
rent limit must not be negative. - Series reac-
tance must be positive. - Shunt current limit is
not 0.0 for an IPFC device. - Bridge real pow-
er transfer limit is not 0.0 for an IPFC slave.
- Impedance setpoint has reactance of 0.0. -
RMPCT is not positive. - Master IPFC FACTS de-
vice not found. - Bus is dummy bus of a mul-
ti-section line. - Multi-section line grouping
deleted. - Owner table is full - Invalid node
number - Non-zero regulated node specified
but regulated bus does not belong to a sub-
station - Regulated node not found - Regulat-
ed node is not connected to any bus section
of the regulated bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
691
Power Flow FACTS_DATA
1.2.19. FACTS_DATA
This API routine is obsolete. It has been replaced by the API routine facts_data_2 .
Use this API to modify the data of an existing FACTS device in the working case or to add a new FACTS de-
vice to the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_FACTS_DATA FD INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(13)
Python command syntax:
ierr, realaro = facts_data(fd, intgar, realari)
Fortran command syntax:
CALL FACTS_API(FD, INTGAR, REALAR, IERR, NERR)
Where:
Integer FD number (which the API converts to a left-justified name) of the FACTS
device for which data is to be specified (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) I, sending end bus number (alias is I)
INTGAR(2) J, terminal end bus number (0 for STATCON)
(alias is J)
INTGAR(3) MODE, control mode (alias is MODE)
INTGAR(4) OWNER, owner number (alias is OWNER)
INTGAR(5) VSREF, series voltage reference code for
modes 4 and 7 (0 for sending end voltage; 1
for series current) (alias is VSREF)
Real REALAR (19) (first thirteen are input values; last six are output values) (input (out-
put).).
Real REALARI (13) array of 13 elements specifying corresponding to values REALAR(1)
through REALAR(13) as described above(input).
REALARI(1) PDES, desired real power at terminal bus
(alias is PDES)
REALARI(2) QDES, desired reactive power at terminal bus
(alias is QDES)
REALARI(3) VSET, sending bus voltage setpoint (alias is
VSET)
REALARI(4) SHMX, sending end maximum shunt current
(MVA at rated voltage) (alias is SHMAX)
REALARI(5) TRMX, maximum bridge real power transfer
(alias is TRMX)
REALARI(6) VTMN, minimum terminal bus voltage mag-
nitude (alias is VTMN)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
692
Power Flow FACTS_DATA
REALARI(7) VTMX, maximum terminal bus voltage mag-
nitude (alias is VTMX)
REALARI(8) VSMX, maximum series voltage magnitude
(alias is VSMX)
REALARI(9) IMX, maximum series current (MVA at rated
voltage) (alias is IMX)
REALARI(10) LINX, pu reactance of temporary series ele-
ment (alias is LINX)
REALARI(11) RMPCT, percent of contributed reactive pow-
er (alias is RMPCT)
REALARI(12) SET1, real component of constant Z (mode =
3), magnitude of constant V (mode = 4), or
VD (mode = 7 or 8) (alias is SET1)
REALARI(13) SET2, imaginary component of constant Z
(mode = 3), angle of constant V (mode = 4),
or VQ (mode = 7 or 8) (alias is SET2)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(14)
through REALAR(19) as described above(output).
REALARO(1) real component of present effective series Z
(returned)
REALARO(2) imaginary component of present effective
series Z (returned)
REALARO(3) magnitude of present series voltage, FDVREF
reference (returned)
REALARO(4) le of present series voltage, FDVREF refer-
ence (returned)
REALARO(5) real component of present series voltage, FD-
VREF reference (returned)
REALARO(6) imaginary component of present series volt-
age, FDVREF reference (returned)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 FACTS device table is full
IERR = 2 no sending end bus is specified
IERR = 3 bus not found
IERR = 4 the same bus is specified for the sending and
terminal end buses
IERR = 6 prerequisite requirements for API are not met
IERR = 7 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid FACTS de-
vice control model. - Invalid owner number. -
Invalid series voltage reference code. - Shunt
element voltage setpoint must be positive. -
Terminal bus voltage limit must be positive. -
VTMX is less than VTMN. - Series voltage lim-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
693
Power Flow FACTS_DATA
it must be positive. - Shunt current limit must
not be negative. - Bridge real power trans-
fer limit must not be negative. - Series cur-
rent limit must not be negative. - Series reac-
tance must be positive. - Shunt current limit is
not 0.0 for an IPFC device. - Bridge real pow-
er transfer limit is not 0.0 for an IPFC device.
- Impedance setpoint has reactance of 0.0. -
RMPCT is not positive. - Master IPFC FACTS de-
vice not found. - Bus is dummy bus of a mul-
ti-section line. - Multi-section line grouping
deleted. - Owner table is full
Integer NERR number of entries in PBUF02 containing error messages (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
694
Power Flow FACTS_DATA_2
1.2.20. FACTS_DATA_2
This API routine is obsolete. It has been replaced by the API routine facts_data_3 .
Use this API to modify the data of an existing FACTS device in the working case, or to add a new FACTS de-
vice to the working case (see PSSE Program Operation Manual, FACTS Device Data).
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_FACTS_DATA_2 'NAME' INTGAR(1)..INTGAR(6) REALAR(1)..REALAR(13)
'MNAME'
Python command syntax:
ierr, realaro = facts_data_2(name, intgar, realari, mname)
Fortran command syntax:
CALL FACTS_API_2(NAME, INTGAR, REALAR, MNAME, IERR)
Where:
Character*12 NAME name of the FACTS device (input; no default allowed).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) I, sending end bus number (no default al-
lowed)
INTGAR(2) J, terminal end bus number (0 for STATCON)
(0 by default)
INTGAR(3) MODE, control mode (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
INTGAR(5) VSREF, series voltage reference code for
modes 4 and 7 (0 for sending end voltage; 1
for series current) (0 by default)
INTGAR(6) REMOT, remote bus number (0 for sending
end bus) (0 by default)
Real REALAR (19) (first thirteen are input values; last six are output values) (input (out-
put).).
Real REALARI (13) array of 13 elements specifying corresponding to values REALAR(1)
through REALAR(13) as described above(input).
REALARI(1) PDES, desired real power at terminal bus (0.0
by default)
REALARI(2) QDES, desired reactive power at terminal bus
(0.0 by default)
REALARI(3) VSET, sending bus voltage setpoint (1.0 by
default)
REALARI(4) SHMX, sending end maximum shunt current
(MVA at rated voltage) (99.99 * SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
695
Power Flow FACTS_DATA_2
REALARI(5) TRMX, maximum bridge real power transfer
(99.99 * SBASE by default)
REALARI(6) VTMN, minimum terminal bus voltage mag-
nitude (0.9 by default)
REALARI(7) VTMX, maximum terminal bus voltage mag-
nitude (1.1 by default)
REALARI(8) VSMX, maximum series voltage magnitude
(1.0 by default)
REALARI(9) IMX, maximum series current (MVA at rated
voltage) (0.0 by default)
REALARI(10) LINX, pu reactance of temporary series ele-
ment (0.05 by default)
REALARI(11) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
REALARI(12) SET1, real component of constant Z (MODE =
3), magnitude of constant V (MODE = 4), or
VD (MODE = 7 or 8) (0.0 by default)
REALARI(13) SET2, imaginary component of constant Z
(MODE = 3), angle of constant V (MODE =
4), or VQ (MODE = 7 or 8) (0.005 by default
when MODE = 3; 0.0 otherwise)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(14)
through REALAR(19) as described above(output).
REALARO(1) real component of present effective series Z
(returned)
REALARO(2) imaginary component of present effective
series Z (returned)
REALARO(3) magnitude of present series voltage, FDVREF
reference (returned)
REALARO(4) le of present series voltage, FDVREF refer-
ence (returned)
REALARO(5) real component of present series voltage, FD-
VREF reference (returned)
REALARO(6) imaginary component of present series volt-
age, FDVREF reference (returned)
Character*12 MNAME name of the FACTS device that is the master device for this IPFC slave
device (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 FACTS device table is full
IERR = 2 no sending end bus is specified
IERR = 3 bus not found
IERR = 4 the same bus is specified for the sending and
terminal end buses
IERR = 5 blank FACTS device name is invalid
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
696
Power Flow FACTS_DATA_2
IERR = 6 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid FACTS de-
vice control mode. - Invalid owner number.
- Invalid series voltage reference code. - Reg-
ulated bus not found. - Shunt element speci-
fied as remotely regulating itself. - Type code
of regulated bus is not 1 or 2. - Shunt ele-
ment voltage setpoint must be positive. - Ter-
minal bus voltage limit must be positive. - VT-
MX is less than VTMN. - Series voltage limit
must be positive. - Shunt current limit must
not be negative. - Bridge real power trans-
fer limit must not be negative. - Series cur-
rent limit must not be negative. - Series reac-
tance must be positive. - Shunt current limit is
not 0.0 for an IPFC device. - Bridge real pow-
er transfer limit is not 0.0 for an IPFC device.
- Impedance setpoint has reactance of 0.0. -
RMPCT is not positive. - Master IPFC FACTS de-
vice not found. - Bus is dummy bus of a mul-
ti-section line. - Multi-section line grouping
deleted. - Owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
697
Power Flow FACTS_DATA_3
1.2.21. FACTS_DATA_3
Use this API to modify the data of an existing FACTS device in the working case, or to add a new FACTS de-
vice to the working case (see PSSE Program Operation Manual, FACTS Device Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_FACTS_DATA_3 'NAME' INTGAR(1)..INTGAR(7) REALAR(1)..REALAR(13)
'MNAME'
Python command syntax:
ierr, realaro = facts_data_3(name, intgar, realari, mname)
Fortran command syntax:
CALL FACTS_API_3(NAME, INTGAR, REALAR, MNAME, IERR)
Where:
Character*12 NAME name of the FACTS device (input; no default allowed).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) I, sending end bus number (no default al-
lowed)
INTGAR(2) J, terminal end bus number (0 for STATCON)
(0 by default)
INTGAR(3) MODE, control mode (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
INTGAR(5) VSREF, series voltage reference code for
modes 4 and 7 (0 for sending end voltage; 1
for series current) (0 by default)
INTGAR(6) IREG, regulated bus number (0 by default)
INTGAR(7) NODE, regulated node number (0 by default)
Real REALAR (19) (first thirteen are input values; last six are output values) (input (out-
put).).
Real REALARI (13) array of 13 elements specifying corresponding to values REALAR(1)
through REALAR(13) as described above(input).
REALARI(1) PDES, desired real power at terminal bus (0.0
by default)
REALARI(2) QDES, desired reactive power at terminal bus
(0.0 by default)
REALARI(3) VSET, sending bus voltage setpoint (1.0 by
default)
REALARI(4) SHMX, sending end maximum shunt current
(MVA at rated voltage) (99.99 * SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
698
Power Flow FACTS_DATA_3
REALARI(5) TRMX, maximum bridge real power transfer
(99.99 * SBASE by default)
REALARI(6) VTMN, minimum terminal bus voltage mag-
nitude (0.9 by default)
REALARI(7) VTMX, maximum terminal bus voltage mag-
nitude (1.1 by default)
REALARI(8) VSMX, maximum series voltage magnitude
(1.0 by default)
REALARI(9) IMX, maximum series current (MVA at rated
voltage) (0.0 by default)
REALARI(10) LINX, pu reactance of temporary series ele-
ment (0.05 by default)
REALARI(11) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
REALARI(12) SET1, real component of constant Z (MODE =
3), magnitude of constant V (MODE = 4), or
VD (MODE = 7 or 8) (0.0 by default)
REALARI(13) SET2, imaginary component of constant Z
(MODE = 3), angle of constant V (MODE =
4), or VQ (MODE = 7 or 8) (0.005 by default
when MODE = 3; 0.0 otherwise)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(14)
through REALAR(19) as described above(output).
REALARO(1) real component of present effective series Z
(returned)
REALARO(2) imaginary component of present effective
series Z (returned)
REALARO(3) magnitude of present series voltage, FDVREF
reference (returned)
REALARO(4) le of present series voltage, FDVREF refer-
ence (returned)
REALARO(5) real component of present series voltage, FD-
VREF reference (returned)
REALARO(6) imaginary component of present series volt-
age, FDVREF reference (returned)
Character*12 MNAME name of the FACTS device that is the master device for this IPFC slave
device (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 FACTS device table is full
IERR = 2 no sending end bus is specified
IERR = 3 bus not found
IERR = 4 the same bus is specified for the sending and
terminal end buses
IERR = 5 blank FACTS device name is invalid
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
699
Power Flow FACTS_DATA_3
IERR = 7 node-breaker terminal connection table is full
IERR = 8 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid FACTS de-
vice control mode. - Invalid owner number. -
Invalid series voltage reference code. - Regu-
lated bus not found. - Remote regulated bus
is specified for a type 3 bus. - Type code of
regulated bus is not 1 or 2. - Shunt element
voltage setpoint must be positive. - Termi-
nal bus voltage limit must be positive. - VT-
MX is less than VTMN. - Series voltage limit
must be positive. - Shunt current limit must
not be negative. - Bridge real power trans-
fer limit must not be negative. - Series cur-
rent limit must not be negative. - Series reac-
tance must be positive. - Shunt current limit is
not 0.0 for an IPFC device. - Bridge real pow-
er transfer limit is not 0.0 for an IPFC slave.
- Impedance setpoint has reactance of 0.0. -
RMPCT is not positive. - Master IPFC FACTS de-
vice not found. - Bus is dummy bus of a mul-
ti-section line. - Multi-section line grouping
deleted. - Owner table is full - Invalid node
number - Non-zero regulated node specified
but regulated bus does not belong to a sub-
station - Regulated node not found - Regulat-
ed node is not connected to any bus section
of the regulated bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
700
Power Flow GNE_CHNG
1.2.22. GNE_CHNG
Use this API routine to modify the data of an existing GNE device in the working case (see PSSE Program
Operation Manual, GNE Device Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_GNE_CHNG 'NAME' 'MODEL' NTERM TRMNLS(1)..TRMNLS(NTERM)
INTGAR(1)..INTGAR(3) NRELCN RELCON(1)..RELCON(NRELCN) NINTCN
INTCON(1)..INTCON(NINTCN) NCHRCN CHRCON(1)..CHRCON(NCHRCN)
Python command syntax:
ierr = gne_chng(name, model, nterm, trmnls, intgar, nrelcn, relcon,
nintcn, intcon, nchrcn, chrcon)
Fortran command syntax:
CALL GNE_CHNG(NAME, MODEL, NTERM, TRMNLS, INTGAR, NRELCN, RELCON, NINTCN,
INTCON, NCHRCN, CHRCON, IERR)
Where:
Character*12 NAME name of the GNE device (input; no default allowed).
Character*16 MODEL name of the GMB/BOSL model to be used by this GNE device. The
GMB/BOSL model file "MODEL.mac" must be available (input; no de-
fault allowed).
Integer NTERM number of terminals (i.e., buses) to which the model is connected.
NTERM must be 1 for GNE-PQ and GNE-I models, and it must be ei-
ther 1 or 2 for a GNE-Y model (input; no default allowed).
Integer TRMNLS (NTERM) containing the bus numbers of the buses to which this model is con-
nected (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) STATUS, model status (0 for out-of-service, 1
for in-service) (1 by default)
INTGAR(2) OWNER, owner number (the owner to which
bus TRMNLS (1) is assigned by default)
INTGAR(3) NMETR, non-metered end bus number
(TRMNLS (NTERM) by default)
Integer NRELCN number of real constants required by the model (input; no default al-
lowed).
Real RELCON (NRELCN) real model constants (input; 0.0).
Integer NINTCN number of integer constants required by the model (input; no default
allowed).
Integer INTCON (NINTCN) integer model constants (usually bus numbers) (TRMNLS) (input; 1
by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
701
Power Flow GNE_CHNG
Integer NCHRCN number of two-character identifiers required required by the model
(input; no default allowed).
Character*12 CHRCON (NCHRCN) containing character model constants (e.g., circuit identifiers) (input;
'1' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 blank GNE device name is invalid
IERR = 2 invalid number of terminal buses for this
GMB/BOSL model
IERR = 3 bus not found
IERR = 4 model is not a GNE model
IERR = 5 number of constants specified differs from
those required in the model's.mac file
IERR = 7 blank model name is invalid for a new GNE
device instance
IERR = 8 GNE.mac file is not found or an error occurred
while reading it
IERR = 9 GNE device not found
IERR = 10 prerequisite requirements for API are not met
IERR = 18 BOSL/GMB not installed/initialized
IERR = -1 warnings - one or more of: - Invalid GNE de-
vice status. - Invalid owner number. - Invalid
non-metered end bus. - Bus specified in an in-
teger constant is not found. - Owner table is
full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
702
Power Flow GNE_DATA
1.2.23. GNE_DATA
Use this API routine to run the GNE device data specification function. It modifies the data of an existing
GNE device in the working case, or adds a new GNE device to the working case (see PSSE Program Opera-
tion Manual, GNE Device Data).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_GNE_DATA 'NAME' 'MODEL' NTERM TRMNLS(1)..TRMNLS(NTERM)
INTGAR(1)..INTGAR(3) NRELCN RELCON(1)..RELCON(NRELCN) NINTCN
INTCON(1)..INTCON(NINTCN) NCHRCN CHRCON(1)..CHRCON(NCHRCN)
Python command syntax:
ierr = gne_data(name, model, nterm, trmnls, intgar, nrelcn, relcon,
nintcn, intcon, nchrcn, chrcon)
Fortran command syntax:
CALL GNE_API(NAME, MODEL, NTERM, TRMNLS, INTGAR, NRELCN, RELCON, NINTCN,
INTCON, NCHRCN, CHRCON, IERR)
Where:
Character*12 NAME name of the GNE device (input; no default allowed).
Character*16 MODEL name of the GMB/BOSL model to be used by this GNE device. The
GMB/BOSL model file "MODEL.mac" must be available (input; no de-
fault allowed).
Integer NTERM number of terminals (i.e., buses) to which the model is connected.
NTERM must be 1 for GNE-PQ and GNE-I models, and it must be ei-
ther 1 or 2 for a GNE-Y model (input; no default allowed).
Integer TRMNLS (NTERM) containing the bus numbers of the buses to which this model is con-
nected (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) STATUS, model status (0 for out-of-service, 1
for in-service) (1 by default)
INTGAR(2) OWNER, owner number (the owner to which
bus TRMNLS (1) is assigned by default)
INTGAR(3) NMETR, non-metered end bus number
(TRMNLS (NTERM) by default)
Integer NRELCN number of real constants required by the model (input; no default al-
lowed).
Real RELCON (NRELCN) real model constants (input; 0.0).
Integer NINTCN number of integer constants required by the model (input; no default
allowed).
Integer INTCON (NINTCN) integer model constants (usually bus numbers) (TRMNLS) (input; 1
by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
703
Power Flow GNE_DATA
Integer NCHRCN number of two-character identifiers required required by the model
(input; no default allowed).
Character*12 CHRCON (NCHRCN) containing character model constants (e.g., circuit identifiers) (input;
'1' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 blank GNE device name is invalid
IERR = 2 invalid number of terminal buses for this
GMB/BOSL model
IERR = 3 bus not found
IERR = 4 model is not a GNE model
IERR = 5 number of constants specified differs from
those required in the model's.mac file
IERR = 6 GNE device instance table is full
IERR = 7 blank model name is invalid for a new GNE
device instance
IERR = 8 GNE.mac file is not found or an error occurred
while reading it
IERR = 10 prerequisite requirements for API are not met
IERR = 18 BOSL/GMB not installed/initialized
IERR = -1 warnings - one or more of: - Invalid GNE de-
vice status. - Invalid owner number. - Invalid
non-metered end bus. - Bus specified in an in-
teger constant is not found. - Owner table is
full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
704
Power Flow IMPEDANCE_CORRECTION_DATA
1.2.24. IMPEDANCE_CORRECTION_DATA
This API routine is obsolete. It has been replaced by the API routine impedance_correction_data_3 .
Use this API to modify the data of an existing transformer impedance correction table in the working case
or to add a new transformer impedance correction table to the working case (see PSSE Program Operation
Manual, Transformer Impedance Correction Table Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_IMPEDANCE_CORRECTION_DATA I REALAR(1,1) REALAR(2,1) REALAR(1,2)
REALAR(2,2)..REALAR(1,11) REALAR(2,11)
Python command syntax:
ierr, intgar = impedance_correction_data(i, realar)
Fortran command syntax:
CALL IMPEDANCE_CORRECTION_TAB_API_2(I, INTGAR, REALAR, IERR)
Where:
Integer I table number (must be between 1 and the number of tables allowed
at the present size level of PSSE) (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (output).
INTGAR(1) number of entries in table (returned)
INTGAR(2) table type flag (0=ratio, 1=angle) (returned)
Real REALAR (22) 22 values dimensioned (2,11), where REALAR(1,i) specifies Ti, and
REALAR(2,i) specifies Fi. The values are specified such that the left
subscript varies more rapidly: (1,1), (2,1), (1,2), (2,2), .. (1,11),
(2,11). (REALAR(1,1) = REALAR (input; 2,1) =1.0 by default; all other
values are 0.0 by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid transformer impedance correction ta-
ble number
IERR = 3 ABSCISSA values are not in ascending order
IERR = 4 ABSCISSA value is outside of the range of
-180 to +180
IERR = 5 table has fewer than 2 points
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - point is beyond previ-
ous end of table - invalid scaling factor
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
705
Power Flow IMPEDANCE_CORRECTION_DATA_3
1.2.25. IMPEDANCE_CORRECTION_DATA_3
Use this API to modify the data of an existing transformer impedance correction table in the working case
or to add a new transformer impedance correction table to the working case (see PSSE Program Operation
Manual, Transformer Impedance Correction Table Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_IMPEDANCE_CORRECTION_DATA_3 I POINTS REALAR(1)..REALAR(POINTS)
CPLXAR(1)..CPLXAR(POINTS)
Python command syntax:
ierr = impedance_correction_data_3(i, points, realar, cplxar)
Fortran command syntax:
CALL IMPEDANCE_CORRECTION_TAB_API_3(I, POINTS, REALAR, CPLXAR, IERR)
Where:
Integer I table number (must be between 1 and the number of tables allowed
at the present size level (input).
Integer POINTS number of points specified in table 'I' (2 through 99) (input; no de-
fault allowed).
Real REALAR (POINTS) array of 'POINTS' values specifying either off-nominal turns ratios in
pu or phase shift angles in degrees in strictly ascending order (input).
Complex CPLXAR (POINTS) array of 'POINTS' complex scaling factors by which transformer nom-
inal impedance is to be multiplied to obtain the actual transformer
impedance for the corresponding 'REALAR' value (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid transformer impedance correction ta-
ble number
IERR = 3 REALAR values are not in ascending order
IERR = 4 REALAR value is outside of the range of -180
to +180
IERR = 5 table has fewer than 2 points
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - point is beyond previ-
ous end of table - invalid scaling factor
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
706
Power Flow INDUCTION_MACHINE_CHNG
1.2.26. INDUCTION_MACHINE_CHNG
Use this API routine to modify the data of an existing induction machine in the working case (see PSSE Pro-
gram Operation Manual, Induction Machine Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_INDUCTION_MACHINE_CHNG IBUS 'ID' INTGAR(1)..INTGAR(9)
REALAR(1)..REALAR(23)
Python command syntax:
ierr = induction_machine_chng(ibus, id, intgar, realar)
Fortran command syntax:
CALL INDUCTION_MACHINE_CHNG(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (9) array of 9 elements specifying (input).
INTGAR(1) STAT, induction machine status (1 by default)
INTGAR(2) SCODE, machine standard type (1 for NEMA,
2 for IEC) (1 by default)
INTGAR(3) DCODE, machine design code (0 for custom,
1 through 5 for MEMA designs A through E)
(2 by default)
INTGAR(4) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(5) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(6) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(7) TCODE, type of mechanical torque variation
(1 for simple power law, 2 for WECC model)
(1 by default)
INTGAR(8) BCODE, base machine power code (1 for me-
chanical power 2 for electrical power drawn)
(1 by default)
INTGAR(9) PCODE, power setpoint code (1 for mechani-
cal power 2 for electrical power drawn) (1 by
default)
Real REALAR (23) array of 23 elements specifying (input).
REALAR(1) MBASE, machine base power (SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
707
Power Flow INDUCTION_MACHINE_CHNG
REALAR(2) RATEKV, machine rated voltage (kV line to
line); 0.0 for bus base voltage (0.0 by de-
fault)
REALAR(3) PSET, machine power setpoint in MW (posi-
tive for a motor) (0.0 by default)
REALAR(4) H, machine inertia in pu on machine base
power (1.0 by default)
REALAR(5) A, load torque variation constant (1.0 by de-
fault)
REALAR(6) B, load torque variation constant (1.0 by de-
fault)
REALAR(7) D, load torque variation constant (1.0 by de-
fault)
REALAR(8) E, load torque variation constant (1.0 by de-
fault)
REALAR(9) RA, armature resistance (0.02494 by default)
REALAR(10) XA, armature leakage reactance (0.07482 by
default)
REALAR(11) XM, magnetizing reactance (2.32786 by de-
fault)
REALAR(12) R1, first cage resistance (0.02078 by default)
REALAR(13) X1, first cage reactance (0.09145 by default)
REALAR(14) R2, second cage resistance (0.12471 by de-
fault)
REALAR(15) X2, second cage reactance (0.03326 by de-
fault)
REALAR(16) X3, third reactance (0.0 by default)
REALAR(17) E1, first voltage point on saturation curve
(1.0 by default)
REALAR(18) SE1, saturation factor at E1 (0.04 by default)
REALAR(19) E2, second voltage point on saturation curve
(1.2 by default)
REALAR(20) SE2, saturation factor at E2 (0.2 by default)
REALAR(21) IA1, starting stator current for applying stator
leakage reactance saturation (1.0 by default)
REALAR(22) IA2, stator current at wiich the stator leakage
reactance is fully saturated (5.0 by default)
REALAR(23) XAMULT, Xa multiplier at full leakage reac-
tance saturation (1.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 5 induction machine not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
708
Power Flow INDUCTION_MACHINE_CHNG
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus. - invalid machine standard code. - in-
valid machine design code. - invalid area,
zone or owner number. - invalid mechanical
torque variation method code. - invalid base
power code. - invalid power setpoint code.
- machine base power is not positive. - ma-
chine rated voltage is negative. - machine
rated voltage is ignored because the bus has
no base voltage specified for it. - bus base
voltage and machine rated voltage differ by
more than 20%. - power setpoint exceeds the
threshold determined from the standard code
and the power setpoint code. - invalid ma-
chine inertia. - magnitude of load torque vari-
ation constant D is not between 0.2 and 5.0. -
the sign of load torque variation constant D is
not consistent with that of the machine pow-
er setpoint. - machine parameter is negative.
- XM is not positive. - Rn or Xn exceeds 999.0.
- Rn and Xn are both 0.0. - one of R1 and Xn
is 999.0 and the other is not. - E1 is greater
than E2; interchanging E1 and E2. - E1 and
E2 are equal. - SE1 is greater than SE2; inter-
changing SE1 and SE2. - IA1 is greater than
IA2; interchanging IA1 and IA2. - IA1 and IA2
are equal. - XAMULT must be between 0.0
and 1.0. - area, zone or owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
709
Power Flow INDUCTION_MACHINE_DATA
1.2.27. INDUCTION_MACHINE_DATA
Use this API routine to modify the data of an existing induction machine in the working case, or to add a
new induction machine to the working case (see PSSE Program Operation Manual, Induction Machine Da-
ta).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_INDUCTION_MACHINE_DATA IBUS 'ID' INTGAR(1)..INTGAR(9)
REALAR(1)..REALAR(23)
Python command syntax:
ierr = induction_machine_data(ibus, id, intgar, realar)
Fortran command syntax:
CALL INDUCTION_MACHINE_API(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (9) array of 9 elements specifying (input).
INTGAR(1) STAT, induction machine status (1 by default)
INTGAR(2) SCODE, machine standard type (1 for NEMA,
2 for IEC) (1 by default)
INTGAR(3) DCODE, machine design code (0 for custom,
1 through 5 for MEMA designs A through E)
(2 by default)
INTGAR(4) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(5) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(6) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(7) TCODE, type of mechanical torque variation
(1 for simple power law, 2 for WECC model)
(1 by default)
INTGAR(8) BCODE, base machine power code (1 for me-
chanical power 2 for electrical power drawn)
(1 by default)
INTGAR(9) PCODE, power setpoint code (1 for mechani-
cal power 2 for electrical power drawn) (1 by
default)
Real REALAR (23) array of 23 elements specifying (input).
REALAR(1) MBASE, machine base power (SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
710
Power Flow INDUCTION_MACHINE_DATA
REALAR(2) RATEKV, machine rated voltage (kV line to
line); 0.0 for bus base voltage (0.0 by de-
fault)
REALAR(3) PSET, machine power setpoint in MW (posi-
tive for a motor) (0.0 by default)
REALAR(4) H, machine inertia in pu on machine base
power (1.0 by default)
REALAR(5) A, load torque variation constant (1.0 by de-
fault)
REALAR(6) B, load torque variation constant (1.0 by de-
fault)
REALAR(7) D, load torque variation constant (1.0 by de-
fault)
REALAR(8) E, load torque variation constant (1.0 by de-
fault)
REALAR(9) RA, armature resistance (0.02494 by default)
REALAR(10) XA, armature leakage reactance (0.07482 by
default)
REALAR(11) XM, magnetizing reactance (2.32786 by de-
fault)
REALAR(12) R1, first cage resistance (0.02078 by default)
REALAR(13) X1, first cage reactance (0.09145 by default)
REALAR(14) R2, second cage resistance (0.12471 by de-
fault)
REALAR(15) X2, second cage reactance (0.03326 by de-
fault)
REALAR(16) X3, third reactance (0.0 by default)
REALAR(17) E1, first voltage point on saturation curve
(1.0 by default)
REALAR(18) SE1, saturation factor at E1 (0.04 by default)
REALAR(19) E2, second voltage point on saturation curve
(1.2 by default)
REALAR(20) SE2, saturation factor at E2 (0.2 by default)
REALAR(21) IA1, starting stator current for applying stator
leakage reactance saturation (1.0 by default)
REALAR(22) IA2, stator current at wiich the stator leakage
reactance is fully saturated (5.0 by default)
REALAR(23) XAMULT, Xa multiplier at full leakage reac-
tance saturation (1.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 blank machine identifier is invalid
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
711
Power Flow INDUCTION_MACHINE_DATA
IERR = 4 induction machine table is full
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus. - invalid machine standard code. - in-
valid machine design code. - invalid area,
zone or owner number. - invalid mechanical
torque variation method code. - invalid base
power code. - invalid power setpoint code.
- machine base power is not positive. - ma-
chine rated voltage is negative. - machine
rated voltage is ignored because the bus has
no base voltage specified for it. - bus base
voltage and machine rated voltage differ by
more than 20%. - power setpoint exceeds the
threshold determined from the standard code
and the power setpoint code. - invalid ma-
chine inertia. - magnitude of load torque vari-
ation constant D is not between 0.2 and 5.0. -
the sign of load torque variation constant D is
not consistent with that of the machine pow-
er setpoint. - machine parameter is negative.
- XM is not positive. - Rn or Xn exceeds 999.0.
- Rn and Xn are both 0.0. - one of R1 and Xn
is 999.0 and the other is not. - E1 is greater
than E2; interchanging E1 and E2. - E1 and
E2 are equal. - SE1 is greater than SE2; inter-
changing SE1 and SE2. - IA1 is greater than
IA2; interchanging IA1 and IA2. - IA1 and IA2
are equal. - XAMULT must be between 0.0
and 1.0. - area, zone or owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
712
Power Flow LOAD_CHNG_4
1.2.28. LOAD_CHNG_4
This API routine is obsolete. It has been replaced by the API routine load_chng_5 .
Use this API routine to modify the data of an existing load in the working case (see PSSE Program Opera-
tion Manual, Load Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_LOAD_CHNG_4 IBUS 'ID' INTGAR(1)..INTGAR(6) REALAR(1)..REALAR(6)
Python command syntax:
ierr = load_chng_4(ibus, id, intgar, realar)
Fortran command syntax:
CALL LOAD_CHNG_4(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(5) SCALE, load scaling flag (0 = fixed, non-con-
forming; 1 = scalable, conforming) (1 by de-
fault)
INTGAR(6) INTRPT, interruptible load flag (0 = non-inter-
ruptible; 1 = interruptible) (0 by default)
Real REALAR (6) array of 6 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
713
Power Flow LOAD_CHNG_4
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 5 load not found
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - area ta-
ble is full. - zone table is full. - owner table is
full. - invalid load scaling flag. - invalid inter-
ruptible load flag
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
714
Power Flow LOAD_CHNG_5
1.2.29. LOAD_CHNG_5
This API routine is obsolete. It has been replaced by the API routine load_chng_6 .
Use this API routine to modify the data of an existing load in the working case (see PSSE Program Opera-
tion Manual, Load Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_LOAD_CHNG_5 IBUS ID INTGAR(1)..INTGAR(7) REALAR(1)..REALAR(8)
Python command syntax:
ierr = load_chng_5(ibus, id, intgar, realar)
Fortran command syntax:
CALL LOAD_CHNG_5(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(5) SCALE, load scaling flag (0 = fixed, non-con-
forming; 1 = scalable, conforming) (1 by de-
fault)
INTGAR(6) INTRPT, interruptible load flag (0 = non-inter-
ruptible; 1 = interruptible) (0 by default)
INTGAR(7) DGNFLG, distributed generation flag (0 = dis-
tributed generation not in-service; 1 = dis-
tributed generation in-service) (0 by default)
Real REALAR (8) array of 8 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
715
Power Flow LOAD_CHNG_5
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
REALAR(7) PG, distributed generation real power (0.0 by
default)
REALAR(8) QG, distributed generation reactive power
(0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 5 load not found
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - area ta-
ble is full. - zone table is full. - owner table is
full. - invalid load scaling flag. - invalid inter-
ruptible load flag
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
716
Power Flow LOAD_CHNG_6
1.2.30. LOAD_CHNG_6
Use this API routine to modify the data of an existing load in the working case (see PSSE Program Opera-
tion Manual, Load Data).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_LOAD_CHNG_6 IBUS ID INTGAR(1)..INTGAR(7) REALAR(1)..REALAR(8) LODTYP
Python command syntax:
ierr = load_chng_6(ibus, id, intgar, realar, lodtyp)
Fortran command syntax:
CALL LOAD_CHNG_6(IBUS, ID, INTGAR, REALAR, LODTYP, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(5) SCALE, load scaling flag (0 = fixed, non-con-
forming; 1 = scalable, conforming) (1 by de-
fault)
INTGAR(6) INTRPT, interruptible load flag (0 = non-inter-
ruptible; 1 = interruptible) (0 by default)
INTGAR(7) DGNFLG, distributed generation flag (0 = dis-
tributed generation not in-service; 1 = dis-
tributed generation in-service) (0 by default)
Real REALAR (8) array of 8 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
717
Power Flow LOAD_CHNG_6
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
REALAR(7) PG, distributed generation real power (0.0 by
default)
REALAR(8) QG, distributed generation reactive power
(0.0 by default)
character*12 LODTYP load type description (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 5 load not found
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - area ta-
ble is full. - zone table is full. - owner table is
full. - invalid load scaling flag. - invalid inter-
ruptible load flag - invalid distributed genera-
tion flag - load type description is more than
12 characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
718
Power Flow LOAD_DATA
1.2.31. LOAD_DATA
This API routine is obsolete. It has been replaced by the API routine load_data_3 .
Use this API to modify the data of an existing load in the working case or to add a new load to the working
case.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_LOAD_DATA IBUS 'ID' INTGAR(1)..INTGAR(4) REALAR(1)..REALAR(6)
Python command syntax:
ierr = load_data(ibus, id, intgar, realar)
Fortran command syntax:
CALL LOAD_API_2(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
Real REALAR (6) array of 6 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
719
Power Flow LOAD_DATA
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 3 blank load identifier is invalid
IERR = 4 load table is full
IERR = 6 prerequisite requirements for API are not me
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - Area ta-
ble is full. - Zone table is full. - Owner table is
full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
720
Power Flow LOAD_DATA_3
1.2.32. LOAD_DATA_3
This API routine is obsolete. It has been replaced by the API routine load_data_4 .
Use this API to modify the data of an existing load in the working case or to add a new load to the working
case.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_LOAD_DATA_3 IBUS 'ID' INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(6)
Python command syntax:
ierr = load_data_3(ibus, id, intgar, realar)
Fortran command syntax:
CALL LOAD_API_3(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(5) SCALE, load scaling flag (0 = fixed, non-con-
forming; 1 = scalable, conforming) (1 by de-
fault)
Real REALAR (6) array of 6 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
721
Power Flow LOAD_DATA_3
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 3 blank load identifier is invalid
IERR = 4 load table is full
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - area ta-
ble is full. - zone table is full. - owner table is
full. - invalid load scaling flag
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
722
Power Flow LOAD_DATA_4
1.2.33. LOAD_DATA_4
This API routine is obsolete. It has been replaced by the API routine load_data_5 .
Use this API routine to modify the data of an existing load in the working case, or to add a new load to the
working case (see PSSE Program Operation Manual, Load Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_LOAD_DATA_4 IBUS 'ID' INTGAR(1)..INTGAR(6) REALAR(1)..REALAR(6)
Python command syntax:
ierr = load_data_4(ibus, id, intgar, realar)
Fortran command syntax:
CALL LOAD_API_4(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(5) SCALE, load scaling flag (0 = fixed, non-con-
forming; 1 = scalable, conforming) (1 by de-
fault)
INTGAR(6) INTRPT, interruptible load flag (0 = non-inter-
ruptible; 1 = interruptible) (0 by default)
Real REALAR (6) array of 6 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
723
Power Flow LOAD_DATA_4
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 3 blank load identifier is invalid
IERR = 4 load table is full
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - area ta-
ble is full. - zone table is full. - owner table is
full. - invalid load scaling flag. - invalid inter-
ruptible load flag
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
724
Power Flow LOAD_DATA_5
1.2.34. LOAD_DATA_5
This API routine is obsolete. It has been replaced by the API routine load_data_6 .
Use this API routine to modify the data of an existing load in the working case, or to add a new load to the
working case (see PSSE Program Operation Manual, Load Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_LOAD_DATA_5 IBUS ID INTGAR(1)..INTGAR(7) REALAR(1)..REALAR(8)
Python command syntax:
ierr = load_data_5(ibus, id, intgar, realar)
Fortran command syntax:
CALL LOAD_API_5(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(5) SCALE, load scaling flag (0 = fixed, non-con-
forming; 1 = scalable, conforming) (1 by de-
fault)
INTGAR(6) INTRPT, interruptible load flag (0 = non-inter-
ruptible; 1 = interruptible) (0 by default)
INTGAR(7) DGNFLG, distributed generation flag (0 = dis-
tributed generation not in-service; 1 = dis-
tributed generation in-service) (0 by default)
Real REALAR (8) array of 8 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
725
Power Flow LOAD_DATA_5
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
REALAR(7) PG, distributed generation real power (0.0 by
default)
REALAR(8) QG, distributed generation reactive power
(0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 3 blank load identifier is invalid
IERR = 4 load table is full
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - area ta-
ble is full. - zone table is full. - owner table is
full. - invalid load scaling flag. - invalid inter-
ruptible load flag
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
726
Power Flow LOAD_DATA_6
1.2.35. LOAD_DATA_6
Use this API routine to modify the data of an existing load in the working case, or to add a new load to the
working case (see PSSE Program Operation Manual, Load Data).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_LOAD_DATA_6 IBUS ID INTGAR(1)..INTGAR(7) REALAR(1)..REALAR(8) LODTYP
Python command syntax:
ierr = load_data_6(ibus, id, intgar, realar, lodtyp)
Fortran command syntax:
CALL LOAD_API_6(IBUS, ID, INTGAR, REALAR, LODTYP, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STATUS, load status (1 by default)
INTGAR(2) AREA, area number (area of bus IBUS by de-
fault)
INTGAR(3) ZONE, zone number (zone of bus IBUS by de-
fault)
INTGAR(4) OWNER, owner number (owner of bus IBUS
by default)
INTGAR(5) SCALE, load scaling flag (0 = fixed, non-con-
forming; 1 = scalable, conforming) (1 by de-
fault)
INTGAR(6) INTRPT, interruptible load flag (0 = non-inter-
ruptible; 1 = interruptible) (0 by default)
INTGAR(7) DGNFLG, distributed generation flag (0 = dis-
tributed generation not in-service; 1 = dis-
tributed generation in-service) (0 by default)
Real REALAR (8) array of 8 elements specifying (input).
REALAR(1) PL, constant power active load (0.0 by de-
fault)
REALAR(2) QL, constant power reactive load (0.0 by de-
fault)
REALAR(3) IP, constant current active load (0.0 by de-
fault)
REALAR(4) IQ, constant current reactive load (0.0 by de-
fault)
REALAR(5) YP, constant admittance active load (0.0 by
default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
727
Power Flow LOAD_DATA_6
REALAR(6) YQ, constant admittance reactive load (0.0
by default)
REALAR(7) PG, distributed generation real power (0.0 by
default)
REALAR(8) QG, distributed generation reactive power
(0.0 by default)
character*12 LODTYP load type description (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 3 blank load identifier is invalid
IERR = 4 load table is full
IERR = 6 prerequisite requirements for API are not met
IERR = 7 node-breaker terminal connection table is full
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid load status. -
invalid area, zone or owner number. - area ta-
ble is full. - zone table is full. - owner table is
full. - invalid load scaling flag. - invalid inter-
ruptible load flag - invalid distributed genera-
tion flag - load type description is more than
12 characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
728
Power Flow LONG_TITLE_DATA
1.2.36. LONG_TITLE_DATA
Use this API to change the sixteen line long title in the working case (see PSSE Program Operation Manual,
activity CHTI).
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_LONG_TITLE_DATA 'LNGLNS(1)'..'LNGLNS(16)'
Python command syntax:
ierr = long_title_data(lnglns)
Fortran command syntax:
CALL LONG_TITLE_API_2(LNGLNS, IERR)
Where:
Character*72 LNGLNS (16) sixteen title lines (defaulted lines are unchanged) (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Title line exceeds 72
characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
729
Power Flow MACHINE_CAP_CURVE_CHNG
1.2.37. MACHINE_CAP_CURVE_CHNG
Use this API routine to modify the capability curve data of an existing machine in the working case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_MACHINE_CAP_CURVE_CHNG IBUS ID POINTS PGENAR(1)...PGENAR(POINTS)
QMAXAR(1)...QMAXAR(POINTS) QMINAR(1)...QMINAR(POINTS)
Python command syntax:
ierr = machine_cap_curve_chng(ibus, id, points, pgenar, qmaxar, qminar)
Fortran command syntax:
CALL MACHINE_CAP_CURVE_CHNG(IBUS, ID, POINTS, PGENAR, QMAXAR, QMINAR,
IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer POINTS number of points specified in the capability curve (input).
real PGENAR (POINTS) array of 'POINTS' values specifying machine active power outputs in
MW along the MW axis of the machine's capability curve (input).
real QMAXAR (POINTS) array of 'POINTS' values specifying machine maximum reactive pow-
er outputs in MVAR at the corresponding PGENAR values of the
machine's capability curve (input).
real QMINAR (POINTS) array of 'POINTS' values specifying machine minimum reactive pow-
er outputs in MVAR at the corresponding PGENAR values of the
machine's capability curve (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 invalid POINTS value
IERR = 5 a motor capability curve is specified for a gen-
erator
IERR = 6 a generator capability curve is specified for a
motor
IERR = 7 capability curve P''s for a generator are not in
increasing order
IERR = 8 capability curve P''s for a motor are not in de-
creasing order
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
730
Power Flow MACHINE_CAP_CURVE_CHNG
IERR = 9 capability curve not found for this machine
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Machine active pow-
er is outside the limits of the capability curve.
- For at least one curve point, QMAX is less
than QMIN - Non-conventional machine with
machine control mode greater than 1
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
731
Power Flow MACHINE_CAP_CURVE_DATA
1.2.38. MACHINE_CAP_CURVE_DATA
Use this API routine to specify or modify the capability curve data of an existing machine in the working
case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_MACHINE_CAP_CURVE_DATA IBUS ID POINTS PGENAR(1)...PGENAR(POINTS)
QMAXAR(1)...QMAXAR(POINTS) QMINAR(1)...QMINAR(POINTS)
Python command syntax:
ierr = machine_cap_curve_data(ibus, id, points, pgenar, qmaxar, qminar)
Fortran command syntax:
CALL MACHINE_CAP_CURVE_DATA(IBUS, ID, POINTS, PGENAR, QMAXAR, QMINAR,
IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer POINTS number of points specified in the capability curve (input).
real PGENAR (POINTS) array of 'POINTS' values specifying machine active power outputs in
MW along the MW axis of the machine's capability curve (input).
real QMAXAR (POINTS) array of 'POINTS' values specifying machine maximum reactive pow-
er outputs in MVAR at the corresponding PGENAR values of the
machine's capability curve (input).
real QMINAR (POINTS) array of 'POINTS' values specifying machine minimum reactive pow-
er outputs in MVAR at the corresponding PGENAR values of the
machine's capability curve (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 invalid POINTS value
IERR = 5 a motor capability curve is specified for a gen-
erator
IERR = 6 a generator capability curve is specified for a
motor
IERR = 7 capability curve P''s for a generator are not in
increasing order
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
732
Power Flow MACHINE_CAP_CURVE_DATA
IERR = 8 capability curve P''s for a motor are not in de-
creasing order
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Machine active pow-
er is outside the limits of the capability curve.
- For at least one curve point, QMAX is less
than QMIN - Non-conventional machine with
machine control mode greater than 1
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
733
Power Flow MACHINE_CHNG_2
1.2.39. MACHINE_CHNG_2
This API routine is obsolete. It has been replaced by the API routine machine_chng_3 .
Use this API routine to modify the data of an existing machine in the working case (see PSSE Program Op-
eration Manual, Plant Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_MACHINE_CHNG_2 IBUS 'ID' INTGAR(1)..INTGAR(6)
REALAR(1)..REALAR(17)
Python command syntax:
ierr = machine_chng_2(ibus, id, intgar, realar)
Fortran command syntax:
CALL MACHINE_CHNG_2(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) STAT, machine status (1 by default)
INTGAR(2) O1, first owner number (owner of bus I by
default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
INTGAR(6) WMOD, wind machine reactive power lim-
its mode (0 if this machine is not a wind ma-
chine) (0 by default)
Real REALAR (17) array of 17 elements specifying (input).
REALAR(1) PG, machine active power (0.0 by default)
REALAR(2) QG, machine reactive power (0.0 by default)
REALAR(3) QT, machine reactive power upper limit
(9999.0 by default)
REALAR(4) QB, machine reactive power lower limit
(-9999.0 by default)
REALAR(5) PT, machine active power upper limit
(9999.0 by default)
REALAR(6) PB, machine active power lower limit
(-9999.0 by default)
REALAR(7) MBASE, machine MVA base (SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
734
Power Flow MACHINE_CHNG_2
REALAR(8) ZR, machine resistance (0.0 by default)
REALAR(9) ZX, machine reactance (1.0 by default)
REALAR(10) RT, step-up transformer resistance (0.0 by de-
fault)
REALAR(11) XT, step-up transformer reactance (0.0 by de-
fault)
REALAR(12) GTAP, step-up transformer tap ratio (1.0 by
default)
REALAR(13) F1, first owner fraction (1.0 by default)
REALAR(14) F2, second owner fraction (1.0 by default)
REALAR(15) F3, third owner fraction (1.0 by default)
REALAR(16) F4, fourth owner fraction (1.0 by default)
REALAR(17) WPF, wind machine power factor (1.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 no plant data at this bus
IERR = 7 machine not found
IERR = 8 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus - invalid wind machine control mode -
invalid wind machine power factor - invalid
ZSORCE reactance - invalid owner number
- invalid ownership fraction - no ownership
data is specified - QMAX is less than QMIN -
PMAX is less than PMIN - MBASE is not pos-
itive - non-conventional machine has nega-
tive active power - machine is no longer treat-
ed as a non-conventional machine - non-con-
ventional machine table is full--retained as a
conventional machine - capability curve is as-
signed to a non-conventional machine with
machine control mode greater than 1 - ma-
chine ownership table is full--only first n own-
ers retained - owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
735
Power Flow MACHINE_CHNG_3
1.2.40. MACHINE_CHNG_3
Use this API routine to modify the data of an existing machine in the working case (see PSSE Program Op-
eration Manual, Plant Data).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_MACHINE_CHNG_3 IBUS 'ID' INTGAR(1)..INTGAR(7)
REALAR(1)..REALAR(17)
Python command syntax:
ierr = machine_chng_3(ibus, id, intgar, realar)
Fortran command syntax:
CALL MACHINE_CHNG_3(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STAT, machine status (1 by default)
INTGAR(2) O1, first owner number (owner of bus I by
default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
INTGAR(6) WMOD, non-conventional machine reactive
power limits mode (0 if this machine is a
conventional machine) (0 by default)
INTGAR(7) BASFLG, baseloaded machine flag
Real REALAR (17) array of 17 elements specifying (input).
REALAR(1) PG, machine active power (0.0 by default)
REALAR(2) QG, machine reactive power (0.0 by default)
REALAR(3) QT, machine reactive power upper limit
(9999.0 by default)
REALAR(4) QB, machine reactive power lower limit
(-9999.0 by default)
REALAR(5) PT, machine active power upper limit
(9999.0 by default)
REALAR(6) PB, machine active power lower limit
(-9999.0 by default)
REALAR(7) MBASE, machine MVA base (SBASE by de-
fault)
REALAR(8) ZR, machine resistance (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
736
Power Flow MACHINE_CHNG_3
REALAR(9) ZX, machine reactance (1.0 by default)
REALAR(10) RT, step-up transformer resistance (0.0 by de-
fault)
REALAR(11) XT, step-up transformer reactance (0.0 by de-
fault)
REALAR(12) GTAP, step-up transformer tap ratio (1.0 by
default)
REALAR(13) F1, first owner fraction (1.0 by default)
REALAR(14) F2, second owner fraction (1.0 by default)
REALAR(15) F3, third owner fraction (1.0 by default)
REALAR(16) F4, fourth owner fraction (1.0 by default)
REALAR(17) WPF, non-conventional machine power fac-
tor (1.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 no plant data at this bus
IERR = 8 machine not found
IERR = 9 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus - invalid non-conventional (renewable and
infeed type) machine control mode - invalid
renewable machine power factor - invalid
ZSORCE reactance - invalid owner number
- invalid ownership fraction - no ownership
data is specified - QMAX is less than QMIN -
PMAX is less than PMIN - MBASE is not posi-
tive - machine is no longer treated as a non-
conventional machine - non-conventional
machine table is full--retained as a conven-
tional machine - machine ownership table is
full--only first n owners retained - owner table
is full - infeed machine QGEN is greater than
QMAX - QGEN set equal to QMAX - infeed
machine QGEN is less than QMIN - QGEN set
equal to QMIN - capability curve is assigned
to a non-conventional machine with machine
control mode greater than 1 - invalid base-
loaded machine flag - baseloaded machine
has negative active power
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
737
Power Flow MACHINE_CHNG_4
1.2.41. MACHINE_CHNG_4
Use this API routine to modify the data of an existing machine in the working case (see PSSE Program Op-
eration Manual, Plant Data).
This API routine was first introduced in release 35.3.0.
Batch command syntax:
BAT_MACHINE_CHNG_4 IBUS 'ID' INTGAR(1)..INTGAR(7)
REALAR(1)..REALAR(17),NAME
Python command syntax:
ierr = machine_chng_4(ibus, id, intgar, realar, name)
Fortran command syntax:
CALL MACHINE_CHNG_4(IBUS, ID, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STAT, machine status (1 by default)
INTGAR(2) O1, first owner number (owner of bus I by
default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
INTGAR(6) WMOD, non-conventional machine reactive
power limits mode (0 if this machine is a
conventional machine) (0 by default)
INTGAR(7) BASFLG, baseloaded machine flag
Real REALAR (17) array of 17 elements specifying (input).
REALAR(1) PG, machine active power (0.0 by default)
REALAR(2) QG, machine reactive power (0.0 by default)
REALAR(3) QT, machine reactive power upper limit
(9999.0 by default)
REALAR(4) QB, machine reactive power lower limit
(-9999.0 by default)
REALAR(5) PT, machine active power upper limit
(9999.0 by default)
REALAR(6) PB, machine active power lower limit
(-9999.0 by default)
REALAR(7) MBASE, machine MVA base (SBASE by de-
fault)
REALAR(8) ZR, machine resistance (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
738
Power Flow MACHINE_CHNG_4
REALAR(9) ZX, machine reactance (1.0 by default)
REALAR(10) RT, step-up transformer resistance (0.0 by de-
fault)
REALAR(11) XT, step-up transformer reactance (0.0 by de-
fault)
REALAR(12) GTAP, step-up transformer tap ratio (1.0 by
default)
REALAR(13) F1, first owner fraction (1.0 by default)
REALAR(14) F2, second owner fraction (1.0 by default)
REALAR(15) F3, third owner fraction (1.0 by default)
REALAR(16) F4, fourth owner fraction (1.0 by default)
REALAR(17) WPF, non-conventional machine power fac-
tor (1.0 by default)
Character*40 NAME name of the voltage droop control (input; " ").
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 no plant data at this bus
IERR = 8 machine not found
IERR = 9 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus - invalid non-conventional (renewable and
infeed type) machine control mode - invalid
renewable machine power factor - invalid
ZSORCE reactance - invalid owner number
- invalid ownership fraction - no ownership
data is specified - QMAX is less than QMIN -
PMAX is less than PMIN - MBASE is not posi-
tive - machine is no longer treated as a non-
conventional machine - non-conventional
machine table is full--retained as a conven-
tional machine - machine ownership table is
full--only first n owners retained - owner table
is full - infeed machine QGEN is greater than
QMAX - QGEN set equal to QMAX - infeed
machine QGEN is less than QMIN - QGEN set
equal to QMIN - capability curve is assigned
to a non-conventional machine with machine
control mode greater than 1 - invalid base-
loaded machine flag - baseloaded machine
has negative active power
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
739
Power Flow MACHINE_DATA
1.2.42. MACHINE_DATA
This API routine is obsolete. It has been replaced by the API routine machine_data_2 .
Use this API to modify the data of an existing machine in the working case or to add a new machine to a
plant bus in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MACHINE_DATA IBUS 'ID' INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(16)
Python command syntax:
ierr = machine_data(ibus, id, intgar, realar)
Fortran command syntax:
CALL MACHINE_API(IBUS, ID, INTGAR, REALAR, IERR, NERR)
Where:
Integer IBUS bus number (input).
Character*2 ID machine identifier (input).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) STAT, machine status
INTGAR(2) O1, first owner number
INTGAR(3) O2, second owner number
INTGAR(4) O3, third owner number
INTGAR(5) O4, fourth owner number
Real REALAR (16) array of 16 elements specifying (input).
REALAR(1) PG, machine active power
REALAR(2) QG, machine reactive power
REALAR(3) QT, machine reactive power upper limit
REALAR(4) QB, machine reactive power lower limit
REALAR(5) PT, machine active power upper limit
REALAR(6) PB, machine active power lower limit
REALAR(7) MBASE, machine MVA base
REALAR(8) ZR, machine resistance
REALAR(9) ZX, machine reactance
REALAR(10) RT, step-up transformer resistance
REALAR(11) XT, step-up transformer reactance
REALAR(12) GTAP, step-up transformer tap ratio
REALAR(13) F1, first owner fraction
REALAR(14) F2, second owner fraction
REALAR(15) F3, third owner fraction
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
740
Power Flow MACHINE_DATA
REALAR(16) F4, fourth owner fraction
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 no plant data at bus
IERR = 4 blank machine identifier is invalid
IERR = 5 machine table full
IERR = 6 machine ownership table full
IERR = 7 prerequisite requirements for API are not met
IERR = 8 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine
status - invalid ZSORCE reactance - invalid
ZSORCE: (0.0,0.0) - invalid owner number
- invalid ownership fraction - no ownership
data is specified - QMAX is less than QMIN -
PMAX is less than PMIN - MBASE is not pos-
itive - machine ownership table is full--only
first n owners retained - owner table is full
Integer NERR number of entries in PBUF02 containing error messages (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
741
Power Flow MACHINE_DATA_2
1.2.43. MACHINE_DATA_2
This API routine is obsolete. It has been replaced by the API routine machine_data_3 .
Use this API to modify the data of an existing machine in the working case, or to add a new machine to a
plant bus in the working case (see PSSE Program Operation Manual, Plant Data).
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_MACHINE_DATA_2 I 'ID' INTGAR(1)..INTGAR(6) REALAR(1)..REALAR(17)
Python command syntax:
ierr = machine_data_2(i, id, intgar, realar)
Fortran command syntax:
CALL MACHINE_API_2(I, ID, INTGAR, REALAR, IERR)
Where:
Integer I bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) STAT, machine status (1 by default)
INTGAR(2) O1, first owner number (owner of bus I by
default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
INTGAR(6) WMOD, wind machine reactive power lim-
its mode (0 if this machine is not a wind ma-
chine) (0 by default)
Real REALAR (17) array of 17 elements specifying (input).
REALAR(1) PG, machine active power (0.0 by default)
REALAR(2) QG, machine reactive power (0.0 by default)
REALAR(3) QT, machine reactive power upper limit
(9999.0 by default)
REALAR(4) QB, machine reactive power lower limit
(-9999.0 by default)
REALAR(5) PT, machine active power upper limit
(9999.0 by default)
REALAR(6) PB, machine active power lower limit
(-9999.0 by default)
REALAR(7) MBASE, machine MVA base (SBASE by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
742
Power Flow MACHINE_DATA_2
REALAR(8) ZR, machine resistance (0.0 by default)
REALAR(9) ZX, machine reactance (1.0 by default)
REALAR(10) RT, step-up transformer resistance (0.0 by de-
fault)
REALAR(11) XT, step-up transformer reactance (0.0 by de-
fault)
REALAR(12) GTAP, step-up transformer tap ratio (1.0 by
default)
REALAR(13) F1, first owner fraction (1.0 by default)
REALAR(14) F2, second owner fraction (1.0 by default)
REALAR(15) F3, third owner fraction (1.0 by default)
REALAR(16) F4, fourth owner fraction (1.0 by default)
REALAR(17) WPF, wind machine power factor (1.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 no plant data at this bus
IERR = 4 blank machine identifier is invalid
IERR = 5 machine table is full
IERR = 6 machine ownership table is full
IERR = 8 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus - invalid wind machine control mode -
invalid wind machine power factor - invalid
ZSORCE: reactance - invalid owner number
- invalid ownership fraction - no ownership
data is specified - QMAX is less than QMIN -
PMAX is less than PMIN - MBASE is not pos-
itive - non-conventional machine has nega-
tive active power - machine is no longer treat-
ed as a non-conventional machine - non-con-
ventional machine table is full--retained as a
conventional machine - capability curve is as-
signed to a non-conventional machine with
machine control mode greater than 1 - ma-
chine ownership table is full--only first n own-
ers retained - owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
743
Power Flow MACHINE_DATA_3
1.2.44. MACHINE_DATA_3
Use this API to modify the data of an existing machine in the working case, or to add a new machine to a
plant bus in the working case (see PSSE Program Operation Manual, Plant Data).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_MACHINE_DATA_3 IBUS 'ID' INTGAR(1)..INTGAR(7)
REALAR(1)..REALAR(17)
Python command syntax:
ierr = machine_data_3(ibus, id, intgar, realar)
Fortran command syntax:
CALL MACHINE_API_3(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STAT, machine status (1 by default)
INTGAR(2) O1, first owner number (owner of bus I by
default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
INTGAR(6) WMOD, non-conventional machine reactive
power limits mode (0 if this machine is a
conventional machine) (0 by default)
INTGAR(7) BASFLG, baseloaded machine flag
Real REALAR (17) array of 17 elements specifying (input).
REALAR(1) PG, machine active power (0.0 by default)
REALAR(2) QG, machine reactive power (0.0 by default)
REALAR(3) QT, machine reactive power upper limit
(9999.0 by default)
REALAR(4) QB, machine reactive power lower limit
(-9999.0 by default)
REALAR(5) PT, machine active power upper limit
(9999.0 by default)
REALAR(6) PB, machine active power lower limit
(-9999.0 by default)
REALAR(7) MBASE, machine MVA base (SBASE by de-
fault)
REALAR(8) ZR, machine resistance (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
744
Power Flow MACHINE_DATA_3
REALAR(9) ZX, machine reactance (1.0 by default)
REALAR(10) RT, step-up transformer resistance (0.0 by de-
fault)
REALAR(11) XT, step-up transformer reactance (0.0 by de-
fault)
REALAR(12) GTAP, step-up transformer tap ratio (1.0 by
default)
REALAR(13) F1, first owner fraction (1.0 by default)
REALAR(14) F2, second owner fraction (1.0 by default)
REALAR(15) F3, third owner fraction (1.0 by default)
REALAR(16) F4, fourth owner fraction (1.0 by default)
REALAR(17) WPF, non-conventional machine power fac-
tor (1.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 no plant data at this bus
IERR = 4 blank machine identifier is invalid
IERR = 5 machine table is full
IERR = 6 machine ownership table is full
IERR = 7 node-breaker terminal connection table is full
IERR = 9 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus - invalid non-conventional (renewable and
infeed type) machine control mode - invalid
renewable machine power factor - invalid
ZSORCE reactance - invalid owner number
- invalid ownership fraction - no ownership
data is specified - QMAX is less than QMIN -
PMAX is less than PMIN - MBASE is not posi-
tive - machine is no longer treated as a non-
conventional machine - non-conventional
machine table is full--retained as a conven-
tional machine - machine ownership table is
full--only first n owners retained - owner table
is full - infeed machine QGEN is greater than
QMAX - QGEN set equal to QMAX - infeed
machine QGEN is less than QMIN - QGEN set
equal to QMIN - capability curve is assigned
to a non-conventional machine with machine
control mode greater than 1 - invalid base-
loaded machine flag - baseloaded machine
has negative active power
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
745
Power Flow MACHINE_DATA_3
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
746
Power Flow MACHINE_DATA_4
1.2.45. MACHINE_DATA_4
Use this API to modify the data of an existing machine in the working case, or to add a new machine to a
plant bus in the working case (see PSSE Program Operation Manual, Plant Data).
This API routine was first introduced in release 35.3.0.
Batch command syntax:
BAT_MACHINE_DATA_4 IBUS 'ID' INTGAR(1)..INTGAR(7)
REALAR(1)..REALAR(17), NAME
Python command syntax:
ierr = machine_data_4(ibus, id, intgar, realar, name)
Fortran command syntax:
CALL MACHINE_API_4(IBUS, ID, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (7) array of 7 elements specifying (input).
INTGAR(1) STAT, machine status (1 by default)
INTGAR(2) O1, first owner number (owner of bus I by
default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
INTGAR(6) WMOD, non-conventional machine reactive
power limits mode (0 if this machine is a
conventional machine) (0 by default)
INTGAR(7) BASFLG, baseloaded machine flag
Real REALAR (17) array of 17 elements specifying (input).
REALAR(1) PG, machine active power (0.0 by default)
REALAR(2) QG, machine reactive power (0.0 by default)
REALAR(3) QT, machine reactive power upper limit
(9999.0 by default)
REALAR(4) QB, machine reactive power lower limit
(-9999.0 by default)
REALAR(5) PT, machine active power upper limit
(9999.0 by default)
REALAR(6) PB, machine active power lower limit
(-9999.0 by default)
REALAR(7) MBASE, machine MVA base (SBASE by de-
fault)
REALAR(8) ZR, machine resistance (0.0 by default)
REALAR(9) ZX, machine reactance (1.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
747
Power Flow MACHINE_DATA_4
REALAR(10) RT, step-up transformer resistance (0.0 by de-
fault)
REALAR(11) XT, step-up transformer reactance (0.0 by de-
fault)
REALAR(12) GTAP, step-up transformer tap ratio (1.0 by
default)
REALAR(13) F1, first owner fraction (1.0 by default)
REALAR(14) F2, second owner fraction (1.0 by default)
REALAR(15) F3, third owner fraction (1.0 by default)
REALAR(16) F4, fourth owner fraction (1.0 by default)
REALAR(17) WPF, non-conventional machine power fac-
tor (1.0 by default)
Character*40 NAME name of the voltage droop control (input; " ").
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 no plant data at this bus
IERR = 4 blank machine identifier is invalid
IERR = 5 machine table is full
IERR = 6 machine ownership table is full
IERR = 7 node-breaker terminal connection table is full
IERR = 9 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid machine sta-
tus - invalid non-conventional (renewable and
infeed type) machine control mode - invalid
renewable machine power factor - invalid
ZSORCE reactance - invalid owner number
- invalid ownership fraction - no ownership
data is specified - QMAX is less than QMIN -
PMAX is less than PMIN - MBASE is not posi-
tive - machine is no longer treated as a non-
conventional machine - non-conventional
machine table is full--retained as a conven-
tional machine - machine ownership table is
full--only first n owners retained - owner table
is full - infeed machine QGEN is greater than
QMAX - QGEN set equal to QMAX - infeed
machine QGEN is less than QMIN - QGEN set
equal to QMIN - capability curve is assigned
to a non-conventional machine with machine
control mode greater than 1 - invalid base-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
748
Power Flow MACHINE_DATA_4
loaded machine flag - baseloaded machine
has negative active power
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
749
Power Flow MBID2DC
1.2.46. MBID2DC
Use this API to change the name of the specified two-terminal dc line.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBID2DC DC DCNEW
Python command syntax:
ierr = mbid2dc(dc, dcnew)
Fortran command syntax:
CALL MBID2DC(NUM, NUMNEW, IERR)
CALL MBID2DC_II(NUM, NUMNEW, IERR)
CALL MBID2DC_IC(NUM, NAMENEW, IERR)
CALL MBID2DC_CI(NAME, NUMNEW, IERR)
CALL MBID2DC_CC(NAME, NAMENEW, IERR)
Where:
Integer or Character*12 DC quoted name of the two-terminal dc line for which the dc line name
is to be changed; if an unquoted integer value is specified, the API
converts it to a left-justified name (input; no default allowed).
Integer or Character*12 DCNEW quoted new name to be assigned to the two-terminal dc line; if an
unquoted integer value is specified, the API converts it to a left-justi-
fied name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the two-
terminal dc line for which the dc line name is to be changed (input;
no default allowed).
Integer NUMNEW new number to be assigned to the two-terminal dc line as a left-justi-
fied name (input; no default allowed).
Character*12 NAME name of the two-terminal dc line for which the dc line name is to be
changed (input; no default allowed).
Character*12 NAMENEW new dc line name to be assigned to the two-terminal dc line (input;
no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 dc line DC not found
IERR = 2 dc line DCNEW already exists
IERR = 3 a non-blank new identifier must be specified
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
750
Power Flow MBID3WND
1.2.47. MBID3WND
Use this API to change the identifier of the specified three-winding transformer.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBID3WND IBUS JBUS1 JBUS2 'ID' 'IDNEW'
Python command syntax:
ierr = mbid3wnd(ibus, jbus1, jbus2, id, idnew)
Fortran command syntax:
CALL MBID3WND(IBUS, JBUS1, JBUS2, ID, IDNEW, IERR)
Where:
Integer IBUS one of the buses connected by the three-winding transformer (input;
no default allowed).
Integer JBUS1 other bus connected by the three-winding transformer (input; no de-
fault allowed).
Integer JBUS2 other bus connected by the three-winding transformer (input; no de-
fault allowed).
Character*2 ID present circuit identifier of the three-winding transformer for which
the identifier is to be changed (input; '1' by default).
Character*2 IDNEW new identifier to be assigned to the three-winding transformer (in-
put; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 circuit ID bus IBUS to JBUS1 to JBUS2 not
found
IERR = 3 circuit IDNEW bus IBUS to JBUS1 to JBUS2 al-
ready exists
IERR = 4 invalid new identifier; cannot start with &, *
or @
IERR = 5 a non-blank new identifier must be specified
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
751
Power Flow MBIDATRN
1.2.48. MBIDATRN
Use this API to change the identifier of the specified inter-area transfer.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBIDATRN FRMAREA TOAREA 'ID' 'IDNEW'
Python command syntax:
ierr = mbidatrn(frmarea, toarea, id, idnew)
Fortran command syntax:
CALL MBIDATRN(FRMAREA, TOAREA, ID, IDNEW, IERR)
Where:
Integer FRMAREA one of the areas involved in the transfer (input; no default allowed).
Integer TOAREA other area involved in the transfer (input; no default allowed).
Character*1 ID present inter-area transfer identifier (input; '1' by default).
Character*1 IDNEW new identifier to be assigned to the inter-area transfer (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid area number
IERR = 2 inter-area transfer ID from area FRMAREA to
TOAREA not found
IERR = 3 inter-area transfer ID from area FRMAREA to
TOAREA already exists
IERR = 4 invalid new identifier--must be 0 through 9 or
A through Z
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
752
Power Flow MBIDBRN
1.2.49. MBIDBRN
Use this API to change the identifier of the specified non-transformer branch or two-winding transformer.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBIDBRN IBUS JBUS 'ID' 'IDNEW'
Python command syntax:
ierr = mbidbrn(ibus, jbus, id, idnew)
Fortran command syntax:
CALL MBIDBRN(IBUS, JBUS, ID, IDNEW, IERR)
Where:
Integer IBUS one of the buses connected by the branch (input; no default al-
lowed).
Integer JBUS other bus connected by the branch (input; no default allowed).
Character*2 ID present circuit identifier of the branch for which the identifier is to be
changed (input; '1' by default).
Character*2 IDNEW new identifier to be assigned to the branch (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 circuit ID from IBUS to JBUS not found
IERR = 3 circuit ID from IBUS to JBUS already exists
IERR = 4 invalid new identifier; cannot start with &, *
or @
IERR = 5 a non-blank new identifier must be specified
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
753
Power Flow MBIDFACTS
1.2.50. MBIDFACTS
Use this API to change the name of the specified FACTS device.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBIDFACTS FD FDNEW
Python command syntax:
ierr = mbidfacts(fd, fdnew)
Fortran command syntax:
CALL MBIDFACTS(NUM, NUMNEW, IERR)
CALL MBIDFACTS_II(NUM, NUMNEW, IERR)
CALL MBIDFACTS_IC(NUM, NAMENEW, IERR)
CALL MBIDFACTS_CI(NAME, NUMNEW, IERR)
CALL MBIDFACTS_CC(NAME, NAMENEW, IERR)
Where:
Integer or Character*12 FD quoted name of the FACTS device for which the FACTS device name is
to be changed; if an unquoted integer value is specified, the API con-
verts it to a left-justified name (input; no default allowed).
Integer or Character*12 FDNEW quoted new name to be assigned to the FACTS device; if an unquoted
integer value is specified, the API converts it to a left-justified name
(input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the FACTS
device for which the FACTS device name is to be changed (input; no
default allowed).
Integer NUMNEW new number to be assigned to the FACTS device as a left-justified
name (input; no default allowed).
Character*12 NAME name of the FACTS device for which the FACTS device name is to be
changed (input; no default allowed).
Character*12 NAMENEW new FACTS device name to be assigned to the FACTS device (input;
no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 FACTS device FD not found
IERR = 2 FACTS device FDNEW already exists
IERR = 3 a non-blank new identifier must be specified
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
754
Power Flow MBIDGNE
1.2.51. MBIDGNE
Use this API routine to change the GNE device name of the specified GNE device.
This API routine was first introduced in release 32.0.2.
Batch command syntax:
BAT_MBIDGNE 'NAME' 'NAMNEW'
Python command syntax:
ierr = mbidgne(name, namnew)
Fortran command syntax:
CALL MBIDGNE(NAME, NAMNEW, IERR)
Where:
Character*12 NAME name of the GNE device for which the GNE device name is to be
changed (input; no default allowed).
Character*12 NAMNEW new name to be assigned to the GNE device (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 GNE device NAME not found
IERR = 2 GNE device NEWNAM already exists
IERR = 3 a non-blank new identifier must be specified
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
755
Power Flow MBIDINDMAC
1.2.52. MBIDINDMAC
Use this API routine to change the identifier of the specified induction machine.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_MBIDINDMAC IBUS 'ID' 'IDNEW'
Python command syntax:
ierr = mbidindmac(ibus, id, idnew)
Fortran command syntax:
CALL MBIDINDMAC(IBUS, ID, IDNEW, IERR)
Where:
Integer IBUS bus to which induction machine ID is connected (input; no default al-
lowed).
Character*2 ID present induction machine identifier of the induction machine for
which the identifier is to be changed (input; '1' by default).
Character*2 IDNEW new identifier to be assigned to the induction machine (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 induction machine ID at bus IBUS not found
IERR = 3 induction machine ID at bus IBUS already ex-
ists
IERR = 4 a non-blank new identifier must be specified
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
756
Power Flow MBIDLOAD
1.2.53. MBIDLOAD
Use this API to change the identifier of the specified load.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBIDLOAD IBUS 'ID' 'IDNEW'
Python command syntax:
ierr = mbidload(ibus, id, idnew)
Fortran command syntax:
CALL MBIDLOAD(IBUS, ID, IDNEW, IERR)
Where:
Integer IBUS bus to which the load ID is connected (input; no default allowed).
Character*2 ID present load identifier of the load for which the identifier is to be
changed (input; '1' by default).
Character*2 IDNEW new identifier to be assigned to the load (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 load ID at bus IBUS not found
IERR = 3 load ID at bus IBUS already exists
IERR = 4 a non-blank new identifier must be specified
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
757
Power Flow MBIDMAC
1.2.54. MBIDMAC
Use this API to change the identifier of the specified machine.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBIDMAC IBUS 'ID' 'IDNEW'
Python command syntax:
ierr = mbidmac(ibus, id, idnew)
Fortran command syntax:
CALL MBIDMAC(IBUS, ID, IDNEW, IERR)
Where:
Integer IBUS bus to which the machine ID is connected (input; no default al-
lowed).
Character*2 ID present machine identifier of the machine for which the identifier is
to be changed (input; '1' by default).
Character*2 IDNEW new identifier to be assigned to the machine (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 machine ID at bus IBUS not found
IERR = 3 machine ID at bus IBUS already exists
IERR = 4 a non-blank new identifier must be specified
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
758
Power Flow MBIDMDC
1.2.55. MBIDMDC
Use this API to change the name of the specified multi-terminal dc line.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBIDMDC DC DCNEW
Python command syntax:
ierr = mbidmdc(dc, dcnew)
Fortran command syntax:
CALL MBIDMDC(NUM, NUMNEW, IERR)
CALL MBIDMDC_II(NUM, NUMNEW, IERR)
CALL MBIDMDC_IC(NUM, NAMENEW, IERR)
CALL MBIDMDC_CI(NAME, NUMNEW, IERR)
CALL MBIDMDC_CC(NAME, NAMENEW, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line for which the dc line name
is to be changed; if an unquoted integer value is specified, the API
converts it to a left-justified name (input; no default allowed).
Integer or Character*12 DCNEW quoted new name to be assigned to the multi-terminal dc line; if an
unquoted integer value is specified, the API converts it to a left-justi-
fied name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line for which the dc line name is to be changed (input;
no default allowed).
Integer NUMNEW new number to be assigned to the multi-terminal dc line as a left-jus-
tified name (input; no default allowed).
Character*12 NAME name of the multi-terminal dc line for which the dc line name is to be
changed (input; no default allowed).
Character*12 NAMENEW new dc line name to be assigned to the multi-terminal dc line (input;
no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 dc line DC not found
IERR = 2 dc line DCNEW already exists
IERR = 3 a non-blank new identifier must be specified
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
759
Power Flow MBIDMSL
1.2.56. MBIDMSL
Use this API to change the identifier of the specified multi-section line.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MBIDMSL IBUS JBUS 'ID' 'IDNEW'
Python command syntax:
ierr = mbidmsl(ibus, jbus, id, idnew)
Fortran command syntax:
CALL MBIDMSL(IBUS, JBUS, ID, IDNEW, IERR)
Where:
Integer IBUS one of the endpoint buses connected by the multi-section line (input;
no default allowed).
Integer JBUS other endpoint bus connected by the multi-section line (input; no de-
fault allowed).
Character*2 ID present multi-section identifier of the multi-section line for which the
identifier is to be changed (input; '&1' by default).
Character*2 IDNEW new identifier to be assigned to the multi-section line (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 multi-section line ID from IBUS to JBUS not
found
IERR = 3 multi-section line ID from IBUS to JBUS al-
ready exists
IERR = 4 invalid new identifier; must start with &
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
760
Power Flow MBIDSHUNT
1.2.57. MBIDSHUNT
Use this API to change the identifier of the specified fixed bus shunt.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_MBIDSHUNT IBUS 'ID' 'IDNEW'
Python command syntax:
ierr = mbidshunt(ibus, id, idnew)
Fortran command syntax:
CALL MBIDSHUNT(IBUS, ID, IDNEW, IERR)
Where:
Integer IBUS bus to which the shunt ID is connected (input; no default allowed).
Character*2 ID present shunt identifier of the shunt for which the identifier is to be
changed (input; '1' by default).
Character*2 IDNEW new identifier to be assigned to the shunt (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 shunt ID at bus IBUS not found
IERR = 3 shunt ID at bus IBUS already exists
IERR = 4 a non-blank new identifier must be specified
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
761
Power Flow MBIDSWSHUNT
1.2.58. MBIDSWSHUNT
Use this API to change the identifier of the specified switched bus shunt.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_MBIDSWSHUNT IBUS 'ID' 'IDNEW'
Python command syntax:
ierr = mbidswshunt(ibus, id, idnew)
Fortran command syntax:
CALL MBIDSWSHUNT(IBUS, ID, IDNEW, IERR)
Where:
Integer IBUS bus to which switched shunt "ID" is connected (input; no default al-
lowed).
Character*2 ID present shunt identifier of the shunt for which the identifier is to be
changed (input; '1' by default).
Character*2 IDNEW new identifier to be assigned to the shunt (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 switched shunt "ID" at bus IBUS not found
IERR = 3 switched shunt "ID" at bus IBUS already exists
IERR = 4 a non-blank new identifier must be specified
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
762
Power Flow MBIDVD
1.2.59. MBIDVD
Use this API to change the voltage droop control name of the specified voltage droop control in the work-
ing case.
This API routine was first introduced in release 35.3.0.
Batch command syntax:
BAT_MBIDVD 'NAME' 'NAMNEW'
Python command syntax:
ierr = mbidvd(name, namnew)
Fortran command syntax:
CALL MBIDVD(NAME, NAMNEW, IERR)
Where:
Character*40 NAME name of the voltage droop control for which the voltage droop con-
trol name is to be changed (input; no default allowed).
Character*40 NAMNEW new name to be assigned to the voltage droop control (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 voltage droop control NAME not found
IERR = 2 voltage droop control NEWNAM already exists
IERR = 3 a non-blank new identifier must be specified
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
763
Power Flow MBIDVSC
1.2.60. MBIDVSC
Use this API to change the VSC dc line name of the specified VSC dc line.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_MBIDVSC 'NAME' 'NAMNEW'
Python command syntax:
ierr = mbidvsc(name, namnew)
Fortran command syntax:
CALL MBIDVSC(NAME, NAMNEW, IERR)
Where:
Character*12 NAME name of the VSC dc line for which the VSC dc line name is to be
changed (input; no default allowed).
Character*12 NAMNEW new name to be assigned to the VSC dc line (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 dc line NAME not found
IERR = 2 dc line NEWNAM already exists
IERR = 3 a non-blank new identifier must be specified
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
764
Power Flow MULTI_SECTION_LINE_DATA
1.2.61. MULTI_SECTION_LINE_DATA
Use this API to modify the definition of an existing multi-section line grouping in the working case or to
add a new multi-section line grouping to the working case (see PSSE Program Operation Manual, Mul-
ti-Section Line Grouping Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MULTI_SECTION_LINE_DATA IBUS JBUS 'ID' INTGAR(1)..INTGAR(10)
Python command syntax:
ierr = multi_section_line_data(ibus, jbus, id, intgar)
Fortran command syntax:
CALL MULTI_SECTION_LINE_API_2(IBUS, JBUS, ID, INTGAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 ID a multi-section line identifier; ID(1:1) must be '&' (input; '&1' by de-
fault).
Integer INTGAR (10) array of 10 elements specifying (input).
INTGAR(1) METBUS, metered end bus number (must be
IBUS or JBUS) (IBUS by default)
INTGAR(2) DUM1 through DUM9 entries 2 through 10
are the bus numbers of the dummy buses
encountered along this multi-section line,
starting with the bus to which bus 'IBUS' is
connected and ending with the bus to which
bus 'JBUS' is connected; entries used are 2
through n+1, where n is the number of dum-
my buses; if n+1 is less than 10, entries n+2
through 10 must be set to 0 (No default is al-
lowed for entry 2; entries 3 through 10 are
0)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 multi-section line identifier is more than two
characters
IERR = 3 multi-section line identifier does not start
with &
IERR = 4 no dummy buses specified
IERR = 5 line section not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
765
Power Flow MULTI_SECTION_LINE_DATA
IERR = 6 circuit is already a member of another mul-
ti-section line
IERR = 7 bus appears more than once in the multi-sec-
tion line path
IERR = 8 dummy bus does not have exactly two
branches connected to it
IERR = 9 dummy bus is a converter bus of a dc line
IERR = 10 a FACTS device is connected to a dummy bus
IERR = 11 line section table is full
IERR = 12 multi-section line table is full
IERR = 13 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered
end bus - branch status and bus type code
changes
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
766
Power Flow MULTI_SECTION_LINE_EDIT
1.2.62. MULTI_SECTION_LINE_EDIT
Use this API to modify the status and/or metered end designation of an existing multi-section line grouping
in the working case (see PSSE Program Operation Manual, Multi-Section Line Grouping Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MULTI_SECTION_LINE_EDIT IBUS JBUS 'ID' INTGAR(1) INTGAR(2)
Python command syntax:
ierr = multi_section_line_edit(ibus, jbus, id, intgar)
Fortran command syntax:
CALL MULTI_SECTION_LINE_EDIT_API_2(IBUS, JBUS, ID, INTGAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 ID multi-section line identifier; ID(1:1) must be '&' (input; '&1' by de-
fault).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) STAT, branch status (unchanged by default)
INTGAR(1) = 1 for in-service
INTGAR(1) = 0 for out-of-service
INTGAR(2) METBUS, metered end bus number (must be
IBUS or JBUS) (unchanged by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 multi-section line identifier is more than two
characters
IERR = 3 multi-section line identifier does not start
with &
IERR = 4 multi-section line not found
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus. - invalid branch status
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
767
Power Flow MULTI_TERM_DC_BUS_DATA
1.2.63. MULTI_TERM_DC_BUS_DATA
Use this API to modify the data of a dc bus of an existing multi-terminal dc line in the working case or
to add a new dc bus to a multi-terminal dc line in the working case (see PSSE Program Operation Man-
ual, Multi-Terminal DC Transmission Line Data). The dc line must have previously been specified via the
MULTI_TERM_DC_LINE_DATA API.
just some stupid words to see if they show up
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MULTI_TERM_DC_BUS_DATA DC IDC INTGAR(1)..INTGAR(5) REALAR(1)
'DCNAME'
Python command syntax:
ierr, realaro = multi_term_dc_bus_data(dc, idc, intgar, realari, dcname)
Fortran command syntax:
CALL MULTI_TERMINAL_DC_BUS_API(NUM, IDC, INTGAR, REALAR, DCNAME, IERR)
CALL MULTI_TERMINAL_DC_BUS_API_I(NUM, IDC, INTGAR, REALAR, DCNAME, IERR)
CALL MULTI_TERMINAL_DC_BUS_API_C(NAME, IDC, INTGAR, REALAR, DCNAME, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line for which data for a dc bus
is to be specified; if an unquoted integer value is specified, the API
converts it to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line for which data for a dc bus is to be specified; no
default allowed
Character*12 NAME name of the multi-terminal dc line for which data for a dc bus is to be
specified; no default allowed
Integer IDC dc bus number (must be between 1 and the number of dc buses in
multi-terminal dc line DC) (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) IB, converter bus number or zero (0 by de-
fault)
INTGAR(2) AREA, area number (1 by default)
INTGAR(3) ZONE, zone number (1 by default)
INTGAR(4) OWNER, owner number (1 by default)
INTGAR(5) IDC2, second dc bus number (0 by default)
Real REALAR (2) (first value is input; second value is output) (input (output).).
Real REALARI (1) array of 1 elements specifying one element corresponding to values
REALAR(1) as described above(input).
REALARI(1) RGRND, resistance to ground (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
768
Power Flow MULTI_TERM_DC_BUS_DATA
Real REALARO (1) array of 1 elements specifying one element corresponding to value
REALAR(2) as described above(output).
REALARO(1) dc voltage (kV) (returned)
Character*12 DCNAME dc bus name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 invalid dc bus number
IERR = 3 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - data for lower num-
bered dc bus has not yet been entered. - con-
verter bus not found. - bus is not a converter
of this multi-terminal dc line. - this dc bus is
not the first dc bus of any converter. - the first
dc bus of some converter is set to this dc bus.
- invalid second dc bus number. - this dc bus
is being connected to a converter bus. - dc
bus no longer connected to some other con-
verter. - dc bus is being specified with no con-
verter bus. - dc bus no longer connected to
converter as its first dc bus. - dc bus no longer
connected to converter as its second dc bus.
- bus invalid as second dc bus because it is
the first dc bus of another converter. - invalid
area/zone/owner number. - area table is full. -
zone table is full. - owner table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
769
Power Flow MULTI_TERM_DC_CONVR_DATA
1.2.64. MULTI_TERM_DC_CONVR_DATA
Use this API to modify the data of a dc converter of an existing multi-terminal dc line in the working case or
to add a new converter to a multi-terminal dc line in the working case (see PSSE Program Operation Man-
ual, Multi-Terminal DC Transmission Line Data). The dc line must have previously been specified via the
MULTI_TERM_DC_LINE_DATA API.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MULTI_TERM_DC_CONVR_DATA DC INTGAR(1)..INTGAR(4)
REALAR(1)..REALAR(13)
Python command syntax:
ierr, realaro = multi_term_dc_convr_data(dc, intgar, realari)
Fortran command syntax:
CALL MULTI_TERM_DC_CONVERTER_API(NUM,INTGAR,REALAR,IERR)
CALL MULTI_TERM_DC_CONVERTER_API_I(NUM,INTGAR,REALAR,IERR)
CALL MULTI_TERM_DC_CONVERTER_API_C(NAME,INTGAR,REALAR,IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line for which data for a con-
verter is to be specified; if an unquoted integer value is specified, the
API converts it to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line for which data for a converter is to be specified; no
default allowed
Character*12 NAME name of the multi-terminal dc line for which data for a converter is to
be specified; no default allowed
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IB, converter bus number (no default al-
lowed)
INTGAR(2) N, number of bridges in series (1 by default)
INTGAR(3) CNVCOD, pole code (0 by default)
INTGAR(3) >= 0 for a positive pole converter
INTGAR(3) < 0 for a negative pole converter
INTGAR(4) VCCFLG, pole's voltage controlling converter
flag (0 by default)
INTGAR(4) <= 0 no
INTGAR(4) > 0 yes
Real REALAR (17) (first thirteen are input values; last four are output values) (input
(output).).
Real REALARI (13) array of 13 elements specifying corresponding to values REALAR(1)
through REALAR(13) as described above(input).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
770
Power Flow MULTI_TERM_DC_CONVR_DATA
REALARI(1) SETVL, scheduled current (amps), power
(MW) or voltage (kv) (0.0 by default)
REALARI(2) MN, minimum firing angle (0.0 by default)
REALARI(3) MX, maximum firing angle (90.0 by default)
REALARI(4) TR, transformer ratio (1.0 by default)
REALARI(5) RC, commutating resistance (0.0 by default)
REALARI(6) XC, commutating reactance (0.0 by default)
REALARI(7) EBAS, primary base ac voltage (1.0 by de-
fault)
REALARI(8) TAP, tap setting (1.0 by default)
REALARI(9) TPMX, maximum tap setting (1.5 by default)
REALARI(10) TPMN, minimum tap setting (0.51 by de-
fault)
REALARI(11) TSTP, tap step (0.00625 by default)
REALARI(12) MARG, margin (pu) (0.0 by default)
REALARI(13) DCPF, converter participation factor (1.0 by
default)
Real REALARO (4) array of 4 elements specifying corresponding to values REALAR(14)
through REALAR(17) as described above(output).
REALARO(1) firing angle (returned)
REALARO(2) converter current (amps) (returned)
REALARO(3) active power into converter (MW or kW) (re-
turned)
REALARO(4) reactive power into converter (MW or kW)
(returned)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 no converter bus is specified
IERR = 3 converter bus not found
IERR = 4 too many converters specified
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - converter bus is a
dummy bus of a multi-section line. - mul-
ti-section line grouping deleted. - invalid
number of bridges. - invalid base ac voltage. -
converter maximum angle is less than its min-
imum angle. - converter maximum tap is less
than its minimum tap. - invalid tap step. - dc
voltage setpoint is not positive. - scheduled
voltage is less than mode switch voltage. -
this converter bus is now on the other pole; it
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
771
Power Flow MULTI_TERM_DC_CONVR_DATA
is no longer the voltage controlling convert-
er of its previous pole. - there is no voltage
controlling converter on a pole. - this con-
verter replaces another converter as its pole's
voltage controlling converter. - this convert-
er must remain its pole's voltage controlling
converter because it is the only converter on
the pole
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
772
Power Flow MULTI_TERM_DC_LINE_CHNG
1.2.65. MULTI_TERM_DC_LINE_CHNG
Use this API routine to modify the control mode and mode switch voltage of an existing multi-terminal dc
line in the working case (see PSSE Program Operation Manual, Multi-Terminal DC Transmission Line Da-
ta). Converter data, dc bus data, and dc link data are specified via the MULTI_TERM_DC_CONVR_DATA,
MULTI_TERM_DC_BUS_DATA, and MULTI_TERM_DC_LINK_DATA API routines respectively.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_MULTI_TERM_DC_LINE_CHNG DC INTGAR(1) REALAR(1)
Python command syntax:
ierr, intgaro = multi_term_dc_line_chng(dc, intgari, realar)
Fortran command syntax:
CALL MULTI_TERMINAL_DC_LINE_CHNG(NUM, INTGAR, REALAR, IERR)
CALL MULTI_TERMINAL_DC_LINE_CHNG_I(NUM, INTGAR, REALAR, IERR)
CALL MULTI_TERMINAL_DC_LINE_CHNG_C(NAME, INTGAR, REALAR, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line for which data is to be
specified; if an unquoted integer value is specified, the API converts it
to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line for which data is to be specified; no default al-
lowed
Character*12 NAME name of the multi-terminal dc line for which data is to be specified;
no default allowed
Integer INTGAR (8) (first value is input; last seven are output values) (input (output).).
Integer INTGARI (1) array of 1 elements specifying one element corresponding to value
INTGAR(1) as described above(input).
INTGARI(1) MDC, control mode (0 by default)
Integer INTGARO (7) array of 7 elements specifying corresponding to values INTGAR(2)
through INTGAR(8) as described above(output).
INTGARO(1) positive pole voltage controlling converter in-
dex (returned)
INTGARO(2) negative pole voltage controlling converter
index, or zero if the negative pole is not be-
ing modeled (returned)
INTGARO(3) positive pole voltage controlling converter
bus number (returned)
INTGARO(4) positive pole voltage controlling converter
bus number (returned)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
773
Power Flow MULTI_TERM_DC_LINE_CHNG
INTGARO(5) number of converters (returned)
INTGARO(6) number of dc buses (returned)
INTGARO(7) number of dc links (returned)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) VCMOD, mode switch dc voltage (kV) (0.0 by
default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 2 blank dc line name is invalid
IERR = 3 dc line not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid dc line control
mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
774
Power Flow MULTI_TERM_DC_LINE_DATA
1.2.66. MULTI_TERM_DC_LINE_DATA
Use this API to modify the control mode and mode switch voltage of an existing multi-terminal dc
line in the working case or to add a new multi-terminal dc line to the working case (see PSSE Pro-
gram Operation Manual, Multi-Terminal DC Transmission Line Data). Converter data, dc bus data, and
dc link data are specified via the MULTI_TERM_DC_CONVR_DATA, MULTI_TERM_DC_BUS_DATA, and
MULTI_TERM_DC_LINK_DATA APIs respectively.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MULTI_TERM_DC_LINE_DATA DC INTGAR(1) REALAR(1)
Python command syntax:
ierr, intgaro = multi_term_dc_line_data(dc, intgari, realar)
Fortran command syntax:
CALL MULTI_TERMINAL_DC_LINE_API(NUM, INTGAR, REALAR, IERR)
CALL MULTI_TERMINAL_DC_LINE_API_I(NUM, INTGAR, REALAR, IERR)
CALL MULTI_TERMINAL_DC_LINE_API_C(NAME, INTGAR, REALAR, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line for which data is to be
specified; if an unquoted integer value is specified, the API converts it
to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line for which data is to be specified; no default al-
lowed
Character*12 NAME name of the multi-terminal dc line for which data is to be specified;
no default allowed
Integer INTGAR (8) (first value is input; last seven are output values) (input (output).).
Integer INTGARI (1) array of 1 elements specifying one element corresponding to value
INTGAR(1) as described above(input).
INTGARI(1) MDC, control mode (0 by default)
Integer INTGARO (7) array of 7 elements specifying corresponding to values INTGAR(2)
through INTGAR(8) as described above(output).
INTGARO(1) positive pole voltage controlling converter in-
dex (returned)
INTGARO(2) negative pole voltage controlling converter
index, or zero if the negative pole is not be-
ing modeled (returned)
INTGARO(3) positive pole voltage controlling converter
bus number (returned)
INTGARO(4) positive pole voltage controlling converter
bus number (returned)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
775
Power Flow MULTI_TERM_DC_LINE_DATA
INTGARO(5) number of converters (returned)
INTGARO(6) number of dc buses (returned)
INTGARO(7) number of dc links (returned)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) VCMOD, mode switch dc voltage (kV) (0.0 by
default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 multi-terminal dc line table is full
IERR = 2 blank dc line name is invalid
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid dc line control
mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
776
Power Flow MULTI_TERM_DC_LINK_DATA
1.2.67. MULTI_TERM_DC_LINK_DATA
Use this API to modify the data of a dc link of an existing multi-terminal dc line in the working case or
to add a new dc link to a multi-terminal dc line in the working case (see PSSE Program Operation Man-
ual, Multi-Terminal DC Transmission Line Data). The dc line must have previously been specified via the
MULTI_TERM_DC_LINE_DATA API.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MULTI_TERM_DC_LINK_DATA DC IDC JDC 'DCCKT' INTGAR(1) REALAR(1)
REALAR(2)
Python command syntax:
ierr = multi_term_dc_link_data(dc,idc,jdc,dcckt,intgar,realar)
Fortran command syntax:
CALL MULTI_TERMINAL_DC_LINK_API(NUM, IDC, JDC, DCCKT, INTGAR, REALAR,
IERR)
CALL MULTI_TERMINAL_DC_LINK_API_I(NUM, IDC, JDC, DCCKT, INTGAR, REALAR,
IERR)
CALL MULTI_TERMINAL_DC_LINK_API_C(NAME, IDC, JDC, DCCKT, INTGAR, REALAR,
IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line for which data for a dc link
is to be specified; if an unquoted integer value is specified, the API
converts it to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line for which data for a dc link is to be specified; no
default allowed
Character*12 NAME name of the multi-terminal dc line for which data for a dc link is to be
specified; no default allowed
Integer IDC dc bus number of from bus (must be between 1 and the number of
dc buses in multi-terminal dc line DC) (input; no default allowed).
Integer JDC dc bus number of to bus (must be between 1 and the number of dc
buses in multi-terminal dc line DC) (input; no default allowed).
Character*1 DCCKT circuit identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) METBUS, metered end dc bus number (IDC
by default)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) RDC, dc link resistance (0.0 by default)
REALAR(2) LDC, dc link inductance (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
777
Power Flow MULTI_TERM_DC_LINK_DATA
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 invalid dc bus number
IERR = 3 circuit identifier is more than one character
IERR = 4 dc bus not present in this multi-terminal dc
line
IERR = 5 branch from a bus to itself
IERR = 6 too many dc links in this multi-terminal dc
line
IERR = 7 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus. - invalid dc link resistance. - invalid dc
link inductance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
778
Power Flow OWNER_DATA
1.2.68. OWNER_DATA
Use this API to modify owner data in the working case (see PSSE Program Operation Manual, Interarea
Transfer Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OWNER_DATA IOWNER 'OWNAME'
Python command syntax:
ierr = owner_data(iowner, owname)
Fortran command syntax:
CALL OWNER_API_2(IOWNER, OWNAME, IERR)
Where:
Integer IOWNER owner number between 1 and 9999 (input; no default allowed).
Character*12 OWNAME owner name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid owner number
IERR = 2 owner table is full
IERR = 3 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - no equipment is as-
signed to owner
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
779
Power Flow PBUS_ADD_MOD
1.2.69. PBUS_ADD_MOD
Use this API to add or modify transaction event participating bus data.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PBUS_ADD_MOD EVENT IBUS REALAR(1) REALAR(2)
Python command syntax:
ierr = pbus_add_mod(event, ibus, realar)
Fortran command syntax:
CALL PBUS_ADD_MOD(EVENT, IBUS, REALAR, IERR, NERR)
Where:
Integer EVENT transaction event number (input).
Integer IBUS number of the participating bus (input).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) participating bus load value
REALAR(2) participating bus generation value
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 2 invalid transaction event number
IERR = 3 transaction event not found
IERR > 3 unable to add or modify participating bus da-
ta; error condition detected in data access
routine
IERR = 10 prerequisite requirements for API are not met
IERR = -1 warnings: - None
Integer NERR number of error entries in PBUF02 (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
780
Power Flow PBUS_DELETE
1.2.70. PBUS_DELETE
Use this API to remove a bus from the set of buses that are participating in a transaction event.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PBUS_DELETE EVENT IBUS
Python command syntax:
ierr = pbus_delete(event, ibus)
Fortran command syntax:
CALL PBUS_DELETE(EVENT, IBUS, IERR, NERR)
Where:
Integer EVENT transaction event number (input).
Integer IBUS number of the participating bus (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid transaction event number
IERR = 2 transaction event not found
IERR = 3 prerequisite requirements for API are not met
Integer NERR number of error entries in PBUF02 (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
781
Power Flow PLANT_CHNG
1.2.71. PLANT_CHNG
This API routine is obsolete. It has been replaced by the API routine plant_chng_3 .
Use this API routine to modify the data of an existing plant in the working case, if the plant bus is not a bus
section within a substation. Use plant_chng_3 if data is to be modified at a plant associated with a bus sec-
tion.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_PLANT_CHNG IBUS INTGAR(1) REALAR(1) REALAR(2)
Python command syntax:
ierr = plant_chng(ibus, intgar, realar)
Fortran command syntax:
CALL PLANT_CHNG(IBUS, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) IREG, remote bus number (0 to control volt-
age at bus IBUS) (0 by default)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) VS, scheduled voltage magnitude (1.0 by de-
fault)
REALAR(2) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 3 no plant at bus
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid scheduled
voltage - regulated bus not found - plant
specified as remotely regulating itself - type
code of regulated bus is not 1 or 2 - RMPCT is
not positive
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
782
Power Flow PLANT_CHNG_3
1.2.72. PLANT_CHNG_3
This API routine is obsolete. It has been replaced by the API routine plant_chng_4 .
Use this API routine to modify the data of an existing plant that is part of a substation in the working case.
If the substation has been split into multiple bus sections, use this API to designate the bus number and a
node number within the bus section of the plant that the data is to be changed.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_PLANT_CHNG_3 IBUS INODE INTGAR(1) REALAR(1) REALAR(2)
Python command syntax:
ierr = plant_chng_3(ibus, inode, intgar, realar)
Fortran command syntax:
CALL PLANT_CHNG_3(IBUS, INODE, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INODE node number within the bus section for which the plant resides (in-
put; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) IREG, remote bus number (0 to control volt-
age at bus IBUS) (0 by default)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) VS, scheduled voltage magnitude (1.0 by de-
fault)
REALAR(2) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 3 no plant at bus
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid scheduled
voltage - regulated bus not found - plant
specified as remotely regulating itself - type
code of regulated bus is not 1 or 2 - RMPCT is
not positive
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
783
Power Flow PLANT_CHNG_4
1.2.73. PLANT_CHNG_4
Use this API routine to modify the data of an existing plant that is part of a substation in the working case.
If the substation has been split into multiple bus sections, use this API to designate the bus number and a
node number within the bus section of the plant that the data is to be changed.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_PLANT_CHNG_4 IBUS INODE INTGAR(1) INTGAR(2) REALAR(1) REALAR(2)
Python command syntax:
ierr = plant_chng_4(ibus, inode, intgar, realar)
Fortran command syntax:
CALL PLANT_CHNG_4(IBUS, INODE, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INODE node number within the bus section for which the plant resides (in-
put; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) IREG, remote bus number (0 to control volt-
age at bus IBUS) (0 by default)
INTGAR(2) NREG, regulated bus node number (0 to con-
trol voltage at the "parent" bus
section of bus IBUS)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) VS, scheduled voltage magnitude (1.0 by de-
fault)
REALAR(2) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 3 no plant at bus
IERR = 4 invalid bus number
IERR = 5 INODE is an invalid node number
IERR = 6 bus IBUS does not belong to a substation
IERR = 7 node INODE is not found in the substation of
bus IBUS
IERR = 8 node INODE is not connected to any bus sec-
tion of bus IBUS
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
784
Power Flow PLANT_CHNG_4
IERR = 9 INODE must be 0 for a bus that is not yet a
generator bus
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid scheduled
voltage - regulated bus not found - type code
of regulated bus is not 1 or 2 - RMPCT is not
positive - per unit scheduled voltage is out-
side of the band 0.5 to 1.5 p.u. - invalid node
number - non-zero regulated node specified
but regulated bus does not belong to a sub-
station - regulated node not found - regulat-
ed node is not connected to any bus section
of the regulated bus - a remote regulated bus
is specified for a type 3 bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
785
Power Flow PLANT_DATA
1.2.74. PLANT_DATA
This API routine is obsolete. It has been replaced by the API routine plant_data_3 .
Use this API to modify the data of an existing plant in the working case, or to add a new plant to the work-
ing case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PLANT_DATA IBUS INTGAR(1) REALAR(1) REALAR(2)
Python command syntax:
ierr = plant_data(ibus, intgar, realar)
Fortran command syntax:
CALL PLANT_API_2(IBUS, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) IREG, remote bus number (0 to control volt-
age at bus IBUS) (0 by default)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) VS, scheduled voltage magnitude (1.0 by de-
fault)
REALAR(2) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 plant table is full
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid scheduled
voltage - regulated bus not found - plant
specified as remotely regulating itself - type
code of regulated bus is not 1 or 2 - RMPCT is
not positive
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
786
Power Flow PLANT_DATA_3
1.2.75. PLANT_DATA_3
This API routine is obsolete. It has been replaced by the API routine plant_data_4 .
Use this API to modify the data of an existing plant in the working case, or to add a new plant to the work-
ing case (see PSSE Program Operation Manual, Fixed Bus Shunt Data).
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_PLANT_DATA_3 IBUS INODE INTGAR(1) REALAR(1) REALAR(2)
Python command syntax:
ierr = plant_data_3(ibus, inode, intgar, realar)
Fortran command syntax:
CALL PLANT_API_3(IBUS, INODE, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INODE bus section node number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) IREG, remote bus number (0 to control volt-
age at bus IBUS) (0 by default)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) VS, scheduled voltage magnitude (1.0 by de-
fault)
REALAR(2) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 plant table is full
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid scheduled
voltage - regulated bus not found - plant
specified as remotely regulating itself - type
code of regulated bus is not 1 or 2 - RMPCT is
not positive
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
787
Power Flow PLANT_DATA_4
1.2.76. PLANT_DATA_4
Use this API to modify the data of an existing plant in the working case, or to add a new plant to the work-
ing case (see PSSE Program Operation Manual, Fixed Bus Shunt Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_PLANT_DATA_4 IBUS INODE INTGAR(1) INTGAR(2) REALAR(1) REALAR(2)
Python command syntax:
ierr = plant_data_4(ibus, inode, intgar, realar)
Fortran command syntax:
CALL PLANT_API_4(IBUS, INODE, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INODE bus section node number (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) IREG, remote bus number (0 to control volt-
age at bus IBUS) (0 by default)
INTGAR(2) NREG, regulated bus node number (0 to con-
trol voltage at the "parent" bus section of bus
IBUS) (0 by default)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) VS, scheduled voltage magnitude (1.0 by de-
fault)
REALAR(2) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 plant table is full
IERR = 4 invalid bus number
IERR = 5 INODE is an invalid node number
IERR = 6 bus IBUS does not belong to a substation
IERR = 7 node INODE is not found in the substation of
bus IBUS
IERR = 8 node INODE is not connected to any bus sec-
tion of bus IBUS
IERR = 9 INODE must be 0 for a bus that is not yet a
generator bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
788
Power Flow PLANT_DATA_4
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid scheduled
voltage - regulated bus not found - type code
of regulated bus is not 1 or 2 - RMPCT is not
positive - per unit scheduled voltage is out-
side of the band 0.5 to 1.5 p.u. - invalid node
number - non-zero regulated node specified
but regulated bus does not belong to a sub-
station - regulated node not found - regulat-
ed node is not connected to any bus section
of the regulated bus - a remote regulated bus
is specified for a type 3 bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
789
Power Flow PURG
1.2.77. PURG
Use this API routine to delete specified outaged equipment items from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURG SID ALL OPT STATUS
Python command syntax:
ierr = purg(sid, all, opt, status)
Fortran command syntax:
CALL PURGNW(SID, ALL, OPT, 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 = 0 process only buses in subsystem SID.
ALL = 1 process all buses.
Integer OPT equipment type to remove (input; 1 by default).
OPT = 1 ac lines
OPT = 2 switched shunts
OPT = 3 machines
OPT = 4 plants
OPT = 5 two-terminal dc lines
OPT = 6 multi-terminal dc lines
OPT = 7 loads
OPT = 8 FACTS devices
OPT = 9 three-winding transformers
OPT = 10 VSC dc lines
OPT = 11 fixed bus shunts
OPT = 12 GNE devices
OPT = 13 induction machines
Integer STATUS option for the treatment of out-of-service ties to other systems (in-
put; 0 by default).
STATUS = 0 keep out-of-service ties
STATUS = 1 remove out-of-service ties
Integer IERR error code (output).
IERR = 0 no error
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
790
Power Flow PURG
IERR = 2 invalid ALL value
IERR = 3 invalid OPT value
IERR = 4 invalid STATUS 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
791
Power Flow PURG2DC
1.2.78. PURG2DC
Use this API to delete the specified two-terminal dc line from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURG2DC DC
Python command syntax:
ierr = purg2dc(dc)
Fortran command syntax:
CALL PURG2DC(NUM, IERR)
CALL PURG2DC_I(NUM, IERR)
CALL PURG2DC_C(NAME, IERR)
Where:
Integer or Character*12 DC quoted name of the two-terminal dc line to be removed; if an un-
quoted integer value is specified, the API converts it to a left-justified
name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the two-
terminal dc line to be removed; no default allowed
Character*12 NAME name of the two-terminal dc line to be removed; no default allowed
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 dc line 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
792
Power Flow PURG3WND
1.2.79. PURG3WND
Use this API to delete the specified three-winding transformer from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURG3WND IBUS JBUS KBUS 'CKT'
Python command syntax:
ierr = purg3wnd(ibus, jbus, kbus, ckt)
Fortran command syntax:
CALL PURG3WND(IBUS, JBUS, KBUS, CKT, IERR)
Where:
Integer IBUS one of the buses connected by the three-winding transformer (input;
no default allowed).
Integer JBUS the bus connected by the three-winding transformer (input; no de-
fault allowed).
Integer KBUS other bus connected by the three-winding transformer (input; no de-
fault allowed).
Character*2 CKT circuit identifier of the three-winding transformer to be deleted (in-
put; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 three-winding transformer not found
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
793
Power Flow PURGAREA
1.2.80. PURGAREA
Use this API to delete areas with no equipment assigned to them from the working case.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_PURGAREA SID ALL
Python command syntax:
ierr = purgarea(sid, all)
Fortran command syntax:
CALL PURGAREA(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 delete only areas in area subsystem SID with
no equipment assigned to them.
ALL = 1 delete all areas with no equipment assigned
to them.
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
794
Power Flow PURGATRN
1.2.81. PURGATRN
Use this API to delete the specified inter-area transfer from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGATRN FRMAREA TOAREA 'ID'
Python command syntax:
ierr = purgatrn(frmarea, toarea, id)
Fortran command syntax:
CALL PURGATRN(FRMAREA, TOAREA, ID, IERR)
Where:
Integer FRMAREA one of the areas involved in the transfer (input; no default allowed).
Integer TOAREA other area involved in the transfer (input; no default allowed).
Character*1 ID inter-area transfer identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 area not found
IERR = 2 inter-area transfer not found
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
795
Power Flow PURGBRN
1.2.82. PURGBRN
Use this API to delete the specified non-transformer branch or two-winding transformer from the working
case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGBRN IBUS JBUS 'CKT'
Python command syntax:
ierr = purgbrn(ibus, jbus, ckt)
Fortran command syntax:
CALL PURGBRN(IBUS, JBUS, CKT, IERR)
Where:
Integer IBUS one of the buses connected by the branch (input; no default al-
lowed).
Integer JBUS other bus connected by the branch (input; no default allowed).
Character*2 CKT circuit identifier of the branch to be deleted (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 branch not found
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
796
Power Flow PURGCAPCURVE
1.2.83. PURGCAPCURVE
Use this API to delete the specified machine's capability curve from the working case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_PURGCAPCURVE IBUS 'ID'
Python command syntax:
ierr = purgcapcurve(ibus, id)
Fortran command syntax:
CALL PURGCAPCURVE(IBUS, ID, IERR)
Where:
Integer IBUS bus to which the specified machine is connected (input; no default
allowed).
Character*2 ID identifier of the machine whose capability curve is to be removed (in-
put; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no machines at the bus
IERR = 3 machine not found
IERR = 4 capability curve not found for this machine
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
797
Power Flow PURGE_MULTI_TERM_DC_BUS
1.2.84. PURGE_MULTI_TERM_DC_BUS
Use this API to delete the specified dc bus from the specified multi-terminal dc line in the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_MULTI_TERM_DC_BUS DC IBUS
Python command syntax:
ierr = purge_multi_term_dc_bus(dc, ibus)
Fortran command syntax:
CALL PURGMDC_DC_BUS_API(NUM, IBUS, IERR, NERR)
CALL PURGMDC_DC_BUS_API_I(NUM, IBUS, IERR)
CALL PURGMDC_DC_BUS_API_C(NAME, IBUS, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line from which a dc bus is to
be removed; if an unquoted integer value is specified, the API con-
verts it to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line from which a dc bus is to be removed (input; no
default allowed).
Character*12 NAME name of the multi-terminal dc line from which a dc bus is to be re-
moved (input; no default allowed).
Integer IBUS number of the dc bus to be removed (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 invalid dc bus number
IERR = 3 dc bus not present in this multi-terminal dc
line
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - dc bus no longer con-
nected to converter as first dc bus. - dc bus no
longer connected to converter as second dc
bus. - dc link deleted
Integer NERR number of error entries in PBUF02
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
798
Power Flow PURGE_MULTI_TERM_DC_CONVR
1.2.85. PURGE_MULTI_TERM_DC_CONVR
Use this API to delete the specified converter from the specified multi-terminal dc line in the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_MULTI_TERM_DC_CONVR DC IBUS
Python command syntax:
ierr = purge_multi_term_dc_convr(dc, ibus)
Fortran command syntax:
CALL PURGMDC_CONVERTER_API(NUM, IBUS, IERR)
CALL PURGMDC_CONVERTER_API_I(NUM, IBUS, IERR)
CALL PURGMDC_CONVERTER_API_C(NAME, IBUS, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line from which a converter is
to be removed; if an unquoted integer value is specified, the API con-
verts it to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line from which a converter is to be removed (input; no
default allowed).
Character*12 NAME name of the multi-terminal dc line from which a converter is to be re-
moved (input; no default allowed).
Integer IBUS number of the ac bus from which the converter is to be removed (in-
put).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 converter bus not found
IERR = 3 bus is not a converter bus of this multi-termi-
nal dc line
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - this converter bus is
no longer its pole's voltage controlling con-
verter. - the voltage setpoint of the new volt-
age controlling converter is not positive. - the
voltage setpoint of the new voltage control-
ling converter is less than the mode switch
voltage
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
799
Power Flow PURGE_MULTI_TERM_DC_CONVR
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
800
Power Flow PURGE_MULTI_TERM_DC_LINK
1.2.86. PURGE_MULTI_TERM_DC_LINK
Use this API to delete the specified dc link from the specified multi-terminal dc line in the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_MULTI_TERM_DC_LINK DC IBUS JBUS 'CKT'
Python command syntax:
ierr = purge_multi_term_dc_link(dc, ibus, jbus, ckt)
Fortran command syntax:
CALL PURGMDC_DC_LINK_API(NUM, IBUS, JBUS, CKT, IERR)
CALL PURGMDC_DC_LINK_API_I(NUM, IBUS, JBUS, CKT, IERR)
CALL PURGMDC_DC_LINK_API_C(NAME, IBUS, JBUS, CKT, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line from which a dc link is to
be removed; if an unquoted integer value is specified, the API con-
verts it to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line from which a dc link is to be removed (input; no
default allowed).
Character*12 NAME name of the multi-terminal dc line from which a dc link is to be re-
moved (input; no default allowed).
Integer IBUS one of the dc buses connected by the dc link to be removed (input).
Integer JBUS other dc bus connected by the dc link (input).
Character*1 CKT circuit identifier of the dc link to be deleted (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 invalid dc bus number
IERR = 3 dc bus not present in this multi-terminal dc
line
IERR = 4 circuit identifier is more than one character
IERR = 5 dc link not found in this multi-terminal dc line
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
801
Power Flow PURGFACTS
1.2.87. PURGFACTS
Use this API to delete the specified FACTS device from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGFACTS FD
Python command syntax:
ierr = purgfacts(fd)
Fortran command syntax:
CALL PURGFACTS(NUM, IERR)
CALL PURGFACTS_I(NUM, IERR)
CALL PURGFACTS_C(NAME, IERR)
Where:
Integer or Character*12 FD quoted name of the FACTS device to be removed; if an unquoted in-
teger value is specified, the API converts it to a left-justified name (in-
put; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the FACTS
device to be removed (input; no default allowed).
Character*12 NAME name of the FACTS device to be removed (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 FACTS device 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
802
Power Flow PURGGNE
1.2.88. PURGGNE
Use this API routine to delete the specified GNE device from the working case.
This API routine was first introduced in release 32.0.2.
Batch command syntax:
BAT_PURGGNE 'NAME'
Python command syntax:
ierr = purggne(name)
Fortran command syntax:
CALL PURGGNE(NAME, IERR)
Where:
Character*12 NAME name of the GNE device to be removed (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 GNE device 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
803
Power Flow PURGINDMAC
1.2.89. PURGINDMAC
Use this API routine to delete the specified induction machine from the working case.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_PURGINDMAC IBUS 'ID'
Python command syntax:
ierr = purgindmac(ibus, id)
Fortran command syntax:
CALL PURGINDMAC(IBUS, ID, IERR)
Where:
Integer IBUS bus to which induction machine ID is connected (input; no default al-
lowed).
Character*2 ID identifier of the induction machine to be removed (input; '1' by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no induction machines at bus
IERR = 3 induction machine not found
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
804
Power Flow PURGINDMACS
1.2.90. PURGINDMACS
Use this API routine to delete all induction machines from the specified bus in the working case.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_PURGINDMACS IBUS
Python command syntax:
ierr = purgindmacs(ibus)
Fortran command syntax:
CALL PURGINDMACS(IBUS, IERR)
Where:
Integer IBUS bus from which all induction machines are to be removed (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
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
805
Power Flow PURGLOAD
1.2.91. PURGLOAD
Use this API to delete the specified load from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGLOAD IBUS 'ID'
Python command syntax:
ierr = purgload(ibus, id)
Fortran command syntax:
CALL PURGLOAD(IBUS, ID, IERR)
Where:
Integer IBUS bus to which the load ID is connected (input; no default allowed).
Character*2 ID identifier of the load to be removed (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no loads at bus
IERR = 3 load not found
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
806
Power Flow PURGLOADS
1.2.92. PURGLOADS
Use this API to delete all loads from the specified bus in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGLOADS IBUS
Python command syntax:
ierr = purgloads(ibus)
Fortran command syntax:
CALL PURGLOADS(IBUS, IERR)
Where:
Integer IBUS bus from which all loads are to be removed (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no loads at bus
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
807
Power Flow PURGMAC
1.2.93. PURGMAC
Use this API to delete the specified machine from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGMAC IBUS 'ID'
Python command syntax:
ierr = purgmac(ibus, id)
Fortran command syntax:
CALL PURGMAC(IBUS, ID, IERR)
Where:
Integer IBUS bus to which the machine ID is connected (input; no default al-
lowed).
Character*2 ID identifier of the machine to be removed (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no machines at bus
IERR = 3 machine not found
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
808
Power Flow PURGMDC
1.2.94. PURGMDC
Use this API to delete the specified multi-terminal dc line from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGMDC DC
Python command syntax:
ierr = purgmdc(dc)
Fortran command syntax:
CALL PURGMDC(NUM, IERR)
CALL PURGMDC_I(NUM, IERR)
CALL PURGMDC_C(NAME, IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line to be removed; if an un-
quoted integer value is specified, the API converts it to a left-justified
name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line to be removed (input; no default allowed).
Character*12 NAME name of the multi-terminal dc line to be removed (input; no default
allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 dc line 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
809
Power Flow PURGMSL
1.2.95. PURGMSL
Use this API to delete the specified multi-section line grouping from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGMSL IBUS JBUS 'CKT'
Python command syntax:
ierr = purgmsl(ibus, jbus, ckt)
Fortran command syntax:
CALL PURGMSL(IBUS, JBUS, CKT, IERR)
Where:
Integer IBUS one of the endpoint buses of the multi-section line (input; no default
allowed).
Integer JBUS other endpoint bus of the multi-section line (input; no default al-
lowed).
Character*2 CKT circuit identifier of the multi-section line to be deleted; the first char-
acter must be an ampersand (input; '&1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 multi-section line not found
IERR = 3 invalid multi-section line identifier (first char-
acter not &)
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
810
Power Flow PURGMUT
1.2.96. PURGMUT
Use this API to delete the specified zero sequence mutual coupling from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGMUT IBUS1 JBUS1 'CKT1' IBUS2 JBUS2 'CKT2'
Python command syntax:
ierr = purgmut(ibus1, jbus1, ckt1, ibus2, jbus2, ckt2)
Fortran command syntax:
CALL PURGMUT(IBUS1, JBUS1, CKT1, IBUS2, JBUS2, CKT2, IERR)
Where:
Integer IBUS1 one of the buses connected by the first branch of the mutual cou-
pling (input; no default allowed).
Integer JBUS1 other bus connected by the first branch of the mutual coupling (in-
put; no default allowed).
Character*2 CKT1 circuit identifier of the first branch of the mutual coupling (input; '1'
by default).
Integer IBUS2 one of the buses connected by the second branch of the mutual cou-
pling (input; no default allowed).
Integer JBUS2 other bus connected by the second branch of the mutual coupling
(input; no default allowed).
Character*2 CKT2 circuit identifier of the second branch of the mutual coupling (input;
'1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 branch not found
IERR = 3 mutual coupling not found
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
811
Power Flow PURGOWNER
1.2.97. PURGOWNER
Use this API to delete owners with no equipment assigned to them from the working case.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_PURGOWNER SID ALL
Python command syntax:
ierr = purgowner(sid, all)
Fortran command syntax:
CALL PURGOWNER(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 delete only owners in owner subsystem SID
with no equipment assigned to them
ALL = 1 delete all owners with no equipment as-
signed to them
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
812
Power Flow PURGPLNT
1.2.98. PURGPLNT
Use this API to delete the plant and machine data at the specified bus from the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGPLNT IBUS
Python command syntax:
ierr = purgplnt(ibus)
Fortran command syntax:
CALL PURGPLNT(IBUS, IERR)
Where:
Integer IBUS bus from which the plant is to be removed (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no machines at bus
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
813
Power Flow PURGSHUNT
1.2.99. PURGSHUNT
Use this API to delete the specified fixed bus shunt from the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGSHUNT IBUS 'ID'
Python command syntax:
ierr = purgshunt(ibus, id)
Fortran command syntax:
CALL PURGSHUNT(IBUS, ID, IERR)
Where:
Integer IBUS bus to which the shunt is connected (input; no default allowed).
Character*2 ID identifier of the shunt to be removed (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no fixed shunts at bus
IERR = 3 shunt not found
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
814
Power Flow PURGSHUNTS
1.2.100. PURGSHUNTS
Use this API to delete all fixed shunts from the specified bus in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGSHUNTS IBUS
Python command syntax:
ierr = purgshunts(ibus)
Fortran command syntax:
CALL PURGSHUNTS(IBUS, IERR)
Where:
Integer IBUS bus from which all fixed shunts are to be removed (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
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
815
Power Flow PURGSWS
1.2.101. PURGSWS
Use this API to delete all switched shunts from the specified bus in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PURGSWS IBUS
Python command syntax:
ierr = purgsws(ibus)
Fortran command syntax:
CALL PURGSWS(IBUS, IERR)
Where:
Integer IBUS bus from which all switched shunts are to be removed (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no switched shunts at bus
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
816
Power Flow PURGSWSHUNT
1.2.102. PURGSWSHUNT
Use this API to delete the specified switched bus shunt from the working case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_PURGSWSHUNT IBUS 'ID'
Python command syntax:
ierr = purgswshunt(ibus, id)
Fortran command syntax:
CALL PURGSWSHUNT(IBUS, ID, IERR)
Where:
Integer IBUS bus to which the switched shunt is connected (input; no default al-
lowed).
Character*2 ID identifier of the switched shunt to be removed (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 no switched shunts at bus
IERR = 3 switched shunt not found
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
817
Power Flow PURGVSC
1.2.103. PURGVSC
Use this API to delete the specified VSC dc line from the working case.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_PURGVSC 'NAME'
Python command syntax:
ierr = purgvsc(name)
Fortran command syntax:
CALL PURGVSC(NAME, IERR)
Where:
Character*12 NAME name of the VSC dc line to be removed (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 dc line 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
818
Power Flow PURGZONE
1.2.104. PURGZONE
Use this API to delete zones with no equipment assigned to them from the working case.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_PURGZONE SID ALL
Python command syntax:
ierr = purgzone(sid, all)
Fortran command syntax:
CALL PURGZONE(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 delete only zones in zone subsystem SID with
no equipment assigned to them
ALL = 1 delete all zones with no equipment assigned
to them
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
819
Power Flow PURG_VOLTAGE_DROOP
1.2.105. PURG_VOLTAGE_DROOP
Use this API to delete an existing voltage droop control from the working case.
This API routine was first introduced in release 35.3.0.
Batch command syntax:
BAT_PURG_VOLTAGE_DROOP 'NAME'
Python command syntax:
ierr = purg_voltage_droop(name)
Fortran command syntax:
CALL PURG_VOLTAGE_DROOP(NAME, IERR)
Where:
character*40 NAME voltage droop control name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 voltage droop control 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
820
Power Flow RATINGSETTEXTDATA
1.2.106. RATINGSETTEXTDATA
Use this API to change the column and descriptions for a particular rating set used in reporting.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_RATINGSETTEXTDATA IRATE NAME DESCR
Python command syntax:
ierr = ratingsettextdata(irate, name, descr)
Fortran command syntax:
CALL RATINGSETTEXTDATA(IRATE, NAME, DESCR, IERR)
Where:
Integer IRATE rating set number (1 through 12) (input; no default allowed).
Character*6 NAME rating set column heading (input; blank by default).
Character*32 DESCR rating set description (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors
IERR = 1 invalid rating set number
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
821
Power Flow SHUNT_CHNG
1.2.107. SHUNT_CHNG
Use this API routine to modify the data of an existing fixed bus shunt in the working case (see PSSE Pro-
gram Operation Manual, Fixed Bus Shunt Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SHUNT_CHNG IBUS 'ID' INTGAR(1) REALAR(1) REALAR(2)
Python command syntax:
ierr = shunt_chng(ibus, id, intgar, realar)
Fortran command syntax:
CALL SHUNT_CHNG(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID shunt identifier (input; '1' by default).
Integer INTGAR (1) See the SHUNT_DATA API routine for details (input).
Real REALAR (2) See the SHUNT_DATA API routine for details (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 shunt identifier is more than two characters
IERR = 5 fixed bus shunt not found
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid shunt status
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
822
Power Flow SHUNT_DATA
1.2.108. SHUNT_DATA
Use this API to modify the data of an existing fixed bus shunt in the working case or to add a new fixed bus
shunt to the working case (see PSSE Program Operation Manual, Fixed Bus Shunt Data).
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_SHUNT_DATA IBUS 'ID' INTGAR(1) REALAR(1) REALAR(2)
Python command syntax:
ierr = shunt_data(ibus, id, intgar, realar)
Fortran command syntax:
CALL SHUNT_API(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID shunt identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) STATUS, shunt status (1 by default)
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) GL, fixed shunt admittance (conductance)
(0.0 by default)
REALAR(2) BL, fixed shunt admittance (susceptance)
(0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 shunt identifier is more than two characters
IERR = 3 blank shunt identifier is invalid
IERR = 4 fixed bus shunt table is full
IERR = 6 prerequisite requirements for API are not met
IERR = 7 node-breaker terminal connection table is full
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid shunt status
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
823
Power Flow SOLUTION_PARAMETERS
1.2.109. SOLUTION_PARAMETERS
This API routine is obsolete. It has been replaced by the API routine solution_parameters_2 .
Use this API to modify the power flow solution parameters in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SOLUTION_PARAMETERS INTGAR(1)..INTGAR(3) REALAR(1)..REALAR(16)
Python command syntax:
ierr = solution_parameters(intgar, realar)
Fortran command syntax:
CALL SOLUTION_PARAMETER_API(INTGAR, REALAR, IERR, NERR)
Where:
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) ITMX, Gauss-Seidel maximum number of it-
erations
INTGAR(2) ITMXN, Newton-Raphson maximum number
of iterations
INTGAR(3) ITMXTY, TYSL maximum number of iterations
Real REALAR (16) array of 16 elements specifying (input).
REALAR(1) ACCP, Gauss-Seidel real component accelera-
tion factor
REALAR(2) ACCQ, Gauss-Seidel imaginary component
acceleration factor
REALAR(3) ACCM, special MSLV acceleration factor
REALAR(4) TOL, Gauss-Seidel convergence tolerance
REALAR(5) ACCN, Newton-Raphson acceleration factor
REALAR(6) TOLN, Newton-Raphson mismatch conver-
gence tolerance
REALAR(7) ACCTY, TYSL acceleration factor
REALAR(8) TOLTY, TYSL convergence tolerance
REALAR(9) BLOWUP, blow-up threshold
REALAR(10) PQBRAK, constant power load characteristic
breakpoint
REALAR(11) THRSHZ, zero impedance line threshold
REALAR(12) ADJTHR, automatic adjustment threshold tol-
erance
REALAR(13) ACCTAP, tap movement deceleration factor
REALAR(14) TAPLIM, maximum tap change per adjust-
ment
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
824
Power Flow SOLUTION_PARAMETERS
REALAR(15) DVLIM, largest abs(delta v)/abs(v) for New-
ton solutions
REALAR(16) NDVFCT, non-divergent required improve-
ment factor
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = -1 warnings: - None
Integer NERR number of entries in PBUF02 containing error messages (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
825
Power Flow SOLUTION_PARAMETERS_2
1.2.110. SOLUTION_PARAMETERS_2
This API routine is obsolete. It has been replaced by the API routine solution_parameters_3 .
Use this API to modify the power flow solution parameters in the working case.
This API routine was first introduced in release 30.3.0.
Batch command syntax:
BAT_SOLUTION_PARAMETERS_2 INTGAR(1)..INTGAR(3) REALAR(1)..REALAR(18)
Python command syntax:
ierr = solution_parameters_2(intgar, realar)
Fortran command syntax:
CALL SOLUTION_PARAMETER_API_2(INTGAR, REALAR, IERR, NERR)
Where:
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) ITMX, Gauss-Seidel maximum number of it-
erations
INTGAR(2) ITMXN, Newton-Raphson maximum number
of iterations
INTGAR(3) ITMXTY, TYSL maximum number of iterations
Real REALAR (18) array of 18 elements specifying (input).
REALAR(1) ACCP, Gauss-Seidel real component accelera-
tion factor
REALAR(2) ACCQ, Gauss-Seidel imaginary component
acceleration factor
REALAR(3) ACCM, special MSLV acceleration factor
REALAR(4) TOL, Gauss-Seidel convergence tolerance
REALAR(5) ACCN, Newton-Raphson acceleration factor
REALAR(6) TOLN, Newton-Raphson mismatch conver-
gence tolerance
REALAR(7) ACCTY, TYSL acceleration factor
REALAR(8) TOLTY, TYSL convergence tolerance
REALAR(9) BLOWUP, blow-up threshold
REALAR(10) PQBRAK, constant power load characteristic
breakpoint
REALAR(11) THRSHZ, zero impedance line threshold
REALAR(12) ADJTHR, automatic adjustment threshold tol-
erance
REALAR(13) ACCTAP, tap movement deceleration factor
REALAR(14) TAPLIM, maximum tap change per adjust-
ment
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
826
Power Flow SOLUTION_PARAMETERS_2
REALAR(15) DVLIM, largest abs(delta v)/abs(v) for New-
ton solutions
REALAR(16) NDVFCT, non-divergent required improve-
ment factor
REALAR(17) VCTOLQ, Newton-Raphson voltage controlled
bus reactive power mismatch convergence
tolerance
REALAR(18) VCTOLV, Newton-Raphson voltage controlled
bus voltage error convergence tolerance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = -1 warnings: - None
Integer NERR number of entries in PBUF02 containing error messages (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
827
Power Flow SOLUTION_PARAMETERS_3
1.2.111. SOLUTION_PARAMETERS_3
This API routine is obsolete. It has been replaced by the API routine solution_parameters_4 .
Use this API to modify the power flow solution parameters in the working case (see PSSE Program Opera-
tion Manual, Sections 6.3.13, 6.3.18, 6.5.1 and 11.7).
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_SOLUTION_PARAMETERS_3 INTGAR(1)..INTGAR(3) REALAR(1)..REALAR(19)
Python command syntax:
ierr = solution_parameters_3(intgar, realar)
Fortran command syntax:
CALL SOLUTION_PARAMETER_API_3(INTGAR, REALAR, IERR)
Where:
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) ITMX, Gauss-Seidel maximum number of it-
erations (100 by default)
INTGAR(2) ITMXN, Newton-Raphson maximum number
of iterations (20 by default)
INTGAR(3) ITMXTY, TYSL maximum number of iterations
(20 by default)
Real REALAR (19) array of 19 elements specifying (input).
REALAR(1) ACCP, Gauss-Seidel real component accelera-
tion factor (1.6 by default)
REALAR(2) ACCQ, Gauss-Seidel imaginary component
acceleration factor (1.6 by default)
REALAR(3) ACCM, special MSLV acceleration factor (1.0
by default)
REALAR(4) TOL, Gauss-Seidel convergence tolerance
(0.0001 by default)
REALAR(5) ACCN, Newton-Raphson acceleration factor
(1.0 by default)
REALAR(6) TOLN, Newton-Raphson mismatch conver-
gence tolerance (default Newton power flow
solution tolerance option setting)
REALAR(7) ACCTY, TYSL acceleration factor (1.0 by de-
fault)
REALAR(8) TOLTY, TYSL convergence tolerance (0.00001
by default)
REALAR(9) BLOWUP, blow-up threshold (5.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
828
Power Flow SOLUTION_PARAMETERS_3
REALAR(10) PQBRAK, constant power load characteristic
breakpoint (0.7 by default)
REALAR(11) THRSHZ, zero impedance line threshold
(0.0001 by default)
REALAR(12) ADJTHR, automatic adjustment threshold tol-
erance (0.005 by default)
REALAR(13) ACCTAP, tap movement deceleration factor
(1.0 by default)
REALAR(14) TAPLIM, maximum tap change per adjust-
ment (0.05 by default)
REALAR(15) DVLIM, largest abs(delta v)/abs(v) for New-
ton solutions (0.99 by default)
REALAR(16) NDVFCT, non-divergent required improve-
ment factor (0.99 by default)
REALAR(17) VCTOLQ, Newton-Raphson voltage controlled
bus reactive power mismatch convergence
tolerance (default Newton power flow solu-
tion tolerance option setting)
REALAR(18) VCTOLV, Newton-Raphson voltage controlled
bus voltage error convergence tolerance
(0.00001 by default)
REALAR(19) SWVBND, percent of voltage controlling band
mode switched shunts to be adjusted per
power flow iteration (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid percent value
for switched shunt adjustment
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
829
Power Flow SOLUTION_PARAMETERS_4
1.2.112. SOLUTION_PARAMETERS_4
This API routine is obsolete. It has been replaced by the API routine solution_parameters_5 .
Use this API to modify the power flow solution parameters in the working case (see PSSE Program Opera-
tion Manual, Sections 6.3.13, 6.3.18, 6.5.1 and 11.7).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SOLUTION_PARAMETERS_4 INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(19)
Python command syntax:
ierr = solution_parameters_4(intgar, realar)
Fortran command syntax:
CALL SOLUTION_PARAMETER_API_4(INTGAR, REALAR, IERR)
Where:
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) ITMX, Gauss-Seidel maximum number of it-
erations (100 by default)
INTGAR(2) ITMXN, Newton-Raphson maximum number
of iterations (20 by default)
INTGAR(3) ITMXTY, TYSL maximum number of iterations
(20 by default)
INTGAR(4) MXTPSS, maximum number of times taps
and/or switched shunts are adjusted during
power flow solutions (100 by default)
INTGAR(5) MXSWIM, maximum number of times an
induction machine can change state (e.g.,
from "running" to "stalled") during power
flow solutions (10 by default)
Real REALAR (19) array of 19 elements specifying (input).
REALAR(1) ACCP, Gauss-Seidel real component accelera-
tion factor (1.6 by default)
REALAR(2) ACCQ, Gauss-Seidel imaginary component
acceleration factor (1.6 by default)
REALAR(3) ACCM, special MSLV acceleration factor (1.0
by default)
REALAR(4) TOL, Gauss-Seidel convergence tolerance
(0.0001 by default)
REALAR(5) ACCN, Newton-Raphson acceleration factor
(1.0 by default)
REALAR(6) TOLN, Newton-Raphson mismatch conver-
gence tolerance (default Newton power flow
solution tolerance option setting)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
830
Power Flow SOLUTION_PARAMETERS_4
REALAR(7) ACCTY, TYSL acceleration factor (1.0 by de-
fault)
REALAR(8) TOLTY, TYSL convergence tolerance (0.00001
by default)
REALAR(9) BLOWUP, blow-up threshold (5.0 by default)
REALAR(10) PQBRAK, constant power load characteristic
breakpoint (0.7 by default)
REALAR(11) THRSHZ, zero impedance line threshold
(0.0001 by default)
REALAR(12) ADJTHR, automatic adjustment threshold tol-
erance (0.005 by default)
REALAR(13) ACCTAP, tap movement deceleration factor
(1.0 by default)
REALAR(14) TAPLIM, maximum tap change per adjust-
ment (0.05 by default)
REALAR(15) DVLIM, largest abs(delta v)/abs(v) for New-
ton solutions (0.99 by default)
REALAR(16) NDVFCT, non-divergent required improve-
ment factor (0.99 by default)
REALAR(17) VCTOLQ, Newton-Raphson voltage controlled
bus reactive power mismatch convergence
tolerance (default Newton power flow solu-
tion tolerance option setting)
REALAR(18) VCTOLV, Newton-Raphson voltage controlled
bus voltage error convergence tolerance
(0.00001 by default)
REALAR(19) SWVBND, percent of voltage controlling band
mode switched shunts to be adjusted per
power flow iteration (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid percent val-
ue for switched shunt adjustment. - Invalid in-
duction motor treatment code
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
831
Power Flow SOLUTION_PARAMETERS_5
1.2.113. SOLUTION_PARAMETERS_5
Use this API to modify the power flow solution parameters in the working case (see PSSE Program Opera-
tion Manual, Sections 6.3.13, 6.3.18, 6.5.1 and 11.7).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_SOLUTION_PARAMETERS_5 INTGAR(1)..INTGAR(9) REALAR(1)..REALAR(21)
Python command syntax:
ierr = solution_parameters_5(intgar, realar)
Fortran command syntax:
CALL SOLUTION_PARAMETER_API_5(INTGAR, REALAR, IERR)
Where:
Integer INTGAR (9) array of 9 elements specifying (input).
INTGAR(1) ITMX, Gauss-Seidel maximum number of it-
erations (100 by default)
INTGAR(2) ITMXN, Newton-Raphson maximum number
of iterations (20 by default)
INTGAR(3) ITMXTY, TYSL maximum number of iterations
(20 by default)
INTGAR(4) MXTPSS, maximum number of times taps
and/or switched shunts are adjusted during
power flow solutions (100 by default)
INTGAR(5) MXSWIM, maximum number of times an
induction machine can change state (e.g.,
from "running" to "stalled") during power
flow solutions (10 by default)
INTGAR(6) MovIterMax, maximum number of MOV it-
erations in short circuit solutions (20 by de-
fault)
INTGAR(7) IsolLvl, Maximum number of levels to go out-
ward when isolating an element by breaker
actions (4 by default)
INTGAR(8) CaIterMax, Maximum number of repeat so-
lutions for each contingency case (20 by de-
fault)
INTGAR(9) CntChk, Check for duplicate contingency la-
bels (<=0 = no, >0 = yes) (0 by default)
Real REALAR (21) array of 21 elements specifying (input).
REALAR(1) ACCP, Gauss-Seidel real component accelera-
tion factor (1.6 by default)
REALAR(2) ACCQ, Gauss-Seidel imaginary component
acceleration factor (1.6 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
832
Power Flow SOLUTION_PARAMETERS_5
REALAR(3) ACCM, special MSLV acceleration factor (1.0
by default)
REALAR(4) TOL, Gauss-Seidel convergence tolerance
(0.0001 by default)
REALAR(5) ACCN, Newton-Raphson acceleration factor
(1.0 by default)
REALAR(6) TOLN, Newton-Raphson mismatch conver-
gence tolerance (default Newton power flow
solution tolerance option setting)
REALAR(7) ACCTY, TYSL acceleration factor (1.0 by de-
fault)
REALAR(8) TOLTY, TYSL convergence tolerance (0.00001
by default)
REALAR(9) BLOWUP, blow-up threshold (5.0 by default)
REALAR(10) PQBRAK, constant power load characteristic
breakpoint (0.7 by default)
REALAR(11) THRSHZ, zero impedance line threshold
(0.0001 by default)
REALAR(12) ADJTHR, automatic adjustment threshold tol-
erance (0.005 by default)
REALAR(13) ACCTAP, tap movement deceleration factor
(1.0 by default)
REALAR(14) TAPLIM, maximum tap change per adjust-
ment (0.05 by default)
REALAR(15) DVLIM, largest abs(delta v)/abs(v) for New-
ton solutions (0.99 by default)
REALAR(16) NDVFCT, non-divergent required improve-
ment factor (0.99 by default)
REALAR(17) VCTOLQ, Newton-Raphson voltage controlled
bus reactive power mismatch convergence
tolerance (default Newton power flow solu-
tion tolerance option setting)
REALAR(18) VCTOLV, Newton-Raphson voltage controlled
bus voltage error convergence tolerance
(0.00001 by default)
REALAR(19) SWVBND, percent of voltage controlling band
mode switched shunts to be adjusted per
power flow iteration (100.0 by default)
REALAR(20) MovTolerance, MOV iteration tolerance in
short circuit solutions (0.01 by default)
REALAR(21) MovAlpha, MOV acceleration factor in short
circuit solutions (0.3 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal 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
833
Power Flow SOLUTION_PARAMETERS_5
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid percent val-
ue for switched shunt adjustment. - Invalid in-
duction motor treatment code
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
834
Power Flow SWITCHED_SHUNT_CHNG_3
1.2.114. SWITCHED_SHUNT_CHNG_3
This API routine is obsolete. It has been replaced by the API routine switched_shunt_chng_4 .
Use this API routine to modify the data of an existing switched shunt in the working case (see PSSE Pro-
gram Operation Manual, Switched Shunt Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_CHNG_3 IBUS INTGAR(1)..INTGAR(12)
REALAR(1)..REALAR(12) 'RMIDNT'
Python command syntax:
ierr = switched_shunt_chng_3(ibus, intgar, realar, rmidnt)
Fortran command syntax:
CALL SWITCHED_SHUNT_CHNG_3(IBUS, INTGAR, REALAR, RMIDNT, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (12) array of 12 elements specifying (input).
INTGAR(1) N1, number of steps for block 1 (0 by de-
fault)
INTGAR(2) N2, number of steps for block 2 (0 by de-
fault)
INTGAR(3) N3, number of steps for block 3 (0 by de-
fault)
INTGAR(4) N4, number of steps for block 4 (0 by de-
fault)
INTGAR(5) N5, number of steps for block 5 (0 by de-
fault)
INTGAR(6) N6, number of steps for block 6 (0 by de-
fault)
INTGAR(7) N7, number of steps for block 7 (0 by de-
fault)
INTGAR(8) N8, number of steps for block 8 (0 by de-
fault)
INTGAR(9) MODSW, control mode (1 by default)
INTGAR(10) SWREM, remote bus number (0 by default)
INTGAR(11) STAT, status (1 by default)
INTGAR(12) ADJM, adjustment method (0 by default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) B1, admittance increment per step for block
1 (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
835
Power Flow SWITCHED_SHUNT_CHNG_3
REALAR(2) B2, admittance increment per step for block
2 (0.0 by default)
REALAR(3) B3, admittance increment per step for block
3 (0.0 by default)
REALAR(4) B4, admittance increment per step for block
4 (0.0 by default)
REALAR(5) B5, admittance increment per step for block
5 (0.0 by default)
REALAR(6) B6, admittance increment per step for block
6 (0.0 by default)
REALAR(7) B7, admittance increment per step for block
7 (0.0 by default)
REALAR(8) B8, admittance increment per step for block
8 (0.0 by default)
REALAR(9) VSWHI, desired voltage upper limit (1.0 by
default)
REALAR(10) VSWLO, desired voltage lower limit (1.0 by
default)
REALAR(11) BINIT, present switched shunt admittance
(0.0 by default)
REALAR(12) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Character*12 RMIDNT VSC dc line name (MODSW =4) or FACTS device name (MODSW = 6)
(input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 3 switched shunt not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - invalid switched
shunt control mode - control mode is 4 and
a blank VSC dc line name is specified - VSC
dc line not found - control mode is 6 and a
blank FACTS device name is specified - FAC-
TS device not found - non-blank device name
specified with control mode 0, 1, 2, 3 or 5 -
regulated bus not found - voltage controlling
switched shunt specified as remotely regulat-
ing itself - type code of regulated bus is not
1 or 2 - VHIGH is less than VLOW for voltage
controlling switched shunt - no regulated bus
specified for plant, VSC converter, or switched
shunt control - control mode is 3 and the reg-
ulated bus has no generation - control mode
is 4 and the regulated bus is not a convert-
er of the specified VSC dc line - control mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
836
Power Flow SWITCHED_SHUNT_CHNG_3
is 5 and the regulated bus has no switched
shunt - regulated bus is not the sending end
bus of the specified FACTS device - VLOW is
not less than VHIGH for plant, VSC convert-
er, switched shunt, or FACTS device control -
VHIGH is greater than 1.0 for plant, VSC con-
verter, switched shunt, or FACTS device con-
trol - VLOW is less than 0.0 for plant, VSC con-
verter, switched shunt, or FACTS device con-
trol - RMPCT is not positive - block has N or B
zero and the other non-zero - invalid number
of steps in block - block with non-zero N is be-
yond a previous N=0 block - block 1 has no
steps. - Reactor block is out of sequence. - Ini-
tial admittance is below minimum. - Initial ad-
mittance is above maximum. - Initial admit-
tance is not on a step. - Block has admittances
with different signs in positive and zero se-
quences. - Invalid switched shunt status. - In-
valid switched shunt adjustment method
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
837
Power Flow SWITCHED_SHUNT_CHNG_4
1.2.115. SWITCHED_SHUNT_CHNG_4
This API routine is obsolete. It has been replaced by the API routine switched_shunt_chng_5 .
Use this API routine to modify the data of an existing switched shunt in the working case (see PSSE Pro-
gram Operation Manual, Switched Shunt Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_CHNG_4 IBUS INTGAR(1)..INTGAR(13)
REALAR(1)..REALAR(12) 'RMIDNT'
Python command syntax:
ierr = switched_shunt_chng_4(ibus, intgar, realar, rmidnt)
Fortran command syntax:
CALL SWITCHED_SHUNT_CHNG_4(IBUS, INTGAR, REALAR, RMIDNT, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (13) array of 13 elements specifying (input).
INTGAR(1) N1, number of steps for block 1 (0 by de-
fault)
INTGAR(2) N2, number of steps for block 2 (0 by de-
fault)
INTGAR(3) N3, number of steps for block 3 (0 by de-
fault)
INTGAR(4) N4, number of steps for block 4 (0 by de-
fault)
INTGAR(5) N5, number of steps for block 5 (0 by de-
fault)
INTGAR(6) N6, number of steps for block 6 (0 by de-
fault)
INTGAR(7) N7, number of steps for block 7 (0 by de-
fault)
INTGAR(8) N8, number of steps for block 8 (0 by de-
fault)
INTGAR(9) MODSW, control mode (1 by default)
INTGAR(10) SWREM, regulated bus number (0 by default)
INTGAR(11) NODE, regulated node number (0 by default)
INTGAR(12) STAT, status (1 by default)
INTGAR(13) ADJM, adjustment method (0 by default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) B1, admittance increment per step for block
1 (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
838
Power Flow SWITCHED_SHUNT_CHNG_4
REALAR(2) B2, admittance increment per step for block
2 (0.0 by default)
REALAR(3) B3, admittance increment per step for block
3 (0.0 by default)
REALAR(4) B4, admittance increment per step for block
4 (0.0 by default)
REALAR(5) B5, admittance increment per step for block
5 (0.0 by default)
REALAR(6) B6, admittance increment per step for block
6 (0.0 by default)
REALAR(7) B7, admittance increment per step for block
7 (0.0 by default)
REALAR(8) B8, admittance increment per step for block
8 (0.0 by default)
REALAR(9) VSWHI, desired voltage upper limit (1.0 by
default)
REALAR(10) VSWLO, desired voltage lower limit (1.0 by
default)
REALAR(11) BINIT, present switched shunt admittance
(0.0 by default)
REALAR(12) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Character*12 RMIDNT VSC dc line name (MODSW =4) or FACTS device name (MODSW = 6)
(input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 3 switched shunt not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid switched
shunt control mode - Control mode is 4 and
a blank VSC dc line name is specified - VSC
dc line not found - Control mode is 6 and a
blank FACTS device name is specified - FAC-
TS device not found - Non-blank device name
specified with control mode 0, 1, 2, 3 or 5 -
Regulated bus not found - Type code of reg-
ulated bus is not 1 or 2 - VHIGH is less than
VLOW for voltage controlling switched shunt
- No regulated bus specified for plant, VSC
converter, or switched shunt control - Control
mode is 3 and the regulated bus has no gen-
eration - Control mode is 4 and the regulat-
ed bus is not a converter of the specified VSC
dc line - Control mode is 5 and the regulated
bus has no switched shunt - Regulated bus is
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
839
Power Flow SWITCHED_SHUNT_CHNG_4
not the sending end bus of the specified FAC-
TS device - VLOW is not less than VHIGH for
plant, VSC converter, switched shunt, or FAC-
TS device control - VHIGH is greater than 1.0
for plant, VSC converter, switched shunt, or
FACTS device control - VLOW is less than 0.0
for plant, VSC converter, switched shunt, or
FACTS device control - RMPCT is not positive -
Block has N or B zero and the other non-zero
- Invalid number of steps in block - Block with
non-zero N is beyond a previous N=0 block -
Block 1 has no steps. - Reactor block is out of
sequence. - Initial admittance is below mini-
mum. - Initial admittance is above maximum.
- Initial admittance is not on a step. - Block
has admittances with different signs in pos-
itive and zero sequences. - Invalid switched
shunt status. - Invalid switched shunt adjust-
ment method - Invalid node number - Non-
zero regulated node specified but regulated
bus does not belong to a substation - Regu-
lated node not found - Regulated node is not
connected to any bus section of the regulated
bus - Regulated bus is 0 but a non-zero regu-
lated node is specified - A remote regulated
bus is specified for a type 3 bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
840
Power Flow SWITCHED_SHUNT_CHNG_5
1.2.116. SWITCHED_SHUNT_CHNG_5
Use this API routine to modify the data of an existing switched shunt in the working case (see PSSE Pro-
gram Operation Manual, Switched Shunt Data).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_CHNG_5 IBUS 'ID' INTGAR(1)..INTGAR(21)
REALAR(1)..REALAR(12) 'RMIDNT'
Python command syntax:
ierr = switched_shunt_chng_5(ibus, id, intgar, realar, rmidnt)
Fortran command syntax:
CALL SWITCHED_SHUNT_CHNG_5(IBUS, ID, INTGAR, REALAR, RMIDNT, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
character*2 ID Switched shunt identifier (input; '1' by default).
Integer INTGAR (21) array of 21 elements specifying (input).
INTGAR(1) N1, number of steps for block 1 (0 by de-
fault)
INTGAR(2) N2, number of steps for block 2 (0 by de-
fault)
INTGAR(3) N3, number of steps for block 3 (0 by de-
fault)
INTGAR(4) N4, number of steps for block 4 (0 by de-
fault)
INTGAR(5) N5, number of steps for block 5 (0 by de-
fault)
INTGAR(6) N6, number of steps for block 6 (0 by de-
fault)
INTGAR(7) N7, number of steps for block 7 (0 by de-
fault)
INTGAR(8) N8, number of steps for block 8 (0 by de-
fault)
INTGAR(9) MODSW, control mode (1 by default)
INTGAR(10) SWREM, regulated bus number (0 by default)
INTGAR(11) NODE, regulated node number (0 by default)
INTGAR(12) STAT, status (1 by default)
INTGAR(13) ADJM, adjustment method (0 by default)
INTGAR(14) ST1, status of block 1 (1 by default)
INTGAR(15) ST2, status of block 2 (1 by default)
INTGAR(16) ST3, status of block 3 (1 by default)
INTGAR(17) ST4, status of block 4 (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
841
Power Flow SWITCHED_SHUNT_CHNG_5
INTGAR(18) ST5, status of block 5 (1 by default)
INTGAR(19) ST6, status of block 6 (1 by default)
INTGAR(20) ST7, status of block 7 (1 by default)
INTGAR(21) ST8, status of block 8 (1 by default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) B1, admittance increment per step for block
1 (0.0 by default)
REALAR(2) B2, admittance increment per step for block
2 (0.0 by default)
REALAR(3) B3, admittance increment per step for block
3 (0.0 by default)
REALAR(4) B4, admittance increment per step for block
4 (0.0 by default)
REALAR(5) B5, admittance increment per step for block
5 (0.0 by default)
REALAR(6) B6, admittance increment per step for block
6 (0.0 by default)
REALAR(7) B7, admittance increment per step for block
7 (0.0 by default)
REALAR(8) B8, admittance increment per step for block
8 (0.0 by default)
REALAR(9) VSWHI, desired voltage upper limit (1.0 by
default)
REALAR(10) VSWLO, desired voltage lower limit (1.0 by
default)
REALAR(11) BINIT, present switched shunt admittance
(0.0 by default)
REALAR(12) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Character*12 RMIDNT VSC dc line name (MODSW =4) or FACTS device name (MODSW = 6)
(input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 3 identifier is more than two characters
IERR = 5 switched shunt not found
IERR = 6 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid switched
shunt control mode - Control mode is 4 and
a blank VSC dc line name is specified - VSC
dc line not found - Control mode is 6 and a
blank FACTS device name is specified - FAC-
TS device not found - Non-blank device name
specified with control mode 0, 1, 2, 3 or 5 -
Regulated bus not found - Type code of reg-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
842
Power Flow SWITCHED_SHUNT_CHNG_5
ulated bus is not 1 or 2 - VHIGH is less than
VLOW for voltage controlling switched shunt
- No regulated bus specified for plant, VSC
converter, or switched shunt control - Control
mode is 3 and the regulated bus has no gen-
eration - Control mode is 4 and the regulat-
ed bus is not a converter of the specified VSC
dc line - Control mode is 5 and the regulated
bus has no switched shunt - Regulated bus is
not the sending end bus of the specified FAC-
TS device - VLOW is not less than VHIGH for
plant, VSC converter, switched shunt, or FAC-
TS device control - VHIGH is greater than 1.0
for plant, VSC converter, switched shunt, or
FACTS device control - VLOW is less than 0.0
for plant, VSC converter, switched shunt, or
FACTS device control - RMPCT is not positive -
Block has N or B zero and the other non-zero
- Invalid number of steps in block - Block with
non-zero N is beyond a previous N=0 block -
Block 1 has no steps. - Reactor block is out of
sequence. - Initial admittance is below mini-
mum. - Initial admittance is above maximum.
- Initial admittance is not on a step. - Block
has admittances with different signs in pos-
itive and zero sequences. - Invalid switched
shunt status. - Invalid switched shunt adjust-
ment method - Invalid node number - Non-
zero regulated node specified but regulated
bus does not belong to a substation - Regu-
lated node not found - Regulated node is not
connected to any bus section of the regulated
bus - Regulated bus is 0 but a non-zero regu-
lated node is specified - A remote regulated
bus is specified for a type 3 bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
843
Power Flow SWITCHED_SHUNT_DATA
1.2.117. SWITCHED_SHUNT_DATA
This API routine is obsolete. It has been replaced by the API routine switched_shunt_data_3 .
Use this API to modify the data of an existing switched shunt in the working case or to add a new switched
shunt to the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_DATA IBUS INTGAR(1)..INTGAR(10)
REALAR(1)..REALAR(12) 'RMIDNT'
Python command syntax:
ierr = switched_shunt_data(ibus, intgar, realar, rmidnt)
Fortran command syntax:
CALL SWITCHED_SHUNT_API_2(IBUS, INTGAR, REALAR, RMIDNT, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (10) array of 10 elements specifying (input).
INTGAR(1) N1, number of steps for block 1 (0 by de-
fault)
INTGAR(2) N2, number of steps for block 2 (0 by de-
fault)
INTGAR(3) N3, number of steps for block 3 (0 by de-
fault)
INTGAR(4) N4, number of steps for block 4 (0 by de-
fault)
INTGAR(5) N5, number of steps for block 5 (0 by de-
fault)
INTGAR(6) N6, number of steps for block 6 (0 by de-
fault)
INTGAR(7) N7, number of steps for block 7 (0 by de-
fault)
INTGAR(8) N8, number of steps for block 8 (0 by de-
fault)
INTGAR(9) MODSW, control mode (1 by default)
INTGAR(10) SWREM, remote bus number (0 by default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) B1, admittance increment per step for block
1 (0.0 by default)
REALAR(2) B2, admittance increment per step for block
2 (0.0 by default)
REALAR(3) B3, admittance increment per step for block
3 (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
844
Power Flow SWITCHED_SHUNT_DATA
REALAR(4) B4, admittance increment per step for block
4 (0.0 by default)
REALAR(5) B5, admittance increment per step for block
5 (0.0 by default)
REALAR(6) B6, admittance increment per step for block
6 (0.0 by default)
REALAR(7) B7, admittance increment per step for block
7 (0.0 by default)
REALAR(8) B8, admittance increment per step for block
8 (0.0 by default)
REALAR(9) VSWHI, desired voltage upper limit (1.0 by
default)
REALAR(10) VSWLO, desired voltage lower limit (1.0 by
default)
REALAR(11) BINIT, present switched shunt admittance
(0.0 by default)
REALAR(12) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Character*12 RMIDNT VSC dc line name (MODSW =4) or FACTS device name (MODSW = 6)
(input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 switched shunt table is full
IERR = 4 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - invalid switched
shunt control mode - control mode is 4 and
a blank VSC dc line name is specified - VSC
dc line not found - control mode is 6 and a
blank FACTS device name is specified - FAC-
TS device not found - non-blank device name
specified with control mode 0, 1, 2, 3 or 5 -
regulated bus not found - voltage controlling
switched shunt specified as remotely regulat-
ing itself - type code of regulated bus is not
1 or 2 - VHIGH is less than VLOW for voltage
controlling switched shunt - no regulated bus
specified for plant, VSC converter, or switched
shunt control - control mode is 3 and the reg-
ulated bus has no generation - control mode
is 4 and the regulated bus is not a convert-
er of the specified VSC dc line - control mode
is 5 and the regulated bus has no switched
shunt - regulated bus is not the sending end
bus of the specified FACTS device - VLOW is
not less than VHIGH for plant, VSC convert-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
845
Power Flow SWITCHED_SHUNT_DATA
er, switched shunt, or FACTS device control -
VHIGH is greater than 1.0 for plant, VSC con-
verter, switched shunt, or FACTS device con-
trol - VLOW is less than 0.0 for plant, VSC con-
verter, switched shunt, or FACTS device con-
trol - - RMPCT is not positive - block has N or
B zero and the other non-zero - invalid num-
ber of steps in block - block with non-zero N
is beyond a previous N=0 block - block 1 has
no steps. - Reactor block is out of sequence. -
Initial admittance is below minimum. - Initial
admittance is above maximum. - Initial admit-
tance is not on a step. - Block has admittances
with different signs in positive and zero se-
quences
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
846
Power Flow SWITCHED_SHUNT_DATA_3
1.2.118. SWITCHED_SHUNT_DATA_3
This API routine is obsolete. It has been replaced by the API routine switched_shunt_data_4 .
Use this API to modify the data of an existing switched shunt in the working case or to add a new switched
shunt to the working case (see PSSE Program Operation Manual, Switched Shunt Data).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_DATA_3 IBUS INTGAR(1)..INTGAR(12)
REALAR(1)..REALAR(12) 'RMIDNT'
Python command syntax:
ierr = switched_shunt_data_3(ibus, intgar, realar, rmidnt)
Fortran command syntax:
CALL SWITCHED_SHUNT_API_3(IBUS, INTGAR, REALAR, RMIDNT, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (12) array of 12 elements specifying (input).
INTGAR(1) N1, number of steps for block 1 (0 by de-
fault)
INTGAR(2) N2, number of steps for block 2 (0 by de-
fault)
INTGAR(3) N3, number of steps for block 3 (0 by de-
fault)
INTGAR(4) N4, number of steps for block 4 (0 by de-
fault)
INTGAR(5) N5, number of steps for block 5 (0 by de-
fault)
INTGAR(6) N6, number of steps for block 6 (0 by de-
fault)
INTGAR(7) N7, number of steps for block 7 (0 by de-
fault)
INTGAR(8) N8, number of steps for block 8 (0 by de-
fault)
INTGAR(9) MODSW, control mode (1 by default)
INTGAR(10) SWREM, remote bus number (0 by default)
INTGAR(11) STAT, status (1 by default)
INTGAR(12) ADJM, adjustment method (0 by default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) B1, admittance increment per step for block
1 (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
847
Power Flow SWITCHED_SHUNT_DATA_3
REALAR(2) B2, admittance increment per step for block
2 (0.0 by default)
REALAR(3) B3, admittance increment per step for block
3 (0.0 by default)
REALAR(4) B4, admittance increment per step for block
4 (0.0 by default)
REALAR(5) B5, admittance increment per step for block
5 (0.0 by default)
REALAR(6) B6, admittance increment per step for block
6 (0.0 by default)
REALAR(7) B7, admittance increment per step for block
7 (0.0 by default)
REALAR(8) B8, admittance increment per step for block
8 (0.0 by default)
REALAR(9) VSWHI, desired voltage upper limit (1.0 by
default)
REALAR(10) VSWLO, desired voltage lower limit (1.0 by
default)
REALAR(11) BINIT, present switched shunt admittance
(0.0 by default)
REALAR(12) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Character*12 RMIDNT VSC dc line name (MODSW =4) or FACTS device name (MODSW = 6)
(input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 switched shunt table is full
IERR = 4 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - invalid switched
shunt control mode - control mode is 4 and
a blank VSC dc line name is specified - VSC
dc line not found - control mode is 6 and a
blank FACTS device name is specified - FAC-
TS device not found - non-blank device name
specified with control mode 0, 1, 2, 3 or 5 -
regulated bus not found - voltage controlling
switched shunt specified as remotely regulat-
ing itself - type code of regulated bus is not
1 or 2 - VHIGH is less than VLOW for voltage
controlling switched shunt - no regulated bus
specified for plant, VSC converter, or switched
shunt control - control mode is 3 and the reg-
ulated bus has no generation - control mode
is 4 and the regulated bus is not a convert-
er of the specified VSC dc line - control mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
848
Power Flow SWITCHED_SHUNT_DATA_3
is 5 and the regulated bus has no switched
shunt - regulated bus is not the sending end
bus of the specified FACTS device - VLOW is
not less than VHIGH for plant, VSC convert-
er, switched shunt, or FACTS device control -
VHIGH is greater than 1.0 for plant, VSC con-
verter, switched shunt, or FACTS device con-
trol - VLOW is less than 0.0 for plant, VSC con-
verter, switched shunt, or FACTS device con-
trol - RMPCT is not positive - block has N or B
zero and the other non-zero - invalid number
of steps in block - block with non-zero N is be-
yond a previous N=0 block - block 1 has no
steps. - Reactor block is out of sequence. - Ini-
tial admittance is below minimum. - Initial ad-
mittance is above maximum. - Initial admit-
tance is not on a step. - Block has admittances
with different signs in positive and zero se-
quences. - Invalid switched shunt status. - In-
valid switched shunt adjustment method
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
849
Power Flow SWITCHED_SHUNT_DATA_4
1.2.119. SWITCHED_SHUNT_DATA_4
This API routine is obsolete. It has been replaced by the API routine switched_shunt_data_5 .
Use this API to modify the data of an existing switched shunt in the working case or to add a new switched
shunt to the working case (see PSSE Program Operation Manual, Switched Shunt Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_DATA_4 IBUS INTGAR(1)..INTGAR(13)
REALAR(1)..REALAR(12) 'RMIDNT'
Python command syntax:
ierr = switched_shunt_data_4(ibus, intgar, realar, rmidnt)
Fortran command syntax:
CALL SWITCHED_SHUNT_API_4(IBUS, INTGAR, REALAR, RMIDNT, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INTGAR (13) array of 13 elements specifying (input).
INTGAR(1) N1, number of steps for block 1 (0 by de-
fault)
INTGAR(2) N2, number of steps for block 2 (0 by de-
fault)
INTGAR(3) N3, number of steps for block 3 (0 by de-
fault)
INTGAR(4) N4, number of steps for block 4 (0 by de-
fault)
INTGAR(5) N5, number of steps for block 5 (0 by de-
fault)
INTGAR(6) N6, number of steps for block 6 (0 by de-
fault)
INTGAR(7) N7, number of steps for block 7 (0 by de-
fault)
INTGAR(8) N8, number of steps for block 8 (0 by de-
fault)
INTGAR(9) MODSW, control mode (1 by default)
INTGAR(10) SWREM, regulated bus number (0 by default)
INTGAR(11) NODE, regulated node number (0 by default)
INTGAR(12) STAT, status (1 by default)
INTGAR(13) ADJM, adjustment method (0 by default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) B1, admittance increment per step for block
1 (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
850
Power Flow SWITCHED_SHUNT_DATA_4
REALAR(2) B2, admittance increment per step for block
2 (0.0 by default)
REALAR(3) B3, admittance increment per step for block
3 (0.0 by default)
REALAR(4) B4, admittance increment per step for block
4 (0.0 by default)
REALAR(5) B5, admittance increment per step for block
5 (0.0 by default)
REALAR(6) B6, admittance increment per step for block
6 (0.0 by default)
REALAR(7) B7, admittance increment per step for block
7 (0.0 by default)
REALAR(8) B8, admittance increment per step for block
8 (0.0 by default)
REALAR(9) VSWHI, desired voltage upper limit (1.0 by
default)
REALAR(10) VSWLO, desired voltage lower limit (1.0 by
default)
REALAR(11) BINIT, present switched shunt admittance
(0.0 by default)
REALAR(12) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Character*12 RMIDNT VSC dc line name (MODSW =4) or FACTS device name (MODSW = 6)
(input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 switched shunt table is full
IERR = 4 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid switched
shunt control mode - Control mode is 4 and
a blank VSC dc line name is specified - VSC
dc line not found - Control mode is 6 and a
blank FACTS device name is specified - FAC-
TS device not found - Non-blank device name
specified with control mode 0, 1, 2, 3 or 5 -
Regulated bus not found - Type code of reg-
ulated bus is not 1 or 2 - VHIGH is less than
VLOW for voltage controlling switched shunt
- No regulated bus specified for plant, VSC
converter, or switched shunt control - Control
mode is 3 and the regulated bus has no gen-
eration - Control mode is 4 and the regulat-
ed bus is not a converter of the specified VSC
dc line - Control mode is 5 and the regulated
bus has no switched shunt - Regulated bus is
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
851
Power Flow SWITCHED_SHUNT_DATA_4
not the sending end bus of the specified FAC-
TS device - VLOW is not less than VHIGH for
plant, VSC converter, switched shunt, or FAC-
TS device control - VHIGH is greater than 1.0
for plant, VSC converter, switched shunt, or
FACTS device control - VLOW is less than 0.0
for plant, VSC converter, switched shunt, or
FACTS device control - RMPCT is not positive -
Block has N or B zero and the other non-zero
- Invalid number of steps in block - Block with
non-zero N is beyond a previous N=0 block -
Block 1 has no steps. - Reactor block is out of
sequence. - Initial admittance is below mini-
mum. - Initial admittance is above maximum.
- Initial admittance is not on a step. - Block
has admittances with different signs in pos-
itive and zero sequences. - Invalid switched
shunt status. - Invalid switched shunt adjust-
ment method - Invalid node number - Non-
zero regulated node specified but regulated
bus does not belong to a substation - Regu-
lated node not found - Regulated node is not
connected to any bus section of the regulated
bus - Regulated bus is 0 but a non-zero regu-
lated node is specified - A remote regulated
bus is specified for a type 3 bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
852
Power Flow SWITCHED_SHUNT_DATA_5
1.2.120. SWITCHED_SHUNT_DATA_5
Use this API to modify the data of an existing switched shunt in the working case or to add a new switched
shunt to the working case (see PSSE Program Operation Manual, Switched Shunt Data).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_SWITCHED_SHUNT_DATA_5 IBUS 'ID' INTGAR(1)..INTGAR(21)
REALAR(1)..REALAR(12) 'RMIDNT'
Python command syntax:
ierr = switched_shunt_data_5(ibus, id, intgar, realar, rmidnt)
Fortran command syntax:
CALL SWITCHED_SHUNT_API_5(IBUS, ID, INTGAR, REALAR, RMIDNT, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
character*2 ID Switched shunt identifier (input; '1' by default).
Integer INTGAR (21) array of 21 elements specifying (input).
INTGAR(1) N1, number of steps for block 1 (0 by de-
fault)
INTGAR(2) N2, number of steps for block 2 (0 by de-
fault)
INTGAR(3) N3, number of steps for block 3 (0 by de-
fault)
INTGAR(4) N4, number of steps for block 4 (0 by de-
fault)
INTGAR(5) N5, number of steps for block 5 (0 by de-
fault)
INTGAR(6) N6, number of steps for block 6 (0 by de-
fault)
INTGAR(7) N7, number of steps for block 7 (0 by de-
fault)
INTGAR(8) N8, number of steps for block 8 (0 by de-
fault)
INTGAR(9) MODSW, control mode (1 by default)
INTGAR(10) SWREM, regulated bus number (0 by default)
INTGAR(11) NODE, regulated node number (0 by default)
INTGAR(12) STAT, status (1 by default)
INTGAR(13) ADJM, adjustment method (0 by default)
INTGAR(14) ST1, status of block 1 (1 by default)
INTGAR(15) ST2, status of block 2 (1 by default)
INTGAR(16) ST3, status of block 3 (1 by default)
INTGAR(17) ST4, status of block 4 (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
853
Power Flow SWITCHED_SHUNT_DATA_5
INTGAR(18) ST5, status of block 5 (1 by default)
INTGAR(19) ST6, status of block 6 (1 by default)
INTGAR(20) ST7, status of block 7 (1 by default)
INTGAR(21) ST8, status of block 8 (1 by default)
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) B1, admittance increment per step for block
1 (0.0 by default)
REALAR(2) B2, admittance increment per step for block
2 (0.0 by default)
REALAR(3) B3, admittance increment per step for block
3 (0.0 by default)
REALAR(4) B4, admittance increment per step for block
4 (0.0 by default)
REALAR(5) B5, admittance increment per step for block
5 (0.0 by default)
REALAR(6) B6, admittance increment per step for block
6 (0.0 by default)
REALAR(7) B7, admittance increment per step for block
7 (0.0 by default)
REALAR(8) B8, admittance increment per step for block
8 (0.0 by default)
REALAR(9) VSWHI, desired voltage upper limit (1.0 by
default)
REALAR(10) VSWLO, desired voltage lower limit (1.0 by
default)
REALAR(11) BINIT, present switched shunt admittance
(0.0 by default)
REALAR(12) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Character*12 RMIDNT VSC dc line name (MODSW =4) or FACTS device name (MODSW = 6)
(input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 switched shunt table is full
IERR = 3 identifier is more than two characters
IERR = 4 blank shunt identifier is invalid
IERR = 6 prerequisite requirements for API are not met
IERR = 7 node-breaker terminal connection table is full
IERR = -1 warnings - one or more of: - Invalid switched
shunt control mode - Control mode is 4 and
a blank VSC dc line name is specified - VSC
dc line not found - Control mode is 6 and a
blank FACTS device name is specified - FAC-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
854
Power Flow SWITCHED_SHUNT_DATA_5
TS device not found - Non-blank device name
specified with control mode 0, 1, 2, 3 or 5 -
Regulated bus not found - Type code of reg-
ulated bus is not 1 or 2 - VHIGH is less than
VLOW for voltage controlling switched shunt
- No regulated bus specified for plant, VSC
converter, or switched shunt control - Control
mode is 3 and the regulated bus has no gen-
eration - Control mode is 4 and the regulat-
ed bus is not a converter of the specified VSC
dc line - Control mode is 5 and the regulated
bus has no switched shunt - Regulated bus is
not the sending end bus of the specified FAC-
TS device - VLOW is not less than VHIGH for
plant, VSC converter, switched shunt, or FAC-
TS device control - VHIGH is greater than 1.0
for plant, VSC converter, switched shunt, or
FACTS device control - VLOW is less than 0.0
for plant, VSC converter, switched shunt, or
FACTS device control - RMPCT is not positive -
Block has N or B zero and the other non-zero
- Invalid number of steps in block - Block with
non-zero N is beyond a previous N=0 block -
Block 1 has no steps. - Reactor block is out of
sequence. - Initial admittance is below mini-
mum. - Initial admittance is above maximum.
- Initial admittance is not on a step. - Block
has admittances with different signs in pos-
itive and zero sequences. - Invalid switched
shunt status. - Invalid switched shunt adjust-
ment method - Invalid node number - Non-
zero regulated node specified but regulated
bus does not belong to a substation - Regu-
lated node not found - Regulated node is not
connected to any bus section of the regulated
bus - Regulated bus is 0 but a non-zero regu-
lated node is specified - A remote regulated
bus is specified for a type 3 bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
855
Power Flow THREE_WINDING_DATA
1.2.121. THREE_WINDING_DATA
This API routine is obsolete. It has been replaced by the API routines three_wnd_impedance_data and
three_wnd_winding_data .
Use this API to modify the data of an existing three-winding transformer in the working case or to add a
new three-winding transformer to the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_THREE_WINDING_DATA IBUS JBUS KBUS 'CKT' INTGAR(1)..INTGAR(17)
REALAR(1)..REALAR(41) 'NAME'
Python command syntax:
ierr, realaro = three_winding_data(ibus, jbus, kbus, ckt, intgar, realari,
name)
Fortran command syntax:
CALL THREE_WINDING_API(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR, NAME, IERR,
NERR)
Where:
Integer IBUS bus number of one of the buses (input).
Integer JBUS bus number one of the other buses (input).
Integer KBUS bus number of the third bus (input).
Character*2 CKT transformer circuit identifier (input).
Integer INTGAR (17) array of 17 elements specifying (input).
INTGAR(1) O1, first owner number
INTGAR(2) O2, second owner number
INTGAR(3) O3, third owner number
INTGAR(4) O4, fourth owner number
INTGAR(5) NTP1, number of tap positions
INTGAR(6) TAB1, impedance correction table number
INTGAR(7) CONT1, controlled bus number
INTGAR(8) SICOD1, negative for controlled bus on wind-
ing one side
INTGAR(9) COD1, adjustment control mode flag (-3
through +3)
INTGAR(10) CW, winding data I/O code
INTGAR(11) CZ, impedance data I/O code
INTGAR(12) CM, magnetizing admittance data I/O code
INTGAR(13) STAT, branch status
INTGAR(14) NMETBS, non-metered end bus number
(IBUS, JBUS or KBUS)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
856
Power Flow THREE_WINDING_DATA
INTGAR(15) WN1BUS, winding one side bus number
(IBUS, JBUS or KBUS)
INTGAR(16) WN2BUS, winding two side bus number
(IBUS, JBUS or KBUS)
INTGAR(17) WN3BUS, winding three side bus number
(IBUS, JBUS or KBUS)
Real REALAR (53) array of elements specifying (first 41 are input values; last 12 are out-
put values)(input).(output).
REALAR(1) R1-2, nominal bus one to two transformer re-
sistance
REALAR(2) X1-2, nominal bus one to two transformer
reactance
REALAR(3) R3-1, nominal bus three to one transformer
resistance
REALAR(4) X3-1, nominal bus three to one transformer
reactance
REALAR(5) R2-3, nominal bus two to three transformer
resistance
REALAR(6) X2-3, nominal bus two to three transformer
reactance
REALAR(7) SBS1-2, winding one to two base MVA
REALAR(8) SBS2-3, winding two to three base MVA
REALAR(9) SBS3-1, winding three to one base MVA
REALAR(10) MAG1, magnetizing conductance or no-load
losses
REALAR(11) MAG2, magnetizing susceptance or exciting
current
REALAR(12) WINDV1, winding one ratio or voltage
REALAR(13) NOMV1, winding one nominal voltage
REALAR(14) 1, winding one phase shift angle
REALAR(15) RATA1, winding one rating set A line rating
REALAR(16) RATB1, winding one rating set B line rating
REALAR(17) RATC1, winding one rating set C line rating
REALAR(18) WINDV2, winding two ratio or voltage
REALAR(19) NOMV2, winding two nominal voltage
REALAR(20) 2, winding two phase shift angle
REALAR(21) RATA2, winding two rating set A line rating
REALAR(22) RATB2, winding two rating set B line rating
REALAR(23) RATC2, winding two rating set C line rating
REALAR(24) WINDV3, winding three ratio or voltage
REALAR(25) NOMV3, winding three nominal voltage
REALAR(26) 3, winding three phase shift angle
REALAR(27) RATA3, winding three rating set A line rating
REALAR(28) RATB3, winding three rating set B line rating
REALAR(29) RATC3, winding three rating set C line rating
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
857
Power Flow THREE_WINDING_DATA
REALAR(30) F1, first owner fraction
REALAR(31) F2, second owner fraction
REALAR(32) F3, third owner fraction
REALAR(33) F4, fourth owner fraction
REALAR(34) RMA1, winding one ratio/angle high limit
REALAR(35) RMI1, winding one ratio/angle low limit
REALAR(36) VMA1, voltage or flow upper limit
REALAR(37) VMI1, voltage or flow lower limit
REALAR(38) CR1, load drop compensating resistance
REALAR(39) CX1, load drop compensating reactance
REALAR(40) VMSTAR, star bus voltage magnitude
REALAR(41) TAR, star bus voltage angle
REALAR(42) actual bus one to two resistance (returned)
REALAR(43) actual bus one to two reactance (returned)
REALAR(44) actual bus three to one resistance (returned)
REALAR(45) actual bus three to one reactance (returned)
REALAR(46) nominal winding one resistance (returned)
REALAR(47) nominal winding one reactance (returned)
REALAR(48) nominal winding two resistance (returned)
REALAR(49) nominal winding two reactance (returned)
REALAR(50) nominal winding three resistance (returned)
REALAR(51) nominal winding three reactance (returned)
REALAR(52) actual winding one resistance (returned)
REALAR(53) actual winding one reactance (returned)
Character*40 NAME transformer name (input).
Real REALARI (input).
Real REALARO (output).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW, CZ and/or CM >1 but no base voltage at
one or more buses
IERR = 5 three different buses must be specified
IERR = 6 blank circuit identifier
IERR = 7 circuit identifier may not start with '&'
IERR = 8 three-winding transformer table full
IERR = 9 bus table full
IERR = 10 not enough branch table entries available
IERR = 11 not enough room in two winding transformer
table
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
858
Power Flow THREE_WINDING_DATA
IERR = 12 not enough room in branch ownership table
IERR = 13 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid set of
winding buses. - Invalid transformer status. -
Invalid non-metered end bus. - Winding side
buses interchanged. - Losses are too big rela-
tive to total impedance at winding base MVA.
- Magnitude of winding impedance is less
than 0.00001. - Controlled bus not found. -
Invalid adjustment control mode flag. - Any
two-winding transformer warnings
Integer NERR number of entries in PBUF02 containing error messages (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
859
Power Flow THREE_WND_IMPEDANCE_DATA
1.2.122. THREE_WND_IMPEDANCE_DATA
This API routine is obsolete. It has been replaced by the API routine three_wnd_imped_data_3 .
Use this API routine to modify the impedance data of an existing three-winding transformer in the working
case, or to add a new three-winding transformer to the working case (see PSSE Program Operation Manu-
al, Non-Transformer Branch Data).
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_THREE_WND_IMPEDANCE_DATA IBUS JBUS KBUS 'CKT'
INTGAR(1)..INTGAR(12) REALAR(1)..REALAR(17) 'NAME'
Python command syntax:
ierr, realaro = three_wnd_impedance_data(ibus, jbus, kbus, ckt, intgar,
realari, name)
Fortran command syntax:
CALL THREE_WINDING_IMPEDANCE_API_2(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR,
NAME, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (12) array of 12 elements specifying (input).
INTGAR(1) O1, first owner number (owner of bus IBUS
by default)
INTGAR(2) O2, second owner number (0 by default)
INTGAR(3) O3, third owner number (0 by default)
INTGAR(4) O4, fourth owner number (0 by default)
INTGAR(5) CW, winding data I/O code (1 by default)
INTGAR(6) CZ, impedance data I/O code (1 by default)
INTGAR(7) CM, magnetizing admittance data I/O code
(1 by default)
INTGAR(8) STAT, branch status (1 by default)
INTGAR(9) NMETBS, non-metered end bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(10) WN1BUS, winding one side bus number
(IBUS, JBUS or KBUS) (IBUS by default)
INTGAR(11) WN2BUS, winding two side bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(12) WN3BUS, winding three side bus number
(IBUS, JBUS or KBUS) (KBUS by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
860
Power Flow THREE_WND_IMPEDANCE_DATA
Real REALAR (23) (first seventeen are input values; last six are output values) (input
(output).).
Real REALARI (17) array of 17 elements specifying corresponding to values REALAR(1)
through REALAR(17) as described above(input).
REALARI(1) R1-2, nominal bus one to two transformer re-
sistance (0.0 by default)
REALARI(2) X1-2, nominal bus one to two transformer
reactance (0.0002 by default)
REALARI(3) R2-3, nominal bus two to three transformer
resistance (0.0 by default)
REALARI(4) X2-3, nominal bus two to three transformer
reactance (0.0002 by default)
REALARI(5) R3-1, nominal bus three to one transformer
resistance (0.0 by default)
REALARI(6) X3-1, nominal bus three to one transformer
reactance (0.0002 by default)
REALARI(7) SBS1-2, winding one to two base MVA
(SBASE by default)
REALARI(8) SBS2-3, winding two to three base MVA
(SBASE by default)
REALARI(9) SBS3-1, winding three to one base MVA
(SBASE by default)
REALARI(10) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(11) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (0.0 by default)
REALARI(14) F3, third owner fraction (0.0 by default)
REALARI(15) F4, fourth owner fraction (0.0 by default)
REALARI(16) VMSTAR, star bus voltage magnitude (1.0 by
default)
REALARI(17) TAR, star bus voltage angle (0.0 by default)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(18)
through REALAR(23) as described above(output).
REALARO(1) actual bus one to two resistance (returned)
REALARO(2) actual bus one to two reactance (returned)
REALARO(3) actual bus two to three resistance (returned)
REALARO(4) actual bus two to three reactance (returned)
REALARO(5) actual bus three to one resistance (returned)
REALARO(6) actual bus three to one reactance (returned)
Character*40 NAME transformer name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
861
Power Flow THREE_WND_IMPEDANCE_DATA
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 5 three different buses must be specified
IERR = 6 blank circuit identifier is invalid
IERR = 7 transformer circuit identifier may not start
with &, * or @
IERR = 8 three-winding transformer table is full
IERR = 9 bus table is full
IERR = 10 not enough branch table entries are available
IERR = 11 not enough two-winding transformer table
entries are available
IERR = 12 not enough branch ownership table entries
are available
IERR = 14 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid set of wind-
ing buses. - Invalid CW, CZ and/or CM data
value. - Invalid transformer status. - Invalid
non-metered end bus. - Winding side bus-
es interchanged. - Losses are too big relative
to total impedance at winding base MVA.
- Magnitude of winding impedance is less
than 0.00001. - Any two-winding transformer
warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
862
Power Flow THREE_WND_IMPED_CHNG_3
1.2.123. THREE_WND_IMPED_CHNG_3
This API routine is obsolete. It has been replaced by the API routine three_wnd_imped_chng_4 .
Use this API routine to modify the impedance data of an existing three-winding transformer in the working
case (see PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_THREE_WND_IMPED_CHNG_3 IBUS JBUS KBUS 'CKT' INTGAR(1)..INTGAR(12)
REALAR(1)..REALAR(17) 'CHARAR(1)' 'CHARAR(2)'
Python command syntax:
ierr, realaro = three_wnd_imped_chng_3(ibus, jbus, kbus, ckt, intgar,
realari, charar)
Fortran command syntax:
CALL THREE_WINDING_IMPEDANCE_CHNG_3(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR,
CHARAR, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (12) array of 12 elements specifying (input).
INTGAR(1) O1, first owner number (owner of bus IBUS
by default)
INTGAR(2) O2, second owner number (0 by default)
INTGAR(3) O3, third owner number (0 by default)
INTGAR(4) O4, fourth owner number (0 by default)
INTGAR(5) CW, winding data I/O code (1 by default)
INTGAR(6) CZ, impedance data I/O code (1 by default)
INTGAR(7) CM, magnetizing admittance data I/O code
(1 by default)
INTGAR(8) STAT, branch status (1 by default)
INTGAR(9) NMETBS, non-metered end bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(10) WN1BUS, winding one side bus number
(IBUS, JBUS or KBUS) (IBUS by default)
INTGAR(11) WN2BUS, winding two side bus number
(IBUS, JBUS or KBUS) (JBUS by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
863
Power Flow THREE_WND_IMPED_CHNG_3
INTGAR(12) WN3BUS, winding three side bus number
(IBUS, JBUS or KBUS) (KBUS by default)
Real REALAR (23) (first seventeen are input values; last six are output values) (input
(output).).
Real REALARI (17) array of 17 elements specifying corresponding to values REALAR(1)
through REALAR(17) as described above(input).
REALARI(1) R1-2, nominal bus one to two transformer re-
sistance (0.0 by default)
REALARI(2) X1-2, nominal bus one to two transformer
reactance (0.0002 by default)
REALARI(3) R2-3, nominal bus two to three transformer
resistance (0.0 by default)
REALARI(4) X2-3, nominal bus two to three transformer
reactance (0.0002 by default)
REALARI(5) R3-1, nominal bus three to one transformer
resistance (0.0 by default)
REALARI(6) X3-1, nominal bus three to one transformer
reactance (0.0002 by default)
REALARI(7) SBS1-2, winding one to two base MVA
(SBASE by default)
REALARI(8) SBS2-3, winding two to three base MVA
(SBASE by default)
REALARI(9) SBS3-1, winding three to one base MVA
(SBASE by default)
REALARI(10) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(11) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (0.0 by default)
REALARI(14) F3, third owner fraction (0.0 by default)
REALARI(15) F4, fourth owner fraction (0.0 by default)
REALARI(16) VMSTAR, star bus voltage magnitude (1.0 by
default)
REALARI(17) TAR, star bus voltage angle (0.0 by default)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(18)
through REALAR(23) as described above(output).
REALARO(1) actual bus one to two resistance (returned)
REALARO(2) actual bus one to two reactance (returned)
REALARO(3) actual bus two to three resistance (returned)
REALARO(4) actual bus two to three reactance (returned)
REALARO(5) actual bus three to one resistance (returned)
REALARO(6) actual bus three to one reactance (returned)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) NAME, transformer name (blank by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
864
Power Flow THREE_WND_IMPED_CHNG_3
CHARAR(2) VGRP, vector group name (blank by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 13 three-winding transformer not found
IERR = 14 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid set of wind-
ing buses. - Invalid CW, CZ and/or CM data
value. - Invalid transformer status. - Invalid
non-metered end bus. - Winding side bus-
es interchanged. - Losses are too big relative
to total impedance at winding base MVA. -
Magnitude of winding impedance is less than
0.00001. - Vector group not found. - Any two-
winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
865
Power Flow THREE_WND_IMPED_CHNG_4
1.2.124. THREE_WND_IMPED_CHNG_4
Use this API routine to modify the impedance data of an existing three-winding transformer in the working
case (see PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_THREE_WND_IMPED_CHNG_4 IBUS JBUS KBUS CKT INTGAR(1)..INTGAR(13)
REALAR(1)..REALAR(17) NAMEAR VGRPAR
Python command syntax:
ierr, realaro = three_wnd_imped_chng_4(ibus, jbus, kbus, ckt, intgar,
realari, namear, vgrpar)
Fortran command syntax:
CALL THREE_WINDING_IMPEDANCE_CHNG_4(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR,
NAMEAR, VGRPAR, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (13) array of 13 elements specifying (input).
INTGAR(1) O1, first owner number (owner of bus IBUS
by default)
INTGAR(2) O2, second owner number (0 by default)
INTGAR(3) O3, third owner number (0 by default)
INTGAR(4) O4, fourth owner number (0 by default)
INTGAR(5) CW, winding data I/O code (1 by default)
INTGAR(6) CZ, impedance data I/O code (1 by default)
INTGAR(7) CM, magnetizing admittance data I/O code
(1 by default)
INTGAR(8) STAT, branch status (1 by default)
INTGAR(9) NMETBS, non-metered end bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(10) WN1BUS, winding one side bus number
(IBUS, JBUS or KBUS) (IBUS by default)
INTGAR(11) WN2BUS, winding two side bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(12) WN3BUS, winding three side bus number
(IBUS, JBUS or KBUS) (KBUS by default)
INTGAR(13) ZCOD, impedance adjustment code (0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
866
Power Flow THREE_WND_IMPED_CHNG_4
Real REALAR (23) (first seventeen are input values; last six are output values) (input
(output).).
Real REALARI (17) array of 17 elements specifying corresponding to values REALAR(1)
through REALAR(17) as described above(input).
REALARI(1) R1-2, nominal bus one to two transformer re-
sistance (0.0 by default)
REALARI(2) X1-2, nominal bus one to two transformer
reactance (0.0002 by default)
REALARI(3) R2-3, nominal bus two to three transformer
resistance (0.0 by default)
REALARI(4) X2-3, nominal bus two to three transformer
reactance (0.0002 by default)
REALARI(5) R3-1, nominal bus three to one transformer
resistance (0.0 by default)
REALARI(6) X3-1, nominal bus three to one transformer
reactance (0.0002 by default)
REALARI(7) SBS1-2, winding one to two base MVA
(SBASE by default)
REALARI(8) SBS2-3, winding two to three base MVA
(SBASE by default)
REALARI(9) SBS3-1, winding three to one base MVA
(SBASE by default)
REALARI(10) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(11) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (0.0 by default)
REALARI(14) F3, third owner fraction (0.0 by default)
REALARI(15) F4, fourth owner fraction (0.0 by default)
REALARI(16) VMSTAR, star bus voltage magnitude (1.0 by
default)
REALARI(17) TAR, star bus voltage angle (0.0 by default)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(18)
through REALAR(23) as described above(output).
REALARO(1) actual bus one to two resistance (returned)
REALARO(2) actual bus one to two reactance (returned)
REALARO(3) actual bus two to three resistance (returned)
REALARO(4) actual bus two to three reactance (returned)
REALARO(5) actual bus three to one resistance (returned)
REALARO(6) actual bus three to one reactance (returned)
Character*40 NAMEAR transformer name (input; blank by default).
Character*12 VGRPAR vector group name (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
867
Power Flow THREE_WND_IMPED_CHNG_4
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 13 three-winding transformer not found
IERR = 14 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid set of wind-
ing buses. - Invalid CW, CZ and/or CM data
value. - Invalid transformer status. - Invalid
non-metered end bus. - Winding side bus-
es interchanged. - Losses are too big relative
to total impedance at winding base MVA. -
Magnitude of winding impedance is less than
0.00001. - Vector group not found. - Any two-
winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
868
Power Flow THREE_WND_IMPED_DATA_3
1.2.125. THREE_WND_IMPED_DATA_3
This API routine is obsolete. It has been replaced by the API routine three_wnd_imped_data_4 .
Use this API routine to modify the impedance data of an existing three-winding transformer in the working
case, or to add a new three-winding transformer to the working case (see PSSE Program Operation Manu-
al, Non-Transformer Branch Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_THREE_WND_IMPED_DATA_3 IBUS JBUS KBUS 'CKT' INTGAR(1)..INTGAR(12)
REALAR(1)..REALAR(17) 'CHARAR(1)' 'CHARAR(2)'
Python command syntax:
ierr, realaro = three_wnd_imped_data_3(ibus, jbus, kbus, ckt, intgar,
realari, charar)
Fortran command syntax:
CALL THREE_WINDING_IMPEDANCE_API_3(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR,
CHARAR, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (12) array of 12 elements specifying (input).
INTGAR(1) O1, first owner number (owner of bus IBUS
by default)
INTGAR(2) O2, second owner number (0 by default)
INTGAR(3) O3, third owner number (0 by default)
INTGAR(4) O4, fourth owner number (0 by default)
INTGAR(5) CW, winding data I/O code (1 by default)
INTGAR(6) CZ, impedance data I/O code (1 by default)
INTGAR(7) CM, magnetizing admittance data I/O code
(1 by default)
INTGAR(8) STAT, branch status (1 by default)
INTGAR(9) NMETBS, non-metered end bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(10) WN1BUS, winding one side bus number
(IBUS, JBUS or KBUS) (IBUS by default)
INTGAR(11) WN2BUS, winding two side bus number
(IBUS, JBUS or KBUS) (JBUS by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
869
Power Flow THREE_WND_IMPED_DATA_3
INTGAR(12) WN3BUS, winding three side bus number
(IBUS, JBUS or KBUS) (KBUS by default)
Real REALAR (23) (first seventeen are input values; last six are output values) (input
(output).).
Real REALARI (17) array of 17 elements specifying corresponding to values REALAR(1)
through REALAR(17) as described above(input).
REALARI(1) R1-2, nominal bus one to two transformer re-
sistance (0.0 by default)
REALARI(2) X1-2, nominal bus one to two transformer
reactance (0.0002 by default)
REALARI(3) R2-3, nominal bus two to three transformer
resistance (0.0 by default)
REALARI(4) X2-3, nominal bus two to three transformer
reactance (0.0002 by default)
REALARI(5) R3-1, nominal bus three to one transformer
resistance (0.0 by default)
REALARI(6) X3-1, nominal bus three to one transformer
reactance (0.0002 by default)
REALARI(7) SBS1-2, winding one to two base MVA
(SBASE by default)
REALARI(8) SBS2-3, winding two to three base MVA
(SBASE by default)
REALARI(9) SBS3-1, winding three to one base MVA
(SBASE by default)
REALARI(10) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(11) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (0.0 by default)
REALARI(14) F3, third owner fraction (0.0 by default)
REALARI(15) F4, fourth owner fraction (0.0 by default)
REALARI(16) VMSTAR, star bus voltage magnitude (1.0 by
default)
REALARI(17) TAR, star bus voltage angle (0.0 by default)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(18)
through REALAR(23) as described above(output).
REALARO(1) actual bus one to two resistance (returned)
REALARO(2) actual bus one to two reactance (returned)
REALARO(3) actual bus two to three resistance (returned)
REALARO(4) actual bus two to three reactance (returned)
REALARO(5) actual bus three to one resistance (returned)
REALARO(6) actual bus three to one reactance (returned)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) NAME, transformer name (blank by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
870
Power Flow THREE_WND_IMPED_DATA_3
CHARAR(2) VGRP, vector group name (blank by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 5 three different buses must be specified
IERR = 6 blank circuit identifier is invalid
IERR = 7 transformer circuit identifier may not start
with &, * or @
IERR = 8 three-winding transformer table is full
IERR = 9 bus table is full
IERR = 10 not enough branch table entries are available
IERR = 11 not enough two-winding transformer table
entries are available
IERR = 12 not enough branch ownership table entries
are available
IERR = 14 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid set of wind-
ing buses. - Invalid CW, CZ and/or CM data
value. - Invalid transformer status. - Invalid
non-metered end bus. - Winding side bus-
es interchanged. - Losses are too big relative
to total impedance at winding base MVA. -
Magnitude of winding impedance is less than
0.00001. - Vector group not found. - Any two-
winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
871
Power Flow THREE_WND_IMPED_DATA_4
1.2.126. THREE_WND_IMPED_DATA_4
Use this API routine to modify the impedance data of an existing three-winding transformer in the working
case, or to add a new three-winding transformer to the working case (see PSSE Program Operation Manu-
al, Non-Transformer Branch Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_THREE_WND_IMPED_DATA_4 IBUS JBUS KBUS CKT INTGAR(1)..INTGAR(13)
REALAR(1)..REALAR(17) NAMEAR VGRPAR
Python command syntax:
ierr, realaro = three_wnd_imped_data_4(ibus, jbus, kbus, ckt, intgar,
realari, namear, vgrpar)
Fortran command syntax:
CALL THREE_WINDING_IMPEDANCE_API_4(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR,
NAMEAR, VGRPAR, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (13) array of 13 elements specifying (input).
INTGAR(1) O1, first owner number (owner of bus IBUS
by default)
INTGAR(2) O2, second owner number (0 by default)
INTGAR(3) O3, third owner number (0 by default)
INTGAR(4) O4, fourth owner number (0 by default)
INTGAR(5) CW, winding data I/O code (1 by default)
INTGAR(6) CZ, impedance data I/O code (1 by default)
INTGAR(7) CM, magnetizing admittance data I/O code
(1 by default)
INTGAR(8) STAT, branch status (1 by default)
INTGAR(9) NMETBS, non-metered end bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(10) WN1BUS, winding one side bus number
(IBUS, JBUS or KBUS) (IBUS by default)
INTGAR(11) WN2BUS, winding two side bus number
(IBUS, JBUS or KBUS) (JBUS by default)
INTGAR(12) WN3BUS, winding three side bus number
(IBUS, JBUS or KBUS) (KBUS by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
872
Power Flow THREE_WND_IMPED_DATA_4
INTGAR(13) ZCOD, transformer impedance adjustment
code (0 for winding impedances, 1 for bus-
to-bus impedances) (0 by default)
Real REALAR (23) (first seventeen are input values; last six are output values) (input
(output).).
Real REALARI (17) array of 17 elements specifying corresponding to values REALAR(1)
through REALAR(17) as described above(input).
REALARI(1) R1-2, nominal bus one to two transformer re-
sistance (0.0 by default)
REALARI(2) X1-2, nominal bus one to two transformer
reactance (0.0002 by default)
REALARI(3) R2-3, nominal bus two to three transformer
resistance (0.0 by default)
REALARI(4) X2-3, nominal bus two to three transformer
reactance (0.0002 by default)
REALARI(5) R3-1, nominal bus three to one transformer
resistance (0.0 by default)
REALARI(6) X3-1, nominal bus three to one transformer
reactance (0.0002 by default)
REALARI(7) SBS1-2, winding one to two base MVA
(SBASE by default)
REALARI(8) SBS2-3, winding two to three base MVA
(SBASE by default)
REALARI(9) SBS3-1, winding three to one base MVA
(SBASE by default)
REALARI(10) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(11) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (0.0 by default)
REALARI(14) F3, third owner fraction (0.0 by default)
REALARI(15) F4, fourth owner fraction (0.0 by default)
REALARI(16) VMSTAR, star bus voltage magnitude (1.0 by
default)
REALARI(17) TAR, star bus voltage angle (0.0 by default)
Real REALARO (6) array of 6 elements specifying corresponding to values REALAR(18)
through REALAR(23) as described above(output).
REALARO(1) actual bus one to two resistance (returned)
REALARO(2) actual bus one to two reactance (returned)
REALARO(3) actual bus two to three resistance (returned)
REALARO(4) actual bus two to three reactance (returned)
REALARO(5) actual bus three to one resistance (returned)
REALARO(6) actual bus three to one reactance (returned)
Character*40 NAMEAR transformer name (input; blank by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
873
Power Flow THREE_WND_IMPED_DATA_4
Character*12 VGRPAR vector group name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 5 three different buses must be specified
IERR = 6 blank circuit identifier is invalid
IERR = 7 transformer circuit identifier may not start
with &, * or @
IERR = 8 three-winding transformer table is full
IERR = 9 bus table is full
IERR = 10 not enough branch table entries are available
IERR = 11 not enough two-winding transformer table
entries are available
IERR = 12 not enough branch ownership table entries
are available
IERR = 14 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid set of wind-
ing buses. - Invalid CW, CZ and/or CM data
value. - Invalid transformer status. - Invalid
non-metered end bus. - Winding side bus-
es interchanged. - Losses are too big relative
to total impedance at winding base MVA. -
Magnitude of winding impedance is less than
0.00001. - Vector group not found. - Any two-
winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
874
Power Flow THREE_WND_WINDING_DATA
1.2.127. THREE_WND_WINDING_DATA
This API routine is obsolete. It has been replaced by the API routine three_wnd_winding_data_3 .
Use this API to modify the data of one winding of an existing three-winding transformer in the working
case (see PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_THREE_WND_WINDING_DATA IBUS JBUS KBUS 'CKT' WARG
INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(12)
Python command syntax:
ierr, realaro = three_wnd_winding_data(ibus, jbus, kbus, ckt, warg,
intgar, realari)
Fortran command syntax:
CALL THREE_WINDING_WINDING_API_2(IBUS, JBUS, KBUS, CKT, WARG, INTGAR,
REALAR, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer WARG winding number (1, 2 or 3) (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) NTPi, number of tap positions (33 by default)
INTGAR(2) TABi, impedance correction table number (0
by default)
INTGAR(3) CONTi, controlled bus number (0 by default)
INTGAR(4) SICODi, negative for controlled bus on wind-
ing bus side (1 by default)
INTGAR(5) CODi, adjustment control mode flag (-3
through +3) (0 by default)
Real REALAR (16) (first twelve are input values; last four are output values) (input (out-
put).).
Real REALARI (12) array of 12 elements specifying corresponding to values REALAR(1)
through REALAR(12) as described above(input).
REALARI(1) WINDVi, winding ratio or voltage (1.0 by de-
fault if CW of this transformer is 1 or 3; base
voltage of the winding bus by default if CW is
2)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
875
Power Flow THREE_WND_WINDING_DATA
REALARI(2) NOMVi, winding nominal voltage (0.0 by de-
fault)
REALARI(3) i, winding phase shift angle (0.0 by default)
REALARI(4) RATAi, winding rating set A line rating (0.0 by
default)
REALARI(5) RATBi, winding rating set B line rating (0.0 by
default)
REALARI(6) RATCi, winding rating set C line rating (0.0 by
default)
REALARI(7) RMAi, winding ratio/angle high limit (1.1 by
default)
REALARI(8) RMIi, winding ratio/angle low limit (0.9 by
default)
REALARI(9) VMAi, winding voltage or flow upper limit
(1.1 by default)
REALARI(10) VMIi, winding voltage or flow lower limit
(0.9 by default)
REALARI(11) CRi, winding load drop compensating resis-
tance (0.0 by default)
REALARI(12) CXi, winding load drop compensating reac-
tance (0.0 by default)
Real REALARO (4) array of 4 elements specifying corresponding to values REALAR(13)
through REALAR(16) as described above(output).
REALARO(1) winding nominal resistance (returned)
REALARO(2) winding nominal reactance (returned)
REALARO(3) winding actual resistance (returned)
REALARO(4) winding actual reactance (returned)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW and/or CZ >1 but no base voltage at wind-
ing bus
IERR = 5 three winding transformer not found
IERR = 6 invalid winding number
IERR = 7 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Controlled bus not
found. - Invalid adjustment control mode
flag. - Any two-winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
876
Power Flow THREE_WND_WINDING_DATA_3
1.2.128. THREE_WND_WINDING_DATA_3
This API routine is obsolete. It has been replaced by the API routine three_wnd_winding_data_4 .
Use this API to modify the data of one winding of an existing three-winding transformer in the working
case (see PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_THREE_WND_WINDING_DATA_3 IBUS JBUS KBUS 'CKT' WARG
INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(12)
Python command syntax:
ierr, realaro = three_wnd_winding_data_3(ibus, jbus, kbus, ckt, warg,
intgar, realari)
Fortran command syntax:
CALL THREE_WINDING_WINDING_API_3(IBUS, JBUS, KBUS, CKT, WARG, INTGAR,
REALAR, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer WARG winding number (1, 2 or 3) (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) NTPi, number of tap positions (33 by default)
INTGAR(2) TABi, impedance correction table number (0
by default)
INTGAR(3) CONTi, controlled bus number (0 by default)
INTGAR(4) SICODi, negative for controlled bus on wind-
ing bus side (1 by default)
INTGAR(5) CODi, adjustment control mode flag (-3
through +3, -5 or 5) (0 by default)
Real REALAR (17) (first thirteen are input values; last four are output values) (input
(output).).
Real REALARI (13) array of 13 elements specifying corresponding to values REALAR(1)
through REALAR(13) as described above(input).
REALARI(1) WINDVi, winding ratio or voltage (1.0 by de-
fault if CW of this transformer is 1 or 3; base
voltage of the winding bus by default if CW is
2)
REALARI(2) NOMVi, winding nominal voltage (0.0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
877
Power Flow THREE_WND_WINDING_DATA_3
REALARI(3) i, winding phase shift angle (0.0 by default)
REALARI(4) RATAi, winding rating set A line rating (0.0 by
default)
REALARI(5) RATBi, winding rating set B line rating (0.0 by
default)
REALARI(6) RATCi, winding rating set C line rating (0.0 by
default)
REALARI(7) RMAi, winding ratio/angle high limit (1.1 by
default)
REALARI(8) RMIi, winding ratio/angle low limit (0.9 by
default)
REALARI(9) VMAi, winding voltage or flow upper limit
(1.1 by default)
REALARI(10) VMIi, winding voltage or flow lower limit
(0.9 by default)
REALARI(11) CRi, winding load drop compensating resis-
tance (0.0 by default)
REALARI(12) CXi, winding load drop compensating reac-
tance (0.0 by default)
REALARI(13) CNXAi, winding connection angle (0.0 by de-
fault). Used with adjustment control mode
5 (unsymmetric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (4) array of 4 elements specifying corresponding to values REALAR(14)
through REALAR(17) as described above(output).
REALARO(1) winding nominal resistance (returned)
REALARO(2) winding nominal reactance (returned)
REALARO(3) winding actual resistance (returned)
REALARO(4) winding actual reactance (returned)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW and/or CZ >1 but no base voltage at wind-
ing bus
IERR = 5 three winding transformer not found
IERR = 6 invalid winding number
IERR = 7 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Controlled bus not
found. - Invalid adjustment control mode
flag. - Any two-winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
878
Power Flow THREE_WND_WINDING_DATA_4
1.2.129. THREE_WND_WINDING_DATA_4
This API routine is obsolete. It has been replaced by the API routine three_wnd_winding_data_5 .
Use this API to modify the data of one winding of an existing three-winding transformer in the working
case (see PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_THREE_WND_WINDING_DATA_4 IBUS JBUS KBUS CKT WARG INTGAR(1)..INTGAR(5)
REALAR(1)..REALAR(10) RATINGS(1)..RATINGS(12)
Python command syntax:
ierr, realaro = three_wnd_winding_data_4(ibus, jbus, kbus, ckt, warg,
intgar, realari, ratings)
Fortran command syntax:
CALL THREE_WINDING_WINDING_DATA_4(IBUS, JBUS, KBUS, CKT, WARG, INTGAR,
REALAR, RATINGS, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer WARG winding number (1, 2 or 3) (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) NTPi, number of tap positions (33 by default)
INTGAR(2) TABi, impedance correction table number (0
by default)
INTGAR(3) CONTi, controlled bus number (0 by default)
INTGAR(4) SICODi, negative for controlled bus on wind-
ing bus side (1 by default)
INTGAR(5) CODi, adjustment control mode flag (-3
through +3, -5 or 5) (0 by default)
Real REALAR (14) (first ten are input values; last four are output values) (input (out-
put).).
Real REALARI (10) array of 10 elements specifying corresponding to values REALAR(1)
through REALAR(10) as described above(input).
REALARI(1) WINDVi, winding ratio or voltage (1.0 by de-
fault if CW of this transformer is 1 or 3; base
voltage of the winding bus by default if CW is
2)
REALARI(2) NOMVi, winding nominal voltage (0.0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
879
Power Flow THREE_WND_WINDING_DATA_4
REALARI(3) i, winding phase shift angle (0.0 by default)
REALARI(4) RMAi, winding ratio/angle high limit (1.1 by
default)
REALARI(5) RMIi, winding ratio/angle low limit (0.9 by
default)
REALARI(6) VMAi, winding voltage or flow upper limit
(1.1 by default)
REALARI(7) VMIi, winding voltage or flow lower limit
(0.9 by default)
REALARI(8) CRi, winding load drop compensating resis-
tance (0.0 by default)
REALARI(9) CXi, winding load drop compensating reac-
tance (0.0 by default)
REALARI(10) CNXAi, winding connection angle (0.0 by de-
fault). Used with adjustment control mode
5 (unsymmetric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (4) array of 4 elements specifying corresponding to values REALAR(11)
through REALAR(14) as described above(output).
REALARO(1) winding nominal resistance (returned)
REALARO(2) winding nominal reactance (returned)
REALARO(3) winding actual resistance (returned)
REALARO(4) winding actual reactance (returned)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1i, winding rating set 1 line rating (alias
is RATE1) (0.0 by default)
RATINGS(2) RATE2i, winding rating set 2 line rating (alias
is RATE2) (0.0 by default)
RATINGS(3) RATE3i, winding rating set 3 line rating (alias
is RATE3) (0.0 by default)
RATINGS(4) RATE4i, winding rating set 4 line rating (alias
is RATE4) (0.0 by default)
RATINGS(5) RATE5i, winding rating set 5 line rating (alias
is RATE5) (0.0 by default)
RATINGS(6) RATE6i, winding rating set 6 line rating (alias
is RATE6) (0.0 by default)
RATINGS(7) RATE7i, winding rating set 7 line rating (alias
is RATE7) (0.0 by default)
RATINGS(8) RATE8i, winding rating set 8 line rating (alias
is RATE8) (0.0 by default)
RATINGS(9) RATE9i, winding rating set 9 line rating (alias
is RATE9) (0.0 by default)
RATINGS(10) RATE10i, winding rating set 10 line rating
(alias is RATE10) (0.0 by default)
RATINGS(11) RATE11i, winding rating set 11 line rating
(alias is RATE11) (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
880
Power Flow THREE_WND_WINDING_DATA_4
RATINGS(12) RATE12i, winding rating set 12 line rating
(alias is RATE12) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW and/or CZ >1 but no base voltage at wind-
ing bus
IERR = 5 three winding transformer not found
IERR = 6 invalid winding number
IERR = 7 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Controlled bus not
found. - Invalid adjustment control mode
flag. - Any two-winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
881
Power Flow THREE_WND_WINDING_DATA_5
1.2.130. THREE_WND_WINDING_DATA_5
Use this API to modify the data of one winding of an existing three-winding transformer in the working
case (see PSSE Program Operation Manual, Non-Transformer Branch Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_THREE_WND_WINDING_DATA_5 IBUS JBUS KBUS CKT WARG INTGAR(1)..INTGAR(6)
REALAR(1)..REALAR(10) RATINGS(1)..RATINGS(12)
Python command syntax:
ierr, realaro = three_wnd_winding_data_5(ibus, jbus, kbus, ckt, warg,
intgar, realari, ratings)
Fortran command syntax:
CALL THREE_WINDING_WINDING_DATA_5(IBUS, JBUS, KBUS, CKT, WARG, INTGAR,
REALAR, RATINGS, IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer WARG winding number (1, 2 or 3) (input; no default allowed).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) NTPi, number of tap positions (33 by default)
INTGAR(2) TABi, impedance correction table number (0
by default)
INTGAR(3) CONTi, controlled bus number (0 by default)
INTGAR(4) NODEi, controlled node number (0 by de-
fault)
INTGAR(5) SICODi, negative for controlled bus on wind-
ing bus side (1 by default)
INTGAR(6) CODi, adjustment control mode flag (-3
through +3, -5 or 5) (0 by default)
Real REALAR (14) (first ten are input values; last four are output values) (input (out-
put).).
Real REALARI (10) array of 10 elements specifying corresponding to values REALAR(1)
through REALAR(10) as described above(input).
REALARI(1) WINDVi, winding ratio or voltage (1.0 by de-
fault if CW of this transformer is 1 or 3; base
voltage of the winding bus by default if CW is
2)
REALARI(2) NOMVi, winding nominal voltage (0.0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
882
Power Flow THREE_WND_WINDING_DATA_5
REALARI(3) i, winding phase shift angle (0.0 by default)
REALARI(4) RMAi, winding ratio/angle high limit (1.1 by
default)
REALARI(5) RMIi, winding ratio/angle low limit (0.9 by
default)
REALARI(6) VMAi, winding voltage or flow upper limit
(1.1 by default)
REALARI(7) VMIi, winding voltage or flow lower limit
(0.9 by default)
REALARI(8) CRi, winding load drop compensating resis-
tance (0.0 by default)
REALARI(9) CXi, winding load drop compensating reac-
tance (0.0 by default)
REALARI(10) CNXAi, winding connection angle (0.0 by de-
fault). Used with adjustment control mode
5 (unsymmetric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (4) array of 4 elements specifying corresponding to values REALAR(11)
through REALAR(14) as described above(output).
REALARO(1) winding nominal resistance (returned)
REALARO(2) winding nominal reactance (returned)
REALARO(3) winding actual resistance (returned)
REALARO(4) winding actual reactance (returned)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1i, winding rating set 1 line rating (alias
is RATE1) (0.0 by default)
RATINGS(2) RATE2i, winding rating set 2 line rating (alias
is RATE2) (0.0 by default)
RATINGS(3) RATE3i, winding rating set 3 line rating (alias
is RATE3) (0.0 by default)
RATINGS(4) RATE4i, winding rating set 4 line rating (alias
is RATE4) (0.0 by default)
RATINGS(5) RATE5i, winding rating set 5 line rating (alias
is RATE5) (0.0 by default)
RATINGS(6) RATE6i, winding rating set 6 line rating (alias
is RATE6) (0.0 by default)
RATINGS(7) RATE7i, winding rating set 7 line rating (alias
is RATE7) (0.0 by default)
RATINGS(8) RATE8i, winding rating set 8 line rating (alias
is RATE8) (0.0 by default)
RATINGS(9) RATE9i, winding rating set 9 line rating (alias
is RATE9) (0.0 by default)
RATINGS(10) RATE10i, winding rating set 10 line rating
(alias is RATE10) (0.0 by default)
RATINGS(11) RATE11i, winding rating set 11 line rating
(alias is RATE11) (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
883
Power Flow THREE_WND_WINDING_DATA_5
RATINGS(12) RATE12i, winding rating set 12 line rating
(alias is RATE12) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 invalid CW, CZ and/or CM value
IERR = 4 CW and/or CZ >1 but no base voltage at wind-
ing bus
IERR = 5 three winding transformer not found
IERR = 6 invalid winding number
IERR = 7 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Controlled bus not
found. - Invalid adjustment control mode
flag. - Any two-winding transformer warnings
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
884
Power Flow TRANSACTION_ADD_MOD
1.2.131. TRANSACTION_ADD_MOD
Use this API to add or modify transaction event data in PSSE working memory.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_TRANSACTION_ADD_MOD EVENT INTGAR(1) INTGAR(2) REALAR(1) REALAR(2)
'DSCRP'
Python command syntax:
ierr = transaction_add_mod(event, intgar, realar, dscrp)
Fortran command syntax:
CALL TRANSACTION_ADD_MOD(EVENT, INTGAR, REALAR, DSCRP, IERR, NERR)
Where:
Integer EVENT transaction event number (input).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) transaction event status (0 = out-of-service,
1 = in-service)
INTGAR(2) transaction event priority
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) transaction event magnitude in MW
REALAR(2) transaction event curtailment in MW
Character*24 DSCRP transaction event description (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 2 invalid transaction event number
IERR > 2 unable to add or modify transaction event
data: error condition detected in data access
routine
IERR = 10 prerequisite requirements for API are not met
IERR = -1 warnings: - None
Integer NERR number of error entries in PBUF02 (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
885
Power Flow TRANSACTION_DELETE
1.2.132. TRANSACTION_DELETE
Use this API to delete a transaction event from PSSE working memory.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_TRANSACTION_DELETE EVENT
Python command syntax:
ierr = transaction_delete(event)
Fortran command syntax:
CALL TRANSACTION_DELETE(EVENT, IERR, NERR)
Where:
Integer EVENT transaction event number (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid transaction event number
IERR = 2 prerequisite requirements for API are not met
Integer NERR number of error entries in PBUF02 (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
886
Power Flow TRANSFER_CHNG
1.2.133. TRANSFER_CHNG
Use this API routine to modify the data of an inter-area transfer in the working case (see PSSE Program Op-
eration Manual, Zone Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_TRANSFER_CHNG APPLYF ARFROM ARTO 'TRID' REALAR(1)
Python command syntax:
ierr = transfer_chng(applyf, arfrom, arto, trid, realar)
Fortran command syntax:
CALL TRANSFER_CHNG(APPLYF, ARFROM, ARTO, TRID, REALAR, IERR)
Where:
Integer APPLYF APPLYF = 1 to modify from and to area desired net interchange en-
tries (DESINT) (input).
APPLYF = 2 to leave DESINT entries unchanged. (Input;
no default allowed.)
Integer ARFROM from area number (must be an area already defined) (input; no de-
fault allowed).
Integer ARTO to area number (must be an area already defined) (input; no default
allowed).
Character*1 TRID inter-area transfer identifier (input; '1' by default).
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) PTRAN, MW comprising this inter-area trans-
fer (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid area number
IERR = 2 inter-area transfer identifier is more than one
character
IERR = 3 invalid APPLYF value
IERR = 8 area not found
IERR = 9 inter-area transfer not found
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Changes to desired
area net interchanges if APPLYF = 1
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
887
Power Flow TRANSFER_DATA
1.2.134. TRANSFER_DATA
Use this API routine to modify the data of an inter-area transfer in the working case, or to add a new in-
ter-area transfer to the working case (see PSSE Program Operation Manual, Zone Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TRANSFER_DATA APPLYF ARFROM ARTO 'TRID' REALAR(1)
Python command syntax:
ierr = transfer_data(applyf, arfrom, arto, trid, realar)
Fortran command syntax:
CALL TRANSFER_API_2(APPLYF, ARFROM, ARTO, TRID, REALAR, IERR)
Where:
Integer APPLYF APPLYF = 1 to modify from and to area desired net interchange en-
tries (DESINT) (input).
APPLYF = 2 to leave DESINT entries unchanged. (Input;
no default allowed.)
Integer ARFROM from area number (must be an area already defined) (input; no de-
fault allowed).
Integer ARTO to area number (must be an area already defined) (input; no default
allowed).
Character*1 TRID inter-area transfer identifier (input; '1' by default).
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) PTRAN, MW comprising this inter-area trans-
fer (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid area number
IERR = 2 inter-area transfer identifier is more than one
character
IERR = 3 invalid APPLYF value
IERR = 4 invalid inter-area transfer identifier
IERR = 5 transfer from an area to itself
IERR = 6 inter-area transfer table is full
IERR = 7 inter-area transfer already exists
IERR = 8 area not found
IERR = 10 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Changes to desired
area net interchanges if APPLYF = 1
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
888
Power Flow TRANSFER_DATA
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
889
Power Flow TWO_TERMINAL_DC_LINE_CHNG
1.2.135. TWO_TERMINAL_DC_LINE_CHNG
Use this API routine to modify the link data of an existing two-terminal dc line in the working case (see
PSSE Program Operation Manual, Area Interchange Data). Converter data for the rectifier and inverter are
specified via the TWO_TERM_DC_CONVR_DATA API routine.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_TWO_TERMINAL_DC_LINE_CHNG DC INTGAR(1) INTGAR(2) REALAR(1)..REALAR(8)
'METER'
Python command syntax:
ierr, realaro = two_terminal_dc_line_chng(dc, intgar, realari, meter)
Fortran command syntax:
CALL TWO_TERMINAL_DC_LINE_CHNG(NUM, INTGAR, REALAR, METER, IERR)
CALL TWO_TERMINAL_DC_LINE_CHNG_I(NUM, INTGAR, REALAR, METER, IERR)
CALL TWO_TERMINAL_DC_LINE_CHNG_C(NAME, INTGAR, REALAR, METER, IERR)
Where:
Integer or Character*12 DC quoted name of the two-terminal dc line for which data is to be spec-
ified; if an unquoted integer value is specified, the API converts it to a
left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the two-
terminal dc line for which data is to be specified; no default allowed
Character*12 NAME name of the two-terminal dc line for which data is to be specified; no
default allowed
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) MDC, control mode (0, 1 or 2) (0 by default)
INTGAR(2) CCITMX, CCC Newton solution iteration limit
(20 by default)
Real REALAR (9) first eight are input values; last value is output (input (output).).
Real REALARI (8) array of 8 elements specifying values REALAR(1) through REALAR(8)
as described above(input).
REALARI(1) SETVL, scheduled current (amps) or power
(MW) demand (0.0 by default)
REALARI(2) VSCHD, scheduled dc voltage (kV) (1.0 by de-
fault)
REALARI(3) VCMOD, mode switch dc voltage (kV) (0.0 by
default)
REALARI(4) DELTI, margin (pu, > 0) (0.0 by default)
REALARI(5) RDC, dc line resistance (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
890
Power Flow TWO_TERMINAL_DC_LINE_CHNG
REALARI(6) RCOMP, compounding resistance (0.0 by de-
fault)
REALARI(7) DCVMIN, minimum dc voltage (kV) (0.0 by
default)
REALARI(8) CCCACC, CCC Newton solution acceleration
(1.0 by default)
Real REALARO (1) array of 1 elements specifying value REALAR(9) as described
above(output).
REALARO(1) dc line current (amps) (returned)
Character*1 METER metered end flag: 'R' or 'I' (input; 'I' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 2 metered end code is more than one character
IERR = 3 blank dc line name is invalid
IERR = 4 two-terminal dc line not found
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid dc line con-
trol mode - invalid dc line resistance - invalid
compounding resistance - compounding re-
sistance exceeds line resistance - scheduled
voltage must exceed mode switch voltage -
invalid metered end code
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
891
Power Flow TWO_TERMINAL_DC_LINE_DATA
1.2.136. TWO_TERMINAL_DC_LINE_DATA
Use this API routine to modify the link data of an existing two-terminal dc line in the working case,
or to add a new two-terminal dc line and its link data to the working case (see PSSE Program Opera-
tion Manual, Area Interchange Data). Converter data for the rectifier and inverter are specified via the
TWO_TERM_DC_CONVR_DATA API routine.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TWO_TERMINAL_DC_LINE_DATA DC INTGAR(1) INTGAR(2) REALAR(1)..REALAR(8)
'METER'
Python command syntax:
ierr, realaro = two_terminal_dc_line_data(dc, intgar, realari, meter)
Fortran command syntax:
CALL TWO_TERMINAL_DC_LINE_API(NUM, INTGAR, REALAR, METER, IERR)
CALL TWO_TERMINAL_DC_LINE_API_I(NUM, INTGAR, REALAR, METER, IERR)
CALL TWO_TERMINAL_DC_LINE_API_C(NAME, INTGAR, REALAR, METER, IERR)
Where:
Integer or Character*12 DC quoted name of the two-terminal dc line for which data is to be spec-
ified; if an unquoted integer value is specified, the API converts it to a
left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the two-
terminal dc line for which data is to be specified; no default allowed
Character*12 NAME name of the two-terminal dc line for which data is to be specified; no
default allowed
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) MDC, control mode (0, 1 or 2) (0 by default)
INTGAR(2) CCITMX, CCC Newton solution iteration limit
(20 by default)
Real REALAR (9) first eight are input values; last value is output (input (output).).
Real REALARI (8) array of 8 elements specifying values REALAR(1) through REALAR(8)
as described above(input).
REALARI(1) SETVL, scheduled current (amps) or power
(MW) demand (0.0 by default)
REALARI(2) VSCHD, scheduled dc voltage (kV) (1.0 by de-
fault)
REALARI(3) VCMOD, mode switch dc voltage (kV) (0.0 by
default)
REALARI(4) DELTI, margin (pu, > 0) (0.0 by default)
REALARI(5) RDC, dc line resistance (0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
892
Power Flow TWO_TERMINAL_DC_LINE_DATA
REALARI(6) RCOMP, compounding resistance (0.0 by de-
fault)
REALARI(7) DCVMIN, minimum dc voltage (kV) (0.0 by
default)
REALARI(8) CCCACC, CCC Newton solution acceleration
(1.0 by default)
Real REALARO (1) array of 1 elements specifying value REALAR(9) as described
above(output).
REALARO(1) dc line current (amps) (returned)
Character*1 METER metered end flag: 'R' or 'I' (input; 'I' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 two-terminal dc line table is full
IERR = 2 metered end code is more than one character
IERR = 3 blank dc line name is invalid
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid dc line con-
trol mode - invalid dc line resistance - invalid
compounding resistance - compounding re-
sistance exceeds line resistance - scheduled
voltage must exceed mode switch voltage -
invalid metered end code
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
893
Power Flow TWO_TERM_DC_CONVERTER_DATA_3
1.2.137. TWO_TERM_DC_CONVERTER_DATA_3
Use this API to modify the data of a dc converter of an existing two-terminal dc line in the working case
(see PSSE Program Operation Manual, Area Interchange Data). The dc line must have previously been spec-
ified via the TWO_TERMINAL_DC_LINE_DATA API.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_TWO_TERM_DC_CONVERTER_DATA_3 CNVFLG NAME INTGAR(1)..INTGAR(6)
REALAR(1)..REALAR(11) 'ID'
Python command syntax:
ierr, realaro = two_term_dc_converter_data_3(cnvflg, name, intgar,
realari, id)
Fortran command syntax:
CALL TWO_TERM_DC_CONVERTER_DATA_3 (CNVFLG, NAME, INTGAR, REALAR, ID, IERR)
Where:
Integer CNVFLG converter type (input; no default allowed).
CNVFLG = 1 for rectifier data.
CNVFLG = 2 for inverter data.
Character*12 NAME name of the two-terminal dc line for which data for one of its con-
verters is to be specified (input; no default allowed).
Integer INTGAR (6) array of 6 elements specifying (input).
INTGAR(1) IPR or IPI, converter bus number (no default
allowed)
INTGAR(2) NBR or NBI, number of bridges in series (0 by
default)
INTGAR(3) ICR or ICI, zero or bus number of firing angle
bus (0 by default)
INTGAR(4) NDR or NDI, zero or node number of firing
angle bus node (0 by default)
INTGAR(5) IFR or IFI, zero or bus number of winding one
side of a two-winding ac transformer (0 by
default)
INTGAR(6) ITR or ITI, zero or bus number of winding two
side of a two-winding ac transformer (0 by
default)
Real REALAR (15) (first eleven are input values; last four are output values) (input (out-
put).).
Real REALARI (11) array of elements specifying values REALAR(1) through REALAR(11)
as described above(input).
REALARI(1) NR or ANMNI, minimum firing angle (90.0 by
default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
894
Power Flow TWO_TERM_DC_CONVERTER_DATA_3
REALARI(2) XR or ANMXI, maximum firing angle (0.0 by
default)
REALARI(3) RCR or RCI, commutating resistance (0.0 by
default)
REALARI(4) XCR or XCI, commutating reactance (0.0 by
default)
REALARI(5) EBASR or EBASI, primary base ac voltage (0.0
by default)
REALARI(6) TRR or TRI, transformer ratio (1.0 by default)
REALARI(7) TAPR or TAPI, tap setting (1.0 by default)
REALARI(8) TMXR or TMXI, maximum tap setting (1.5 by
default)
REALARI(9) TMNR or TMNI, minimum tap setting (0.51
by default)
REALARI(10) STPR or STPI, tap step (0.00625 by default)
REALARI(11) XCAPR or XCAPI, capacitive reactance of CCC
type converter (0.0 by default)
Real REALARO (4) array of elements specifying values REALAR(12) through REALAR(15)
as described above(output).
REALARO(1) firing angle (returned)
REALARO(2) dc voltage (kV) (returned)
REALARO(3) real power into converter (PWRCOD) (re-
turned)
REALARO(4) reactive power into converter (PWRCOD) (re-
turned)
Character*2 ID ac transformer circuit identifier, IDR or IDI (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 converter type is not 1 or 2
IERR = 3 transformer circuit identifier is more than two
characters
IERR = 4 no converter bus is specified
IERR = 5 converter bus not found
IERR = 6 node-breaker terminal connection table is full
IERR = 7 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Converter bus is
dummy bus of a multi-section line. - Mul-
ti-section line grouping deleted. - Converter
maximum angle is less than its minimum an-
gle. - Converter maximum tap is less than its
minimum tap. - Invalid tap step. - Commutat-
ing bus not found. - ac transformer bus not
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
895
Power Flow TWO_TERM_DC_CONVERTER_DATA_3
found. - Specified branch not found. - Speci-
fied branch is not a transformer. - From bus of
specified branch is not winding one side bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
896
Power Flow TWO_TERM_DC_CONVR_DATA
1.2.138. TWO_TERM_DC_CONVR_DATA
This API routine is obsolete. It has been replaced by the API routine two_term_dc_converter_data_3 .
Use this API to modify the data of a dc converter of an existing two-terminal dc line in the working case
(see PSSE Program Operation Manual, Area Interchange Data). The dc line must have previously been spec-
ified via the TWO_TERMINAL_DC_LINE_DATA API.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_TWO_TERM_DC_CONVR_DATA CNVFLG DC INTGAR(1)..INTGAR(5)
REALAR(1)..REALAR(11) 'ID'
Python command syntax:
ierr, realaro = two_term_dc_convr_data(cnvflg, dc, intgar, realari, id)
Fortran command syntax:
CALL TWO_TERMINAL_DC_CONVERTER_API (CNVFLG, NUM, INTGAR, REALAR, ID, IERR)
CALL TWO_TERMINAL_DC_CONVERTER_API_I (CNVFLG, NUM, INTGAR, REALAR, ID,
IERR)
CALL TWO_TERMINAL_DC_CONVERTER_API_C (CNVFLG, NAME, INTGAR, REALAR, ID,
IERR)
Where:
Integer CNVFLG converter type (input; no default allowed).
CNVFLG = 1 for rectifier data.
CNVFLG = 2 for inverter data.
Integer or Character*12 DC quoted name of the two-terminal dc line for which data for one of
its converters is to be specified; if an unquoted integer value is spec-
ified, the API converts it to a left-justified name (input; no default al-
lowed).
Integer NUM number (which the API converts to a left-justified name) of the two-
terminal dc line for which data for one of its converters is to be speci-
fied; no default allowed
Character*12 NAME name of the two-terminal dc line for which data for one of its con-
verters is to be specified; no default allowed
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) IPR or IPI, converter bus number (no default
allowed)
INTGAR(2) NBR or NBI, number of bridges in series (0 by
default)
INTGAR(3) ICR or ICI, zero or bus number of firing angle
bus (0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
897
Power Flow TWO_TERM_DC_CONVR_DATA
INTGAR(4) IFR or IFI, zero or bus number of winding one
side of a two-winding ac transformer (0 by
default)
INTGAR(5) ITR or ITI, zero or bus number of winding two
side of a two-winding ac transformer (0 by
default)
Real REALAR (15) (first eleven are input values; last four are output values) (input (out-
put).).
Real REALARI (11) array of elements specifying values REALAR(1) through REALAR(11)
as described above(input).
REALARI(1) NR or ANMNI, minimum firing angle (90.0 by
default)
REALARI(2) XR or ANMXI, maximum firing angle (0.0 by
default)
REALARI(3) RCR or RCI, commutating resistance (0.0 by
default)
REALARI(4) XCR or XCI, commutating reactance (0.0 by
default)
REALARI(5) EBASR or EBASI, primary base ac voltage (0.0
by default)
REALARI(6) TRR or TRI, transformer ratio (1.0 by default)
REALARI(7) TAPR or TAPI, tap setting (1.0 by default)
REALARI(8) TMXR or TMXI, maximum tap setting (1.5 by
default)
REALARI(9) TMNR or TMNI, minimum tap setting (0.51
by default)
REALARI(10) STPR or STPI, tap step (0.00625 by default)
REALARI(11) XCAPR or XCAPI, capacitive reactance of CCC
type converter (0.0 by default)
Real REALARO (4) array of elements specifying values REALAR(12) through REALAR(15)
as described above(output).
REALARO(1) firing angle (returned)
REALARO(2) dc voltage (kV) (returned)
REALARO(3) real power into converter (PWRCOD) (re-
turned)
REALARO(4) reactive power into converter (PWRCOD) (re-
turned)
Character*2 ID ac transformer circuit identifier, IDR or IDI (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 dc line not found
IERR = 2 converter type is not 1 or 2
IERR = 3 transformer circuit identifier is more than two
characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
898
Power Flow TWO_TERM_DC_CONVR_DATA
IERR = 4 no converter bus is specified
IERR = 5 converter bus not found
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Converter bus is
dummy bus of a multi-section line. - Mul-
ti-section line grouping deleted. - Converter
maximum angle is less than its minimum an-
gle. - Converter maximum tap is less than its
minimum tap. - Invalid tap step. - Commutat-
ing bus not found. - ac transformer bus not
found. - Specified branch not found. - Speci-
fied branch is not a transformer. - From bus of
specified branch is not winding one side bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
899
Power Flow TWO_WINDING_CHNG_4
1.2.139. TWO_WINDING_CHNG_4
This API routine is obsolete. It has been replaced by the API routine two_winding_chng_5 .
Use this API routine to modify the data of an existing two-winding transformer in the working case (see
PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_TWO_WINDING_CHNG_4 IBUS JBUS 'CKT' INTGAR(1)..INTGAR(15)
REALAR(1)..REALAR(24) 'CHARAR(1)' 'CHARAR(2)'
Python command syntax:
ierr, realaro = two_winding_chng_4(ibus, jbus, ckt, intgar, realari,
charar)
Fortran command syntax:
CALL TWO_WINDING_CHNG_4(IBUS, JBUS, CKT, INTGAR, REALAR, CHARAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (15) array of 15 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(12) COD1, adjustment control mode flag (-5
through +5) (0 by default)
INTGAR(13) CW, winding data I/O code (1 by default)
INTGAR(14) CZ, impedance data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
900
Power Flow TWO_WINDING_CHNG_4
INTGAR(15) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (26) (first twenty-four are input values; last two are output values) (input
(output).).
Real REALARI (24) array of 24 elements specifying corresponding to values REALAR(1)
through REALAR(24) as described above(input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) RATA1, rating set A line rating (0.0 by de-
fault)
REALARI(10) RATB1, rating set B line rating (0.0 by de-
fault)
REALARI(11) RATC1, rating set C line rating (0.0 by de-
fault)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (1.0 by default)
REALARI(14) F3, third owner fraction (1.0 by default)
REALARI(15) F4, fourth owner fraction (1.0 by default)
REALARI(16) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(17) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(18) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(19) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(20) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(21) VMI1, voltage or flow lower limit (0.9 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
901
Power Flow TWO_WINDING_CHNG_4
REALARI(22) CR1, load drop compensating resistance (0.0
by default)
REALARI(23) CX1, load drop compensating reactance (0.0
by default)
REALARI(24) CNXA1, winding connection angle (0.0 by
default). Used with adjustment control mode
5 (unsymmatric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(25)
through REALAR(26) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) NAME, transformer name (blank by default)
CHARAR(2) VGRP, vector group name (blank by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 12 two-winding transformer not found
IERR = 13 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - invalid winding 1 side bus num-
ber - invalid CW, CZ and/or CM data value -
controlled bus not found - invalid adjustment
control mode flag - invalid impedance cor-
rection table number - invalid number of tap
positions - winding nominal voltage is neg-
ative - winding bus base voltage and nom-
inal voltage differ by more than 20% - in-
valid winding voltage - winding voltage and
bus base voltage differ by more than 50% -
RMAX is greater than 150% of bus base volt-
age - RMIN is less than 50% of bus base volt-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
902
Power Flow TWO_WINDING_CHNG_4
age - invalid tap ratio - tap ratio is outside
the band 0.5 to 1.5 pu - RMAX is greater than
1.5 - RMIN is less than 0.5 - RMAX is less than
RMIN - VMAX is less than VMIN - phase shift
angle normalized between -180 and 180 -
winding base MVA must be positive - MAG1
is too big relative to MAG2 at winding base
MVA - magnetizing susceptance MAG2 is pos-
itive - losses are too big relative to total im-
pedance at winding base MVA - branch reac-
tance is 0.0 - winding 1 and winding 2 sides
are interchanged (any two-terminal dc lines
controlled by this transformer are logged).
- winding connection angle normalized be-
tween -360 and 360 - adjustment control
mode flag and the winding connection an-
gle are inconsistent. - for asymmetric phase
shifter, abnormally large or small tap setting
results at RMA1 (or RMI1) and CNXA1. - for
asymmetric phase shifter, the specified and
derived winding tap settings differ. - Vector
group not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
903
Power Flow TWO_WINDING_CHNG_5
1.2.140. TWO_WINDING_CHNG_5
This API routine is obsolete. It has been replaced by the API routine two_winding_chng_6 .
Use this API routine to modify the data of an existing two-winding transformer in the working case (see
PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_TWO_WINDING_CHNG_5 IBUS JBUS CKT INTGAR(1)..INTGAR(15)
REALAR(1)..REALAR(21) RATINGS(1)..RATINGS(12) NAMEAR VGRPAR
Python command syntax:
ierr, realaro = two_winding_chng_5(ibus, jbus, ckt, intgar, realari,
ratings, namear, vgrpar)
Fortran command syntax:
CALL TWO_WINDING_CHNG_5(IBUS, JBUS, CKT, INTGAR, REALAR, RATINGS, NAMEAR,
VGRPAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (15) array of 15 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(12) COD1, adjustment control mode flag (-5
through +5) (0 by default)
INTGAR(13) CW, winding data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
904
Power Flow TWO_WINDING_CHNG_5
INTGAR(14) CZ, impedance data I/O code (1 by default)
INTGAR(15) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (23) (first twenty-four are input values; last two are output values) (input
(output).).
Real REALARI (21) array of 21 elements specifying (input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) F1, first owner fraction (1.0 by default)
REALARI(10) F2, second owner fraction (1.0 by default)
REALARI(11) F3, third owner fraction (1.0 by default)
REALARI(12) F4, fourth owner fraction (1.0 by default)
REALARI(13) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(14) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(15) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(16) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(17) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(18) VMI1, voltage or flow lower limit (0.9 by de-
fault)
REALARI(19) CR1, load drop compensating resistance (0.0
by default)
REALARI(20) CX1, load drop compensating reactance (0.0
by default)
REALARI(21) CNXA1, winding connection angle (0.0 by
default). Used with adjustment control mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
905
Power Flow TWO_WINDING_CHNG_5
5 (unsymmatric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(25)
through REALAR(26) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1, rating set 1 line rating (alias is RATE1)
(0.0 by default)
RATINGS(2) RATE2, rating set 2 line rating (alias is RATE2)
(0.0 by default)
RATINGS(3) RATE3, rating set 3 line rating (alias is RATE3)
(0.0 by default)
RATINGS(4) RATE4, rating set 4 line rating (alias is RATE4)
(0.0 by default)
RATINGS(5) RATE5, rating set 5 line rating (alias is RATE5)
(0.0 by default)
RATINGS(6) RATE6, rating set 6 line rating (alias is RATE6)
(0.0 by default)
RATINGS(7) RATE7, rating set 7 line rating (alias is RATE7)
(0.0 by default)
RATINGS(8) RATE8, rating set 8 line rating (alias is RATE8)
(0.0 by default)
RATINGS(9) RATE9, rating set 9 line rating (alias is RATE9)
(0.0 by default)
RATINGS(10) RATE10, rating set 10 line rating (alias is
RATE10) (0.0 by default)
RATINGS(11) RATE11, rating set 11 line rating (alias is
RATE11) (0.0 by default)
RATINGS(12) RATE12, rating set 12 line rating (alias is
RATE12) (0.0 by default)
Character*40 NAMEAR transformer name (input; blank by default).
Character*12 VGRPAR vector group name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &, * or @
IERR = 7 branch table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
906
Power Flow TWO_WINDING_CHNG_5
IERR = 8 branch ownership table is full
IERR = 9 two-winding transformer table is full
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 13 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - invalid winding 1 side bus num-
ber - invalid CW, CZ and/or CM data value -
controlled bus not found - invalid adjustment
control mode flag - invalid impedance cor-
rection table number - invalid number of tap
positions - winding nominal voltage is neg-
ative - winding bus base voltage and nom-
inal voltage differ by more than 20% - in-
valid winding voltage - winding voltage and
bus base voltage differ by more than 50% -
RMAX is greater than 150% of bus base volt-
age - RMIN is less than 50% of bus base volt-
age - invalid tap ratio - tap ratio is outside
the band 0.5 to 1.5 pu - RMAX is greater than
1.5 - RMIN is less than 0.5 - RMAX is less than
RMIN - VMAX is less than VMIN - phase shift
angle normalized between -180 and 180 -
winding base MVA must be positive - MAG1
is too big relative to MAG2 at winding base
MVA - magnetizing susceptance MAG2 is pos-
itive - losses are too big relative to total im-
pedance at winding base MVA - branch reac-
tance is 0.0 - winding 1 and winding 2 sides
are interchanged (any two-terminal dc lines
controlled by this transformer are logged).
- winding connection angle normalized be-
tween -360 and 360 - adjustment control
mode flag and the winding connection an-
gle are inconsistent. - for asymmetric phase
shifter, abnormally large or small tap setting
results at RMA1 (or RMI1) and CNXA1. - for
asymmetric phase shifter, the specified and
derived winding tap settings differ. - vector
group not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
907
Power Flow TWO_WINDING_CHNG_6
1.2.141. TWO_WINDING_CHNG_6
Use this API routine to modify the data of an existing two-winding transformer in the working case (see
PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_TWO_WINDING_CHNG_6( IBUS JBUS CKT INTGAR(1)..INTGAR(16)
REALAR(1)..REALAR(21) RATINGS(1)..RATINGS(12) NAMEAR VGRPAR
Python command syntax:
ierr, realaro = two_winding_chng_6(ibus, jbus, ckt, intgar, realari,
ratings, namear, vgrpar)
Fortran command syntax:
CALL TWO_WINDING_CHNG_6(IBUS, JBUS, CKT, INTGAR, REALAR, RATINGS, NAMEAR,
VGRPAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (16) array of 16 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) NODE1, controlled node number (0 by de-
fault)
INTGAR(12) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(13) COD1, adjustment control mode flag (-5
through +5) (0 by default)
INTGAR(14) CW, winding data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
908
Power Flow TWO_WINDING_CHNG_6
INTGAR(15) CZ, impedance data I/O code (1 by default)
INTGAR(16) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (23) (first twenty-one are input values; last two are output values) (input
(output).).
Real REALARI (21) array of 21 elements specifying (input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) F1, first owner fraction (1.0 by default)
REALARI(10) F2, second owner fraction (1.0 by default)
REALARI(11) F3, third owner fraction (1.0 by default)
REALARI(12) F4, fourth owner fraction (1.0 by default)
REALARI(13) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(14) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(15) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(16) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(17) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(18) VMI1, voltage or flow lower limit (0.9 by de-
fault)
REALARI(19) CR1, load drop compensating resistance (0.0
by default)
REALARI(20) CX1, load drop compensating reactance (0.0
by default)
REALARI(21) CNXA1, winding connection angle (0.0 by
default). Used with adjustment control mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
909
Power Flow TWO_WINDING_CHNG_6
5 (unsymmatric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(25)
through REALAR(26) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1, rating set 1 line rating (alias is RATE1)
(0.0 by default)
RATINGS(2) RATE2, rating set 2 line rating (alias is RATE2)
(0.0 by default)
RATINGS(3) RATE3, rating set 3 line rating (alias is RATE3)
(0.0 by default)
RATINGS(4) RATE4, rating set 4 line rating (alias is RATE4)
(0.0 by default)
RATINGS(5) RATE5, rating set 5 line rating (alias is RATE5)
(0.0 by default)
RATINGS(6) RATE6, rating set 6 line rating (alias is RATE6)
(0.0 by default)
RATINGS(7) RATE7, rating set 7 line rating (alias is RATE7)
(0.0 by default)
RATINGS(8) RATE8, rating set 8 line rating (alias is RATE8)
(0.0 by default)
RATINGS(9) RATE9, rating set 9 line rating (alias is RATE9)
(0.0 by default)
RATINGS(10) RATE10, rating set 10 line rating (alias is
RATE10) (0.0 by default)
RATINGS(11) RATE11, rating set 11 line rating (alias is
RATE11) (0.0 by default)
RATINGS(12) RATE12, rating set 12 line rating (alias is
RATE12) (0.0 by default)
Character*40 NAMEAR transformer name (input; blank by default).
Character*12 VGRPAR vector group name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &, * or @
IERR = 7 branch table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
910
Power Flow TWO_WINDING_CHNG_6
IERR = 8 branch ownership table is full
IERR = 9 two-winding transformer table is full
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 12 branch not found
IERR = 13 node-breaker terminal connection table is full
IERR = 14 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - invalid winding 1 side bus num-
ber - invalid CW, CZ and/or CM data value -
controlled bus not found - invalid adjustment
control mode flag - invalid impedance correc-
tion table number - invalid number of tap po-
sitions - winding nominal voltage is negative
- winding bus base voltage and nominal volt-
age differ by more than 20% - invalid wind-
ing voltage - winding voltage and bus base
voltage differ by more than 50% - RMAX is
greater than 150% of bus base voltage - RMIN
is less than 50% of bus base voltage - invalid
tap ratio - tap ratio is outside the band 0.5 to
1.5 pu - RMAX is greater than 1.5 - RMIN is
less than 0.5 - RMAX is less than RMIN - VMAX
is less than VMIN - phase shift angle normal-
ized between -180 and 180 - winding base
MVA must be positive - MAG1 is too big rel-
ative to MAG2 at winding base MVA - mag-
netizing susceptance MAG2 is positive - loss-
es are too big relative to total impedance at
winding base MVA - branch reactance is 0.0
- winding 1 and winding 2 sides are inter-
changed (any two-terminal dc lines controlled
by this transformer are logged). - winding
connection angle normalized between -360
and 360 - adjustment control mode flag and
the winding connection angle are inconsis-
tent. - for asymmetric phase shifter, abnor-
mally large or small tap setting results at
RMA1 (or RMI1) and CNXA1. - for asymmet-
ric phase shifter, the specified and derived
winding tap settings differ. - vector group not
found - Invalid node number - Non-zero con-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
911
Power Flow TWO_WINDING_CHNG_6
trolled node specified but controlled bus does
not belong to a substation - Controlled node
not found - Controlled node is not connect-
ed to any bus section of the regulated bus -
Controlled bus is 0 but a non-zero controlled
node is specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
912
Power Flow TWO_WINDING_DATA
1.2.142. TWO_WINDING_DATA
This API routine is obsolete. It has been replaced by the API routine two_winding_data_3 .
Use this API to modify the data of an existing two-winding transformer in the working case, or to add a
new two-winding transformer to the working case (see PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_TWO_WINDING_DATA IBUS JBUS 'CKT' INTGAR(1)..INTGAR(15)
REALAR(1)..REALAR(23) 'NAME'
Python command syntax:
ierr, realaro = two_winding_data(ibus, jbus, ckt, intgar, realari, name)
Fortran command syntax:
CALL TWO_WINDING_API_2(IBUS, JBUS, CKT, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (15) array of 15 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(12) COD1, adjustment control mode flag (-4
through +4) (0 by default)
INTGAR(13) CW, winding data I/O code (1 by default)
INTGAR(14) CZ, impedance data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
913
Power Flow TWO_WINDING_DATA
INTGAR(15) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (25) (first twenty-three are input values; last two are ouptut values) (input
(output).).
Real REALARI (23) array of 23 elements specifying corresponding to values REALAR(1)
through REALAR(23) as described above(input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) RATA1, rating set A line rating (0.0 by de-
fault)
REALARI(10) RATB1, rating set B line rating (0.0 by de-
fault)
REALARI(11) RATC1, rating set C line rating (0.0 by de-
fault)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (1.0 by default)
REALARI(14) F3, third owner fraction (1.0 by default)
REALARI(15) F4, fourth owner fraction (1.0 by default)
REALARI(16) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(17) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(18) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(19) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(20) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(21) VMI1, voltage or flow lower limit (0.9 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
914
Power Flow TWO_WINDING_DATA
REALARI(22) CR1, load drop compensating resistance (0.0
by default)
REALARI(23) CX1, load drop compensating reactance (0.0
by default)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(24)
through REALAR(25) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Character*12 NAME transformer name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &, * or @
IERR = 7 branch table is full
IERR = 8 branch ownership table is full
IERR = 9 two-winding transformer table is full
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 13 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - invalid winding 1 side bus num-
ber - invalid CW, CZ and/or CM data value -
controlled bus not found - invalid adjustment
control mode flag - invalid impedance correc-
tion table number - invalid number of tap po-
sitions - winding nominal voltage is negative
- winding bus base voltage and nominal volt-
age differ by more than 20% - invalid wind-
ing voltage - winding voltage and bus base
voltage differ by more than 50% - RMAX is
greater than 150% of bus base voltage - RMIN
is less than 50% of bus base voltage - invalid
tap ratio - tap ratio is outside the band 0.5 to
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
915
Power Flow TWO_WINDING_DATA
1.5 pu - RMAX is greater than 1.5 - RMIN is
less than 0.5 - RMAX is less than RMIN - VMAX
is less than VMIN - phase shift angle normal-
ized between -180 and 180 - winding base
MVA must be positive - MAG1 is too big rel-
ative to MAG2 at winding base MVA - loss-
es are too big relative to total impedance at
winding base MVA - branch reactance is 0.0
- winding 1 and winding 2 sides are inter-
changed (any two-terminal dc lines controlled
by this transformer are logged)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
916
Power Flow TWO_WINDING_DATA_3
1.2.143. TWO_WINDING_DATA_3
This API routine is obsolete. It has been replaced by the API routine two_winding_data_4 .
Use this API to modify the data of an existing two-winding transformer in the working case, or to add a
new two-winding transformer to the working case (see PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_TWO_WINDING_DATA_3 IBUS JBUS 'CKT' INTGAR(1)..INTGAR(15)
REALAR(1)..REALAR(24) 'NAME'
Python command syntax:
ierr, realaro = two_winding_data_3(ibus, jbus, ckt, intgar, realari, name)
Fortran command syntax:
CALL TWO_WINDING_API_3(IBUS, JBUS, CKT, INTGAR, REALAR, NAME, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (15) array of 15 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(12) COD1, adjustment control mode flag (-5
through +5) (0 by default)
INTGAR(13) CW, winding data I/O code (1 by default)
INTGAR(14) CZ, impedance data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
917
Power Flow TWO_WINDING_DATA_3
INTGAR(15) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (26) (first twenty-four are input values; last two are output values) (input
(output).).
Real REALARI (24) array of 24 elements specifying corresponding to values REALAR(1)
through REALAR(24) as described above(input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) RATA1, rating set A line rating (0.0 by de-
fault)
REALARI(10) RATB1, rating set B line rating (0.0 by de-
fault)
REALARI(11) RATC1, rating set C line rating (0.0 by de-
fault)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (1.0 by default)
REALARI(14) F3, third owner fraction (1.0 by default)
REALARI(15) F4, fourth owner fraction (1.0 by default)
REALARI(16) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(17) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(18) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(19) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(20) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(21) VMI1, voltage or flow lower limit (0.9 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
918
Power Flow TWO_WINDING_DATA_3
REALARI(22) CR1, load drop compensating resistance (0.0
by default)
REALARI(23) CX1, load drop compensating reactance (0.0
by default)
REALARI(24) CNXA1, winding connection angle (0.0 by
default). Used with adjustment control mode
5 (unsymmatric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(25)
through REALAR(26) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Character*12 NAME transformer name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &, * or @
IERR = 7 branch table is full
IERR = 8 branch ownership table is full
IERR = 9 two-winding transformer table is full
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 13 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - invalid winding 1 side bus num-
ber - invalid CW, CZ and/or CM data value -
controlled bus not found - invalid adjustment
control mode flag - invalid impedance correc-
tion table number - invalid number of tap po-
sitions - winding nominal voltage is negative
- winding bus base voltage and nominal volt-
age differ by more than 20% - invalid wind-
ing voltage - winding voltage and bus base
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
919
Power Flow TWO_WINDING_DATA_3
voltage differ by more than 50% - RMAX is
greater than 150% of bus base voltage - RMIN
is less than 50% of bus base voltage - invalid
tap ratio - tap ratio is outside the band 0.5 to
1.5 pu - RMAX is greater than 1.5 - RMIN is
less than 0.5 - RMAX is less than RMIN - VMAX
is less than VMIN - phase shift angle normal-
ized between -180 and 180 - winding base
MVA must be positive - MAG1 is too big rel-
ative to MAG2 at winding base MVA - mag-
netizing susceptance MAG2 is positive - loss-
es are too big relative to total impedance at
winding base MVA - branch reactance is 0.0
- winding 1 and winding 2 sides are inter-
changed (any two-terminal dc lines controlled
by this transformer are logged). - winding
connection angle normalized between -360
and 360 - adjustment control mode flag and
the winding connection angle are inconsis-
tent. - for asymmetric phase shifter, abnor-
mally large or small tap setting results at
RMA1 (or RMI1) and CNXA1. - for asymmetric
phase shifter, the specified and derived wind-
ing tap settings differ
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
920
Power Flow TWO_WINDING_DATA_4
1.2.144. TWO_WINDING_DATA_4
This API routine is obsolete. It has been replaced by the API routine two_winding_data_5 .
Use this API to modify the data of an existing two-winding transformer in the working case, or to add a
new two-winding transformer to the working case (see PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_TWO_WINDING_DATA_4 IBUS JBUS 'CKT' INTGAR(1)..INTGAR(15)
REALAR(1)..REALAR(24) 'CHARAR(1)' 'CHARAR(2)'
Python command syntax:
ierr, realaro = two_winding_data_4(ibus, jbus, ckt, intgar, realari,
charar)
Fortran command syntax:
CALL TWO_WINDING_API_4(IBUS, JBUS, CKT, INTGAR, REALAR, CHARAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (15) array of 15 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(12) COD1, adjustment control mode flag (-5
through +5) (0 by default)
INTGAR(13) CW, winding data I/O code (1 by default)
INTGAR(14) CZ, impedance data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
921
Power Flow TWO_WINDING_DATA_4
INTGAR(15) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (26) (first twenty-four are input values; last two are output values) (input
(output).).
Real REALARI (24) array of 24 elements specifying corresponding to values REALAR(1)
through REALAR(24) as described above(input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) RATA1, rating set A line rating (0.0 by de-
fault)
REALARI(10) RATB1, rating set B line rating (0.0 by de-
fault)
REALARI(11) RATC1, rating set C line rating (0.0 by de-
fault)
REALARI(12) F1, first owner fraction (1.0 by default)
REALARI(13) F2, second owner fraction (1.0 by default)
REALARI(14) F3, third owner fraction (1.0 by default)
REALARI(15) F4, fourth owner fraction (1.0 by default)
REALARI(16) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(17) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(18) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(19) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(20) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(21) VMI1, voltage or flow lower limit (0.9 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
922
Power Flow TWO_WINDING_DATA_4
REALARI(22) CR1, load drop compensating resistance (0.0
by default)
REALARI(23) CX1, load drop compensating reactance (0.0
by default)
REALARI(24) CNXA1, winding connection angle (0.0 by
default). Used with adjustment control mode
5 (unsymmatric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(25)
through REALAR(26) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) NAME, transformer name (blank by default)
CHARAR(2) VGRP, vector group name (blank by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &, * or @
IERR = 7 branch table is full
IERR = 8 branch ownership table is full
IERR = 9 two-winding transformer table is full
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 13 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - invalid winding 1 side bus num-
ber - invalid CW, CZ and/or CM data value -
controlled bus not found - invalid adjustment
control mode flag - invalid impedance cor-
rection table number - invalid number of tap
positions - winding nominal voltage is neg-
ative - winding bus base voltage and nom-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
923
Power Flow TWO_WINDING_DATA_4
inal voltage differ by more than 20% - in-
valid winding voltage - winding voltage and
bus base voltage differ by more than 50% -
RMAX is greater than 150% of bus base volt-
age - RMIN is less than 50% of bus base volt-
age - invalid tap ratio - tap ratio is outside
the band 0.5 to 1.5 pu - RMAX is greater than
1.5 - RMIN is less than 0.5 - RMAX is less than
RMIN - VMAX is less than VMIN - phase shift
angle normalized between -180 and 180 -
winding base MVA must be positive - MAG1
is too big relative to MAG2 at winding base
MVA - magnetizing susceptance MAG2 is pos-
itive - losses are too big relative to total im-
pedance at winding base MVA - branch reac-
tance is 0.0 - winding 1 and winding 2 sides
are interchanged (any two-terminal dc lines
controlled by this transformer are logged).
- winding connection angle normalized be-
tween -360 and 360 - adjustment control
mode flag and the winding connection an-
gle are inconsistent. - for asymmetric phase
shifter, abnormally large or small tap setting
results at RMA1 (or RMI1) and CNXA1. - for
asymmetric phase shifter, the specified and
derived winding tap settings differ. - vector
group not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
924
Power Flow TWO_WINDING_DATA_5
1.2.145. TWO_WINDING_DATA_5
This API routine is obsolete. It has been replaced by the API routine two_winding_data_6 .
Use this API to modify the data of an existing two-winding transformer in the working case, or to add a
new two-winding transformer to the working case (see PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_TWO_WINDING_DATA_5 IBUS JBUS CKT INTGAR(1)..INTGAR(15)
REALAR(1)..REALAR(21) RATINGS(1)..RATINGS(12) NAMEAR VGRPAR
Python command syntax:
ierr, realaro = two_winding_data_5(ibus, jbus, ckt, intgar, realari,
ratings, namear, vgrpar)
Fortran command syntax:
CALL TWO_WINDING_DATA_5(IBUS, JBUS, CKT, INTGAR, REALAR, RATINGS, NAMEAR,
VGRPAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (15) array of 15 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(12) COD1, adjustment control mode flag (-5
through +5) (0 by default)
INTGAR(13) CW, winding data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
925
Power Flow TWO_WINDING_DATA_5
INTGAR(14) CZ, impedance data I/O code (1 by default)
INTGAR(15) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (23) (first twenty-one are input values; last two are output values) (input
(output).).
Real REALARI (21) array of 21 elements specifying (input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) F1, first owner fraction (1.0 by default)
REALARI(10) F2, second owner fraction (1.0 by default)
REALARI(11) F3, third owner fraction (1.0 by default)
REALARI(12) F4, fourth owner fraction (1.0 by default)
REALARI(13) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(14) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(15) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(16) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(17) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(18) VMI1, voltage or flow lower limit (0.9 by de-
fault)
REALARI(19) CR1, load drop compensating resistance (0.0
by default)
REALARI(20) CX1, load drop compensating reactance (0.0
by default)
REALARI(21) CNXA1, winding connection angle (0.0 by
default). Used with adjustment control mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
926
Power Flow TWO_WINDING_DATA_5
5 (unsymmatric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(25)
through REALAR(26) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1, rating set 1 line rating (alias is RATE1)
(0.0 by default)
RATINGS(2) RATE2, rating set 2 line rating (alias is RATE2)
(0.0 by default)
RATINGS(3) RATE3, rating set 3 line rating (alias is RATE3)
(0.0 by default)
RATINGS(4) RATE4, rating set 4 line rating (alias is RATE4)
(0.0 by default)
RATINGS(5) RATE5, rating set 5 line rating (alias is RATE5)
(0.0 by default)
RATINGS(6) RATE6, rating set 6 line rating (alias is RATE6)
(0.0 by default)
RATINGS(7) RATE7, rating set 7 line rating (alias is RATE7)
(0.0 by default)
RATINGS(8) RATE8, rating set 8 line rating (alias is RATE8)
(0.0 by default)
RATINGS(9) RATE9, rating set 9 line rating (alias is RATE9)
(0.0 by default)
RATINGS(10) RATE10, rating set 10 line rating (alias is
RATE10) (0.0 by default)
RATINGS(11) RATE11, rating set 11 line rating (alias is
RATE11) (0.0 by default)
RATINGS(12) RATE12, rating set 12 line rating (alias is
RATE12) (0.0 by default)
Character*40 NAMEAR transformer name (input; blank by default).
Character*12 VGRPAR vector group name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &, * or @
IERR = 7 branch table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
927
Power Flow TWO_WINDING_DATA_5
IERR = 8 branch ownership table is full
IERR = 9 two-winding transformer table is full
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 13 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - invalid winding 1 side bus num-
ber - invalid CW, CZ and/or CM data value -
controlled bus not found - invalid adjustment
control mode flag - invalid impedance cor-
rection table number - invalid number of tap
positions - winding nominal voltage is neg-
ative - winding bus base voltage and nom-
inal voltage differ by more than 20% - in-
valid winding voltage - winding voltage and
bus base voltage differ by more than 50% -
RMAX is greater than 150% of bus base volt-
age - RMIN is less than 50% of bus base volt-
age - invalid tap ratio - tap ratio is outside
the band 0.5 to 1.5 pu - RMAX is greater than
1.5 - RMIN is less than 0.5 - RMAX is less than
RMIN - VMAX is less than VMIN - phase shift
angle normalized between -180 and 180 -
winding base MVA must be positive - MAG1
is too big relative to MAG2 at winding base
MVA - magnetizing susceptance MAG2 is pos-
itive - losses are too big relative to total im-
pedance at winding base MVA - branch reac-
tance is 0.0 - winding 1 and winding 2 sides
are interchanged (any two-terminal dc lines
controlled by this transformer are logged).
- winding connection angle normalized be-
tween -360 and 360 - adjustment control
mode flag and the winding connection an-
gle are inconsistent. - for asymmetric phase
shifter, abnormally large or small tap setting
results at RMA1 (or RMI1) and CNXA1. - for
asymmetric phase shifter, the specified and
derived winding tap settings differ. - vector
group not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
928
Power Flow TWO_WINDING_DATA_6
1.2.146. TWO_WINDING_DATA_6
Use this API to modify the data of an existing two-winding transformer in the working case, or to add a
new two-winding transformer to the working case (see PSSE Program Operation Manual, Owner Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_TWO_WINDING_DATA_6 IBUS JBUS CKT INTGAR(1)..INTGAR(16)
REALAR(1)..REALAR(21) RATINGS(1)..RATINGS(12) NAMEAR VGRPAR
Python command syntax:
ierr, realaro = two_winding_data_6(ibus, jbus, ckt, intgar, realari,
ratings, namear, vgrpar)
Fortran command syntax:
CALL TWO_WINDING_DATA_6(IBUS, JBUS, CKT, INTGAR, REALAR, RATINGS, NAMEAR,
VGRPAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (16) array of 16 elements specifying (input).
INTGAR(1) STAT, branch status (1 by default)
INTGAR(2) METBUS, metered end bus number (IBUS or
JBUS) (IBUS by default)
INTGAR(3) O1, first owner number (owner of bus IBUS
by default)
INTGAR(4) O2, second owner number (0 by default)
INTGAR(5) O3, third owner number (0 by default)
INTGAR(6) O4, fourth owner number (0 by default)
INTGAR(7) NTP1, number of tap positions (33 by de-
fault)
INTGAR(8) TAB1, impedance correction table number (0
by default)
INTGAR(9) WN1BUS, winding one side bus number
(IBUS or JBUS) (IBUS by default)
INTGAR(10) CONT1, controlled bus number (0 by default)
INTGAR(11) NODE1, controlled node number (0 by de-
fault)
INTGAR(12) SICOD1, negative for controlled bus on wind-
ing one side (1 by default)
INTGAR(13) COD1, adjustment control mode flag (-5
through +5) (0 by default)
INTGAR(14) CW, winding data I/O code (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
929
Power Flow TWO_WINDING_DATA_6
INTGAR(15) CZ, impedance data I/O code (1 by default)
INTGAR(16) CM, magnetizing admittance data I/O code
(1 by default)
Real REALAR (23) (first twenty-one are input values; last two are output values) (input
(output).).
Real REALARI (21) array of 21 elements specifying (input).
REALARI(1) R1-2, nominal transformer resistance (0.0 by
default)
REALARI(2) X1-2, nominal transformer reactance
(THRSHZ by default; 0.0001 if THRSHZ = 0.0)
REALARI(3) SBS1-2, winding base MVA (SBASE by de-
fault)
REALARI(4) WINDV1, winding one ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
IBUS by default if CW is 2)
REALARI(5) NOMV1, winding one nominal voltage (0.0
by default)
REALARI(6) 1, winding one phase shift angle (0.0 by de-
fault)
REALARI(7) WINDV2, winding two ratio/voltage (1.0 by
default if CW is 1 or 3; base voltage of bus
JBUS by default if CW is 2)
REALARI(8) NOMV2, winding two nominal voltage (0.0
by default)
REALARI(9) F1, first owner fraction (1.0 by default)
REALARI(10) F2, second owner fraction (1.0 by default)
REALARI(11) F3, third owner fraction (1.0 by default)
REALARI(12) F4, fourth owner fraction (1.0 by default)
REALARI(13) MAG1, magnetizing conductance or no-load
losses (0.0 by default)
REALARI(14) MAG2, magnetizing susceptance or exciting
current (0.0 by default)
REALARI(15) RMA1, winding one ratio/angle high limit
(1.1 by default)
REALARI(16) RMI1, winding one ratio/angle low limit (0.9
by default)
REALARI(17) VMA1, voltage or flow upper limit (1.1 by de-
fault)
REALARI(18) VMI1, voltage or flow lower limit (0.9 by de-
fault)
REALARI(19) CR1, load drop compensating resistance (0.0
by default)
REALARI(20) CX1, load drop compensating reactance (0.0
by default)
REALARI(21) CNXA1, winding connection angle (0.0 by
default). Used with adjustment control mode
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
930
Power Flow TWO_WINDING_DATA_6
5 (unsymmatric phase shift control of active
power) implemented in PSSE version 32.1)
Real REALARO (2) array of 2 elements specifying corresponding to values REALAR(25)
through REALAR(26) as described above(output).
REALARO(1) actual transformer resistance (returned)
REALARO(2) actual transformer reactance (returned)
Real RATINGS (12) array of 12 elements specifying (input).
RATINGS(1) RATE1, rating set 1 line rating (alias is RATE1)
(0.0 by default)
RATINGS(2) RATE2, rating set 2 line rating (alias is RATE2)
(0.0 by default)
RATINGS(3) RATE3, rating set 3 line rating (alias is RATE3)
(0.0 by default)
RATINGS(4) RATE4, rating set 4 line rating (alias is RATE4)
(0.0 by default)
RATINGS(5) RATE5, rating set 5 line rating (alias is RATE5)
(0.0 by default)
RATINGS(6) RATE6, rating set 6 line rating (alias is RATE6)
(0.0 by default)
RATINGS(7) RATE7, rating set 7 line rating (alias is RATE7)
(0.0 by default)
RATINGS(8) RATE8, rating set 8 line rating (alias is RATE8)
(0.0 by default)
RATINGS(9) RATE9, rating set 9 line rating (alias is RATE9)
(0.0 by default)
RATINGS(10) RATE10, rating set 10 line rating (alias is
RATE10) (0.0 by default)
RATINGS(11) RATE11, rating set 11 line rating (alias is
RATE11) (0.0 by default)
RATINGS(12) RATE12, rating set 12 line rating (alias is
RATE12) (0.0 by default)
Character*40 NAMEAR transformer name (input; blank by default).
Character*12 VGRPAR vector group name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a non-transformer
branch
IERR = 4 branch from a bus to itself
IERR = 5 blank circuit identifier is invalid
IERR = 6 circuit identifier may not start with &, * or @
IERR = 7 branch table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
931
Power Flow TWO_WINDING_DATA_6
IERR = 8 branch ownership table is full
IERR = 9 two-winding transformer table is full
IERR = 10 CW, CZ and/or CM >1 but at least one end-
point bus has no base voltage
IERR = 11 invalid CW, CZ and/or CM value
IERR = 13 node-breaker terminal connection table is full
IERR = 14 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid metered end
bus - invalid transformer status - invalid own-
er number - invalid ownership fraction - no
ownership data specified. - multi-section line
grouping deleted - branch ownership table is
full--only first n owners retained - owner ta-
ble is full - rating is negative - invalid wind-
ing 1 side bus number - invalid CW, CZ and/or
CM data value - controlled bus not found - in-
valid adjustment control mode flag - invalid
impedance correction table number - invalid
number of tap positions - winding nominal
voltage is negative - winding bus base volt-
age and nominal voltage differ by more than
20% - invalid winding voltage - winding volt-
age and bus base voltage differ by more than
50% - RMAX is greater than 150% of bus base
voltage - RMIN is less than 50% of bus base
voltage - invalid tap ratio - tap ratio is outside
the band 0.5 to 1.5 pu - RMAX is greater than
1.5 - RMIN is less than 0.5 - RMAX is less than
RMIN - VMAX is less than VMIN - phase shift
angle normalized between -180 and 180 -
winding base MVA must be positive - MAG1
is too big relative to MAG2 at winding base
MVA - magnetizing susceptance MAG2 is pos-
itive - losses are too big relative to total im-
pedance at winding base MVA - branch reac-
tance is 0.0 - winding 1 and winding 2 sides
are interchanged (any two-terminal dc lines
controlled by this transformer are logged).
- winding connection angle normalized be-
tween -360 and 360 - adjustment control
mode flag and the winding connection an-
gle are inconsistent. - for asymmetric phase
shifter, abnormally large or small tap setting
results at RMA1 (or RMI1) and CNXA1. - for
asymmetric phase shifter, the specified and
derived winding tap settings differ. - vector
group not found - Invalid node number - Non-
zero controlled node specified but controlled
bus does not belong to a substation - Con-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
932
Power Flow TWO_WINDING_DATA_6
trolled node not found - Controlled node is
not connected to any bus section of the regu-
lated bus - Controlled bus is 0 but a non-zero
controlled node is specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
933
Power Flow VOLTAGE_DROOP_CHNG
1.2.147. VOLTAGE_DROOP_CHNG
Use this API routine to modify the voltage droop control in the working case(see PSSE Program Operation
Manual.
This API routine was first introduced in release 35.3.0.
Batch command syntax:
BAT_VOLTAGE_DROOP_CHNG NAME INTGAR(1) INTGAR(2) REALAR(1)..REALAR(7)
Python command syntax:
ierr = voltage_droop_chng(name, intgar, realari)
Fortran command syntax:
CALL VOLTAGE_DROOP_CHNG(NAME, INTGAR, REALAR, IERR)
Where:
Character*40 NAME name of the voltage droop control for which data is to be specified
(input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) STATUS, voltage droop control status (0, 1)
(0 by default)
INTGAR(2) REGBUS, regulated bus of voltage droop con-
trol (20 by default)
Real REALAR (7) seven input values (input).
Real REALARI (7) array of 7 elements specifying values REALAR(1) through REALAR(7)
as described above(input).
REALARI(1) QMAX, upper Q limit of voltage droop con-
trol (1.0 by default)
REALARI(2) QDB, Q output when voltage is within dead-
band (0.0 by default)
REALARI(3) QMIN, lower Q limit of voltage droop control
(-1.0 by default)
REALARI(4) VLOW, lower voltage limit of voltage droop
control (0.9 by default)
REALARI(5) VDVLW, lower voltage deadband limit of volt-
age droop control (0.98 by default)
REALARI(6) VDBVHI, higher voltage deadband limit of
voltage droop control (1.02 by default)
REALARI(7) VHIGH, higher voltage limit of voltage droop
control (1.1 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 voltage droop control table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
934
Power Flow VOLTAGE_DROOP_CHNG
IERR = 2 blank voltage droop control name is invalid
IERR = 3 voltage droop control characteristic curve is
invalid
IERR = 4 Voltage Droop control not found
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid voltage droop
control status - qmax is less than qmin - vhigh
is less than vlow - vdbhigh is less than vdblow
- vdblow is less than vlow
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
935
Power Flow VOLTAGE_DROOP_DATA
1.2.148. VOLTAGE_DROOP_DATA
Use this API routine to modify the voltage droop control in the working case, or to add a new voltage droop
control to the working case (see PSSE Program Operation Manual.
This API routine was first introduced in release 35.3.0.
Batch command syntax:
BAT_VOLTAGE_DROOP_DATA NAME INTGAR(1) INTGAR(2) REALAR(1)..REALAR(7)
Python command syntax:
ierr = voltage_droop_data(name, intgar, realari)
Fortran command syntax:
CALL VOLTAGE_DROOP_DATA(NAME, INTGAR, REALAR, IERR)
Where:
Character*40 NAME name of the voltage droop control for which data is to be specified
(input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) STATUS, voltage droop control status (0, 1)
(0 by default)
INTGAR(2) REGBUS, regulated bus of voltage droop con-
trol (0 by default)
Real REALAR (7) seven input values (input).
Real REALARI (7) array of 7 elements specifying values REALAR(1) through REALAR(7)
as described above(input).
REALARI(1) QMAX, upper Q limit of voltage droop con-
trol (1.0 by default)
REALARI(2) QDB, Q output when voltage is within dead-
band (0.0 by default)
REALARI(3) QMIN, lower Q limit of voltage droop control
(-1.0 by default)
REALARI(4) VLOW, lower voltage limit of voltage droop
control (0.9 by default)
REALARI(5) VDVLW, lower voltage deadband limit of volt-
age droop control (0.98 by default)
REALARI(6) VDBVHI, higher voltage deadband limit of
voltage droop control (1.02 by default)
REALARI(7) VHIGH, higher voltage limit of voltage droop
control (1.1 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 voltage droop control table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
936
Power Flow VOLTAGE_DROOP_DATA
IERR = 2 blank voltage droop control name is invalid
IERR = 3 voltage droop control characteristic curve is
invalid
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid voltage droop
control status - qmax is less than qmin - vhigh
is less than vlow - vdbhigh is less than vdblow
- vdblow is less than vlow
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
937
Power Flow VSC_DC_CONVERTER_DATA
1.2.149. VSC_DC_CONVERTER_DATA
This API routine is obsolete. It has been replaced by the API routine vsc_dc_converter_data_3 .
Use this API to modify the data of a dc converter of an existing VSC dc line in the working case (see PSSE
Program Operation Manual, Voltage Source Converter (VSC) DC Transmission Line Data).
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_VSC_DC_CONVERTER_DATA 'NAME' IC INTGAR(1)..INTGAR(4)
REALAR(1)..REALAR(11)
Python command syntax:
ierr = vsc_dc_converter_data(name, ic, intgar, realar)
Fortran command syntax:
CALL VSC_DC_LINE_CONVERTER_API_2(NAME, IC, INTGAR, REALAR, IERR)
Where:
Character*12 NAME VSC dc line name (input; no default allowed).
Integer IC dc converter index (1 or 2) (input; no default allowed).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) IBUS, converter bus number (no default al-
lowed)
INTGAR(2) TYPE, dc control code (1 by default)
INTGAR(2) = 0 out-of-service
INTGAR(2) = 1 kV
INTGAR(2) = 2 MW
INTGAR(3) MODE, ac control code (1 = voltage, 2 =
power factor) (1 by default)
INTGAR(4) REMOT, remote bus number (0 for this con-
verter to regulate voltage at bus IBUS) (0 by
default)
Real REALAR (11) array of 11 elements specifying (input).
REALAR(1) DCSET, dc setpoint (kV or MW) (1.0 by de-
fault)
REALAR(2) ACSET, ac setpoint (pu voltage or power fac-
tor) (1.0 by default)
REALAR(3) ALOSS, A loss coefficient (kW) (0.0 by de-
fault)
REALAR(4) BLOSS, B loss coefficient (kW/amps) (0.0 by
default)
REALAR(5) MINLOS, minimum converter losses (kW)
(0.0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
938
Power Flow VSC_DC_CONVERTER_DATA
REALAR(6) SMAX, converter ac MVA rating (0.0 by de-
fault)
REALAR(7) IMAX, converter ac current rating (amps)
(0.0 by default)
REALAR(8) PWF, power weighting factor fraction (1.0 by
default)
REALAR(9) MAXQ, reactive power upper limit (Mvar)
(9999.0 by default)
REALAR(10) MINQ, reactive power lower limit (Mvar)
(-9999.0 by default)
REALAR(11) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid converter index
IERR = 2 no converter bus is specified
IERR = 3 dc line not found
IERR = 4 converter bus not found
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Converter bus is
dummy bus of a multi-section line - Multi-sec-
tion line grouping deleted. - Invalid dc con-
trol code - Invalid ac control mode - Regulat-
ed bus not found - Converter specified as re-
motely regulating itself. - Type code of regu-
lated bus is not 1 or 2. - dc voltage setpoint
is not positive - ac voltage setpoint is outside
the band 0.75 to 1.25 pu - ac power factor
setpoint is in error (magnitude exceeds 1.0)
- Invalid power weighting factor fraction -
MAXQ is less than MINQ. - RMPCT is not posi-
tive
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
939
Power Flow VSC_DC_CONVERTER_DATA_3
1.2.150. VSC_DC_CONVERTER_DATA_3
Use this API to modify the data of a dc converter of an existing VSC dc line in the working case (see PSSE
Program Operation Manual, Voltage Source Converter (VSC) DC Transmission Line Data).
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_VSC_DC_CONVERTER_DATA_3 'NAME' IC INTGAR(1)..INTGAR(5)
REALAR(1)..REALAR(11)
Python command syntax:
ierr = vsc_dc_converter_data_3(name, ic, intgar, realar)
Fortran command syntax:
CALL VSC_DC_LINE_CONVERTER_API_3(NAME, IC, INTGAR, REALAR, IERR)
Where:
Character*12 NAME VSC dc line name (input; no default allowed).
Integer IC dc converter index (1 or 2) (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) IBUS, converter bus number (no default al-
lowed)
INTGAR(2) TYPE, dc control code (1 by default)
INTGAR(2) = 0 out-of-service
INTGAR(2) = 1 kV
INTGAR(2) = 2 MW
INTGAR(3) MODE, ac control code (1 = voltage, 2 =
power factor) (1 by default)
INTGAR(4) VSREG, regulated bus number (0 by default)
INTGAR(5) NODE, regulated node number (0 by default)
Real REALAR (11) array of 11 elements specifying (input).
REALAR(1) DCSET, dc setpoint (kV or MW) (1.0 by de-
fault)
REALAR(2) ACSET, ac setpoint (pu voltage or power fac-
tor) (1.0 by default)
REALAR(3) ALOSS, A loss coefficient (kW) (0.0 by de-
fault)
REALAR(4) BLOSS, B loss coefficient (kW/amps) (0.0 by
default)
REALAR(5) MINLOS, minimum converter losses (kW)
(0.0 by default)
REALAR(6) SMAX, converter ac MVA rating (0.0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
940
Power Flow VSC_DC_CONVERTER_DATA_3
REALAR(7) IMAX, converter ac current rating (amps)
(0.0 by default)
REALAR(8) PWF, power weighting factor fraction (1.0 by
default)
REALAR(9) MAXQ, reactive power upper limit (Mvar)
(9999.0 by default)
REALAR(10) MINQ, reactive power lower limit (Mvar)
(-9999.0 by default)
REALAR(11) RMPCT, percent of contributed reactive pow-
er (100.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid converter index
IERR = 2 no converter bus is specified
IERR = 3 dc line not found
IERR = 4 converter bus not found
IERR = 5 prerequisite requirements for API are not met
IERR = 6 node-breaker terminal connection table is full
IERR = -1 data error, warning and information mes-
sages; one or more of: - Converter bus is
dummy bus of a multi-section line - Multi-sec-
tion line grouping deleted. - Invalid dc con-
trol code - Invalid ac control mode - Regulat-
ed bus not found - A remote regulated bus is
specified for a type 3 bus - Type code of reg-
ulated bus is not 1 or 2 - dc voltage setpoint
is not positive - ac voltage setpoint is outside
the band 0.75 to 1.25 pu - ac power factor
setpoint is in error (magnitude exceeds 1.0)
- Invalid power weighting factor fraction -
MAXQ is less than MINQ. - RMPCT is not posi-
tive - Invalid node number - Non-zero regulat-
ed node specified but regulated bus does not
belong to a substation - Regulated node not
found - Regulated node is not connected to
any bus section of the regulated bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
941
Power Flow VSC_DC_LINE_CHNG
1.2.151. VSC_DC_LINE_CHNG
Use this API routine to modify the link data of an existing VSC dc line in the working case (see PSSE Pro-
gram Operation Manual, Voltage Source Converter (VSC) DC Transmission Line Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_VSC_DC_LINE_CHNG 'NAME' INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(5)
Python command syntax:
ierr = vsc_dc_line_chng(name, intgar, realar)
Fortran command syntax:
CALL VSC_DC_LINE_CHNG(NAME, INTGAR, REALAR, IERR)
Where:
Character*12 NAME VSC dc line name (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) MDC, control mode (0 or 1) (0 by default)
INTGAR(2) O1, first owner number (1 by default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) RDC, dc line resistance (0.0 by default)
REALAR(2) F1, first owner fraction (1.0 by default)
REALAR(3) F2, second owner fraction (1.0 by default)
REALAR(4) F3, third owner fraction (1.0 by default)
REALAR(5) F4, fourth owner fraction (1.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 2 blank dc line name is invalid
IERR = 3 dc line not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid dc line con-
trol mode - invalid dc line resistance - invalid
owner number - invalid ownership fraction -
no ownership data specified - owner table is
full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
942
Power Flow VSC_DC_LINE_DATA
1.2.152. VSC_DC_LINE_DATA
Use this API routine to modify the link data of an existing VSC dc line in the working case, or to add a new
VSC dc line to the working case (see PSSE Program Operation Manual, Voltage Source Converter (VSC) DC
Transmission Line Data).
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_VSC_DC_LINE_DATA 'NAME' INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(5)
Python command syntax:
ierr = vsc_dc_line_data(name, intgar, realar)
Fortran command syntax:
CALL VSC_DC_LINE_API_2(NAME, INTGAR, REALAR, IERR)
Where:
Character*12 NAME VSC dc line name (input; no default allowed).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) MDC, control mode (0 or 1) (0 by default)
INTGAR(2) O1, first owner number (1 by default)
INTGAR(3) O2, second owner number (0 by default)
INTGAR(4) O3, third owner number (0 by default)
INTGAR(5) O4, fourth owner number (0 by default)
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) RDC, dc line resistance (0.0 by default)
REALAR(2) F1, first owner fraction (1.0 by default)
REALAR(3) F2, second owner fraction (1.0 by default)
REALAR(4) F3, third owner fraction (1.0 by default)
REALAR(5) F4, fourth owner fraction (1.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 VSC dc line table is full
IERR = 2 blank dc line name is invalid
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid dc line con-
trol mode - invalid dc line resistance - invalid
owner number - invalid ownership fraction -
no ownership data specified - owner table is
full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
943
Power Flow ZONE_DATA
1.2.153. ZONE_DATA
Use this API to modify zone data in the working case (see PSSE Program Operation Manual, Zone Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ZONE_DATA IZONE 'ZONAME'
Python command syntax:
ierr = zone_data(izone, zoname)
Fortran command syntax:
CALL ZONE_API_2(IZONE, ZONAME, IERR)
Where:
Integer IZONE zone number between 1 and 9999 (input; no default allowed).
Character*12 ZONAME zone name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid zone number
IERR = 2 zone table is full
IERR = 3 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - No equipment is as-
signed to zone
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
944
Power Flow ZONE_DATA
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
945
Chapter 2
Node Breaker
This chapter describes the API routines used in PSS®E Node Breaker operations and data changing functions
for substation data.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
946
Node Breaker Node Breaker Operation
2.1. Node Breaker Operation
2.1.1. CONVERT_SECTION_TO_BUS
Use this API routine to convert a bus section, one that had been automatically created within a substation
due to open substation switching devices, into a main network bus. After the conversion, the new network
bus will reside in the same substation and all prior network connections will remain.
Only bus sections that are not the main parent bus can be converted.
If a plant exists at the parent bus of the bus section to be converted and if all machines are connected to
the bus section, then the plant will be removed from the parent bus once the conversion of the bus section
to a main network bus is made. The newly converted network bus will remain as a plant.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_CONVERT_SECTION_TO_BUS IBUS INODE IARG 'NAME'
Python command syntax:
ierr = convert_section_to_bus(ibus, inode, iarg, name)
Fortran command syntax:
CALL CONVERT_SECTION_TO_BUS(IBUS, INODE, IARG, NAME, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Integer INODE node number (input; no default allowed).
Integer IARG bus number of the new network bus that is being converted from a
bus section (input; no default allowed).
Character*12 NAME new bus name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid bus number
IERR = 4 bus not found
IERR = 5 invalid node number
IERR = 6 bus does not belong to a substation
IERR = 7 node is not found in the substation
IERR = 8 node is not connected to any bus section of
the specified bus
IERR = 9 selected bus section is the parent bus and
therefore is already a network bus
IERR = -1 data error, warning and information mes-
sages; one or more of: - Bus name is more
than 12 characters.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
947
Node Breaker ISOLATE2DCLINEBYBREAKER
2.1.2. ISOLATE2DCLINEBYBREAKER
Use this API to isolate a two-terminal DC line using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the
ISOLATE2DCLINEBYBREAKER API can search outward into the network for breakers to open when attempt-
ing to isolate the two-terminal dc line. If inadequate system or substation breakers are found, such that the
line is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough addi-
tional breakers to open to achieve isolation of the line.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_ISOLATE2DCLINEBYBREAKER NAMEARG
Python command syntax:
ierr = isolate2dclinebybreaker(namearg)
Fortran command syntax:
CALL ISOLATE2DCLINEBYBREAKER(NAMEARG, IERR)
Where:
Character*12 NAMEARG Two-terminal DC line identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 two-terminal dc line is not found
IERR = 2 topology error in bus branch model
IERR = 3 maximum levels reached and unable to iso-
late line
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
948
Node Breaker ISOLATE3WTBYBREAKER
2.1.3. ISOLATE3WTBYBREAKER
Use this API to isolate a three-winding transformer using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the
ISOLATE3WTBYBREAKER API can search outward into the network for breakers to open when attempting
to isolate the three-winding transformer. If inadequate system or substation breakers are found, such that
the three-winding transformer is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value
may find enough additional breakers to open to achieve isolation.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATE3WTBYBREAKER IBUS JBUS KBUS CKTARG
Python command syntax:
ierr = isolate3wtbybreaker(ibus, jbus, kbus, cktarg)
Fortran command syntax:
CALL ISOLATE3WTBYBREAKER(IBUS, JBUS, KBUS, CKTARG, IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Integer KBUS last bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 circuit identifier may not start with &
IERR = 3 circuit identifier is more than two characters
IERR = 4 circuit is not found
IERR = 5 topology error in bus branch model
IERR = 6 maximum levels reached and unable to iso-
late line
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
949
Node Breaker ISOLATEBUSBYBREAKER
2.1.4. ISOLATEBUSBYBREAKER
Use this API to isolate a bus using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISOLATE-
BUSBYBREAKER API can search outward into the network for breakers to open when attempting to success-
fully isolate the bus. If inadequate system or substation breakers are found, such that the bus is not suc-
cessfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough additional breakers to
open to achieve isolation of the bus.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATEBUSBYBREAKER IBUS
Python command syntax:
ierr = isolatebusbybreaker(ibus)
Fortran command syntax:
CALL ISOLATEBUSBYBREAKER(IBUS, IERR)
Where:
Integer IBUS from bus number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 topology error in bus branch model
IERR = 3 maximum levels reached and unable to iso-
late 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
950
Node Breaker ISOLATEFACTSBYBREAKER
2.1.5. ISOLATEFACTSBYBREAKER
Use this API to isolate a FACTS device using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISOLATE-
FACTSBYBREAKER API can search outward into the network for breakers to open when attempting to isolate
the FACTS device. If inadequate system or substation breakers are found, such that the device is not suc-
cessfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough additional breakers to
open to achieve isolation of the FACTS device.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_ISOLATEFACTSBYBREAKER NAMEARG
Python command syntax:
ierr = isolatefactsbybreaker(namearg)
Fortran command syntax:
CALL ISOLATEFACTSBYBREAKER(NAMEARG, IERR)
Where:
Character*12 NAMEARG FACTS device name identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 FACTS device is not found
IERR = 2 topology error in bus branch model
IERR = 3 maximum levels reached and unable to iso-
late device
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
951
Node Breaker ISOLATEINDMACHINEBYBREAK-
ER
2.1.6. ISOLATEINDMACHINEBYBREAKER
Use this API to isolate an induction machine using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISOLATE-
LOADBYBREAKER API can search outward into the network for breakers to open when attempting to isolate
the induction machine. If inadequate system or substation breakers are found, such that the induction ma-
chine is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough addi-
tional breakers to open to achieve isolation of the induction machine.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_ISOLATEINDMACHINEBYBREAKER IBUS CKTARG
Python command syntax:
ierr = isolateindmachinebybreaker(ibus, cktarg)
Fortran command syntax:
CALL ISOLATEINDMACHINEBYBREAKER(IBUS, CKTARG, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG induction machine identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 induction machine is not found
IERR = 3 topology error in bus branch model
IERR = 4 maximum levels reached and unable to iso-
late line
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
952
Node Breaker ISOLATELINEBYBREAKER
2.1.7. ISOLATELINEBYBREAKER
Use this API to isolate a two-winding transformer or non-transformer line using system or substation break-
ers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATELINEBYBREAKER API can search outward into the network for breakers to open when attempting to
isolate the two-winding transformer or non-transformer line. If inadequate system or substation breakers
are found, such that the line is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value
may find enough additional breakers to open to achieve isolation of the line.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATELINEBYBREAKER IBUS JBUS CKTARG
Python command syntax:
ierr = isolatelinebybreaker(ibus, jbus, cktarg)
Fortran command syntax:
CALL ISOLATELINEBYBREAKER(IBUS, JBUS, CKTARG, IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 circuit identifier may not start with &
IERR = 3 circuit identifier is more than two characters
IERR = 4 circuit is not found
IERR = 5 topology error in bus branch model
IERR = 6 maximum levels reached and unable to iso-
late line
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
953
Node Breaker ISOLATELOADBYBREAKER
2.1.8. ISOLATELOADBYBREAKER
Use this API to isolate a load using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISOLATE-
LOADBYBREAKER API can search outward into the network for breakers to open when attempting to iso-
late the load. If inadequate system or substation breakers are found, such that the load is not suc-cessfully
isolated, then specifying a larger ISOLATE_LEVELS() value may find enough additional breakers to open to
achieve isolation of the load.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATELOADBYBREAKER IBUS CKTARG
Python command syntax:
ierr = isolateloadbybreaker(ibus, cktarg)
Fortran command syntax:
CALL ISOLATELOADBYBREAKER(IBUS, CKTARG, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG load identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 load is not found
IERR = 3 topology error in bus branch model
IERR = 4 maximum levels reached and unable to iso-
late line
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
954
Node Breaker ISOLATEMACHINEBYBREAKER
2.1.9. ISOLATEMACHINEBYBREAKER
Use this API to isolate a machine using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATEMACHINEBYBREAKER API can search outward into the network for breakers to open when attempting
to isolate the machine. If inadequate system or substation breakers are found, such that the machine is not
successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough additional breakers
to open to achieve isolation of the machine.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATEMACHINEBYBREAKER IBUS CKTARG
Python command syntax:
ierr = isolatemachinebybreaker(ibus, cktarg)
Fortran command syntax:
CALL ISOLATEMACHINEBYBREAKER(IBUS, CKTARG, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG machine identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 machine is not found
IERR = 3 topology error in bus branch model
IERR = 4 maximum levels reached and unable to iso-
late line
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
955
Node Breaker ISOLATEMSLINEBYBREAKER
2.1.10. ISOLATEMSLINEBYBREAKER
Use this API to isolate a multi-section line using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API used to set the number of levels the ISO-
LATEMSLINEBYBREAKER API can search outward into the network for breakers to open when attempt-
ing to isolate the multi-section line. If inadequate system or substation breakers are found, such that the
multi-section line is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find
enough additional breakers to open to achieve isolation of the multi-section line.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATEMSLINEBYBREAKER IBUS JBUS CKTARG
Python command syntax:
ierr = isolatemslinebybreaker(ibus, jbus, cktarg)
Fortran command syntax:
CALL ISOLATEMSLINEBYBREAKER(IBUS, JBUS, CKTARG, IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 circuit identifier is more than two characters
IERR = 3 circuit is not found
IERR = 4 topology error in bus branch model
IERR = 5 maximum levels reached and unable to iso-
late line
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
956
Node Breaker ISOLATEMTDCLINEBYBREAKER
2.1.11. ISOLATEMTDCLINEBYBREAKER
Use this API to isolate a multi-terminal dc line using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATEMTDCLINEBYBREAKER API can search outward into the network for breakers to open when attempt-
ing to isolate the multi-terminal dc line. If inadequate system or substation breakers are found, such that
the line is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough ad-
ditional breakers to open to achieve isolation of the line.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_ISOLATEMTDCLINEBYBREAKER NAMEARG
Python command syntax:
ierr = isolatemtdclinebybreaker(namearg)
Fortran command syntax:
CALL ISOLATEMTDCLINEBYBREAKER(NAMEARG, IERR)
Where:
Character*12 NAMEARG Multi-terminal dc line identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 multi-terminal dc line is not found
IERR = 2 topology error in bus branch model
IERR = 3 maximum levels reached and unable to iso-
late line
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
957
Node Breaker ISOLATENODEBYBREAKER
2.1.12. ISOLATENODEBYBREAKER
Use this API to isolate a substation node using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATENODEBYBREAKER API can search outward into the network for breakers to open when attempting to
isolate the substation node. If inadequate system or substation breakers are found, such that the node
is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough additional
breakers to open to achieve isolation of the node.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATENODEBYBREAKER ISTARG IARG
Python command syntax:
ierr = isolatenodebybreaker(istarg, iarg)
Fortran command syntax:
CALL ISOLATENODEBYBREAKER(ISTARG, IARG, IERR)
Where:
Integer ISTARG substation number (input).
Integer IARG node number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 substation in not foung
IERR = 2 node not found in substation
IERR = 3 topology error in bus branch model
IERR = 4 maximum levels reached and unable to iso-
late line
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
958
Node Breaker ISOLATESHUNTBYBREAKER
2.1.13. ISOLATESHUNTBYBREAKER
Use this API to isolate a fixed shunt using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATESHUNTBYBREAKER API can search outward into the network for breakers to open when attempting to
successfully isolate the fixed shunt. If inadequate system or substation breakers are found, such that the
shunt is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough addi-
tional breakers to open to achieve isolation of the shunt.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATESHUNTBYBREAKER IBUS CKTARG
Python command syntax:
ierr = isolateshuntbybreaker(ibus, cktarg)
Fortran command syntax:
CALL ISOLATESHUNTBYBREAKER(IBUS, CKTARG, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG fixed shunt identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 fixed shunt is not found
IERR = 3 topology error in bus branch model
IERR = 4 maximum levels reached and unable to iso-
late line
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
959
Node Breaker ISOLATESWDBYBREAKER
2.1.14. ISOLATESWDBYBREAKER
Use this API to isolate a substation switching device using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATESWDBYBREAKER API can search outward into the network for breakers to open when attempting to
isolate the substation switching device. If inadequate system or substation breakers are found, such that
the substation switching device is not successfully isolated, then specifying a larger ISOLATE_LEVELS() val-
ue may find enough additional breakers to open to achieve isolation.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATESWDBYBREAKER STATION IBUS JBUS CKTARG
Python command syntax:
ierr = isolateswdbybreaker(station, ibus, jbus, cktarg)
Fortran command syntax:
CALL ISOLATESWDBYBREAKER(STATION, IBUS, JBUS, CKTARG, IERR)
Where:
Integer STATION substation number (input).
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 substation in not foung
IERR = 2 node not found in substation
IERR = 3 circuit identifier is more than two characters
IERR = 4 circuit is not found
IERR = 5 topology error in bus branch model
IERR = 6 maximum levels reached and unable to iso-
late line
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
960
Node Breaker ISOLATESWSHUNTBYBREAKER
2.1.15. ISOLATESWSHUNTBYBREAKER
This API routine is obsolete. It has been replaced by the API routine IsolateSwShuntByBreaker_2 .
Use this API to isolate a switched shunt using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATESWSHUNTBYBREAKER API can search outward into the network for breakers to open when attempting
to successfully isolate the switched shunt. If inadequate system or substation breakers are found, such that
the switched shunt is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find
enough additional breakers to open to achieve isolation.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_ISOLATESWSHUNTBYBREAKER IBUS
Python command syntax:
ierr = isolateswshuntbybreaker(ibus)
Fortran command syntax:
CALL ISOLATESWSHUNTBYBREAKER(IBUS, IERR)
Where:
Integer IBUS from bus number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 switched shunt is not found
IERR = 3 topology error in bus branch model
IERR = 4 maximum levels reached and unable to iso-
late line
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
961
Node Breaker ISOLATESWSHUNTBYBREAKER_2
2.1.16. ISOLATESWSHUNTBYBREAKER_2
Use this API to isolate a switched shunt using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISO-
LATESWSHUNTBYBREAKER API can search outward into the network for breakers to open when attempting
to successfully isolate the switched shunt. If inadequate system or substation breakers are found, such that
the switched shunt is not successfully isolated, then specifying a larger ISOLATE_LEVELS() value may find
enough additional breakers to open to achieve isolation.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_ISOLATESWSHUNTBYBREAKER_2 IBUS, 'ID'
Python command syntax:
ierr = isolateswshuntbybreaker_2(ibus, id)
Fortran command syntax:
CALL ISOLATESWSHUNTBYBREAKER_2(IBUS, ID, IERR)
Where:
Integer IBUS from bus number (input).
character*2 ID Switched shunt identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 switched shunt is not found
IERR = 3 topology error in bus branch model
IERR = 4 maximum levels reached and unable to iso-
late line
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
962
Node Breaker ISOLATEVSCDCLINEBYBREAKER
2.1.17. ISOLATEVSCDCLINEBYBREAKER
Use this API to isolate a VSC DC line using system or substation breakers.
This API works in conjunction with the ISOLATE_LEVELS() API which sets the number of levels the ISOLAT-
EVSCDCLINEBYBREAKER API can search outward into the network for breakers to open when attempting to
isolate the VSC dc line. If inadequate system or substation breakers are found, such that the line is not suc-
cessfully isolated, then specifying a larger ISOLATE_LEVELS() value may find enough additional breakers to
open to achieve isolation of the line.
Use the RESTORESTATESFROMISOLATE API to restore the original network working case after an Isolate. It is
recommended that you save your network case prior to running any "Isolate". Multiple "Isolate" actions can
be run, and other network changes can be made, but only the original network working case prior to the
initial "Isolate", or prior to the first "Isolate" after a "Restore", will be restored.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_ISOLATEVSCDCLINEBYBREAKER NAMEARG
Python command syntax:
ierr = isolatevscdclinebybreaker(namearg)
Fortran command syntax:
CALL ISOLATEVSCDCLINEBYBREAKER(NAMEARG, IERR)
Where:
Character*12 NAMEARG VSC DC line identifier (input).
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 vsc dc line is not found
IERR = 2 topology error in bus branch model
IERR = 3 maximum levels reached and unable to iso-
late line
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
963
Node Breaker RESTORESTATESFROMISOLATE
2.1.18. RESTORESTATESFROMISOLATE
Use this API to restore the network working case back to its original state; the state prior to all "Isolate By
Breaker" actions that have been taken.
Caution: Any network changes that may have been made since the initial "Isolate" action will be lost.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_RESTORESTATESFROMISOLATE IERR
Python command syntax:
restorestatesfromisolate(ierr)
Fortran command syntax:
CALL RESTORESTATESFROMISOLATE(IERR)
Where:
Integer IERR error code (output).
IERR = 0 No error
IERR = 1 error restoring working 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
964
Node Breaker STATION_BUILD_CONFIG
2.1.19. STATION_BUILD_CONFIG
Use this API to automatically build a substation for a bus in specific configuration. Once the substation is
built, it can be modified to meet specific configurations.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_BUILD_CONFIG IBUS ISTARG NAMEAR SUBTYP
Python command syntax:
ierr = station_build_config(ibus, istarg, namear, subtyp)
Fortran command syntax:
CALL BUILDBUSCONFIGURATION(IBUS, ISTARG, NAMEAR, SUBTYP, IERR)
Where:
Integer IBUS bus the substation is built for (input).
Integer ISTARG station number used to uniquely identify this substation (input).
Character*40 NAMEAR station name used to uniquely identify this substation (input).
Integer SUBTYP basic configuration to build for this substation (input).
SUBTYP = 1 single bus
SUBTYP = 2 ring bus
SUBTYP = 3 double breaker, double bus
SUBTYP = 4 breaker and a half bus
SUBTYP = 5 single breaker, double bus
SUBTYP = 6 main transfer bus
SUBTYP = 7 breaker and a half bus, with odd/even nodes
in columns
SUBTYP = 8 single breaker, double bus, with odd/even
nodes in columns
Integer IERR error code (output).
IERR = 1 bus does not exist
IERR = 2 invalid substation number
IERR = 3 substation model already exists for bus
IERR = 4 nodes to be added in the substation greater
than maximum
IERR = 5 total nodes in the substation greater than
maximum
IERR = 6 error building the substation
IERR = 7 error building the nodes and switching de-
vices
IERR = 8 Prerequisite requirements for function not
met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
965
Node Breaker STATION_LIST
2.1.20. STATION_LIST
Use this API to list components in a substation.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_LIST OPTION STATION
Python command syntax:
ierr = station_list(option, station)
Fortran command syntax:
CALL SLIST(OPTION, STATION, IERR)
Where:
Integer OPTION (input).
OPTION = 1 list all substations
OPTION = 2 list substation STATION
Integer STATION substation number (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid OPTION value
IERR = 2 STATION does not exist
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
966
Node Breaker STATION_POUT
2.1.21. STATION_POUT
This API routine is obsolete. It has been replaced by the API routine station_pout_2 .
Use this API to print power flows in a substation.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_POUT OPTION STATION
Python command syntax:
ierr = station_pout(option, station)
Fortran command syntax:
CALL SPOUT(OPTION, STATION, IERR)
Where:
Integer OPTION (input).
OPTION = 1 report the power flows of all substations
OPTION = 2 report the power flows of substation STATION
Integer STATION substation number (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid OPTION value
IERR = 2 STATION does not exist
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
967
Node Breaker STATION_POUT_2
2.1.22. STATION_POUT_2
Use this API to print power flows within a substation.
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_STATION_POUT_2 ALL STATION OPTION
Python command syntax:
ierr = station_pout_2(all, station, option)
Fortran command syntax:
CALL SPOUT_2(ALL, STATION, OPTION, IERR)
Where:
Integer ALL (input).
ALL = 1 report the power flows of all substations
ALL = 2 report the power flows of substation STATION
Integer STATION substation number (input).
Integer OPTION (input).
OPTION = 0 Do not display loop flow values
OPTION = 1 Show all flow values
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid ALL value
IERR = 2 STATION does not exist
IERR = 3 invalid OPTION 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
968
Node Breaker STATION_TREE
2.1.23. STATION_TREE
Use this API routine to check the node breaker model and the consistency between node breaker and bus
branch models.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_TREE INTOPT STATION
Python command syntax:
ierr = station_tree(intopt, station)
Fortran command syntax:
CALL STREE(INTOPT, STATION, IERR)
Where:
Integer INTOPT operation mode (input).
INTOPT = 0 check all changed stations
INTOPT = 1 force check all stations
INTOPT = 2 check individual station
Integer STATION substation number. Used if INTOPT = 2. (input).
Integer IERR error code (output).
IERR = 1 invalid INTOPT value
IERR = 2 invalid substation number
IERR = 3 substation does not exist
IERR = 4 topology error in bus branch model
IERR = 5 topology error in node breaker model
IERR = 6 Prerequisite requirements for function not
met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
969
Node Breaker STATION_TREE
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
970
Node Breaker STATION_TREE
This chapter describes the API routines used in PSS®E Node Breaker operations.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
971
Node Breaker Node Breaker Data
2.2. Node Breaker Data
2.2.1. FETCH_ADJVAR_TERM_NODE
Use this API to obtain the terminal node to which an OPF adjustable bus shunt is connected to.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Python command syntax:
ierr,intgar = fetch_adjvar_term_node(ibus, cktarg)
Fortran command syntax:
CALL FETCH_ADJVAR_TERM_NODE(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG OPF adjustable var identifier (input).
Integer INTGAR node terminal number (output).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 OPF adjustable bus shunt identifier is more
than two characters
IERR = 3 OPF adjustable bus shunt not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
972
Node Breaker FETCH_INDMACHINE_TERM_NODE
2.2.2. FETCH_INDMACHINE_TERM_NODE
Use this API to obtain the terminal node to which a machine is connected to.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Python command syntax:
ierr,intgar = fetch_indmachine_term_node(ibus, cktarg)
Fortran command syntax:
CALL FETCH_INDMACHINE_TERM_NODE(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG induction machine identifier (input).
Integer INTGAR node terminal number (output).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
973
Node Breaker FETCH_LOAD_TERM_NODE
2.2.3. FETCH_LOAD_TERM_NODE
Use this API to obtain the terminal node to which a load is connected to.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Python command syntax:
ierr,intgar = fetch_load_term_node(ibus, cktarg)
Fortran command syntax:
CALL FETCH_LOAD_TERM_NODE(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG load identifier (input).
Integer INTGAR node terminal number (output).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 load identifier is more than two characters
IERR = 3 load not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
974
Node Breaker FETCH_MACHINE_TERM_NODE
2.2.4. FETCH_MACHINE_TERM_NODE
Use this API to obtain the terminal node to which a machine is connected to.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Python command syntax:
ierr,intgar = fetch_machine_term_node(ibus, cktarg)
Fortran command syntax:
CALL FETCH_MACHINE_TERM_NODE(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG machine identifier (input).
Integer INTGAR node terminal number (output).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
975
Node Breaker FETCH_SHUNT_TERM_NODE
2.2.5. FETCH_SHUNT_TERM_NODE
Use this API to obtain the terminal node to which a shunt is connected to.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Python command syntax:
ierr,intgar = fetch_shunt_term_node(ibus, cktarg)
Fortran command syntax:
CALL FETCH_SHUNT_TERM_NODE(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG shunt identifier (input).
Integer INTGAR node terminal number (output).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 shunt identifier is more than two characters
IERR = 3 shunt not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
976
Node Breaker FETCH_SWS_SHUNT_TERM_NODE
2.2.6. FETCH_SWS_SHUNT_TERM_NODE
This API routine is obsolete. It has been replaced by the API routine fetch_sws_shunt_term_node_2 .
Use this API to obtain the terminal node to which a switched shunt is connected to.
This API routine was first introduced in release 34.8.0.
Python command syntax:
ierr,intgar = fetch_sws_shunt_term_node(ibus)
Fortran command syntax:
CALL FETCH_SWS_SHUNT_TERM_NODE(IBUS, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Integer INTGAR node terminal number (output).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 switched shunt not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
977
Node Breaker FETCH_SWS_SHUNT_TERM_NODE_2
2.2.7. FETCH_SWS_SHUNT_TERM_NODE_2
Use this API to obtain the terminal node to which a switched shunt is connected to.
This API routine was first introduced in release 35.2.
Python command syntax:
ierr,intgar = fetch_sws_shunt_term_node_2(ibus, cktarg)
Fortran command syntax:
CALL FETCH_SWS_SHUNT_TERM_NODE_2(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG switched shunt identifier (input).
Integer INTGAR node terminal number (output).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 switched shunt identifier is more than two
characters
IERR = 3 switched shunt not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
978
Node Breaker PLANT_BUS_SECTION_CHNG
2.2.8. PLANT_BUS_SECTION_CHNG
This API routine is obsolete. It has been replaced by the API routine plant_chng_3 .
Use this API routine to modify the data of an existing plant in the working case (see PSSE Data Formats Ref-
erence Manual, Generator Data).
This API routine was first introduced in release 34.0.1.
Batch command syntax:
BAT_PLANT_BUS_SECTION_CHNG I NODE INTGAR REALAR(1)..REALAR(2)
Python command syntax:
ierr = plant_bus_section_chng(i, node, intgar, realar)
Fortran command syntax:
CALL PLANT_BUS_SECTION_CHNG(I, NODE, INTGAR, REALAR, IERR)
Where:
Integer I bus number (input; no default allowed).
Integer NODE node number (input; no default allowed).
Integer INTGAR (1) one element. See the PLANT_DATA_3 API routine for details (input).
Real REALAR (2) See the PLANT_DATA_3 API routine for details (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 3 no plant at bus
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid scheduled
voltage - regulated bus not found - plant
specified as remotely regulating itself - type
code of regulated bus is not 1 or 2 - RMPCT is
not positive
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
979
Node Breaker STATION_2DC_CONV_TERM_CHNG
2.2.9. STATION_2DC_CONV_TERM_CHNG
Use this API to access existing station two-term dc rectifier and inverter terminal data in the working case.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_STATION_2DC_CONV_TERM_CHNG NAME NODES(1) NODES(2)
Python command syntax:
ierr = station_2dc_conv_term_chng(name, nodes)
Fortran command syntax:
CALL ST_NTWOTERMDC(NAME, NODES, IERR)
Where:
character*12 NAME quoted name of the two-terminal dc line for which node terminal da-
ta for one or both of its converters is to be specified (input; no de-
fault allowed).
Integer NODES (2) array of elements specifying (input).
NODES(1) node number to which the dc rectifier end is
attached
NODES(2) node number to which the dc inverter end is
attached
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 two-terminal dc line not found
IERR = 2 bus associated with node is not part of a sub-
station
IERR = 3 node does not exist
IERR = 4 Invalid node number
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
980
Node Breaker STATION_ADJVAR_TERM_CHNG
2.2.10. STATION_ADJVAR_TERM_CHNG
Use this API to change a substation OPF adjustable bus shunt node terminal connection in the working
case.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_STATION_ADJVAR_TERM_CHNG BUS CKTARG INTGAR
Python command syntax:
ierr = station_adjvar_term_chng(bus, cktarg, intgar)
Fortran command syntax:
CALL ST_NADJVAR(BUS, CKTARG, INTGAR, IERR)
Where:
Integer BUS from bus number (input).
Character*2 CKTARG adjustable bus shunt identifier (input).
Integer INTGAR node terminal number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 OPF adjustable bus shunt identifier is more
than two characters
IERR = 3 OPF adjustable bus shunt is not found
IERR = 4 bus does not belong to a substation
IERR = 5 node not found in substation
IERR = 6 invalid node number
IERR = 7 node-breaker terminal connection table is full
IERR = 8 error when moving OPF adjustable bus shunt
terminal connection
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
981
Node Breaker STATION_BRANCH_TERM_CHNG
2.2.11. STATION_BRANCH_TERM_CHNG
Use this API to access existing station branch terminal data in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_BRANCH_TERM_CHNG IBUS JBUS CKTARG NODES(1) NODES(2)
Python command syntax:
ierr = station_branch_term_chng(ibus, jbus, cktarg, nodes)
Fortran command syntax:
CALL ST_NBRANCH(IBUS, JBUS, CKTARG, NODES, IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer NODES (2) array of 2 elements specifying (input).
NODES(1) from node number
NODES(2) to node number
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 bus does not belong to a substation
IERR = 3 node does not exist in substation
IERR = 4 invalid node number
IERR = 5 circuit not found
IERR = 6 circuit identifier is more than two characters
IERR = 7 circuit identifier may not start with &
IERR = 8 error encountered when moving branch con-
nection
IERR = 9 node-breaker terminal connection table is full
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
982
Node Breaker STATION_BRANCH_TERM_MOVE
2.2.12. STATION_BRANCH_TERM_MOVE
Use this API to move one terminal node connection of a branch in the working case. The second bus argu-
ment (JBUS) is the bus at which the bus at which the node connection will be moved to the node designat-
ed in the DSNODE argument.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_BRANCH_TERM_MOVE IBUS JBUS CKTARG DSNODE
Python command syntax:
ierr = station_branch_term_move(ibus, jbus, cktarg, dsnode)
Fortran command syntax:
CALL MOVEBRANCHTERMINAL(IBUS, JBUS, CKTARG, DSNODE, IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number. This is the bus for which the node connection will be
moved to the node designated in DSNODE. (input).
Character*2 CKTARG circuit identifier (input).
Integer DSNODE new terminal node number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 bus does not belong to a substation
IERR = 3 node not found in substation
IERR = 4 invalid node number
IERR = 5 circuit not found
IERR = 6 circuit identifier is more than two characters
IERR = 7 circuit identifier may not start with &
IERR = 8 error encountered when moving branch
IERR = 9 node-breaker terminal connection table is full
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
983
Node Breaker STATION_BUS_PURG
2.2.13. STATION_BUS_PURG
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_STATION_BUS_PURG STATION IBUS
Python command syntax:
ierr = station_bus_purg(station,ibus)
Fortran command syntax:
CALL PURG_STATION_BUS(STATION, IBUS, IERR)
Where:
Integer STATION substation number (input).
Integer IBUS bus number (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid STATION number
IERR = 2 STATION does not exist
IERR = 3 BUS does not exist
IERR = 4 unable to move all connections back to origi-
nal network bus
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
984
Node Breaker STATION_CHNG
2.2.14. STATION_CHNG
Use this API to modify the data of an existing substation data in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_CHNG STATION REALAR(1)..REALAR(3) NAMEAR
Python command syntax:
ierr = station_chng(station, realar, namear)
Fortran command syntax:
CALL STATION_CHNG(STATION, REALAR, NAMEAR, IERR)
Where:
Integer STATION substation number (input; no default allowed).
Real REALAR (3) array of elements specifying (input).
REALAR(1) substation latitude
REALAR(2) substation longitude
REALAR(3) substation grounding resistance
Character*40 NAMEAR substation name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid substation number
IERR = 2 substation not found
IERR = 3 substation name has been used
IERR = 4 substation table is full
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Latitude/longitude
out of range - Substation grounding dc re-
sistance is less than 0.0 - Substation name is
more than STATIONNAMLEN characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
985
Node Breaker STATION_DATA
2.2.15. STATION_DATA
Use this API to modify the data of an existing substation data in the working case, or to add a new substa-
tion to the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_DATA STATION REALAR(1)..REALAR(3) NAMEAR
Python command syntax:
ierr = station_data(station, realar, namear)
Fortran command syntax:
CALL STATION_API(STATION, REALAR, NAMEAR, IERR)
Where:
Integer STATION substation number (input; no default allowed).
Real REALAR (3) array of elements specifying (input).
REALAR(1) substation latitude
REALAR(2) substation longitude
REALAR(3) substation grounding resistance
Character*40 NAMEAR substation name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid substation number
IERR = 2 substation not found
IERR = 3 substation name has been used
IERR = 4 substation table is full
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Latitude/longitude
out of range - Substation grounding dc re-
sistance is less than 0.0 - Substation name is
more than STATIONNAMLEN characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
986
Node Breaker STATION_FACTS_TERM_CHNG
2.2.16. STATION_FACTS_TERM_CHNG
Use this API to access existing station FACTS device sending and terminal end node-breaker terminal data
in the working case.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_STATION_FACTS_TERM_CHNG NAME INTGAR(1) INTGAR(2)
Python command syntax:
ierr = station_facts_term_chng(name, intgar)
Fortran command syntax:
CALL ST_NFACTS(NAME, INTGAR, IERR)
Where:
character*12 NAME quoted name of the FACTS device for which node terminal data for
the sending and terminal end is to be changed (input; no default al-
lowed).
Integer INTGAR (2) array of elements specifying (input).
INTGAR(1) node number to which the FACTS device
sending end is attached
INTGAR(2) node number to which the FACTS device ter-
minal end is attached
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 FACTS device not found
IERR = 2 bus associated with node does not belong to
substation
IERR = 3 node does not exist
IERR = 4 Invalid node number
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
987
Node Breaker STATION_INDMACHINE_TERM_CHNG
2.2.17. STATION_INDMACHINE_TERM_CHNG
Use this API to change a substation induction machine node terminal connection in the working case.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_STATION_INDMACHINE_TERM_CHNG IBUS CKTARG INTGAR
Python command syntax:
ierr = station_indmachine_term_chng(ibus, cktarg, intgar)
Fortran command syntax:
CALL ST_NINDMAC(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG induction machine identifier (input).
Integer INTGAR node terminal number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 induction machine identifier is more than two
characters
IERR = 3 induction machine not found
IERR = 4 bus does not belong to a substation
IERR = 5 node does not exist in substation
IERR = 6 invalid node number
IERR = 7 node-breaker terminal connection table is full
IERR = 8 error when moving induction machine termi-
nal connection
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
988
Node Breaker STATION_LOAD_TERM_CHNG
2.2.18. STATION_LOAD_TERM_CHNG
Use this API to access existing station load terminal data in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_LOAD_TERM_CHNG IBUS CKTARG INTGAR
Python command syntax:
ierr = station_load_term_chng(ibus, cktarg, intgar)
Fortran command syntax:
CALL ST_NLOAD(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG load identifier (input).
Integer INTGAR node terminal number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 load identifier is more than two characters
IERR = 3 load is not found
IERR = 4 bus does not belong to a substation
IERR = 5 node does not exist in substation
IERR = 6 invalid node number
IERR = 7 node-breaker terminal connection table is full
IERR = 8 error when moving load terminal connection
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
989
Node Breaker STATION_MACHINE_TERM_CHNG
2.2.19. STATION_MACHINE_TERM_CHNG
Use this API to change a substation machine terminal connection in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_MACHINE_TERM_CHNG IBUS CKTARG INTGAR
Python command syntax:
ierr = station_machine_term_chng(ibus, cktarg, intgar)
Fortran command syntax:
CALL ST_NMACHINE(IBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Character*2 CKTARG machine identifier (input).
Integer INTGAR node terminal number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 bus does not belong to a substation
IERR = 5 node does not exist in substation
IERR = 6 Invalid node number
IERR = 7 node-breaker terminal connection table is full
IERR = 8 error encountered when moving machine ter-
minal connection
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
990
Node Breaker STATION_MTDC_TERM_CHNG
2.2.20. STATION_MTDC_TERM_CHNG
Use this API to access existing station multi-terminal converter terminal data in the working case.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_STATION_MTDC_TERM_CHNG NAME INTGAR(1) INTGAR(2)
Python command syntax:
ierr = station_mtdc_term_chng(name, intgar)
Fortran command syntax:
CALL ST_NMTDC(NAME, INTGAR, IERR)
Where:
character*12 NAME quoted name of the multi-terminal dc line for which node terminal
data is to be specified for one of the ac converter buses (input; no de-
fault allowed).
Integer INTGAR (2) array of elements specifying (input).
INTGAR(1) converter bus to which the node is attached
INTGAR(2) node number to which the converter end is
attached
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 multi-terminal dc line not found
IERR = 2 bus associated with node does not belong to
substation
IERR = 3 node does not exist
IERR = 4 Invalid node number
IERR = 5 bus is not a recognized ac converter bus with-
in multi-terminal dc line
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
991
Node Breaker STATION_NODE_CHNG
2.2.21. STATION_NODE_CHNG
Use this API to modify the data of an existing substation node in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_NODE_CHNG STATION NODE INTGAR(1) INTGAR(2) NAMEAR
Python command syntax:
ierr = station_node_chng(station, node, intgar, namear)
Fortran command syntax:
CALL NODE_CHNG(STATION, NODE, INTGAR, NAMEAR, IERR)
Where:
Integer STATION substation number (input; no default allowed).
Integer NODE node number (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying array of two integer values(input).
INTGAR(1) bus number to which the node is connected
INTGAR(2) node status
INTGAR(2) = 0 out-of-service
INTGAR(2) = 1 in-service
Character*40 NAMEAR node name (input; blank by default).
Integer IERR error code (output).
IERR = -1 data error, warning and information mes-
sages
IERR = 0 no errors
IERR = 1 invalid substation number
IERR = 2 substation not found
IERR = 3 invalid node number
IERR = 4 node not found
IERR = 5 no bus associated with this node
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
992
Node Breaker STATION_NODE_DATA
2.2.22. STATION_NODE_DATA
Use this API to modify the data of an existing substation node in the working case, or to add a new substa-
tion node to the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_NODE_DATA STATION NODE INTGAR(1) INTGAR(2) NAMEAR
Python command syntax:
ierr = station_node_data(station, node, intgar, namear)
Fortran command syntax:
CALL NODE_API(STATION, NODE, INTGAR, NAMEAR, IERR)
Where:
Integer STATION substation number (input; no default allowed).
Integer NODE node number (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying Array of two integer values(input).
INTGAR(1) bus number to which the node is connected
INTGAR(2) node status
INTGAR(2) = 0 out-of-service
INTGAR(2) = 1 in-service
Character*40 NAMEAR Node name (input; blank by default).
Integer IERR error code (output).
IERR = -1 data error, warning and information mes-
sages
IERR = 0 no errors
IERR = 1 invalid substation number
IERR = 2 substation not found
IERR = 3 invalid node number
IERR = 4 node not found
IERR = 5 no bus associated with this node
IERR = 7 node table is full
IERR = 8 node-breaker terminal connection table is 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
993
Node Breaker STATION_NODE_NUMBER
2.2.23. STATION_NODE_NUMBER
Use this API to change a node number in an existing substation.
This API routine was first introduced in release 34.0.1.
Batch command syntax:
BAT_STATION_NODE_NUMBER STATION NODE NEWNODE
Python command syntax:
ierr = station_node_number(station, node, newnode)
Fortran command syntax:
CALL NODE_NUMBER(STATION, NODE, NEWNODE, IERR)
Where:
Integer STATION substation number (input; no default allowed).
Integer NODE number of the node to be changed (input; no default allowed).
Integer NEWNODE new number to be assigned to the node (input; no default allowed).
Integer IERR error code (output).
IERR = 1 invalid substation number.
IERR = 2 substation not found.
IERR = 3 invalid node number.
IERR = 4 node not found.
IERR = 5 invalid new node number.
IERR = 6 node number is already assigned to another
node in the 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
994
Node Breaker STATION_NODE_PURG
2.2.24. STATION_NODE_PURG
Use this API to delete a node in an existing substation.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_NODE_PURG STATION NODE
Python command syntax:
ierr = station_node_purg(station, node)
Fortran command syntax:
CALL PURG_NODE(STATION, NODE, IERR)
Where:
Integer STATION substation number (input; no default allowed).
Integer NODE node number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 working case is empty
IERR = 2 invalid substation number
IERR = 3 substation not found
IERR = 4 invalid node number
IERR = 5 node not found
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
995
Node Breaker STATION_NUMBER
2.2.25. STATION_NUMBER
Use this API to change a substation number for an existing substation.
This API routine was first introduced in release 34.0.1.
Batch command syntax:
BAT_STATION_NUMBER STATION NEWSTATION
Python command syntax:
ierr = station_number(station, newstation)
Fortran command syntax:
CALL STATION_NUMBER(STATION, NEWSTATION, IERR)
Where:
Integer STATION substation number (input).
Integer NEWSTATION new substation number (input).
Integer IERR error code (output).
IERR = 1 invalid substation number.
IERR = 2 substation not found.
IERR = 3 invalid new substation number.
IERR = 4 substation number is already assigned to an-
other substation.
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
996
Node Breaker STATION_PURG
2.2.26. STATION_PURG
Use this API to delete a substation and all node-breaker components within that substation from the work-
ing case. All network elements will remain in the working case and any bus sections will be merged back
into the original bus.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_PURG STATION
Python command syntax:
ierr = station_purg(station)
Fortran command syntax:
CALL PURG_STATION(STATION, IERR)
Where:
Integer STATION substation number (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 invalid substation number
IERR = 2 substation not found
IERR = 3 unable to move all connections back to origi-
nal network 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
997
Node Breaker STATION_SHUNT_TERM_CHNG
2.2.27. STATION_SHUNT_TERM_CHNG
Use this API to change a substation fixed shunt terminal connection in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_SHUNT_TERM_CHNG BUS CKTARG INTGAR
Python command syntax:
ierr = station_shunt_term_chng(bus, cktarg, intgar)
Fortran command syntax:
CALL ST_NSHUNT(BUS, CKTARG, INTGAR, IERR)
Where:
Integer BUS from bus number (input).
Character*2 CKTARG fixed bus shunt identifier (input).
Integer INTGAR node terminal number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 fixed shunt identifier is more than two char-
acters
IERR = 3 fixed shunt is not found
IERR = 4 bus does not have substation model
IERR = 5 node does not exist in substation
IERR = 6 invalid node number
IERR = 7 node-breaker terminal connection table is full
IERR = 8 error when moving shunt terminal connec-
tion
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
998
Node Breaker STATION_SWD_CHNG
2.2.28. STATION_SWD_CHNG
Use this API to modify the data of an existing station switching device in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_SWD_CHNG STATION INODE JNODE CKTARG INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(4) NAMEAR
Python command syntax:
ierr = station_swd_chng(station, inode, jnode, cktarg, intgar, realar,
namear)
Fortran command syntax:
CALL STATION_SWD_CHNG(STATION, INODE, JNODE, CKTARG, INTGAR, REALAR,
NAMEAR, IERR)
Where:
Integer STATION substation number (input).
Integer INODE from node number (input).
Integer JNODE to node number (input).
Character*2 CKTARG circuit identifier (input).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) device status
INTGAR(2) device normal status
INTGAR(3) device type
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) device reactance
REALAR(2) RateA rating
REALAR(3) RateB rating
REALAR(4) RateC rating
Character*40 NAMEAR substation switching device name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 substation is not found
IERR = 2 node is not found
IERR = 3 circuit identifier is more than two characters
IERR = 4 switching device from node to itself
IERR = 5 circuit identifier is invalid
IERR = 6 switching device is not found
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
999
Node Breaker STATION_SWD_CHNG
IERR = -1 data error, warning and information mes-
sages; one or more of: - switching device re-
actance is 0.0. - switching device rating is less
than 0.0. - invalid status. -switching device
name truncated to 40 characters.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1000
Node Breaker STATION_SWD_DATA
2.2.29. STATION_SWD_DATA
Use this API to modify the data of an existing substation switching device in the working case, or to add a
new substation switching device to the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_SWD_DATA STATION INODE JNODE CKTARG INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(4) NAMEAR
Python command syntax:
ierr = station_swd_data(station, inode, jnode, cktarg, intgar, realar,
namear)
Fortran command syntax:
CALL STATION_SWD_DATA(STATION, INODE, JNODE, CKTARG, INTGAR, REALAR,
NAMEAR, IERR)
Where:
Integer STATION substation number (input).
Integer INODE from node number (input).
Integer JNODE to node number (input).
Character*2 CKTARG circuit identifier (input).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) device status
INTGAR(2) device normal status
INTGAR(3) device type
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) device reactance
REALAR(2) RateA rating
REALAR(3) RateB rating
REALAR(4) RateC rating
Character*40 NAMEAR substation switching device name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 substation is not found
IERR = 2 node is not found
IERR = 3 circuit identifier is more than two characters
IERR = 4 switching device from node to itself
IERR = 5 circuit identifier is invalid
IERR = 6 switching device already exists
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1001
Node Breaker STATION_SWD_DATA
IERR = 7 station switching device table is full
IERR = 8 system switching device table is full
IERR = 9 cannot place substation switching device be-
tween nodes residing in different substations
IERR = 10 cannot place substation switching device be-
tween nodes belonging to two different bus-
es in the same substation
IERR = 11 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - switching device re-
actance is 0.0. - switching device rating is less
than 0.0. - invalid status. - switching device
name truncated to 40 characters.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1002
Node Breaker STATION_SWD_MBID
2.2.30. STATION_SWD_MBID
Use this API to modify the circuit identifier of an existing station switching device in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_SWD_MBID STATION INODE JNODE CKTARG CKTNEW
Python command syntax:
ierr = station_swd_mbid(station, inode, jnode, cktarg, cktnew)
Fortran command syntax:
CALL STATION_MSWDID(STATION, INODE, JNODE, CKTARG, CKTNEW, IERR)
Where:
Integer STATION substation number (input).
Integer INODE from node number (input).
Integer JNODE to node number (input).
Character*2 CKTARG circuit identifier (input).
Character*2 CKTNEW new circuit identifier (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 substation is not found
IERR = 2 node is not found
IERR = 3 circuit identifier is more than two characters
IERR = 4 switching device from node to itself
IERR = 5 circuit identifier is invalid
IERR = 6 switching device is not found
IERR = 7 circuit identifier connecting these nodes al-
ready exists
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
1003
Node Breaker STATION_SWD_MOVE
2.2.31. STATION_SWD_MOVE
Use this API to move the "to" node of an existing substation switching device in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_SWD_MOVE STATION INODE JNODE CKTARG KNODE CKTNEW
Python command syntax:
ierr = station_swd_move(station, inode, jnode, cktarg, knode, cktnew)
Fortran command syntax:
CALL MOVE_STATION_SWD(STATION, INODE, JNODE, CKTARG, KNODE, CKTNEW, IERR)
Where:
Integer STATION substation number (input).
Integer INODE from node number (input).
Integer JNODE to node number (input).
Character*2 CKTARG circuit identifier (input).
Integer KNODE new to node number (input).
Character*2 CKTNEW new circuit identifier (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 working case is empty
IERR = 2 invalid substation number
IERR = 3 substation is not found
IERR = 4 invalid node number
IERR = 5 node number is not found in substation
IERR = 6 switching device is not found
IERR = 7 switching device already exists
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
1004
Node Breaker STATION_SWD_PURG
2.2.32. STATION_SWD_PURG
Use this API to delete an existing substation switching device in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_SWD_PURG STATION INODE JNODE CKTARG
Python command syntax:
ierr = station_swd_purg(station, inode, jnode, cktarg)
Fortran command syntax:
CALL PURG_STATION_SWD(STATION, INODE, JNODE, CKTARG, IERR)
Where:
Integer STATION substation number (input).
Integer INODE from node number (input).
Integer JNODE to node number (input).
Character*2 CKTARG circuit identifier (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 working case is empty
IERR = 2 invalid substation number
IERR = 3 substation is not found
IERR = 4 invalid node number
IERR = 5 node number is not found in substation
IERR = 6 switching device is not found
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
1005
Node Breaker STATION_SWS_SHUNT_TERM_CHNG
2.2.33. STATION_SWS_SHUNT_TERM_CHNG
This API routine is obsolete. It has been replaced by the API routine station_sws_shunt_term_chng_2 .
Use this API to change a substation switched shunt node terminal connection in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_SWS_SHUNT_TERM_CHNG BUS INTGAR
Python command syntax:
ierr = station_sws_shunt_term_chng(bus, intgar)
Fortran command syntax:
CALL ST_NSWSHUNT(BUS, INTGAR, IERR)
Where:
Integer BUS (input).
Integer INTGAR (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 switched shunt does not exist
IERR = 3 bus does not belong to a substation
IERR = 4 node not found in substation
IERR = 5 invalid node number
IERR = 6 error when moving switched shunt
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
1006
Node Breaker STATION_SWS_SHUNT_TERM_CHNG_2
2.2.34. STATION_SWS_SHUNT_TERM_CHNG_2
Use this API to change a substation switched shunt node terminal connection in the working case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_STATION_SWS_SHUNT_TERM_CHNG_2 BUS ID INTGAR
Python command syntax:
ierr = station_sws_shunt_term_chng_2(bus, id, intgar)
Fortran command syntax:
CALL ST_NSWSHUNT_2(BUS, ID, INTGAR, IERR)
Where:
Integer BUS Number of the bus to which the switched shunt is connected (input).
character*2 ID switched shunt identifier (input).
Integer INTGAR Terminal node number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 switched shunt identifier is more than two
characters
IERR = 3 switched shunt not found
IERR = 4 bus does not belong to a substation
IERR = 5 node not found in substation
IERR = 6 invalid node number
IERR = 7 node-breaker terminal connection table is full
IERR = 8 error when moving switched shunt terminal
connection
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
1007
Node Breaker STATION_THREE_WND_TERM_CHNG
2.2.35. STATION_THREE_WND_TERM_CHNG
Use this API to access existing substation three-winding transformer terminal data in the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_THREE_WND_TERM_CHNG IBUS JBUS KBUS CKTARG
INTGAR(1)..INTGAR(3)
Python command syntax:
ierr = station_three_wnd_term_chng(ibus, jbus, kbus, cktarg, intgar)
Fortran command syntax:
CALL ST_NTHREE_WINDING(IBUS, JBUS, KBUS, CKTARG, INTGAR, IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Integer KBUS to bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) from node number
INTGAR(2) to node number
INTGAR(3) to node number
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 bus does not belong to a substation
IERR = 3 node does not exist
IERR = 4 node number is invalid
IERR = 5 circuit identifier is more than two characters
IERR = 6 circuit identifier may not start with &
IERR = 7 circuit does not exist
IERR = 8 error encountered when moving transformer
IERR = 9 node-breaker terminal connection table is full
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
1008
Node Breaker STATION_THREE_WND_TERM_MOVE
2.2.36. STATION_THREE_WND_TERM_MOVE
Use this API to move one terminal node connection of a three-winding transformer in the working case.
The third bus argument (KBUS) is the bus at which the node connection will be moved to the node desig-
nated in the DSNODE argument. IBUS and JBUS are the other two three winding transformer bus connec-
tions.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_STATION_THREE_WND_TERM_MOVE IBUS JBUS KBUS CKTARG DSNODE
Python command syntax:
ierr = station_three_wnd_term_move(ibus, jbus, kbus, cktarg, dsnode)
Fortran command syntax:
CALL MOVE3WTERMINAL(IBUS, JBUS, KBUS, CKTARG, DSNODE, IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Integer KBUS third bus number. This is the bus for which the node connection will
be moved to the node designated in DSNODE. (input).
Character*2 CKTARG circuit identifier (input).
Integer DSNODE new terminal node number (input).
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 bus does not exist
IERR = 2 bus does not belong to a substation
IERR = 3 node does not exist
IERR = 4 invalid node number
IERR = 5 circuit identifier is more than two characters
IERR = 6 circuit identifier may not start with &
IERR = 7 circuit does not exist
IERR = 8 error encountered when moving transformer
IERR = 9 node-breaker terminal connection table is full
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
1009
Node Breaker STATION_VSCDC_CONV_TERM_CHNG
2.2.37. STATION_VSCDC_CONV_TERM_CHNG
Use this API to access existing station vsc dc converter terminal data in the working case.
This API routine was first introduced in release 34.3.0.
Batch command syntax:
BAT_STATION_VSCDC_CONV_TERM_CHNG NAME INTGAR(1) INTGAR(2)
Python command syntax:
ierr = station_vscdc_conv_term_chng(name, intgar)
Fortran command syntax:
CALL ST_NVSCDC(NAME, INTGAR, IERR)
Where:
character*12 NAME quoted name of the vsc dc line for which node terminal data for one
or both of its converters is to be specified (input; no default allowed).
Integer INTGAR (2) array of elements specifying (input).
INTGAR(1) node number to which the first converter
end is attached
INTGAR(2) node number to which the second converter
end is attached
Integer IERR error code (output).
IERR = 0 No error
IERR > 0 fatal error occurred
IERR = 1 vsc dc line not found
IERR = 2 bus associated with node is not part of a sub-
station
IERR = 3 node does not exist
IERR = 4 Invalid node number
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
1010
Node Breaker SYSTEM_SWD_CHNG
2.2.38. SYSTEM_SWD_CHNG
Use this API to modify the data of an existing system switching device in the working case, or to add a new
system switching device to the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SYSTEM_SWD_CHNG IBUS JBUS CKTARG INTGAR(1)..INTGAR(4) RBRXAR
REALAR(1)..REALAR(12) NAMEAR
Python command syntax:
ierr = system_swd_chng(ibus, jbus, cktarg, intgar, rbrxar, realar, namear)
Fortran command syntax:
CALL SYSTEM_SWD_CHNG(IBUS, JBUS, CKTARG, INTGAR, RBRXAR, REALAR, NAMEAR,
IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) device status
INTGAR(2) device normal status
INTGAR(3) metered end bus number
INTGAR(4) device type
Real RBRXAR nominal branch reactance (input).
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) rating set 1 rating
REALAR(2) rating set 2 rating
REALAR(3) rating set 3 rating
REALAR(4) rating set 4 rating
REALAR(5) rating set 5 rating
REALAR(6) rating set 6 rating
REALAR(7) rating set 7 rating
REALAR(8) rating set 8 rating
REALAR(9) rating set 9 rating
REALAR(10) rating set 10 rating
REALAR(11) rating set 11 rating
REALAR(12) rating set 12 rating
Character*40 NAMEAR switching device name (input).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1011
Node Breaker SYSTEM_SWD_CHNG
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus is not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a two-winding trans-
former
IERR = 4 branch exists but it is a regular, non-trans-
former barhcn
IERR = 5 switching device from bus to itself
IERR = 6 blank circuit identifier is invalid
IERR = 7 circuit identifier may not start with &
IERR = 8 branch table is full
IERR = 9 branch ownership table is full
IERR = 10 switching device table is full
IERR = 11 prerequisite requirements for API are not met
IERR = 12 zero impedance line table is full
IERR = 13 branch not found
IERR = 14 node-breaker terminal connection table is full
IERR = -1 data error, warning and information mes-
sages; one or more of: - switching device re-
actance is 0.0 or greater than zero impedance
line threshold. - invalid metered end bus. - in-
valid switching device status. - system switch-
ing device name has too many characters -
system switching device rate is negative - ze-
ro impedance line table is full - multi-section
line grouping deleted - name is already as-
signed to a branch - name contains invalid
characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1012
Node Breaker SYSTEM_SWD_DATA
2.2.39. SYSTEM_SWD_DATA
Use this API to add or modify the data of an existing system switching device in the working case, or to add
a new system switching device to the working case.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SYSTEM_SWD_DATA IBUS JBUS CKTARG INTGAR(1)..INTGAR(4) RBRXAR
REALAR(1)..REALAR(12) NAMEAR
Python command syntax:
ierr = system_swd_data(ibus, jbus, cktarg, intgar, rbrxar, realar, namear)
Fortran command syntax:
CALL SYSTEM_SWD_DATA(IBUS, JBUS, CKTARG, INTGAR, RBRXAR, REALAR, NAMEAR,
IERR)
Where:
Integer IBUS from bus number (input).
Integer JBUS to bus number (input).
Character*2 CKTARG circuit identifier (input).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) device status
INTGAR(2) device normal status
INTGAR(3) metered end bus number
INTGAR(4) device type
Real RBRXAR nominal branch reactance (input).
Real REALAR (12) array of 12 elements specifying (input).
REALAR(1) rating set 1 rating
REALAR(2) rating set 2 rating
REALAR(3) rating set 3 rating
REALAR(4) rating set 4 rating
REALAR(5) rating set 5 rating
REALAR(6) rating set 6 rating
REALAR(7) rating set 7 rating
REALAR(8) rating set 8 rating
REALAR(9) rating set 9 rating
REALAR(10) rating set 10 rating
REALAR(11) rating set 11 rating
REALAR(12) rating set 12 rating
Character*40 NAMEAR switching device name (input).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1013
Node Breaker SYSTEM_SWD_DATA
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus is not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 branch exists but it is a two-winding trans-
former
IERR = 4 branch exists but it is a regular, non-trans-
former barhcn
IERR = 5 switching device from bus to itself
IERR = 6 blank circuit identifier is invalid
IERR = 7 circuit identifier may not start with &
IERR = 8 branch table is full
IERR = 9 branch ownership table is full
IERR = 10 switching device table is full
IERR = 11 prerequisite requirements for API are not met
IERR = 12 zero impedance line table is full
IERR = 13 branch already exists
IERR = 14 node-breaker terminal connection table is full
IERR = -1 data error, warning and information mes-
sages; one or more of: - switching device re-
actance is 0.0 or greater than zero impedance
line threshold. - invalid metered end bus. - in-
valid switching device status. - system switch-
ing device name has too many characters -
system switching device rate is negative - ze-
ro impedance line table is full - multi-section
line grouping deleted. - name is already as-
signed to a branch - name contains invalid
characters
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1014
Node Breaker SYSTEM_SWD_DATA
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1015
Node Breaker SYSTEM_SWD_DATA
This section describes the API routines used to add or modify power flow data pertaining to substation data.
For most categories of power flow substation data, there are a pair of API routines for specifying data; one of
these contains "_DATA" as part of the API name, and the other contains "_CHNG" in its API name. The "_DATA"
API routines may be used to add a new network element to the working case, or to modify the data of an
existing network element. The "_CHNG" API routines may be used only to modify the data of an existing
network element; specifying a network element that does not already exist in the working case to one of the
"_CHNG" API routines is treated as a fatal error by the API routine.
Generally, when an API is adding a new element to the working case, data items that are defaulted are set
to the value listed in the data item’s description. When an API is modifying the data of an existing element,
defaulted data items are unchanged.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1016
Chapter 3
Optimal Power Flow
This chapter describes the API routines used in PSS®E Optimal Power Flow, or OPF.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1017
Optimal Power Flow Optimal Power Flow Operation
3.1. Optimal Power Flow Operation
3.1.1. ADD_DETAILS_TO_OPF_LOG
Use this API to specify or return the value of the OPF solution option to add details of the sensitivity values
and Lagrange multipliers to the OPF Output Log file.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_ADD_DETAILS_TO_OPF_LOG IVAL
Python command syntax:
ierr = add_details_to_opf_log(ival)
ierr, ival = add_details_to_opf_log()
Fortran command syntax:
CALL ADD_DETAILS_TO_OPF_LOG(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to append the OPF log file with information on
sensitivity values and Lagrange multipliers (input; input if Batch com-
mand or for Python if specified as an argument, or for FORTRAN if
IOCODE is 0; else output, 0 by default).
IVAL = 0 do not print additional details in log file.
IVAL = 1 print additional details.
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
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
1018
Optimal Power Flow APPLY_ALTERNATE_STEP_SIZE
3.1.2. APPLY_ALTERNATE_STEP_SIZE
Use this API to specify or return the value of the OPF solution option for applying an alternate lambda mis-
match step size. This option works in conjunction with the OPF_BARRIER_STEP_LENGTH option setting
(Section 3.1.25), which specifies the alternate barrier step length value.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_APPLY_ALTERNATE_STEP_SIZE IVAL
Python command syntax:
ierr = apply_alternate_step_size(ival)
ierr, ival = apply_alternate_step_size()
Fortran command syntax:
CALL APPLY_ALTERNATE_STEP_SIZE(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to limit the step size taken during the OPF solution
(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 do not limit the step size.
IVAL = 1 limit the step size.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1019
Optimal Power Flow APPLY_AUTOMATIC_SCALING
3.1.3. APPLY_AUTOMATIC_SCALING
Use this API to specify or return the value of the OPF solution option to apply automatic scaling of the ob-
jective coefficients and derivatives to improve convergence of the OPF solution.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_APPLY_AUTOMATIC_SCALING IVAL
Python command syntax:
ierr = apply_automatic_scaling(ival)
ierr, ival = apply_automatic_scaling()
Fortran command syntax:
CALL APPLY_AUTOMATIC_SCALING(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to apply automatic scaling of the objective during
the solution (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 do not apply automatic scaling of the objec-
tive.
IVAL = 1 apply automatic scaling of the objective.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1020
Optimal Power Flow BAD_ITER_COARSE_LIMIT
3.1.4. BAD_ITER_COARSE_LIMIT
Use this API to specify or return the number of bad iterations allowed when the barrier coefficient is
greater than 0.011 (mu greater then -2) before the solution progress is terminated as being infeasible.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_BAD_ITER_COARSE_LIMIT IVAL
Python command syntax:
ierr = bad_iter_coarse_limit(ival)
ierr, ival = bad_iter_coarse_limit()
Fortran command syntax:
CALL BAD_ITER_COARSE_LIMIT(IVAL, IOCODE, IERR)
Where:
Integer IVAL Bad iteration coarse limit value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1021
Optimal Power Flow BAD_ITER_FINE_LIMIT
3.1.5. BAD_ITER_FINE_LIMIT
Use this API to specify or return the the bad iteration limit when the barrier coefficient is less than, or equal
to 0.011 (mu less than or equal to -2) before the solution progress is terminated as being infeasible.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_BAD_ITER_FINE_LIMIT IVAL
Python command syntax:
ierr = bad_iter_fine_limit(ival)
ierr, ival = bad_iter_fine_limit()
Fortran command syntax:
CALL BAD_ITER_FINE_LIMIT(IVAL, IOCODE, IERR)
Where:
Integer IVAL Bad iteration fine limit value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1022
Optimal Power Flow CLAMP_NONOPTIMIZED_GENS
3.1.6. CLAMP_NONOPTIMIZED_GENS
Use this API to specify or return the value of the OPF solution option to apply the clamp equation to
non-optimized generators. The behavior of the clamp equation may be further customized through the
OPF_INITIAL_CLAMP_TOL, OPF_FINAL_CLAMP_TOL and the OPF_CLAMP_DECAY_FACTOR option settings.
For additional information on the clamp treatment of non-optimized generators, refer to Clamp Treatment
in the PSSE Program Operation Manual.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_CLAMP_NONOPTIMIZED_GENS IVAL
Python command syntax:
ierr = clamp_nonoptimized_gens(ival)
ierr, ival = clamp_nonoptimized_gens()
Fortran command syntax:
CALL CLAMP_NONOPTIMIZED_GENS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to apply the clamp equation to nonoptimized gen-
erators (input; if Batch command, or for Python if specified as an ar-
gument, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not clamp nonoptimized generators.
IVAL = 1 clamp nonoptimized generators.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1023
Optimal Power Flow CONSTRAIN_INTERFACE_FLOWS
3.1.7. CONSTRAIN_INTERFACE_FLOWS
Use this API to specify or return the value of the OPF option to constrain interface flows. The set-
ting of this option affects recognition of any interface flow constraints and the behavior of the
MINIMIZE_INTERFACE_FLOWS objective function option.
If the Constrain Interface Flows option is not enabled, the Minimize Interrface Flows objective and any in-
terface flow constraints will be ignored and not used.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_CONSTRAIN_INTERFACE_FLOWS IVAL
Python command syntax:
ierr = constrain_interface_flows(ival)
ierr, ival = constrain_interface_flows()
Fortran command syntax:
CALL CONSTRAIN_INTERFACE_FLOWS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the option to constrain interface flows
(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 do not constrain interface flows.
IVAL = 1 constrain interface flows.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1024
Optimal Power Flow FINAL_OPF_BARRIER_COEFF
3.1.8. FINAL_OPF_BARRIER_COEFF
Use this API to specify or return the value of the final coefficient value that the barrier function is attempt-
ing to attain. It may be used in conjunction with the INITIAL_OPF_BARRIER_COEFF value.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_FINAL_OPF_BARRIER_COEFF RVAL
Python command syntax:
ierr = final_opf_barrier_coeff(rval)
ierr, rval = final_opf_barrier_coeff()
Fortran command syntax:
CALL FINAL_OPF_BARRIER_COEFF(RVAL, IOCODE, IERR)
Where:
Real RVAL final barrier coefficient value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1025
Optimal Power Flow IMPORT_ECDI
3.1.9. IMPORT_ECDI
Use this API to import data from an Economics Dispatch Data File, as prepared for use in activity ECDI, into
the OPF working data. This function removes all existing Optimal Power Flow Generator Dispatch Data, Ac-
tive Power Dispatch Data, and Cost Curve Data, before adding new records from the ECD file.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_IMPORT_ECDI FILE
Python command syntax:
ierr = import_ecdi(file)
Fortran command syntax:
CALL IMPORT_ECDI(FILE, IERR)
Where:
Character*260 FILE name of the Economics Dispatch Data File (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 NEWOPF_API error occurred
IERR = 2 ECDIAPI error occurred
IERR = 3 CSTTBL_QUAD_API error occurred
IERR = 4 OPFDSP_TBL_API error occurred
IERR = 5 GENDSP_INDV_API error occurred
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
1026
Optimal Power Flow INITIAL_OPF_BARRIER_COEFF
3.1.10. INITIAL_OPF_BARRIER_COEFF
Use this API to specify or return the value of the initial OPF barrier coefficient. It may be used in conjunc-
tion with the FINAL_OPF_BARRIER_COEFF value.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_INITIAL_OPF_BARRIER_COEFF RVAL
Python command syntax:
ierr = initial_opf_barrier_coeff(rval)
ierr, rval = initial_opf_barrier_coeff()
Fortran command syntax:
CALL INITIAL_OPF_BARRIER_COEFF(RVAL, IOCODE, IERR)
Where:
Real RVAL initial barrier coefficient value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1027
Optimal Power Flow INTERFACE_FLOW_COST_COEFF
3.1.11. INTERFACE_FLOW_COST_COEFF
Use this API to specify or return the value of the coefficient for the interface flow objective. This API works
in conjunction with the MINIMIZE_INTERFACE_FLOWS objective function option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_INTERFACE_FLOW_COST_COEFF RVAL
Python command syntax:
ierr = interface_flow_cost_coeff(rval)
ierr, rval = interface_flow_cost_coeff()
Fortran command syntax:
CALL INTERFACE_FLOW_COST_COEFF(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the interface flow cost coefficient (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1028
Optimal Power Flow LSTO
3.1.12. LSTO
Use this API to list OPF working case data in a form suitable for data documentation.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LSTO SID ALL OPT VREV
Python command syntax:
ierr = lsto(sid, all, opt, vrev)
Fortran command syntax:
CALL LSTONW(SID, ALL, OPT, VREV, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Integer OPT number corresponding to the category of OPF data that is to be tabu-
lated (input; no default allowed).
OPT = 1 case summary
OPT = 2 bus attribute data
OPT = 3 adjustable bus shunt data
OPT = 4 bus load data
OPT = 5 adjustable bus load table data
OPT = 6 generator dispatch data
OPT = 7 active power dispatch data
OPT = 8 generation reserve data
OPT = 9 generator reactive capability data
OPT = 10 adjustable branch reactance data
OPT = 11 linear cost table data
OPT = 12 quadratic cost table data
OPT = 13 polynomial and exponential cost table data
OPT = 14 period reserve constraint data
OPT = 15 branch flow constraint data
OPT = 16 interface flow constraint data
OPT = 17 linear constraint dependency data
OPT = 21 full listing
Integer VREV option to change voltage units from the default units to the alternate
units (input; no default allowed).
VREV = 0 use default voltage units.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1029
Optimal Power Flow LSTO
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
1030
Optimal Power Flow MINIMIZE_ADJ_BUS_SHUNTS
3.1.13. MINIMIZE_ADJ_BUS_SHUNTS
Use this API to specify or return the value of the OPF minimize adjustable bus shunts (var compensation)
objective function option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_ADJ_BUS_SHUNTS IVAL
Python command syntax:
ierr = minimize_adj_bus_shunts(ival)
ierr, ival = minimize_adj_bus_shunts()
Fortran command syntax:
CALL MINIMIZE_ADJ_BUS_SHUNTS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize adjustable bus shunts ob-
jective (input; if Batch command, or for Python if specified as an ar-
gument, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not enable the minimize adjustable bus
shunts objective.
IVAL = 1 enable the minimize adjustable bus shunts
objective.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1031
Optimal Power Flow MINIMIZE_FUEL_COST
3.1.14. MINIMIZE_FUEL_COST
Use this API to specify or return the value of the OPF minimize fuel cost objective option. The Minimize fu-
el cost objective and Minimize active power loss objective cannot be simultaneously employed due to the
competing goals.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_FUEL_COST IVAL
Python command syntax:
ierr = minimize_fuel_cost(ival)
ierr, ival = minimize_fuel_cost()
Fortran command syntax:
CALL MINIMIZE_FUEL_COST(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize fuel cost objective (input; if
Batch command, or for Python if specified as an argument, or for For-
tran if IOCODE is 0, then input of 0 by default; else output).
IVAL = 0 do not enable the minimize fuel cost objec-
tive.
IVAL = 1 enable the minimize fuel cost objective.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1032
Optimal Power Flow MINIMIZE_INTERFACE_FLOWS
3.1.15. MINIMIZE_INTERFACE_FLOWS
Use this API to specify or return the value of the OPF minimize interface flows objective option. Used in
conjuction with INTERFACE_FLOW_COST_COEFFICIENT. A negative coefficient value will maximize inter-
face flows.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_INTERFACE_FLOWS IVAL
Python command syntax:
ierr = minimize_interface_flows(ival)
ierr, ival = minimize_interface_flows()
Fortran command syntax:
CALL MINIMIZE_INTERFACE_FLOWS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize interface flows objective
(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 do not enable the minimize interface flows
objective.
IVAL = 1 enable the minimize interface flows objec-
tive.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1033
Optimal Power Flow MINIMIZE_LOAD_ADJUSTMENTS
3.1.16. MINIMIZE_LOAD_ADJUSTMENTS
Use this API to specify or return the value of the OPF minimize adjustable bus load objective option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_LOAD_ADJUSTMENTS IVAL
Python command syntax:
ierr = minimize_load_adjustments(ival)
ierr, ival = minimize_load_adjustments()
Fortran command syntax:
CALL MINIMIZE_LOAD_ADJUSTMENTS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize adjustable bus loads objec-
tive (input; if Batch command, or for Python if specified as an argu-
ment, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not enable the minimize adjustable bus
loads objective.
IVAL = 1 enable the minimize adjustable bus loads ob-
jective.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1034
Optimal Power Flow MINIMIZE_P_LOSSES
3.1.17. MINIMIZE_P_LOSSES
Use this API to specify or return the value of the OPF minimize active power loss objective option. The Mini-
mize active power loss objective and Minimize fuel cost objective cannot be simultaneously employed due
to the competing goals
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_P_LOSSES IVAL
Python command syntax:
ierr = minimize_p_losses(ival)
ierr, ival = minimize_p_losses()
Fortran command syntax:
CALL MINIMIZE_P_LOSSES(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize active power loss objective
(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 do not enable the minimize active power loss
objective.
IVAL = 1 enable the minimize active power loss objec-
tive.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1035
Optimal Power Flow MINIMIZE_P_SLACK
3.1.18. MINIMIZE_P_SLACK
Use this API to specify or return the value of the OPF minimize active power slack objective option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_P_SLACK IVAL
Python command syntax:
ierr = minimize_p_slack(ival)
ierr, ival = minimize_p_slack()
Fortran command syntax:
CALL MINIMIZE_P_SLACK(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize active power slack objec-
tive (input; if Batch command, or for Python if specified as an argu-
ment, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not enable the minimize active power
slack objective.
IVAL = 1 enable the minimize active power slack objec-
tive.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1036
Optimal Power Flow MINIMIZE_Q_LOSSES
3.1.19. MINIMIZE_Q_LOSSES
Use this API to specify or return the value of the OPF minimize reactive power loss objective option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_Q_LOSSES IVAL
Python command syntax:
ierr = minimize_q_losses(ival)
ierr, ival = minimize_q_losses()
Fortran command syntax:
CALL MINIMIZE_Q_LOSSES(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize reactive power loss objec-
tive (input; if Batch command, or for Python if specified as an argu-
ment, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not enable the minimize reactive power
loss objective.
IVAL = 1 enable the minimize reactive power loss ob-
jective.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1037
Optimal Power Flow MINIMIZE_Q_SLACK
3.1.20. MINIMIZE_Q_SLACK
Use this API to specify or return the value of the OPF minimize reactive power slack objective option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_Q_SLACK IVAL
Python command syntax:
ierr = minimize_q_slack(ival)
ierr, ival = minimize_q_slack()
Fortran command syntax:
CALL MINIMIZE_Q_SLACK(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize reactive power slack objec-
tive (input; if Batch command, or for Python if specified as an argu-
ment, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not enable the minimize reactive power
slack objective.
IVAL = 1 enable the minimize reactive power slack ob-
jective.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1038
Optimal Power Flow MINIMIZE_REACTIVE_RESERVE
3.1.21. MINIMIZE_REACTIVE_RESERVE
Use this API to specify or return the value of the OPF minimize reactive reserve objective option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_REACTIVE_RESERVE IVAL
Python command syntax:
ierr = minimize_reactive_reserve(ival)
ierr, ival = minimize_reactive_reserve()
Fortran command syntax:
CALL MINIMIZE_REACTIVE_RESERVE(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize reactive reserves objective
(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 do not enable the minimize reactive reserves
objective.
IVAL = 1 enable the minimize reactive reserves objec-
tive.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1039
Optimal Power Flow MINIMIZE_SERIES_COMP
3.1.22. MINIMIZE_SERIES_COMP
Use this API to specify or return the value of the OPF minimize series compensation (adjustable branch re-
actance) objective option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_MINIMIZE_SERIES_COMP IVAL
Python command syntax:
ierr = minimize_series_comp(ival)
ierr, ival = minimize_series_comp()
Fortran command syntax:
CALL MINIMIZE_SERIES_COMP(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the minimize series compensation ob-
jective (input; if Batch command, or for Python if specified as an ar-
gument, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not enable the minimize series compensa-
tion objective.
IVAL = 1 enable the minimize series compensation ob-
jective.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1040
Optimal Power Flow NOPF
3.1.23. NOPF
Use this API to run the Optimal Power Flow solution. Subsystems that have been specified will be opti-
mized to the objectives and tolerances specified, if a solution is achievable.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_NOPF SID ALL
Python command syntax:
ierr = nopf(sid, all)
Fortran command syntax:
CALL NOPF_SOLVE(SID, ALL, IERR)
Where:
Integer SID a valid bus subsystem ID from 0 to 11. A bus subsystem must have
been previously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
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 error initializing OPF data
IERR = 4 generators are converted
IERR = 5 Topology error: buses exist with bus type
code and series element status inconsisten-
cies
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
1041
Optimal Power Flow OPEN_BUS_VOLTAGE_LIMITS
3.1.24. OPEN_BUS_VOLTAGE_LIMITS
Use this API to specify or return the value of the OPF solution option to automatically adjust bus voltage
limits, making them more open for initial feasibility.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPEN_BUS_VOLTAGE_LIMITS IVAL
Python command syntax:
ierr = open_bus_voltage_limits(ival)
ierr, ival = open_bus_voltage_limits()
Fortran command syntax:
CALL OPEN_BUS_VOLTAGE_LIMITS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to open bus voltage limits for initial feasibility (in-
put; 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 do not open up bus voltage limits.
IVAL = 1 open bus voltage limits for initial feasibility.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1042
Optimal Power Flow OPF_BARRIER_STEP_LENGTH
3.1.25. OPF_BARRIER_STEP_LENGTH
Use this API to specify or return the value of the barrier function step length setting.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_BARRIER_STEP_LENGTH RVAL
Python command syntax:
ierr = opf_barrier_step_length(rval)
ierr, rval = opf_barrier_step_length()
Fortran command syntax:
CALL OPF_BARRIER_STEP_LENGTH(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the barrier function step length (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1043
Optimal Power Flow OPF_CLAMP_DECAY_FACTOR
3.1.26. OPF_CLAMP_DECAY_FACTOR
Use this API to specify or return the value of the clamp equation decay factor. This API works in con-
junction with the API option to CLAMP_NONOPTIMIZED_GENS, and is associated with the APIs for
OPF_INITIAL_CLAMP_TOL and OPF_FINAL_CLAMP_TOL.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_CLAMP_DECAY_FACTOR RVAL
Python command syntax:
ierr = opf_clamp_decay_factor(rval)
ierr, rval = opf_clamp_decay_factor()
Fortran command syntax:
CALL OPF_CLAMP_DECAY_FACTOR(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the clamp equation decay factor (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1044
Optimal Power Flow OPF_FINAL_CLAMP_TOL
3.1.27. OPF_FINAL_CLAMP_TOL
Use this API to specify or return the value of the final clamp tolerance. This API works in conjunc-
tion with the API option to CLAMP_NONOPTIMIZED_GENS, and is associated with the APIs for
OPF_INITIAL_CLAMP_TOL and the OPF_CLAMP_DECAY_FACTOR.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_FINAL_CLAMP_TOL RVAL
Python command syntax:
ierr = opf_final_clamp_tol(rval)
ierr, rval = opf_final_clamp_tol()
Fortran command syntax:
CALL OPF_FINAL_CLAMP_TOL(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the final clamp tolerance (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1045
Optimal Power Flow OPF_FIXED_VOLTAGE_PENALTY
3.1.28. OPF_FIXED_VOLTAGE_PENALTY
Use this API to specify or return the value of the penalty for fixed voltage excursions.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_FIXED_VOLTAGE_PENALTY RVAL
Python command syntax:
ierr = opf_fixed_voltage_penalty(rval)
ierr, rval = opf_fixed_voltage_penalty()
Fortran command syntax:
CALL OPF_FIXED_VOLTAGE_PENALTY(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the penalty for fixed voltage excursions (input; if Batch com-
mand, or for Python if specified as an argument, or for Fortran if
IOCODE is 0, then input of 0 by default; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1046
Optimal Power Flow OPF_FIX_ALL_GENERATORS
3.1.29. OPF_FIX_ALL_GENERATORS
Use this API to specify or return the value of the OPF option to treat all generators as nonoptimized (fixed).
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_FIX_ALL_GENERATORS IVAL
Python command syntax:
ierr = opf_fix_all_generators(ival)
ierr, ival = opf_fix_all_generators()
Fortran command syntax:
CALL OPF_FIX_ALL_GENERATORS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the option to treat all generators as
nonoptimized and fix their settings (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 do not treat all generators as nonoptimized.
IVAL = 1 treat all generators as nonoptimized.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1047
Optimal Power Flow OPF_FIX_PHASE_SHIFTERS
3.1.30. OPF_FIX_PHASE_SHIFTERS
Use this API to specify or return the value of the OPF option to fix transformer phase shift angle settings.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_FIX_PHASE_SHIFTERS IVAL
Python command syntax:
ierr = opf_fix_phase_shifters(ival)
ierr, ival = opf_fix_phase_shifters()
Fortran command syntax:
CALL OPF_FIX_PHASE_SHIFTERS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the option to fix transformer phase shift
angles (input; if Batch command, or for Python if specified as an ar-
gument, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not fix transformer phase shift angle set-
tings.
IVAL = 1 fix transformer phase shift angle settings.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1048
Optimal Power Flow OPF_FIX_SWITCHED_SHUNTS
3.1.31. OPF_FIX_SWITCHED_SHUNTS
Use this API to specify or return the value of the OPF option to fix switched shunt settings.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_FIX_SWITCHED_SHUNTS IVAL
Python command syntax:
ierr = opf_fix_switched_shunts(ival)
ierr, ival = opf_fix_switched_shunts()
Fortran command syntax:
CALL OPF_FIX_SWITCHED_SHUNTS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the option to fix switched shunt settings
(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 do not fix switched shunt settings.
IVAL = 1 fix switched shunt settings.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1049
Optimal Power Flow OPF_FIX_TAP_RATIOS
3.1.32. OPF_FIX_TAP_RATIOS
Use this API to specify or return the value of the OPF option to fix transformer tap ratio settings.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_FIX_TAP_RATIOS IVAL
Python command syntax:
ierr = opf_fix_tap_ratios(ival)
ierr, ival = opf_fix_tap_ratios()
Fortran command syntax:
CALL OPF_FIX_TAP_RATIOS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the option to fix transformer tap ratio
settings (input; if Batch command, or for Python if specified as an ar-
gument, or for Fortran if IOCODE is 0, then input of 0 by default; else
output).
IVAL = 0 do not fix transformer tap ratio settings.
IVAL = 1 fix transformer tap ratio settings.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1050
Optimal Power Flow OPF_INITIAL_CLAMP_TOL
3.1.33. OPF_INITIAL_CLAMP_TOL
Use this API to specify or return the value of the initial clamp tolerance. This API works in con-
junction with the API option to CLAMP_NONOPTIMIZED_GENS, and is associated with the APIs for
OPF_FINAL_CLAMP_TOL and the OPF_CLAMP_DECAY_FACTOR.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_INITIAL_CLAMP_TOL RVAL
Python command syntax:
ierr = opf_initial_clamp_tol(rval)
ierr, rval = opf_initial_clamp_tol()
Fortran command syntax:
CALL OPF_INITIAL_CLAMP_TOL(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the initial clamp tolerance (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1051
Optimal Power Flow OPF_INTERIOR_SHIFT_FACTOR
3.1.34. OPF_INTERIOR_SHIFT_FACTOR
Use this API to specify or return the value of the interior shift factor multiplier. This value indicates by how
much a variable should be moved "more interior" of the upper and lower limits.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_OPF_INTERIOR_SHIFT_FACTOR RVAL
Python command syntax:
ierr = opf_interior_shift_factor(rval)
ierr, rval = opf_interior_shift_factor()
Fortran command syntax:
CALL OPF_INTERIOR_SHIFT_FACTOR(RVAL, IOCODE, IERR)
Where:
Real RVAL interior shift factor multiplier value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1052
Optimal Power Flow OPF_LAMBDA_TOLERANCE
3.1.35. OPF_LAMBDA_TOLERANCE
Use this API to specify or return the value of the Lagrange multiplier blow-up tolerance during an optimal
power flow solution.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_LAMBDA_TOLERANCE RVAL
Python command syntax:
ierr = opf_lambda_tolerance(rval)
ierr, rval = opf_lambda_tolerance()
Fortran command syntax:
CALL OPF_LAMBDA_TOLERANCE(RVAL, IOCODE, IERR)
Where:
Real RVAL lambda tolerance value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1053
Optimal Power Flow OPF_LF_CONTROL_PENALTY
3.1.36. OPF_LF_CONTROL_PENALTY
Use this API to specify or return the value of the quadratic penalty for loadflow controls. This penalty is ap-
plied to optimized loadflow control variable excursions from their initial condition, in $/pu.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_LF_CONTROL_PENALTY RVAL
Python command syntax:
ierr = opf_lf_control_penalty(rval)
ierr, rval = opf_lf_control_penalty()
Fortran command syntax:
CALL OPF_LF_CONTROL_PENALTY(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the quadratic penalty for loadflow controls (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1054
Optimal Power Flow OPF_MAX_TAP_RATIO_STEP
3.1.37. OPF_MAX_TAP_RATIO_STEP
Use this API to specify or return the value of the maximum transformer tap ratio step.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_MAX_TAP_RATIO_STEP RVAL
Python command syntax:
ierr = opf_max_tap_ratio_step(rval)
ierr, rval = opf_max_tap_ratio_step()
Fortran command syntax:
CALL OPF_MAX_TAP_RATIO_STEP(RVAL, IOCODE, IERR)
Where:
Real RVAL maximum tap ratio step value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1055
Optimal Power Flow OPF_MIN_TAP_RATIO_STEP
3.1.38. OPF_MIN_TAP_RATIO_STEP
Use this API to set or return the value of the minimum transformer tap ratio step.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_MIN_TAP_RATIO_STEP RVAL
Python command syntax:
ierr = opf_min_tap_ratio_step(rval)
ierr, rval = opf_min_tap_ratio_step()
Fortran command syntax:
CALL OPF_MIN_TAP_RATIO_STEP(RVAL, IOCODE, IERR)
Where:
Real RVAL minimum tap ratio step value (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1056
Optimal Power Flow OPF_REGULATE_AREA_INT
3.1.39. OPF_REGULATE_AREA_INT
Use this API to set or return the value of the OPF option to regulate area interchange.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_REGULATE_AREA_INT IVAL
Python command syntax:
ierr = opf_regulate_area_int(ival)
ierr, ival = opf_regulate_area_int()
Fortran command syntax:
CALL OPF_REGULATE_AREA_INT(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to enable the option to regulate area interchange
(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 do not regulate area interchange.
IVAL = 1 regulate area interchange.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1057
Optimal Power Flow OPF_ROUND_SWITCHED_SHUNTS
3.1.40. OPF_ROUND_SWITCHED_SHUNTS
Use this API to set or return the value of the OPF solution option to discretize switched shunts.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_ROUND_SWITCHED_SHUNTS IVAL
Python command syntax:
ierr = opf_round_switched_shunts(ival)
ierr, ival = opf_round_switched_shunts()
Fortran command syntax:
CALL OPF_ROUND_SWITCHED_SHUNTS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to discretize switched shunt settings after initial
solution. (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 do not discretize switched shunt settings.
IVAL = 1 discretize switched shunt settings.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1058
Optimal Power Flow OPF_ROUND_TAP_RATIOS
3.1.41. OPF_ROUND_TAP_RATIOS
Use this API to set or return the value of the OPF solution option to round transformer tap ratio settings.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_ROUND_TAP_RATIOS IVAL
Python command syntax:
ierr = opf_round_tap_ratios(ival)
ierr, ival = opf_round_tap_ratios()
Fortran command syntax:
CALL OPF_ROUND_TAP_RATIOS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to round transformer tap ratio settings (input; if
Batch command, or for Python if specified as an argument, or for For-
tran if IOCODE is 0, then input of 0 by default; else output).
IVAL = 0 do not round transformer tap ratio settings.
IVAL = 1 round transformer tap ratio settings.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1059
Optimal Power Flow OPF_SCALE_QGEN_LIMITS
3.1.42. OPF_SCALE_QGEN_LIMITS
Use this API to set or return the value of the OPF option to scale reactive generation limits in the clamped
constraint equation.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_SCALE_QGEN_LIMITS IVAL
Python command syntax:
ierr = opf_scale_qgen_limits(ival)
ierr, ival = opf_scale_qgen_limits()
Fortran command syntax:
CALL OPF_SCALE_QGEN_LIMITS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to scale reactive generation limits in the clamp
equation (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 do not scale reactive generation limits.
IVAL = 1 scale reactive generation limits.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1060
Optimal Power Flow OPF_STEP_LENGTH_TOLERANCE
3.1.43. OPF_STEP_LENGTH_TOLERANCE
Use this API to set or return the value of the OPF minimum barrier step length tolerance.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_STEP_LENGTH_TOLERANCE RVAL
Python command syntax:
ierr = opf_step_length_tolerance(rval)
ierr, rval = opf_step_length_tolerance()
Fortran command syntax:
CALL OPF_STEP_LENGTH_TOLERANCE(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the minimum barrier step length tolerance (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).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1061
Optimal Power Flow OPF_USE_GENERATOR_VSCHED
3.1.44. OPF_USE_GENERATOR_VSCHED
Use this API to set or return the value of the OPF option to employ the generator scheduled voltage.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_OPF_USE_GENERATOR_VSCHED IVAL
Python command syntax:
ierr = opf_use_generator_vsched(ival)
ierr, ival = opf_use_generator_vsched()
Fortran command syntax:
CALL OPF_USE_GENERATOR_VSCHED(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to use generator scheduled voltage values (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 do not use generator scheduled voltages.
IVAL = 1 use generator scheduled voltages.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1062
Optimal Power Flow OPTO
3.1.45. OPTO
Please use the individual OPF option setting API's described in this section.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPTO SID ALL IARY(1) .. IARY(36) RARY(1) .. RARY(19) OPFILE
RCFILE
Python command syntax:
ierr = opto(sid, all, iary, rary, opfile, rcfile)
Fortran command syntax:
CALL OPTONW(SID, ALL, IARY, RARY, OPFILE, RCFILE, IERR)
Where:
Integer SID a valid bus subsystem ID from 0 to 11. A bus subsystem must have
been previously defined (input).
Integer ALL all buses or specified subsystem flag (input).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Integer IARY (36) array of 36 elements specifying 36 integers, which are defined as
follows(input).
IARY(1) specifies the fuel cost objective
IARY(1) = 0 do not employ minimize fuel cost objective
IARY(1) = 1 employ the minimize fuel cost objective
IARY(2) specifies the active power slack bus genera-
tion objective
IARY(2) = 0 do not employ minimize active power slack
bus generation objective
IARY(2) = 1 employ the minimize active power slack bus
generation objective
IARY(3) specifies the reactive power slack generation
objective
IARY(3) = 0 do not employ the minimize reactive power
slack generation objective
IARY(3) = 1 employ the minimize reactive power slack
generation objective
IARY(4) specifies the active power loss objective
IARY(4) = 0 do not employ the minimize active power
loss objective
IARY(4) = 1 employ the minimize active power loss ob-
jective
IARY(5) specifies the reactive power loss objective
IARY(5) = 0 do not employ the minimize reactive power
loss objective
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1063
Optimal Power Flow OPTO
IARY(5) = 1 employ the minimize reactive power loss ob-
jective
IARY(6) specifies the adjustable branch reactance
(series compensation) objective
IARY(6) = 0 do not employ the minimize adjustable
branch reactance objective
IARY(6) = 1 employ the minimize adjustable branch reac-
tance objective
IARY(7) specifies the adjustable bus shunt (var com-
pensation) objective
IARY(7) = 0 do not employ the minimize adjustable bus
shunt objective
IARY(7) = 1 employ the minimize adjustable bus shunt
objective
IARY(8) specifies the adjustable bus load (load shed-
ding/increase) objective
IARY(8) = 0 do not employ the adjustable bus load objec-
tive
IARY(8) = 1 employ the adjustable bus load objective
IARY(9) specifies the interface flow objective
IARY(9) = 0 do not employ the interface flow objective
IARY(9) = 1 employ the interface flow objective
IARY(10) specifies the reactive generation reserve ob-
jective
IARY(10) = 0 do not employ the reactive generation re-
serve objective
IARY(10) = 1 employ the reactive generation reserve ob-
jective
IARY(11) specifies whether to apply the power flow
mismatch tolerance to the dual variable
problem
IARY(11) = 0 apply tolerance to the mismatch equation
only
IARY(11) = 1 apply tolerance to the entire equation
IARY(12) specifies whether to apply the clamp equa-
tion to nonoptimized generators
IARY(12) = 0 do not clamp nonoptimized generators
IARY(12) = 1 clamp nonoptimized generators
IARY(13) specifies whether to apply the clamp equa-
tion to nonoptimized transformers. (Not cur-
rently functional)
IARY(13) = 0 do not clamp nonoptimized transformers
IARY(13) = 1 clamp nonoptimized transformers
IARY(14) specifies whether to constrain interface
flows
IARY(14) = 0 do not constrain interface flows
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1064
Optimal Power Flow OPTO
IARY(14) = 1 constrain interface flows
IARY(15) specifies whether to employ automatic scal-
ing of the objective
IARY(15) = 0 do not employ automatic scaling
IARY(15) = 1 employ automatic scaling
IARY(16) specifies whether to regulate area inter-
change
IARY(16) = 0 do not regulate area interchange
IARY(16) = 1 regulate area interchange
IARY(17) specifies whether to fix transformer tap ratio
settings
IARY(17) = 0 do not fix transformer tap ratio settings
IARY(17) = 1 fix transformer tap ratio settings
IARY(18) specifies whether to fix transformer phase
shift angles
IARY(18) = 0 do not fix transformer phase shift angles
IARY(18) = 1 fix transformer phase shift angles
IARY(19) specifies whether to fix switched shunt set-
tings
IARY(19) = 0 do not fix switched shunt settings
IARY(19) = 1 fix switched shunt settings
IARY(20) specifies whether to treat all generators as
nonoptimized
IARY(20) = 0 do not treat all generators as nonoptimized
IARY(20) = 1 treat all generators as nonoptimized
IARY(21) specifies whether to employ the generator
scheduled voltage
IARY(21) = 0 do not employ generator scheduled voltage
IARY(21) = 1 use generator scheduled voltage
IARY(22) specifies whether to scale reactive genera-
tion limits on clamped constraint equations
IARY(22) = 0 do not scale reactive generation limits
IARY(22) = 1 scale reactive generation limits
IARY(23) specifies whether to round transformer tap
settings
IARY(23) = 0 do not round transformer tap settings
IARY(23) = 1 round transformer tap settings
IARY(24) specifies whether to round switched shunt
settings
IARY(24) = 0 do not round switched shunt settings
IARY(24) = 1 round switched shunt settings
IARY(25) specifies whether to limit the step size taken
during solution
IARY(25) = 0 do not limit the step size
IARY(25) = 1 limit the step size taken
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1065
Optimal Power Flow OPTO
IARY(26) specifies whether to produce an optimization
log file
IARY(26) = 0 do not produce an optimization log file
IARY(26) = 1 produce an optimization log file
IARY(27) specifies whether to include a detailed listing
of Lagrange multipliers in the optimization
log file. IARY(26) must be set to 1 for this to
take effect
IARY(27) = 0 do not print details
IARY(27) = 1 print Lagrange multipliers
IARY(28) specifies whether to produce a PSSE raw data
change file. (Not currently functional)
IARY(28) = 0 do not produce an Read/Change File
IARY(28) = 1 produce an Read/Change File
IARY(29) specifies whether to save the OPF solution
option settings to the OPF Options File,
PSSOPF.OPT
IARY(29) = 0 do not save settings
IARY(29) = 1 save settings to PSSOPF.OPT
IARY(30) indicates whether the program should open
voltage limits to ensure an initial feasible
condition
IARY(30) = 0 do not have the program open the limits for
an initial feasible condition
IARY(30) = 1 have the program open the limits for an ini-
tial feasible condition
IARY(31) specifies whether to impose emergency bus
voltage limits or normal bus voltage limits
IARY(31) = 0 impose normal voltage limits
IARY(31) = 1 impose emergency bus voltage limits
IARY(32) specifies whether to impose emergency
branch flow limits or normal branch flow lim-
its
IARY(32) = 0 impose normal branch flow limits
IARY(32) = 1 impose emergency branch flow limits
IARY(33) specifies whether to include transformer ad-
justment data in the Read/Change File (if
one is produced according to the setting of
IARY(28)). (Not currently functional)
IARY(33) = 0 do not include transformer adjustment data
IARY(33) = 1 include transformer adjustment data
IARY(34) specifies the maximum iteration limit (corre-
sponds to ITMXN of the power flow solution
parameters)
IARY(35) specifies the bad iteration coarse limit
IARY(36) specifies the bad iteration fine limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1066
Optimal Power Flow OPTO
Real RARY (19) array of 19 elements specifying which are defined as follows(input).
RARY(1) specifies the initial barrier function coeffi-
cient
RARY(2) specifies the final barrier function coefficient
RARY(3) specifies the step length blow-up tolerance
RARY(4) specifies the final clamp equation tolerance
value
RARY(5) specifies the initial clamp equation tolerance
value
RARY(6) specifies the clamp equation decay factor
RARY(7) specifies the cost coefficient for the active
power loss objective
RARY(8) specifies the cost coefficient for the reactive
power loss objective
RARY(9) specifies the penalty value for power flow
controls
RARY(10) specifies the cost coefficient for the interface
flow objective
RARY(11) specifies the cost coefficient for the reactive
generation reserve objective
RARY(12) specifies the penalty value for fixed voltage
RARY(13) specifies the lambda (Lagrange multiplier)
blow-up tolerance
RARY(14) specifies the minimum amount to open up
tap settings by
RARY(15) specifies the maximum amount to open up
tap settings by
RARY(16) specifies the amount to shift the interior
point by during solution
RARY(17) specifies the step length taken for the barrier
method
RARY(18) specifies the tolerance value used to deter-
mine which bus shunts get added to the
Read/Change File as switched shunts (if an
RDCH file is produced according to IARY(28)
and the minimize added vars objective is em-
ployed according to IARY(7)). (Not currently
functional)
RARY(19) specifies the solution convergence tolerance,
in MVA (corresponds to TOLN of the power
flow solution parameters)
Character*260 OPFILE name of the OPF Optimization Log File that will be produced if
IARY(26) is set to 1. It is a good idea to specify the filename in quotes
(input).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1067
Optimal Power Flow OPTO
Character*260 RCFILE name of the PTI Read Change Data File that will be produced if
IARY(28) is set to 1. It is a good idea to specify the filename in
quotes. (Not currently functional) (input).
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 IARY value
IERR = 4 invalid RARY 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
1068
Optimal Power Flow PRODUCE_OPF_LOG_FILE
3.1.46. PRODUCE_OPF_LOG_FILE
Use this API to set or return the value of the OPF solution option to produce an OPF solution log file, and if
so, the name of the log file. This API can be used in conjunction with the ADD_DETAILS_TO_OPF_LOG API if
additional details of the Lagrange multipliers are desired.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PRODUCE_OPF_LOG_FILE IVAL OFILE
Python command syntax:
ierr = produce_opf_log_file(ival, ofile)
ierr, ival,ofile = produce_opf_log_file()
Fortran command syntax:
CALL PRODUCE_OPF_LOG_FILE(IVAL, IOCODE, OFILE, IERR)
Where:
Integer IVAL Indicates whether to produce an OPF Optimization Log File (input; if
Batch command or for Python if specified as an argument, or for For-
tran if IOCODE is 0; else 0 by default for input).
IVAL = 0 do not produce an OPF solution log file.
IVAL = 1 produce an OPF solution log file.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to value specified in
IVAL.
IOCODE = 1 return the current value of the option setting
in IVAL.
Character*260 OFILE OPF Optimization Log output filename (input; if Batch command or
for Python if specified as an argument, or for FORTRAN if IOCODE is
0; else DETAIL.DAT by default for input).
Integer IERR error code (output).
IERR = 0 no error
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
1069
Optimal Power Flow P_LOSSES_COST_COEFF
3.1.47. P_LOSSES_COST_COEFF
Use this API to set or return the value of the coefficient for the active power loss objective (OPF Solution
Options). This API works in conjunction with the MINIMIZE_P_LOSSES objective function option.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_P_LOSSES_COST_COEFF RVAL
Python command syntax:
ierr = p_losses_cost_coeff(rval)
ierr, rval = p_losses_cost_coeff()
Fortran command syntax:
CALL P_LOSSES_COST_COEFF(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the active power loss cost coefficient (input; if Batch com-
mand, or for Python if specified as an argument, or for Fortran if
IOCODE is 0, then input of 0 by default; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1070
Optimal Power Flow Q_LOSSES_COST_COEFF
3.1.48. Q_LOSSES_COST_COEFF
Use this API to set or return the value of the coefficient for the reactive power loss objective. This API works
in conjunction with the API option to MINIMIZE_Q_LOSSES.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_Q_LOSSES_COST_COEFF RVAL
Python command syntax:
ierr = q_losses_cost_coeff(rval)
ierr, rval = q_losses_cost_coeff()
Fortran command syntax:
CALL Q_LOSSES_COST_COEFF(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the reactive power loss cost coefficient (input; if Batch com-
mand, or for Python if specified as an argument, or for Fortran if
IOCODE is 0, then input of 0 by default; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1071
Optimal Power Flow REACTIVE_RESV_COST_COEFF
3.1.49. REACTIVE_RESV_COST_COEFF
Use this API to set or return the value of the coefficient for the reactive reserve objective. This API works in
conjunction with the API option to MINIMIZE_REACTIVE_RESERVE.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_REACTIVE_RESV_COST_COEFF RVAL
Python command syntax:
ierr = reactive_resv_cost_coeff(rval)
ierr, rval = reactive_resv_cost_coeff()
Fortran command syntax:
CALL REACTIVE_RESV_COST_COEFF(RVAL, IOCODE, IERR)
Where:
Real RVAL value of the reactive reserve cost coefficient (input; if Batch com-
mand, or for Python if specified as an argument, or for Fortran if
IOCODE is 0, then input of 0 by default; else output).
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1072
Optimal Power Flow ROPF
3.1.50. ROPF
Use this API to read an Optimal Power Flow Raw Data File.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ROPF RFILE
Python command syntax:
ierr = ropf(rfile)
Fortran command syntax:
CALL ROPFNW(RFILE, IERR)
Where:
Character*260 RFILE Optimal Power Flow Data File name, or '1' if is coming directly from
the terminal or Response file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 error opening file
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
1073
Optimal Power Flow RWOP
3.1.51. RWOP
Use this API to replicate the OPF data contained in the working case in the form of an Optimal Power Flow
Data File.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RWOP SID ALL STATUS(1)..STATUS(4) OUT OFILE
Python command syntax:
ierr = rwop(sid, all, status, out, ofile)
Fortran command syntax:
CALL RWOPNW(SID, ALL, STATUS, OUT, OFILE, IERR)
Where:
Integer SID a valid bus subsystem ID from 0 to 11. A bus subsystem must have
been previously defined (input; no default allowed).
Integer ALL all buses or specified buses subsystem flag (input; no default al-
lowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Integer STATUS (4) array of 4 elements specifying Specifies whether to use various con-
trol options. A value of 0 means the option is not enabled. A value of
1 means the option is enabled.(input).
STATUS(1) include isolated buses
STATUS(2) include out-of-service branches
STATUS(3) include subsystem data
STATUS(4) include subsystem tie lines
Integer OUT option selection (input; no default allowed).
OUT = 0 direct output to a data file specified by OFILE.
OUT = 1 direct output to the current report device.
Character*260 OFILE output filename (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 STATUS(n) 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
1074
Optimal Power Flow SET_OPF_REPORT_SUBSYSTEM
3.1.52. SET_OPF_REPORT_SUBSYSTEM
Use this API to define the subsystem to be used when producing the opf output report. The records con-
tained in the report will be limited to just the equipment residing within the defined subsystem. This in-
cludes bounded and infeasible reactive power generation, regulated buses, transformer tap ratios, trans-
former phase shift angles and bounded switched shunts.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_SET_OPF_REPORT_SUBSYSTEM OSID ALL
Python command syntax:
ierr = set_opf_report_subsystem(osid, all)
Fortran command syntax:
CALL SET_OPF_REPORT_SUBSYSTEM(OSID, ALL, IERR)
Where:
Integer OSID Indicates the previously defined subsystem number to be used for
the opf report (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
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 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1075
Optimal Power Flow USE_DUAL_CRITERIA
3.1.53. USE_DUAL_CRITERIA
Use this API to set or return the value of the OPF solution option to apply the power flow mismatch toler-
ance to the dual variable problem.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_USE_DUAL_CRITERIA IVAL
Python command syntax:
ierr = use_dual_criteria(ival)
ierr, ival = use_dual_criteria()
Fortran command syntax:
CALL USE_DUAL_CRITERIA(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to apply the power flow mismatch tolerance to
the dual variable problem (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 apply tolerance to the mismatch equation on-
ly.
IVAL = 1 apply tolerance to the entire equation.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1076
Optimal Power Flow USE_EMERGENCY_FLOW_LIMITS
3.1.54. USE_EMERGENCY_FLOW_LIMITS
Use this API to set or return the value of the OPF solution option to impose the emergency flow limits in-
stead of the normal flow limits.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_USE_EMERGENCY_FLOW_LIMITS IVAL
Python command syntax:
ierr = use_emergency_flow_limits(ival)
ierr, ival = use_emergency_flow_limits()
Fortran command syntax:
CALL USE_EMERGENCY_FLOW_LIMITS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to use the emergency flow limits instead of the
normal bus voltage limits (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 do not impose the emergency flow limits
(normal flow limits will be imposed).
IVAL = 1 impose emergency flow limits.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1077
Optimal Power Flow USE_EMERGENCY_VOLT_LIMITS
3.1.55. USE_EMERGENCY_VOLT_LIMITS
Use this API to set or return the value of the OPF solution option to impose the emergency bus voltage lim-
its instead of the normal bus voltage limits.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_USE_EMERGENCY_VOLT_LIMITS IVAL
Python command syntax:
ierr = use_emergency_volt_limits(ival)
ierr, ival = use_emergency_volt_limits()
Fortran command syntax:
CALL USE_EMERGENCY_VOLT_LIMITS(IVAL, IOCODE, IERR)
Where:
Integer IVAL Indicates whether to use the emergency bus voltage limits instead of
the normal bus voltage limits (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 do not impose the emergency bus voltage
limits (normal voltage limits will be imposed).
IVAL = 1 impose emergency bus voltage limits.
Integer IOCODE Indicates the operation mode of the API (no default allowed).
IOCODE = 0 set the option setting to 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
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
1078
Optimal Power Flow WRITE_OPF_OPTIONS_FILE
3.1.56. WRITE_OPF_OPTIONS_FILE
Use this API to save the PSSE OPF solution option settings to the PSSOPF.OPT file.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_WRITE_OPF_OPTIONS_FILE
Python command syntax:
ierr = write_opf_options_file()
Fortran command syntax:
CALL WRITE_OPF_OPTIONS_FILE(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error
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
1079
Optimal Power Flow WRITE_OPF_OPTIONS_FILE
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1080
Optimal Power Flow WRITE_OPF_OPTIONS_FILE
Optimal Power Flow Operation APIs contains API routines corresponding to the operational functions of the
PSS®E OPF.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1081
Optimal Power Flow Optimal Power Flow Data
3.2. Optimal Power Flow Data
3.2.1. NEWOPF
Use this API to initialize the working case with default OPF data for all bus oriented data records. It must be
called prior to introducing any OPF data records. It has no effect if OPF data already exists in the working
case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_NEWOPF
Python command syntax:
ierr = newopf()
Fortran command syntax:
CALL NEWOPF_API(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
1082
Optimal Power Flow OPF_ADJBRX_INDV
3.2.2. OPF_ADJBRX_INDV
Use this API to add an individual adjustable branch reactance data record to the working case. It may also
be used to modify an existing adjustable branch reactance data record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_ADJBRX_INDV EIBUS EJBUS CKTID INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(4)
Python command syntax:
ierr = opf_adjbrx_indv(eibus, ejbus, cktid, intgar, realar)
Fortran command syntax:
CALL OPF_ADJBRX_INDV(EIBUS, EJBUS, CKTID, INTGAR, REALAR, IERR)
Where:
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) cost curve type. This value is not currently
used by the program
INTGAR(1) = 1 polynomial and exponential cost curve
INTGAR(1) = 2 linear cost curve
INTGAR(1) = 3 quadratic cost curve
INTGAR(2) adjustable branch reactance status (default
of 1 if new record, current value otherwise)
INTGAR(2) = 0 out of service
INTGAR(2) = 1 in service
INTGAR(3) cost table cross reference number. This value
is not currently used by the program
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) reactance multiplier in pu (default value of
1.0 if new record, current value otherwise)
REALAR(2) maximum reactance multiplier in pu (default
value of 1.0 if new record, current value oth-
erwise)
REALAR(3) minimum reactance multiplier in pu (default
value of 1.0 if new record, current value oth-
erwise)
REALAR(4) cost scale coefficient in $/pu (default value
of 1.0 if new record, current value otherwise)
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1083
Optimal Power Flow OPF_ADJBRX_INDV
IERR = -1 non-fatal error occurred. Warning messages
are as follows: - Invalid cost curve type spec-
ified - Invalid branch reactance status speci-
fied. - Maximum branch reactance multipli-
er less than minimum multiplier - Branch re-
actance multiplier cannot be less than 0.1. -
Branch reactance multiplier cannot be set to
zero
IERR = 0 no error occurred
IERR = 1 invalid bus number
IERR = 2 specified branch does not exist
IERR = 3 branch reactance table full
IERR = 4 specified branch cannot be a transformer
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
1084
Optimal Power Flow OPF_ADJBRX_SUBSYS
3.2.3. OPF_ADJBRX_SUBSYS
Use this API to add or modify all OPF branch reactance data records in a specified subsystem of the work-
ing case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_ADJBRX_SUBSYS SID ALL INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(4) USEVAL(1)..USEVAL(4)
Python command syntax:
ierr = opf_adjbrx_subsys(sid, all, intgar, realar, useval)
Fortran command syntax:
CALL OPF_ADJBRX_SUBSYS(SID, ALL, INTGAR, REALAR, USEVAL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) cost curve type. This value is not currently
used by the program
INTGAR(1) = 1 polynomial and exponential cost curve
INTGAR(1) = 2 linear cost curve
INTGAR(1) = 3 quadratic cost curve
INTGAR(2) adjustable branch reactance status (default
value of 1 for new records, current values
otherwise)
INTGAR(2) = 0 out of service
INTGAR(2) = 1 in service
INTGAR(3) cost table cross reference number. This value
is not currently used by the program
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) reactance multiplier in pu (default value of
1.0 for new records, current value otherwise)
REALAR(2) maximum reactance multiplier in pu (default
value of 1.0 for new records, current value
otherwise)
REALAR(3) minimum reactance multiplier in pu (default
value of 1.0 for new records, current value
otherwise)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1085
Optimal Power Flow OPF_ADJBRX_SUBSYS
REALAR(4) cost scale coefficient in $/pu (default value
of 1.0 for new records, current value other-
wise)
Integer USEVAL (4) array of 4 elements specifying (default treatment same as value of 0)
(input).
USEVAL(1) indicates how the value of REALAR(1) should
be used
USEVAL(1) = 0 if the value of REALAR(1) is to be used as de-
fined
USEVAL(1) = 1 if the value of REALAR(1) is to be multiplied
by the present value of the branch reactance
multiplier
USEVAL(1) = 2 if the value of REALAR(1) is to be added to
the present value of the branch reactance
multiplier
USEVAL(2) indicates how the value of REALAR(2) should
be used
USEVAL(2) = 0 if the value of REALAR(2) is to be used as de-
fined
USEVAL(2) = 1 if the value of REALAR(2) is to be multiplied
by the present value of the maximum branch
reactance multiplier
USEVAL(2) = 2 if the value of REALAR(2) is to be added to
the present value of the maximum branch re-
actance multiplier
USEVAL(3) indicates how the value of REALAR(3) should
be used
USEVAL(3) = 0 if the value of REALAR(3) is to be used as de-
fined
USEVAL(3) = 1 if the value of REALAR(3) is to be multiplied
by the present value of the minimum branch
reactance multiplier
USEVAL(3) = 2 if the value of REALAR(3) is to be added to
the present value of the minimum branch re-
actance multiplier
USEVAL(4) indicates how the value of REALAR(4) should
be used
USEVAL(4) = 0 if the value of REALAR(4) is to be used as de-
fined
USEVAL(4) = 1 if the value of REALAR(4) is to be multiplied
by the present value of the cost scale coeffi-
cient
USEVAL(4) = 2 if the value of REALAR(4) is to be added to
the present value of the cost scale coefficient
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Warning messages
are as follows: - Invalid cost curve type spec-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1086
Optimal Power Flow OPF_ADJBRX_SUBSYS
ified - Invalid branch reactance status speci-
fied. - Maximum branch reactance multipli-
er less than minimum multiplier - Branch re-
actance multiplier cannot be less than 0.1. -
Branch reactance multiplier cannot be set to
zero
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 adjustable branch reactance table is full
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
1087
Optimal Power Flow OPF_ADJLOAD_TBL
3.2.4. OPF_ADJLOAD_TBL
Use this API to add an individual adjustable bus load table record to the working case. It may also be used
to modify an existing adjustable bus load table record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_ADJLOAD_TBL TBL INTGAR(1)..INTGAR(3) REALAR(1)..REALAR(7)
Python command syntax:
ierr = opf_adjload_tbl(tbl, intgar, realar)
Fortran command syntax:
CALL OPF_ADJLOAD_TBL(TBL, INTGAR, REALAR, IERR)
Where:
Integer TBL adjustable bus load table number (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) cost curve type. This value is not currently
used by the program
INTGAR(1) = 1 polynomial and exponential cost curve
INTGAR(1) = 2 linear cost curve
INTGAR(1) = 3 quadratic cost curve
INTGAR(2) adjustable bus load status (default of 1 if
new record, current value otherwise)
INTGAR(2) = 0 out of service
INTGAR(2) = 1 in service
INTGAR(3) cost table cross reference number. This value
is not currently used by the program
Real REALAR (7) array of 7 elements specifying (input).
REALAR(1) load multiplier (default value of 1.0 if new
record, current value otherwise)
REALAR(2) maximum load multiplier (default value of
1.0 if new record, current value otherwise)
REALAR(3) minimum load multiplier (default value of
1.0 if new record, current value otherwise)
REALAR(4) load ratio multiplier. This value is not current-
ly used by the program
REALAR(5) maximum load ratio multiplier. This value is
not currently used by the program
REALAR(6) minimum load ratio multiplier. This value is
not currently used by the program
REALAR(7) load cost scale coefficient (default value of
1.0 if new record, current value otherwise)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1088
Optimal Power Flow OPF_ADJLOAD_TBL
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Warning messages
are as follows: - invalid cost curve type speci-
fied - invalid load table status specified - Max-
imum load multiplier less than 0.0 - Minimum
load multiplier less than 0.0 - maximum load
multiplier less than minimum load multiplier -
maximum load ratio multiplier less than mini-
mum load ratio multiplier
IERR = 0 no error occurred
IERR = 1 adjustable bus load table is full
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
1089
Optimal Power Flow OPF_ADJVAR_INDV
3.2.5. OPF_ADJVAR_INDV
This API routine is obsolete. It has been replaced by the API routine opf_adjvar_indv_2 .
Use this API to add an individual OPF adjustable bus shunt data record to the working case. It may also be
used to modify an existing adjustable bus shunt data record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_ADJVAR_INDV EIBUS SHNTID INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(4)
Python command syntax:
ierr = opf_adjvar_indv(eibus, shntid, intgar, realar)
Fortran command syntax:
CALL OPF_ADJVAR_INDV(EIBUS, SHNTID, INTGAR, REALAR, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 SHNTID bus shunt identifier (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying The value of each is as follows(input).
INTGAR(1) cost curve type. This value is not currently
used by the program
INTGAR(1) = 1 polynomial and exponential cost curve
INTGAR(1) = 2 linear cost curve
INTGAR(1) = 3 quadratic cost curve
INTGAR(2) status (default value of 1 if new record, cur-
rent value otherwise)
INTGAR(2) = 0 out of service
INTGAR(2) = 1 in service
INTGAR(3) cost table cross reference number. This value
is not currently used by the program
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) initial bus shunt susceptance in Mvar at
nominal voltage (default value of 0.0 if new
record, current value otherwise)
REALAR(2) maximum bus shunt susceptance in Mvar
(default value of 0.0 if new record, current
value otherwise)
REALAR(3) minimum bus shunt susceptance in Mvar
(default value of 0.0 if new record, current
value otherwise)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1090
Optimal Power Flow OPF_ADJVAR_INDV
REALAR(4) cost scale coefficient in $/Mvar (default value
of 1.0 if new record, current value otherwise)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Possible warning
messages are as follows: - Invalid cost curve
type specified. - Invalid adjustable bus shunt
status specified. - Maximum shunt suscep-
tance less than minimum shunt susceptance
IERR = 0 no error occurred
IERR = 1 adjustable bus shunt identifier is more than
two characters
IERR = 2 invalid bus number specified
IERR = 3 blank adjustable bus shunt identifier is invalid
IERR = 4 adjustable bus shunt table is full
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
1091
Optimal Power Flow OPF_ADJVAR_INDV_2
3.2.6. OPF_ADJVAR_INDV_2
Use this API to add an individual OPF adjustable bus shunt data record to the working case. It may also be
used to modify an existing adjustable bus shunt data record.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_OPF_ADJVAR_INDV_2 EIBUS ENOD SHNTID INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(4)
Python command syntax:
ierr = opf_adjvar_indv_2(eibus, enod, shntid, intgar, realar)
Fortran command syntax:
CALL OPF_ADJVAR_INDV_2(EIBUS, ENOD, SHNTID, INTGAR, REALAR, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Integer ENOD Bus section number of the node number of one of the nodes in the
bus section of interest. 0 if bus is represented by a single bus section.
If 0 is specified and bus is represented by multiple bus sections, the
bus data of the parent bus and not that of one of the topology bus
sections will be changed. (input; no default allowed).
Character*2 SHNTID bus shunt identifier (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying The value of each is as follows(input).
INTGAR(1) cost curve type. This value is not currently
used by the program
INTGAR(1) = 1 polynomial and exponential cost curve
INTGAR(1) = 2 linear cost curve
INTGAR(1) = 3 quadratic cost curve
INTGAR(2) status (default value of 1 if new record, cur-
rent value otherwise)
INTGAR(2) = 0 out of service
INTGAR(2) = 1 in service
INTGAR(3) cost table cross reference number. This value
is not currently used by the program
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) initial bus shunt susceptance in Mvar at
nominal voltage (default value of 0.0 if new
record, current value otherwise)
REALAR(2) maximum bus shunt susceptance in Mvar
(default value of 0.0 if new record, current
value otherwise)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1092
Optimal Power Flow OPF_ADJVAR_INDV_2
REALAR(3) minimum bus shunt susceptance in Mvar
(default value of 0.0 if new record, current
value otherwise)
REALAR(4) cost scale coefficient in $/Mvar (default value
of 1.0 if new record, current value otherwise)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 adjustable bus shunt identifier is more than
two characters
IERR = 2 invalid bus number
IERR = 3 blank adjustable bus shunt identifier is invalid
IERR = 4 adjustable bus shunt table is full
IERR = 5 node-breaker terminal connection table is full
IERR = 6 bus not found
IERR = 7 invalid node number
IERR = 8 bus does not belong to a substation
IERR = 9 node is not found in the substation
IERR = 10 node is not connected to any bus section of
bus
IERR = 11 prerequisite requirements for function not
met
IERR = -1 warnings - one or more of: - Invalid cost curve
type specified. - Invalid adjustable bus shunt
status specified. - Maximum shunt suscep-
tance less than minimum shunt susceptance,
values have been switched
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1093
Optimal Power Flow OPF_ADJVAR_SUBSYS
3.2.7. OPF_ADJVAR_SUBSYS
Use this API to add or modify all OPF adjustable bus shunt records in a specified subsystem of the working
case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_ADJVAR_SUBSYS SID ALL AUTOADD SHNTID INTGAR(1)..INTGAR(4)
REALAR(1)..REALAR(4) USEVAL(1)..USEVAL(4)
Python command syntax:
ierr = opf_adjvar_subsys(sid, all, autoadd, shntid, intgar, realar,
useval)
Fortran command syntax:
CALL OPF_ADJVAR_SUBSYS(SID, ALL, AUTOADD, SHNTID, INTGAR, REALAR, USEVAL,
IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Integer AUTOADD Indicates whether new records can be added (default treatment
same as value of 3) (input).
AUTOADD = 0 do not add a new var record if it does not al-
ready exist.
AUTOADD = 1 add a new var record if it does not already ex-
ist.
AUTOADD = 2 add a separate shunt record at the bus.
AUTOADD = 3 only modify existing bus shunt records that
correspond to the shunt identifier given in
SHNTID.
Character*2 SHNTID adjustable bus shunt identifier (input; '1' by default).
Integer INTGAR (4) array of 4 elements specifying (input).
INTGAR(1) cost curve type. This value is not currently
used by the program
INTGAR(1) = 1 polynomial and exponential cost curve
INTGAR(1) = 2 piece-wise linear cost curve
INTGAR(1) = 3 piece-wise quadratic cost curve
INTGAR(2) status (default value of 1 for new records,
current value otherwise)
INTGAR(2) = 0 out of service
INTGAR(2) = 1 in service
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1094
Optimal Power Flow OPF_ADJVAR_SUBSYS
INTGAR(3) cost table cross reference number. This value
is not currently used by the program
INTGAR(4) indicates which bus types should be
processed (default treatment same as value
of 0)
INTGAR(4) = 0 process all buses in subsystem
INTGAR(4) = 1 process only Type 1 buses in subsystem
INTGAR(4) = 2 process only Type 2 and 3 buses in subsys-
tem
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) bus shunt susceptance in Mvar at nominal
voltage (default value of 0.0 for new records,
current values used for existing ones)
REALAR(2) maximum bus shunt susceptance in Mvar
(default value of 0.0 for new records, current
value otherwise)
REALAR(3) minimum bus shunt susceptance in Mvar
(default value of 0.0 for new records, current
value otherwise)
REALAR(4) cost scale coefficient in $/Mvar (default val-
ue of 1.0 for new records, current value oth-
erwise)
Integer USEVAL (4) array of 4 elements specifying Used to indicate actions to be taken on
the REALAR values. If USEVAL is 1 then value REALAR value is multi-
plied by the current value. If USEVAL is 2 then REALAR value is added
to current real value. If USEVAL is 0 (default) then REALAR is used as
provided.(input).
USEVAL(1) indicates how the value of REALAR(1) should
be adjusted
USEVAL(1) = 0 if the value of REALAR(1) is to be used as de-
fined
USEVAL(1) = 1 if the value of REALAR(1) is to be multiplied
by the present value of the bus shunt suscep-
tance
USEVAL(1) = 2 if the value of REALAR(1) is to be added to
the present value of the bus shunt suscep-
tance
USEVAL(2) indicates how the value of REALAR(2) should
be used
USEVAL(2) = 0 if the value of REALAR(2) is to be used as de-
fined
USEVAL(2) = 1 if the value of REALAR(2) is to be multiplied
by the present value of the maximum bus
shunt susceptance
USEVAL(2) = 2 if the value of REALAR(2) is to be added to
the present value of the maximum bus shunt
susceptance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1095
Optimal Power Flow OPF_ADJVAR_SUBSYS
USEVAL(3) indicates how the value of REALAR(3) should
be used
USEVAL(3) = 0 if the value of REALAR(3) is to be used as de-
fined
USEVAL(3) = 1 if the value of REALAR(3) is to be multiplied
by the present value of the minimum bus
shunt susceptance
USEVAL(3) = 2 if the value of REALAR(3) is to be added to
the present value of the minimum bus shunt
susceptance
USEVAL(4) indicates how the value of REALAR(4) should
be used
USEVAL(4) = 0 if the value of REALAR(4) is to be used as de-
fined
USEVAL(4) = 1 if the value of REALAR(4) is to be multiplied
by the present value of the cost scale coeffi-
cient
USEVAL(4) = 2 if the value of REALAR(4) is to be added to
the present value of the cost scale coefficient
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 adjustable bus shunt identifier is more than
two characters
IERR = 2 invalid SID value or subsystem SID is not de-
fined
IERR = 3 invalid ALL value
IERR = 4 adjustable bus shunt table is full
IERR = 5 node-breaker terminal connection table is full
IERR = 6 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid cost curve
type specified. - Invalid adjustable bus shunt
status specified. - Maximum shunt suscep-
tance less than minimum shunt susceptance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1096
Optimal Power Flow OPF_APDSP_TBL
3.2.8. OPF_APDSP_TBL
Use this API to add an individual active power dispatch table record to the working case. It may also be
used to modify an existing active power dispatch table record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_APDSP_TBL TBL INTGAR(1)..INTGAR(3) REALAR(1)..REALAR(3)
Python command syntax:
ierr = opf_apdsp_tbl(tbl, intgar, realar)
Fortran command syntax:
CALL OPF_APDSP_TBL(TBL, INTGAR, REALAR, IERR)
Where:
Integer TBL active power dispatch table number (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) cost curve type (default value of 1 if new
record, current value otherwise)
INTGAR(1) = 1 polynomial and exponential cost curve
INTGAR(1) = 2 linear cost curve
INTGAR(1) = 3 quadratic cost curve
INTGAR(2) active power dispatch table status (default
value of 1 if new record, current value other-
wise)
INTGAR(2) = 0 out of service
INTGAR(2) = 1 in service
INTGAR(3) cost table cross reference number (default
value of 0, current value otherwise)
Real REALAR (3) array of 3 elements specifying (input).
REALAR(1) maximum active power generation, in MW
(default value of 9999.0, current value other-
wise)
REALAR(2) minimum active power generation, in MW
(default value of -9999.0, current value oth-
erwise)
REALAR(3) fuel cost scale coefficient (default value of
1.0, current value otherwise)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Warning messages
are as follows: - invalid cost curve type speci-
fied - invalid active power dispatch table sta-
tus specified - maximum active power gener-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1097
Optimal Power Flow OPF_APDSP_TBL
ation less than minimum active power gener-
ation
IERR = 0 no error occurred
IERR = 1 active power dispatch table is full
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
1098
Optimal Power Flow OPF_BRFLW_3WT_INDV
3.2.9. OPF_BRFLW_3WT_INDV
Use this API to add a flow constraint record for an individual winding of a three-winding transformer in the
working case. It may also be used to modify an existing three-winding transformer flow constraint record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_BRFLW_3WT_INDV EIBUS EJBUS EKBUS CKTID BFLWID INTGAR(1)
INTGAR(2) REALAR(1)..REALAR(5)
Python command syntax:
ierr = opf_brflw_3wt_indv(eibus, ejbus, ekbus, cktid, bflwid, intgar,
realar)
Fortran command syntax:
CALL OPF_BRFLW_3WT_INDV(EIBUS, EJBUS, EKBUS, CKTID, BFLWID, INTGAR,
REALAR, IERR)
Where:
Integer EIBUS from bus number The value of EIBUS indicates the from bus of the
winding for which the flow constraint is being introduced (input; no
default allowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 BFLWID branch flow constraint identifier (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) branch flow type (default value of 4 if new
record, current value otherwise)
INTGAR(1) = 1 MW
INTGAR(1) = 2 Mvar
INTGAR(1) = 3 MVA
INTGAR(1) = 4 Ampere
INTGAR(2) limit type imposed on the branch flow limits
(default value of 1 if new record, current val-
ue otherwise)
INTGAR(2) = 0 reporting only
INTGAR(2) = 1 hard limit
INTGAR(2) = 2 linear soft limit
INTGAR(2) = 3 quadratic soft limit
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) maximum normal flow limit in physical units
(default value of 0.0 for new record, current
value otherwise)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1099
Optimal Power Flow OPF_BRFLW_3WT_INDV
REALAR(2) minimum normal flow limit in physical units
(default value of 0.0 for new record, current
value otherwise)
REALAR(3) maximum emergency flow limit in physical
units (default value of 0.0 for new record,
current value otherwise)
REALAR(4) minimum emergency flow limit in physical
units (default value of 0.0 for new record,
current value otherwise)
REALAR(5) soft limit penalty weight (default value of 1.0
for new record, current value otherwise)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Invalid branch flow type spec-
ified. - Invalid branch flow limit type speci-
fied. - Maximum normal flow limit is less than
the minimum normal flow limit. - Maximum
emergency flow limit is less than the mini-
mum emergency flow limit
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified three-winding transformer does not
exist
IERR = 3 specified winding of three-winding trans-
former not found
IERR = 4 branch flow constraint table is full
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
1100
Optimal Power Flow OPF_BRFLW_BRN_INDV
3.2.10. OPF_BRFLW_BRN_INDV
Use this API to add an individual branch or two-winding transformer flow constraint record to the working
case. It may also be used to modify an existing branch or two-winding transformer flow constraint.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_BRFLW_BRN_INDV EIBUS EJBUS CKTID BFLWID INTGAR(1) INTGAR(2)
REALAR(1)..REALAR(5)
Python command syntax:
ierr = opf_brflw_brn_indv(eibus, ejbus, cktid, bflwid, intgar, realar)
Fortran command syntax:
CALL OPF_BRFLW_BRN_INDV(EIBUS, EJBUS, CKTID, BFLWID, INTGAR, REALAR, IERR)
Where:
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 BFLWID branch flow constraint identifier (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) branch flow type (default value of 4 if new
record, current value otherwise)
INTGAR(1) = 1 MW
INTGAR(1) = 2 Mvar
INTGAR(1) = 3 MVA
INTGAR(1) = 4 Ampere
INTGAR(2) limit type imposed on the branch flow limits
(default value of 1 if new record, current val-
ue otherwise)
INTGAR(2) = 0 reporting only
INTGAR(2) = 1 hard limit
INTGAR(2) = 2 linear soft limit
INTGAR(2) = 3 quadratic soft limit
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) maximum normal flow limit in physical units
(default value of 0.0 if new record, current
value otherwise)
REALAR(2) minimum normal flow limit in physical units
(default value of 0.0 if new record, current
value otherwise)
REALAR(3) maximum emergency flow limit in physical
units (default value of 0.0 if new record, cur-
rent value otherwise)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1101
Optimal Power Flow OPF_BRFLW_BRN_INDV
REALAR(4) minimum emergency flow limit in physical
units (default value of 0.0 if new record, cur-
rent value otherwise)
REALAR(5) soft limit penalty weight (default value of 1.0
if new record, current value otherwise)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Invalid branch flow type spec-
ified. - Invalid branch flow limit type speci-
fied. - Maximum normal flow limit is less than
the minimum normal flow limit. - Maximum
emergency flow limit is less than the mini-
mum emergency flow limit
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified branch does not exist
IERR = 3 branch flow constraint table is full
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
1102
Optimal Power Flow OPF_BRFLW_SUBSYS
3.2.11. OPF_BRFLW_SUBSYS
Use this API to add or modify all branch flow data records in a specified subsystem of the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_BRFLW_SUBSYS SID ALL AUTOADD BFLWID INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(5) USEVAL(1)..USEVAL(5)
Python command syntax:
ierr = opf_brflw_subsys(sid, all, autoadd, bflwid, intgar, realar, useval)
Fortran command syntax:
CALL OPF_BRFLW_SUBSYS(SID, ALL, AUTOADD, BFLWID, INTGAR, REALAR, USEVAL,
IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Integer AUTOADD Indicates whether new records can be added, or are to be modified
(input; no default allowed).
AUTOADD = 0 do not add a new branch flow record if it does
not already exist.
AUTOADD = 1 add a new branch flow record if it does not al-
ready exist.
AUTOADD = 2 only modify existing branch flow records that
correspond to the flow identifier given in
BFLWID.
Character*1 BFLWID branch flow identifier (input; no default allowed).
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) branch flow type (default value of 4 for new
records, current value otherwise)
INTGAR(1) = 1 MW
INTGAR(1) = 2 Mvar
INTGAR(1) = 3 MVA
INTGAR(1) = 4 Ampere
INTGAR(2) limit type imposed on the branch flow limits
(default value of 1 for new records, current
value otherwise)
INTGAR(2) = 0 reporting only
INTGAR(2) = 1 hard limit
INTGAR(2) = 2 linear soft limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1103
Optimal Power Flow OPF_BRFLW_SUBSYS
INTGAR(2) = 3 quadratic soft limit
INTGAR(3) default rate setting (default value of 0)
INTGAR(3) = 0 use the limits that have been defined
INTGAR(3) = 1 base flow limits on RATEA
INTGAR(3) = 2 base flow limits on RATEB
INTGAR(3) = 3 base flow limits on RATEC
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) maximum normal flow limit in physical units
(default value of 0.0 for new records, current
value otherwise)
REALAR(2) minimum normal flow limit in physical units
(default value of 0.0 for new records, current
value otherwise)
REALAR(3) maximum emergency flow limit in physical
units (default value of 0.0 for new records,
current value otherwise)
REALAR(4) minimum emergency flow limit in physical
units (default value of 0.0 for new records,
current value otherwise)
REALAR(5) soft limit penalty weight (default value of 1.0
for new records, current value otherwise)
Integer USEVAL (5) array of 5 elements specifying Specifies whether the corresponding
REALAR value should be applied as provided, or multiplied by the
present value or added to the present value.(input).
USEVAL(1) indicates how the value of REALAR(1) should
be used
USEVAL(1) = 0 if the value of REALAR(1) is to be used as de-
fined
USEVAL(1) = 1 if the value of REALAR(1) is to be multiplied
by the present value of the maximum normal
flow limit
USEVAL(1) = 2 if the value of REALAR(1) is to be added to
the present value of the maximum normal
flow limit
USEVAL(2) indicates how the value of REALAR(2) should
be used
USEVAL(2) = 0 if the value of REALAR(2) is to be used as de-
fined
USEVAL(2) = 1 if the value of REALAR(2) is to be multiplied
by the present value of the minimum normal
flow limit
USEVAL(2) = 2 if the value of REALAR(2) is to be added to
the present value of the minimum normal
flow limit
USEVAL(3) indicates how the value of REALAR(3) should
be used
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1104
Optimal Power Flow OPF_BRFLW_SUBSYS
USEVAL(3) = 0 if the value of REALAR(3) is to be used as de-
fined
USEVAL(3) = 1 if the value of REALAR(3) is to be multiplied
by the present value of the maximum emer-
gency flow limit
USEVAL(3) = 2 if the value of REALAR(3) is to be added to
the present value of the maximum emer-
gency flow limit
USEVAL(4) indicates how the value of REALAR(4) should
be used
USEVAL(4) = 0 if the value of REALAR(4) is to be used as de-
fined
USEVAL(4) = 1 if the value of REALAR(4) is to be multiplied
by the present value of the minimum emer-
gency flow limit
USEVAL(4) = 2 if the value of REALAR(4) is to be added to
the present value of the minimum emer-
gency flow limit
USEVAL(5) indicates how the value of REALAR(5) should
be used
USEVAL(5) = 0 if the value of REALAR(5) is to be used as de-
fined
USEVAL(5) = 1 if the value of REALAR(5) is to be multiplied
by the present value of the soft limit penalty
weight
USEVAL(5) = 2 if the value of REALAR(5) is to be added to
the present value of the soft limit penalty
weight
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Invalid flow type specified.
- Invalid branch flow limit type specified. -
Maximum normal flow limit is less than the
minimum normal flow limit. - Maximum
emergency flow limit is less than the mini-
mum emergency flow limit
IERR = 0 no error occurred
IERR = 1 invalid SID value or subsystem SID is not de-
fined
IERR = 2 invalid ALL value
IERR = 3 branch flow constraint table is full
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
1105
Optimal Power Flow OPF_BUS_INDV
3.2.12. OPF_BUS_INDV
This API routine is obsolete. It has been replaced by the API routine opf_bus_indv_2 .
Use this API to add OPF bus voltage magnitude data to the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_BUS_INDV EIBUS INTGAR(1) INTGAR(2) REALAR(1)..REALAR(5)
Python command syntax:
ierr = opf_bus_indv(eibus, intgar, realar)
Fortran command syntax:
CALL OPF_BUS_INDV(EIBUS, INTGAR, REALAR, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) limit type imposed on the bus voltage limits
(default is the current value; initialized to 1)
INTGAR(1) = 0 reporting only
INTGAR(1) = 1 hard limit
INTGAR(1) = 2 linear soft limit
INTGAR(1) = 3 quadratic soft limit
INTGAR(2) indicates what to do with the defined voltage
limits (default treatment same as value of 0)
INTGAR(2) = 0 leave voltage limits as defined by REALAR(1)
and REALAR(2)
INTGAR(2) = 1 fix normal voltage limit at present voltage
values, ignoring any values defined by RE-
ALAR(1) and REALAR(2)
INTGAR(2) = 2 allow normal voltage limits to open up if
they exceed the bounds defined by RE-
ALAR(1) or REALAR(2)
INTGAR(2) = 3 set normal and emergency OPF voltage limits
to the normal and emergency voltage limits
as defined in the network bus data
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) normal maximum voltage limit in pu (default
is the current value; initialized to 9999.0)
REALAR(2) normal minimum voltage limit in pu (default
is the current value; initialized to -9999.0)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1106
Optimal Power Flow OPF_BUS_INDV
REALAR(3) emergency maximum voltage limit in pu
(default is the current value; initialized to
9999.0)
REALAR(4) emergency minimum voltage limit in pu
(default is the current value; initialized to
-9999.0)
REALAR(5) soft-limit penalty weight (default is the cur-
rent value; initialized to 1.0)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Warning messages
are as follows: - Invalid limit type specified. -
Maximum normal voltage limit less than min-
imum limit. - Maximum emergency voltage
limit less than minimum limit
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
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
1107
Optimal Power Flow OPF_BUS_INDV_2
3.2.13. OPF_BUS_INDV_2
Use this API to add OPF bus voltage magnitude data to the working case.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_OPF_BUS_INDV_2 EIBUS ENOD INTGAR(1) INTGAR(2)
REALAR(1)..REALAR(5)
Python command syntax:
ierr = opf_bus_indv_2(eibus, enod, intgar, realar)
Fortran command syntax:
CALL OPF_BUS_INDV_2(EIBUS, ENOD, INTGAR, REALAR, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Integer ENOD The bus section number or the external node number of one of the
nodes in the bus section of interest. Specify 0 if bus is represented by
a single bus section. If 0 is specified and bus is represented by multi-
ple bus sections, the data of the parent bus and not that of the bus
sections will be changed. (input; no default allowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) limit type imposed on the bus voltage limits
(default is the current value; initialized to 1)
INTGAR(1) = 0 reporting only
INTGAR(1) = 1 hard limit
INTGAR(1) = 2 linear soft limit
INTGAR(1) = 3 quadratic soft limit
INTGAR(2) indicates what to do with the defined voltage
limits (default treatment same as value of 0)
INTGAR(2) = 0 leave voltage limits as defined by REALAR(1)
and REALAR(2)
INTGAR(2) = 1 fix normal voltage limit at present voltage
values, ignoring any values defined by RE-
ALAR(1) and REALAR(2)
INTGAR(2) = 2 allow normal voltage limits to open up if
they exceed the bounds defined by RE-
ALAR(1) or REALAR(2)
INTGAR(2) = 3 set normal and emergency OPF voltage limits
to the normal and emergency voltage limits
as defined in the network bus data
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) normal maximum voltage limit in pu (default
is the current value; initialized to 9999.0)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1108
Optimal Power Flow OPF_BUS_INDV_2
REALAR(2) normal minimum voltage limit in pu (default
is the current value; initialized to -9999.0)
REALAR(3) emergency maximum voltage limit in pu
(default is the current value; initialized to
9999.0)
REALAR(4) emergency minimum voltage limit in pu
(default is the current value; initialized to
-9999.0)
REALAR(5) soft-limit penalty weight (default is the cur-
rent value; initialized to 1.0)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Warning messages
are as follows: - Invalid limit type specified. -
Maximum normal voltage limit less than min-
imum limit. - Maximum emergency voltage
limit less than minimum limit
IERR = 0 no error occurred
IERR = 1 invalid bus number
IERR = 2 bus not found
IERR = 3 invalid node number
IERR = 4 node not found in substation of bus
IERR = 5 node not connected to any bus section of bus
in substation
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
1109
Optimal Power Flow OPF_BUS_SUBSYS
3.2.14. OPF_BUS_SUBSYS
Use this API to add OPF bus attribute data for all records in a specified subsystem of the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_BUS_SUBSYS SID ALL INTGAR(1)..INTGAR(3) REALAR(1)..REALAR(5)
USEVAL(1)..USEVAL(5)
Python command syntax:
ierr = opf_bus_subsys(sid, all, intgar, realar, useval)
Fortran command syntax:
CALL OPF_BUS_SUBSYS(SID, ALL, INTGAR, REALAR, USEVAL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses, use existing data values.
ALL = 2 process all buses, use default data values.
Integer INTGAR (3) array of 3 elements specifying (input).
INTGAR(1) limit type imposed on the bus voltage limits
(default is the current value; initialized to 1)
INTGAR(1) = 0 reporting only
INTGAR(1) = 1 hard limit
INTGAR(1) = 2 linear soft limit
INTGAR(1) = 3 quadratic soft limit
INTGAR(2) indicates what to do with the defined voltage
limits (default treatment same as value of 0)
INTGAR(2) = 0 leave voltage limits as defined by REALAR(1)
and REALAR(2)
INTGAR(2) = 1 fix normal voltage limit at present voltage
values, ignoring any values defined by RE-
ALAR(1) and REALAR(2)
INTGAR(2) = 2 allow normal voltage limits to open up if
they exceed the bounds defined by RE-
ALAR(1) or REALAR(2)
INTGAR(2) = 3 set normal and emergency OPF voltage limits
to the normal and emergency voltage limits
as defined in the network bus data
INTGAR(3) indicates which bus types should be
processed (default treatment same as value
of 0)
INTGAR(3) = 0 all buses in subsystem
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1110
Optimal Power Flow OPF_BUS_SUBSYS
INTGAR(3) = 1 only Type 1 buses in subsystem
INTGAR(3) = 2 only Type 2 and 3 buses in subsystem
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) normal maximum voltage limit in pu (default
is the current value; initialized to 9999.0)
REALAR(2) normal minimum voltage limit in pu (default
is the current value; initialized to -9999.0)
REALAR(3) emergency maximum voltage limit in pu
(default is the current value; initialized to
9999.0)
REALAR(4) emergency minimum voltage limit in pu
(default is the current value; initialized to
-9999.0)
REALAR(5) soft-limit penalty weight (default is the cur-
rent value; initialized to 1.0)
Integer USEVAL (5) array of 5 elements specifying (default treatment same as value of 0)
(input).
USEVAL(1) indicates how the value of REALAR(1) should
be used
USEVAL(1) = 0 if the value of REALAR(1) is to be used as de-
fined
USEVAL(1) = 1 if the value of REALAR(1) is to be multiplied
by the present value of the normal bus volt-
age minimum limit
USEVAL(1) = 2 if the value of REALAR(1) is to be added to
the present value of the normal bus voltage
minimum limit
USEVAL(2) indicates how the value of REALAR(2) should
be used
USEVAL(2) = 0 if the value of REALAR(2) is to be used as de-
fined
USEVAL(2) = 1 if the value of REALAR(2) is to be multiplied
by the present value of the normal bus volt-
age maximum limit
USEVAL(2) = 2 if the value of REALAR(2) is to be added to
the present value of the normal bus voltage
maximum limit
USEVAL(3) indicates how the value of REALAR(3) should
be used
USEVAL(3) = 0 if the value of REALAR(3) is to be used as de-
fined
USEVAL(3) = 1 if the value of REALAR(3) is to be multiplied
by the present value of the emergency bus
voltage minimum limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1111
Optimal Power Flow OPF_BUS_SUBSYS
USEVAL(3) = 2 if the value of REALAR(3) is to be added to
the present value of the emergency bus volt-
age minimum limit
USEVAL(4) indicates how the value of REALAR(4) should
be used
USEVAL(4) = 0 if the value of REALAR(4) is to be used as de-
fined
USEVAL(4) = 1 if the value of REALAR(4) is to be multiplied
by the present value of the emergency bus
voltage maximum limit
USEVAL(4) = 2 if the value of REALAR(4) is to be added to
the present value of the emergency bus volt-
age maximum limit
USEVAL(5) indicates how the value of PENWGT should
be used
USEVAL(5) = 0 if the value of PENWGT is to be used as de-
fined
USEVAL(5) = 1 if the value of PENWGT is to be multiplied
by the present value of the soft limit penalty
weight
USEVAL(5) = 2 if the value of PENWGT is to be added to the
present value of the soft limit penalty weight
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
IERR = -1 non-fatal error occurred. Warning messages
are as follows: - Invalid limit type specified. -
Maximum normal voltage limit less than min-
imum limit. - Maximum emergency voltage
limit less than minimum limit
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1112
Optimal Power Flow OPF_CHANGE_3WT_FLOW_ID
3.2.15. OPF_CHANGE_3WT_FLOW_ID
Use this API to change the identifier of a flow constraint record for an individual winding of a three-wind-
ing transformer in the working case.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Batch command syntax:
OPF_CHANGE_3WT_FLOW_ID IBUS JBUS KBUS CKTID ID IDNEW
Python command syntax:
ierr = opf_change_3wt_flow_id(ibus, jbus, kbus, cktid, id, idnew)
Fortran command syntax:
CALL OPF_CHANGE_3WT_FLOW_ID(IBUS, JBUS, KBUS, CKTID, ID, IDNEW, IERR)
Where:
Integer IBUS from bus number The value of IBUS indicates the from bus of the
winding for which the flow constraint is being introduced (input; no
default allowed).
Integer JBUS to bus number (input; no default allowed).
Integer KBUS third bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 ID branch flow constraint identifier (input; no default allowed).
Character*1 IDNEW new branch flow constraint identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 a non-blank new identifier must be specified
IERR = 3 specified three-winding transformer does not
exist
IERR = 4 branch flow identifier is more than one char-
acter
IERR = 5 specified winding of three-winding trans-
former not found
IERR = 6 specified OPF branch flow constraint does not
exist
IERR = 7 branch flow constraint already exists
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
1113
Optimal Power Flow OPF_CHANGE_ADJVAR_ID
3.2.16. OPF_CHANGE_ADJVAR_ID
This API routine is obsolete. It has been replaced by the API routine opf_change_adjvar_id .
Use this API to change the identifier of an OPF adjustable bus shunt data record in the working case.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Batch command syntax:
BAT_OPF_CHANGE_ADJVAR_ID IBUS ID IDNEW
Python command syntax:
ierr = opf_change_adjvar_id(ibus, id, idnew)
Fortran command syntax:
CALL OPF_CHANGE_ADJVAR_ID(IBUS, ID, IDNEW, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID OPF adjustable bus shunt identifier (input; no default allowed).
Character*2 IDNEW new OPF adjustable bus shunt identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 blank adjustable bus shunt identifier is invalid
IERR = 3 adjustable bus shunt identifier is more than
two characters
IERR = 4 adjustable bus shunt not found
IERR = 5 adjustable bus shunt already exists
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
1114
Optimal Power Flow OPF_CHANGE_BRN_FLOW_ID
3.2.17. OPF_CHANGE_BRN_FLOW_ID
Use this API to change the identifier of a branch or two-winding transformer OPF flow constraint record in
the working case.
This API routine was first introduced in release 34.8.0 and 35.2.0.
Batch command syntax:
OPF_CHANGE_BRN_FLOW_ID IBUS JBUS CKTID ID IDNEW
Python command syntax:
ierr = opf_change_brn_flow_id(ibus, jbus, cktid, id, idnew)
Fortran command syntax:
CALL OPF_CHANGE_BRN_FLOW_ID(IBUS, JBUS, CKTID, ID, IDNEW, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 ID branch flow constraint identifier (input; no default allowed).
Character*1 IDNEW new branch flow constraint identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 a non-blank new identifier must be specified
IERR = 3 specified branch does not exist
IERR = 4 branch flow identifier is more than one char-
acter
IERR = 5 branch flow constraint does not exist
IERR = 6 branch flow constraint already exists
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
1115
Optimal Power Flow OPF_CSTTBL_LIN
3.2.18. OPF_CSTTBL_LIN
Use this API to add a linear cost curve table record to the working case. It may also be used to modify an
existing linear cost curve table record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_CSTTBL_LIN TBL LABL NPRS
Python command syntax:
ierr = opf_csttbl_lin(tbl, labl, nprs, xy)
Fortran command syntax:
CALL OPF_CSTTBL_LIN(TBL, LABL, NPRS, XY, IERR)
Where:
Integer TBL linear cost curve table number (input; no default allowed).
Character*12 LABL cost table description of, at most, 12 characters (input; ' ' by default).
Integer NPRS number of (Xi, Yi) coordinate pairs being specified (input; no default
allowed).
Real XY (2*NPRS) Coordinate pairs from 1 to NPRS. Xi is the control variable value. Yi is
the total cost or energy consumption value. (input; Xi and Yi have de-
faults of 0.0).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 cost table data table is full
IERR = 2 exceeded maximum number of allowable
cost curve data pairs
IERR = 3 number of data pairs must not be less than
zero
IERR = 4 incremental costs are not monotonically in-
creasing
IERR = 5 MW values are not monotonically increasing
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
1116
Optimal Power Flow OPF_CSTTBL_POLY
3.2.19. OPF_CSTTBL_POLY
Use this API to add a polynomial and exponential cost curve table record to the working case. It may also
be used to modify an existing polynomial and exponential cost curve table record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_CSTTBL_POLY TBL LABL COST LINCST QUACST EXPCST EXPON
Python command syntax:
ierr = opf_csttbl_poly(tbl, labl, cost, lincst, quacst, expcst, expon)
Fortran command syntax:
CALL OPF_CSTTBL_POLY(TBL, LABL, COST, LINCST, QUACST, EXPCST, EXPON, IERR)
Where:
Integer TBL polynomial and exponential cost curve table number (input; no de-
fault allowed).
Character*12 LABL cost table description of, at most, 12 characters (input; ' ' by default).
Real COST cost integration constant (input; 0.0).
Real LINCST linear cost coefficient value (input; 1.0).
Real QUACST quadratic cost coefficient value (input; 1.0).
Real EXPCST exponential cost coefficient value (input; 0.0).
Real EXPON exponent of the exponential cost coefficient (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 cost table data table full
IERR = 2 exceeded maximum number of allowable
cost curve data values
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
1117
Optimal Power Flow OPF_CSTTBL_QUAD
3.2.20. OPF_CSTTBL_QUAD
Use this API to add a quadratic cost curve table record to the working case. It may also be used to modify
an existing quadratic cost curve table record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_CSTTBL_QUAD TBL LABL COST NPRS
Python command syntax:
ierr = opf_csttbl_quad(tbl, labl, cost, nprs, xy)
Fortran command syntax:
CALL OPF_CSTTBL_QUAD(TBL, LABL, COST, NPRS, XY, IERR)
Where:
Integer TBL quadratic cost curve table number (input; no default allowed).
Character*12 LABL cost table description of, at most, 12 characters (input; ' ' by default).
Real COST cost integration constant (input; 0.0).
Integer NPRS number of (Xi, Yi) coordinate pairs to be specified (no default) (in-
put).
Real XY (2*NPRS) Coordinate pairs from 1 to NPRS. Xi is the control variable value. Yi is
the total cost or energy consumption value. (input; Xi and Yi have de-
faults of 0.0).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 cost table data table is full
IERR = 2 exceeded maximum number of allowable
cost curve data pairs
IERR = 3 number of data pairs must not be negative
IERR = 4 incremental costs are not monotonically in-
creasing
IERR = 5 MW values are not monotonically increasing
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
1118
Optimal Power Flow OPF_GENDSP_INDV
3.2.21. OPF_GENDSP_INDV
Use this API to add generator dispatch data to an individual record in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_GENDSP_INDV EIBUS GENID APDTBL DSPTCH
Python command syntax:
ierr = opf_gendsp_indv(eibus, genid, apdtbl, dsptch)
Fortran command syntax:
CALL OPF_GENDSP_INDV(EIBUS, GENID, APDTBL, DSPTCH, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Integer APDTBL active power dispatch table cross reference number (input; default of
0 if new record, current value otherwise).
Real DSPTCH dispatch fraction (default value of 1.0 if new record, current value
otherwise) (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified machine does not exist
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
1119
Optimal Power Flow OPF_GENDSP_SUBSYS
3.2.22. OPF_GENDSP_SUBSYS
Use this API to add OPF generator dispatch data to all records in a specified subsystem of the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_GENDSP_SUBSYS SID ALL APDTBL DSPTCH USEVAL
Python command syntax:
ierr = opf_gendsp_subsys(sid, all, apdtbl, dsptch, useval)
Fortran command syntax:
CALL OPF_GENDSP_SUBSYS(SID, ALL, APDTBL, DSPTCH, USEVAL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses, use existing data values.
ALL = 2 process all buses, use default data values.
Integer APDTBL active power dispatch table cross reference number (input; default of
0 for new record, current value otherwise).
Real DSPTCH dispatch fraction (input; default of 1.0 for new record, current value
otherwise).
Integer USEVAL Indicates how the value of DSPTCH should be applied (default treat-
ment same as value of 0) (input).
useval = 0 if the value of DSPTCH is to be used as de-
fined.
useval = 1 if the value of DSPTCH is to be multiplied by
the present value of the dispatch fraction.
useval = 2 if the value of DSPTCH is to be added to the
present value of the dispatch fraction.
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
1120
Optimal Power Flow OPF_GENRSV_INDV
3.2.23. OPF_GENRSV_INDV
Use this API to add an individual generator reserve data record to the working case. It may also be used to
modify an existing generator reserve data record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_GENRSV_INDV EIBUS GENID REALAR(1) REALAR(2)
Python command syntax:
ierr = opf_genrsv_indv(eibus, genid, realar)
Fortran command syntax:
CALL OPF_GENRSV_INDV(EIBUS, GENID, REALAR, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) unit ramp rate in MW/minute (default value
of 9999.0 if new record, current value other-
wise)
REALAR(2) unit capability in MW (default value of
9999.0 if new record, current value other-
wise)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified machine does not exist
IERR = 3 generator reserve unit table full
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
1121
Optimal Power Flow OPF_GENRSV_SUBSYS
3.2.24. OPF_GENRSV_SUBSYS
Use this API to add or modify all OPF generator reserve records in a specified subsystem of the working
case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_GENRSV_SUBSYS SID ALL REALAR(1) REALAR(2) USEVAL(1)
USEVAL(2)
Python command syntax:
ierr = opf_genrsv_subsys(sid, all, realar, useval)
Fortran command syntax:
CALL OPF_GENRSV_SUBSYS(SID, ALL, REALAR, USEVAL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) unit ramp rate in MW/minute (default val-
ue of 9999.0 for new records, current value
used otherwise)
REALAR(2) unit capability in MW (default value of
9999.0 for new records, current value used
otherwise)
Integer USEVAL (2) array of 2 elements specifying (default treatment same as value of 0)
(input).
USEVAL(1) indicates how the value of REALAR(1) should
be used
USEVAL(1) = 0 if the value of REALAR(1) is to be used as de-
fined
USEVAL(1) = 1 if the value of REALAR(1) is to be multiplied
by the present value of the unit ramp rate
USEVAL(1) = 2 if the value of REALAR(1) is to be added to
the present value of the unit ramp rate
USEVAL(2) indicates how the value of REALAR(2) should
be used
USEVAL(2) = 0 if the value of REALAR(2) is to be used as de-
fined
USEVAL(2) = 1 if the value of REALAR(2) is to be multiplied
by the present value of the unit capability
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1122
Optimal Power Flow OPF_GENRSV_SUBSYS
USEVAL(2) = 2 if the value of REALAR(2) is to be added to
the present value of the unit capability
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 generator reserve unit table is full
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
1123
Optimal Power Flow OPF_GEN_RCAP_INDV
3.2.25. OPF_GEN_RCAP_INDV
Use this API to add an individual generation reactive capability data record to the working case. It may also
be used to modify an existing generation reactive capability data record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_GEN_RCAP_INDV EIBUS GENID RCSTAT REALAR(1)..REALAR(5)
Python command syntax:
ierr = opf_gen_rcap_indv(eibus, genid, rcstat, realar)
Fortran command syntax:
CALL OPF_GEN_RCAP_INDV(EIBUS, GENID, RCSTAT, REALAR, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; ' ' by default).
Integer RCSTAT reactive capability limit status (input; 4 by default).
rcstat = 0 out of service.
rcstat = 1 in service, no reactive generation limits.
rcstat = 2 in service, inhibiting field increase.
rcstat = 3 in service, inhibiting field decrease.
rcstat = 4 in service, fixed Efd.
rcstat = 5 in service, apply reactive generation limits.
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) direct-axis synchronous reactance in pu on
Mbase (default of 1.0 if new record, current
value otherwise)
REALAR(2) stator current limit in pu on Mbase (default
of 1.0 if new record, current value otherwise)
REALAR(3) rated lagging power factor (default of 1.0 if
new record, current value otherwise)
REALAR(4) rated leading power factor (default of 1.0 if
new record, current value otherwise)
REALAR(5) maximum reactive absorption in pu on
Mbase (default of 1.0 if new record, current
value otherwise)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified machine does not exist
IERR = 3 generator reactive capability data table is full
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1124
Optimal Power Flow OPF_GEN_RCAP_INDV
IERR = 4 prerequisite requirements for API are not met
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Invalid reactive capability sta-
tus specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1125
Optimal Power Flow OPF_GEN_RCAP_SUBSYS
3.2.26. OPF_GEN_RCAP_SUBSYS
Use this API to add or modify all OPF generator reactive capability records in a specified subsystem of the
working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_GEN_RCAP_SUBSYS SID ALL RCSTAT REALAR(1)..REALAR(5)
USEVAL(1)..USEVAL(5)
Python command syntax:
ierr = opf_gen_rcap_subsys(sid, all, rcstat, realar, useval)
Fortran command syntax:
CALL OPF_GEN_RCAP_SUBSYS(SID, ALL, RCSTAT, REALAR, USEVAL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Integer RCSTAT reactive capability limit status (default value of 4 for new records,
current value otherwise) (input).
rcstat = 0 out of service.
rcstat = 1 in service, no reactive generation limits.
rcstat = 2 in service, inhibiting field increase.
rcstat = 3 in service, inhibiting field decrease.
rcstat = 4 in service, fixed Efd.
rcstat = 5 in service, apply reactive generation limits.
Real REALAR (5) array of 5 elements specifying The value of each is as follows(input).
REALAR(1) direct-axis synchronous reactance in pu on
Mbase (default value of 1.0 for new records,
current value otherwise)
REALAR(2) stator current limit in pu on Mbase (default
value of 1.0 for new records, current value
otherwise)
REALAR(3) rated lagging power factor (default value of
1.0 for new records, current value otherwise)
REALAR(4) rated leading power factor (default value of
1.0 for new records, current value otherwise)
REALAR(5) maximum reactive absorption in pu on
Mbase (default value of 1.0 for new records,
current value otherwise)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1126
Optimal Power Flow OPF_GEN_RCAP_SUBSYS
Integer USEVAL (5) array of 5 elements specifying (default treatment same as value of 0)
(input).
USEVAL(1) indicates how the value of REALAR(1) should
be used
USEVAL(1) = 0 if the value of REALAR(1) is to be used as de-
fined
USEVAL(1) = 1 if the value of REALAR(1) is to be multiplied
by the present value of the direct-axis syn-
chronous reactance
USEVAL(1) = 2 if the value of REALAR(1) is to be added to
the present value of the direct-axis synchro-
nous reactance
USEVAL(2) indicates how the value of REALAR(2) should
be used
USEVAL(2) = 0 if the value of REALAR(2) is to be used as de-
fined
USEVAL(2) = 1 if the value of REALAR(2) is to be multiplied
by the present value of the stator current lim-
it
USEVAL(2) = 2 if the value of REALAR(2) is to be added to
the present value of the stator current limit
USEVAL(3) indicates how the value of REALAR(3) should
be used
USEVAL(3) = 0 if the value of REALAR(3) is to be used as de-
fined
USEVAL(3) = 1 if the value of REALAR(3) is to be multiplied
by the present value of the rated lagging
power factor
USEVAL(3) = 2 if the value of REALAR(3) is to be added to
the present value of the rated lagging power
factor
USEVAL(4) indicates how the value of REALAR(4) should
be used
USEVAL(4) = 0 if the value of REALAR(4) is to be used as de-
fined
USEVAL(4) = 1 if the value of REALAR(4) is to be multiplied
by the present value of the rated leading
power factor
USEVAL(4) = 2 if the value of REALAR(4) is to be added to
the present value of the rated leading power
factor
USEVAL(5) indicates how the value of REALAR(5) should
be used
USEVAL(5) = 0 if the value of REALAR(5) is to be used as de-
fined
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1127
Optimal Power Flow OPF_GEN_RCAP_SUBSYS
USEVAL(5) = 1 if the value of REALAR(5) is to be multiplied
by the present value of the maximum reac-
tive absorption
USEVAL(5) = 2 if the value of REALAR(5) is to be added to
the present value of the maximum reactive
absorption
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 generator reactive capability data table is full
IERR = 4 prerequisite requirements for API are not met
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Invalid reactive capability sta-
tus specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1128
Optimal Power Flow OPF_INTFLW_3WT
3.2.27. OPF_INTFLW_3WT
Use this API to add a participating three-winding transformer winding to a specified interface flow con-
straint in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_INTFLW_3WT IFID EIBUS EJBUS EKBUS CKTID
Python command syntax:
ierr = opf_intflw_3wt(ifid, eibus, ejbus, ekbus, cktid)
Fortran command syntax:
CALL OPF_INTFLW_3WT(IFID, EIBUS, EJBUS, EKBUS, CKTID, IERR)
Where:
Integer IFID interface flow identifier (input; no default allowed).
Integer EIBUS from bus number The value of EIBUS indicates the from bus of the
winding for which the flow constraint is being introduced (input; no
default allowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 participating branch table is full
IERR = 2 invalid interface flow identifier specified
IERR = 3 invalid bus number specified
IERR = 4 specified three-winding transformer does not
exist
IERR = 5 specified winding is already participating in
the interface
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
1129
Optimal Power Flow OPF_INTFLW_BRN
3.2.28. OPF_INTFLW_BRN
Use this API to add a participating branch to a specified interface flow constraint in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_INTFLW_BRN IFID EIBUS EJBUS CKTID
Python command syntax:
ierr = opf_intflw_brn(ifid, eibus, ejbus, cktid)
Fortran command syntax:
CALL OPF_INTFLW_BRN(IFID, EIBUS, EJBUS, CKTID, IERR)
Where:
Integer IFID interface flow identifier (input; no default allowed).
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 participating branch table is full
IERR = 2 invalid interface flow identifier specified
IERR = 3 invalid bus number specified
IERR = 4 specified branch does not exist
IERR = 5 specified branch is already participating in the
interface
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
1130
Optimal Power Flow OPF_INTFLW_MAIN
3.2.29. OPF_INTFLW_MAIN
Use this API to add an interface flow constraint record to the working case. It may also be used to modify
an existing interface flow constraint record.
This API must be invoked prior to adding any participating branch or three-winding transformer flows to
the interface flow constraint.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_INTFLW_MAIN IFID LABL INTGAR(1) INTGAR(2)
REALAR(1)..REALAR(3)
Python command syntax:
ierr = opf_intflw_main(ifid, labl, intgar, realar)
Fortran command syntax:
CALL OPF_INTFLW_MAIN(IFID, LABL, INTGAR, REALAR, IERR)
Where:
Integer IFID interface flow identifier (input; no default allowed).
Character*32 LABL interface flow description made up of, at most, 32 characters (input;
' ' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) interface flow type (default value of 1 if new
record, current value otherwise)
INTGAR(1) = 1 MW
INTGAR(1) = 2 Mvar
INTGAR(2) interface flow limit type (default value of 1 if
new record, current value otherwise)
INTGAR(2) = 0 reporting only
INTGAR(2) = 1 hard limit
INTGAR(2) = 2 linear soft limit
INTGAR(2) = 3 quadratic soft limit
Real REALAR (3) array of 3 elements specifying (input).
REALAR(1) maximum interface flow, in physical units
(default value of 0.0 if new record, current
value otherwise)
REALAR(2) minimum interface flow, in physical units
(default value of 0.0 if new record, current
value otherwise)
REALAR(3) soft limit penalty weight (default value of 1.0
if new record, current value otherwise)
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
1131
Optimal Power Flow OPF_INTFLW_MAIN
IERR = 1 interface flow constraint table is full
IERR = 2 prerequisite requirements for API are not met
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Invalid flow type specified.
- Invalid interface flow limit type specified. -
Maximum interface flow is less than the mini-
mum interface flow
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1132
Optimal Power Flow OPF_INTFLW_RESET
3.2.30. OPF_INTFLW_RESET
Use this API to remove all interface branches associated with a particular interface flow constraint in the
working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_INTFLW_RESET IFID
Python command syntax:
ierr = opf_intflw_reset(ifid)
Fortran command syntax:
CALL OPF_INTFLW_RESET(IFID, IERR)
Where:
Integer IFID interface flow identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid interface flow identifier specified
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
1133
Optimal Power Flow OPF_LNCEQN_ADJLOAD
3.2.31. OPF_LNCEQN_ADJLOAD
Use this API to add a participating adjustable bus load variable to a specified linear constraint dependency
equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_ADJLOAD IQID ITBL COEFF
Python command syntax:
ierr = opf_lnceqn_adjload(iqid, itbl, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_ADJLOAD(IQID, ITBL, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer ITBL adjustable bus load table identifier (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
default of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 specified adjustable bus load table does not
exist
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
1134
Optimal Power Flow OPF_LNCEQN_ADJVAR
3.2.32. OPF_LNCEQN_ADJVAR
Use this API to add a participating adjustable bus shunt variable to a specified linear constraint dependency
equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_ADJVAR IQID EIBUS SHNTID COEFF
Python command syntax:
ierr = opf_lnceqn_adjvar(iqid, eibus, shntid, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_ADJVAR(IQID, EIBUS, SHNTID, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Character*2 SHNTID OPF adjustable bus shunt identifier (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
default of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number specified
IERR = 4 specified adjustable bus shunt does not exist
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
1135
Optimal Power Flow OPF_LNCEQN_BRFLOW
3.2.33. OPF_LNCEQN_BRFLOW
Use this API to add a participating branch flow variable to a specified linear constraint dependency equa-
tion in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_BRFLOW IQID EIBUS EJBUS EKBUS CKTID FLWID COEFF
Python command syntax:
ierr = opf_lnceqn_brflow(iqid, eibus, ejbus, ekbus, cktid, flwid, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_BRFLOW(IQID, EIBUS, EJBUS, EKBUS, CKTID, FLWID, COEFF,
IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number for a three-winding transformer and zero for a two-
winding transformer (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 FLWID branch flow identifier (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable. (input;
Default value of 1.0 if new record, current value otherwise.).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number specified
IERR = 4 specified branch/transformer does not exist
IERR = 5 specified three-winding transformer does not
exist
IERR = 6 flow constraint does not exist at the specified
branch
IERR = 7 flow constraint does not exist at the specified
three-winding transformer
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
1136
Optimal Power Flow OPF_LNCEQN_INTFLOW
3.2.34. OPF_LNCEQN_INTFLOW
Use this API to add a participating interface flow constraint variable to a specified linear constraint depen-
dency equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_INTFLOW IQID ITBL COEFF
Python command syntax:
ierr = opf_lnceqn_intflow(iqid, itbl, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_INTFLOW(IQID, ITBL, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer ITBL interface flow identifier (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise.).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 specified interface identifier does not exist
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
1137
Optimal Power Flow OPF_LNCEQN_MAIN
3.2.35. OPF_LNCEQN_MAIN
Use this API to add a linear constraint dependency record to the working case. It may also be used to modi-
fy an existing linear constraint dependency record.
This API must be invoked prior to adding any participating linear constraint equation variable records to the
specified linear constraint dependency equation.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_MAIN IQID LABL REALAR(1) REALAR(2)
Python command syntax:
ierr = opf_lnceqn_main(iqid, labl, realar)
Fortran command syntax:
CALL OPF_LNCEQN_MAIN(IQID, LABL, REALAR, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Character*12 LABL linear constraint description made up of, at most, 12 characters (in-
put; ' ' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) maximum constraint slack value (Default val-
ue of 1.0 if new record, current value other-
wise. by default)
REALAR(2) minimum constraint slack value (Default val-
ue of 1.0 if new record, current value other-
wise. by default)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Maximum linear constraint
slack is less than the minimum linear con-
straint slack
IERR = 0 no error occurred
IERR = 1 linear constraint table is full
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
1138
Optimal Power Flow OPF_LNCEQN_PGEN
3.2.36. OPF_LNCEQN_PGEN
Use this API to add a participating active power dispatch variable to a specified linear constraint dependen-
cy equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_PGEN IQID ITBL COEFF
Python command syntax:
ierr = opf_lnceqn_pgen(iqid, itbl, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_PGEN(IQID, ITBL, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer ITBL active power dispatch table number (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise.).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid active power dispatch table number
specified
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
1139
Optimal Power Flow OPF_LNCEQN_QGEN
3.2.37. OPF_LNCEQN_QGEN
Use this API to add a participating reactive power dispatch variable of a specified linear constraint depen-
dency equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_QGEN IQID EIBUS GENID COEFF
Python command syntax:
ierr = opf_lnceqn_qgen(iqid, eibus, genid, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_QGEN(IQID, EIBUS, GENID, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise.).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 specified bus does not exist
IERR = 4 specified machine does not exist at bus
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
1140
Optimal Power Flow OPF_LNCEQN_RESET
3.2.38. OPF_LNCEQN_RESET
Use this API to remove all participating variables from a particular OPF linear constraint dependency equa-
tion in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_RESET IQID
Python command syntax:
ierr = opf_lnceqn_reset(iqid)
Fortran command syntax:
CALL OPF_LNCEQN_RESET(IQID, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 Invalid linear constraint identifier specified
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
1141
Optimal Power Flow OPF_LNCEQN_SWSHUNT
3.2.39. OPF_LNCEQN_SWSHUNT
This API routine is obsolete. It has been replaced by the API routine opf_lnceqn_swshunt_2 .
Use this API to add a participating switched shunt variable to a specified linear constraint dependency
equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_SWSHUNT IQID EIBUS COEFF
Python command syntax:
ierr = opf_lnceqn_swshunt(iqid, eibus, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_SWSHUNT(IQID, EIBUS, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1142
Optimal Power Flow OPF_LNCEQN_SWSHUNT_2
3.2.40. OPF_LNCEQN_SWSHUNT_2
Use this API to add a participating switched shunt variable to a specified linear constraint dependency
equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_SWSHUNT_2 IQID EIBUS SWSHID COEFF
Python command syntax:
ierr = opf_lnceqn_swshunt_2(iqid, eibus, swshid, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_SWSHUNT_2(IQID, EIBUS, SWSHID, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
character*2 SWSHID Switched shunt identifier (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number specified
IERR = 4 specified switched shunt does not exist
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
1143
Optimal Power Flow OPF_LNCEQN_TRAN
3.2.41. OPF_LNCEQN_TRAN
Use this API to add a participating transformer control variable to a specified linear constraint dependency
equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_TRAN IQID EIBUS EJBUS EKBUS CKTID COEFF
Python command syntax:
ierr = opf_lnceqn_tran(iqid, eibus, ejbus, ekbus, cktid, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_TRAN(IQID, EIBUS, EJBUS, EKBUS, CKTID, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number if a three-winding transformer is specified and zero
for a two-winding transformer (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number specified
IERR = 3 specified branch/transformer does not exist
IERR = 4 specified three-winding transformer does not
exist
IERR = 5 specified branch is not a transformer
IERR = 6 specified branch is not a three-winding trans-
former
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
1144
Optimal Power Flow OPF_LNCEQN_VANG
3.2.42. OPF_LNCEQN_VANG
This API routine is obsolete. It has been replaced by the API routine opf_lnceqn_vang_2 .
Use this API to add a participating bus voltage angle variable to a specified linear constraint dependency
equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_VANG IQID EIBUS COEFF
Python command syntax:
ierr = opf_lnceqn_vang(iqid, eibus, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_VANG(IQID, EIBUS, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number specified
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
1145
Optimal Power Flow OPF_LNCEQN_VANG_2
3.2.43. OPF_LNCEQN_VANG_2
Use this API to add a participating bus voltage angle variable to a specified linear constraint dependency
equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_OPF_LNCEQN_VANG_2 IQID EIBUS ENODE COEFF
Python command syntax:
ierr = opf_lnceqn_vang_2(iqid, eibus, enode, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_VANG_2(IQID, EIBUS, ENODE, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Integer ENODE The bus section number or the external node number of one of the
nodes in the bus section of interest. Specify 0 if bus is represented by
a single bus section. If 0 is specified and bus is represented by multi-
ple bus sections, the data of the parent bus and not that of the bus
sections will be changed. (input).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number
IERR = 4 bus not found
IERR = 5 invalid node number
IERR = 6 node not found in substation of bus
IERR = 7 node not connected to any bus section of bus
in substation
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
1146
Optimal Power Flow OPF_LNCEQN_VMAG
3.2.44. OPF_LNCEQN_VMAG
This API routine is obsolete. It has been replaced by the API routine opf_lnceqn_vmag_2 .
Use this API to add a participating bus voltage magnitude variable to a specified linear constraint depen-
dency equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LNCEQN_VMAG IQID EIBUS COEFF
Python command syntax:
ierr = opf_lnceqn_vmag(iqid, eibus, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_VMAG(IQID, EIBUS, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number specified
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
1147
Optimal Power Flow OPF_LNCEQN_VMAG_2
3.2.45. OPF_LNCEQN_VMAG_2
Use this API to add a participating bus voltage magnitude variable to a specified linear constraint depen-
dency equation in the working case. It may also be used to modify an existing record.
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_OPF_LNCEQN_VMAG_2 IQID EIBUS ENODE COEFF
Python command syntax:
ierr = opf_lnceqn_vmag_2(iqid, eibus, enode, coeff)
Fortran command syntax:
CALL OPF_LNCEQN_VMAG_2(IQID, EIBUS, ENODE, COEFF, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Integer ENODE The bus section number or the external node number of one of the
nodes in the bus section of interest. Specify 0 if bus is represented by
a single bus section. If 0 is specified and bus is represented by multi-
ple bus sections, the data of the parent bus and not that of the bus
sections will be changed. (input).
Real COEFF value of the coefficient associated with the equation variable (input;
Default value of 1.0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 participating equation variable table is full
IERR = 3 invalid bus number
IERR = 4 bus not found
IERR = 5 invalid node number
IERR = 6 node not found in substation of bus
IERR = 7 node not connected to any bus section of bus
in substation
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
1148
Optimal Power Flow OPF_LOAD_INDV
3.2.46. OPF_LOAD_INDV
Use this API to add an individual OPF bus load data record to the working case. It may also be used to mod-
ify an existing bus load data record.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LOAD_INDV EIBUS LOADID INTGAR
Python command syntax:
ierr = opf_load_indv(eibus, loadid, intgar)
Fortran command syntax:
CALL OPF_LOAD_INDV(EIBUS, LOADID, INTGAR, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 LOADID bus load identifier (input; no default allowed).
Integer INTGAR adjustable bus load table cross reference number (input; Default val-
ue of 0 if new record, current value otherwise).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified load does not exist
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
1149
Optimal Power Flow OPF_LOAD_SUBSYS
3.2.47. OPF_LOAD_SUBSYS
Use this API to add or modify all OPF bus load data records in a specified subsystem of the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_LOAD_SUBSYS SID ALL INTGAR(1) INTGAR(2)
Python command syntax:
ierr = opf_load_subsys(sid, all, intgar)
Fortran command syntax:
CALL OPF_LOAD_SUBSYS(SID, ALL, INTGAR, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses, use existing data values.
ALL = 2 process all buses, use default data values.
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) bus load table cross reference number (de-
fault value of 0, current value otherwise)
INTGAR(2) indicates which bus types should be
processed (default treatment same as value
of 0)
INTGAR(2) = 0 all buses in subsystem
INTGAR(2) = 1 only Type 1 buses in subsystem
INTGAR(2) = 2 only Type 2 and 3 buses in subsystem
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
1150
Optimal Power Flow OPF_PERRSV_GEN
3.2.48. OPF_PERRSV_GEN
Use this API to add a participating generation reserve unit to a previously defined period reserve constraint
in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_PERRSV_GEN RSVID EIBUS GENID
Python command syntax:
ierr = opf_perrsv_gen(rsvid, eibus, genid)
Fortran command syntax:
CALL OPF_PERRSV_GEN(RSVID, EIBUS, GENID, IERR)
Where:
Integer RSVID period reserve identifier (1 through 15) (input; no default allowed).
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid period reserve identifier specified
IERR = 2 invalid bus number specified
IERR = 3 specified machine does not exist
IERR = 4 specified unit does not have any generator re-
serve data defined
IERR = 5 specified unit is already participating in the
reserve constraint
IERR = 6 generator reserve participating unit table 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
1151
Optimal Power Flow OPF_PERRSV_MAIN
3.2.49. OPF_PERRSV_MAIN
Use this API to add a period reserve constraint record to the working case. It may also be used to modify an
existing period reserve constraint record.
This API must be invoked prior to adding any participating generator reserve units (via OPF_PERRSV_GEN)
to a specified period reserve constraint.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_PERRSV_MAIN RSVID STATUS REALAR(1) REALAR(2)
Python command syntax:
ierr = opf_perrsv_main(rsvid, status, realar)
Fortran command syntax:
CALL OPF_PERRSV_MAIN(RSVID, STATUS, REALAR, IERR)
Where:
Integer RSVID a valid period reserve identifier (1 through 15) (input; no default al-
lowed).
Integer STATUS status of the period reserve constraint (input; default value of 1 if
new record, current value otherwise).
status = 0 out of service.
status = 1 in service.
Real REALAR (2) array of 2 elements specifying The value for each is as follows(input).
REALAR(1) reserve limit, in MW (default value of 0.0 if
new record, current value otherwise)
REALAR(2) period, in minutes (default value of 9999.0 if
new record, current value otherwise)
Integer IERR error code (output).
IERR = -1 non-fatal error occurred. Possible warning
messages are: - Invalid period reserve status
specified
IERR = 0 no error occurred
IERR = 1 invalid period reserve identifier specified
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
1152
Optimal Power Flow OPF_PERRSV_RESET
3.2.50. OPF_PERRSV_RESET
Use this API to remove all generation reserve units associated with a particular period reserve constraint in
the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_OPF_PERRSV_RESET RSVID
Python command syntax:
ierr = opf_perrsv_reset(rsvid)
Fortran command syntax:
CALL OPF_PERRSV_RESET(RSVID, IERR)
Where:
Integer RSVID period reserve identifier (1 through 15) (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid period reserve identifier specified
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
1153
Optimal Power Flow PURGE_ALL_OPF_DATA
3.2.51. PURGE_ALL_OPF_DATA
Use this API to purge and re-initialize all OPF data records in the working case. Unlike the NEWOPF_API call,
any OPF data in the working case will be purged and re-initialized.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_ALL_OPF_DATA
Python command syntax:
ierr = purge_all_opf_data()
Fortran command syntax:
CALL PURGE_ALL_OPF_DATA(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
1154
Optimal Power Flow PURGE_OPF_ADJBRX_INDV
3.2.52. PURGE_OPF_ADJBRX_INDV
Use this API to purge an individual adjustable branch reactance data record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_ADJBRX_INDV EIBUS EJBUS CKTID
Python command syntax:
ierr = purge_opf_adjbrx_indv(eibus, ejbus, cktid)
Fortran command syntax:
CALL PURGE_OPF_ADJBRX_INDV_2(EIBUS, EJBUS, CKTID, IERR)
Where:
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified branch does not exist
IERR = 3 prerequisite requirements for API are not met
IERR = 4 specified branch cannot be a transformer
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1155
Optimal Power Flow PURGE_OPF_ADJBRX_SUBSYS
3.2.53. PURGE_OPF_ADJBRX_SUBSYS
Use this API to purge all OPF branch reactance data records from a specified subsystem of the working
case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_ADJBRX_SUBSYS SID ALL
Python command syntax:
ierr = purge_opf_adjbrx_subsys(sid, all)
Fortran command syntax:
CALL PURGE_OPF_ADJBRX_SUBSYS_2(SID, ALL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
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
1156
Optimal Power Flow PURGE_OPF_ADJLOAD_TBL
3.2.54. PURGE_OPF_ADJLOAD_TBL
Use this API to purge an individual adjustable bus load table from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_ADJLOAD_TBL TBL
Python command syntax:
ierr = purge_opf_adjload_tbl(tbl)
Fortran command syntax:
CALL PURGE_OPF_ADJLOAD_TBL_2(TBL, IERR)
Where:
Integer TBL adjustable bus load table number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 adjustable bus load table does not exist
IERR = 2 load table still referenced by bus load(s) -- un-
able to delete
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
1157
Optimal Power Flow PURGE_OPF_ADJVAR_INDV
3.2.55. PURGE_OPF_ADJVAR_INDV
This API routine is obsolete. It has been replaced by the API routine purge_opf_adjvar_indv_3 .
Use this API to purge an individual OPF adjustable bus shunt data record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_ADJVAR_INDV EIBUS SHNTID
Python command syntax:
ierr = purge_opf_adjvar_indv(eibus, shntid)
Fortran command syntax:
CALL PURGE_OPF_ADJVAR_INDV_2(EIBUS, SHNTID, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 SHNTID bus shunt identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 adjustable bus shunt identifier is more than
two characters
IERR = 2 invalid bus number specified
IERR = 3 blank adjustable bus shunt identifier is invalid
IERR = 4 OPF adjustable bus shunt at bus not found
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
1158
Optimal Power Flow PURGE_OPF_ADJVAR_INDV_3
3.2.56. PURGE_OPF_ADJVAR_INDV_3
Use this API to purge an individual OPF adjustable bus shunt data record from the working case.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_PURGE_OPF_ADJVAR_INDV_3 EIBUS ENOD SHNTID
Python command syntax:
ierr = purge_opf_adjvar_indv_3(eibus, enod, shntid)
Fortran command syntax:
CALL PURGE_OPF_ADJVAR_INDV_3(EIBUS, ENOD, SHNTID, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Integer ENOD The section number or the node number of one of the nodes in the
bus section of interest. Specify 0 (zero) if the bus is represented by
a single bus section. If 0 is specified and the bus is represented by
multiple bus sections, then the data of the parent bus and not that of
one of the bus sections is changed. (input).
Character*2 SHNTID bus shunt identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 adjustable bus shunt identifier is more than
two characters
IERR = 2 invalid bus number specified
IERR = 3 blank adjustable bus shunt identifier is invalid
IERR = 4 OPF adjustable bus shunt at bus not found
IERR = 5 prerequisite requirements for API are not met
IERR = 6 bus not found
IERR = 7 invalid node number
IERR = 8 bus does not belong to a substation
IERR = 9 node is not found in the substation
IERR = 10 node is not connected to any bus section of
bus
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1159
Optimal Power Flow PURGE_OPF_ADJVAR_SUBSYS
3.2.57. PURGE_OPF_ADJVAR_SUBSYS
Use this API to purge all OPF adjustable bus shunt records from a specified subsystem of the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_ADJVAR_SUBSYS SID ALL SHNTID
Python command syntax:
ierr = purge_opf_adjvar_subsys(sid, all, shntid)
Fortran command syntax:
CALL PURGE_OPF_ADJVAR_SUBSYS_2(SID, ALL, SHNTID, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Character*2 SHNTID Adjustable bus shunt identifier. If blank then all adjustable bus
shunts in subsystem will be deleted. (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 adjustable bus shunt identifier is more than
two characters
IERR = 2 invalid SID value or subsystem SID is not de-
fined
IERR = 3 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
1160
Optimal Power Flow PURGE_OPF_APDSP_TBL
3.2.58. PURGE_OPF_APDSP_TBL
Use this API to purge an individual active power dispatch table record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_APDSP_TBL TBL
Python command syntax:
ierr = purge_opf_apdsp_tbl(tbl)
Fortran command syntax:
CALL PURGE_OPF_APDSP_TBL_2(TBL, IERR)
Where:
Integer TBL active power dispatch table number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 active power dispatch table does not exist
IERR = 2 active power dispatch table still referenced --
unable to delete
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
1161
Optimal Power Flow PURGE_OPF_BRFLW_3WT
3.2.59. PURGE_OPF_BRFLW_3WT
Use this API to purge an individual flow constraint record of a three-winding transformer from the working
case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_BRFLW_3WT EIBUS EJBUS EKBUS CKTID BFLWID
Python command syntax:
ierr = purge_opf_brflw_3wt(eibus, ejbus, ekbus, cktid, bflwid)
Fortran command syntax:
CALL PURGE_OPF_BRFLW_3WT_2(EIBUS, EJBUS, EKBUS, CKTID, BFLWID, IERR)
Where:
Integer EIBUS from bus of the winding from which the flow constraint is being
purged (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 BFLWID branch flow constraint identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified three-winding transformer does not
exist
IERR = 3 specified winding of three-winding trans-
former not found
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
1162
Optimal Power Flow PURGE_OPF_BRFLW_BRN
3.2.60. PURGE_OPF_BRFLW_BRN
Use this API to purge an individual branch or two-winding transformer flow constraint record from the
working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_BRFLW_BRN EIBUS EJBUS CKTID BFLWID
Python command syntax:
ierr = purge_opf_brflw_brn(eibus, ejbus, cktid, bflwid)
Fortran command syntax:
CALL PURGE_OPF_BRFLW_BRN_2(EIBUS, EJBUS, CKTID, BFLWID, IERR)
Where:
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 BFLWID branch flow constraint identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified branch does not exist
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
1163
Optimal Power Flow PURGE_OPF_BRFLW_SUBSYS
3.2.61. PURGE_OPF_BRFLW_SUBSYS
Use this API to purge all branch flow data records in a specified subsystem in the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_BRFLW_SUBSYS SID ALL BFLWID
Python command syntax:
ierr = purge_opf_brflw_subsys(sid, all, bflwid)
Fortran command syntax:
CALL PURGE_OPF_BRFLW_SUBSYS_2(SID, ALL, BFLWID, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses.
Character*1 BFLWID branch flow identifier (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 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1164
Optimal Power Flow PURGE_OPF_BUS_INDV
3.2.62. PURGE_OPF_BUS_INDV
This API routine is obsolete. It has been replaced by the API routine purge_opf_bus_indv_3 .
Use this API to purge (re-initialize) OPF bus voltage magnitude data for an individual record in the working
case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_BUS_INDV EIBUS
Python command syntax:
ierr = purge_opf_bus_indv(eibus)
Fortran command syntax:
CALL PURGE_OPF_BUS_INDV_2(EIBUS, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
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
1165
Optimal Power Flow PURGE_OPF_BUS_INDV_3
3.2.63. PURGE_OPF_BUS_INDV_3
Use this API to purge (re-initialize) OPF bus voltage magnitude data for an individual bus or bus section
record in the working case.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_PURGE_OPF_BUS_INDV_3 EIBUS ENOD
Python command syntax:
ierr = purge_opf_bus_indv_3(eibus, enod)
Fortran command syntax:
CALL PURGE_OPF_BUS_INDV_3(EIBUS, ENOD, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Integer ENOD The bus section number or the external node number of one of the
nodes in the bus sections of interest. Specify 0 if bus is represent-
ed by a single bus section. If 0 is specified and bus is represented by
multiple bus sections, then the data of parent bus and not that of
one of the bus sections is changed. (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
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
1166
Optimal Power Flow PURGE_OPF_BUS_SUBSYS
3.2.64. PURGE_OPF_BUS_SUBSYS
Use this API to purge (re-initialize) OPF bus attribute data for all records in a specified subsystem of the
working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_BUS_SUBSYS SID ALL
Python command syntax:
ierr = purge_opf_bus_subsys(sid, all)
Fortran command syntax:
CALL PURGE_OPF_BUS_SUBSYS_2(SID, ALL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses, use existing data values.
ALL = 2 process all buses, use default data values.
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
1167
Optimal Power Flow PURGE_OPF_CSTTBL_LIN
3.2.65. PURGE_OPF_CSTTBL_LIN
Use this API to purge an optimal power flow linear cost curve record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_CSTTBL_LIN TBL
Python command syntax:
ierr = purge_opf_csttbl_lin(tbl)
Fortran command syntax:
CALL PURGE_OPF_CSTTBL_LIN_2(TBL, IERR)
Where:
Integer TBL linear cost curve table number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear cost table does not exist
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
1168
Optimal Power Flow PURGE_OPF_CSTTBL_POLY
3.2.66. PURGE_OPF_CSTTBL_POLY
Use this API to purge an optimal power flow polynomial and exponential cost curve record from the work-
ing case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_CSTTBL_POLY TBL
Python command syntax:
ierr = purge_opf_csttbl_poly(tbl)
Fortran command syntax:
CALL PURGE_OPF_CSTTBL_POLY_2(TBL, IERR)
Where:
Integer TBL polynomial and exponential cost curve table number (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified polynomial cost table does not exist
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
1169
Optimal Power Flow PURGE_OPF_CSTTBL_QUAD
3.2.67. PURGE_OPF_CSTTBL_QUAD
Use this API to purge an optimal power flow quadratic cost curve record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_CSTTBL_QUAD TBL
Python command syntax:
ierr = purge_opf_csttbl_quad(tbl)
Fortran command syntax:
CALL PURGE_OPF_CSTTBL_QUAD_2(TBL, IERR)
Where:
Integer TBL quadratic cost curve table number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified quadratic cost table does not exist
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
1170
Optimal Power Flow PURGE_OPF_GENDSP_INDV
3.2.68. PURGE_OPF_GENDSP_INDV
Use this API to purge generator dispatch data for an individual record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_GENDSP_INDV EIBUS GENID
Python command syntax:
ierr = purge_opf_gendsp_indv(eibus, genid)
Fortran command syntax:
CALL PURGE_OPF_GENDSP_INDV_2(EIBUS, GENID, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified machine does not exist
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
1171
Optimal Power Flow PURGE_OPF_GENDSP_SUBSYS
3.2.69. PURGE_OPF_GENDSP_SUBSYS
Use this API to purge generator dispatch data for all records from a specified subsystem of the working
case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_GENDSP_SUBSYS SID ALL
Python command syntax:
ierr = purge_opf_gendsp_subsys(sid, all)
Fortran command syntax:
CALL PURGE_OPF_GENDSP_SUBSYS_2(SID, ALL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
ALL = 1 process all buses, use existing data values.
ALL = 2 process all buses, use default data values.
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
1172
Optimal Power Flow PURGE_OPF_GENRSV_INDV
3.2.70. PURGE_OPF_GENRSV_INDV
Use this API to purge an individual optimal power flow generator reserve data record from the working
case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_GENRSV_INDV EIBUS GENID
Python command syntax:
ierr = purge_opf_genrsv_indv(eibus, genid)
Fortran command syntax:
CALL PURGE_OPF_GENRSV_INDV_2(EIBUS, GENID, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified machine does not exist
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
1173
Optimal Power Flow PURGE_OPF_GENRSV_SUBSYS
3.2.71. PURGE_OPF_GENRSV_SUBSYS
Use this API to purge all OPF generator reserve records in a specified subsystem from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_GENRSV_SUBSYS SID ALL
Python command syntax:
ierr = purge_opf_genrsv_subsys(sid, all)
Fortran command syntax:
CALL PURGE_OPF_GENRSV_SUBSYS_2(SID, ALL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
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
1174
Optimal Power Flow PURGE_OPF_GEN_RCAP_INDV
3.2.72. PURGE_OPF_GEN_RCAP_INDV
Use this API to purge an individual OPF generation reactive capability data record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_GEN_RCAP_INDV EIBUS GENID
Python command syntax:
ierr = purge_opf_gen_rcap_indv(eibus, genid)
Fortran command syntax:
CALL PURGE_OPF_GEN_RCAP_INDV_2(EIBUS, GENID, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified machine does not exist
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
1175
Optimal Power Flow PURGE_OPF_GEN_RCAP_SUBSYS
3.2.73. PURGE_OPF_GEN_RCAP_SUBSYS
Use this API to purge all OPF generator reactive capability records in a specified subsystem from the work-
ing case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_GEN_RCAP_SUBSYS SID ALL
Python command syntax:
ierr = purge_opf_gen_rcap_subsys(sid, all)
Fortran command syntax:
CALL PURGE_OPF_GEN_RCAP_SUBSYS_2(SID, ALL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
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
1176
Optimal Power Flow PURGE_OPF_INTFLW
3.2.74. PURGE_OPF_INTFLW
Use this API to purge an OPF interface flow constraint record, including all of its participating branches,
from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_INTFLW IFID
Python command syntax:
ierr = purge_opf_intflw(ifid)
Fortran command syntax:
CALL PURGE_OPF_INTFLW_2(IFID, IERR)
Where:
Integer IFID interface flow identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 interface flow identifier not found
IERR = 2 unable to remove interface flow record due to
participation in linear constraint record
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
1177
Optimal Power Flow PURGE_OPF_INTFLW_3WT
3.2.75. PURGE_OPF_INTFLW_3WT
Use this API to remove a participating three-winding transformer winding from a specified OPF interface
flow constraint in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_INTFLW_3WT IFID EIBUS EJBUS EKBUS CKTID
Python command syntax:
ierr = purge_opf_intflw_3wt(ifid, eibus, ejbus, ekbus, cktid)
Fortran command syntax:
CALL PURGE_OPF_INTFLW_3WT(IFID, EIBUS, EJBUS, EKBUS, CKTID, IERR)
Where:
Integer IFID interface flow identifier (input; no default allowed).
Integer EIBUS from bus number The value of EIBUS indicates the from bus of the
winding to be removed from the flow constraint (input; no default al-
lowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid interface flow identifier specified
IERR = 2 invalid bus number specified
IERR = 3 specified three-winding transformer does not
exist
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
1178
Optimal Power Flow PURGE_OPF_INTFLW_BRN
3.2.76. PURGE_OPF_INTFLW_BRN
Use this API to remove a participating branch from a specified OPF interface flow constraint in the working
case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_INTFLW_BRN IFID EIBUS EJBUS CKTID
Python command syntax:
ierr = purge_opf_intflw_brn(ifid, eibus, ejbus, cktid)
Fortran command syntax:
CALL PURGE_OPF_INTFLW_BRN(IFID, EIBUS, EJBUS, CKTID, IERR)
Where:
Integer IFID interface flow identifier (input; no default allowed).
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid interface flow identifier specified
IERR = 2 invalid bus number specified
IERR = 3 specified branch does not exist
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
1179
Optimal Power Flow PURGE_OPF_LNCEQN
3.2.77. PURGE_OPF_LNCEQN
Use this API to purge an OPF linear constraint dependency record, including all of its participating vari-
ables, from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN IQID
Python command syntax:
ierr = purge_opf_lnceqn(iqid)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_2(IQID, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 linear constraint equation number 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
1180
Optimal Power Flow PURGE_OPF_LNCEQN_ADJLOAD
3.2.78. PURGE_OPF_LNCEQN_ADJLOAD
Use this API to remove a participating adjustable bus load variable from a specified OPF linear constraint
dependency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_ADJLOAD IQID ITBL
Python command syntax:
ierr = purge_opf_lnceqn_adjload(iqid, itbl)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_ADJLOAD(IQID, ITBL, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer ITBL adjustable bus load table identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 specified adjustable bus load table does not
exist
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
1181
Optimal Power Flow PURGE_OPF_LNCEQN_ADJVAR
3.2.79. PURGE_OPF_LNCEQN_ADJVAR
Use this API to remove a participating adjustable bus shunt variable from a specified OPF linear constraint
dependency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_ADJVAR IQID EIBUS SHNTID
Python command syntax:
ierr = purge_opf_lnceqn_adjvar(iqid, eibus, shntid)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_ADJVAR(IQID, EIBUS, SHNTID, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Character*2 SHNTID adjustable bus shunt identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number specified
IERR = 3 specified adjustable bus shunt does not exist
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
1182
Optimal Power Flow PURGE_OPF_LNCEQN_BRFLOW
3.2.80. PURGE_OPF_LNCEQN_BRFLOW
Use this API to remove a participating branch flow variable from a specified OPF linear constraint depen-
dency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_BRFLOW IQID EIBUS EJBUS EKBUS CKTID FLWID
Python command syntax:
ierr = purge_opf_lnceqn_brflow(iqid, eibus, ejbus, ekbus, cktid, flwid)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_BRFLOW(IQID, EIBUS, EJBUS, EKBUS, CKTID, FLWID,
IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number for a three-winding transformer and zero for a two-
winding transformer (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Character*1 FLWID branch flow identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number specified
IERR = 3 specified branch/transformer does not exist
IERR = 4 specified three-winding transformer does not
exist
IERR = 5 flow constraint does not exist at the specified
branch
IERR = 6 flow constraint does not exist at the specified
three-winding transformer
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
1183
Optimal Power Flow PURGE_OPF_LNCEQN_INTFLOW
3.2.81. PURGE_OPF_LNCEQN_INTFLOW
Use this API to remove a participating interface flow constraint variable from a specified OPF linear con-
straint dependency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_INTFLOW IQID ITBL
Python command syntax:
ierr = purge_opf_lnceqn_intflow(iqid, itbl)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_INTFLOW(IQID, ITBL, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer ITBL interface flow identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 specified interface identifier does not exist
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
1184
Optimal Power Flow PURGE_OPF_LNCEQN_PGEN
3.2.82. PURGE_OPF_LNCEQN_PGEN
Use this API to remove a participating active power dispatch variable from a specified OPF linear constraint
dependency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_PGEN IQID ITBL
Python command syntax:
ierr = purge_opf_lnceqn_pgen(iqid, itbl)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_PGEN(IQID, ITBL, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer ITBL active power dispatch table number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid active power dispatch table number
specified
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
1185
Optimal Power Flow PURGE_OPF_LNCEQN_QGEN
3.2.83. PURGE_OPF_LNCEQN_QGEN
Use this API to remove a participating reactive power dispatch variable from a specified OPF linear con-
straint dependency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_QGEN IQID EIBUS GENID
Python command syntax:
ierr = purge_opf_lnceqn_qgen(iqid, eibus, genid)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_QGEN(IQID, EIBUS, GENID, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 specified bus does not exist
IERR = 3 specified machine does not exist at 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
1186
Optimal Power Flow PURGE_OPF_LNCEQN_SWSHUNT
3.2.84. PURGE_OPF_LNCEQN_SWSHUNT
This API routine is obsolete. It has been replaced by the API routine purge_opf_lnceqn_swshunt_2 .
Use this API to remove a participating switched shunt variable from a specified OPF linear constraint de-
pendency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_SWSHUNT IQID EIBUS
Python command syntax:
ierr = purge_opf_lnceqn_swshunt(iqid, eibus)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_SWSHUNT(IQID, EIBUS, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1187
Optimal Power Flow PURGE_OPF_LNCEQN_SWSHUNT_2
3.2.85. PURGE_OPF_LNCEQN_SWSHUNT_2
Use this API to remove a participating switched shunt variable from a specified OPF linear constraint de-
pendency equation in the working case.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_SWSHUNT_2 IQID EIBUS SWSHID
Python command syntax:
ierr = purge_opf_lnceqn_swshunt_2(iqid, eibus, swshid)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_SWSHUNT_2(IQID, EIBUS, SWSHID, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
character*2 SWSHID Switched shunt identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number specified
IERR = 3 specified switched shunt does not exist
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
1188
Optimal Power Flow PURGE_OPF_LNCEQN_TRAN
3.2.86. PURGE_OPF_LNCEQN_TRAN
Use this API to remove a participating transformer control variable from a specified OPF linear constraint
dependency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_TRAN IQID EIBUS EJBUS EKBUS CKTID
Python command syntax:
ierr = purge_opf_lnceqn_tran(iqid, eibus, ejbus, ekbus, cktid)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_TRAN(IQID, EIBUS, EJBUS, EKBUS, CKTID, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS from bus number (input; no default allowed).
Integer EJBUS to bus number (input; no default allowed).
Integer EKBUS third bus number if a three-winding transformer is specified and zero
for a two-winding transformer (input; no default allowed).
Character*2 CKTID circuit identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number specified
IERR = 3 specified branch/transformer does not exist
IERR = 4 specified three-winding transformer does not
exist
IERR = 5 specified branch is not a transformer
IERR = 6 specified branch is not a three-winding trans-
former
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
1189
Optimal Power Flow PURGE_OPF_LNCEQN_VANG
3.2.87. PURGE_OPF_LNCEQN_VANG
This API routine is obsolete. It has been replaced by the API routine purge_opf_lnceqn_vang_2 .
Use this API to remove a participating bus voltage angle variable from a specified OPF linear constraint de-
pendency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_VANG IQID EIBUS
Python command syntax:
ierr = purge_opf_lnceqn_vang(iqid, eibus)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_VANG(IQID, EIBUS, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number specified
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
1190
Optimal Power Flow PURGE_OPF_LNCEQN_VANG_2
3.2.88. PURGE_OPF_LNCEQN_VANG_2
Use this API to remove a participating bus voltage angle variable from a specified OPF linear constraint de-
pendency equation in the working case.
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_VANG_2 IQID EIBUS ENODE
Python command syntax:
ierr = purge_opf_lnceqn_vang_2(iqid, eibus, enode)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_VANG_2(IQID, EIBUS, ENODE, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Integer ENODE The bus section number or the external node number of one of the
nodes in the bus section of interest. Specify 0 if bus is represented by
a single bus section. If 0 is specified and bus is represented by multi-
ple bus sections, the data of the parent bus and not that of the bus
sections will be changed. (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number
IERR = 3 prerequisite requirements for API are not met
IERR = 4 bus not found
IERR = 5 invalid node number
IERR = 6 node not found in substation of bus
IERR = 7 node not connected to any bus section of bus
in substation
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1191
Optimal Power Flow PURGE_OPF_LNCEQN_VMAG
3.2.89. PURGE_OPF_LNCEQN_VMAG
This API routine is obsolete. It has been replaced by the API routine purge_opf_lnceqn_vmag_2 .
Use this API to remove a participating bus voltage magnitude variable from a specified OPF linear con-
straint dependency equation in the working case.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_VMAG IQID EIBUS
Python command syntax:
ierr = purge_opf_lnceqn_vmag(iqid, eibus)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_VMAG(IQID, EIBUS, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number specified
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
1192
Optimal Power Flow PURGE_OPF_LNCEQN_VMAG_2
3.2.90. PURGE_OPF_LNCEQN_VMAG_2
Use this API to remove a participating bus voltage magnitude variable from a specified OPF linear con-
straint dependency equation in the working case.
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_PURGE_OPF_LNCEQN_VMAG_2 IQID EIBUS ENODE
Python command syntax:
ierr = purge_opf_lnceqn_vmag_2(iqid, eibus, enode)
Fortran command syntax:
CALL PURGE_OPF_LNCEQN_VMAG_2(IQID, EIBUS, ENODE, IERR)
Where:
Integer IQID linear constraint equation identification number (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Integer ENODE The bus section number or the external node number of one of the
nodes in the bus section of interest. Specify 0 if bus is represented by
a single bus section. If 0 is specified and bus is represented by multi-
ple bus sections, the data of the parent bus and not that of the bus
sections will be changed. (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 specified linear constraint equation does not
exist
IERR = 2 invalid bus number
IERR = 3 prerequisite requirements for API are not met
IERR = 4 bus not found
IERR = 5 invalid node number
IERR = 6 node not found in substation of bus
IERR = 7 node not connected to any bus section of bus
in substation
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1193
Optimal Power Flow PURGE_OPF_LOAD_INDV
3.2.91. PURGE_OPF_LOAD_INDV
Use this API to purge (re-initialize) an individual OPF bus load data record from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_LOAD_INDV EIBUS LOADID
Python command syntax:
ierr = purge_opf_load_indv(eibus, loadid)
Fortran command syntax:
CALL PURGE_OPF_LOAD_INDV_2(EIBUS, LOADID, IERR)
Where:
Integer EIBUS bus number (input; no default allowed).
Character*2 LOADID bus load identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid bus number specified
IERR = 2 specified load does not exist
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
1194
Optimal Power Flow PURGE_OPF_LOAD_SUBSYS
3.2.92. PURGE_OPF_LOAD_SUBSYS
Use this API to purge (re-initialize) all OPF bus load data records in a specified subsystem of the working
case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_LOAD_SUBSYS SID ALL
Python command syntax:
ierr = purge_opf_load_subsys(sid, all)
Fortran command syntax:
CALL PURGE_OPF_LOAD_SUBSYS_2(SID, ALL, IERR)
Where:
Integer SID a valid subsystem ID from 0 to 11. A subsystem must have been pre-
viously defined (input; no default allowed).
Integer ALL all buses or specified subsystem flag (input; no default allowed).
ALL = 0 process only specified buses.
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
1195
Optimal Power Flow PURGE_OPF_PERRSV
3.2.93. PURGE_OPF_PERRSV
Use this API to purge an OPF period reserve constraint record and its association with participating reserve
units from the working case.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PURGE_OPF_PERRSV RSVID
Python command syntax:
ierr = purge_opf_perrsv(rsvid)
Fortran command syntax:
CALL PURGE_OPF_PERRSV_2(RSVID, IERR)
Where:
Integer RSVID a valid period reserve identifier (1 through 15) (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid period reserve identifier specified
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
1196
Optimal Power Flow PURGE_OPF_PERRSV_GEN
3.2.94. PURGE_OPF_PERRSV_GEN
Use this API to remove a participating period reserve unit from a specified OPF period reserve constraint.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_PURGE_OPF_PERRSV_GEN RSVID EIBUS GENID
Python command syntax:
ierr = purge_opf_perrsv_gen(rsvid, eibus, genid)
Fortran command syntax:
CALL PURGE_OPF_PERRSV_GEN(RSVID, EIBUS, GENID, IERR)
Where:
Integer RSVID a valid period reserve identifier (1 through 15) (input; no default al-
lowed).
Integer EIBUS bus number (input; no default allowed).
Character*2 GENID machine identifier (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 period reserve constraint does not exist
IERR = 2 bus not found
IERR = 3 machine not found
IERR = 4 machine does not have generator reserve da-
ta defined
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
1197
Optimal Power Flow PURGE_OPF_PERRSV_GEN
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1198
Optimal Power Flow PURGE_OPF_PERRSV_GEN
Optimal Power Flow Data Changing APIs contains API routines specific to adding, modifying, and deleting
optimal power flow data.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1199
Chapter 4
Fault Analysis
This chapter describes the API routines used in PSS®E Fault Analysis, also called PSS®E Short Circuit.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1200
Fault Analysis Fault Analysis Operation
4.1. Fault Analysis Operation
4.1.1. ANSI
This API routine is obsolete. It has been replaced by the API routine ansi_2 .
Use this API to calculate fault currents according to the ANSI standard (activity ANSI). To designate fault
specification data as part of the API's calling sequence, INARG must be positive; to designate fault specifi-
cation data in an ANSI Fault Specification Data input file, INARG must be zero and the filename specified as
FILARG.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ANSI OPTIONS(1)..OPTIONS(3) VALUES(1)..VALUES(4)
INARG BUSARY(1)..BUSARY(INARG) VLTARY(1)..VLTARY(INARG)
CPTARY(1)..CPTARY(INARG) FILARG
Python command syntax:
ierr = ansi(options, values, inarg, busary, vltary, cptary, filarg)
Fortran command syntax:
CALL ANSIAPI(OPTIONS, VALUES, INARG, BUSARY, VLTARY, CPTARY, FILARG, IERR)
Where:
Integer OPTIONS (3) array of 3 elements specifying solution and reporting options(input).
OPTIONS(1) transformer impedance correction option (1
by default)
OPTIONS(1) = 0 do not apply to zero sequence
OPTIONS(1) = 1 apply to zero sequence
OPTIONS(2) set of ANSI decrement factors to use (1 by
default)
OPTIONS(2) = 0 account for dc decrement only (use ANSI ta-
ble 3)
OPTIONS(2) = 1 account for ac and dc decrements (use ANSI
tables 1 and 2)
OPTIONS(3) option (0 by default)
OPTIONS(3) = 0 summary output using ANSI X only, report
format (blank delimited output fields)
OPTIONS(3) = 1 summary output using ANSI X only, spread-
sheet input format (comma delimited output
fields)
OPTIONS(3) = 2 detailed output using ANSI X only
OPTIONS(3) = 3 detailed output using ANSI R and X
OPTIONS(3) = 4 summary output using ANSI R and X, report
format (blank delimited output fields)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1201
Fault Analysis ANSI
OPTIONS(3) = 5 summary output using ANSI R and X, spread-
sheet input format (comma delimited output
fields)
Real VALUES (4) array of 4 elements specifying divisors for calculating resistances
of network elements where resistance is zero in the working
case(input).
VALUES(1) used for branches in the positive sequence
network (40.0 by default)
VALUES(2) used for machines in the positive sequence
network (80.0 by default)
VALUES(3) used for branches in the zero sequence net-
work (40.0 by default)
VALUES(4) used for machines in the zero sequence net-
work (80.0 by default)
Integer INARG fault specification option (input; 0 by default).
INARG = 0 fault specifications specified in input file.
INARG > 0 fault specifications specified in calling se-
quence.
Integer BUSARY (INARG) a list of faulted buses; ignored if INARG is 0 (if INARG > 0) (input; no
default allowed).
Real VLTARY (INARG) a list of maximum operating voltages in pu; ignored if INARG is 0 (in-
put; 1.0).
Real CPTARY (INARG) a list of contact parting times in seconds; ignored if INARG is 0 (input;
1 cycle).
Character*260 FILARG filename of ANSI Fault Specification Data File; ignored if INARG > 0 (if
INARG is 0) (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 INARG value
IERR = 4 fault analysis is invalid due to the presence of
in-service induction machines that are in the
"stalled" or "tripped" state
IERR = 5 bus type code and series element status in-
consistencies
IERR = 6 error opening file FILARG
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
1202
Fault Analysis ANSI_2
4.1.2. ANSI_2
This API routine is obsolete. It has been replaced by the API routine ansi_3 .
This API routine executes the second release of the ANSI fault calculation function. Use this API routine to
calculate fault currents according to the ANSI standard (activity ANSI). To designate fault specification da-
ta as part of the API's calling sequence, INARG must be positive; to designate fault specification data in an
ANSI Fault Specification Data input file, INARG must be zero and the filename specified as FILARG.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_ANSI_2 OPTIONS(1)..OPTIONS(5) VALUES(1)..VALUES(4)
INARG BUSARY(1)..BUSARY(INARG) VLTARY(1)..VLTARY(INARG)
CPTARY(1)..CPTARY(INARG) FILARG
Python command syntax:
ierr = ansi_2(options, values, inarg, busary, vltary, cptary, filarg)
Fortran command syntax:
CALL ANSI_2(OPTIONS,VALUES,INARG,BUSARY,VLTARY,CPTARY,FILARG,IERR)
Where:
Integer OPTIONS (5) array of 5 elements specifying solution and reporting options(input).
OPTIONS(1) fault analysis generator reactance option (0
by default)
OPTIONS(1) = 0 use subtransient reactance
OPTIONS(1) = 1 use transient reactance
OPTIONS(1) = 2 use synchronous reactance
OPTIONS(2) transformer impedance correction option (1
by default)
OPTIONS(2) = 0 do not apply to zero sequence
OPTIONS(2) = 1 apply to zero sequence
OPTIONS(3) set of ANSI decrement factors to use (1 by
default)
OPTIONS(3) = 0 account for dc decrement only (use ANSI ta-
ble 3)
OPTIONS(3) = 1 account for ac and dc decrements (use ANSI
tables 1 and 2)
OPTIONS(4) option (0 by default)
OPTIONS(4) = 0 summary output using ANSI X only, report
format (blank delimited output fields)
OPTIONS(4) = 1 summary output using ANSI X only, spread-
sheet input format (comma delimited output
fields)
OPTIONS(4) = 2 detailed output using ANSI X only
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1203
Fault Analysis ANSI_2
OPTIONS(4) = 3 detailed output using ANSI R and X
OPTIONS(4) = 4 summary output using ANSI R and X, report
format (blank delimited output fields)
OPTIONS(4) = 5 summary output using ANSI R and X, spread-
sheet input format (comma delimited output
fields)
OPTIONS(5) breaker rating option (0 by default)
OPTIONS(5) = 0 IEEE total current basis
OPTIONS(5) = 1 IEEE symmetrical current basis
Real VALUES (4) array of 4 elements specifying divisors for calculating resistances
of network elements where resistance is zero in the working
case(input).
VALUES(1) used for branches in the positive sequence
network (40.0 by default)
VALUES(2) used for machines in the positive sequence
network (80.0 by default)
VALUES(3) used for branches in the zero sequence net-
work (40.0 by default)
VALUES(4) used for machines in the zero sequence net-
work (80.0 by default)
Integer INARG fault specification option (input; 0 by default).
INARG = 0 fault specifications specified in input file.
INARG > 0 fault specifications specified in calling se-
quence.
Integer BUSARY (INARG) a list of faulted buses; ignored if INARG is 0 (if INARG > 0) (input; no
default allowed).
Real VLTARY (INARG) a list of maximum operating voltages in pu; ignored if INARG is 0 (in-
put; 1.0).
Real CPTARY (INARG) a list of contact parting times in seconds; ignored if INARG is 0 (input;
1 cycle).
Character*260 FILARG filename of ANSI Fault Specification Data File; ignored if INARG > 0 (if
INARG is 0) (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 INARG value
IERR = 4 fault analysis is invalid due to the presence of
in-service induction machines that are in the
"stalled" or "tripped" state
IERR = 5 bus type code and series element status in-
consistencies
IERR = 6 error opening file FILARG
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
1204
Fault Analysis ANSI_3
4.1.3. ANSI_3
This API routine executes the third release of the ANSI fault calculation function. Use this API routine to cal-
culate fault currents according to the ANSI standard (activity ANSI). To designate fault specification data as
part of the API's calling sequence, INARG must be positive; to designate fault specification data in an ANSI
Fault Specification Data input file, INARG must be zero and the filename specified as FILARG.
This API routine was first introduced in release 34.2.0.
Batch command syntax:
BAT_ANSI_3 OPTIONS(1)..OPTIONS(5) VALUES(1)..VALUES(4)
INARG BUSARY(1)..BUSARY(INARG) NODARY(1)..NODARY(INARG)
VLTARY(1)..VLTARY(INARG) CPTARY(1)..CPTARY(INARG) FILARG
Python command syntax:
ierr = ansi_3(options, values, inarg, busary, nodary, vltary, cptary,
filarg)
Fortran command syntax:
CALL ANSI_3(OPTIONS,VALUES,INARG,BUSARY,NODARY,VLTARY,CPTARY,FILARG,IERR)
Where:
Integer OPTIONS (5) array of 5 elements specifying solution and reporting options(input).
OPTIONS(1) fault analysis generator reactance option (0
by default)
OPTIONS(1) = 0 use subtransient reactance
OPTIONS(1) = 1 use transient reactance
OPTIONS(1) = 2 use synchronous reactance
OPTIONS(2) transformer impedance correction option (1
by default)
OPTIONS(2) = 0 do not apply to zero sequence
OPTIONS(2) = 1 apply to zero sequence
OPTIONS(3) set of ANSI decrement factors to use (1 by
default)
OPTIONS(3) = 0 account for dc decrement only (use ANSI ta-
ble 3)
OPTIONS(3) = 1 account for ac and dc decrements (use ANSI
tables 1 and 2)
OPTIONS(4) option (0 by default)
OPTIONS(4) = 0 summary output using ANSI X only, report
format (blank delimited output fields)
OPTIONS(4) = 1 summary output using ANSI X only, spread-
sheet input format (comma delimited output
fields)
OPTIONS(4) = 2 detailed output using ANSI X only
OPTIONS(4) = 3 detailed output using ANSI R and X
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1205
Fault Analysis ANSI_3
OPTIONS(4) = 4 summary output using ANSI R and X, report
format (blank delimited output fields)
OPTIONS(4) = 5 summary output using ANSI R and X, spread-
sheet input format (comma delimited output
fields)
OPTIONS(5) breaker rating option (0 by default)
OPTIONS(5) = 0 IEEE total current basis
OPTIONS(5) = 1 IEEE symmetrical current basis
Real VALUES (4) array of 4 elements specifying divisors for calculating resistances
of network elements where resistance is zero in the working
case(input).
VALUES(1) used for branches in the positive sequence
network (40.0 by default)
VALUES(2) used for machines in the positive sequence
network (80.0 by default)
VALUES(3) used for branches in the zero sequence net-
work (40.0 by default)
VALUES(4) used for machines in the zero sequence net-
work (80.0 by default)
Integer INARG fault specification option (input; 0 by default).
INARG = 0 fault specifications specified in input file.
INARG > 0 fault specifications specified in calling se-
quence.
Integer BUSARY (INARG) a list of faulted buses; ignored if INARG is 0 (if INARG > 0) (input; no
default allowed).
Integer NODARY (INARG) a list of node numbers whose bus sections are to be faulted; ignored
if INARG is 0 (if INARG > 0) (input; 0 by default).
Real VLTARY (INARG) a list of maximum operating voltages in pu; ignored if INARG is 0 (in-
put; 1.0).
Real CPTARY (INARG) a list of contact parting times in seconds; ignored if INARG is 0 (input;
1 cycle).
Character*260 FILARG filename of ANSI Fault Specification Data File; ignored if INARG > 0 (if
INARG is 0) (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 INARG value
IERR = 4 fault analysis is invalid due to the presence of
in-service induction machines that are in the
"stalled" or "tripped" state
IERR = 5 bus type code and series element status in-
consistencies
IERR = 6 error opening file FILARG
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1206
Fault Analysis ANSI_3
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
1207
Fault Analysis ASCC
4.1.4. ASCC
This API routine is obsolete. It has been replaced by the API routine ASCC_1A .
This API is used to apply a series of faults at various locations in the working case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ASCC SID ALL STATUS(1)..STATUS(10) RELFILE FCDFILE
Python command syntax:
ierr = ascc(sid, all, status, relfile, fcdfile)
Fortran command syntax:
CALL ASCCNW(SID, ALL, STATUS, RELFILE, FCDFILE, 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 (10) array of 10 elements specifying integer options(input).
STATUS(1) Three phase and line-to-ground fault (alias is
flt3phlg) (0 by default)
STATUS(1) = 0 three phase faults only
STATUS(1) = 1 three phase and line-to-ground faults
STATUS(2) line-out faults (alias is linout) (0 by default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (alias is linend) (0 by default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) flat conditions option (alias is flatop) (0 by
default)
STATUS(4) = 0 pre-fault conditions taken from working case
STATUS(4) = 1 impose flat conditions as pre-fault condition
STATUS(5) double-precision fault calculation option
(alias is nouse1) (ignored, but must be speci-
fied as 0 or 1; 0 by default; double precision
always used)
STATUS(6) report option (alias is rptop) (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1208
Fault Analysis ASCC
STATUS(6) = 1 full output at home bus and N levels away
STATUS(6) = 2 full output at home bus, summary N levels
away
STATUS(6) = 3 fault current summary table
STATUS(7) number of levels back for contributions if
STATUS(6) = 1 or 2. STATUS(7) > 0 (alias is
rptlvl) (0 by default)
STATUS(8) branch quantity code for line to ground
faults (alias is brnop) (0 by default)
STATUS(8) = 0 A phase
STATUS(8) = 1 3 * IO
STATUS(8) = 2 both
STATUS(9) dc line and FACTS device option (alias is
dcload) (0 by default)
STATUS(9) = 0 blocked
STATUS(9) = 1 represent as load
STATUS(10) transformer impedance correction option
(alias is zcorec) (1 by default)
STATUS(10) = 0 do not apply to zero sequence
STATUS(10) = 1 apply to zero sequence
Character*260 RELFILE Relay Data (.rel) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) 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
1209
Fault Analysis ASCC_1A
4.1.5. ASCC_1A
This API routine is obsolete. It has been replaced by the API routine ASCC_2 .
This API is used to apply a series of faults at various locations in the working case.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_ASCC_1A SID ALL STATUS(1)..STATUS(10) RELFILE FCDFILE
Python command syntax:
ierr = ascc_1a(sid, all, status, relfile, fcdfile)
Fortran command syntax:
CALL ASCC_1A(SID, ALL, STATUS, RELFILE, FCDFILE, 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 (10) array of 10 elements specifying integer options(input).
STATUS(1) Three phase and line-to-ground fault (alias is
flt3phlg) (0 by default)
STATUS(1) = 0 three phase faults only
STATUS(1) = 1 three phase and line-to-ground faults
STATUS(2) line-out faults (alias is linout) (0 by default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (alias is linend) (0 by default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) flat conditions option (alias is flatop) (0 by
default)
STATUS(4) = 0 pre-fault conditions taken from working case
STATUS(4) = 1 impose flat conditions as pre-fault condition
STATUS(5) fault analysis generator reactance op-
tion; ignored if generators are already
"converted" (alias is genxop) (0 by default)
STATUS(5) = 0 use subtransient reactance
STATUS(5) = 1 use transient reactance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1210
Fault Analysis ASCC_1A
STATUS(5) = 2 use synchronous reactance
STATUS(6) option (alias is rptop) (1 by default)
STATUS(6) = 1 full output at home bus and N levels away
STATUS(6) = 2 full output at home bus, summary N levels
away
STATUS(6) = 3 fault current summary table
STATUS(7) number of levels back for contributions if
STATUS(6) = 1 or 2. STATUS(7) > 0 (alias is
rptlvl) (0 by default)
STATUS(8) branch quantity code for line to ground
faults (alias is brnop) (0 by default)
STATUS(8) = 0 A phase
STATUS(8) = 1 3 * IO
STATUS(8) = 2 both
STATUS(9) dc line and FACTS device option (alias is
dcload) (0 by default)
STATUS(9) = 0 blocked
STATUS(9) = 1 represent as load
STATUS(10) transformer impedance correction option
(alias is zcorec) (1 by default)
STATUS(10) = 0 do not apply to zero sequence
STATUS(10) = 1 apply to zero sequence
Character*260 RELFILE Relay Data (.rel) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) file (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 line end fault is invalid; bus table is full
IERR = 5 fault analysis is invalid due to the presence of
in-service induction machines that are in the
"stalled" or "tripped" state
IERR = 6 bus type code and series element status in-
consistencies
IERR = 7 error opening RELFILE
IERR = 8 error opening FCDFILE
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
1211
Fault Analysis ASCC_2
4.1.6. ASCC_2
This API routine is obsolete. It has been replaced by the API routine ASCC_3 .
This API is used to apply a series of faults at various locations in the working case.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_ASCC_2 SID ALL STATUS(1)..STATUS(13) RELFILE FCDFILE SCFILE
Python command syntax:
ierr = ascc_2(sid, all, status, relfile, fcdfile, scfile)
Fortran command syntax:
CALL ASCC2(SID, ALL, STATUS, RELFILE, FCDFILE, SCFILE, 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 selected subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer STATUS (13) array of 13 elements specifying integer options(input).
STATUS(1) line-to-ground faults (alias is fltlg) (0 by de-
fault)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-out faults (alias is linout) (0 by default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (alias is linend) (0 by default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) flat conditions option (alias is flatop) (0 by
default)
STATUS(4) = 0 pre-fault conditions taken from working case
STATUS(4) = 1 impose flat conditions as pre-fault condition
STATUS(5) double-precision fault calculation option
(alias is nouse1) (ignored, but must be speci-
fied as 0 or 1; 0 by default; double precision
always used)
STATUS(6) report option (alias is rptop) (1 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1212
Fault Analysis ASCC_2
STATUS(6) = 1 total fault currents
STATUS(6) = 2 fault contributions to N levels away
STATUS(6) = 3 total fault currents and fault contributions to
N levels away
STATUS(7) number of levels back for contributions (alias
is rptlvl) (0 by default)
STATUS(7) >= 0 used if STATUS(6) = 2 or 3
STATUS(8) branch quantity code (alias is nouse2) (ig-
nored, but must be specified as 0 or 1; 0 by
default)
STATUS(9) dc line and FACTS device option (alias is
dcload) (0 by default)
STATUS(9) = 0 blocked
STATUS(9) = 1 represent as load
STATUS(10) zero sequence transformer impedance cor-
rection option (alias is zcorec) (0 by default)
STATUS(10) = 0 ignore
STATUS(10) = 1 apply
STATUS(11) three phase faults (alias is flt3ph) (0 by de-
fault)
STATUS(11) = 0 omit
STATUS(11) = 1 include
STATUS(12) line-line-to-ground faults (alias is fltllg) (0 by
default)
STATUS(12) = 0 omit
STATUS(12) = 1 include
STATUS(13) line-to-line faults (alias is fltll) (0 by default)
STATUS(13) = 0 omit
STATUS(13) = 1 include
Character*260 RELFILE Relay Data (.rel) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) file (input; blank by default).
Character*260 SCFILE ASCC_2 Results (.sc) file (input; blank by default).
scfile = temporary file created
scfile = nooutput no file created
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1213
Fault Analysis ASCC_3
4.1.7. ASCC_3
This API is used to apply a series of faults at various locations in the working case.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_ASCC_3 SID ALL STATUS(1)..STATUS(17) VALUES(1) RELFILE FCDFILE SCFILE
Python command syntax:
ierr = ascc_3(sid, all, status, values, relfile, fcdfile, scfile)
Fortran command syntax:
CALL ASCC3(SID, ALL, STATUS, VALUES, RELFILE, FCDFILE, SCFILE, 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 selected subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer STATUS (17) array of 17 elements specifying integer options(input).
STATUS(1) line-to-ground faults (alias is fltlg) (0 by de-
fault)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-out faults (alias is linout) (0 by default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (alias is linend) (0 by default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) bus voltage option (alias is voltop) (0 by de-
fault)
STATUS(4) = 0 use bus voltages from power flow solution
STATUS(4) = 1 set all bus voltages at specified value and at
0 deg
STATUS(4) = 2 set faulted bus voltage at specified value and
at 0 deg
STATUS(5) fault analysis generator reactance op-
tion; ignored if generators are already
"converted" (alias is genxop) (0 by default)
STATUS(5) = 0 use subtransient reactance
STATUS(5) = 1 use transient reactance
STATUS(5) = 2 use synchronous reactance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1214
Fault Analysis ASCC_3
STATUS(6) report option (alias is rptop) (1 by default)
STATUS(6) = 0 fault current summary table
STATUS(6) = 1 total fault currents
STATUS(6) = 2 fault contributions to N levels away
STATUS(6) = 3 total fault currents and fault contributions to
N levels away
STATUS(7) number of levels back for contributions (alias
is rptlvl) (0 by default)
STATUS(7) >= 0 used if STATUS(6) = 2 or 3
STATUS(8) transformer tap ratios and phase shift angles
option (alias is tpunty) (0 by default)
STATUS(8) = 0 leave tap ratios and phase shift angles un-
changed
STATUS(8) = 1 set tap ratios to 1.0 pu and phase shift an-
gles to 0
STATUS(8) = 2 set tap ratios to 1.0 pu and phase shift an-
gles unchanged
STATUS(8) = 3 set tap ratios unchanged and phase shift an-
gles to 0
STATUS(9) dc line and FACTS device option (alias is
dcload) (0 by default)
STATUS(9) = 0 blocked
STATUS(9) = 1 represent as load
STATUS(10) zero sequence transformer impedance cor-
rection option (alias is zcorec) (1 by default)
STATUS(10) = 0 ignore
STATUS(10) = 1 apply
STATUS(11) three phase faults (alias is flt3ph) (0 by de-
fault)
STATUS(11) = 0 omit
STATUS(11) = 1 include
STATUS(12) line-line-to-ground faults (alias is fltllg) (0 by
default)
STATUS(12) = 0 omit
STATUS(12) = 1 include
STATUS(13) line-to-line faults (alias is fltll) (0 by default)
STATUS(13) = 0 omit
STATUS(13) = 1 include
STATUS(14) line charging option (alias is lnchrg) (0 by de-
fault)
STATUS(14) = 0 leave unchanged
STATUS(14) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(14) = 2 set to 0.0 in all sequences
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1215
Fault Analysis ASCC_3
STATUS(15) line, fixed and switched shunts, and magne-
tizing admittance option (alias is shntop) (0
by default)
STATUS(15) = 0 leave unchanged
STATUS(15) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(15) = 2 set to 0.0 in all sequences
STATUS(16) load option (alias is loadop) (0 by default)
STATUS(16) = 0 leave unchanged
STATUS(16) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(16) = 2 set to 0.0 in all sequences
STATUS(17) synchronous and asynchronous machines
power option (alias is machpq) (0 by default)
STATUS(17) = 0 use real and reactive power outputs from
power flow solution
STATUS(17) = 1 set real and reactive power outputs to 0.0
Real VALUES (1) array of 1 elements specifying real values(input).
VALUES(1) User specified pu bus voltage value (Used
when STATUS (4) = 1 or 2) (alias is volts)
Character*260 RELFILE Relay Data (.rel) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) file (input; blank by default).
Character*260 SCFILE Results (.sc) file (input; blank by default).
scfile = temporary file created
scfile = nooutput no file created
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 line end fault invalid; bus table is full
IERR = 5 error opening RELFILE
IERR = 6 error opening FCDFILE
IERR = 7 prerequisite requirements for function not
met
IERR = 8 no faults specified
IERR = 9 error opening SCFILE
IERR = 10 SCFILE error
IERR = 11 bus SC results not available
IERR = 12 branch SC results not available
IERR = 13 three winding transformer SC results not
available
IERR = 14 incorrect SCFILE
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1216
Fault Analysis ASCC_3
IERR = 15 SCFILE not allowed
IERR = 16 fault analysis invalid
IERR = 17 invalid VALUES value
IERR = 18 SC result file size exceeded. Define smaller
size bus subsystems and re-run if SCFILE is re-
quired.
IERR = 19 topology error - bus(es) with bus type code
and series element status inconsistencies
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1217
Fault Analysis ASCC_SCFILE
4.1.8. ASCC_SCFILE
This API reads ASCC short circuit results from SCFILE and produces same ASCC output report that was gen-
erated when SCFILE was created. SCFILE is read into PSSE memory to enable displaying ASCC results onto
slider diagrams. For this API to work properly, it is required that working case in PSSE memory should be
the same Saved case that was used when creating the SCFILE.
This API routine was first introduced in release 32.0.2.
Batch command syntax:
BAT_ASCC_SCFILE SCFILE
Python command syntax:
ierr = ascc_scfile(scfile)
Fortran command syntax:
CALL ASCC_SCFILE(SCFILE,IERR)
Where:
Character*260 SCFILE Activity ASCC Results (.sc) file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 7 prerequisite requirements for function not
met
IERR = 9 error opening SCFILE
IERR = 10 SCFILE error
IERR = 11 bus SC results not available
IERR = 12 branch SC results not available
IERR = 13 three winding transformer SC results not
available
IERR = 14 incorrect SCFILE
IERR = 15 SCFILE not allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1218
Fault Analysis BKDY
4.1.9. BKDY
Use this API to calculate and report circuit breaker interrupting duty for 3-phase faults at all buses in a spec-
ified subsystem of the working case (activity BKDY).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_BKDY SID ALL APIOPT LVLBAK FLTTIM BFILE FFILE
Python command syntax:
ierr = bkdy(sid, all, apiopt, lvlbak, flttim, bfile, ffile)
Fortran command syntax:
CALL BKDYNW(SID, ALL, APIOPT, LVLBAK, FLTTIM, BFILE, FFILE, 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 APIOPT mode of operation in the API (input; 1 by default).
APIOPT = 1 fault applications specified in subsystem.
APIOPT = 2 fault applications specified in FFILE.
Integer LVLBAK number of levels back for contributions (input; 0 by default).
LVLBAK < 0 fault currents only.
LVLBAK = 0 fault currents and local contributions.
LVLBAK > 0 fault currents and local contributions, plus
contributions LVLBAK levels back.
Real FLTTIM default fault duty time. FLTTIM >= 0.0 (input; 0.0).
Character*260 BFILE Breaker Duty Data file (input; no default allowed).
Character*260 FFILE Fault Specification Data file (if APIOPT is 2) (input; no default al-
lowed).
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 FLTTIM value
IERR = 5 BFILE is blank
IERR = 6 FFILE is blank
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1219
Fault Analysis BKDY
IERR = 7 generators are not converted
IERR = 8 fixed bus shunt table is full
IERR = 9 error opening BFILE or FFILE
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
1220
Fault Analysis CHECK_SEQUENCE_DATA
4.1.10. CHECK_SEQUENCE_DATA
Use this API routine to perform data checks on the selected categories of sequence 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_SEQUENCE_DATA SID ALL OPT
Python command syntax:
ierr = check_sequence_data(sid, all, opt)
Fortran command syntax:
CALL CHECK_SEQUENCE_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 sequence data category to be checked (input; 0 by default).
OPT = 0 all data categories
OPT = 1 load data
OPT = 2 generator unit data
OPT = 3 induction machine data
OPT = 4 fixed bus shunt data
OPT = 5 switched shunt data
OPT = 6 non-transformer branch data
OPT = 7 two-winding transformer data
OPT = 8 three-winding transformer data
OPT = 9 zero sequence mutual data
OPT = 10 non-conforming source table data
OPT = 11 non-conforming source machine 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 = 5 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1221
Fault Analysis FLAT
4.1.11. FLAT
This API routine is obsolete. It has been replaced by the API routine flat_2 .
Use this API to specify various levels of flat conditions in preparation for fault analysis calculations (activity
FLAT).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_FLAT OPTIONS(1)..OPTIONS(4) VALUES(1) VALUES(2)
Python command syntax:
ierr = flat(options, values)
Fortran command syntax:
CALL FLATAPI(OPTIONS, VALUES, IERR)
Where:
Integer OPTIONS (4) array of 4 elements specifying boundary condition options(input).
OPTIONS(1) flat option (0 by default)
OPTIONS(1) = 0 only change voltages (activity FLAT)
OPTIONS(1) = 1 set classical fault analysis conditions (activity
FLAT,CL)
OPTIONS(1) = 2 set conditions in preparation for IEC standard
909 calculations (activity FLAT,IEC)
OPTIONS(2) tap ratio treatment flag (ignored if OP-
TIONS(1) is 0) (0 by default)
OPTIONS(2) = 0 leave tap ratios unchanged
OPTIONS(2) = 1 set tap ratios to 1.0
OPTIONS(3) charging treatment flag (ignored if OP-
TIONS(1) is 0) (0 by default)
OPTIONS(3) = 0 leave charging unchanged
OPTIONS(3) = 1 set charging to 0.0
OPTIONS(4) shunt treatment flag (ignored if OPTIONS(1)
is 0) (0 by default)
OPTIONS(4) = 0 leave shunts unchanged
OPTIONS(4) = 1 set line shunts to 0.0 in the positive (and
hence negative) sequence, and fixed and
switched shunts to 0.0 in all three sequence
networks
OPTIONS(4) = 2 set line shunts, fixed shunts, and switched
shunts to 0.0 in all sequence networks, and
negative and zero sequence shunt loads to
0.0
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1222
Fault Analysis FLAT
Real VALUES (2) array of 2 elements specifying boundary condition values (ignored
unless OPTIONS(1) is 2)(input).
VALUES(1) voltage magnitude for all buses, or 0.0 to use
present voltage magnitudes (0.0 by default)
VALUES(2) generator power factor, or 0.0 to leave gen-
erator Mvar unchanged (0.0 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES 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
1223
Fault Analysis FLAT_2
4.1.12. FLAT_2
This API routine is the second release of the flat conditions function. Use this API routine to specify various
levels of flat conditions in preparation for fault analysis calculations (activity FLAT)
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_FLAT_2 OPTIONS(1)..OPTIONS(8) VALUES(1) VALUES(2)
Python command syntax:
ierr = flat_2(options, values)
Fortran command syntax:
CALL FLAT_2(OPTIONS, VALUES, IERR)
Where:
Integer OPTIONS (8) array of 8 elements specifying boundary condition options(input).
OPTIONS(1) flat option (0 by default)
OPTIONS(1) = 0 only change voltages (activity FLAT)
OPTIONS(1) = 1 set classical fault analysis conditions (activity
FLAT,CL)
OPTIONS(1) = 2 set conditions in preparation for IEC standard
909 calculations (activity FLAT,IEC)
OPTIONS(2) tap ratio treatment flag (ignored if OP-
TIONS(1) is 0) (0 by default)
OPTIONS(2) = 0 leave tap ratios unchanged
OPTIONS(2) = 1 set tap ratios to 1.0
OPTIONS(3) charging treatment flag (ignored if OP-
TIONS(1) is 0) (0 by default)
OPTIONS(3) = 0 leave charging unchanged
OPTIONS(3) = 1 set charging to 0.0
OPTIONS(4) fixed bus shunt treatment flag (ignored if OP-
TIONS(1) is 0) (0 by default)
OPTIONS(4) = 0 leave fixed bus shunts unchanged
OPTIONS(4) = 1 set fixed bus shunts to 0.0 in the positive
(and hence negative) sequence
OPTIONS(4) = 2 set fixed bus shunts to 0.0 in all sequence
networks
OPTIONS(5) switched shunt treatment flag (ignored if OP-
TIONS(1) is 0) (0 by default)
OPTIONS(5) = 0 leave switched shunts unchanged
OPTIONS(5) = 1 set switched shunts to 0.0 in all sequence
networks
OPTIONS(6) line shunt treatment flag (ignored if OP-
TIONS(1) is 0) (0 by default)
OPTIONS(6) = 0 leave line shunts unchanged
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1224
Fault Analysis FLAT_2
OPTIONS(6) = 1 set line shunts to 0.0 in the positive (and
hence negative) sequence
OPTIONS(6) = 2 set line shunts to 0.0 in all sequence net-
works
OPTIONS(7) transformer magnetizing admittance treat-
ment flag (ignored if OPTIONS(1) is 0) (0 by
default)
OPTIONS(7) = 0 leave transformer magnetizing admittances
unchanged
OPTIONS(7) = 1 set transformer magnetizing admittances to
0.0 in the positive (and hence negative) se-
quence
OPTIONS(8) load treatment flag; this option applies to
the constant power, current, and admittance
load characteristic data (specified on Load
Data records in the Power Flow Raw Data
File), and to the exceptional negative and
zero sequence load data (specified on Load
Data records in the Sequence Data File) (ig-
nored if OPTIONS(1) is 0) (0 by default)
OPTIONS(8) = 0 leave loads unchanged
OPTIONS(8) = 1 set the constant power, current and admit-
tance load to 0.0 in all sequence networks;
model (GNEG + j BNEG) in the negative se-
quence, and (GZERO + j BZERO) in the zero
sequence
OPTIONS(8) = 2 set the constant power, current and admit-
tance load to 0.0 in all sequence networks,
and (GNEG + j BNEG) to 0.0 in the negative
sequence; model (GZERO + j BZERO) in the
zero sequence
OPTIONS(8) = 3 set the constant power, current and admit-
tance load to 0.0 in all sequence networks,
(GNEG + j BNEG) to 0.0 in the negative se-
quence, and (GZERO + j BZERO) to 0.0 in the
zero sequence
Real VALUES (2) array of 2 elements specifying boundary condition values (ignored
unless OPTIONS(1) is 2)(input).
VALUES(1) voltage magnitude for all buses, or 0.0 to use
present voltage magnitudes (0.0 by default)
VALUES(2) generator power factor, or 0.0 to leave gen-
erator Mvar unchanged (0.0 by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 invalid VALUES 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
1225
Fault Analysis FLAT_2
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1226
Fault Analysis IECS
4.1.13. IECS
This API routine is obsolete. It has been replaced by the API routine iecs_2 .
Use this API to apply a series of faults at various locations in the working case to compute short circuit cur-
rents according to IEC 60909 standard.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_IECS SID ALL STATUS(1)..STATUS(8) BRKTIM IECFILE FCDFILE
Python command syntax:
ierr = iecs(sid, all, status, brktim, iecfile, fcdfile)
Fortran command syntax:
CALL IECSAPI(SID, ALL, STATUS, BRKTIM, IECFILE, FCDFILE, 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 integer options(input).
STATUS(1) three phase faults (alias is flt3ph) (0 by de-
fault)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-to-ground faults (alias is fltlg) (0 by de-
fault)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-line-to-ground faults (alias is fltllg) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) line-to-line faults (alias is fltll) (0 by default)
STATUS(4) = 0 omit
STATUS(4) = 1 include
STATUS(5) report option (alias is rptop) (1 by default)
STATUS(5) = 1 total fault currents
STATUS(5) = 2 fault contributions to N levels away
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1227
Fault Analysis IECS
STATUS(5) = 3 total fault currents and fault contributions to
N levels away
STATUS(6) number of levels back for contributions (alias
is rptlvl) (0 by default)
STATUS(6) >= 0 used if STATUS(5) = 2 or 3
STATUS(7) location of fault (alias is fltloc) (0 by default)
STATUS(7) = 1 fault at network bus
STATUS(7) = 2 fault at LV bus of Power Station Unit (PSU)
STATUS(7) = 3 fault at auxiliary transformer (connected to
PSU) LV bus
STATUS(8) report total fault currents in descending or-
der of magnitude (AMPS) (0 by default)
STATUS(8) = 0 do not order
STATUS(8) = 1 descending order
Real BRKTIM breaker contact parting time in seconds (input; 5/BaseFrequency).
Character*260 IECFILE IEC Fault Calculation Data (.iec) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) 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
1228
Fault Analysis IECS_2
4.1.14. IECS_2
This API routine is obsolete. It has been replaced by the API routine iecs_3 .
This API executes the second release of the IEC short circuit calculations function. This API is used to apply
a series of faults at various locations in the working case to compute short circuit currents according to IEC
60909 standard.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_IECS_2 SID ALL STATUS(1)..STATUS(14) BRKTIM IECFILE FCDFILE SCFILE
Python command syntax:
ierr = iecs_2(sid, all, status, brktim, iecfile, fcdfile, scfile)
Fortran command syntax:
CALL IECSAPI2(SID, ALL, STATUS, BRKTIM, IECFILE, FCDFILE, SCFILE, 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 (14) array of 14 elements specifying integer options(input).
STATUS(1) three phase faults (alias is flt3ph) (0 by de-
fault)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-to-ground faults (alias is fltlg) (0 by de-
fault)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-line-to-ground faults (alias is fltllg) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) line-to-line faults (alias is fltll) (0 by default)
STATUS(4) = 0 omit
STATUS(4) = 1 include
STATUS(5) report option (alias is rptop) (1 by default)
STATUS(5) = 1 total fault currents
STATUS(5) = 2 fault contributions to N levels away
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1229
Fault Analysis IECS_2
STATUS(5) = 3 total fault currents and fault contributions to
N levels away
STATUS(6) number of levels back for contributions (alias
is rptlvl) (0 by default)
STATUS(6) >= 0 used if STATUS(5) = 2 or 3
STATUS(7) location of fault (alias is fltloc) (1 by default)
STATUS(7) = 1 fault at network bus
STATUS(7) = 2 fault at LV bus of Power Station Unit (PSU)
STATUS(7) = 3 fault at auxiliary transformer (connected to
PSU) LV bus
STATUS(8) line-out faults (alias is linout) (0 by default)
STATUS(8) = 0 omit
STATUS(8) = 1 include
STATUS(9) line-end faults (alias is linend) (0 by default)
STATUS(9) = 0 omit
STATUS(9) = 1 include
STATUS(10) transformer tap ratios and phase angles op-
tion (alias is tpunty) (0 by default)
STATUS(10) = 0 leave tap ratios and phase angles unchanged
STATUS(10) = 1 set tap ratios 1.0 pu and phase angles to 0.0
deg
STATUS(11) line charging option (alias is lnchrg) (1 by de-
fault)
STATUS(11) = 1 set to 0.0 in positive and negative sequences
STATUS(11) = 2 set to 0.0 in all sequences
STATUS(11) = 3 leave line charging unchanged
STATUS(12) loads, fixed and switched shunts and and
magnetizing admittance option (alias is shn-
top) (1 by default)
STATUS(12) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(12) = 2 set to 0.0 in all sequences
STATUS(12) = 3 leave unchanged
STATUS(13) dc line and FACTS device option (alias is
dcload) (0 by default)
STATUS(13) = 0 blocked
STATUS(13) = 1 represent as load
STATUS(14) zero sequence transformer impedance cor-
rection option (alias is zcorec) (0 by default)
STATUS(14) = 0 ignore
STATUS(14) = 1 apply
Real BRKTIM breaker contact parting time in seconds (input; 5/BaseFrequency).
Character*260 IECFILE IEC Fault Calculation Data (.iec) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) file (input; blank by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1230
Fault Analysis IECS_2
Character*260 SCFILE Results (.sc) file (input; blank by default).
scfile = temporary file created
scfile = nooutput no file created
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1231
Fault Analysis IECS_3
4.1.15. IECS_3
This API routine is obsolete. It has been replaced by the API routine iecs_4 .
This API executes the third release of the IEC short circuit calculations function. This API is used to apply a
series of faults at various locations in the working case to compute short circuit currents according to IEC
60909 standard.
This API routine was first introduced in release 32.0.5.
Batch command syntax:
BAT_IECS_3 SID ALL STATUS(1)..STATUS(15) VALUES(1) VALUES(2) IECFILE
FCDFILE SCFILE
Python command syntax:
ierr = iecs_3(sid, all, status, values, iecfile, fcdfile, scfile)
Fortran command syntax:
CALL IECSAPI3(SID, ALL, STATUS, VALUES, IECFILE, FCDFILE, SCFILE, 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 (15) array of 15 elements specifying integer options(input).
STATUS(1) three phase faults (alias is flt3ph) (0 by de-
fault)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-to-ground faults (alias is fltlg) (0 by de-
fault)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-line-to-ground faults (alias is fltllg) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) line-to-line faults (alias is fltll) (0 by default)
STATUS(4) = 0 omit
STATUS(4) = 1 include
STATUS(5) report option (alias is rptop) (1 by default)
STATUS(5) = 1 total fault currents
STATUS(5) = 2 fault contributions to N levels away
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1232
Fault Analysis IECS_3
STATUS(5) = 3 total fault currents and fault contributions to
N levels away
STATUS(6) number of levels back for contributions (alias
is rptlvl) (0 by default)
STATUS(6) >= 0 used if STATUS(5) = 2 or 3
STATUS(7) location of fault (alias is fltloc) (1 by default)
STATUS(7) = 1 fault at network bus
STATUS(7) = 2 fault at LV bus of Power Station Unit (PSU)
STATUS(7) = 3 fault at auxiliary transformer (connected to
PSU) LV bus
STATUS(8) line-out faults (alias is linout) (0 by default)
STATUS(8) = 0 omit
STATUS(8) = 1 include
STATUS(9) line-end faults (alias is linend) (0 by default)
STATUS(9) = 0 omit
STATUS(9) = 1 include
STATUS(10) transformer tap ratios and phase angles op-
tion (alias is tpunty) (0 by default)
STATUS(10) = 0 leave tap ratios and phase angles unchanged
STATUS(10) = 1 set tap ratios 1.0 pu and phase angles to 0.0
deg
STATUS(11) line charging option (alias is lnchrg) (1 by de-
fault)
STATUS(11) = 1 set to 0.0 in positive and negative sequences
STATUS(11) = 2 set to 0.0 in all sequences
STATUS(11) = 3 leave line charging unchanged
STATUS(12) loads, fixed and switched shunts and and
magnetizing admittance option (alias is shn-
top) (1 by default)
STATUS(12) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(12) = 2 set to 0.0 in all sequences
STATUS(12) = 3 leave unchanged
STATUS(13) dc line and FACTS device option (alias is
dcload) (0 by default)
STATUS(13) = 0 blocked
STATUS(13) = 1 represent as load
STATUS(14) zero sequence transformer impedance cor-
rection option (alias is zcorec) (0 by default)
STATUS(14) = 0 ignore
STATUS(14) = 1 apply
STATUS(15) option for Voltage Factor C (alias is cfactor)
(1 by default)
STATUS(15) = 1 Voltage Factor C for maximum fault currents
(default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1233
Fault Analysis IECS_3
STATUS(15) = 2 Voltage Factor C for minimum fault currents
STATUS(15) = 3 Voltage Factor C as specified by 'vfactorc' val-
ue
Real VALUES (2) array of 2 elements specifying real values(input).
VALUES(1) breaker contact parting time in seconds
(alias is brktim) (5/base Frequency by de-
fault)
VALUES(2) user specified voltage factor c (alias is ucfac-
tor) (1.0 by default) This is used only when
STATUS(15)=3)
Character*260 IECFILE IEC Fault Calculation Data (.iec) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) file (input; blank by default).
Character*260 SCFILE Results (.sc) file (input; blank by default).
scfile = temporary file created
scfile = nooutput no file created
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1234
Fault Analysis IECS_4
4.1.16. IECS_4
This API executes the fourth release of the IEC short circuit calculations function. This API is used to apply
a series of faults at various locations in the working case to compute short circuit currents according to IEC
60909 standard.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_IECS_4 SID ALL STATUS(1)..STATUS(17) VALUES(1) VALUES(2) IECFILE
FCDFILE SCFILE
Python command syntax:
ierr = iecs_4(sid, all, status, values, iecfile, fcdfile, scfile)
Fortran command syntax:
CALL IECSAPI4(SID, ALL, STATUS, VALUES, IECFILE, FCDFILE, SCFILE, 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 (17) array of 17 elements specifying integer options(input).
STATUS(1) three phase faults (alias is flt3ph) (0 by de-
fault)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-to-ground faults (alias is fltlg) (0 by de-
fault)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-line-to-ground faults (alias is fltllg) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) line-to-line faults (alias is fltll) (0 by default)
STATUS(4) = 0 omit
STATUS(4) = 1 include
STATUS(5) report option (alias is rptop) (1 by default)
STATUS(5) = 0 fault current summary table
STATUS(5) = 1 total fault currents
STATUS(5) = 2 fault contributions to N levels away
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1235
Fault Analysis IECS_4
STATUS(5) = 3 total fault currents and fault contributions to
N levels away
STATUS(6) number of levels back for contributions (alias
is rptlvl) (0 by default)
STATUS(6) >= 0 used if STATUS(5) = 2 or 3
STATUS(7) location of fault (alias is fltloc) (0 by default)
STATUS(7) = 0 fault at network bus
STATUS(7) = 1 fault at LV bus of Power Station Unit (PSU)
STATUS(7) = 2 fault at auxiliary transformer (connected to
PSU) LV bus
STATUS(8) line-out faults (alias is linout) (0 by default)
STATUS(8) = 0 omit
STATUS(8) = 1 include
STATUS(9) line-end faults (alias is linend) (0 by default)
STATUS(9) = 0 omit
STATUS(9) = 1 include
STATUS(10) transformer tap ratios and phase shift angles
option (alias is tpunty) (0 by default)
STATUS(10) = 0 leave tap ratios and phase shift angles un-
changed
STATUS(10) = 1 set tap ratios to 1.0 pu and phase shift an-
gles to 0 deg
STATUS(10) = 2 set tap ratios to 1.0 pu and phase shift an-
gles unchanged
STATUS(10) = 3 set tap ratios unchanged and phase shift an-
gles to 0 deg
STATUS(11) line charging option (alias is lnchrg) (1 by de-
fault)
STATUS(11) = 0 leave unchanged
STATUS(11) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(11) = 2 set to 0.0 in all sequences
STATUS(12) line, fixed and switched shunts, and magne-
tizing admittance option (alias is shntop) (1
by default)
STATUS(12) = 0 leave unchanged
STATUS(12) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(12) = 2 set to 0.0 in all sequences
STATUS(13) dc line and FACTS device option (alias is
dcload) (0 by default)
STATUS(13) = 0 blocked
STATUS(13) = 1 represent as load
STATUS(14) zero sequence transformer impedance cor-
rection option (alias is zcorec) (0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1236
Fault Analysis IECS_4
STATUS(14) = 0 ignore
STATUS(14) = 1 apply
STATUS(15) option for Voltage Factor C (alias is cfactor)
(0 by default)
STATUS(15) = 0 Voltage Factor C for maximum fault currents
STATUS(15) = 1 Voltage Factor C for minimum fault currents
STATUS(15) = 2 Voltage Factor C as specified by 'vfactorc' val-
ue for maximum fault current calculations
STATUS(15) = 3 Voltage Factor C as specified by 'vfactorc' val-
ue for minimum fault current calculations
STATUS(16) load option (alias is loadop) (1 by default)
STATUS(16) = 0 leave unchanged
STATUS(16) = 1 set to 0.0 in the positive and negative se-
quences
STATUS(16) = 2 set to 0.0 in all sequences
STATUS(17) fault analysis generator reactance op-
tion; ignored if generators are already
"converted" (alias is genxop) (0 by default)
STATUS(17) = 0 use subtransient reactance
STATUS(17) = 1 use transient reactance
STATUS(17) = 2 use synchronous reactance
Real VALUES (2) array of 2 elements specifying real values(input).
VALUES(1) breaker contact parting time in seconds
(alias is brktim) (5/base Frequency by de-
fault)
VALUES(2) user specified voltage factor c (alias is ucfac-
tor) (1.0 by default) This is used only when
STATUS(15)=2)
Character*260 IECFILE IEC Fault Calculation Data (.iec) file (input; blank by default).
Character*260 FCDFILE Fault Control (.fcd) file (input; blank by default).
Character*260 SCFILE Results (.sc) file (input; blank by default).
scfile = temporary file created
scfile = nooutput no file created
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 no faults specified
IERR = 6 error opening IECFILE
IERR = 7 error opening FCDFILE
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
1237
Fault Analysis IECS_4
IERR = 9 error opening SCFILE
IERR = 10 SCFILE error
IERR = 11 bus SC results not available
IERR = 12 branch SC results not available
IERR = 13 three winding transformer SC results not
available
IERR = 14 incorrect SCFILE
IERR = 15 SCFILE not allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1238
Fault Analysis IECS_SCFILE
4.1.17. IECS_SCFILE
This API reads IECS short circuit results from SCFILE and produces same IECS output report that was gener-
ated when SCFILE was created. SCFILE is read into PSSE memory to enable displaying IECS results onto slid-
er diagrams. For this API to work properly, it is required that working case in PSSE memory should be the
same Saved case that was used when creating the SCFILE.
This API routine was first introduced in release 32.0.3.
Batch command syntax:
BAT_IECS_SCFILE SCFILE
Python command syntax:
ierr = iecs_scfile(scfile)
Fortran command syntax:
CALL IECS_SCFILE(SCFILE,IERR)
Where:
Character*260 SCFILE IEC Results (.sc) file (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 7 prerequisite requirements for function not
met
IERR = 9 error opening SCFILE
IERR = 10 SCFILE error
IERR = 11 bus SC results not available
IERR = 12 branch SC results not available
IERR = 13 three winding transformer SC results not
available
IERR = 14 incorrect SCFILE
IERR = 15 SCFILE not allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1239
Fault Analysis NEWSEQ
4.1.18. NEWSEQ
Use this API to initialize the fault analysis data arrays, set them to default values, and set the flag indicating
that sequence data is present in the working case.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_NEWSEQ
Python command syntax:
ierr = newseq()
Fortran command syntax:
CALL NEWSEQ(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
1240
Fault Analysis SCEQ
4.1.19. SCEQ
Use this API to construct network equivalents of the positive and zero sequence networks and calculates
source impedances at equivalent source nodes for all three sequences in preparation for the unbalanced
fault analysis activities of PSSE.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SCEQ SID ALL STATUS THRESH RFILE SFILE
Python command syntax:
ierr = sceq(sid, all, status, thresh, rfile, sfile)
Fortran command syntax:
CALL SCEQNW(SID, ALL, STATUS, THRESH, RFILE, SFILE, 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 transformer impedance correction option (input; 1 by default).
STATUS = 0 do not apply to zero sequence
STATUS = 1 apply to zero sequence
Real THRESH equivalent branch threshold tolerance (input; 10.0).
Character*260 RFILE power flow raw data file; blank for none (input; blank by default).
Character*260 SFILE sequence data 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 case is not subject to classical assumptions
IERR = 5 generators are not converted
IERR = 6 error writing the working case to a temporary
file
IERR = 7 no buses being retained
IERR = 8 no buses being processed for equivalence
IERR = 9 too many branches in the equivalent
IERR = 10 bus type codes other than 1, 2, 4, 5 and 6
present
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1241
Fault Analysis SCEQ
IERR = 11 substations present in subsystem to be equiv-
alenced
IERR = 12 error opening RFILE or SFILE
IERR = 13 error opening temporary file
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
1242
Fault Analysis SCGR
4.1.20. SCGR
This API routine is obsolete. It has been replaced by the API routine ascc_2 .
This API no longer performs any action. Usage in previous releases described below.
Use this API routine to calculate three phase and line-to-ground fault solutions. Results may be program-
matically accessed via the internally accessible fetch routines SCGTXT, SCGBUS, SCGBRN, and SCG3WN.
Usage is:
- invoke SCGR API with APIOPT = 0;
- multiple calls to fetch routines;
- optionally, repeat of above steps for different fault and/or different pre-fault conditions;
- final invocation of SCGR API with APIOPT = 1.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SCGR SID ALL APIOPT STATUS(1)..STATUS(8)
Python command syntax:
ierr = scgr(sid, all, apiopt, status)
Fortran command syntax:
CALL SCGRAPI(SID, ALL, APIOPT, 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 = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer APIOPT mode of operation of SCGRAPI (input; 0 by default).
APIOPT = 0 apply fault calculations and fill arrays used by
fetch routines
APIOPT = 1 deallocate arrays used by fetch routines
Integer STATUS (8) array of 8 elements specifying fault and options(input).
STATUS(1) fault type (0 by default)
STATUS(1) = 0 three-phase
STATUS(1) = 1 line-to-ground
STATUS(2) L-G fault (ignored if STATUS(1) is 0) (0 by de-
fault)
STATUS(2) = 0 A phase
STATUS(2) = 1 3 * I0
STATUS(3) fault location (0 by default)
STATUS(3) = 0 all buses in subsystem
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1243
Fault Analysis SCGR
STATUS(3) > 0 bus number of the subsystem bus to be fault-
ed
STATUS(4) flat conditions option (0 by default)
STATUS(4) = 0 working case conditions
STATUS(4) = 1 flat conditions
STATUS(5) double-precision fault calculation option (ig-
nored, but must be specified as 0 or 1; 0 by
default; double precision always used)
STATUS(6) dc line and FACTS device option (ignored if
STATUS(4) is 1) (0 by default)
STATUS(6) = 0 block
STATUS(6) = 1 represent as load
STATUS(7) transformer impedance correction option (ig-
nored if STATUS(1) is 0 or STATUS(4) is 1 (1
by default)
STATUS(7) = 0 do not apply to zero sequence
STATUS(7) = 1 apply to zero sequence
STATUS(8) branch results option (0 by default)
STATUS(8) = 0 currents
STATUS(8) = 1 apparent impedances
Integer IERR error code (output).
IERR = 1 SCGR is obsolete; use "Fault>Automatic se-
quencing fault calculation (ASCC).." (API rou-
tine ASCC_2)
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
1244
Fault Analysis SCMU
4.1.21. SCMU
This API routine is obsolete. It has been replaced by the API routine scmu_2 .
Use this API to calculate simultaneous unbalances. It must be called once with APIOPT set to 1, once for
each of the simultaneous faults to be applied with APIOPT set to 2, and once with APIOPT set to 3.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SCMU APIOPT OPTIONS(1)..OPTIONS(7) RVAL(1)..RVAL(5) CKTARG
Python command syntax:
ierr = scmu(apiopt, options, rval, cktarg)
Fortran command syntax:
CALL SCMUAPI(APIOPT, OPTIONS, RVAL, CKTARG, IERR)
Where:
Integer APIOPT mode of operation (input; no default allowed).
APIOPT = 1 Initialize; automatically runs activity SEQD if
the sequence network setup option setting is
enabled.
APIOPT = 2 Specify an unbalance to be applied; must be
called once for each simultaneous unbalance
to be imposed.
APIOPT = 3 Solve in the presence of the specified unbal-
ances and terminate.
APIOPT = 4 Remove specified unbalances (cancels any
unbalances specified by any preceding
APIOPT 2 references, and leaves memory as
it is immediately following an APIOPT 1 refer-
ence).
Integer OPTIONS (7) array of 7 elements specifying options and input values to be used
in the current calculation phase. It is ignored when APIOPT is 3 or 4.
When APIOPT is 1, OPTIONS(1), OPTIONS(2) and OPTIONS(3) define
options to be used in the construction of the sequence admittance
matrices. These values are used only when the sequence network
setup option is enabled, and activity SEQD is to be automatically exe-
cuted.(input).
OPTIONS(1) Specify it per additional conditions as below.
When APIOPT=1, dc line and FACTS device option, 0 by default.
OPTIONS(1) = 0 Block and ignore
OPTIONS(1) = 1 Convert to constant admittance load
When APIOPT=2, define the type of unbalance to be applied, no
default allowed
OPTIONS(1) = 1 First line-to-ground fault
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1245
Fault Analysis SCMU
OPTIONS(1) = 2 Second line-to-ground fault
OPTIONS(1) = 3 First line-to-line or line-to-line-to-ground
fault
OPTIONS(1) = 4 Second line-to-line or line-to-line-to-ground
fault
OPTIONS(1) = 5 One phase closed
OPTIONS(1) = 6 Two phases closed
OPTIONS(1) = 7 Three-phase fault (uses fault types 2 and 4)
OPTIONS(1) = 8 Branch unbalance with one end opened
OPTIONS(1) = 9 Branch unbalance with both ends closed
OPTIONS(2) Specify it per additional conditions as below.
When APIOPT=1, transformer impedance correction option, 1
by default.
OPTIONS(2) = 0 Do not apply to zero sequence
OPTIONS(2) = 1 Apply to zero sequence
When APIOPT=2 and OPTIONS(1)=1 or 2 (LG), no default al-
lowed.
OPTIONS(2) = None Bus to be faulted
When APIOPT=2 and OPTIONS(1)=3 or 4 (LLG), no default al-
lowed.
OPTIONS(2) = None Bus to be faulted
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), no default
allowed.
OPTIONS(2) = None One of the buses to be connected by the
phase closed unbalance
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), no de-
fault allowed.
OPTIONS(2) = None One of the buses to be connected by the
phase closed unbalance
When APIOPT=2 and OPTIONS(1)=7 (3PH), no default allowed.
OPTIONS(2) = None Bus to be faulted
When APIOPT=2 and OPTIONS(1)=8 (one end open), no default
allowed.
OPTIONS(2) = None One of the buses connected by the branch
to be faulted
When APIOPT=2 and OPTIONS(1)=9 (both ends closed), no de-
fault allowed.
OPTIONS(2) = None One of the buses connected by the branch
to be faulted
OPTIONS(3) Specify it per additional conditions as below.
When APIOPT=1, fault analysis generator reactance option, ig-
nored if generators are already "converted", 0 by default.
OPTIONS(3) = 0 Use subtransient reactance
OPTIONS(3) = 1 Use transient reactance
OPTIONS(3) = 2 Use synchronous reactance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1246
Fault Analysis SCMU
When APIOPT=2 and OPTIONS(1)=1 or 2 (LG), faulted phase, 1
by default.
OPTIONS(3) = 1 Phase A
OPTIONS(3) = 2 Phase B
OPTIONS(3) = 3 Phase C
When APIOPT=2 and OPTIONS(1)=3 or 4 (LLG), excluded phase,
1 by default.
OPTIONS(3) = 1 Phase A
OPTIONS(3) = 2 Phase B
OPTIONS(3) = 3 Phase C
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), no default
allowed.
OPTIONS(3) = None The other bus to be connected by the phase
closed unbalance
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), no de-
fault allowed.
OPTIONS(3) = None The other bus to be connected by the phase
closed unbalance
When APIOPT=2 and OPTIONS(1)=8 (one end open), no default
allowed.
OPTIONS(3) = None Another bus connected by the branch to be
faulted
When APIOPT=2 and OPTIONS(1)=9 (both ends closed), no de-
fault allowed.
OPTIONS(3) = None The other bus connected by the branch to
be faulted
OPTIONS(4) Specify it per additional conditions as below.
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), phase to
be closed, 1 by default.
OPTIONS(4) = 1 Phase A
OPTIONS(4) = 2 Phase B
OPTIONS(4) = 3 Phase C
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), excluded
phase, 1 by default.
OPTIONS(4) = 1 Phase A
OPTIONS(4) = 2 Phase B
OPTIONS(4) = 3 Phase C
When APIOPT=2 and OPTIONS(1)=8 (one end open), 0 by de-
fault.
OPTIONS(4) = None Third bus connected by the three-winding
transformer to be faulted, or zero for a two
terminal branch
When APIOPT=2 and OPTIONS(1)=9 (both ends closed), type of
in-line fault to be applied (1 by default).
OPTIONS(4) = 1 Line-to-ground
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1247
Fault Analysis SCMU
OPTIONS(4) = 2 Line-to-line or line-to-line-to-ground fault
OPTIONS(4) = 3 Three-phase
OPTIONS(5) Specify it per additional conditions as below.
When APIOPT=2 and OPTIONS(1)=8 (one end open), type of in-
line fault to be applied (1 by default).
OPTIONS(5) = 1 Line-to-ground
OPTIONS(5) = 2 Line-to-line or line-to-line-to-ground fault
OPTIONS(5) = 3 Three-phase
When APIOPT=2, OPTIONS(1)=9 (both ends closed) and OP-
TIONS(4)=1, faulted phase (1 by default).
OPTIONS(5) = 1 Phase A
OPTIONS(5) = 2 Phase B
OPTIONS(5) = 3 Phase C
When APIOPT=2, OPTIONS(1)=9 (both ends closed) and OP-
TIONS(4)=2, excluded phase (1 by default).
OPTIONS(5) = 1 Phase A
OPTIONS(5) = 2 Phase B
OPTIONS(5) = 3 Phase C
OPTIONS(6) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=8 (one end open) and OP-
TIONS(5)=1, faulted phase (1 by default).
OPTIONS(6) = 1 Phase A
OPTIONS(6) = 2 Phase B
OPTIONS(6) = 3 Phase C
When APIOPT=2, OPTIONS(1)=8 (one end open) and OP-
TIONS(5)=2, excluded phase (1 by default).
OPTIONS(6) = 1 Phase A
OPTIONS(6) = 2 Phase B
OPTIONS(6) = 3 Phase C
OPTIONS(7) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(2) by
default.
OPTIONS(7) = None Opened end bus (must be identical to one of
OPTIONS(2), OPTIONS(3), or, if it is non-ze-
ro, OPTIONS(4))
Real RVAL (5) array of 5 elements specifying input values used to define the current
fault; ignored except when APIOPT is 2. The elements of RVAL are de-
pendent on the value specified for OPTIONS(1).(input).
RVAL(1) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=1 or 2 (LG), 0.0 by default.
RVAL(1) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1248
Fault Analysis SCMU
RVAL(1) = None Resistance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=5 (1 phase closed), 0.0 by de-
fault.
RVAL(1) = None Resistance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=6 (2 phases closed), 0.0 by de-
fault.
RVAL(1) = None Resistance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=1,
0.0 by default.
RVAL(1) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(1) = None Resistance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=1, 0.0 by default.
RVAL(1) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(1) = None Resistance of the complex L-L fault imped-
ance in pu
RVAL(2) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=1 or 2 (LG), 0.0 by default.
RVAL(2) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
RVAL(2) = None Reactance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=5 (1 phase closed), 0.0 by de-
fault.
RVAL(2) = None Reactance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=6 (2 phases closed), 0.0 by de-
fault.
RVAL(2) = None Reactance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=1,
0.0 by default.
RVAL(2) = None Reactance of the complex L-G fault imped-
ance in pu
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1249
Fault Analysis SCMU
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(2) = None Reactance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=1, 0.0 by default.
RVAL(2) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(2) = None Reactance of the complex L-L fault imped-
ance in pu
RVAL(3) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
RVAL(3) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(3) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(3) = None Resistance of the complex L-G fault imped-
ance in pu
RVAL(4) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
RVAL(4) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(4) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(4) = None Reactance of the complex L-G fault imped-
ance in pu
RVAL(5) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=8 (one end open), 1.0 by default.
RVAL(5) = None fault location from closed end bus in pu of
total line length; must be 1.0 if the branch is
a transformer
When APIOPT=2, OPTIONS(1)=9 (both ends closed), 0.5 by de-
fault.
RVAL(5) = None fault location from bus OPTIONS(2) in pu of
total line length
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1250
Fault Analysis SCMU
Character*2 CKTARG circuit identifier of branch to be faulted; ignored except when APIOPT
is 2 and OPTIONS(1) is 8 or 9 (input; '1' by default).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1251
Fault Analysis SCMU_2
4.1.22. SCMU_2
Use this API to calculate simultaneous unbalances. It must be called once with APIOPT set to 1, once for
each of the simultaneous faults to be applied with APIOPT set to 2, and once with APIOPT set to 3.
This API routine was first introduced in release 34.1.0.
Batch command syntax:
BAT_SCMU_2 APIOPT OPTIONS(1)..OPTIONS(7) RVAL(1)..RVAL(5) CKTARG
Python command syntax:
ierr = scmu_2(apiopt, options, rval, cktarg)
Fortran command syntax:
CALL SCMU_2(APIOPT, OPTIONS, RVAL, CKTARG, IERR)
Where:
Integer APIOPT mode of operation (input; no default allowed).
APIOPT = 1 Initialize; automatically runs activity SEQD if
the sequence network setup option setting is
enabled.
APIOPT = 2 Specify an unbalance to be applied; must be
called once for each simultaneous unbalance
to be imposed.
APIOPT = 3 Solve in the presence of the specified unbal-
ances and terminate.
APIOPT = 4 Remove specified unbalances (cancels any
unbalances specified by any preceding
APIOPT 2 references, and leaves memory as
it is immediately following an APIOPT 1 refer-
ence).
Integer OPTIONS (7) array of 7 elements specifying options and input values to be used
in the current calculation phase. It is ignored when APIOPT is 3 or 4.
When APIOPT is 1, OPTIONS(1), OPTIONS(2) and OPTIONS(3) define
options to be used in the construction of the sequence admittance
matrices. These values are used only when the sequence network
setup option is enabled, and activity SEQD is to be automatically exe-
cuted.(input).
OPTIONS(1) Specify it per additional conditions as below.
When APIOPT=1, dc line and FACTS device option, 0 by default.
OPTIONS(1) = 0 Block and ignore
OPTIONS(1) = 1 Convert to constant admittance load
When APIOPT=2, define the type of unbalance to be applied, no
default allowed
OPTIONS(1) = 1 First line-to-ground fault
OPTIONS(1) = 2 Second line-to-ground fault
OPTIONS(1) = 3 First line-to-line or line-to-line-to-ground
fault
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1252
Fault Analysis SCMU_2
OPTIONS(1) = 4 Second line-to-line or line-to-line-to-ground
fault
OPTIONS(1) = 5 One phase closed
OPTIONS(1) = 6 Two phases closed
OPTIONS(1) = 7 Three-phase fault (uses fault types 2 and 4)
OPTIONS(1) = 8 Branch unbalance with one end opened
OPTIONS(1) = 9 Branch unbalance with both ends closed
OPTIONS(2) Specify it per additional conditions as below.
When APIOPT=1, transformer impedance correction option, 1
by default.
OPTIONS(2) = 0 Do not apply to zero sequence
OPTIONS(2) = 1 Apply to zero sequence
When APIOPT=2 and OPTIONS(1)=1 or 2 (LG), no default al-
lowed.
OPTIONS(2) = None Bus to be faulted
When APIOPT=2 and OPTIONS(1)=3 or 4 (LLG), no default al-
lowed.
OPTIONS(2) = None Bus to be faulted
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), no default
allowed.
OPTIONS(2) = None One of the buses to be connected by the
phase closed unbalance
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), no de-
fault allowed.
OPTIONS(2) = None One of the buses to be connected by the
phase closed unbalance
When APIOPT=2 and OPTIONS(1)=7 (3PH), no default allowed.
OPTIONS(2) = None Bus to be faulted
When APIOPT=2 and OPTIONS(1)=8 (one end open), no default
allowed.
OPTIONS(2) = None One of the buses connected by the branch
to be faulted
When APIOPT=2 and OPTIONS(1)=9 (both ends closed), no de-
fault allowed.
OPTIONS(2) = None One of the buses connected by the branch
to be faulted
OPTIONS(3) Specify it per additional conditions as below.
When APIOPT=1, fault analysis generator reactance option, ig-
nored if generators are already "converted", 0 by default.
OPTIONS(3) = 0 Use subtransient reactance
OPTIONS(3) = 1 Use transient reactance
OPTIONS(3) = 2 Use synchronous reactance
When APIOPT=2 and OPTIONS(1)=1 or 2 (LG), 0 by default.
OPTIONS(3) = None Number of node whose bus section is to be
faulted
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1253
Fault Analysis SCMU_2
When APIOPT=2 and OPTIONS(1)=3 or 4 (LLG), 0 by default.
OPTIONS(3) = None Number of node whose bus section is to be
faulted
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), 0 by de-
fault.
OPTIONS(3) = None Number of node whose bus section is to be
connected
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), 0 by de-
fault.
OPTIONS(3) = None Number of node whose bus section is to be
connected
When APIOPT=2 and OPTIONS(1)=7 (3PH), 0 by default.
OPTIONS(3) = None Number of node whose bus section is to be
faulted
When APIOPT=2 and OPTIONS(1)=8 (one end open), no default
allowed.
OPTIONS(3) = None Another bus connected by the branch to be
faulted
When APIOPT=2 and OPTIONS(1)=9 (both ends closed), no de-
fault allowed.
OPTIONS(3) = None The other bus connected by the branch to
be faulted
OPTIONS(4) Specify it per additional conditions as below.
When APIOPT=2 and OPTIONS(1)=1 or 2 (LG), faulted phase, 1
by default.
OPTIONS(4) = 1 Phase A
OPTIONS(4) = 2 Phase B
OPTIONS(4) = 3 Phase C
When APIOPT=2 and OPTIONS(1)=3 or 4 (LLG), excluded phase,
1 by default.
OPTIONS(4) = 1 Phase A
OPTIONS(4) = 2 Phase B
OPTIONS(4) = 3 Phase C
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), no default
allowed.
OPTIONS(4) = None The other bus to be connected by the phase
closed unbalance
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), no de-
fault allowed.
OPTIONS(4) = None The other bus to be connected by the phase
closed unbalance
When APIOPT=2 and OPTIONS(1)=8 (one end open), 0 by de-
fault.
OPTIONS(4) = None Third bus connected by the three-winding
transformer to be faulted, or zero for a two
terminal branch
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1254
Fault Analysis SCMU_2
When APIOPT=2 and OPTIONS(1)=9 (both ends closed), type of
in-line fault to be applied (1 by default).
OPTIONS(4) = 1 Line-to-ground
OPTIONS(4) = 2 Line-to-line or line-to-line-to-ground fault
OPTIONS(4) = 3 Three-phase
OPTIONS(5) Specify it per additional conditions as below.
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), 0 by de-
fault.
OPTIONS(5) = None Number of node whose bus section is to be
connected
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), 0 by de-
fault.
OPTIONS(5) = None Number of node whose bus section is to be
connected
When APIOPT=2 and OPTIONS(1)=8 (one end open), type of in-
line fault to be applied (1 by default).
OPTIONS(5) = 1 Line-to-ground
OPTIONS(5) = 2 Line-to-line or line-to-line-to-ground fault
OPTIONS(5) = 3 Three-phase
When APIOPT=2, OPTIONS(1)=9 (both ends closed) and OP-
TIONS(4)=1, faulted phase (1 by default).
OPTIONS(5) = 1 Phase A
OPTIONS(5) = 2 Phase B
OPTIONS(5) = 3 Phase C
When APIOPT=2, OPTIONS(1)=9 (both ends closed) and OP-
TIONS(4)=2, excluded phase (1 by default).
OPTIONS(5) = 1 Phase A
OPTIONS(5) = 2 Phase B
OPTIONS(5) = 3 Phase C
OPTIONS(6) Specify it per additional conditions as below.
When APIOPT=2 and OPTIONS(1)=5 (1 phase closed), phase to
be closed, 1 by default.
OPTIONS(6) = 1 Phase A
OPTIONS(6) = 2 Phase B
OPTIONS(6) = 3 Phase C
When APIOPT=2 and OPTIONS(1)=6 (2 phases closed), excluded
phase, 1 by default.
OPTIONS(6) = 1 Phase A
OPTIONS(6) = 2 Phase B
OPTIONS(6) = 3 Phase C
When APIOPT=2, OPTIONS(1)=8 (one end open) and OP-
TIONS(5)=1, faulted phase (1 by default).
OPTIONS(6) = 1 Phase A
OPTIONS(6) = 2 Phase B
OPTIONS(6) = 3 Phase C
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1255
Fault Analysis SCMU_2
When APIOPT=2, OPTIONS(1)=8 (one end open) and OP-
TIONS(5)=2, excluded phase (1 by default).
OPTIONS(6) = 1 Phase A
OPTIONS(6) = 2 Phase B
OPTIONS(6) = 3 Phase C
OPTIONS(7) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(2) by
default.
OPTIONS(7) = None Opened end bus (must be identical to one of
OPTIONS(2), OPTIONS(3), or, if it is non-ze-
ro, OPTIONS(4))
Real RVAL (5) array of 5 elements specifying input values used to define the current
fault; ignored except when APIOPT is 2. The elements of RVAL are de-
pendent on the value specified for OPTIONS(1).(input).
RVAL(1) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=1 or 2 (LG), 0.0 by default.
RVAL(1) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
RVAL(1) = None Resistance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=5 (1 phase closed), 0.0 by de-
fault.
RVAL(1) = None Resistance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=6 (2 phases closed), 0.0 by de-
fault.
RVAL(1) = None Resistance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=1,
0.0 by default.
RVAL(1) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(1) = None Resistance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=1, 0.0 by default.
RVAL(1) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(1) = None Resistance of the complex L-L fault imped-
ance in pu
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1256
Fault Analysis SCMU_2
RVAL(2) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=1 or 2 (LG), 0.0 by default.
RVAL(2) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
RVAL(2) = None Reactance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=5 (1 phase closed), 0.0 by de-
fault.
RVAL(2) = None Reactance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=6 (2 phases closed), 0.0 by de-
fault.
RVAL(2) = None Reactance of the complex phase impedance
in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=1,
0.0 by default.
RVAL(2) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(2) = None Reactance of the complex L-L fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=1, 0.0 by default.
RVAL(2) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(2) = None Reactance of the complex L-L fault imped-
ance in pu
RVAL(3) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
RVAL(3) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(3) = None Resistance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(3) = None Resistance of the complex L-G fault imped-
ance in pu
RVAL(4) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=3 or 4 (LLG), 0.0 by default.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1257
Fault Analysis SCMU_2
RVAL(4) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=8 (one end open), OPTIONS(5)=2,
0.0 by default.
RVAL(4) = None Reactance of the complex L-G fault imped-
ance in pu
When APIOPT=2, OPTIONS(1)=9 (both ends closed), OP-
TIONS(4)=2, 0.0 by default.
RVAL(4) = None Reactance of the complex L-G fault imped-
ance in pu
RVAL(5) Specify it per additional conditions as below.
When APIOPT=2, OPTIONS(1)=8 (one end open), 1.0 by default.
RVAL(5) = None fault location from closed end bus in pu of
total line length; must be 1.0 if the branch is
a transformer
When APIOPT=2, OPTIONS(1)=9 (both ends closed), 0.5 by de-
fault.
RVAL(5) = None fault location from bus OPTIONS(2) in pu of
total line length
Character*2 CKTARG circuit identifier of branch to be faulted; ignored except when APIOPT
is 2 and OPTIONS(1) is 8 or 9 (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 unexpected APIOPT value
IERR = 2 invalid APIOPT value
IERR = 3 invalid unbalance type
IERR = 4 bus not found
IERR = 5 bus is out-of-service
IERR = 6 invalid phase value
IERR = 7 branch not found
IERR = 8 three-winding transformer not found
IERR = 9 invalid open end bus
IERR = 10 invalid distance factor
IERR = 11 terminated due to invalid fault specification
or application
IERR = 12 SEQD results are not compatible with the
working case
IERR = 13 fault analysis is invalid due to the presence of
in-service induction machines that are in the
"stalled" or "tripped" state
IERR = 14 bus type code and series element status in-
consistencies
IERR = 15 invalid OPTIONS value (from SEQD)
IERR = 16 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1258
Fault Analysis SCOP
4.1.23. SCOP
Use this API to tabulate unbalanced fault solution output. It must be preceded by the execution of activity
SCMU, either interactively, from a response file, or via Python. It must then 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_SCOP SID ALL UNITS APIOPT
Python command syntax:
ierr = scop(sid, all, units, apiopt)
Fortran command syntax:
CALL SCOPAPI(SID, ALL, UNITS, APIOPT, IERR)
Where:
Integer SID a valid subsystem identifier; used only when APIOPT is 0 or 2 and ALL
is 0. 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 0 or
2 (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer UNITS branch quantity flag; used only when APIOPT is 0 or 2 (input; 1 by
default).
UNITS = 1 currents
UNITS = 2 apparent impedances
UNITS = 3 apparent admittances
Integer APIOPT mode of operation (input; 0 by default).
APIOPT = 0 initialize for short circuit output, produce the
output, and run post-processing clean up
APIOPT = 1 initialize for short circuit output
APIOPT = 2 produce output
APIOPT = 3 post-processing clean up
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
1259
Fault Analysis SCOP
IERR = 3 invalid UNITS value
IERR = 4 invalid APIOPT value
IERR = 5 unexpected APIOPT value
IERR = 6 SCMU results error; one of the these oc-
curred: No SCMU results file is open; SCMU
results are not compatible with the working
case; Error reading the SCMU results file
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
1260
Fault Analysis SEQD
4.1.24. SEQD
This API routine is obsolete. It has been replaced by the API routine seqd_2 .
Use this API to factorize the sequence matrices in preparation for unbalanced fault calculations.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SEQD OPTIONS(1) OPTIONS(2)
Python command syntax:
ierr = seqd(options)
Fortran command syntax:
CALL SEQDAPI(OPTIONS, IERR)
Where:
Integer OPTIONS (2) array of 2 elements specifying options to be used in constructing the
sequence matrices(input).
OPTIONS(1) dc line and FACTS device option (0 by de-
fault)
OPTIONS(1) = 0 block and ignore
OPTIONS(1) = 1 convert to constant admittance load
OPTIONS(2) transformer impedance correction option (1
by default)
OPTIONS(2) = 0 do not apply to zero sequence
OPTIONS(2) = 1 apply to zero sequence
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS 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
1261
Fault Analysis SEQD_2
4.1.25. SEQD_2
Use this API routine to factorize the sequence matrices in preparation for unbalanced fault calculations SC-
MU and SPCB.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SEQD_2 OPTIONS(1) OPTIONS(2) OPTIONS(3)
Python command syntax:
ierr = seqd_2(options)
Fortran command syntax:
CALL SEQD_2(OPTIONS, IERR)
Where:
Integer OPTIONS (3) array of 3 elements specifying options to be used in constructing the
sequence matrices(input).
OPTIONS(1) dc line and FACTS device option (0 by de-
fault)
OPTIONS(1) = 0 block and ignore
OPTIONS(1) = 1 convert to constant admittance load
OPTIONS(2) transformer impedance correction option (1
by default)
OPTIONS(2) = 0 do not apply to zero sequence
OPTIONS(2) = 1 apply to zero sequence
OPTIONS(3) fault analysis generator reactance option;
ignored if generators are already "convert-
ed" (0 by default)
OPTIONS(3) = 0 use subtransient reactance
OPTIONS(3) = 1 use transient reactance
OPTIONS(3) = 2 use synchronous reactance
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid OPTIONS value
IERR = 2 fault analysis is invalid due to the presence of
in-service induction machines that are in the
"stalled" or "tripped" state
IERR = 3 bus type code and series element status in-
consistencies
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
1262
Fault Analysis SEQUENCE_NETWORK_SETUP
4.1.26. SEQUENCE_NETWORK_SETUP
Use this API to specify or return the option to enable or disable automatic fault analysis sequence network
setup.
This API routine was first introduced in release 29.0.0.
Batch command syntax:
BAT_SEQUENCE_NETWORK_SETUP IVAL
Python command syntax:
ierr = sequence_network_setup(ival)
ierr, ival = sequence_network_setup()
Fortran command syntax:
CALL SEQUENCE_NETWORK_SETUP_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 SCMU assumes SEQD has already been exe-
cuted.
IVAL = 1 SCMU always executes activity SEQD.
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
1263
Fault Analysis SQEX
4.1.27. SQEX
Use this API to tabulate all fault analysis data pertaining to a specified bus.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SQEX SID ALL
Python command syntax:
ierr = sqex(sid, all)
Fortran command syntax:
CALL SQEXNW(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
1264
Fault Analysis SQEX
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1265
Fault Analysis SQEX
Fault Analysis Operation APIs contains API routines corresponding to the operational functions of PSS®E Fault
Analysis.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1266
Fault Analysis Fault Analysis Data
4.2. Fault Analysis Data
Fault Analysis, or Short Circuit, Data Changing APIs contains API routines specific to adding, modifying and
deleting short circuit data.
Note that, except for the SEQ_MUTUAL_DATA API, the SEQ_ APIs always modify data of an existing element.
4.2.1. MBIDNCS
Use this API to change the table name of the specified non-conventional source fault contribution table in
the working case.
This API routine was first introduced in release 35.2.0.
Batch command syntax:
BAT_MBIDNCS 'NAME' 'NAMNEW'
Python command syntax:
ierr = mbidncs(name, namnew)
Fortran command syntax:
CALL MBIDNCS(NAME, NAMNEW, IERR)
Where:
Character*12 NAME name of the NCSFCC table for which the NCSFCC table name is to be
changed (input; no default allowed).
Character*12 NAMNEW new name to be assigned to the NCSFCC table (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 NCSFCC table NAME not found
IERR = 2 NCSFCC table NEWNAM already exists
IERR = 3 a non-blank new identifier must be specified
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
1267
Fault Analysis SEQ_3_WIND_GROUNDING_DATA
4.2.2. SEQ_3_WIND_GROUNDING_DATA
Use this API to modify the zero sequence grounding data of an existing three-winding transformer in the
working case (see PSSE Program Operation Manual, Zero Sequence Transformer Data).
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_SEQ_3_WIND_GROUNDING_DATA IBUS JBUS KBUS 'CKT' INTGAR(1)
REALAR(1) REALAR(2)
Python command syntax:
ierr = seq_3_wind_grounding_data(ibus, jbus, kbus, ckt, intgar, realar)
Fortran command syntax:
CALL SEQ_3_WINDING_GROUNDING_API_2(IBUS,JBUS,KBUS,CKT,INTGAR,REALAR,IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying one element (defaulted data items are
unchanged)(input).
INTGAR(1) CC, connection code
Real REALAR (2) array of 2 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RG, zero sequence grounding resistance
REALAR(2) XG, zero sequence grounding reactance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 three-winding transformer not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid winding con-
nection code. - Connection code is such that
more than one winding requires a grounding
impedance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1268
Fault Analysis SEQ_3_WIND_WINDING_DATA
4.2.3. SEQ_3_WIND_WINDING_DATA
Use this API to modify the zero sequence impedance data of one winding of an existing three-winding
transformer in the working case (see PSSE Program Operation Manual, Zero Sequence Transformer Data).
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_SEQ_3_WIND_WINDING_DATA IBUS JBUS KBUS 'CKT' WARG REALAR(1)
REALAR(2)
Python command syntax:
ierr = seq_3_wind_winding_data(ibus, jbus, kbus, ckt, warg, realar)
Fortran command syntax:
CALL SEQ_THREE_WINDING_WINDING_API_2(IBUS,JBUS,KBUS,CKT,WARG,REALAR,IERR)
Where:
Integer IBUS bus number of one of the buses (input; no default allowed).
Integer JBUS bus number one of the other buses (input; no default allowed).
Integer KBUS bus number of the third bus (input; no default allowed).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer WARG winding number (1, 2 or 3) (input; no default allowed).
Real REALAR (2) array of 2 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) Ri, zero sequence winding resistance
REALAR(2) Xi, zero sequence winding reactance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 three-winding transformer not found
IERR = 4 invalid winding number
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - None
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1269
Fault Analysis SEQ_BRANCH_DATA
4.2.4. SEQ_BRANCH_DATA
This API routine is obsolete. It has been replaced by the API routine seq_branch_data_3 .
Use this API to modify the zero sequence data of an existing non-transformer branch in the working case
(see PSSE Program Operation Manual, Zero Sequence Non-Transformer Branch Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SEQ_BRANCH_DATA IBUS JBUS 'CKT' REALAR(1)..REALAR(7)
Python command syntax:
ierr = seq_branch_data(ibus, jbus, ckt, realar)
Fortran command syntax:
CALL SEQ_BRANCH_API_2(IBUS, JBUS, CKT, REALAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Real REALAR (7) array of 7 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RLINZ, zero sequence branch resistance
REALAR(2) XLINZ, zero sequence branch reactance
REALAR(3) BCHZ, zero sequence total line charging
REALAR(4) GI, zero sequence active line shunt at bus
IBUS end
REALAR(5) BI, zero sequence reactive line shunt at bus
IBUS end
REALAR(6) GJ, zero sequence active line shunt at bus
JBUS end
REALAR(7) BJ, zero sequence reactive line shunt at bus
JBUS end
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 circuit identifier may not start with &
IERR = 4 branch not found
IERR = 5 branch exists but it is a two-winding trans-
former
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1270
Fault Analysis SEQ_BRANCH_DATA
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - branch is treated as a
zero impedance line but its zero sequence im-
pedance is non-zero
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1271
Fault Analysis SEQ_BRANCH_DATA_3
4.2.5. SEQ_BRANCH_DATA_3
Use this API to modify the zero sequence data of an existing non-transformer branch in the working case
(see PSSE Program Operation Manual, Zero Sequence Non-Transformer Branch Data).
This API routine was first introduced in release 33.1.0.
Batch command syntax:
BAT_SEQ_BRANCH_DATA_3 IBUS JBUS CKT INTGAR REALAR(1)..REALAR(8)
Python command syntax:
ierr = seq_branch_data_3(ibus, jbus, ckt, intgar, realar)
Fortran command syntax:
CALL SEQ_BRANCH_API_3(IBUS, JBUS, CKT, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying MOV-protected series capacitor
flag(input).
INTGAR(1) MOV-protected series capacitor flag
INTGAR(1) = 0 not a MOV-protected branch
INTGAR(1) = 1 MOV-protected series capacitor with MOV
protection enabled
INTGAR(1) = 2 MOV-protected series capacitor with MOV
protection disabled
INTGAR(1) = 3 spark gap protection enabled
Real REALAR (8) array of 8 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RLINZ, zero sequence branch resistance
REALAR(2) XLINZ, zero sequence branch reactance
REALAR(3) BCHZ, zero sequence total line charging
REALAR(4) GI, zero sequence active line shunt at bus
IBUS end
REALAR(5) BI, zero sequence reactive line shunt at bus
IBUS end
REALAR(6) GJ, zero sequence active line shunt at bus
JBUS end
REALAR(7) BJ, zero sequence reactive line shunt at bus
JBUS end
REALAR(8) MOVI, mov protected current level in kA
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1272
Fault Analysis SEQ_BRANCH_DATA_3
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 circuit identifier may not start with &
IERR = 4 branch not found
IERR = 5 branch exists but it is a two-winding trans-
former
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - branch is treated as a
zero impedance line but its zero sequence im-
pedance is non-zero
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1273
Fault Analysis SEQ_BUS_DATA
4.2.6. SEQ_BUS_DATA
Bus load sequence data is now accessible as load sequence data.
Use this API routine to modify the sequence data of an existing bus in the working case (see PSSE Program
Operation Manual, Negative Sequence Shunt Load Data and Zero Sequence Shunt Load Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SEQ_BUS_DATA IBUS REALAR(1)..REALAR(4)
Python command syntax:
ierr = seq_bus_data(ibus, realar)
Fortran command syntax:
CALL SEQ_BUS_API_2(IBUS, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Real REALAR (4) array of 4 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) GNEG, negative sequence shunt admittance
active component
REALAR(2) BNEG, negative sequence shunt admittance
reactive component
REALAR(3) GZERO, zero sequence shunt admittance ac-
tive component
REALAR(4) BZERO, zero sequence shunt admittance re-
active component
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 the SEQ_BUS_DATA API routine is obsolete
IERR = 2 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - None
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1274
Fault Analysis SEQ_FIXED_SHUNT_DATA
4.2.7. SEQ_FIXED_SHUNT_DATA
Use this API to modify the zero sequence data of an existing fixed bus shunt in the working case (see PSSE
Program Operation Manual, Zero Sequence Fixed Shunt Data).
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_SEQ_FIXED_SHUNT_DATA IBUS 'ID' REALAR(1) REALAR(2)
Python command syntax:
ierr = seq_fixed_shunt_data(ibus, id, realar)
Fortran command syntax:
CALL SEQ_FIXED_SHUNT_API(IBUS, ID, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID shunt identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) GSZERO, active power component of fixed
shunt zero sequence admittance (conduc-
tance)
REALAR(2) BSZERO, reactive power component of fixed
shunt zero sequence admittance (suscep-
tance)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 shunt identifier is more than two characters
IERR = 3 fixed shunt not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Admittance compo-
nents with different signs in the positive and
zero sequences
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1275
Fault Analysis SEQ_INDUCTION_MACH_DATA
4.2.8. SEQ_INDUCTION_MACH_DATA
This API routine is obsolete. It has been replaced by the API routine seq_induction_mach_data_2 .
Use this API routine to modify the sequence data of an existing induction machine in the working case (see
PSSE Program Operation Manual, Induction Machine Impedance Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SEQ_INDUCTION_MACH_DATA IBUS 'ID' INTGAR(1) INTGAR(2)
REALAR(1)..REALAR(6)
Python command syntax:
ierr = seq_induction_mach_data(ibus, id, intgar, realar)
Fortran command syntax:
CALL SEQ_INDUCTION_MACH_API(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (defaulted data items are un-
changed)(input).
INTGAR(1) CZG, code indicating the units in which the
zero sequence grounding impedance is spec-
ified
INTGAR(1) = 1 for per unit
INTGAR(1) = 2 for ohms
INTGAR(2) CGR, grounding code (0 = ungrounded; 1 =
grounded) (0 by default)
Real REALAR (6) array of 6 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) ILK2IR, ratio of positive sequence locked ro-
tor current to rated current
REALAR(2) ROVERX, ratio of positive sequence resis-
tance to reactance
REALAR(3) R0, machine zero sequence fault analysis re-
sistance
REALAR(4) X0, machine zero sequence fault analysis re-
actance
REALAR(5) RG, machine zero sequence grounding resis-
tance
REALAR(6) XG, machine zero sequence grounding reac-
tance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1276
Fault Analysis SEQ_INDUCTION_MACH_DATA
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 induction machine not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid CZG data val-
ue. - invalid grounding code. - CZG is 2 but
the bus has no base voltage specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1277
Fault Analysis SEQ_INDUCTION_MACH_DATA_2
4.2.9. SEQ_INDUCTION_MACH_DATA_2
Use this API routine to modify the sequence data of an existing induction machine in the working case (see
PSSE Program Operation Manual, Induction Machine Impedance Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SEQ_INDUCTION_MACH_DATA_2 IBUS ID INTGAR(1)..INTGAR(2)
REALAR(1)..REALAR(10)
Python command syntax:
ierr = seq_induction_mach_data_2(ibus, id, intgar, realar)
Fortran command syntax:
CALL SEQ_INDUCTION_MACH_API_2(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (defaulted data items are un-
changed)(input).
INTGAR(1) CZG, code indicating the units in which the
zero sequence grounding impedance is spec-
ified
INTGAR(1) = 1 for per unit
INTGAR(1) = 2 for ohms
INTGAR(2) CGR, grounding code (0 = ungrounded; 1 =
grounded) (0 by default)
Real REALAR (10) array of 10 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) ILK2IR, ratio of positive sequence locked ro-
tor current to rated current
REALAR(2) ROVERX, ratio of positive sequence resis-
tance to reactance
REALAR(3) R0, machine zero sequence fault analysis re-
sistance
REALAR(4) X0, machine zero sequence fault analysis re-
actance
REALAR(5) RG, machine zero sequence grounding resis-
tance
REALAR(6) XG, machine zero sequence grounding reac-
tance
REALAR(7) RT, ratio of locked rotor current to rated cur-
rent (transient)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1278
Fault Analysis SEQ_INDUCTION_MACH_DATA_2
REALAR(8) XT, ratio of Rpos to Xpos (these two used to
set IMZPSN)(transient)
REALAR(9) RN, ratio of locked rotor current to rated cur-
rent (negative sequence)
REALAR(10) XN, ratio of Rpos to Xpos (these two used to
set IMZPSN)(negative sequence)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 induction machine not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid CZG data val-
ue. - invalid grounding code. - CZG is 2 but
the bus has no base voltage specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1279
Fault Analysis SEQ_LOAD_DATA
4.2.10. SEQ_LOAD_DATA
Use this API routine to modify the sequence data of an existing load in the working case (see PSSE Program
Operation Manual, Load Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SEQ_LOAD_DATA IBUS 'ID' INTGAR(1) REALAR(1)..REALAR(4)
Python command syntax:
ierr = seq_load_data(ibus, id, intgar, realar)
Fortran command syntax:
CALL SEQ_LOAD_API(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying one element(input).
INTGAR(1) CGR, load grounding code (0 = ungrounded;
1 = grounded) (0 by default)
Real REALAR (4) array of 4 elements specifying (input).
REALAR(1) GNEG, negative sequence active power load
component; entered as admittance in MW at
1.0 per unit voltage (0.0 by default)
REALAR(2) BNEG, negative sequence reactive power
load component; BNEG is negative for an
inductive load and positive for a capacitive
load; entered as admittance in MVar at 1.0
per unit voltage (0.0 by default)
REALAR(3) GZERO, zero sequence active power load
component; entered as admittance in MW at
1.0 per unit voltage (0.0 by default)
REALAR(4) BZERO, zero sequence reactive power load
component; BZERO is negative for an induc-
tive load and positive for a capacitive load;
entered as admittance in MVar at 1.0 per
unit voltage (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 load identifier is more than two characters
IERR = 3 load not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1280
Fault Analysis SEQ_LOAD_DATA
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid grounding
code
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1281
Fault Analysis SEQ_MACHINE_DATA
4.2.11. SEQ_MACHINE_DATA
This API routine is obsolete. It has been replaced by the API routine seq_machine_data_3 .
Use this API routine to modify the sequence data of an existing machine in the working case (see PSSE
Program Operation Manual, Positive Sequence Generator Impedance Data, Negative Sequence Generator
Impedance Data and Zero Sequence Generator Impedance Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SEQ_MACHINE_DATA IBUS 'ID' REALAR(1)..REALAR(6)
Python command syntax:
ierr = seq_machine_data(ibus, id, realar)
Fortran command syntax:
CALL SEQ_MACHINE_API_2(IBUS, ID, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Real REALAR (6) array of 6 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) ZRPOS, machine positive sequence fault
analysis resistance
REALAR(2) ZXPOS, machine positive sequence fault
analysis reactance
REALAR(3) ZRNEG, machine negative sequence fault
analysis resistance
REALAR(4) ZXNEG, machine negative sequence fault
analysis reactance
REALAR(5) RZERO, machine zero sequence fault analysis
resistance
REALAR(6) XZERO, machine zero sequence fault analysis
reactance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
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
1282
Fault Analysis SEQ_MACHINE_DATA
IERR = -1 data error, warning and information mes-
sages; one or more of: - Machine impedance
is (0.0,0.0)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1283
Fault Analysis SEQ_MACHINE_DATA_3
4.2.12. SEQ_MACHINE_DATA_3
This API routine is obsolete. It has been replaced by the API routine seq_machine_data_4 .
Use this API routine to modify the sequence data of an existing machine in the working case (see PSSE
Program Operation Manual, Positive Sequence Generator Impedance Data, Negative Sequence Generator
Impedance Data and Zero Sequence Generator Impedance Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SEQ_MACHINE_DATA_3 IBUS 'ID' INTGAR(1) REALAR(1)..REALAR(10)
Python command syntax:
ierr = seq_machine_data_3(ibus, id, intgar, realar)
Fortran command syntax:
CALL SEQ_MACHINE_API_3(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying one element (defaulted data items are
unchanged)(input).
INTGAR(1) CZG, code indicating the units in which the
zero sequence grounding impedance is spec-
ified
INTGAR(1) = 1 for per unit
INTGAR(1) = 2 for ohms
Real REALAR (10) array of 10 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RPOS, machine positive sequence fault analy-
sis resistance
REALAR(2) X", machine positive sequence fault analysis
subtransient reactance
REALAR(3) RNEG, machine negative sequence fault
analysis resistance
REALAR(4) XNEG, machine negative sequence fault
analysis reactance
REALAR(5) RZERO, machine zero sequence fault analysis
resistance
REALAR(6) XZERO, machine zero sequence fault analysis
reactance
REALAR(7) X', machine positive sequence fault analysis
transient reactance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1284
Fault Analysis SEQ_MACHINE_DATA_3
REALAR(8) Xs, machine positive sequence fault analysis
synchronous reactance
REALAR(9) RG, machine zero sequence grounding resis-
tance
REALAR(10) XG, machine zero sequence grounding reac-
tance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Grounding imped-
ance units code indicates input in ohms but
no base voltage has been specified for the
bus. - Invalid grounding impedance units
code. - Invalid grounding impedance units
code. - Invalid positive sequence reactance
value. - Negative sequence impedance is
(0.0,0.0). - Zero sequence impedance is
(0.0,0.0)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1285
Fault Analysis SEQ_MACHINE_DATA_4
4.2.13. SEQ_MACHINE_DATA_4
Use this API routine to modify the sequence data of an existing machine in the working case (see PSSE
Program Operation Manual, Positive Sequence Generator Impedance Data, Negative Sequence Generator
Impedance Data and Zero Sequence Generator Impedance Data).
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SEQ_MACHINE_DATA_4 IBUS ID INTGAR REALAR(1)..REALAR(11)
Python command syntax:
ierr = seq_machine_data_4(ibus, id, intgar, realar)
Fortran command syntax:
CALL SEQ_MACHINE_API_4(IBUS, ID, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying one element (defaulted data items are
unchanged)(input).
INTGAR(1) CZG, code indicating the units in which the
zero sequence grounding impedance is spec-
ified
INTGAR(1) = 1 for per unit
INTGAR(1) = 2 for ohms
Real REALAR (11) array of 11 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RPOS, machine positive sequence fault analy-
sis resistance
REALAR(2) X", machine positive sequence fault analysis
subtransient reactance
REALAR(3) RNEG, machine negative sequence fault
analysis resistance
REALAR(4) XNEG, machine negative sequence fault
analysis reactance
REALAR(5) RZERO, machine zero sequence fault analysis
resistance
REALAR(6) XZERO, machine zero sequence fault analysis
reactance
REALAR(7) X', machine positive sequence fault analysis
transient reactance
REALAR(8) Xs, machine positive sequence fault analysis
synchronous reactance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1286
Fault Analysis SEQ_MACHINE_DATA_4
REALAR(9) RG, machine zero sequence grounding resis-
tance
REALAR(10) XG, machine zero sequence grounding reac-
tance
REALAR(11) RFDG, machine reference angle in degrees
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Grounding imped-
ance units code indicates input in ohms but
no base voltage has been specified for the
bus. - Invalid grounding impedance units
code. - Invalid grounding impedance units
code. - Invalid positive sequence reactance
value. - Negative sequence impedance is
(0.0,0.0). - Zero sequence impedance is
(0.0,0.0)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1287
Fault Analysis SEQ_MACHINE_NCS_DATA
4.2.14. SEQ_MACHINE_NCS_DATA
Use this API routine to modify a machine's existing non-conventional source fault current contribution
(NCSFCC) data or to add NCSFCC data to an existing machine in the working case.
This API routine was first introduced in release 35.2.0.
Batch command syntax:
BAT_SEQ_MACHINE_NCS_DATA IBUS ID INTGAR REALAR(1) REALAR(2) REALAR(3)
NAMEAR(1) NAMEAR(2)
Python command syntax:
ierr = seq_machine_ncs_data(ibus, id, intgar, realar, namear)
Fortran command syntax:
CALL SEQ_MACHINE_NCS_DATA(IBUS, ID, INTGAR, REALAR, NAMEAR, IERR)
Where:
Integer IBUS bus number (input).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR characteristic type; 0 for none, 1 for time dependent, 2 for voltage
dependent (input; 0 by default).
real REALAR (3) array of 3 elements specifying Real Options(input).
REALAR(1) IFMAX, per unit total current magnitude al-
lowed during a fault (1.1 by default)
REALAR(2) DBVMIN, per unit dead-band minimum volt-
age at POI (0.9 by default)
REALAR(3) DBVMAX, per unit dead-band maximum volt-
age at POI (1.1 by default)
character*12 NAMEAR (2) array of 2 elements specifying Specifies the names of the non-con-
ventional source fault contribution (NCSFCC) tables(input).
NAMEAR(1) positive sequence table name ( by default)
NAMEAR(2) negative sequence table name ( by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 no table specified for the positive sequence
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid characteristic
type flag. - Table not found. - Machine and ta-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1288
Fault Analysis SEQ_MACHINE_NCS_DATA
ble characteristic type mismatch. - IFMAX is
less than 1.0. - DBVMAX is less than DBVMIN.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1289
Fault Analysis SEQ_MACHINE_NCS_DATA_PURG
4.2.15. SEQ_MACHINE_NCS_DATA_PURG
Use this API routine to delete a machine's existing non-conventional source fault current contribution
(NCSFCC) data.
This API routine was first introduced in release 35.2.0.
Batch command syntax:
BAT_SEQ_MACHINE_NCS_DATA_PURG IBUS ID
Python command syntax:
ierr = seq_machine_ncs_data_purg(ibus, id)
Fortran command syntax:
CALL SEQ_MACHINE_NCS_DATA_PURG(IBUS, ID, IERR)
Where:
Integer IBUS bus number (input).
Character*2 ID machine identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 no non-conventional source data specified for
this machine
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1290
Fault Analysis SEQ_MUTUAL_DATA
4.2.16. SEQ_MUTUAL_DATA
Use this API to modify existing zero sequence mutual impedance data in the working case or to add a new
zero sequence mutual coupling to the working case (see PSSE Program Operation Manual, Zero Sequence
Mutual Impedance Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SEQ_MUTUAL_DATA IBUS JBUS 'CKT1' KBUS LBUS 'CKT2'
REALAR(1)..REALAR(6)
Python command syntax:
ierr = seq_mutual_data(ibus, jbus, ckt1, kbus, lbus, ckt2, realar)
Fortran command syntax:
CALL SEQ_MUTUAL_API_2(IBUS, JBUS, CKT1, KBUS, LBUS, CKT2, REALAR, IERR)
Where:
Integer IBUS bus number of the from bus of the first branch (input; no default al-
lowed).
Integer JBUS bus number of the to bus of the first branch (input; no default al-
lowed).
Character*2 CKT1 first branch circuit identifier (input; '1' by default).
Integer KBUS bus number of the from bus of the second branch (input; no default
allowed).
Integer LBUS bus number of the to bus of the second branch to bus (input; no de-
fault allowed).
Character*2 CKT2 second branch circuit identifier (input; '1' by default).
Real REALAR (6) array of 6 elements specifying (input).
REALAR(1) RM, branch-to-branch mutual resistance (0.0
by default)
REALAR(2) XM, branch-to-branch mutual reactance (0.0
by default)
REALAR(3) BIJ1, B factor at IBUS end of the first branch
(0.0 by default)
REALAR(4) BIJ2, B factor at JBUS end of the first branch
(1.0 by default)
REALAR(5) BKL1, B factor at KBUS end of the second
branch (0.0 by default)
REALAR(6) BKL2, B factor at LBUS end of the second
branch (1.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1291
Fault Analysis SEQ_MUTUAL_DATA
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 circuit identifier may not start with &
IERR = 4 branch not found
IERR = 5 mutual couples a branch to itself
IERR = 6 branch is a transformer
IERR = 7 branch is a zero impedance line
IERR = 8 mutual coupling table is full
IERR = 9 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid B factor (<0.0
or >1.0). - B1 is not less than B2
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1292
Fault Analysis SEQ_NCS_FLT_CNTRB_CHNG
4.2.17. SEQ_NCS_FLT_CNTRB_CHNG
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SEQ_NCS_FLT_CNTRB_CHNG IBUS ID POINTS REALAR(1)..REALAR(POINTS)
CPLXAR(1)..CPLXAR(POINTS)
Python command syntax:
ierr = seq_ncs_flt_cntrb_chng(ibus, id, points, realar, cplxar)
Fortran command syntax:
CALL SEQ_NCS_FLT_CNTRB_CHNG(IBUS, ID, POINTS, REALAR, CPLXAR, IERR)
Where:
Integer IBUS bus number (input).
Character*2 ID machine identifier (input; '1' by default).
Integer POINTS number of data points (input; no default allowed).
Real REALAR Array of 'POINTS' values specifying Ti in seconds, in strictly ascending
order of Ti (input; no default allowed).
Complex CPLXAR Array of 'POINTS' values specifying CiP and CiQ (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no errors occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1293
Fault Analysis SEQ_NCS_FLT_CNTRB_DATA
4.2.18. SEQ_NCS_FLT_CNTRB_DATA
This API routine is obsolete. It has been replaced by the API routines SEQ_NCS_TABLE_DATA and
SEQ_MACHINE_NCS_DATA .
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SEQ_NCS_FLT_CNTRB_DATA IBUS ID POINTS REALAR(1)..REALAR(POINTS)
CPLXAR(1)..CPLXAR(POINTS)
Python command syntax:
ierr = seq_ncs_flt_cntrb_data(ibus, id, points, realar, cplxar)
Fortran command syntax:
CALL SEQ_NCS_FLT_CNTRB_DATA(IBUS, ID, POINTS, REALAR, CPLXAR, IERR)
Where:
Integer IBUS bus number (input).
Character*2 ID machine identifier (input; '1' by default).
Integer POINTS number of data points (input; no default allowed).
Real REALAR Array of 'POINTS' values specifying Ti in seconds, in strictly ascending
order of Ti (input; no default allowed).
Complex CPLXAR Array of 'POINTS' values specifying CiP and CiQ (input; no default al-
lowed).
Integer IERR error code (output).
IERR = 0 no errors occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1294
Fault Analysis SEQ_NCS_FLT_CNTRB_PURG
4.2.19. SEQ_NCS_FLT_CNTRB_PURG
This API routine is obsolete. It has been replaced by the API routine SEQ_MACHINE_NCS_DATA_PURG .
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SEQ_NCS_FLT_CNTRB_PURG IBUS ID
Python command syntax:
ierr = seq_ncs_flt_cntrb_purg(ibus, id)
Fortran command syntax:
CALL SEQ_NCS_FLT_CNTRB_PURG(IBUS, ID, IERR)
Where:
Integer IBUS bus number (input).
Character*2 ID machine identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 machine identifier is more than two charac-
ters
IERR = 3 machine not found
IERR = 4 Non-Conventional Source data not found
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
1295
Fault Analysis SEQ_NCS_TABLE_DATA
4.2.20. SEQ_NCS_TABLE_DATA
Use this API to modify the data of an existing non-conventional source fault contribution table in the work-
ing case or to add a new non-conventional source fault contribution table to the working case.
This API routine was first introduced in release 35.2.0.
Batch command syntax:
BAT_SEQ_NCS_TABLE_DATA 'NAME' POINTS TYPARG REALAR(1)..REALAR(POINTS)
CPLXAR(1)..CPLXAR(POINTS)
Python command syntax:
ierr = seq_ncs_table_data(name, points, typarg, realar, cplxar)
Fortran command syntax:
CALL SEQ_NCS_TABLE_DATA(NAME, POINTS, TYPARG, REALAR, CPLXAR, IERR)
Where:
character*12 NAME table name (input; no default allowed).
Integer POINTS number of points specified in table 'NAME' (1 through 20) (input; no
default allowed).
Integer TYPARG characteristic type; 0 for time dependent, 1 for voltage dependent
(input; 0 by default).
Real REALAR (POINTS) array of 'POINTS' values specifying Ti in seconds or Vi in per unit, in
strictly ascending order of Ti or Vi (input).
Complex CPLXAR (POINTS) array of 'POINTS' values specifying CiP and CiQ (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 blank table name is invalid
IERR = 2 invalid POINTS value
IERR = 3 table does not have at least 1 point
IERR = 4 maximum number of tables are already in the
case
IERR = 5 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - invalid characteristic
type flag - point is beyond the previous end of
table - Ti or Vi is negative - Ci is (0.0,0.0) - Ti
or Vi values are not in increasing order
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1296
Fault Analysis SEQ_NCS_TABLE_PURG
4.2.21. SEQ_NCS_TABLE_PURG
Use this API to delete an existing non-conventional source fault contribution table from the working case.
This API routine was first introduced in release 35.2.0.
Batch command syntax:
BAT_SEQ_TABLE_PURG 'NAME'
Python command syntax:
ierr = seq_ncs_table_purg(name)
Fortran command syntax:
CALL SEQ_NCS_TABLE_PURG(NAME, IERR)
Where:
character*12 NAME table name (input).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 table 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
1297
Fault Analysis SEQ_SWITCHED_SHUNT_DATA
4.2.22. SEQ_SWITCHED_SHUNT_DATA
This API routine is obsolete. It has been replaced by the API routine SEQ_SWITCHED_SHUNT_DATA_3 .
Use this API to modify the zero sequence data of an existing switched shunt in the working case (see PSSE
Program Operation Manual, Zero Sequence Switched Shunt Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SEQ_SWITCHED_SHUNT_DATA IBUS REALAR(1)..REALAR(8)
Python command syntax:
ierr, realaro = seq_switched_shunt_data(ibus, realari)
Fortran command syntax:
CALL SEQ_SWITCHED_SHUNT_API_2(IBUS, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Real REALAR (9) (first eight are input values; last value is output) (defaulted data
items are unchanged) (input (output).).
Real REALARI (8) array of 8 elements specifying corresponding to values REALAR(1)
through REALAR(8) as described above(input).
REALARI(1) BZ1, zero sequence increment in MVAR per
step for block 1
REALARI(2) BZ2, zero sequence increment in MVAR per
step for block 2
REALARI(3) BZ3, zero sequence increment in MVAR per
step for block 3
REALARI(4) BZ4, zero sequence increment in MVAR per
step for block 4
REALARI(5) BZ5, zero sequence increment in MVAR per
step for block 5
REALARI(6) BZ6, zero sequence increment in MVAR per
step for block 6
REALARI(7) BZ7, zero sequence increment in MVAR per
step for block 7
REALARI(8) BZ8, zero sequence increment in MVAR per
step for block 8
Real REALARO (1) array of 1 elements specifying one element corresponding to value
REALAR(9) as described above(output).
REALARO(1) present zero sequence switched shunt admit-
tance in MVAR (returned)
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1298
Fault Analysis SEQ_SWITCHED_SHUNT_DATA
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 no switched shunt at bus
IERR = 3 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Block has N zero and
B non-zero. - Block has admittances with dif-
ferent signs in positive and zero sequences
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1299
Fault Analysis SEQ_SWITCHED_SHUNT_DATA_3
4.2.23. SEQ_SWITCHED_SHUNT_DATA_3
Use this API to modify the zero sequence data of an existing switched shunt in the working case (see PSSE
Program Operation Manual, Zero Sequence Switched Shunt Data).
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_SEQ_SWITCHED_SHUNT_DATA_3 IBUS 'ID', REALAR(1)..REALAR(8)
Python command syntax:
ierr, realaro = seq_switched_shunt_data_3(ibus, id, realari)
Fortran command syntax:
CALL SEQ_SWITCHED_SHUNT_API_3(IBUS, ID, REALAR, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
character*2 ID Switched shunt identifier (input; 1 by default).
Real REALAR (9) (first eight are input values; last value is output) (defaulted data
items are unchanged) (input (output).).
Real REALARI (8) array of 8 elements specifying corresponding to values REALAR(1)
through REALAR(8) as described above(input).
REALARI(1) BZ1, zero sequence increment in MVAR per
step for block 1
REALARI(2) BZ2, zero sequence increment in MVAR per
step for block 2
REALARI(3) BZ3, zero sequence increment in MVAR per
step for block 3
REALARI(4) BZ4, zero sequence increment in MVAR per
step for block 4
REALARI(5) BZ5, zero sequence increment in MVAR per
step for block 5
REALARI(6) BZ6, zero sequence increment in MVAR per
step for block 6
REALARI(7) BZ7, zero sequence increment in MVAR per
step for block 7
REALARI(8) BZ8, zero sequence increment in MVAR per
step for block 8
Real REALARO (1) array of 1 elements specifying one element corresponding to value
REALAR(9) as described above(output).
REALARO(1) present zero sequence switched shunt admit-
tance in MVAR (returned)
Integer IERR error code (output).
IERR = 0 no errors occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1300
Fault Analysis SEQ_SWITCHED_SHUNT_DATA_3
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 shunt identifier is more than two characters
IERR = 2 switched shunt not found
IERR = 3 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Block has N zero and
B non-zero. - Block has admittances with dif-
ferent signs in positive and zero sequences
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1301
Fault Analysis SEQ_THREE_WINDING_DATA
4.2.24. SEQ_THREE_WINDING_DATA
This API routine is obsolete. It has been replaced by the API routine seq_three_winding_data_3 .
Use this API to modify the zero sequence data of an existing three-winding transformer in the working
case.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SEQ_THREE_WINDING_DATA IBUS JBUS KBUS 'CKT' INTGAR(1)
REALAR(1)..REALAR(8)
Python command syntax:
ierr = seq_three_winding_data(ibus, jbus, kbus, ckt, intgar, realar)
Fortran command syntax:
CALL SEQ_THREE_WINDING_API(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR, IERR,
NERR)
Where:
Integer IBUS bus number of one of the buses (input).
Integer JBUS bus number one of the other buses (input).
Integer KBUS bus number of the third bus (input).
Character*2 CKT transformer circuit identifier (input).
Integer INTGAR (1) array of 1 elements specifying one element(input).
INTGAR(1) CC, connection code
Real REALAR (8) array of 8 elements specifying (input).
REALAR(1) RG, zero sequence grounding resistance
REALAR(2) XG, zero sequence grounding reactance
REALAR(3) R1, zero sequence winding one resistance
REALAR(4) X1, zero sequence winding one reactance
REALAR(5) R2, zero sequence winding two resistance
REALAR(6) X2, zero sequence winding two reactance
REALAR(7) R3, zero sequence winding three resistance
REALAR(8) X3, zero sequence winding three reactance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 three-winding transformer not found
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
1302
Fault Analysis SEQ_THREE_WINDING_DATA
IERR = -1 warnings - one or more of: - Invalid wind-
ing connection code. - Connection code is
such that more than one winding requires a
grounding impedance
Integer NERR number of entries in PBUF02 containing error messages (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1303
Fault Analysis SEQ_THREE_WINDING_DATA_3
4.2.25. SEQ_THREE_WINDING_DATA_3
Use this API to modify the zero sequence data of an existing three-winding transformer in the working
case.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SEQ_THREE_WINDING_DATA_3 IBUS JBUS KBUS 'CKT'
INTGAR(1)..INTGAR(3) REALAR(1)..REALAR(14)
Python command syntax:
ierr = seq_three_winding_data_3(ibus, jbus, kbus, ckt, intgar, realar)
Fortran command syntax:
CALL SEQ_THREE_WINDING_API_3(IBUS, JBUS, KBUS, CKT, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number of one of the buses (input).
Integer JBUS bus number one of the other buses (input).
Integer KBUS bus number of the third bus (input).
Character*2 CKT transformer circuit identifier (input).
Integer INTGAR (3) array of 3 elements specifying (defaulted data items are un-
changed)(input).
INTGAR(1) CZ0, non-grounding impedance data I/O
code
INTGAR(2) CZG, grounding impedance data I/O code
INTGAR(3) CC, connection code
Real REALAR (14) array of 14 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RG1, grounding resistance on winding 1 for
an impedance grounded transformer
REALAR(2) XG1, grounding reactance on winding 1 for
an impedance grounded transformer
REALAR(3) R01, winding 1, or winding 1 bus to winding
2 bus, leakage resistance
REALAR(4) X01, winding 1, or winding 1 bus to winding
2 bus, leakage reactance
REALAR(5) RG2, grounding resistance on winding 2 for
an impedance grounded transformer
REALAR(6) XG2, grounding reactance on winding 2 for
an impedance grounded transformer
REALAR(7) R02, winding 2, or winding 2 bus to winding
3 bus, leakage resistance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1304
Fault Analysis SEQ_THREE_WINDING_DATA_3
REALAR(8) X02, winding 2, or winding 2 bus to winding
3 bus, leakage reactance
REALAR(9) RG3, grounding resistance on winding 3 for
an impedance grounded transformer
REALAR(10) XG3, grounding reactance on winding 3 for
an impedance grounded transformer
REALAR(11) R03, winding 3, or winding 3 bus to winding
1 bus, leakage resistance
REALAR(12) X03, winding 3, or winding 3 bus to winding
1 bus, leakage reactance
REALAR(13) RN, common neutral grounding resistance
REALAR(14) XN, common neutral grounding reactance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 three-winding transformer not found
IERR = 4 CZG is 3 but at least one endpoint bus has no
base voltage specified
IERR = 5 invalid CZ0 or CZG value
IERR = 6 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - Invalid winding
connection code. - Invalid CZ0 or CZG data
value. - CZ0 or CZG is not 1 with connection
code 1 through 9 or a three-digit connection
code. - CZG data value is 3 but at least one
endpoint bus has no base voltage specified. -
Non-zero neutral impedance specified but at
least one endpoint bus has no base or nom-
inal voltage specified. - A non-zero value is
specified for an impedance that is not used
with the specified connection code. - A val-
ue of zero is specified for an impedance that
is used with the specified connection code.
- Both ZGn and Z0n are used with the speci-
fied connection code and both are (0.0,0.0).
- Connection code is 17 or 18 but at least one
endpoint bus has no base or nominal voltage
specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1305
Fault Analysis SEQ_TWO_WINDING_DATA
4.2.26. SEQ_TWO_WINDING_DATA
This API routine is obsolete. It has been replaced by the API routine seq_two_winding_data_3 .
Use this API to modify the zero sequence data of an existing two-winding transformer in the working case
(see PSSE Program Operation Manual, Zero Sequence Transformer Data).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SEQ_TWO_WINDING_DATA IBUS JBUS 'CKT' INTGAR(1)
REALAR(1)..REALAR(6)
Python command syntax:
ierr = seq_two_winding_data(ibus, jbus, ckt, intgar, realar)
Fortran command syntax:
CALL SEQ_TWO_WINDING_API_2(IBUS, JBUS, CKT, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (1) array of 1 elements specifying one element (defaulted data items are
unchanged)(input).
INTGAR(1) CC, connection code (1 through 8)
Real REALAR (6) array of 6 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RG, grounding resistance if connection code
< 8; winding 1 side resistance to ground if CC
=8
REALAR(2) XG, grounding reactance if connection code
< 8; winding 1 side reactance to ground if CC
=8
REALAR(3) R1, zero sequence transformer resistance
REALAR(4) X1, zero sequence transformer reactance
REALAR(5) RG2, winding 2 side resistance to ground if
CC = 8; 0.0 otherwise
REALAR(6) XG2, winding 2 side reactance to ground if
CC = 8; 0.0 otherwise
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1306
Fault Analysis SEQ_TWO_WINDING_DATA
IERR = 2 circuit identifier is more than two characters
IERR = 3 circuit identifier may not start with &, * or @
IERR = 4 branch not found
IERR = 5 branch exists but it is a non-transformer
branch
IERR = 6 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid winding con-
nection code. - Zero sequence impedance
is (0.0,0.0). - Non-zero winding 2 imped-
ance to ground not used with the specified
connection code. - Winding n impedance to
ground is (0.0,0.0) with connection code 8. -
Grounding impedance is (0.0,0.0) with con-
nection code 9. - A specified series imped-
ance is (0.0,0.0) with connection code 9
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1307
Fault Analysis SEQ_TWO_WINDING_DATA_3
4.2.27. SEQ_TWO_WINDING_DATA_3
Use this API to modify the zero sequence data of an existing two-winding transformer in the working case
(see PSSE Program Operation Manual, Zero Sequence Transformer Data).
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SEQ_TWO_WINDING_DATA_3 IBUS JBUS 'CKT' INTGAR(1)..INTGAR(3)
REALAR(1)..REALAR(10)
Python command syntax:
ierr = seq_two_winding_data_3(ibus, jbus, ckt, intgar, realar)
Fortran command syntax:
CALL SEQ_TWO_WINDING_API_3(IBUS, JBUS, CKT, INTGAR, REALAR, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer INTGAR (3) array of 3 elements specifying (defaulted data items are un-
changed)(input).
INTGAR(1) CC, connection code
INTGAR(2) CZ0, leakage impedance data I/O code
INTGAR(3) CZG, grounding impedance data I/O code
Real REALAR (10) array of 10 elements specifying (defaulted data items are un-
changed)(input).
REALAR(1) RG1, grounding resistance at the winding 1
bus for an impedance grounded transformer
REALAR(2) XG1, grounding reactance at the winding 1
bus for an impedance grounded transformer
REALAR(3) R01, zero sequence leakage resistance con-
nected to the winding 1 bus
REALAR(4) X01, zero sequence leakage reactance con-
nected to the winding 1 bus
REALAR(5) RG2, grounding resistance at the winding 2
bus for an impedance grounded transformer
REALAR(6) XG2, grounding reactance at the winding 2
bus for an impedance grounded transformer
REALAR(7) R02, zero sequence leakage resistance con-
nected to the winding 2 bus
REALAR(8) X02, zero sequence leakage reactance con-
nected to the winding 2 bus
REALAR(9) RN, common neutral grounding resistance
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1308
Fault Analysis SEQ_TWO_WINDING_DATA_3
REALAR(10) XN, common neutral grounding reactance
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 fatal error occurred
IERR = 1 bus not found
IERR = 2 circuit identifier is more than two characters
IERR = 3 circuit identifier may not start with &, * or @
IERR = 4 branch not found
IERR = 5 branch exists but it is a non-transformer
branch
IERR = 6 CZG is 3 but at least one endpoint bus has no
base voltage specified
IERR = 7 invalid CZ0 or CZG value
IERR = 8 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - Invalid winding con-
nection code. - Z01 is set to its positive se-
quence value. - A non-zero value is specified
for an impedance that is not used with the
specified connection code.. - A value of ze-
ro is specified for an impedance that is used
with the specified connection code. - Invalid
CZ0 or CZG data value. - CZ0 or CZG is not 1
with connection code 1 through 9. - CZG da-
ta value is 3 but at least one endpoint bus has
no base voltage specified. - Non-zero neu-
tral impedance specified but at least one end-
point bus has no base or nominal voltage
specified. - Connection code is 18 through 22
but at least one endpoint bus has no base or
nominal voltage specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1309
Fault Analysis SEQ_TWO_WINDING_DATA_3
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1310
Chapter 5
Harmonics
This chapter describes the API routines used in PSS®E Harmonics.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1311
Harmonics Harmonics Operation
5.1. Harmonics Operation
5.1.1. HARMONICS
Use this API to run the Harmonics calculation.
This API routine was first introduced in release 34.5.0.
Batch command syntax:
BAT_HARMONICS SID ALL OPTIONS(1)..OPTIONS(6) VALUES(1)..VALUES(5)
HARMRSLTFILE
Python command syntax:
ierr = harmonics(sid, all, options, values, harmrsltfile)
Fortran command syntax:
CALL HARMONICS(SID, ALL, OPTIONS, VALUES, HARMRSLTFILE, 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 selected subsystem flag (input; 1 by default).
ALL = 0 process only buses in subsystem SID
ALL = 1 process all buses
integer OPTIONS (6) array of 6 elements specifying harmonics options(input).
OPTIONS(1) Harmoinic Weighting Type
OPTIONS(1) = 0 None
OPTIONS(1) = 1 IEEE 519 (Telephone influence factor)
OPTIONS(1) = 2 THFF (Telephone high frequency factor)
OPTIONS(1) = 3 NY x VNY
OPTIONS(1) = 4 IEC 61000-2-4 class 1
OPTIONS(1) = 5 IEC 61000-2-4 class 2
OPTIONS(1) = 6 IEC 61000-2-4 class 3
OPTIONS(2) Frequency Resonse at Node
OPTIONS(2) = 0 For all same values
OPTIONS(2) = 1 Individual values
OPTIONS(3) Wave Resistance Equation for Lines
OPTIONS(3) = 0 Not In Use
OPTIONS(3) = 1 In Use
OPTIONS(4) Include Resonance Network in Frequency
OPTIONS(4) = 0 Not In Use
OPTIONS(4) = 1 In Use
OPTIONS(5) Ignore Consumer
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1312
Harmonics HARMONICS
OPTIONS(5) = 0 Not In Use
OPTIONS(5) = 1 In Use
OPTIONS(6) Voltage Angle Consideration
OPTIONS(6) = 0 Not In Use
OPTIONS(6) = 1 In Use
real VALUES (5) array of 5 elements specifying harmonics values(input).
VALUES(1) Detuning Factor (1.0 by default)
VALUES(2) Initial Frequency (60.0 by default)
VALUES(3) End Frequency (2400.0 by default)
VALUES(4) Large Frequency Step (60.0 by default)
VALUES(5) Small Frequency Step (6.0 by default)
character*260 HARMRSLTFILE (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
1313
Harmonics HAR_NEW
5.1.2. HAR_NEW
Use this API to initialize all data records required for Harmonics analysis. It must be called prior to introduc-
ing any Harmonics data records. It has no effect if Harmonics data already exists in the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_NEW
Python command syntax:
ierr = har_new()
Fortran command syntax:
CALL HAR_NEW(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
1314
Harmonics HAR_PURG
5.1.3. HAR_PURG
Use this API to purge all harmonics data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_PURG
Python command syntax:
ierr = har_purg()
Fortran command syntax:
CALL HAR_PURG(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
1315
Harmonics HAR_READ
5.1.4. HAR_READ
Use this API to read Harmonics Data Text (.har) File into the working case memory.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_READ RFILE
Python command syntax:
ierr = har_read(rfile)
Fortran command syntax:
CALL HAR_READ(RFILE, IERR)
Where:
Character*260 RFILE Harmonics Data File name (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 error opening file
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
1316
Harmonics HAR_READX
5.1.5. HAR_READX
Use this API to read Harmonics Data XML (.xhar) File into the working case memory.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_READX RFILE
Python command syntax:
ierr = har_readx(rfile)
Fortran command syntax:
CALL HAR_READX(RFILE, IERR)
Where:
Character*260 RFILE Harmonics Data XML File name (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 error opening file
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
1317
Harmonics HAR_WRITE
5.1.6. HAR_WRITE
Use this API to write working case Harmonics Data to text (.har) file or report window.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_WRITE RFILE
Python command syntax:
ierr = har_write(rfile)
Fortran command syntax:
CALL HAR_WRITE(RFILE, IERR)
Where:
Character*260 RFILE Harmonics Data File name, when file name is not provided file creat-
ed in Report Window (input; blank).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 prerequisite requirements for API are not met
IERR = 2 no harmonics data in working case
IERR = 3 error opening file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1318
Harmonics HAR_WRITEX
5.1.7. HAR_WRITEX
Use this API to write working case Harmonics Data to XML (.xhar) file.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_WRITEX RFILE
Python command syntax:
ierr = har_writex(rfile)
Fortran command syntax:
CALL HAR_WRITEX(RFILE, IERR)
Where:
Character*260 RFILE Harmonics Data XML File name (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 prerequisite requirements for API are not met
IERR = 2 no harmonics data in working case
IERR = 3 error opening file
IERR = 4 rfile is blank
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1319
Harmonics HAR_WRITEX
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1320
Harmonics HAR_WRITEX
Harmonics Operation APIs contains API routines corresponding to the operational functions of the Harmonics
features of PSS®E.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1321
Harmonics Harmonics Data
5.2. Harmonics Data
5.2.1. HAR_2TDC
Use this API to modify or add new harmonics Two Terminal DC data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_2TDC NAME IBUS INTGAR(1) CHARAR(1) CHARAR(2)
Python command syntax:
ierr = har_2tdc(name,ibus,intgar,charar)
Fortran command syntax:
CALL HAR_2TDC(NAME,IBUS,INTGAR,CHARAR,IERR)
Where:
Character*12 NAME two term dc line name (input; no default allowed).
Integer IBUS rectifier or inverter bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Voltage Source Table Name
CHARAR(2) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1322
Harmonics HAR_2TDC_CHNG
5.2.2. HAR_2TDC_CHNG
Use this API to modify harmonics Two Terminal DC data in the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_2TDC_CHNG NAME IBUS INTGAR(1) CHARAR(1) CHARAR(2)
Python command syntax:
ierr = har_2tdc_chng(name,ibus,intgar,charar)
Fortran command syntax:
CALL HAR_2TDC_CHNG(NAME,IBUS,INTGAR,CHARAR,IERR)
Where:
Character*12 NAME two term dc line name (input; no default allowed).
Integer IBUS rectifier or inverter bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Voltage Source Table Name
CHARAR(2) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1323
Harmonics HAR_2TDC_PURG
5.2.3. HAR_2TDC_PURG
Use this API to purge specified harmonics Two Terminal DC data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_2TDC_PURG NAME IBUS
Python command syntax:
ierr = har_2tdc_purg(name, ibus)
Fortran command syntax:
CALL HAR_2TDC_PURG(NAME, IBUS, IERR)
Where:
Character*12 NAME two term dc line name (input; no default allowed).
Integer IBUS rectifier or inverter bus number (input; no default allowed).
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
1324
Harmonics HAR_BRN
5.2.4. HAR_BRN
Use this API to modify or add new harmonics branch data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_BRN IBUS JBUS CKT INTGAR(1)..INTGAR(2) REALAR(1) CHARAR(1)
Python command syntax:
ierr = har_brn(ibus,jbus,ckt,intgar,realar,charar)
Fortran command syntax:
CALL HAR_BRN(IBUS,JBUS,CKT,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT branch identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (1) array of 1 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
Integer IERR error code (output).
IERR = 0 no errors 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
1325
Harmonics HAR_BRN_CHNG
5.2.5. HAR_BRN_CHNG
Use this API to modify harmonics branch data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_BRN_CHNG IBUS JBUS CKT INTGAR(1)..INTGAR(2) REALAR(1) CHARAR(1)
Python command syntax:
ierr = har_brn_chng(ibus,jbus,ckt,intgar,realar,charar)
Fortran command syntax:
CALL HAR_BRN_CHNG(IBUS,JBUS,CKT,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT branch identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (1) array of 1 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
Integer IERR error code (output).
IERR = 0 no errors 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
1326
Harmonics HAR_BRN_PURG
5.2.6. HAR_BRN_PURG
Use this API to purge specified harmonics branch data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_BRN_PURG IBUS JBUS CKT
Python command syntax:
ierr = har_brn_purg(ibus,jbus,ckt)
Fortran command syntax:
CALL HAR_BRN_PURG(IBUS, JBUS, CKT, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Character*2 CKT circuit identifier (input; '1' by default).
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
1327
Harmonics HAR_CURSRC
5.2.7. HAR_CURSRC
Use this API to modify or add new harmonics current source table data to the working case. This API is used
to add new table of current and angle type data, harmonic numbers and corresponding I/I0 and Angle da-
ta points. This can be used to add a new data point of harmonic number, I/I0 and Angle data to existing ta-
ble. This can be used to change current and angle type data, I/I0 and Angle data points of existing harmon-
ic number in the table. This API cannot be used to change table name and harmonic numbers.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC NAME NPTS INTGAR(1) INTGAR(2) HAR(1)..HAR(NPTS)
IAR(1)..IAR(NPTS) ANAR(1)..ANAR(NPTS)
Python command syntax:
ierr = har_cursrc(name, npts, intgar, har, iar, anar)
Fortran command syntax:
CALL HAR_CURSRC(NAME, NPTS, INTGAR, HAR, IAR, ANAR, IERR)
Where:
Character*40 NAME Harmonics current Source Data table name (input; no default al-
lowed).
Integer NPTS number of data points specified in the table (input; no default al-
lowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) CRTYP, Harmonics current Source type (1 by
default)
INTGAR(2) ANTYP, Harmonics current Source angle type
(1 by default)
Real HAR (NPTS) array of 'NPTS' values specifying harmonic numbers. All the harmonic
numbers in HAR array must be non zero. (input).
Real IAR (NPTS) array of 'NPTS' values specifying current magnitude (input).
Real ANAR (NPTS) array of 'NPTS' values specifying angle (input).
Integer IERR error code (output).
IERR = 0 no errors 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
1328
Harmonics HAR_CURSRC_CHNG
5.2.8. HAR_CURSRC_CHNG
Use this API to change harmonics current source table data in the working case. This API is used to change
current and angle type data, I/I0 and Angle data points of existing harmonic number and existing table in
working case harmonics data. This API cannot be used to change table name and harmonic numbers. All
the harmonic numbers in HAR array must be non zero.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC_CHNG NAME NPTS INTGAR(1) INTGAR(2) HAR(1)..HAR(NPTS)
IAR(1)..IAR(NPTS) ANAR(1)..ANAR(NPTS)
Python command syntax:
ierr = har_cursrc_chng(name, npts, intgar, har, iar, anar)
Fortran command syntax:
CALL HAR_CURSRC_CHNG(NAME, NPTS, INTGAR, HAR, IAR, ANAR, IERR)
Where:
Character*40 NAME Harmonics current Source Data table name (input; no default al-
lowed).
Integer NPTS number of data points specified in the table (input; no default al-
lowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) CRTYP, Harmonics current Source type (1 by
default)
INTGAR(2) ANTYP, Harmonics current Source angle type
(1 by default)
Real HAR (NPTS) array of 'NPTS' values specifying harmonic numbers. All the harmonic
numbers in HAR array must be non zero. (input).
Real IAR (NPTS) array of 'NPTS' values specifying current magnitude (input).
Real ANAR (NPTS) array of 'NPTS' values specifying angle (input).
Integer IERR error code (output).
IERR = 0 no errors 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
1329
Harmonics HAR_CURSRC_CHNG_NAME
5.2.9. HAR_CURSRC_CHNG_NAME
Use this API to change harmonics current source table name in the working case. This API is used to
change table name from working case harmonics data. NAMNEW must not exist in working case har-
monics data. NAME must be provided and it must exist in working case harmonics data, then table name
changed from NAME to NAMNEW.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC_CHNG_NAME 'NAME' 'NAMNEW' INTGAR
Python command syntax:
ierr = har_cursrc_chng_name(name, namnew, intgar)
Fortran command syntax:
CALL HAR_CURSRC_CHNG_NAME(NAME, NAMNEW, INTGAR, IERR)
Where:
Character*40 NAME Harmonics current Source table name whose name is to be changed.
NAME must be provided and it must exist in working case harmonics
data. (input; no default allowed).
Character*40 NAMNEW New Harmonics current Source table name to be assigned. NAMNEW
must not exist in working case harmonics data. (input; no default al-
lowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) CRTYP, Harmonics current Source type (1 by
default)
INTGAR(2) ANTYP, Harmonics current Source angle type
(1 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1330
Harmonics HAR_CURSRC_CHNG_ONEPT
5.2.10. HAR_CURSRC_CHNG_ONEPT
Use this API to modify one data point to harmonics current source table in the working case. This API is
used to change H, I/I0, and Angle data of existing harmonic number (HPTOLD) in the existing working case
harmonics data table. This API cannot be used to change table name.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC_CHNG_ONEPT NAME HPTOLD HPT IPT ANPT
Python command syntax:
ierr = har_cursrc_chng_onept(name, hptold, hpt, ipt, anpt)
Fortran command syntax:
CALL HAR_CURSRC_CHNG_ONEPT(NAME, HPTOLD, HPT, IPT, ANPT, IERR)
Where:
Character*40 NAME Harmonics current Source Data table name (input; no default al-
lowed).
Real HPTOLD Harmonics number at point in data table where provided data is
changed (input; no default allowed).
Real HPT New Harmonics number to be changed (input; 1 by default).
Real IPT current Source magnitude for harmonics number HPT to be changed
(input; 1 by default).
Real ANPT current Source angle for harmonics number HPT to be changed (in-
put; 1 by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1331
Harmonics HAR_CURSRC_NAME
5.2.11. HAR_CURSRC_NAME
Use this API to add or change harmonics current source table name in the working case. This API is used to
add new table name with no harmonics data points or change table name from working case harmonics
data.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC_CHNG_NAME 'NAME' 'NAMNEW' INTGAR
Python command syntax:
ierr = har_cursrc_name(name, namnew, intgar)
Fortran command syntax:
CALL HAR_CURSRC_NAME(NAME, NAMNEW, INTGAR, IERR)
Where:
Character*40 NAME Harmonics current Source table name whose name is to be changed.
When NAME is provided, it must exist in working case harmonics da-
ta, then table name changed from NAME to NAMNEW. If NAME is
blank, a new table NAMNEW will be added with no harmonics data
points. (input; '' by default).
Character*40 NAMNEW New Harmonics current Source table name to be assigned. NAMNEW
must not exist in working case harmonics data. (input; no default al-
lowed).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) CRTYP, Harmonics current Source type (1 by
default)
INTGAR(2) ANTYP, Harmonics current Source angle type
(1 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1332
Harmonics HAR_CURSRC_ONEPT
5.2.12. HAR_CURSRC_ONEPT
Use this API to modify or add new one data point to harmonics current source table in the working case.
This API is used to add one new data point of H, I/I0, and Angle data to existing table of existing working
case harmonics data. This can be used to change H, V/V0, and Angle data points of existing harmonic num-
ber in the table. This API cannot be used to change table name.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC_ONEPT NAME HPTOLD HPT IPT ANPT
Python command syntax:
ierr = har_cursrc_onept(name, hptold, hpt, ipt, anpt)
Fortran command syntax:
CALL HAR_CURSRC_ONEPT(NAME, HPTOLD, HPT, IPT, ANPT, IERR)
Where:
Character*40 NAME Harmonics current Source Data table name (input; no default al-
lowed).
Real HPTOLD Harmonics number at point in data table where provided data is
added or changed. When HPTOLD is specified and found, the H, I/
I0, and Angle values specified will be used to change existing data.
When HPTOLD is zero, the H, I/I0, and Angle values specified will be
used to add data point to existing data. (input; no default allowed).
Real HPT New Harmonics number to be added or changed at specified data
point (input; no default allowed).
Real IPT current Source magnitude for harmonics number HPT to be added or
changed (input; 1 by default).
Real ANPT current source angle for harmonics number HPT to be added or
changed (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1333
Harmonics HAR_CURSRC_PURG
5.2.13. HAR_CURSRC_PURG
Use this API to purge specified harmonics current source table data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC_PURG NAME
Python command syntax:
ierr = har_cursrc_purg(name)
Fortran command syntax:
CALL HAR_CURSRC_PURG(NAME, IERR)
Where:
Character*40 NAME Harmonics current source table name (input; no default allowed).
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
1334
Harmonics HAR_CURSRC_PURG_ONEPT
5.2.14. HAR_CURSRC_PURG_ONEPT
Use this API to purge specified data point in harmonics current source table.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_CURSRC_PURG_ONEPT NAME HPT
Python command syntax:
ierr = har_cursrc_purg_onept(name, hpt)
Fortran command syntax:
CALL HAR_CURSRC_PURG_ONEPT(NAME, HPT, IERR)
Where:
Character*40 NAME Harmonics current source table name (input; no default allowed).
Real HPT Harmonic number (H) at a point in data table where H, R/R0, L/) and
C/C0 data is purged (input; no default allowed).
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
1335
Harmonics HAR_FACTS
5.2.15. HAR_FACTS
Use this API to modify or add new harmonics FACTS device data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_FACTS NAME SENDBUS SENDBUS INTGAR(1) INTGAR(2) CHARAR(1) CHARAR(2)
CHARAR(3)
Python command syntax:
ierr = har_facts(name,sendbus,termbus,intgar,realar,charar)
Fortran command syntax:
CALL HAR_FACTS(NAME,SENDBUS,TERMBUS,INTGAR,REALAR,CHARAR,IERR)
Where:
Character*12 NAME FACTS device name (input; no default allowed).
Integer SENDBUS FACTS Device sending bus number (input; no default allowed).
Integer TERMBUS FACTS Device terminal bus number (input; 0 by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics State (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1336
Harmonics HAR_FACTS_CHNG
5.2.16. HAR_FACTS_CHNG
Use this API to modify harmonics FACTS device data in the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_FACTS_CHNG NAME SENDBUS SENDBUS INTGAR(1) INTGAR(2) CHARAR(1)
CHARAR(2) CHARAR(3)
Python command syntax:
ierr = har_facts_chng(name,sendbus,termbus,intgar,realar,charar)
Fortran command syntax:
CALL HAR_FACTS_CHNG(NAME,SENDBUS,TERMBUS,INTGAR,REALAR,CHARAR,IERR)
Where:
Character*12 NAME FACTS device name (input; no default allowed).
Integer SENDBUS FACTS Device sending bus number (input; no default allowed).
Integer TERMBUS FACTS Device terminal bus number (input; 0 by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics State (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1337
Harmonics HAR_FACTS_PURG
5.2.17. HAR_FACTS_PURG
Use this API to purge specified harmonics FACTS device data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_FACTS_PURG NAME SENDBUS TERMBUS
Python command syntax:
ierr = har_facts_purg(name,sendbus,termbus)
Fortran command syntax:
CALL HAR_FACTS_PURG(NAME,SENDBUS,TERMBUS,IERR)
Where:
Character*12 NAME FACTS device name (input; no default allowed).
Integer SENDBUS FACTS Device sending bus number (input; no default allowed).
Integer TERMBUS FACTS Device terminal bus number (input; 0 by default).
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
1338
Harmonics HAR_IMPCHAR
5.2.18. HAR_IMPCHAR
Use this API to modify or add new harmonics impedance characteristics table data to the working case.
This API is used to add new table of harmonic numbers and corresponding R/R0, L/L0 and C/C0 data points.
This can be used to add a new data point of harmonic number, R/R0, L/L0 and C/C0 data to existing table.
This can be used to change R/R0, L/L0 and C/C0 data points of existing harmonic number in the table. This
API cannot be used to change table name and harmonic numbers.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR NAME NPTS HAR(1)..HAR(NPTS) RAR(1)..RAR(NPTS)
LAR(1)..LAR(NPTS) CAR(1)..CAR(NPTS)
Python command syntax:
ierr = har_impchar(name, npts, har, rar, lar, car)
Fortran command syntax:
CALL HAR_IMPCHAR(NAME, NPTS, HAR, RAR, LAR, CAR, IERR)
Where:
Character*40 NAME Harmonics Impedance Characteristics Data table name (input; no de-
fault allowed).
Integer NPTS number of data points specified in the table (input; no default al-
lowed).
Real HAR (NPTS) array of 'NPTS' values specifying harmonic numbers. All the harmonic
numbers in HAR array must be non zero. (input).
Real RAR (NPTS) array of 'NPTS' values specifying R/R0 ratio (input).
Real LAR (NPTS) array of 'NPTS' values specifying L/L0 ratio (input).
Real CAR (NPTS) array of 'NPTS' values specifying C/C0 ratio (input).
Integer IERR error code (output).
IERR = 0 no errors 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
1339
Harmonics HAR_IMPCHAR_CHNG
5.2.19. HAR_IMPCHAR_CHNG
Use this API to change harmonics impedance characteristics table data in the working case. This API is used
to change R/R0, L/L0 and C/C0 data points of existing harmonic number and existing table in working case
harmonics data. This API cannot be used to change table name and harmonic numbers. All the harmonic
numbers in HAR array must be non zero.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR_CHNG NAME NPTS HAR(1)..HAR(NPTS) RAR(1)..RAR(NPTS)
LAR(1)..LAR(NPTS) CAR(1)..CAR(NPTS)
Python command syntax:
ierr = har_impchar_chng(name, npts, har, rar, lar, car)
Fortran command syntax:
CALL HAR_IMPCHAR_CHNG(NAME, NPTS, HAR, RAR, LAR, CAR, IERR)
Where:
Character*40 NAME Harmonics Impedance Characteristics Data table name (input; no de-
fault allowed).
Integer NPTS number of data points specified in the table (input; no default al-
lowed).
Real HAR (NPTS) array of 'NPTS' values specifying harmonic numbers. All the harmonic
numbers in HAR array must be non zero. (input).
Real RAR (NPTS) array of 'NPTS' values specifying R/R0 ratio (input).
Real LAR (NPTS) array of 'NPTS' values specifying L/L0 ratio (input).
Real CAR (NPTS) array of 'NPTS' values specifying C/C0 ratio (input).
Integer IERR error code (output).
IERR = 0 no errors 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
1340
Harmonics HAR_IMPCHAR_CHNG_NAME
5.2.20. HAR_IMPCHAR_CHNG_NAME
Use this API to change harmonics impedance characteristics table name in the working case. This API is
used to change table name from working case harmonics data. NAMNEW must not exist in working case
harmonics data. NAME must be provided and it must exist in working case harmonics data, then table
name changed from NAME to NAMNEW.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR_CHNG_NAME 'NAME' 'NAMNEW'
Python command syntax:
ierr = har_impchar_chng_name(name, namnew)
Fortran command syntax:
CALL HAR_IMPCHAR_CHNG_NAME(NAME, NAMNEW, IERR)
Where:
Character*40 NAME Harmonics impedance characteristics table name whose name is to
be changed. NAME must be provided and it must exist in working
case harmonics data. (input; no default allowed).
Character*40 NAMNEW New Harmonics Impedance Characteristics table name to be as-
signed. NAMNEW must not exist in working case harmonics data. (in-
put; no default allowed).
Integer IERR error code (output).
IERR = 0 no errors 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
1341
Harmonics HAR_IMPCHAR_CHNG_ONEPT
5.2.21. HAR_IMPCHAR_CHNG_ONEPT
Use this API to modify one data point to harmonics impedance characteristics table in the working case.
This API is used to change H, R/R0, L/L0 and C/C0 data of existing harmonic number (HPTOLD) in the exist-
ing working case harmonics data table. This API cannot be used to change table name.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR_CHNG_ONEPT NAME HPTOLD HPT RPT LPT CPT
Python command syntax:
ierr = har_impchar_chng_onept(name, hptold, hpt, rpt, lpt, cpt)
Fortran command syntax:
CALL HAR_IMPCHAR_CHNG_ONEPT(NAME, HPTOLD, HPT, RPT, LPT, CPT, IERR)
Where:
Character*40 NAME Harmonics Impedance Characteristics Data table name (input; no de-
fault allowed).
Real HPTOLD Harmonics number at point in data table where provided data is
changed (input; no default allowed).
Real HPT New Harmonics number to be changed (input; 1 by default).
Real RPT Impedance characteristics R/R0 for harmonics number HPT to be
changed (input; 1 by default).
Real LPT Impedance characteristics L/L0 for harmonics number HPT to be
changed (input; 1 by default).
Real CPT Impedance characteristics C/C0 for harmonics number HPT to be
changed (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1342
Harmonics HAR_IMPCHAR_NAME
5.2.22. HAR_IMPCHAR_NAME
Use this API to add or change harmonics impedance characteristics table name in the working case. This
API is used to add new table name with no harmonics data points or change table name from working case
harmonics data.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR_CHNG_NAME 'NAME' 'NAMNEW'
Python command syntax:
ierr = har_impchar_name(name, namnew)
Fortran command syntax:
CALL HAR_IMPCHAR_NAME(NAME, NAMNEW, IERR)
Where:
Character*40 NAME Harmonics Impedance Characteristics table name whose name is to
be changed. When NAME is provided, it must exist in working case
harmonics data, then table name changed from NAME to NAMNEW.
If NAME is blank, a new table NAMNEW will be added with no har-
monics data points. (input; '' by default).
Character*40 NAMNEW New Harmonics Impedance Characteristics table name to be as-
signed. NAMNEW must not exist in working case harmonics data. (in-
put; no default allowed).
Integer IERR error code (output).
IERR = 0 no errors 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
1343
Harmonics HAR_IMPCHAR_ONEPT
5.2.23. HAR_IMPCHAR_ONEPT
Use this API to modify or add new one data point to harmonics impedance characteristics table in the
working case. This API is used to add one new data point of H, R/R0, L/L0 and C/C0 data to existing table of
existing working case harmonics data. This can be used to change H, R/R0, L/L0 and C/C0 data points of ex-
isting harmonic number in the table. This API cannot be used to change table name.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR_ONEPT NAME HPTOLD HPT RPT LPT CPT
Python command syntax:
ierr = har_impchar_onept(name, hptold, hpt, rpt, lpt, cpt)
Fortran command syntax:
CALL HAR_IMPCHAR_ONEPT(NAME, HPTOLD, HPT, RPT, LPT, CPT, IERR)
Where:
Character*40 NAME Harmonics Impedance Characteristics Data table name (input; no de-
fault allowed).
Real HPTOLD Harmonics number at point in data table where provided data is
added or changed. When HPTOLD is specified and found, the H, R/
R0, L/L0 and C/C0 values specified will be used to change existing da-
ta. When HPTOLD is zero, the H, R/R0, L/L0 and C/C0 values specified
will be used to add data point to existing data. (input; no default al-
lowed).
Real HPT New Harmonics number to be added or changed at specified data
point (input; no default allowed).
Real RPT Impedance characteristics R/R0 for harmonics number HPT to be
added or changed (input; 1 by default).
Real LPT Impedance characteristics L/L0 for harmonics number HPT to be
added or changed (input; 1 by default).
Real CPT Impedance characteristics C/C0 for harmonics number HPT to be
added or changed (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1344
Harmonics HAR_IMPCHAR_PURG
5.2.24. HAR_IMPCHAR_PURG
Use this API to purge specified harmonics impedance characteristics table data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR_PURG NAME
Python command syntax:
ierr = har_impchar_purg(name)
Fortran command syntax:
CALL HAR_IMPCHAR_PURG(NAME, IERR)
Where:
Character*40 NAME Harmonics impedance characteristics table name (input; no default
allowed).
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
1345
Harmonics HAR_IMPCHAR_PURG_ONEPT
5.2.25. HAR_IMPCHAR_PURG_ONEPT
Use this API to purge specified data point in harmonics impedance characteristics table.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_IMPCHAR_PURG_ONEPT NAME HPT
Python command syntax:
ierr = har_impchar_purg_onept(name, hpt)
Fortran command syntax:
CALL HAR_IMPCHAR_PURG_ONEPT(NAME, HPT, IERR)
Where:
Character*40 NAME Harmonics impedance characteristics table name (input; no default
allowed).
Real HPT Harmonic number (H) at a point in data table where H, R/R0, L/) and
C/C0 data is purged (input; no default allowed).
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
1346
Harmonics HAR_INDMC
5.2.26. HAR_INDMC
Use this API to modify or add new harmonics induction machine data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_INDMC IBUS ID INTGAR(1)..INTGAR(2) REALAR(1) CHARAR(1)..CHARAR(3)
Python command syntax:
ierr = har_indmc(ibus,id,intgar,realar,charar)
Fortran command syntax:
CALL HAR_INDMC(IBUS,ID,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID induction machine identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1347
Harmonics HAR_INDMC_CHNG
5.2.27. HAR_INDMC_CHNG
Use this API to modify harmonics induction machine data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_INDMC_CHNG IBUS ID INTGAR(1)..INTGAR(2) REALAR(1)
CHARAR(1)..CHARAR(3)
Python command syntax:
ierr = har_indmc_chng(ibus,id,intgar,realar,charar)
Fortran command syntax:
CALL HAR_INDMC_CHNG(IBUS,ID,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID induction machine identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1348
Harmonics HAR_INDMC_PURG
5.2.28. HAR_INDMC_PURG
Use this API to purge specified harmonics induction machine data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_INDMC_PURG IBUS ID
Python command syntax:
ierr = har_indmc_purg(ibus,id)
Fortran command syntax:
CALL HAR_INDMC_PURG(IBUS, ID, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID induction machine identifier (input; '1' by default).
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
1349
Harmonics HAR_LOAD
5.2.29. HAR_LOAD
Use this API to modify or add new harmonics load data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_LOAD IBUS ID INTGAR(1)..INTGAR(2) REALAR(1) CHARAR(1)..CHARAR(3)
Python command syntax:
ierr = har_load(ibus,id,intgar,realar,charar)
Fortran command syntax:
CALL HAR_LOAD(IBUS,ID,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1350
Harmonics HAR_LOAD_CHNG
5.2.30. HAR_LOAD_CHNG
Use this API to modify harmonics load data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_LOAD_CHNG IBUS ID INTGAR(1)..INTGAR(2) REALAR(1)
CHARAR(1)..CHARAR(3)
Python command syntax:
ierr = har_load_chng(ibus,id,intgar,realar,charar)
Fortran command syntax:
CALL HAR_LOAD_CHNG(IBUS,ID,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1351
Harmonics HAR_LOAD_PURG
5.2.31. HAR_LOAD_PURG
Use this API to purge specified harmonics load data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_LOAD_PURG IBUS ID
Python command syntax:
ierr = har_load_purg(ibus,id)
Fortran command syntax:
CALL HAR_LOAD_PURG(IBUS, ID, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
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
1352
Harmonics HAR_MACH
5.2.32. HAR_MACH
Use this API to modify or add new harmonics machine data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_MACH IBUS ID INTGAR(1)..INTGAR(2) REALAR(1) CHARAR(1)..CHARAR(3)
Python command syntax:
ierr = har_mach(ibus,id,intgar,realar,charar)
Fortran command syntax:
CALL HAR_MACH(IBUS,ID,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1353
Harmonics HAR_MACH_CHNG
5.2.33. HAR_MACH_CHNG
Use this API to modify harmonics machine data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_MACH_CHNG IBUS ID INTGAR(1)..INTGAR(2) REALAR(1)
CHARAR(1)..CHARAR(3)
Python command syntax:
ierr = har_mach_chng(ibus,id,intgar,realar,charar)
Fortran command syntax:
CALL HAR_MACH_CHNG(IBUS,ID,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (3) array of 3 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Voltage Source Table Name
CHARAR(3) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1354
Harmonics HAR_MACH_PURG
5.2.34. HAR_MACH_PURG
Use this API to purge specified harmonics machine data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_MACH_PURG IBUS ID
Python command syntax:
ierr = har_mach_purg(ibus,id)
Fortran command syntax:
CALL HAR_MACH_PURG(IBUS, ID, IERR)
Where:
Integer IBUS bus number (input; no default allowed).
Character*2 ID mach identifier (input; '1' by default).
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
1355
Harmonics HAR_MTDC
5.2.35. HAR_MTDC
Use this API to modify or add new harmonics Multi Terminal DC data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_MTDC NAME IBUS INTGAR(1) CHARAR(1) CHARAR(2)
Python command syntax:
ierr = har_mtdc(name,ibus,intgar,charar)
Fortran command syntax:
CALL HAR_MTDC(NAME,IBUS,INTGAR,CHARAR,IERR)
Where:
Character*12 NAME multi term dc line name (input; no default allowed).
Integer IBUS converter bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Voltage Source Table Name
CHARAR(2) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1356
Harmonics HAR_MTDC_CHNG
5.2.36. HAR_MTDC_CHNG
Use this API to modify harmonics Multi Terminal DC data in the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_MTDC_CHNG NAME IBUS INTGAR(1) CHARAR(1) CHARAR(2)
Python command syntax:
ierr = har_mtdc_chng(name,ibus,intgar,charar)
Fortran command syntax:
CALL HAR_MTDC_CHNG(NAME,IBUS,INTGAR,CHARAR,IERR)
Where:
Character*12 NAME multi term dc line name (input; no default allowed).
Integer IBUS converter bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Voltage Source Table Name
CHARAR(2) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1357
Harmonics HAR_MTDC_PURG
5.2.37. HAR_MTDC_PURG
Use this API to purge specified harmonics Multi Terminal DC data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_MTDC_PURG NAME IBUS
Python command syntax:
ierr = har_mtdc_purg(name, ibus)
Fortran command syntax:
CALL HAR_MTDC_PURG(NAME, IBUS, IERR)
Where:
Character*12 NAME multi term dc line name (input; no default allowed).
Integer IBUS converter bus number (input; no default allowed).
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
1358
Harmonics HAR_TRN
5.2.38. HAR_TRN
Use this API to modify or add new harmonics transformer data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_TRN IBUS JBUS KBUS CKT INTGAR(1)..INTGAR(2) REALAR(1)
CHARAR(1)..CHARAR(2)
Python command syntax:
ierr = har_trn(ibus,jbus,kbus,ckt,intgar,realar,charar)
Fortran command syntax:
CALL HAR_TRN(IBUS,JBUS,KBUS,CKT,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Integer KBUS bus number of third bus (input; 0 by default).
Character*2 CKT transformer identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Current Source Name
Integer IERR error code (output).
IERR = 0 no errors 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
1359
Harmonics HAR_TRN_CHNG
5.2.39. HAR_TRN_CHNG
Use this API to modify harmonics transformer data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_TRN_CHNG IBUS JBUS KBUS CKT INTGAR(1)..INTGAR(2) REALAR(1)
CHARAR(1)..CHARAR(2)
Python command syntax:
ierr = har_trn_chng(ibus,jbus,kbus,ckt,intgar,realar,charar)
Fortran command syntax:
CALL HAR_TRN_CHNG(IBUS,JBUS,KBUS,CKT,INTGAR,REALAR,CHARAR,IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Integer KBUS bus number of third bus (input; 0 by default).
Character*2 CKT transformer identifier (input; '1' by default).
Integer INTGAR (2) array of 2 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
INTGAR(2) Harmonics Type (1 by default)
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Harmonics Quality (1.0 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Impedance Characteristics Name
CHARAR(2) Harmonics Current Source Name
Integer IERR error code (output).
IERR = 0 no errors 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
1360
Harmonics HAR_TRN_PURG
5.2.40. HAR_TRN_PURG
Use this API to purge specified harmonics transformer data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_TRN_PURG IBUS JBUS KBUS CKT
Python command syntax:
ierr = har_trn_purg(ibus,jbus,kbus,ckt)
Fortran command syntax:
CALL HAR_TRN_PURG(IBUS, JBUS, KBUS, CKT, IERR)
Where:
Integer IBUS bus number of from bus (input; no default allowed).
Integer JBUS bus number of to bus (input; no default allowed).
Integer KBUS bus number of third bus (input; 0 by default).
Character*2 CKT circuit identifier (input; '1' by default).
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
1361
Harmonics HAR_VLTSRC
5.2.41. HAR_VLTSRC
Use this API to modify or add new harmonics voltage source table data to the working case. This API is
used to add new table of angle type data, harmonic numbers and corresponding V/V0 and Angle data
points. This can be used to add a new data point of harmonic number, V/V0 and Angle data to existing ta-
ble. This can be used to change angle type data, V/V0 and Angle data points of existing harmonic number
in the table. This API cannot be used to change table name and harmonic numbers.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC NAME NPTS INTGAR(1) HAR(1)..HAR(NPTS) VAR(1)..VAR(NPTS)
ANAR(1)..ANAR(NPTS)
Python command syntax:
ierr = har_vltsrc(name, npts, intgar, har, var, anar)
Fortran command syntax:
CALL HAR_VLTSRC(NAME, NPTS, INTGAR, HAR, VAR, ANAR, IERR)
Where:
Character*40 NAME Harmonics Voltage Source Data table name (input; no default al-
lowed).
Integer NPTS number of data points specified in the table (input; no default al-
lowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) ANTYP, Harmonics Voltage Source angle type
(1 by default)
Real HAR (NPTS) array of 'NPTS' values specifying harmonic numbers. All the harmonic
numbers in HAR array must be non zero. (input).
Real VAR (NPTS) array of 'NPTS' values specifying R/R0 ratio (input).
Real ANAR (NPTS) array of 'NPTS' values specifying L/L0 ratio (input).
Integer IERR error code (output).
IERR = 0 no errors 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
1362
Harmonics HAR_VLTSRC_CHNG
5.2.42. HAR_VLTSRC_CHNG
Use this API to change harmonics voltage source table data in the working case. This API is used to change
angle type data, V/V0 and Angle data points of existing harmonic number and existing table in working
case harmonics data. This API cannot be used to change table name and harmonic numbers. All the har-
monic numbers in HAR array must be non zero.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC_CHNG NAME NPTS INTGAR(1) HAR(1)..HAR(NPTS)
VAR(1)..VAR(NPTS) ANAR(1)..ANAR(NPTS)
Python command syntax:
ierr = har_vltsrc_chng(name, npts, intgar, har, var, anar)
Fortran command syntax:
CALL HAR_VLTSRC_CHNG(NAME, NPTS, INTGAR, HAR, VAR, ANAR, IERR)
Where:
Character*40 NAME Harmonics Voltage Source Data table name (input; no default al-
lowed).
Integer NPTS number of data points specified in the table (input; no default al-
lowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) ANTYP, Harmonics Voltage Source angle type
(1 by default)
Real HAR (NPTS) array of 'NPTS' values specifying harmonic numbers. All the harmonic
numbers in HAR array must be non zero. (input).
Real VAR (NPTS) array of 'NPTS' values specifying magnitude (input).
Real ANAR (NPTS) array of 'NPTS' values specifying angle (input).
Integer IERR error code (output).
IERR = 0 no errors 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
1363
Harmonics HAR_VLTSRC_CHNG_NAME
5.2.43. HAR_VLTSRC_CHNG_NAME
Use this API to change harmonics voltage source table name in the working case. This API is used to
change table name from working case harmonics data. NAMNEW must not exist in working case har-
monics data. NAME must be provided and it must exist in working case harmonics data, then table name
changed from NAME to NAMNEW.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC_CHNG_NAME 'NAME' 'NAMNEW' INTGAR
Python command syntax:
ierr = har_vltsrc_chng_name(name, namnew, intgar)
Fortran command syntax:
CALL HAR_VLTSRC_CHNG_NAME(NAME, NAMNEW, INTGAR, IERR)
Where:
Character*40 NAME Harmonics Voltage Source table name whose name is to be changed.
NAME must be provided and it must exist in working case harmonics
data. (input; no default allowed).
Character*40 NAMNEW New Harmonics Voltage Source table name to be assigned. NAMNEW
must not exist in working case harmonics data. (input; no default al-
lowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) ANTYP, Harmonics Voltage Source angle type
(1 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1364
Harmonics HAR_VLTSRC_CHNG_ONEPT
5.2.44. HAR_VLTSRC_CHNG_ONEPT
Use this API to modify one data point to harmonics voltage source table in the working case. This API is
used to change H, V/V0, and Angle data of existing harmonic number (HPTOLD) in the existing working
case harmonics data table. This API cannot be used to change table name.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC_CHNG_ONEPT NAME HPTOLD HPT VPT ANPT
Python command syntax:
ierr = har_vltsrc_chng_onept(name, hptold, hpt, vpt, anpt)
Fortran command syntax:
CALL HAR_VLTSRC_CHNG_ONEPT(NAME, HPTOLD, HPT, VPT, ANPT, IERR)
Where:
Character*40 NAME Harmonics Voltage Source Data table name (input; no default al-
lowed).
Real HPTOLD Harmonics number at point in data table where provided data is
changed (input; no default allowed).
Real HPT New Harmonics number to be changed (input; no default allowed).
Real VPT Voltage Source magnitude for harmonics number HPT to be changed
(input; 1 by default).
Real ANPT Voltage Source angle for harmonics number HPT to be changed (in-
put; 1 by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1365
Harmonics HAR_VLTSRC_NAME
5.2.45. HAR_VLTSRC_NAME
Use this API to add or change harmonics voltage source table name in the working case. This API is used to
add new table name with no harmonics data points or change table name from working case harmonics
data.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC_CHNG_NAME 'NAME' 'NAMNEW' INTGAR
Python command syntax:
ierr = har_vltsrc_name(name, namnew, intgar)
Fortran command syntax:
CALL HAR_VLTSRC_NAME(NAME, NAMNEW, INTGAR, IERR)
Where:
Character*40 NAME Harmonics Voltage Source table name whose name is to be changed.
When NAME is provided, it must exist in working case harmonics da-
ta, then table name changed from NAME to NAMNEW. If NAME is
blank, a new table NAMNEW will be added with no harmonics data
points. (input; '' by default).
Character*40 NAMNEW New Harmonics Voltage Source table name to be assigned. NAMNEW
must not exist in working case harmonics data. (input; no default al-
lowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) ANTYP, Harmonics Voltage Source angle type
(1 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1366
Harmonics HAR_VLTSRC_ONEPT
5.2.46. HAR_VLTSRC_ONEPT
Use this API to modify or add new one data point to harmonics voltage source table in the working case.
This API is used to add one new data point of H, V/V0, and Angle data to existing table of existing working
case harmonics data. This can be used to change H, V/V0, and Angle data points of existing harmonic num-
ber in the table. This API cannot be used to change table name.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC_ONEPT NAME HPTOLD HPT VPT ANPT
Python command syntax:
ierr = har_vltsrc_onept(name, hptold, hpt, vpt, anpt)
Fortran command syntax:
CALL HAR_VLTSRC_ONEPT(NAME, HPTOLD, HPT, VPT, ANPT, IERR)
Where:
Character*40 NAME Harmonics Voltage Source Data table name (input; no default al-
lowed).
Real HPTOLD Harmonics number at point in data table where provided data is
added or changed. When HPTOLD is specified and found, the H, V/
V0, and Angle values specified will be used to change existing data.
When HPTOLD is zero, the H, V/V0, and Angle values specified will be
used to add data point to existing data. (input; no default allowed).
Real HPT New Harmonics number to be added or changed at specified data
point (input; no default allowed).
Real VPT Voltage Source magnitude for harmonics number HPT to be added or
changed (input; 1 by default).
Real ANPT Voltage Source angle for harmonics number HPT to be added or
changed (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1367
Harmonics HAR_VLTSRC_PURG
5.2.47. HAR_VLTSRC_PURG
Use this API to purge specified harmonics voltage source table data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC_PURG NAME
Python command syntax:
ierr = har_vltsrc_purg(name)
Fortran command syntax:
CALL HAR_VLTSRC_PURG(NAME, IERR)
Where:
Character*40 NAME Harmonics voltage source table name (input; no default allowed).
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
1368
Harmonics HAR_VLTSRC_PURG_ONEPT
5.2.48. HAR_VLTSRC_PURG_ONEPT
Use this API to purge specified data point in harmonics voltage source table.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VLTSRC_PURG_ONEPT NAME HPT
Python command syntax:
ierr = har_vltsrc_purg_onept(name, hpt)
Fortran command syntax:
CALL HAR_VLTSRC_PURG_ONEPT(NAME, HPT, IERR)
Where:
Character*40 NAME Harmonics voltage source table name (input; no default allowed).
Real HPT Harmonic number (H) at a point in data table where H, magnitude,
L/) and C/C0 data is purged (input; no default allowed).
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
1369
Harmonics HAR_VSCDC
5.2.49. HAR_VSCDC
Use this API to modify or add new harmonics VSCDC data to the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VSCDC NAME IBUS INTGAR(1) CHARAR(1) CHARAR(2)
Python command syntax:
ierr = har_vscdc(name,ibus,intgar,charar)
Fortran command syntax:
CALL HAR_VSCDC(NAME,IBUS,INTGAR,CHARAR,IERR)
Where:
Character*12 NAME VSC DC line name (input; no default allowed).
Integer IBUS converter bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Voltage Source Table Name
CHARAR(2) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1370
Harmonics HAR_VSCDC_CHNG
5.2.50. HAR_VSCDC_CHNG
Use this API to modify harmonics VSCDC data in the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VSCDC_CHNG NAME IBUS INTGAR(1) CHARAR(1) CHARAR(2)
Python command syntax:
ierr = har_vscdc_chng(name,ibus,intgar,charar)
Fortran command syntax:
CALL HAR_VSCDC_CHNG(NAME,IBUS,INTGAR,CHARAR,IERR)
Where:
Character*12 NAME VSC DC line name (input; no default allowed).
Integer IBUS converter bus number (input; no default allowed).
Integer INTGAR (1) array of 1 elements specifying (input).
INTGAR(1) Harmonics Mode (1 by default)
Character*40 CHARAR (2) array of 2 elements specifying (input).
CHARAR(1) Harmonics Voltage Source Table Name
CHARAR(2) Harmonics Current Source Table Name
Integer IERR error code (output).
IERR = 0 no errors 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
1371
Harmonics HAR_VSCDC_PURG
5.2.51. HAR_VSCDC_PURG
Use this API to purge specified harmonics VSCDC data from the working case.
This API routine was first introduced in release 34.4.0.
Batch command syntax:
BAT_HAR_VSCDC_PURG NAME IBUS
Python command syntax:
ierr = har_vscdc_purg(name, ibus)
Fortran command syntax:
CALL HAR_VSCDC_PURG(NAME, IBUS, IERR)
Where:
Character*12 NAME VSC DC line name (input; no default allowed).
Integer IBUS converter bus number (input; no default allowed).
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
1372
Harmonics HAR_VSCDC_PURG
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1373
Harmonics HAR_VSCDC_PURG
Harmonics Data Changing APIs contains API routines specific to adding, modifying, and deleting Harmonics
data.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1374
Chapter 6
GIC
This chapter describes the API routines used in PSS®E GIC.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1375
GIC GIC Operation
6.1. GIC Operation
6.1.1. GIC
This API routine is obsolete. It has been replaced by the API routine gic_2 .
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 32.2.0 and 33.3.0.
Batch command syntax:
BAT_GIC SID ALL APIOPTNS(1)..APIOPTNS(4) VALUES(1)..VALUES(5)
RPTOPTNS(1)..RPTOPTNS(7) GICDATAFIL GICADDFIL GICPURGFIL GICRNWKFIL
Python command syntax:
ierr = gic(sid, all, apioptns, values, rptoptns, gicdatafil, gicaddfil,
gicpurgfil, gicrnwkfil)
Fortran command syntax:
CALL GIC(SID, ALL, APIOPTNS, VALUES, RPTOPTNS, GICDATAFIL, GICADDFIL,
GICPURGFIL, GICRNWKFIL, 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 APIOPTNS (4) array of 4 elements specifying Integer Options(input).
APIOPTNS(1) Electric Field Type (alias is efield_type) (0 by
default)
APIOPTNS(1) = 0 for uniform geoelectric field
APIOPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (0 by default)
APIOPTNS(2) = 0 for volts/km
APIOPTNS(2) = 1 for volts/mile
APIOPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (1 by default)
APIOPTNS(3) = 0 add updates to Saved Case
APIOPTNS(3) = 1 create RDCH raw file of GIC updates
APIOPTNS(4) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1376
GIC GIC
APIOPTNS(4) = 0 consider only study subsystem buses, no
buses from inter-ties
APIOPTNS(4) > 0 consider only study subsystem buses, no
buses from inter-ties
Real VALUES (5) array of 5 elements specifying Real Options(input).
VALUES(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform (alias is
efield_mag) (0 by default)
VALUES(1) > 0 when charoptns(1)=uniform, no default al-
lowed
VALUES(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
VALUES(1) > 0 for charoptns(1)=benchmark, used as speci-
fied
VALUES(2) electric field direction in degrees, range 0 to
360 degrees (alias is efield_deg) (0 by de-
fault)
VALUES(2) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
VALUES(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
VALUES(3) = 0 Substation is ungrounded
VALUES(3) > 0 Use specified grounding dc resistance
VALUES(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
network data (alias is branch_xbyr) (30 by
default)
VALUES(4) = 0 Use default
VALUES(4) > 0 Use specified
VALUES(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
VALUES(5) = 0 Use default
VALUES(5) > 0 Use specified
Integer RPTOPTNS (7) array of 7 elements specifying Report Options(input).
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1377
GIC GIC
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
Character*260 GICDATAFIL GIC data file name (input). (input; no default allowed).
Character*260 GICADDFIL GIC updates to Base Case file name (output). (input; blank by de-
fault).
Character*260 GICPURGFIL RDCH file to remove GIC updates from GIC updated case in working
memory to set it back to Base Case network condition (output). (in-
put; blank by default).
Character*260 GICRNWKFIL GIC dc resistive network raw file. This represents the dc network used
to calculate GIC flow (output). (input; blank by default).
Integer IERR error code (output).
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1378
GIC GIC_2
6.1.2. GIC_2
This API routine is obsolete. It has been replaced by the API routine gic_3 .
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 33.6.0.
Batch command syntax:
BAT_GIC_2 SID ALL INTGOPTNS(1)..INTGOPTNS(4) REALOPTNS(1)..REALOPTNS(7)
CHAROPTNS(1)..CHAROPTNS(7) EJETOPTNS(1)..EJETOPTNS(5)
FILEOPTNS(1)..FILEOPTNS(4) RPTOPTNS(1)..RPTOPTNS(7)
Python command syntax:
ierr = gic_2(sid, all, intgoptns, realoptns, charoptns, ejetoptns,
fileoptns, rptoptns)
Fortran command syntax:
CALL GIC_2(SID, ALL, INTGOPTNS, REALOPTNS, CHAROPTNS, EJETOPTNS,
FILEOPTNS, RPTOPTNS, 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 INTGOPTNS (4) array of 4 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(2) Year number to scale benchmark event
GMD storm. These scaling factors account in
the influence of geomagnetic latitude and
earth model on the estimated geoelectric
field magnitude and are provided in NERC
TPL-007-1. (alias is study_year) (0 by default)
INTGOPTNS(2) = 0 current year, used in benchmark geoelectric
field calculations only.
INTGOPTNS(2) > 0 specific year
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1379
GIC GIC_2
INTGOPTNS(3) Subsystem sid for local GMD hot spots (alias
is sid_local) (0 by default)
INTGOPTNS(3) = 0 No local GMD hot spots
INTGOPTNS(3) > 0 subsystem number (1 - 11). Buses and
branches in this subsystem will have Efield
due to local GMD hot spots.
INTGOPTNS(4) Option for Transformer Thermal Analy-
sis (not implemented yet) (alias is
thermal_ana_optn) (0 by default)
INTGOPTNS(4) = -1 perform on all transformers
INTGOPTNS(4) = 0 do not perform
INTGOPTNS(4) > 0 perform on these many top transformers or-
dered by effective GIC flow
Real REALOPTNS (7) array of 7 elements specifying Real Options(input).
REALOPTNS(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform (alias is
efield_mag) (0 by default)
REALOPTNS(1) > 0 when charoptns(1)=uniform, no default al-
lowed
REALOPTNS(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
REALOPTNS(1) > 0 for charoptns(1)=benchmark, used as speci-
fied
REALOPTNS(2) electric field direction in degrees, range 0 to
360 degrees (alias is efield_deg) (0 by de-
fault)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
REALOPTNS(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance
REALOPTNS(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
network data (alias is branch_xbyr) (30 by
default)
REALOPTNS(4) = 0 Use default
REALOPTNS(4) > 0 Use specified
REALOPTNS(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
REALOPTNS(5) = 0 Use default
REALOPTNS(5) > 0 Use specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1380
GIC GIC_2
REALOPTNS(6) local GMD hot spots electric field magnitude
in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (alias is
efield_mag_local) (realoptns(1) by default)
REALOPTNS(6) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
REALOPTNS(7) local GMD hot spots electric field direction
in degrees, range 0 to 360 degrees (alias is
efield_deg_local) (realoptns(2) by default)
REALOPTNS(7) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
Character*12 CHAROPTNS (7) array of 7 elements specifying Character Options(input).
CHAROPTNS(1) Electric Field Type (alias is efield_type) (uni-
form by default)
CHAROPTNS(1) = uni- for uniform geoelectric field
form
CHAROPTNS(1) = for benchmark event geoelectric field
benchmark
CHAROPTNS(1) = for nonuniform geoelectric field
nonuniform
CHAROPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (v/km by default)
CHAROPTNS(2) = v/ for volts/km
km
CHAROPTNS(2) = v/mi for volts/mile
CHAROPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (rdch by default)
CHAROPTNS(3) = sav add updates to Saved Case
CHAROPTNS(3) = rdch create RDCH raw file of GIC updates
CHAROPTNS(4) Option to select method for GIC to Mvar Cal-
culation (alias is gic2mvar_optn) (kfactors by
default)
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
kfactors file when provided, otherwise default scaling
factors
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
capchar file when provided, otherwise scaling factors
from default transformer Mvar and GIC char-
acteristics
CHAROPTNS(5) Earth Model Name. A Standard or User de-
fined model name must be provided when
Benchmark Event or Non-uniform electric
field is to be modeled or Transformer Ther-
mal Analysis is to be performed. (alias is
earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (alias is
scan_storm_event) ( by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1381
GIC GIC_2
CHAROPTNS(6) = no storm orientation and/or magnitude scan
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg maximum Var losses when charoptns(1) is
uniform or benchmark, create report for only
orientation that gives maximum VAR losses
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, create report for each
orientation scanned
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
only final electric field magnitude.
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag_rpt yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
each scanned electric field magnitude.
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans tiil they yield converged power
flow solution, create report for only orienta-
tion that gives maximum VAR losses and final
electric field magnitude
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans till they yield converged power
flow solution, create report for all orientation
scans and mangitude scans performed
CHAROPTNS(7) Option to solve Power Flow with GIC
losses added to the base case (alias is
power_flow_optn) ( by default)
CHAROPTNS(7) = do not perform power flow solution
CHAROPTNS(7) = fdns use fixed slope decoupled Newton-Raphson
method
CHAROPTNS(7) = fnsl use Full Newton-Raphson method
CHAROPTNS(7) = nsol use Decoupled Newton-Raphson method
Real EJETOPTNS (5) array of 5 elements specifying Electrojet Characteristics, used only if
charoptns(1)=nonuniform(input).
EJETOPTNS(1) eletrojet current in million amperes, must be
>0 (alias is ejet_million_amps) (no default al-
lowed)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1382
GIC GIC_2
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (alias is ejet_halfwidth_km) (no default
allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(alias is ejet_period_min) (no default al-
lowed)
EJETOPTNS(4) height of current in km, must be >0 (alias is
ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees
(alias is ejet_center_deg) (no default al-
lowed)
Character*260 FILEOPTNS (4) array of 4 elements specifying File Used(input).
FILEOPTNS(1) GIC data file name (input). (alias is gicfile)
(no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(alias is addfile) ( by default)
FILEOPTNS(2) = no file created
FILEOPTNS(3) RDCH file to remove GIC updates from GIC
updated case in working memory to set it
back to Base Case network condition (out-
put). (alias is purgfile) ( by default)
FILEOPTNS(3) = no file created
FILEOPTNS(4) GIC dc resistive network raw file. This repre-
sents the dc network used to calculate GIC
flow. (output) (alias is rnwkfile) ( by default)
FILEOPTNS(4) = no file created
Integer RPTOPTNS (7) array of 7 elements specifying Report Options(input).
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1383
GIC GIC_2
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
Integer IERR error code (output).
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1384
GIC GIC_3
6.1.3. GIC_3
This API routine is obsolete. It has been replaced by the API routine gic_4 .
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 33.6.0.
Batch command syntax:
BAT_GIC_3 SID ALL INTGOPTNS(1)..INTGOPTNS(4) REALOPTNS(1)..REALOPTNS(7)
CHAROPTNS(1)..CHAROPTNS(7) EJETOPTNS(1)..EJETOPTNS(5)
FILEOPTNS(1)..FILEOPTNS(5) RPTOPTNS(1)..RPTOPTNS(7)
Python command syntax:
ierr = gic_3(sid, all, intgoptns, realoptns, charoptns, ejetoptns,
fileoptns, rptoptns)
Fortran command syntax:
CALL GIC_3(SID, ALL, INTGOPTNS, REALOPTNS, CHAROPTNS, EJETOPTNS,
FILEOPTNS, RPTOPTNS, 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 INTGOPTNS (4) array of 4 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(2) Year number to scale benchmark event
GMD storm. These scaling factors account in
the influence of geomagnetic latitude and
earth model on the estimated geoelectric
field magnitude and are provided in NERC
TPL-007-1. (alias is study_year) (0 by default)
INTGOPTNS(2) = 0 current year, used in benchmark geoelectric
field calculations only.
INTGOPTNS(2) > 0 specific year
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1385
GIC GIC_3
INTGOPTNS(3) Subsystem sid for local GMD hot spots (alias
is sid_local) (0 by default)
INTGOPTNS(3) = 0 No local GMD hot spots
INTGOPTNS(3) > 0 subsystem number (1 - 11). Buses and
branches in this subsystem will have Efield
due to local GMD hot spots.
INTGOPTNS(4) Option for Transformer Thermal Analy-
sis (not implemented yet) (alias is
thermal_ana_optn) (0 by default)
INTGOPTNS(4) = -1 perform on all transformers
INTGOPTNS(4) = 0 do not perform
INTGOPTNS(4) > 0 perform on these many top transformers or-
dered by effective GIC flow
Real REALOPTNS (7) array of 7 elements specifying Real Options(input).
REALOPTNS(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform (alias is
efield_mag) (0 by default)
REALOPTNS(1) > 0 when charoptns(1)=uniform, no default al-
lowed
REALOPTNS(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
REALOPTNS(1) > 0 for charoptns(1)=benchmark, used as speci-
fied
REALOPTNS(2) electric field direction in degrees, range 0 to
360 degrees (alias is efield_deg) (0 by de-
fault)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
REALOPTNS(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance
REALOPTNS(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
network data (alias is branch_xbyr) (30 by
default)
REALOPTNS(4) = 0 Use default
REALOPTNS(4) > 0 Use specified
REALOPTNS(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
REALOPTNS(5) = 0 Use default
REALOPTNS(5) > 0 Use specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1386
GIC GIC_3
REALOPTNS(6) local GMD hot spots electric field magnitude
in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (alias is
efield_mag_local) (realoptns(1) by default)
REALOPTNS(6) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
REALOPTNS(7) local GMD hot spots electric field direction
in degrees, range 0 to 360 degrees (alias is
efield_deg_local) (realoptns(2) by default)
REALOPTNS(7) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
Character*12 CHAROPTNS (7) array of 7 elements specifying Character Options(input).
CHAROPTNS(1) Electric Field Type (alias is efield_type) (uni-
form by default)
CHAROPTNS(1) = uni- for uniform geoelectric field
form
CHAROPTNS(1) = for benchmark event geoelectric field
benchmark
CHAROPTNS(1) = for nonuniform geoelectric field
nonuniform
CHAROPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (v/km by default)
CHAROPTNS(2) = v/ for volts/km
km
CHAROPTNS(2) = v/mi for volts/mile
CHAROPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (rdch by default)
CHAROPTNS(3) = sav add updates to Saved Case
CHAROPTNS(3) = rdch create RDCH raw file of GIC updates
CHAROPTNS(4) Option to select method for GIC to Mvar Cal-
culation (alias is gic2mvar_optn) (kfactors by
default)
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
kfactors file when provided, otherwise default scaling
factors
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
capchar file when provided, otherwise scaling factors
from default transformer Mvar and GIC char-
acteristics
CHAROPTNS(5) Earth Model Name. A Standard or User de-
fined model name must be provided when
Benchmark Event or Non-uniform electric
field is to be modeled or Transformer Ther-
mal Analysis is to be performed. (alias is
earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (alias is
scan_storm_event) ( by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1387
GIC GIC_3
CHAROPTNS(6) = no storm orientation and/or magnitude scan
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg maximum Var losses when charoptns(1) is
uniform or benchmark, create report for only
orientation that gives maximum VAR losses
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, create report for each
orientation scanned
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
only final electric field magnitude.
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag_rpt yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
each scanned electric field magnitude.
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans tiil they yield converged power
flow solution, create report for only orienta-
tion that gives maximum VAR losses and final
electric field magnitude
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans till they yield converged power
flow solution, create report for all orientation
scans and mangitude scans performed
CHAROPTNS(7) Option to solve Power Flow with GIC
losses added to the base case (alias is
power_flow_optn) ( by default)
CHAROPTNS(7) = do not perform power flow solution
CHAROPTNS(7) = fdns use fixed slope decoupled Newton-Raphson
method
CHAROPTNS(7) = fnsl use Full Newton-Raphson method
CHAROPTNS(7) = nsol use Decoupled Newton-Raphson method
Real EJETOPTNS (5) array of 5 elements specifying Electrojet Characteristics, used only if
charoptns(1)=nonuniform(input).
EJETOPTNS(1) eletrojet current in million amperes, must be
>0 (alias is ejet_million_amps) (no default al-
lowed)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1388
GIC GIC_3
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (alias is ejet_halfwidth_km) (no default
allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(alias is ejet_period_min) (no default al-
lowed)
EJETOPTNS(4) height of current in km, must be >0 (alias is
ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees
(alias is ejet_center_deg) (no default al-
lowed)
Character*260 FILEOPTNS (5) array of 5 elements specifying File Used(input).
FILEOPTNS(1) GIC data file name (input). (alias is gicfile)
(no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(alias is addfile) ( by default)
FILEOPTNS(2) = no file created
FILEOPTNS(3) RDCH file to remove GIC updates from GIC
updated case in working memory to set it
back to Base Case network condition (out-
put). (alias is purgfile) ( by default)
FILEOPTNS(3) = no file created
FILEOPTNS(4) GIC dc resistive network raw file. This repre-
sents the dc network used to calculate GIC
flow. (output) (alias is rnwkfile) ( by default)
FILEOPTNS(4) = no file created
FILEOPTNS(5) GIC Results map data file for given Efield
magnitude and degrees OR Efield magnitude
and degrees scans which give maximum Var
losses when scans are performed (output).
This is used by GICMAPS to plot GIC results
on network map. (alias is pygicfile) ( by de-
fault)
FILEOPTNS(5) = temporary file created
FILEOPTNS(5) = no file created
nooutput
Integer RPTOPTNS (7) array of 7 elements specifying Report Options(input).
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1389
GIC GIC_3
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
Integer IERR error code (output).
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1390
GIC GIC_4
6.1.4. GIC_4
This API routine is obsolete. It has been replaced by the API routine gic_5 .
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 33.10.0 and 34.2.0.
Batch command syntax:
BAT_GIC_4 SID ALL INTGOPTNS(1)..INTGOPTNS(4) REALOPTNS(1)..REALOPTNS(9)
CHAROPTNS(1)..CHAROPTNS(7) EJETOPTNS(1)..EJETOPTNS(5)
FILEOPTNS(1)..FILEOPTNS(6) RPTOPTNS(1)..RPTOPTNS(7)
Python command syntax:
ierr = gic_4(sid, all, intgoptns, realoptns, charoptns, ejetoptns,
fileoptns, rptoptns)
Fortran command syntax:
CALL GIC_4(SID, ALL, INTGOPTNS, REALOPTNS, CHAROPTNS, EJETOPTNS,
FILEOPTNS, RPTOPTNS, 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 INTGOPTNS (4) array of 4 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(2) Year number to scale benchmark event
GMD storm. These scaling factors account
in the influence of geomagnetic latitude on
the estimated geoelectric field magnitude
and are provided in NERC TPL-007. (alias is
study_year) (0 by default)
INTGOPTNS(2) = 0 current year, used in benchmark and supple-
mental geoelectric field calculations only.
INTGOPTNS(2) > 0 specific year
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1391
GIC GIC_4
INTGOPTNS(3) Subsystem sid for supplemental GMD event
(alias is sid_supp) (0 by default)
INTGOPTNS(3) = 0 No supplemental GMD event
INTGOPTNS(3) > 0 subsystem number (1 - 11). Buses and
branches in this subsystem will have Efield
due to supplemental GMD event.
INTGOPTNS(4) Option for Transformer Thermal Analysis
(alias is thermal_ana_optn) (0 by default)
INTGOPTNS(4) = -1 perform on all transformers
INTGOPTNS(4) = 0 do not perform
INTGOPTNS(4) > 0 perform on these many top transformers or-
dered by effective GIC flow
Real REALOPTNS (9) array of 9 elements specifying Real Options(input).
REALOPTNS(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_mag) (0 by default)
REALOPTNS(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
REALOPTNS(1) > 0 when charoptns(1)=uniform, no default al-
lowed
REALOPTNS(1) > 0 when charoptns(1)=benchmark, used as
specified
REALOPTNS(2) electric field direction in degrees,
range 0 to 360 degrees, not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance
REALOPTNS(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
network data (alias is branch_xbyr) (30 by
default)
REALOPTNS(4) = 0 Use default
REALOPTNS(4) > 0 Use specified
REALOPTNS(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
REALOPTNS(5) = 0 Use default
REALOPTNS(5) > 0 Use specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1392
GIC GIC_4
REALOPTNS(6) supplemental event electric field magnitude
in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (alias is
efield_mag_supp) (realoptns(1) by default)
REALOPTNS(6) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is not zero
REALOPTNS(6) > 0 when charoptns(1)=supplemental
REALOPTNS(7) local GMD hot spots electric field direction in
degrees, range 0 to 360 degrees, not used
when charoptns(1)=nonuniform (alias is
efield_deg_supp) (realoptns(2) by default)
REALOPTNS(7) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is non-zero
REALOPTNS(7) > 0 when charoptns(1)=supplemental
REALOPTNS(8) transmission line AC to DC resistance
conversion factor, must be >0 (alias is
branch_rac2rdc) (1.0 by default)
REALOPTNS(8) = 0 Use default
REALOPTNS(8) > 0 Use specified
REALOPTNS(9) transformer winding AC to DC resistance
conversion factor, must be >0 (alias is
transformer_rac2rdc) (1.0 by default)
REALOPTNS(9) = 0 Use default
REALOPTNS(9) > 0 Use specified
Character*12 CHAROPTNS (7) array of 7 elements specifying Character Options(input).
CHAROPTNS(1) Electric Field Type (alias is efield_type) (uni-
form by default)
CHAROPTNS(1) = uni- for uniform geoelectric field and also supple-
form mental event electric field when intgoptns(3)
and realoptns(6) are non-zero
CHAROPTNS(1) = for benchmark event geoelectric field and
benchmark beta factors (B) and also supplemental event
electric field and beta factors (Bs) when int-
goptns(3) and realoptns(6) are non-zero
CHAROPTNS(1) = for nonuniform geoelectric field
nonuniform
CHAROPTNS(1) = sup- for supplemental event geoelectric field and
plemental beta factors (Bs)
CHAROPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (v/km by default)
CHAROPTNS(2) = v/ for volts/km
km
CHAROPTNS(2) = v/mi for volts/mile
CHAROPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (rdch by default)
CHAROPTNS(3) = sav add updates to Saved Case
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1393
GIC GIC_4
CHAROPTNS(3) = rdch create RDCH raw file of GIC updates
CHAROPTNS(4) Option to select method for GIC to Mvar Cal-
culation (alias is gic2mvar_optn) (kfactors by
default)
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
kfactors file when provided, otherwise default scaling
factors
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
capchar file when provided, otherwise scaling factors
from default transformer Mvar and GIC char-
acteristics
CHAROPTNS(5) Earth Model Name. A Standard or User de-
fined model name must be provided when
Benchmark Event or Non-uniform electric
field is to be modeled or Transformer Ther-
mal Analysis is to be performed. (alias is
earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (alias is
scan_storm_event) ( by default)
CHAROPTNS(6) = no storm orientation and/or magnitude scan
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg maximum Var losses when charoptns(1) is
uniform or benchmark, create report for only
orientation that gives maximum VAR losses
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, create report for each
orientation scanned
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
only final electric field magnitude.
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag_rpt yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
each scanned electric field magnitude.
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans tiil they yield converged power
flow solution, create report for only orienta-
tion that gives maximum VAR losses and final
electric field magnitude
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m_rpt maximum Var losses when charoptns(1) is
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1394
GIC GIC_4
uniform or benchmark, then perform mag-
nitude scans till they yield converged power
flow solution, create report for all orientation
scans and mangitude scans performed
CHAROPTNS(7) Option to solve Power Flow with GIC
losses added to the base case (alias is
power_flow_optn) ( by default)
CHAROPTNS(7) = do not perform power flow solution
CHAROPTNS(7) = fdns use fixed slope decoupled Newton-Raphson
method
CHAROPTNS(7) = fnsl use Full Newton-Raphson method
CHAROPTNS(7) = nsol use Decoupled Newton-Raphson method
Real EJETOPTNS (5) array of 5 elements specifying Electrojet Characteristics, used only if
charoptns(1)=nonuniform(input).
EJETOPTNS(1) eletrojet current in million amperes, must be
>0 (alias is ejet_million_amps) (no default al-
lowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (alias is ejet_halfwidth_km) (no default
allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(alias is ejet_period_min) (no default al-
lowed)
EJETOPTNS(4) height of current in km, must be >0 (alias is
ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees
(alias is ejet_center_deg) (no default al-
lowed)
Character*260 FILEOPTNS (6) array of 6 elements specifying File Used(input).
FILEOPTNS(1) GIC data file name (input). (alias is gicfile)
(no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(alias is addfile) (blank by default)
FILEOPTNS(2) = ' ' no file created
FILEOPTNS(3) RDCH file to remove GIC updates from GIC
updated case in working memory to set it
back to Base Case network condition (out-
put). (alias is purgfile) (blank by default)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC dc resistive network raw file. This repre-
sents the dc network used to calculate GIC
flow (output). (alias is rnwkfile) (blank by de-
fault)
FILEOPTNS(4) = ' ' no file created
FILEOPTNS(5) GIC Results map data file for given Efield
magnitude and degrees OR Efield magnitude
and degrees scans which give maximum Var
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1395
GIC GIC_4
losses when scans are performed (output).
This is used by GICMAPS to plot GIC results
on network map. (alias is pygicfile) (noout-
put by default)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput
FILEOPTNS(6) Transformer Thermal Analysis GIC(t) CSV file
(output). (alias is gictfile) (nooutput by de-
fault)
FILEOPTNS(6) = ' ' temporary file created
FILEOPTNS(6) = no file created
nooutput
Integer RPTOPTNS (7) array of 7 elements specifying Report Options(input).
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1396
GIC GIC_4
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1397
GIC GIC_5
6.1.5. GIC_5
This API routine is obsolete. It has been replaced by the API routine gic_6 .
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 34.5.0.
Batch command syntax:
BAT_GIC_5 SID ALL INTGOPTNS(1)..INTGOPTNS(5) REALOPTNS(1)..REALOPTNS(13)
CHAROPTNS(1)..CHAROPTNS(7) EJETOPTNS(1)..EJETOPTNS(5)
FILEOPTNS(1)..FILEOPTNS(6) RPTOPTNS(1)..RPTOPTNS(7)
Python command syntax:
ierr = gic_5(sid, all, intgoptns, realoptns, charoptns, ejetoptns,
fileoptns, rptoptns)
Fortran command syntax:
CALL GIC_5(SID, ALL, INTGOPTNS, REALOPTNS, CHAROPTNS, EJETOPTNS,
FILEOPTNS, RPTOPTNS, 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 INTGOPTNS (5) array of 5 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 1 through 5, consider study subsystem buses
+ these many levels of inter-tie buses and ig-
nore subsystem definition voltage limits for
intertie buses added
INTGOPTNS(1) < 0 -1 through -5, consider study subsystem bus-
es + these many levels of inter-tie buses and
consider subsystem definition voltage limits
for intertie buses added
INTGOPTNS(2) Year number to scale benchmark event
GMD storm. These scaling factors account
in the influence of geomagnetic latitude on
the estimated geoelectric field magnitude
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1398
GIC GIC_5
and are provided in NERC TPL-007. (alias is
study_year) (0 by default)
INTGOPTNS(2) = 0 current year, used in benchmark and supple-
mental geoelectric field calculations only.
INTGOPTNS(2) > 0 specific year
INTGOPTNS(3) Subsystem sid for supplemental GMD event
(alias is sid_supp) (0 by default)
INTGOPTNS(3) = 0 No supplemental GMD event
INTGOPTNS(3) > 0 subsystem number (1 - 11). Buses and
branches in this subsystem will have Efield
due to supplemental GMD event.
INTGOPTNS(4) Option for Transformer Thermal Analysis
(alias is thermal_ana_optn) (0 by default)
INTGOPTNS(4) = -1 perform on all transformers
INTGOPTNS(4) = 0 do not perform
INTGOPTNS(4) > 0 perform on these many top transformers or-
dered by effective GIC flow
INTGOPTNS(5) Option to run power flow for each degree
scan calculation (alias is degscan_pf_optn) (0
by default)
INTGOPTNS(5) = 0 Solve power flow only for worst degree
INTGOPTNS(5) = 1 Solve power flow for each degree scan calcu-
lation
Real REALOPTNS (13) array of 13 elements specifying Real Options(input).
REALOPTNS(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_mag) (0 by default)
REALOPTNS(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
REALOPTNS(1) > 0 when charoptns(1)=uniform, no default al-
lowed
REALOPTNS(1) > 0 when charoptns(1)=benchmark, used as
specified
REALOPTNS(2) electric field direction in degrees,
range 0 to 360 degrees, not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance
REALOPTNS(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1399
GIC GIC_5
network data (alias is branch_xbyr) (30 by
default)
REALOPTNS(4) = 0 Use default
REALOPTNS(4) > 0 Use specified
REALOPTNS(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
REALOPTNS(5) = 0 Use default
REALOPTNS(5) > 0 Use specified
REALOPTNS(6) supplemental event electric field magnitude
in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (alias is
efield_mag_supp) (realoptns(1) by default)
REALOPTNS(6) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is not zero
REALOPTNS(6) > 0 when charoptns(1)=supplemental
REALOPTNS(7) local GMD hot spots electric field direction in
degrees, range 0 to 360 degrees, not used
when charoptns(1)=nonuniform (alias is
efield_deg_supp) (realoptns(2) by default)
REALOPTNS(7) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is non-zero
REALOPTNS(7) > 0 when charoptns(1)=supplemental
REALOPTNS(8) transmission line AC to DC resistance
conversion factor, must be >0 (alias is
branch_rac2rdc) (1.0 by default)
REALOPTNS(8) = 0 Use default
REALOPTNS(8) > 0 Use specified
REALOPTNS(9) transformer winding AC to DC resistance
conversion factor, must be >0 (alias is
transformer_rac2rdc) (1.0 by default)
REALOPTNS(9) = 0 Use default
REALOPTNS(9) > 0 Use specified
REALOPTNS(10) Degree Scan step size, range 1.0 to 180 de-
grees (alias is degscan_step) (10.0 by de-
fault)
REALOPTNS(10) = 0 Use default
REALOPTNS(10) > 0 Use specified
REALOPTNS(11) Magnitude Scan step size, must be >1.0 V/
km (alias is magscan_step) (4.0 by default)
REALOPTNS(11) = 0 Use default
REALOPTNS(11) > 0 Use specified
REALOPTNS(12) Percent GMD Mvar loss step size. Total GMD
Mvar losses added incrementally to the base
case to obtain power flow solution, must
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1400
GIC GIC_5
be >1.0 (alias is pf_qpct_step) (100.0 by de-
fault)
REALOPTNS(12) = 0 Use default
REALOPTNS(12) > 0 Use specified
REALOPTNS(13) Magnitude Scan maximum storm strength,
must be >1.0 (alias is magscan_max) (20.0
by default)
REALOPTNS(13) = 0 Use default
REALOPTNS(13) > 0 Use specified
Character*12 CHAROPTNS (7) array of 7 elements specifying Character Options(input).
CHAROPTNS(1) Electric Field Type (alias is efield_type) (uni-
form by default)
CHAROPTNS(1) = uni- for uniform geoelectric field and also supple-
form mental event electric field when intgoptns(3)
and realoptns(6) are non-zero
CHAROPTNS(1) = for benchmark event geoelectric field and
benchmark beta factors (B) and also supplemental event
electric field and beta factors (Bs) when int-
goptns(3) and realoptns(6) are non-zero
CHAROPTNS(1) = for nonuniform geoelectric field
nonuniform
CHAROPTNS(1) = sup- for supplemental event geoelectric field and
plemental beta factors (Bs)
CHAROPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (v/km by default)
CHAROPTNS(2) = v/ for volts/km
km
CHAROPTNS(2) = v/mi for volts/mile
CHAROPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (rdch by default)
CHAROPTNS(3) = sav add updates to Saved Case
CHAROPTNS(3) = rdch create RDCH raw file of GIC updates
CHAROPTNS(4) Option to select method for GIC to Mvar Cal-
culation (alias is gic2mvar_optn) (kfactors by
default)
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
kfactors file when provided, otherwise default scaling
factors
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
capchar file when provided, otherwise scaling factors
from default transformer Mvar and GIC char-
acteristics
CHAROPTNS(5) Earth Model Name. A Standard or User de-
fined model name must be provided when
Benchmark Event or Non-uniform electric
field is to be modeled or Transformer Ther-
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1401
GIC GIC_5
mal Analysis is to be performed. (alias is
earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (alias is
scan_storm_event) ( by default)
CHAROPTNS(6) = no storm orientation and/or magnitude scan
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg maximum Var losses when charoptns(1) is
uniform or benchmark, create report for only
orientation that gives maximum VAR losses
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, create report for each
orientation scanned
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
only final electric field magnitude.
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag_rpt yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
each scanned electric field magnitude.
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans tiil they yield converged power
flow solution, create report for only orienta-
tion that gives maximum VAR losses and final
electric field magnitude
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans till they yield converged power
flow solution, create report for all orientation
scans and mangitude scans performed
CHAROPTNS(7) Option to solve Power Flow with GIC
losses added to the base case (alias is
power_flow_optn) ( by default)
CHAROPTNS(7) = do not perform power flow solution
CHAROPTNS(7) = fdns use fixed slope decoupled Newton-Raphson
method
CHAROPTNS(7) = fnsl use Full Newton-Raphson method
CHAROPTNS(7) = nsol use Decoupled Newton-Raphson method
Real EJETOPTNS (5) array of 5 elements specifying Electrojet Characteristics, used only if
charoptns(1)=nonuniform(input).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1402
GIC GIC_5
EJETOPTNS(1) eletrojet current in million amperes, must be
>0 (alias is ejet_million_amps) (no default al-
lowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (alias is ejet_halfwidth_km) (no default
allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(alias is ejet_period_min) (no default al-
lowed)
EJETOPTNS(4) height of current in km, must be >0 (alias is
ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees
(alias is ejet_center_deg) (no default al-
lowed)
Character*260 FILEOPTNS (6) array of 6 elements specifying File Used(input).
FILEOPTNS(1) GIC data file name (input). (alias is gicfile)
(no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(alias is addfile) (blank by default)
FILEOPTNS(2) = ' ' no file created
FILEOPTNS(3) RDCH file to remove GIC updates from GIC
updated case in working memory to set it
back to Base Case network condition (out-
put). (alias is purgfile) (blank by default)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC dc resistive network raw file. This repre-
sents the dc network used to calculate GIC
flow (output). (alias is rnwkfile) (blank by de-
fault)
FILEOPTNS(4) = ' ' no file created
FILEOPTNS(5) GIC Results map data file for given Efield
magnitude and degrees OR Efield magnitude
and degrees scans which give maximum Var
losses when scans are performed (output).
This is used by GICMAPS to plot GIC results
on network map. (alias is pygicfile) (noout-
put by default)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput
FILEOPTNS(6) Transformer Thermal Analysis GIC(t) CSV file
(output). (alias is gictfile) (nooutput by de-
fault)
FILEOPTNS(6) = ' ' temporary file created
FILEOPTNS(6) = no file created
nooutput
Integer RPTOPTNS (7) array of 7 elements specifying Report Options(input).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1403
GIC GIC_5
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
Integer IERR error code (output).
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1404
GIC GIC_6
6.1.6. GIC_6
This API routine is obsolete. It has been replaced by the API routine gic_7 .
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_GIC_6 SID ALL INTGOPTNS(1)..INTGOPTNS(10) REALOPTNS(1)..REALOPTNS(17)
CHAROPTNS(1)..CHAROPTNS(7) EJETOPTNS(1)..EJETOPTNS(5)
FILEOPTNS(1)..FILEOPTNS(6) RPTOPTNS(1)..RPTOPTNS(8)
Python command syntax:
ierr = gic_6(sid, all, intgoptns, realoptns, charoptns, ejetoptns,
fileoptns, rptoptns)
Fortran command syntax:
CALL GIC_6(SID, ALL, INTGOPTNS, REALOPTNS, CHAROPTNS, EJETOPTNS,
FILEOPTNS, RPTOPTNS, 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 INTGOPTNS (10) array of 10 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 1 through 5, consider study subsystem buses
+ these many levels of inter-tie buses and ig-
nore subsystem definition voltage limits for
intertie buses added
INTGOPTNS(1) < 0 -1 through -5, consider study subsystem bus-
es + these many levels of inter-tie buses and
consider subsystem definition voltage limits
for intertie buses added
INTGOPTNS(2) Year number to scale benchmark event
GMD storm. These scaling factors account
in the influence of geomagnetic latitude on
the estimated geoelectric field magnitude
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1405
GIC GIC_6
and are provided in NERC TPL-007. (alias is
study_year) (0 by default)
INTGOPTNS(2) = 0 current year, used in benchmark and supple-
mental geoelectric field calculations only.
INTGOPTNS(2) > 0 specific year
INTGOPTNS(3) Subsystem sid for supplemental GMD event
(alias is sid_supp) (0 by default)
INTGOPTNS(3) = 0 No supplemental GMD event
INTGOPTNS(3) > 0 subsystem number (1 - 11). Buses and
branches in this subsystem will have Efield
due to supplemental GMD event.
INTGOPTNS(4) Option for Transformer Thermal Analysis
(alias is thermal_ana_optn) (0 by default)
INTGOPTNS(4) = -1 perform on all transformers
INTGOPTNS(4) = 0 do not perform
INTGOPTNS(4) > 0 perform on these many top transformers or-
dered by effective GIC flow
INTGOPTNS(5) Option to run power flow for each degree
scan calculation (alias is degscan_pf_optn) (0
by default)
INTGOPTNS(5) = 0 Solve power flow only for worst degree
INTGOPTNS(5) = 1 Solve power flow for each degree scan calcu-
lation
INTGOPTNS(6) Option to include buses of boundary
transformers in study subsystem (alias is
boundary_trn) (0 by default)
INTGOPTNS(6) = 0 consider only study subsystem buses
INTGOPTNS(6) = 1 Include buses of boundary transformers con-
sidering subsystem definition voltage limits
INTGOPTNS(6) = 2 Include buses of boundary transformers ig-
noring subsystem definition voltage limits
INTGOPTNS(7) Option for Transformers to include in worst
case determination (alias is worstcase_trn) (0
by default)
INTGOPTNS(7) = 0 All transformers in study subsystem
INTGOPTNS(7) = 1 All transformers in report subsystem
INTGOPTNS(8) Option for Supplemental event Moving Box
(alias is supp_evt) (0 by default)
INTGOPTNS(8) = 0 No supplemental event
INTGOPTNS(8) = 1 Use supplemental event subsytem SID as the
moving box. For CHAROPTNS(6)='', Orienta-
tion of Efield=REALOPTNS(2), Orientation of
Supplemental Efield=REALOPTNS(7)
INTGOPTNS(8) = 2 Rank substations with maximum GIC flows
as center of the moving box from storm ori-
entation scans that results in maximum VAR
losses. For CHAROPTNS(6)='', Orientation of
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1406
GIC GIC_6
Efield=Supplemental Efield=Orienation that
gives Maximum VAR losses
INTGOPTNS(8) = 3 Rank transformers with maximum GIC flows
as center of the moving box from storm ori-
entation scans. For CHAROPTNS(6)='', Orien-
tation of Efield=Orienation that gives Maxi-
mum VAR losses, Orientation of Supplemen-
tal Efield=Orienation that gives Maximum
GICs in transformer
INTGOPTNS(8) = 4 Use substation number provided as center of
the moving box. For CHAROPTNS(6)='', Ori-
entation of Efield=REALOPTNS(2), Orienta-
tion of Supplemental Efield=REALOPTNS(7)
INTGOPTNS(8) = 5 Use location provided as center of the mov-
ing box. For CHAROPTNS(6)='', Orientation of
Efield=REALOPTNS(2), Orientation of Supple-
mental Efield=REALOPTNS(7)
INTGOPTNS(9) Option for number of Supplemental event
moving boxes. It is not used when int-
goptns(8)=0 and intgoptns(8)=4 (alias is
supp_box_num) (0 by default)
INTGOPTNS(9) = 0 Do not perform moving box calculations
when when intgoptns(8)=1, 2, 3
INTGOPTNS(9) > 0 When intgoptns(8)=1, number of substations
to consider for center of moving box
INTGOPTNS(9) > 0 When intgoptns(8)=2, number of transform-
ers to consider for center of moving box
INTGOPTNS(9) > 0 When intgoptns(8)=3, valid substation num-
ber to consider for center of moving box
INTGOPTNS(10) Option for treatment of the transmission line
that intersect with Supplemental event mov-
ing box (alias is brn_seg_efld) (0 by default)
INTGOPTNS(10) = 0 Apply Supplemental event Efield to line seg-
ment inside the box and Benchmark event
Efield to line segments outside the box
INTGOPTNS(10) = 1 Apply Supplemental event Efield to entire
line when any segment of the line is inside
the box
Real REALOPTNS (17) array of 17 elements specifying Real Options(input).
REALOPTNS(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_mag) (0 by default)
REALOPTNS(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
REALOPTNS(1) > 0 when charoptns(1)=uniform, no default al-
lowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1407
GIC GIC_6
REALOPTNS(1) > 0 when charoptns(1)=benchmark, used as
specified
REALOPTNS(2) electric field direction in degrees,
range 0 to 360 degrees, not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance
REALOPTNS(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
network data (alias is branch_xbyr) (30 by
default)
REALOPTNS(4) = 0 Use default
REALOPTNS(4) > 0 Use specified
REALOPTNS(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
REALOPTNS(5) = 0 Use default
REALOPTNS(5) > 0 Use specified
REALOPTNS(6) supplemental event electric field magnitude
in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (alias is
efield_mag_supp) (realoptns(1) by default)
REALOPTNS(6) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is not zero
REALOPTNS(6) > 0 when charoptns(1)=supplemental
REALOPTNS(7) local GMD hot spots electric field direction in
degrees, range 0 to 360 degrees, not used
when charoptns(1)=nonuniform (alias is
efield_deg_supp) (realoptns(2) by default)
REALOPTNS(7) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is non-zero
REALOPTNS(7) > 0 when charoptns(1)=supplemental
REALOPTNS(8) transmission line AC to DC resistance
conversion factor, must be >0 (alias is
branch_rac2rdc) (1.0 by default)
REALOPTNS(8) = 0 Use default
REALOPTNS(8) > 0 Use specified
REALOPTNS(9) transformer winding AC to DC resistance
conversion factor, must be >0 (alias is
transformer_rac2rdc) (1.0 by default)
REALOPTNS(9) = 0 Use default
REALOPTNS(9) > 0 Use specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1408
GIC GIC_6
REALOPTNS(10) Degree Scan step size, range 1.0 to 180 de-
grees (alias is degscan_step) (10.0 by de-
fault)
REALOPTNS(10) = 0 Use default
REALOPTNS(10) > 0 Use specified
REALOPTNS(11) Magnitude Scan step size, must be >1.0 V/
km (alias is magscan_step) (4.0 by default)
REALOPTNS(11) = 0 Use default
REALOPTNS(11) > 0 Use specified
REALOPTNS(12) Percent GMD Mvar loss step size. Total GMD
Mvar losses added incrementally to the base
case to obtain power flow solution, must
be >1.0 (alias is pf_qpct_step) (100.0 by de-
fault)
REALOPTNS(12) = 0 Use default
REALOPTNS(12) > 0 Use specified
REALOPTNS(13) Magnitude Scan maximum storm strength,
must be >1.0 (alias is magscan_max) (20.0
by default)
REALOPTNS(13) = 0 Use default
REALOPTNS(13) > 0 Use specified
REALOPTNS(14) Supplemental event moving box North-South
length in km, must be >1.0, used when
intgoptns(8)>0 (alias is supp_box_ns_km)
(100.0 by default)
REALOPTNS(14) = 0 Use default
REALOPTNS(14) > 0 Use specified
REALOPTNS(15) Supplemental event moving box East-West
length in km, must be >1.0, used when int-
goptns(8)>0 (alias is supp_box_ew_km)
(500.0 by default)
REALOPTNS(15) = 0 Use default
REALOPTNS(15) > 0 Use specified
REALOPTNS(16) Supplemental event moving box center point
longitude in degrees, used only when int-
goptns(8)=4 (alias is supp_box_lon_c) (0.0
by default)
REALOPTNS(16) = 0 Use default
REALOPTNS(16) > 0 Use specified
REALOPTNS(17) Supplemental event moving box center point
latitude in degrees, used only when int-
goptns(8)=4 (alias is supp_box_lat_c) (0.0 by
default)
REALOPTNS(17) = 0 Use default
REALOPTNS(17) > 0 Use specified
Character*12 CHAROPTNS (7) array of 7 elements specifying Character Options(input).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1409
GIC GIC_6
CHAROPTNS(1) Electric Field Type (alias is efield_type) (uni-
form by default)
CHAROPTNS(1) = uni- for uniform geoelectric field and also supple-
form mental event electric field when intgoptns(3)
and realoptns(6) are non-zero
CHAROPTNS(1) = for benchmark event geoelectric field and
benchmark beta factors (B) and also supplemental event
electric field and beta factors (Bs) when int-
goptns(3) and realoptns(6) are non-zero
CHAROPTNS(1) = for nonuniform geoelectric field
nonuniform
CHAROPTNS(1) = sup- for supplemental event geoelectric field and
plemental beta factors (Bs)
CHAROPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (v/km by default)
CHAROPTNS(2) = v/ for volts/km
km
CHAROPTNS(2) = v/mi for volts/mile
CHAROPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (rdch by default)
CHAROPTNS(3) = sav add updates to Saved Case
CHAROPTNS(3) = rdch create RDCH raw file of GIC updates
CHAROPTNS(4) Option to select method for GIC to Mvar Cal-
culation (alias is gic2mvar_optn) (kfactors by
default)
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
kfactors file when provided, otherwise default scaling
factors
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
capchar file when provided, otherwise scaling factors
from default transformer Mvar and GIC char-
acteristics
CHAROPTNS(5) Earth Model Name. A Standard or User de-
fined model name must be provided when
Benchmark Event or Non-uniform electric
field is to be modeled or Transformer Ther-
mal Analysis is to be performed. (alias is
earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (alias is
scan_storm_event) ( by default)
CHAROPTNS(6) = no storm orientation and/or magnitude scan
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg maximum Var losses when charoptns(1) is
uniform or benchmark, create report for only
orientation that gives maximum VAR losses
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg_rpt maximum Var losses when charoptns(1) is
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1410
GIC GIC_6
uniform or benchmark, create report for each
orientation scanned
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
only final electric field magnitude.
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag_rpt yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
each scanned electric field magnitude.
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans tiil they yield converged power
flow solution, create report for only orienta-
tion that gives maximum VAR losses and final
electric field magnitude
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans till they yield converged power
flow solution, create report for all orientation
scans and mangitude scans performed
CHAROPTNS(7) Option to solve Power Flow with GIC
losses added to the base case (alias is
power_flow_optn) ( by default)
CHAROPTNS(7) = do not perform power flow solution
CHAROPTNS(7) = fdns use fixed slope decoupled Newton-Raphson
method
CHAROPTNS(7) = fnsl use Full Newton-Raphson method
CHAROPTNS(7) = nsol use Decoupled Newton-Raphson method
Real EJETOPTNS (5) array of 5 elements specifying Electrojet Characteristics, used only if
charoptns(1)=nonuniform(input).
EJETOPTNS(1) eletrojet current in million amperes, must be
>0 (alias is ejet_million_amps) (no default al-
lowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (alias is ejet_halfwidth_km) (no default
allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(alias is ejet_period_min) (no default al-
lowed)
EJETOPTNS(4) height of current in km, must be >0 (alias is
ejet_height_km) (no default allowed)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1411
GIC GIC_6
EJETOPTNS(5) latitude of center of electrojet in degrees
(alias is ejet_center_deg) (no default al-
lowed)
Character*260 FILEOPTNS (6) array of 6 elements specifying File Used(input).
FILEOPTNS(1) GIC data file name (input). (alias is gicfile)
(no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(alias is addfile) (blank by default)
FILEOPTNS(2) = ' ' no file created
FILEOPTNS(3) RDCH file to remove GIC updates from GIC
updated case in working memory to set it
back to Base Case network condition (out-
put). (alias is purgfile) (blank by default)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC dc resistive network raw file. This repre-
sents the dc network used to calculate GIC
flow (output). (alias is rnwkfile) (blank by de-
fault)
FILEOPTNS(4) = ' ' no file created
FILEOPTNS(5) GIC Results map data file for given Efield
magnitude and degrees OR Efield magnitude
and degrees scans which give maximum Var
losses when scans are performed (output).
This is used by GICMAPS to plot GIC results
on network map. (alias is pygicfile) (noout-
put by default)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput
FILEOPTNS(6) Transformer Thermal Analysis GIC(t) CSV file
(output). (alias is gictfile) (nooutput by de-
fault)
FILEOPTNS(6) = ' ' temporary file created
FILEOPTNS(6) = no file created
nooutput
Integer RPTOPTNS (8) array of 8 elements specifying Report Options(input).
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1412
GIC GIC_6
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
RPTOPTNS(8) Subsystem sid for report (alias is rpt_sid) (0
by default)
RPTOPTNS(8) = 0 Use study subsystem as report subsystem
RPTOPTNS(8) = 1 Subsystem number (1 - 11). GIC report creat-
ed for buses and branches in this subsystem.
Integer IERR error code (output).
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1413
GIC GIC_7
6.1.7. GIC_7
This API routine is obsolete. It has been replaced by the API routine gic_8 .
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_7 SID ALL INTGOPTNS(1)..INTGOPTNS(10) REALOPTNS(1)..REALOPTNS(17)
CHAROPTNS(1)..CHAROPTNS(7) EJETOPTNS(1)..EJETOPTNS(5)
FILEOPTNS(1)..FILEOPTNS(5) RPTOPTNS(1)..RPTOPTNS(8)
Python command syntax:
ierr = gic_7(sid, all, intgoptns, realoptns, charoptns, ejetoptns,
fileoptns, rptoptns)
Fortran command syntax:
CALL GIC_7(SID, ALL, INTGOPTNS, REALOPTNS, CHAROPTNS, EJETOPTNS,
FILEOPTNS, RPTOPTNS, 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 INTGOPTNS (10) array of 10 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 1 through 5, consider study subsystem buses
+ these many levels of inter-tie buses and ig-
nore subsystem definition voltage limits for
intertie buses added
INTGOPTNS(1) < 0 -1 through -5, consider study subsystem bus-
es + these many levels of inter-tie buses and
consider subsystem definition voltage limits
for intertie buses added
INTGOPTNS(2) Year number to scale benchmark event
GMD storm. These scaling factors account
in the influence of geomagnetic latitude on
the estimated geoelectric field magnitude
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1414
GIC GIC_7
and are provided in NERC TPL-007. (alias is
study_year) (0 by default)
INTGOPTNS(2) = 0 current year, used in benchmark and supple-
mental geoelectric field calculations only.
INTGOPTNS(2) > 0 specific year
INTGOPTNS(3) Subsystem sid for supplemental GMD event
(alias is sid_supp) (0 by default)
INTGOPTNS(3) = 0 No supplemental GMD event
INTGOPTNS(3) > 0 subsystem number (1 - 11). Buses and
branches in this subsystem will have Efield
due to supplemental GMD event.
INTGOPTNS(4) Option for Transformer Thermal Analysis
(alias is thermal_ana_optn) (0 by default)
INTGOPTNS(4) = -1 perform on all transformers
INTGOPTNS(4) = 0 do not perform
INTGOPTNS(4) > 0 perform on these many top transformers or-
dered by effective GIC flow
INTGOPTNS(5) Option to run power flow for each degree
scan calculation (alias is degscan_pf_optn) (0
by default)
INTGOPTNS(5) = 0 Solve power flow only for worst degree
INTGOPTNS(5) = 1 Solve power flow for each degree scan calcu-
lation
INTGOPTNS(6) Option to include buses of boundary
transformers in study subsystem (alias is
boundary_trn) (0 by default)
INTGOPTNS(6) = 0 consider only study subsystem buses
INTGOPTNS(6) = 1 Include buses of boundary transformers con-
sidering subsystem definition voltage limits
INTGOPTNS(6) = 2 Include buses of boundary transformers ig-
noring subsystem definition voltage limits
INTGOPTNS(7) Option for Transformers to include in worst
case determination (alias is worstcase_trn) (0
by default)
INTGOPTNS(7) = 0 All transformers in study subsystem
INTGOPTNS(7) = 1 All transformers in report subsystem
INTGOPTNS(8) Option for Supplemental event Moving Box
(alias is supp_evt) (0 by default)
INTGOPTNS(8) = 0 No supplemental event
INTGOPTNS(8) = 1 Use supplemental event subsytem SID as the
moving box. For CHAROPTNS(6)='', Orienta-
tion of Efield=REALOPTNS(2), Orientation of
Supplemental Efield=REALOPTNS(7)
INTGOPTNS(8) = 2 Rank substations with maximum GIC flows
as center of the moving box from storm ori-
entation scans that results in maximum VAR
losses. For CHAROPTNS(6)='', Orientation of
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1415
GIC GIC_7
Efield=Supplemental Efield=Orienation that
gives Maximum VAR losses
INTGOPTNS(8) = 3 Rank transformers with maximum GIC flows
as center of the moving box from storm ori-
entation scans. For CHAROPTNS(6)='', Orien-
tation of Efield=Orienation that gives Maxi-
mum VAR losses, Orientation of Supplemen-
tal Efield=Orienation that gives Maximum
GICs in transformer
INTGOPTNS(8) = 4 Use substation number provided as center of
the moving box. For CHAROPTNS(6)='', Ori-
entation of Efield=REALOPTNS(2), Orienta-
tion of Supplemental Efield=REALOPTNS(7)
INTGOPTNS(8) = 5 Use location provided as center of the mov-
ing box. For CHAROPTNS(6)='', Orientation of
Efield=REALOPTNS(2), Orientation of Supple-
mental Efield=REALOPTNS(7)
INTGOPTNS(9) Option for number of Supplemental event
moving boxes. It is not used when int-
goptns(8)=0 and intgoptns(8)=4 (alias is
supp_box_num) (0 by default)
INTGOPTNS(9) = 0 Do not perform moving box calculations
when when intgoptns(8)=1, 2, 3
INTGOPTNS(9) > 0 When intgoptns(8)=1, number of substations
to consider for center of moving box
INTGOPTNS(9) > 0 When intgoptns(8)=2, number of transform-
ers to consider for center of moving box
INTGOPTNS(9) > 0 When intgoptns(8)=3, valid substation num-
ber to consider for center of moving box
INTGOPTNS(10) Option for treatment of the transmission line
that intersect with Supplemental event mov-
ing box (alias is brn_seg_efld) (0 by default)
INTGOPTNS(10) = 0 Apply Supplemental event Efield to line seg-
ment inside the box and Benchmark event
Efield to line segments outside the box
INTGOPTNS(10) = 1 Apply Supplemental event Efield to entire
line when any segment of the line is inside
the box
Real REALOPTNS (17) array of 17 elements specifying Real Options(input).
REALOPTNS(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_mag) (0 by default)
REALOPTNS(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
REALOPTNS(1) > 0 when charoptns(1)=uniform, no default al-
lowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1416
GIC GIC_7
REALOPTNS(1) > 0 when charoptns(1)=benchmark, used as
specified
REALOPTNS(2) electric field direction in degrees,
range 0 to 360 degrees, not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance
REALOPTNS(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
network data (alias is branch_xbyr) (30 by
default)
REALOPTNS(4) = 0 Use default
REALOPTNS(4) > 0 Use specified
REALOPTNS(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
REALOPTNS(5) = 0 Use default
REALOPTNS(5) > 0 Use specified
REALOPTNS(6) supplemental event electric field magnitude
in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (alias is
efield_mag_supp) (realoptns(1) by default)
REALOPTNS(6) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is not zero
REALOPTNS(6) > 0 when charoptns(1)=supplemental
REALOPTNS(7) local GMD hot spots electric field direction in
degrees, range 0 to 360 degrees, not used
when charoptns(1)=nonuniform (alias is
efield_deg_supp) (realoptns(2) by default)
REALOPTNS(7) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is non-zero
REALOPTNS(7) > 0 when charoptns(1)=supplemental
REALOPTNS(8) transmission line AC to DC resistance
conversion factor, must be >0 (alias is
branch_rac2rdc) (1.0 by default)
REALOPTNS(8) = 0 Use default
REALOPTNS(8) > 0 Use specified
REALOPTNS(9) transformer winding AC to DC resistance
conversion factor, must be >0 (alias is
transformer_rac2rdc) (1.0 by default)
REALOPTNS(9) = 0 Use default
REALOPTNS(9) > 0 Use specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1417
GIC GIC_7
REALOPTNS(10) Degree Scan step size, range 1.0 to 180 de-
grees (alias is degscan_step) (10.0 by de-
fault)
REALOPTNS(10) = 0 Use default
REALOPTNS(10) > 0 Use specified
REALOPTNS(11) Magnitude Scan step size, must be >1.0 V/
km (alias is magscan_step) (4.0 by default)
REALOPTNS(11) = 0 Use default
REALOPTNS(11) > 0 Use specified
REALOPTNS(12) Percent GMD Mvar loss step size. Total GMD
Mvar losses added incrementally to the base
case to obtain power flow solution, must
be >1.0 (alias is pf_qpct_step) (100.0 by de-
fault)
REALOPTNS(12) = 0 Use default
REALOPTNS(12) > 0 Use specified
REALOPTNS(13) Magnitude Scan maximum storm strength,
must be >1.0 (alias is magscan_max) (20.0
by default)
REALOPTNS(13) = 0 Use default
REALOPTNS(13) > 0 Use specified
REALOPTNS(14) Supplemental event moving box North-South
length in km, must be >1.0, used when
intgoptns(8)>0 (alias is supp_box_ns_km)
(100.0 by default)
REALOPTNS(14) = 0 Use default
REALOPTNS(14) > 0 Use specified
REALOPTNS(15) Supplemental event moving box East-West
length in km, must be >1.0, used when int-
goptns(8)>0 (alias is supp_box_ew_km)
(500.0 by default)
REALOPTNS(15) = 0 Use default
REALOPTNS(15) > 0 Use specified
REALOPTNS(16) Supplemental event moving box center point
longitude in degrees, used only when int-
goptns(8)=4 (alias is supp_box_lon_c) (0.0
by default)
REALOPTNS(16) = 0 Use default
REALOPTNS(16) > 0 Use specified
REALOPTNS(17) Supplemental event moving box center point
latitude in degrees, used only when int-
goptns(8)=4 (alias is supp_box_lat_c) (0.0 by
default)
REALOPTNS(17) = 0 Use default
REALOPTNS(17) > 0 Use specified
Character*12 CHAROPTNS (7) array of 7 elements specifying Character Options(input).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1418
GIC GIC_7
CHAROPTNS(1) Electric Field Type (alias is efield_type) (uni-
form by default)
CHAROPTNS(1) = uni- for uniform geoelectric field and also supple-
form mental event electric field when intgoptns(3)
and realoptns(6) are non-zero
CHAROPTNS(1) = for benchmark event geoelectric field and
benchmark beta factors (B) and also supplemental event
electric field and beta factors (Bs) when int-
goptns(3) and realoptns(6) are non-zero
CHAROPTNS(1) = for nonuniform geoelectric field
nonuniform
CHAROPTNS(1) = sup- for supplemental event geoelectric field and
plemental beta factors (Bs)
CHAROPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (v/km by default)
CHAROPTNS(2) = v/ for volts/km
km
CHAROPTNS(2) = v/mi for volts/mile
CHAROPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (rdch by default)
CHAROPTNS(3) = sav add updates to Saved Case
CHAROPTNS(3) = rdch create RDCH raw file of GIC updates
CHAROPTNS(4) Option to select method for GIC to Mvar Cal-
culation (alias is gic2mvar_optn) (kfactors by
default)
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
kfactors file when provided, otherwise default scaling
factors
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
capchar file when provided, otherwise scaling factors
from default transformer Mvar and GIC char-
acteristics
CHAROPTNS(5) Earth Model Name. A Standard or User de-
fined model name must be provided when
Benchmark Event or Non-uniform electric
field is to be modeled or Transformer Ther-
mal Analysis is to be performed. (alias is
earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (alias is
scan_storm_event) ( by default)
CHAROPTNS(6) = no storm orientation and/or magnitude scan
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg maximum Var losses when charoptns(1) is
uniform or benchmark, create report for only
orientation that gives maximum VAR losses
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg_rpt maximum Var losses when charoptns(1) is
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1419
GIC GIC_7
uniform or benchmark, create report for each
orientation scanned
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
only final electric field magnitude.
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag_rpt yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
each scanned electric field magnitude.
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans tiil they yield converged power
flow solution, create report for only orienta-
tion that gives maximum VAR losses and final
electric field magnitude
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans till they yield converged power
flow solution, create report for all orientation
scans and mangitude scans performed
CHAROPTNS(7) Option to solve Power Flow with GIC
losses added to the base case (alias is
power_flow_optn) ( by default)
CHAROPTNS(7) = do not perform power flow solution
CHAROPTNS(7) = fdns use fixed slope decoupled Newton-Raphson
method
CHAROPTNS(7) = fnsl use Full Newton-Raphson method
CHAROPTNS(7) = nsol use Decoupled Newton-Raphson method
Real EJETOPTNS (5) array of 5 elements specifying Electrojet Characteristics, used only if
charoptns(1)=nonuniform(input).
EJETOPTNS(1) eletrojet current in million amperes, must be
>0 (alias is ejet_million_amps) (no default al-
lowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (alias is ejet_halfwidth_km) (no default
allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(alias is ejet_period_min) (no default al-
lowed)
EJETOPTNS(4) height of current in km, must be >0 (alias is
ejet_height_km) (no default allowed)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1420
GIC GIC_7
EJETOPTNS(5) latitude of center of electrojet in degrees
(alias is ejet_center_deg) (no default al-
lowed)
Character*260 FILEOPTNS (5) array of 5 elements specifying File Used(input).
FILEOPTNS(1) GIC updates to Base Case file name (output).
(alias is addfile) (blank by default)
FILEOPTNS(1) = ' ' no file created
FILEOPTNS(2) RDCH file to remove GIC updates from GIC
updated case in working memory to set it
back to Base Case network condition (out-
put). (alias is purgfile) (blank by default)
FILEOPTNS(2) = ' ' no file created
FILEOPTNS(3) GIC dc resistive network raw file. This repre-
sents the dc network used to calculate GIC
flow (output). (alias is rnwkfile) (blank by de-
fault)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC Results map data file for given Efield
magnitude and degrees OR Efield magnitude
and degrees scans which give maximum Var
losses when scans are performed (output).
This is used by GICMAPS to plot GIC results
on network map. (alias is pygicfile) (noout-
put by default)
FILEOPTNS(4) = ' ' temporary file created
FILEOPTNS(4) = no file created
nooutput
FILEOPTNS(5) Transformer Thermal Analysis GIC(t) CSV file
(output). (alias is gictfile) (nooutput by de-
fault)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput
Integer RPTOPTNS (8) array of 8 elements specifying Report Options(input).
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1421
GIC GIC_7
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
RPTOPTNS(8) Subsystem sid for report (alias is rpt_sid) (0
by default)
RPTOPTNS(8) = 0 Use study subsystem as report subsystem
RPTOPTNS(8) = 1 Subsystem number (1 - 11). GIC report creat-
ed for buses and branches in this subsystem.
Integer IERR error code (output).
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1422
GIC GIC_8
6.1.8. GIC_8
Use this API to calculate Geomagnetically Induced Currents (GIC) in electric power system network as a re-
sult of Geomagnetic Disturbance (GMD).
This API routine was first introduced in release 34.8.0 and 35.1.0.
Batch command syntax:
BAT_GIC_8 SID ALL INTGOPTNS(1)..INTGOPTNS(10) REALOPTNS(1)..REALOPTNS(19)
CHAROPTNS(1)..CHAROPTNS(7) EJETOPTNS(1)..EJETOPTNS(5)
FILEOPTNS(1)..FILEOPTNS(5) RPTOPTNS(1)..RPTOPTNS(8)
Python command syntax:
ierr = gic_8(sid, all, intgoptns, realoptns, charoptns, ejetoptns,
fileoptns, rptoptns)
Fortran command syntax:
CALL GIC_8(SID, ALL, INTGOPTNS, REALOPTNS, CHAROPTNS, EJETOPTNS,
FILEOPTNS, RPTOPTNS, 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 INTGOPTNS (10) array of 10 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 1 through 5, consider study subsystem buses
+ these many levels of inter-tie buses and ig-
nore subsystem definition voltage limits for
intertie buses added
INTGOPTNS(1) < 0 -1 through -5, consider study subsystem bus-
es + these many levels of inter-tie buses and
consider subsystem definition voltage limits
for intertie buses added
INTGOPTNS(2) Year number to scale benchmark event
GMD storm. These scaling factors account
in the influence of geomagnetic latitude on
the estimated geoelectric field magnitude
and are provided in NERC TPL-007. (alias is
study_year) (0 by default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1423
GIC GIC_8
INTGOPTNS(2) = 0 current year, used in benchmark and supple-
mental geoelectric field calculations only.
INTGOPTNS(2) > 0 specific year
INTGOPTNS(3) Subsystem sid for supplemental GMD event
(alias is sid_supp) (0 by default)
INTGOPTNS(3) = 0 No supplemental GMD event
INTGOPTNS(3) > 0 subsystem number (1 - 11). Buses and
branches in this subsystem will have Efield
due to supplemental GMD event.
INTGOPTNS(4) Option for Transformer Thermal Analysis
(alias is thermal_ana_optn) (0 by default)
INTGOPTNS(4) = -1 perform on all transformers
INTGOPTNS(4) = 0 do not perform
INTGOPTNS(4) > 0 perform on these many top transformers or-
dered by effective GIC flow
INTGOPTNS(5) Option to run power flow for each degree
scan calculation (alias is degscan_pf_optn) (0
by default)
INTGOPTNS(5) = 0 Solve power flow only for worst degree
INTGOPTNS(5) = 1 Solve power flow for each degree scan calcu-
lation
INTGOPTNS(6) Option to include buses of boundary
transformers in study subsystem (alias is
boundary_trn) (0 by default)
INTGOPTNS(6) = 0 consider only study subsystem buses
INTGOPTNS(6) = 1 Include buses of boundary transformers con-
sidering subsystem definition voltage limits
INTGOPTNS(6) = 2 Include buses of boundary transformers ig-
noring subsystem definition voltage limits
INTGOPTNS(7) Option for Transformers to include in worst
case determination (alias is worstcase_trn) (0
by default)
INTGOPTNS(7) = 0 All transformers in study subsystem
INTGOPTNS(7) = 1 All transformers in report subsystem
INTGOPTNS(8) Option for Supplemental event Moving Box
(alias is supp_evt) (0 by default)
INTGOPTNS(8) = 0 No supplemental event
INTGOPTNS(8) = 1 Use supplemental event subsytem SID as the
moving box. For CHAROPTNS(6)='', Orienta-
tion of Efield=REALOPTNS(2), Orientation of
Supplemental Efield=REALOPTNS(7)
INTGOPTNS(8) = 2 Rank substations with maximum GIC flows
as center of the moving box from storm ori-
entation scans that results in maximum VAR
losses. For CHAROPTNS(6)='', Orientation of
Efield=Supplemental Efield=Orienation that
gives Maximum VAR losses
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1424
GIC GIC_8
INTGOPTNS(8) = 3 Rank transformers with maximum GIC flows
as center of the moving box from storm ori-
entation scans. For CHAROPTNS(6)='', Orien-
tation of Efield=Orienation that gives Maxi-
mum VAR losses, Orientation of Supplemen-
tal Efield=Orienation that gives Maximum
GICs in transformer
INTGOPTNS(8) = 4 Use substation number provided as center of
the moving box. For CHAROPTNS(6)='', Ori-
entation of Efield=REALOPTNS(2), Orienta-
tion of Supplemental Efield=REALOPTNS(7)
INTGOPTNS(8) = 5 Use location provided as center of the mov-
ing box. For CHAROPTNS(6)='', Orientation of
Efield=REALOPTNS(2), Orientation of Supple-
mental Efield=REALOPTNS(7)
INTGOPTNS(9) Option for number of Supplemental event
moving boxes. It is not used when int-
goptns(8)=0 and intgoptns(8)=4 (alias is
supp_box_num) (0 by default)
INTGOPTNS(9) = 0 Do not perform moving box calculations
when when intgoptns(8)=1, 2, 3
INTGOPTNS(9) > 0 When intgoptns(8)=1, number of substations
to consider for center of moving box
INTGOPTNS(9) > 0 When intgoptns(8)=2, number of transform-
ers to consider for center of moving box
INTGOPTNS(9) > 0 When intgoptns(8)=3, valid substation num-
ber to consider for center of moving box
INTGOPTNS(10) Option for treatment of the transmission line
that intersect with Supplemental event mov-
ing box (alias is brn_seg_efld) (0 by default)
INTGOPTNS(10) = 0 Apply Supplemental event Efield to line seg-
ment inside the box and Benchmark event
Efield to line segments outside the box
INTGOPTNS(10) = 1 Apply Supplemental event Efield to entire
line when any segment of the line is inside
the box
Real REALOPTNS (19) array of 19 elements specifying Real Options(input).
REALOPTNS(1) electric field magnitude in units de-
fined by charoptns(2), not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_mag) (0 by default)
REALOPTNS(1) = 0 when charoptns(1)=benchmark, when speci-
fied as 0.0, it will be set to 8.0 V/km (default
benchmark event strength)
REALOPTNS(1) > 0 when charoptns(1)=uniform, no default al-
lowed
REALOPTNS(1) > 0 when charoptns(1)=benchmark, used as
specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1425
GIC GIC_8
REALOPTNS(2) electric field direction in degrees,
range 0 to 360 degrees, not used when
charoptns(1)=nonuniform or supplemental
(alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance
REALOPTNS(4) transmission line X/R ratio, must be >0, used
to calculate branch DC resistance if R=0.0 in
network data (alias is branch_xbyr) (30 by
default)
REALOPTNS(4) = 0 Use default
REALOPTNS(4) > 0 Use specified
REALOPTNS(5) transformer winding X/R ratio, must be
>0, used to calculate winding DC resis-
tance if R=0.0 in network data (alias is
transformer_xbyr) (30 by default)
REALOPTNS(5) = 0 Use default
REALOPTNS(5) > 0 Use specified
REALOPTNS(6) supplemental event electric field magnitude
in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (alias is
efield_mag_supp) (realoptns(1) by default)
REALOPTNS(6) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is not zero
REALOPTNS(6) > 0 when charoptns(1)=supplemental
REALOPTNS(7) local GMD hot spots electric field direction in
degrees, range 0 to 360 degrees, not used
when charoptns(1)=nonuniform (alias is
efield_deg_supp) (realoptns(2) by default)
REALOPTNS(7) > 0 when charoptns(1)=uniform or benchmark
and intgoptns(3) is non-zero
REALOPTNS(7) > 0 when charoptns(1)=supplemental
REALOPTNS(8) transmission line AC to DC resistance
conversion factor, must be >0 (alias is
branch_rac2rdc) (1.0 by default)
REALOPTNS(8) = 0 Use default
REALOPTNS(8) > 0 Use specified
REALOPTNS(9) transformer winding AC to DC resistance
conversion factor, must be >0 (alias is
transformer_rac2rdc) (1.0 by default)
REALOPTNS(9) = 0 Use default
REALOPTNS(9) > 0 Use specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1426
GIC GIC_8
REALOPTNS(10) Degree Scan step size, range 1.0 to 180 de-
grees (alias is degscan_step) (10.0 by de-
fault)
REALOPTNS(10) = 0 Use default
REALOPTNS(10) > 0 Use specified
REALOPTNS(11) Magnitude Scan step size, must be >1.0 V/
km (alias is magscan_step) (4.0 by default)
REALOPTNS(11) = 0 Use default
REALOPTNS(11) > 0 Use specified
REALOPTNS(12) Percent GMD Mvar loss step size. Total GMD
Mvar losses added incrementally to the base
case to obtain power flow solution, must
be >1.0 (alias is pf_qpct_step) (100.0 by de-
fault)
REALOPTNS(12) = 0 Use default
REALOPTNS(12) > 0 Use specified
REALOPTNS(13) Magnitude Scan maximum storm strength,
must be >1.0 (alias is magscan_max) (20.0
by default)
REALOPTNS(13) = 0 Use default
REALOPTNS(13) > 0 Use specified
REALOPTNS(14) Supplemental event moving box North-South
length in km, must be >1.0, used when
intgoptns(8)>0 (alias is supp_box_ns_km)
(100.0 by default)
REALOPTNS(14) = 0 Use default
REALOPTNS(14) > 0 Use specified
REALOPTNS(15) Supplemental event moving box East-West
length in km, must be >1.0, used when int-
goptns(8)>0 (alias is supp_box_ew_km)
(500.0 by default)
REALOPTNS(15) = 0 Use default
REALOPTNS(15) > 0 Use specified
REALOPTNS(16) Supplemental event moving box center point
longitude in degrees, used only when int-
goptns(8)=4 (alias is supp_box_lon_c) (0.0
by default)
REALOPTNS(16) = 0 Use default
REALOPTNS(16) > 0 Use specified
REALOPTNS(17) Supplemental event moving box center point
latitude in degrees, used only when int-
goptns(8)=4 (alias is supp_box_lat_c) (0.0 by
default)
REALOPTNS(17) = 0 Use default
REALOPTNS(17) > 0 Use specified
REALOPTNS(18) Branch segment length in km, used to cal-
culate branch induced voltage from Efield
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1427
GIC GIC_8
Grid, must be >0.0. Branch is subdivided in-
to number of segements (points along the
branch route) and NN algorithm finds near-
est geoelectric efield grid data point to ar-
rive efield at that branch route point. (alias is
brn_segkm) (5.0 by default)
REALOPTNS(18) = 0.0 Use default
REALOPTNS(18) > 0 Use specified
REALOPTNS(19) Branch subsegment length in km, used to
calculate branch induced voltage from Efield
Grid, range 0.02 to 1.0 km. When efield
value at branch route point changes, that
branch segment is further subdivided into
smaller segments to arrive at branch route
point where NN algorithm efield change oc-
curs. (alias is brn_subsegkm) (0.1 by default)
REALOPTNS(19) = 0.0 Use default
REALOPTNS(19) > 0 Use specified
Character*12 CHAROPTNS (7) array of 7 elements specifying Character Options(input).
CHAROPTNS(1) Electric Field Type (alias is efield_type) (uni-
form by default)
CHAROPTNS(1) = uni- for uniform geoelectric field and also supple-
form mental event electric field when intgoptns(3)
and realoptns(6) are non-zero
CHAROPTNS(1) = for benchmark event geoelectric field and
benchmark beta factors (B) and also supplemental event
electric field and beta factors (Bs) when int-
goptns(3) and realoptns(6) are non-zero
CHAROPTNS(1) = for nonuniform geoelectric field per elctrojet
nonuniform characteristics and complex image method
CHAROPTNS(1) = sup- for supplemental event geoelectric field and
plemental beta factors (Bs)
CHAROPTNS(1) = for nonuniform geoelectric field per specified
efieldgrid efield grid data and nearest neighbor algo-
rithm
CHAROPTNS(2) Units of Electric Field Magnitude (alias is
efield_unit) (v/km by default)
CHAROPTNS(2) = v/ for volts/km
km
CHAROPTNS(2) = v/mi for volts/mile
CHAROPTNS(3) Option to add GIC updates to base case (alias
is addfile_optn) (rdch by default)
CHAROPTNS(3) = sav add updates to Saved Case
CHAROPTNS(3) = rdch create RDCH raw file of GIC updates
CHAROPTNS(4) Option to select method for GIC to Mvar Cal-
culation (alias is gic2mvar_optn) (kfactors by
default)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1428
GIC GIC_8
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
kfactors file when provided, otherwise default scaling
factors
CHAROPTNS(4) = for GIC to Mvar scaling factors from GIC data
capchar file when provided, otherwise scaling factors
from default transformer Mvar and GIC char-
acteristics
CHAROPTNS(5) Earth Model Name. A Standard or User de-
fined model name must be provided when
Benchmark Event or Non-uniform electric
field is to be modeled or Transformer Ther-
mal Analysis is to be performed. (alias is
earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (alias is
scan_storm_event) ( by default)
CHAROPTNS(6) = no storm orientation and/or magnitude scan
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg maximum Var losses when charoptns(1) is
uniform or benchmark, create report for only
orientation that gives maximum VAR losses
CHAROPTNS(6) = perform storm orientation scan that give
scan_deg_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, create report for each
orientation scanned
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
only final electric field magnitude.
CHAROPTNS(6) = perform storm electric field magnitude that
scan_mag_rpt yield converged power flow solution when
charoptns(1) is uniform or benchmark and
charoptns(7) specifies PF method. It uses
orienation specified and creates report for
each scanned electric field magnitude.
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans tiil they yield converged power
flow solution, create report for only orienta-
tion that gives maximum VAR losses and final
electric field magnitude
CHAROPTNS(6) = perform storm orientation scan that give
scan_d_m_rpt maximum Var losses when charoptns(1) is
uniform or benchmark, then perform mag-
nitude scans till they yield converged power
flow solution, create report for all orientation
scans and mangitude scans performed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1429
GIC GIC_8
CHAROPTNS(7) Option to solve Power Flow with GIC
losses added to the base case (alias is
power_flow_optn) ( by default)
CHAROPTNS(7) = do not perform power flow solution
CHAROPTNS(7) = fdns use fixed slope decoupled Newton-Raphson
method
CHAROPTNS(7) = fnsl use Full Newton-Raphson method
CHAROPTNS(7) = nsol use Decoupled Newton-Raphson method
CHAROPTNS(7) = rsol use Robust solution method
CHAROPTNS(7) = last use solution method used in input Saved
case file
Real EJETOPTNS (5) array of 5 elements specifying Electrojet Characteristics, used only if
charoptns(1)=nonuniform(input).
EJETOPTNS(1) eletrojet current in million amperes, must be
>0 (alias is ejet_million_amps) (no default al-
lowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (alias is ejet_halfwidth_km) (no default
allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(alias is ejet_period_min) (no default al-
lowed)
EJETOPTNS(4) height of current in km, must be >0 (alias is
ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees
(alias is ejet_center_deg) (no default al-
lowed)
Character*260 FILEOPTNS (5) array of 5 elements specifying File Used(input).
FILEOPTNS(1) GIC updates to Base Case file name (output).
(alias is addfile) (blank by default)
FILEOPTNS(1) = ' ' no file created
FILEOPTNS(2) RDCH file to remove GIC updates from GIC
updated case in working memory to set it
back to Base Case network condition (out-
put). (alias is purgfile) (blank by default)
FILEOPTNS(2) = ' ' no file created
FILEOPTNS(3) GIC dc resistive network raw file. This repre-
sents the dc network used to calculate GIC
flow (output). (alias is rnwkfile) (blank by de-
fault)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC Results map data file for given Efield
magnitude and degrees OR Efield magnitude
and degrees scans which give maximum Var
losses when scans are performed (output).
This is used by GICMAPS to plot GIC results
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1430
GIC GIC_8
on network map. (alias is pygicfile) (noout-
put by default)
FILEOPTNS(4) = ' ' temporary file created
FILEOPTNS(4) = no file created
nooutput
FILEOPTNS(5) Transformer Thermal Analysis GIC(t) CSV file
(output). (alias is gictfile) (nooutput by de-
fault)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput
Integer RPTOPTNS (8) array of 8 elements specifying Report Options(input).
RPTOPTNS(1) what to report (alias is rptoptn) (-1 by de-
fault)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report
RPTOPTNS(1) > 0 Report these many maximum values in each
category
RPTOPTNS(2) report induced branch voltages (alias is
rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (alias is rptdc_busv)
(0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (alias is rptbrn_gic)
(0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (alias is rpttrn_q) (1
by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
RPTOPTNS(8) Subsystem sid for report (alias is rpt_sid) (0
by default)
RPTOPTNS(8) = 0 Use study subsystem as report subsystem
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1431
GIC GIC_8
RPTOPTNS(8) = 1 Subsystem number (1 - 11). GIC report creat-
ed for buses and branches in this subsystem.
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 Topology error, bus type code and series ele-
ment status inconsistencies
IERR = 4 Invalid INTGOPTNS value, set to default
IERR = 5 Invalid REALOPTNS value, no default allowed
IERR = 6 Invalid REALOPTNS value, set to default
IERR = 7 Invalid RPTOPTNS value, set to default value
IERR = 8 Electric Field Value must be greater than 0.0
IERR = 9 Error opening GIC File
IERR = 10 Error opening GIC ADD File
IERR = 11 Error opening GIC PURG File
IERR = 12 Error opening GIC DC NETWORK File
IERR = 13 No substation data provided
IERR = 14 No substation data specified for following GIC
study subsystem buses
IERR = 15 No buses in GIC study subsystem
IERR = 16 No GIC data input file provided
IERR = 17 No non-transformer branches in working case
IERR = 18 No non-transformer branches in GIC study
subsystem
IERR = 19 Prerequisite requirements for API are not met
IERR = 20 Invalid localized GMD hot spots subsystem
SID
IERR = 21 No buses in local GMD hot spots subsystem
IERR = 22 Invalid CHAROPTNS value, set to default
IERR = 23 Invalid EJETOPTNS value
IERR = 24 Benchmark Event default GMD strength dif-
ferent than standard strength
IERR = 25 Invalid REALOPTNS value, set to default value
IERR = 26 Transformer T model GIC data: WRI, WRJ and
WRK dc resistances must be specified for T
model
IERR = 27 Info - The Geographic Coordinates of the
magnetic dipole axis for study year %% are
not defined, used data from year %%
IERR = 28 gic.dll not loaded or entry point not found
IERR = 29 Error - All transformers must have vector
group specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1432
GIC GIC_8
IERR = 30 Invalid Magnitude Scan maximum storm
strength
IERR = 31 Error - No substations exist in specified mov-
ing box
IERR = 32 Error - Specified moving box center substa-
tion does not exist in the case
IERR = 33 Error - No Geoelectric Efield Grid Data provid-
ed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1433
GIC GIC_BRANCH_EFIELD_NN
6.1.9. GIC_BRANCH_EFIELD_NN
Use this API to calculate geoelectric efield induced in the network branches from specified geoelectric
efield grid data using nearest neigbor (NN) alogorithm.
This API routine was first introduced in release 4.8.0 and 35.1.0.
Batch command syntax:
BAT_GIC_BRANCH_EFIELD_NN SID ALL INTGOPTNS(1)..INTGOPTNS(3)
REALOPTNS(1)..REALOPTNS(2)
Python command syntax:
ierr = gic_branch_efield_nn(sid, all, intgoptns, realoptns)
Fortran command syntax:
CALL GIC_BRANCH_EFIELD_NN(SID, ALL, INTGOPTNS, REALOPTNS, 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 INTGOPTNS (4) array of 4 elements specifying Integer Options(input).
INTGOPTNS(1) Number of levels of inter-tie buses to add to
study subsystem (alias is tielevels) (0 by de-
fault)
INTGOPTNS(1) = 0 consider only study subsystem buses, no
buses from inter-ties
INTGOPTNS(1) > 0 1 through 5, consider study subsystem buses
+ these many levels of inter-tie buses and ig-
nore subsystem definition voltage limits for
intertie buses added
INTGOPTNS(1) < 0 -1 through -5, consider study subsystem bus-
es + these many levels of inter-tie buses and
consider subsystem definition voltage limits
for intertie buses added
INTGOPTNS(2) Flag to do branch route segment scan to
find efield grid index same as previous route
point efield grid index (alias is brn_segscan)
(1 by default)
INTGOPTNS(2) = 0 no branch segment scan, efield grid index at
each segment point is used to get segment
induced voltage
INTGOPTNS(2) = 1 perform branch segment scan
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1434
GIC GIC_BRANCH_EFIELD_NN
INTGOPTNS(3) Flag to merge branch route segments with
same efield grid index. This only affects how
the branch route induced voltage is reported.
(alias is brn_segmerge) (1 by default)
INTGOPTNS(3) = 0 do not merge segments
INTGOPTNS(3) = 1 merge segments
INTGOPTNS(4) Report Option (alias is rptoptn) (1 by default)
INTGOPTNS(4) = 0 no report
INTGOPTNS(4) = 1 summary report
INTGOPTNS(4) = 2 detailed report
INTGOPTNS(4) = 3 both summary and detailed reports
Real REALOPTNS (2) array of 2 elements specifying Real Options(input).
REALOPTNS(1) Branch segment length in km, used to cal-
culate branch induced voltage from Efield
Grid, must be >0.0. Branch is subdivided in-
to number of segements (points along the
branch route) and NN algorithm finds near-
est geoelectric efield grid data point to ar-
rive efield at that branch route point. (alias is
brn_segkm) (5.0 by default)
REALOPTNS(1) = 0.0 Use default
REALOPTNS(1) > 0 Use specified
REALOPTNS(2) Branch subsegment length in km, used to
calculate branch induced voltage from Efield
Grid, range 0.02 to 1.0 km. When efield
value at branch route point changes, that
branch segment is further subdivided into
smaller segments to arrive at branch route
point where NN efield change occurs. (alias
is brn_subsegkm) (0.1 by default)
REALOPTNS(2) = 0.0 Use default
REALOPTNS(2) > 0 Use specified
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 INTGOPTNS value, set to default
IERR = 4 Invalid REALOPTNS value, set to default
IERR = 5 Topology error, bus type code and series ele-
ment status inconsistencies
IERR = 6 No Efield Grid Data provided'
IERR = 7 No substations in the working case (or added
from GIC data)
IERR = 8 No buses in GIC study subsystem
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1435
GIC GIC_EARTH1D_USR_PURG
6.1.10. GIC_EARTH1D_USR_PURG
Use this API to purge GIC User 1D Earth Model data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_EARTH1D_USR_PURG NAME
Python command syntax:
ierr = gic_earth1d_usr_purg(name)
Fortran command syntax:
CALL GIC_EARTH1D_USR_PURG(NAME,IERR)
Where:
Character*32 NAME 1D Earth Model name. The non-blank alphanumeric identifier as-
signed to earth model. The name should be unique and different
than standard earth model names defined in TPL-007. (input; no de-
fault allowed).
Integer IERR error code (output).
IERR = 0 no errors 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
1436
GIC GIC_EFIELD_WAVESHAPE
6.1.11. GIC_EFIELD_WAVESHAPE
For Transformer Thermal Impact assessement due to geomagnetic disturbance event, set the geoelectric
field waveshape as provided in EFLDFILE.
This API routine was first introduced in release 33.10.0 and 34.2.0.
Batch command syntax:
BAT_GIC_EFIELD_WAVESHAPE EFLDFILE
Python command syntax:
ierr = gic_efield_waveshape(efldfile)
Fortran command syntax:
CALL GIC_EFIELD_WAVESHAPE(EFLDFILE, IERR)
Where:
Character*260 EFLDFILE name of the Geoelectric Field Waveshape data points file (input; no
default allowed).
Integer IERR error code (output).
IERR = 1 Prerequisite requirements for API are not met,
GIC(t) calculations not done
IERR = 2 Error opening GIC Electric Field Waveshape
Data file, GIC(t) calculations not done
IERR = 3 Error reading GIC Electric Field Waveshape
Data file, GIC(t) calculations not done
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1437
GIC GIC_EFIELD_WAVESHAPE_REF
6.1.12. GIC_EFIELD_WAVESHAPE_REF
For Transformer Thermal Impact assessement due to geomagnetic disturbance event, set the geoelectric
field waveshape as NERC TPL-007-2 benhcmark event.
This API routine was first introduced in release 33.10.0 and 34.2.0.
Batch command syntax:
BAT_GIC_EFIELD_WAVESHAPE_REF
Python command syntax:
ierr = gic_efield_waveshape_ref()
Fortran command syntax:
CALL GIC_EFIELD_WAVESHAPE_REF(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1438
GIC GIC_EFIELD_WAVESHAPE_SUPP
6.1.13. GIC_EFIELD_WAVESHAPE_SUPP
For Transformer Thermal Impact assessement due to geomagnetic disturbance event, set the geoelectric
field waveshape as NERC TPL-007-2 supplemental event.
This API routine was first introduced in release 33.12.0 and 34.4.0.
Batch command syntax:
BAT_GIC_EFIELD_WAVESHAPE_SUPP
Python command syntax:
ierr = gic_efield_waveshape_supp()
Fortran command syntax:
CALL GIC_EFIELD_WAVESHAPE_SUPP(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1439
GIC GIC_MVARLOSS_SCALING_FACTORS
6.1.14. GIC_MVARLOSS_SCALING_FACTORS
Specify KFACTORS to determine transformer reactive power losses due to geomagnetic currents (GICs)
flow.
This API routine was first introduced in release 32.2.1.
Batch command syntax:
BAT_GIC_MVARLOSS_SCALING_FACTORS KFACTORS(1)..KFACTORS(9)
Python command syntax:
ierr = gic_mvarloss_scaling_factors(kfactors)
Fortran command syntax:
CALL GIC_MVARLOSS_SCALING_FACTORS(KFACTORS, IERR)
Where:
Real KFACTORS (9) array of elements specifying Kfactor values. The values are as fol-
lows.(input).
KFACTORS(1) Voltage level at which these kfactors are
specified
KFACTORS(2) kfactor value for Shell form transformers
KFACTORS(3) kfactor value for core design - Single Phase
(three separate cores) transformers
KFACTORS(4) kfactor value for core design - Three Phase 3
legged core form transformers
KFACTORS(5) kfactor value for core design - Three Phase 5
legged core form transformers
KFACTORS(6) kfactor value for core design - Three Phase 7
legged core form transformers
KFACTORS(7) kfactor value for unknown core, voltage level
of <=200 kV
KFACTORS(8) kfactor value for unknown core, voltage level
of <200 kV and <=400 kV
KFACTORS(9) kfactor value for unknown core, voltage level
of >400 kV
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 DLL not loaded or entry point not found.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1440
GIC GIC_NEW
6.1.15. GIC_NEW
Use this API to initialize all data records required for GIC analysis. It must be called prior to introducing any
GIC data records. It has no effect if GIC data already exists in the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_NEW
Python command syntax:
ierr = gic_new()
Fortran command syntax:
CALL GIC_NEW(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = 2 error initializing GIC data
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1441
GIC GIC_PF_OPTIONS
6.1.16. GIC_PF_OPTIONS
Use this API to specify the Newton-Raphson power flow solution options used in GIC.
This API routine was first introduced in release 34.5.0.
Batch command syntax:
BAT_GIC_PF_OPTIONS OPTIONS(1)..OPTIONS(8)
Python command syntax:
ierr = gic_pf_options(options)
Fortran command syntax:
CALL GIC_PF_OPTIONS(OPTIONS, IERR)
Where:
Integer OPTIONS (8) array of 8 elements specifying Newton-Raphson power flow 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
1442
GIC GIC_PF_OPTIONS
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 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1443
GIC GIC_PURG
6.1.17. GIC_PURG
Use this API to purge all GIC data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_PURG
Python command syntax:
ierr = gic_purg()
Fortran command syntax:
CALL GIC_PURG(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
1444
GIC GIC_READ
6.1.18. GIC_READ
Use this API to read GIC Data Text (.gic) File into the working case memory.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_READ RFILE
Python command syntax:
ierr = gic_read(rfile)
Fortran command syntax:
CALL GIC_READ(RFILE, IERR)
Where:
Character*260 RFILE GIC Data File name (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 error opening file
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
1445
GIC GIC_READ_EFIELD_GRID
6.1.19. GIC_READ_EFIELD_GRID
Use this API to read Geoelectric Efield Grid Data File into the working case memory.
This API routine was first introduced in release 34.8.0 and 35.1.0.
Batch command syntax:
BAT_GIC_READ_EFIELD_GRID FTYP, FNAM
Python command syntax:
ierr = gic_read_efield_grid(ftyp, fnam)
Fortran command syntax:
CALL GIC_READ_EFIELD_GRID(FTYP, FNAM, IERR)
Where:
Integer FTYP File format type (input; 0 by default).
FTYP = 0 csv format, column order: latitude (deg), lon-
gitude (deg), Ee (V/km), En (V/km)
FTYP = 1 USGS json format [coordinates [lon, lat] in
deg, Ex(=En) and Ey(=Ee) in mV/km
Character*260 FNAM Efield Grid Data File name (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 prerequisite requirements for API are not met
IERR = 2 error opening Efield Grid data file
IERR = 3 error reading Efield Grid data file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1446
GIC GIC_THERMAL_IMPACT
6.1.20. GIC_THERMAL_IMPACT
This API routine is obsolete. It has been replaced by the API routine gic_thermal_impact_1 .
Use this API to calculate Transformer Thermal Impact assessement GIC(t) curve using specified effective
Eastward GIC(E) and Nortward GIC(N) for one specific transformer. The geoelectric field waveshape used
could be NERC TPL-007-2 Benchmark event, NERC TPL-007-2 Supplemental event or User specified event.
This API routine was first introduced in release 33.10.0 and 34.2.0.
Batch command syntax:
BAT_GIC_THERMAL_IMPACT GICEARG, GICNARG, XMERLBL, GICTFARG
Python command syntax:
ierr = gic_thermal_impact(gicearg, gicnarg, xmerlbl, gictfarg)
Fortran command syntax:
CALL GIC_THERMAL_IMPACT(GICEARG, GICNARG, XMERLBL, GICTFARG, IERR)
Where:
Real GICEARG Transfomer effective per phase GIC due to Eastward geoelectic field,
GIC(E) due to Ee=1 V/km and En=0, with alpha and beta factors ap-
plied (input; 0 by default).
Real GICNARG Transfomer effective per phase GIC due to Northward geoelectic
field, GIC(N) due to En=1 V/km and Ee=0, with alpha and beta factors
applied (input; 0 by default).
Character*40 XMERLBL Transfomer Name (input; '' by default).
Character*260 GICTFARG Transformer Thermal Analysis GIC(t) CSV file (output) (input; '' by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 No or invalid GICEARG value provided
IERR = 1 No or invalid GICNARG value provided
IERR = 3 No GMD Event EE(t) and EN(t) data available
IERR = 4 Error opening GIC(t) File
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1447
GIC GIC_THERMAL_IMPACT_1
6.1.21. GIC_THERMAL_IMPACT_1
Use this API to calculate Transformer Thermal Impact assessement GIC(t) curve using specified effective
Eastward GIC(E) and Nortward GIC(N) for one specific transformer. The geoelectric field waveshape used
could be NERC TPL-007 Benchmark event, NERC TPL-007 Supplemental event or User specified event.
This API routine was first introduced in release 34.8.0 and 35.1.0.
Batch command syntax:
BAT_GIC_THERMAL_IMPACT_1 GICEARG, GICNARG, XMERLBL, GICTFARG IEVT
Python command syntax:
ierr = gic_thermal_impact_1(gicearg, gicnarg, xmerlbl, gictfarg, ievt)
Fortran command syntax:
CALL GIC_THERMAL_IMPACT_1(GICEARG, GICNARG, XMERLBL, GICTFARG, IEVT, IERR)
Where:
Real GICEARG Transfomer effective per phase GIC due to Eastward geoelectic field,
GIC(E) due to Ee=1 V/km and En=0, with alpha and beta factors ap-
plied (input; 0 by default).
Real GICNARG Transfomer effective per phase GIC due to Northward geoelectic
field, GIC(N) due to En=1 V/km and Ee=0, with alpha and beta factors
applied (input; 0 by default).
Character*40 XMERLBL Transfomer Name (input; '' by default).
Character*260 GICTFARG Transformer Thermal Analysis GIC(t) CSV file (output) (input; '' by de-
fault).
Integer IEVT GMD Event Type (input; 0 by default).
IEVT = 0 TPL-007 Benchmark or User Specified Refer-
ence GMD Event
IEVT = 1 TPL-007 Supplemental GMD Event
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 No or invalid GICEARG value provided
IERR = 1 No or invalid GICNARG value provided
IERR = 3 No GMD Event EE(t) and EN(t) data available
IERR = 4 Error opening GIC(t) File
IERR = 5 No or invalid IEVT value provided
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1448
GIC GIC_WRITE
6.1.22. GIC_WRITE
Use this API to write working case GIC Data to text (.gic) file.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_WRITE RFILE
Python command syntax:
ierr = gic_write(rfile)
Fortran command syntax:
CALL GIC_WRITE(RFILE, IERR)
Where:
Character*260 RFILE GIC Data File name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 error opening file
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
1449
GIC GIC_WRITE_STN
6.1.23. GIC_WRITE_STN
Use this API to write working case GIC Data to text (.gic) file version 4 that has substation data.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_GIC_WRITE_STN RFILE
Python command syntax:
ierr = gic_write_stn(rfile)
Fortran command syntax:
CALL GIC_WRITE_STN(RFILE, IERR)
Where:
Character*260 RFILE GIC Data File name (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 error opening file
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
1450
GIC GIC_WRITE_STN
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1451
GIC GIC_WRITE_STN
GIC Operation APIs contains API routines corresponding to the operational functions of the GIC features of
PSS®E.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1452
GIC GIC Data
6.2. GIC Data
6.2.1. GIC_2TDC
Use this API to modify or add new two terminal dc GIC shunt data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_2TDC NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_2tdc(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_2TDC(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME DC line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, two terminal
dc shunt is ignored in DC network. (alias is r)
(0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, two ter-
minal dc is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1453
GIC GIC_2TDC_CHNG
6.2.2. GIC_2TDC_CHNG
Use this API to modify new two terminal dc GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_2TDC_CHNG NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_2tdc_chng(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_2TDC_CHNG(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME DC line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, two terminal
dc shunt is ignored in DC network. (alias is r)
(0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, two ter-
minal dc is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1454
GIC GIC_2TDC_PURG
6.2.3. GIC_2TDC_PURG
Use this API to purge new two terminal dc GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_2TDC_PURG NAME BUS CKT
Python command syntax:
ierr = gic_2tdc_purg(name,bus,ckt)
Fortran command syntax:
CALL GIC_2TDC_PURG(NAME,BUS,CKT,IERR)
Where:
Character*12 NAME DC line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1455
GIC GIC_BRN
6.2.4. GIC_BRN
Use this API to modify or add new GIC branch data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_BRN IBUS JBUS CKT REALAR(1)..REALAR(5)
Python command syntax:
ierr = gic_brn(ibus,jbus,ckt,realar)
Fortran command syntax:
CALL GIC_BRN(IBUS,JBUS,CKT,REALAR,IERR)
Where:
Integer IBUS From bus number of the branch as in the working case. (input; no de-
fault allowed).
Integer JBUS To bus number of the branch as in the working case. (input; no de-
fault allowed).
Character*2 CKT branch circuit identifier (input; '1' by default).
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) DC resistance of the branch in ohms/phase.
When RBRN is not specified, working case re-
sistance is used to determine RBRN. (alias is
rbrn) (0.0 by default)
REALAR(2) Real part of total branch GMD-induced geo-
electric field in volts. When INDVP is not
specified, it is calculated as per GMD event.
(alias is indvp) (no default allowed)
REALAR(3) Imaginary part of total branch GMD-induced
geoelectric field in volts. When INDVP is not
specified, it is calculated as per GMD event.
(alias is indvq) (no default allowed)
REALAR(4) DC resistance in ohms/phase of the line
shunt at bus IBUS end of the branch. When
RLNSHI=0.0 or not specified, there is no
ground path this line shunt in DC network.
(alias is rlnshi) (0.0 by default)
REALAR(5) DC resistance in ohms/phase of the line
shunt at bus JBUS end of the branch. When
RLNSHJ=0.0 or not specified, there is no
ground path this line shunt in DC network.
(alias is rlnshj) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1456
GIC GIC_BRN
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
1457
GIC GIC_BRN_CHNG
6.2.5. GIC_BRN_CHNG
Use this API to modify new GIC branch data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_BRN_CHNG IBUS JBUS CKT REALAR(1)..REALAR(5)
Python command syntax:
ierr = gic_brn_chng(ibus,jbus,ckt,realar)
Fortran command syntax:
CALL GIC_BRN_CHNG(IBUS,JBUS,CKT,REALAR,IERR)
Where:
Integer IBUS From bus number of the branch as in the working case. (input; no de-
fault allowed).
Integer JBUS To bus number of the branch as in the working case. (input; no de-
fault allowed).
Character*2 CKT branch circuit identifier (input; '1' by default).
Real REALAR (5) array of 5 elements specifying (input).
REALAR(1) DC resistance of the branch in ohms/phase.
When RBRN is not specified, working case re-
sistance is used to determine RBRN. (alias is
rbrn) (0.0 by default)
REALAR(2) Real part of total branch GMD-induced geo-
electric field in volts. When INDVP is not
specified, it is calculated as per GMD event.
(alias is indvp) (no default allowed)
REALAR(3) Imaginary part of total branch GMD-induced
geoelectric field in volts. When INDVP is not
specified, it is calculated as per GMD event.
(alias is indvq) (no default allowed)
REALAR(4) DC resistance in ohms/phase of the line
shunt at bus IBUS end of the branch. When
RLNSHI=0.0 or not specified, there is no
ground path this line shunt in DC network.
(alias is rlnshi) (0.0 by default)
REALAR(5) DC resistance in ohms/phase of the line
shunt at bus JBUS end of the branch. When
RLNSHJ=0.0 or not specified, there is no
ground path this line shunt in DC network.
(alias is rlnshj) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors occurred
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1458
GIC GIC_BRN_CHNG
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
1459
GIC GIC_BRN_PURG
6.2.6. GIC_BRN_PURG
Use this API to purge GIC branch data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_BRN_PURG IBUS JBUS CKT
Python command syntax:
ierr = gic_brn_purg(ibus,jbus,ckt)
Fortran command syntax:
CALL GIC_BRN_PURG(IBUS,JBUS,CKT,IERR)
Where:
Integer IBUS From bus number of the branch as in the working case. (input; no de-
fault allowed).
Integer JBUS To bus number of the branch as in the working case. (input; no de-
fault allowed).
Character*2 CKT branch circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1460
GIC GIC_EARTH1D_USR
6.2.7. GIC_EARTH1D_USR
Use this API to modify or add new GIC User 1D Earth Model data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_EARTH1D_USR NAME DESC REALAR(1) REALAR(2) LAYERS RHO(1)..RHO(N)
THICKNESS(1)..THICKNESS(N)
Python command syntax:
ierr = gic_earth1d_usr(name,desc,realar,layers,rho,thickness)
Fortran command syntax:
CALL GIC_EARTH1D_USR(NAME,DESC,REALAR,LAYERS,RHO,THICKNESS,IERR)
Where:
Character*32 NAME 1D Earth Model name. The non-blank alphanumeric identifier as-
signed to earth model. The name should be unique and different
than standard earth model names defined in TPL-007. (input; no de-
fault allowed).
Character*32 DESC Earth Model description. It is used for information purpose only.. (in-
put; blank).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) Benchmark event scaling factor (alias is beta)
(1.0 by default)
REALAR(2) Supplemental event scaling factor (alias is
betas) (1.0 by default)
Integer LAYERS number of layers of earth model rho and thickness (input; no default
allowed).
Real RHO (layers) array of 'layers' values specifying earth model layer resistivity in ohm-
m. All values must be > 0. (input; no default allowed).
Real THICKNESS (layers) array of 'layers' values specifying earth model layer thickness in km.
All values must be > 0 except last layer. The last layer thickness is in-
finity, specified as any number < 0. (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no errors 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
1461
GIC GIC_EARTH1D_USR_CHNG
6.2.8. GIC_EARTH1D_USR_CHNG
Use this API to modify GIC User 1D Earth Model data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_EARTH1D_USR_CHNG NAME DESC REALAR(1) REALAR(2) LAYERS
RHO(1)..RHO(N) THICKNESS(1)..THICKNESS(N)
Python command syntax:
ierr = gic_earth1d_usr_chng(name,desc,realar,layers,rho,thickness)
Fortran command syntax:
CALL GIC_EARTH1D_USR_CHNG(NAME,DESC,REALAR,LAYERS,RHO,THICKNESS,IERR)
Where:
Character*32 NAME 1D Earth Model name. The non-blank alphanumeric identifier as-
signed to earth model. The name should be unique and different
than standard earth model names defined in TPL-007. (input; no de-
fault allowed).
Character*32 DESC Earth Model description. It is used for information purpose only.. (in-
put; blank).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) Benchmark event scaling factor (alias is beta)
(1.0 by default)
REALAR(2) Supplemental event scaling factor (alias is
betas) (1.0 by default)
Integer LAYERS number of layers of earth model rho and thickness (input; no default
allowed).
Real RHO (layers) array of 'layers' values specifying earth model layer resistivity in ohm-
m. All values must be > 0. (input; no default allowed).
Real THICKNESS (layers) array of 'layers' values specifying earth model layer thickness in km.
All values must be > 0 except last layer. The last layer thickness is in-
finity, specified as any number < 0. (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no errors 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
1462
GIC GIC_FACTS
6.2.9. GIC_FACTS
Use this API to modify or add new FACTS device GIC shunt data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_FACTS NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_facts(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_FACTS(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME FACTS device name, must exist in the working case (input; no default
allowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, FACTS device
shunt is ignored in DC network. (alias is r)
(0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, FACTS de-
vice is treated as solidly grounded when part
of DC network. (alias is rg) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1463
GIC GIC_FACTS_CHNG
6.2.10. GIC_FACTS_CHNG
Use this API to modify new FACTS device GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_FACTS_CHNG NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_facts_chng(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_FACTS_CHNG(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME FACTS device name, must exist in the working case (input; no default
allowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, FACTS device
shunt is ignored in DC network. (alias is r)
(0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, FACTS de-
vice is treated as solidly grounded when part
of DC network. (alias is rg) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1464
GIC GIC_FACTS_PURG
6.2.11. GIC_FACTS_PURG
Use this API to purge new FACTS device GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_FACTS_PURG NAME BUS CKT
Python command syntax:
ierr = gic_facts_purg(name,bus,ckt)
Fortran command syntax:
CALL GIC_FACTS_PURG(NAME,BUS,CKT,IERR)
Where:
Character*12 NAME FACTS device name, must exist in the working case (input; no default
allowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1465
GIC GIC_FXSH
6.2.12. GIC_FXSH
Use this API to modify or add new fixed shunt GIC shunt data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_FXSH BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_fxsh(bus,ckt,realar)
Fortran command syntax:
CALL GIC_FXSH(BUS,CKT,REALAR,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, fixed shunt is
ignored in DC network. (alias is r) (0.0 by de-
fault)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, fixed
shunt is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1466
GIC GIC_FXSH_CHNG
6.2.13. GIC_FXSH_CHNG
Use this API to modify fixed shunt GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_FXSH_CHNG BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_fxsh_chng(bus,ckt,realar)
Fortran command syntax:
CALL GIC_FXSH_CHNG(BUS,CKT,REALAR,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, fixed shunt is
ignored in DC network. (alias is r) (0.0 by de-
fault)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, fixed
shunt is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1467
GIC GIC_FXSH_PURG
6.2.14. GIC_FXSH_PURG
Use this API to purge fixed shunt GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_FXSH_PURG BUS CKT
Python command syntax:
ierr = gic_fxsh_purg(bus,ckt)
Fortran command syntax:
CALL GIC_FXSH_PURG(BUS,CKT,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1468
GIC GIC_LOAD
6.2.15. GIC_LOAD
Use this API to modify or add new load GIC shunt data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_LOAD BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_load(bus,ckt,realar)
Fortran command syntax:
CALL GIC_LOAD(BUS,CKT,REALAR,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, fixed shunt is
ignored in DC network. (alias is r) (0.0 by de-
fault)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, fixed
shunt is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1469
GIC GIC_LOAD_CHNG
6.2.16. GIC_LOAD_CHNG
Use this API to modify load GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_LOAD_CHNG BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_load_chng(bus,ckt,realar)
Fortran command syntax:
CALL GIC_LOAD_CHNG(BUS,CKT,REALAR,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, fixed shunt is
ignored in DC network. (alias is r) (0.0 by de-
fault)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, fixed
shunt is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1470
GIC GIC_LOAD_PURG
6.2.17. GIC_LOAD_PURG
Use this API to purge load GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_LOAD_PURG BUS CKT
Python command syntax:
ierr = gic_load_purg(bus,ckt)
Fortran command syntax:
CALL GIC_LOAD_PURG(BUS,CKT,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1471
GIC GIC_MTDC
6.2.18. GIC_MTDC
Use this API to modify or add new multi terminal dc GIC shunt data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_MTDC NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_mtdc(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_MTDC(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME mtdc line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, multi termi-
nal dc shunt is ignored in DC network. (alias
is r) (0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, multi ter-
minal dc is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1472
GIC GIC_MTDC_CHNG
6.2.19. GIC_MTDC_CHNG
Use this API to modify new multi terminal dc GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_MTDC_CHNG NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_mtdc_chng(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_MTDC_CHNG(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME mtdc line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, multi termi-
nal dc shunt is ignored in DC network. (alias
is r) (0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, multi ter-
minal dc is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1473
GIC GIC_MTDC_PURG
6.2.20. GIC_MTDC_PURG
Use this API to purge new multi terminal dc GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_MTDC_PURG NAME BUS CKT
Python command syntax:
ierr = gic_mtdc_purg(name,bus,ckt)
Fortran command syntax:
CALL GIC_MTDC_PURG(NAME,BUS,CKT,IERR)
Where:
Character*12 NAME mtdc line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1474
GIC GIC_SUBSTN
6.2.21. GIC_SUBSTN
Use this API to modify or add new GIC sub station data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_SUBSTN SUBNUM REALAR(1) CHARAR(1) EARTHMDL
Python command syntax:
ierr = gic_substn(subnum,realar,charar,earthmdl)
Fortran command syntax:
CALL GIC_SUBSTN(SUBNUM,REALAR,CHARAR,EARTHMDL,IERR)
Where:
Integer SUBNUM sub station number (input; no default allowed).
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Substation grounding DC resistance in ohms.
For ungrounded substation RG <=0 or RG
>=99 (alias is rg) (0.1 by default)
Character*40 CHARAR (1) array of 1 elements specifying (input).
CHARAR(1) Method used to specify RG value, RGFLAG
may be up to 40 characters. It is used for in-
formational purposes only. (alias is rgflag)
Character*32 EARTHMDL sub station earth conductivity model name (input; '' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1475
GIC GIC_SUBSTN_CHNG
6.2.22. GIC_SUBSTN_CHNG
Use this API to modify GIC sub station data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_SUBSTN_CHNG SUBNUM REALAR(1) CHARAR(1) EARTHMDL
Python command syntax:
ierr = gic_substn_chng(subnum,realar,charar,earthmdl)
Fortran command syntax:
CALL GIC_SUBSTN_CHNG(SUBNUM,REALAR,CHARAR,EARTHMDL,IERR)
Where:
Integer SUBNUM sub station number (input; no default allowed).
Real REALAR (1) array of 1 elements specifying (input).
REALAR(1) Substation grounding DC resistance in ohms.
For ungrounded substation RG <=0 or RG
>=99 (alias is rg) (0.1 by default)
Character*40 CHARAR (1) array of 1 elements specifying (input).
CHARAR(1) Method used to specify RG value, RGFLAG
may be up to 40 characters. It is used for in-
formational purposes only. (alias is rgflag)
Character*32 EARTHMDL sub station earth conductivity model name (input; '' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1476
GIC GIC_SUBSTN_PURG
6.2.23. GIC_SUBSTN_PURG
Use this API to purge GIC sub station data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_SUBSTN_PURG SUBNUM
Python command syntax:
ierr = gic_substn_purg(subnum)
Fortran command syntax:
CALL GIC_SUBSTN_PURG(SUBNUM,IERR)
Where:
Integer SUBNUM sub station number (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no errors 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
1477
GIC GIC_SWSH
6.2.24. GIC_SWSH
Use this API to modify or add new GIC switched shunt data to the working case. Use this when switched
shunt is described by the bus number and its circuit identifier.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_SWSH BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_swsh(bus,ckt,realar)
Fortran command syntax:
CALL GIC_SWSH(BUS,CKT,REALAR,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be >
0. When R is not specified or R=0, switched
shunt is ignored in DC network. (alias is r)
(0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, switched
shunt is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1478
GIC GIC_SWSH_CHNG
6.2.25. GIC_SWSH_CHNG
Use this API to modify GIC switched shunt data from the working case. Use this when switched shunt is de-
scribed by the bus number and its circuit identifier.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_SWSH_CHNG BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_swsh_chng(bus,ckt,realar)
Fortran command syntax:
CALL GIC_SWSH_CHNG(BUS,CKT,REALAR,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be >
0. When R is not specified or R=0, switched
shunt is ignored in DC network. (alias is r)
(0.0 by default)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, switched
shunt is treated as solidly grounded when
part of DC network. (alias is rg) (0.0 by de-
fault)
Integer IERR error code (output).
IERR = 0 no errors 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
1479
GIC GIC_SWSH_PURG
6.2.26. GIC_SWSH_PURG
Use this API to purge GIC switched shunt data from the working case. Use this when switched shunt is de-
scribed by the bus number and its circuit identifier.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_SWSH_PURG BUS CKT
Python command syntax:
ierr = gic_swsh_purg(bus,ckt)
Fortran command syntax:
CALL GIC_SWSH_PURG(BUS,CKT,IERR)
Where:
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1480
GIC GIC_TRN
6.2.27. GIC_TRN
Use this API to modify or add new GIC transformer data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_TRN IBUS JBUS KBUS CKT INTGAR(1)..INTGAR(5) REALAR(1)..REALAR(7)
VECGRP
Python command syntax:
ierr = gic_trn(ibus,jbus,kbus,ckt,intgar,realar,vecgrp)
Fortran command syntax:
CALL GIC_TRN(IBUS,JBUS,KBUS,CKT,INTGAR,REALAR,VECGRP,IERR)
Where:
Integer IBUS The bus number of the bus to which Winding 1 is connected. It must
be same Winding 1 bus of the same transformer in the working case.
(input; no default allowed).
Integer JBUS The bus number of the bus to which Winding 2 is connected. It must
be same Winding 2 bus of the same transformer in the working case.
(input; no default allowed).
Integer KBUS The bus number of the bus to which Winding 3 is connected. It must
be same Winding 3 bus of the same transformer in the working case.
KBUS=0 for two winding transformers. No default allowed for three
winding transformers. (input; 0 by default).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) GIC blocking device in neutral of Winding 1.
For an auto-transformers, if either BDI=1 or
BDJ=1, that auto-transformer is treated as if
it has GIC blocking device present. (alias is
bdi) (0 by default)
INTGAR(1) = 0 no GIC blocking device present
INTGAR(1) = 1 GIC blocking device present
INTGAR(2) GIC blocking device in neutral of Winding 2.
For an auto-transformers, if either BDI=1 or
BDJ=1, that auto-transformer is treated as if
it has GIC blocking device present. (alias is
bdj) (0 by default)
INTGAR(2) = 0 no GIC blocking device present
INTGAR(2) = 1 GIC blocking device present
INTGAR(3) GIC blocking device in neutral of Winding 3.
(alias is bdk) (0 by default)
INTGAR(3) = 0 no GIC blocking device present
INTGAR(3) = 1 GIC blocking device present
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1481
GIC GIC_TRN
INTGAR(4) Number of cores in transformer core design.
This information is used to calculate trans-
former reactive power loss from GIC flowing
its winding. (alias is core) (0 by default)
INTGAR(4) = -1 three phase shell form
INTGAR(4) = 0 unknown core design
INTGAR(4) = 1 single phase core
INTGAR(4) = 3 three phase 3-legged core form
INTGAR(4) = 5 three phase 5-legged core form
INTGAR(5) Model transformer as T-model in GIC DC Net-
work (alias is tmodel) (0 by default)
INTGAR(5) = 0 two/three/auto transformer model as defined
by its vector group
INTGAR(5) = 1 transformer as T-model in DC network
Real REALAR (7) array of 7 elements specifying (input).
REALAR(1) DC resistance of Winding 1 in ohms/phase.
When WRI is not specified, working case re-
sistance is used to determine WRI. (alias is
wri) (0.0 by default)
REALAR(2) DC resistance of Winding 2 in ohms/phase.
When WRJ is not specified, working case re-
sistance is used to determine WRJ. (alias is
wrj) (0.0 by default)
REALAR(3) DC resistance of Winding 2 in ohms/phase.
When WRK is not specified, working case re-
sistance is used to determine WRK. (alias is
wrk) (0.0 by default)
REALAR(4) Factor to calculate transformer reactive
power loss from the GIC flow in its winding
(MVAR/AMP) (alias is kfactor) (0.0 by default)
REALAR(5) Winding 1 grounding DC resistance in ohms.
When GRDWRI=0.0, there is no grounding
resistance and winding is solidly grounded.
(alias is grdwri) (0.0 by default)
REALAR(6) Winding 2 grounding DC resistance in ohms.
When GRDWRJ=0.0, there is no grounding
resistance and winding is solidly grounded.
(alias is grdwrj) (0.0 by default)
REALAR(7) Winding 3 grounding DC resistance in ohms.
When GRDWRK=0.0, there is no grounding
resistance and winding is solidly grounded.
(alias is grdwrk) (0.0 by default)
Character*12 VECGRP Alphanumeric identifier specifying vector group based on trans-
former winding connections and phase angles. When vector group is
blank, its value is taken form power flow data. (input; '' by default).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1482
GIC GIC_TRN
IERR = 0 no errors 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
1483
GIC GIC_TRN_CHNG
6.2.28. GIC_TRN_CHNG
Use this API to modify GIC transformer data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_TRN_CHNG IBUS JBUS KBUS CKT INTGAR(1)..INTGAR(5)
REALAR(1)..REALAR(7) VECGRP
Python command syntax:
ierr = gic_trn_chng(ibus,jbus,kbus,ckt,intgar,realar,vecgrp)
Fortran command syntax:
CALL GIC_TRN_CHNG(IBUS,JBUS,KBUS,CKT,INTGAR,REALAR,VECGRP,IERR)
Where:
Integer IBUS The bus number of the bus to which Winding 1 is connected. It must
be same Winding 1 bus of the same transformer in the working case.
(input; no default allowed).
Integer JBUS The bus number of the bus to which Winding 2 is connected. It must
be same Winding 2 bus of the same transformer in the working case.
(input; no default allowed).
Integer KBUS The bus number of the bus to which Winding 3 is connected. It must
be same Winding 3 bus of the same transformer in the working case.
KBUS=0 for two winding transformers. No default allowed for three
winding transformers. (input; 0 by default).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer INTGAR (5) array of 5 elements specifying (input).
INTGAR(1) GIC blocking device in neutral of Winding 1.
For an auto-transformers, if either BDI=1 or
BDJ=1, that auto-transformer is treated as if
it has GIC blocking device present. (alias is
bdi) (0 by default)
INTGAR(1) = 0 no GIC blocking device present
INTGAR(1) = 1 GIC blocking device present
INTGAR(2) GIC blocking device in neutral of Winding 2.
For an auto-transformers, if either BDI=1 or
BDJ=1, that auto-transformer is treated as if
it has GIC blocking device present. (alias is
bdj) (0 by default)
INTGAR(2) = 0 no GIC blocking device present
INTGAR(2) = 1 GIC blocking device present
INTGAR(3) GIC blocking device in neutral of Winding 3.
(alias is bdk) (0 by default)
INTGAR(3) = 0 no GIC blocking device present
INTGAR(3) = 1 GIC blocking device present
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1484
GIC GIC_TRN_CHNG
INTGAR(4) Number of cores in transformer core design.
This information is used to calculate trans-
former reactive power loss from GIC flowing
its winding. (alias is core) (0 by default)
INTGAR(4) = -1 three phase shell form
INTGAR(4) = 0 unknown core design
INTGAR(4) = 1 single phase core
INTGAR(4) = 3 three phase 3-legged core form
INTGAR(4) = 5 three phase 5-legged core form
INTGAR(5) Model transformer as T-model in GIC DC Net-
work (alias is tmodel) (0 by default)
INTGAR(5) = 0 two/three/auto transformer model as defined
by its vector group
INTGAR(5) = 1 transformer as T-model in DC network
Real REALAR (7) array of 7 elements specifying (input).
REALAR(1) DC resistance of Winding 1 in ohms/phase.
When WRI is not specified, working case re-
sistance is used to determine WRI. (alias is
wri) (0.0 by default)
REALAR(2) DC resistance of Winding 2 in ohms/phase.
When WRJ is not specified, working case re-
sistance is used to determine WRJ. (alias is
wrj) (0.0 by default)
REALAR(3) DC resistance of Winding 2 in ohms/phase.
When WRK is not specified, working case re-
sistance is used to determine WRK. (alias is
wrk) (0.0 by default)
REALAR(4) Factor to calculate transformer reactive
power loss from the GIC flow in its winding
(MVAR/AMP) (alias is kfactor) (0.0 by default)
REALAR(5) Winding 1 grounding DC resistance in ohms.
When GRDWRI=0.0, there is no grounding
resistance and winding is solidly grounded.
(alias is grdwri) (0.0 by default)
REALAR(6) Winding 2 grounding DC resistance in ohms.
When GRDWRJ=0.0, there is no grounding
resistance and winding is solidly grounded.
(alias is grdwrj) (0.0 by default)
REALAR(7) Winding 3 grounding DC resistance in ohms.
When GRDWRK=0.0, there is no grounding
resistance and winding is solidly grounded.
(alias is grdwrk) (0.0 by default)
Character*12 VECGRP Alphanumeric identifier specifying vector group based on trans-
former winding connections and phase angles. When vector group is
blank, its value is taken form power flow data. (input; '' by default).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1485
GIC GIC_TRN_CHNG
IERR = 0 no errors 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
1486
GIC GIC_TRN_PURG
6.2.29. GIC_TRN_PURG
Use this API to purge GIC transformer data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_TRN_PURG IBUS JBUS KBUS CKT
Python command syntax:
ierr = gic_trn_purg(ibus,jbus,kbus,ckt)
Fortran command syntax:
CALL GIC_TRN_PURG(IBUS,JBUS,KBUS,CKT,IERR)
Where:
Integer IBUS The bus number of the bus to which Winding 1 is connected. It must
be same Winding 1 bus of the same transformer in the working case.
(input; no default allowed).
Integer JBUS The bus number of the bus to which Winding 2 is connected. It must
be same Winding 2 bus of the same transformer in the working case.
(input; no default allowed).
Integer KBUS The bus number of the bus to which Winding 3 is connected. It must
be same Winding 3 bus of the same transformer in the working case.
KBUS=0 for two winding transformers. No default allowed for three
winding transformers. (input; 0 by default).
Character*2 CKT transformer circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1487
GIC GIC_VSCDC
6.2.30. GIC_VSCDC
Use this API to modify or add new vscdc GIC shunt data to the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_VSCDC NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_vscdc(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_VSCDC(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME vscdc line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, vscdc shunt is
ignored in DC network. (alias is r) (0.0 by de-
fault)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, vscdc is
treated as solidly grounded when part of DC
network. (alias is rg) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1488
GIC GIC_VSCDC_CHNG
6.2.31. GIC_VSCDC_CHNG
Use this API to modify new vscdc GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_VSCDC_CHNG NAME BUS CKT REALAR(1) REALAR(2)
Python command syntax:
ierr = gic_vscdc_chng(name,bus,ckt,realar)
Fortran command syntax:
CALL GIC_VSCDC_CHNG(NAME,BUS,CKT,REALAR,IERR)
Where:
Character*12 NAME vscdc line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Real REALAR (2) array of 2 elements specifying (input).
REALAR(1) DC resistance in ohms/phase. R must be > 0.
When R is not specified or R=0, vscdc shunt is
ignored in DC network. (alias is r) (0.0 by de-
fault)
REALAR(2) Grounding DC resistance in ohms/phase.
When RG is not specified or RG=0, vscdc is
treated as solidly grounded when part of DC
network. (alias is rg) (0.0 by default)
Integer IERR error code (output).
IERR = 0 no errors 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
1489
GIC GIC_VSCDC_PURG
6.2.32. GIC_VSCDC_PURG
Use this API to purge new vscdc GIC shunt data from the working case.
This API routine was first introduced in release 34.8.0.
Batch command syntax:
BAT_GIC_VSCDC_PURG NAME BUS CKT
Python command syntax:
ierr = gic_vscdc_purg(name,bus,ckt)
Fortran command syntax:
CALL GIC_VSCDC_PURG(NAME,BUS,CKT,IERR)
Where:
Character*12 NAME vscdc line name, must exist in the working case (input; no default al-
lowed).
Integer BUS base case bus number, must exist in the working case (input; no de-
fault allowed).
Character*2 CKT GIC DC shunt circuit identifier (input; '1' by default).
Integer IERR error code (output).
IERR = 0 no errors 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
1490
GIC GIC_VSCDC_PURG
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1491
GIC GIC_VSCDC_PURG
GIC Data Changing APIs contains API routines specific to adding, modifying, and deleting GIC data.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1492
Chapter 7
Dynamics Simulation
This chapter describes the API routines used in PSS®E Dynamic Simulation.
This chapter is divided into sections for General Operations, Output Channel Operations, detailed routines
for dealing with models, by type, and finally setting disturbances.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1493
Dynamics Simulation Dynamic Simulation Operation
7.1. Dynamic Simulation Operation
Dynamic Simulation Operation contains API routines that deals with general operations of dynamics simu-
lation functions, including option settings and reports.
7.1.1. ADDMODELLIBRARY
Use this API to add a library to the list to be searched for library models.
This API routine was first introduced in release 30.3.0.
Batch command syntax:
BAT_ADDMODELLIBRARY LIBRARYNAME
Python command syntax:
ierr = addmodellibrary(libraryname)
Fortran command syntax:
CALL ADDMODELLIBRARY(LIBRARYNAME, IERR)
Where:
Character*260 LIBRARYNAME name of the library of model programs (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 library not found
IERR = 2 library load failed
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
1494
Dynamics Simulation ASTR
7.1.2. ASTR
Use this API to calculate and replicates the state variable system matrices in the form required by the Linear
Dynamic Analysis Program, LSYSAN (activity ASTR).
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_ASTR OPTION MAXDERIV PERTURB NSTATE MINSTATE(1)..MINSTATE(NSTATE)
MAXSTATE(1)..MAXSTATE(NSTATE) NOUTPUT MINCHAN(1)..MINCHAN(NOUTPUT)
MAXCHAN(1)..MAXCHAN(NOUTPUT) NINPUT INTYPE(1)..INTYPE(NINPUT)
INPERT(1)..INPERT(NINPUT) INBUS(1)..INBUS(NINPUT)
INMCID(1)..INMCID(NINPUT) INIDENT(1)..INIDENT(NINPUT) OUTFILE
Python command syntax:
ierr = astr(option, maxderiv, perturb, nstate, minstate, maxstate,
noutput, minchan, maxchan, ninput, intype, inpert, inbus, inmcid,
inident, outfile)
Fortran command syntax:
CALL ASTRAPI(OPTION, MAXDERIV, PERTURB, NSTATE, MINSTATE, MAXSTATE,
NOUTPUT, MINCHAN, MAXCHAN, NINPUT, INTYPE, INPERT, INBUS, INMCID,
INIDENT, OUTFILE, IERR)
Where:
Integer OPTION network solution convergence monitor option (input; 0 by default).
OPTION = 1 automatically print the convergence monitor.
OPTION = 0 print the convergence monitor only if it is en-
abled via the CM interrupt control code.
Real MAXDERIV largest derivative threshold for considering that the initialization re-
flects a steady-state condition (input; 0.01).
Real PERTURB amount by which the specified state variables are to be perturbed
(input; 0.01).
Integer NSTATE number of state variable ranges defining those state variables that
are to be perturbed; 0 to include all STATEs (input; 0 by default).
Integer MINSTATE (NSTATE) a list of starting STATE indices defining the ranges of state variables
to be perturbed; ignored if NSTATE = 0 (input; no default allowed).
Integer MAXSTATE (NSTATE) a list of ending STATE indices defining the ranges of state variables to
be perturbed; ignored if NSTATE = 0 (input; no default allowed).
Integer NOUTPUT number of channel ranges defining those output channels that are to
be included in the system output vector; 0 to use the first 'NCHAN' or
50, whichever is less (input; 0 by default).
Integer MINCHAN (NOUTPUT) a list of starting channel indices defining the ranges of output chan-
nels to be included in the system output vector; ignored if NOUTPUT
= 0 (input; no default allowed).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1495
Dynamics Simulation ASTR
Integer MAXCHAN (NOUTPUT) a list of ending channel indices defining the ranges of output chan-
nels to be included in the system output vector; ignored if NOUTPUT
= 0 (input; no default allowed).
Integer NINPUT number of system variables that are to be perturbed (input; 0 by de-
fault).
Integer INTYPE (NINPUT) a list of variable type codes; ignored if NINPUT = 0 (input; no default
allowed).
INTYPE = 1 EFD, generator main field voltage (pu)
INTYPE = 2 PMECH, turbine mechanical power (pu on
MBASE)
INTYPE = 3 VOTHSG, stabilizer output signal (pu)
INTYPE = 4 VREF, voltage regulator voltage setpoint (pu)
INTYPE = 5 VAR
Real INPERT (NINPUT) a list of perturbation factors to be applied to those system variables
that are to be perturbed; ignored if NINPUT = 0 (input; PERTURB).
Integer INBUS (NINPUT) a list of buses (when the corresponding INTYPE is 1 through 4) and/
or VAR indices (when the corresponding INTYPE is 5) used to define
those system variables that are to be perturbed; ignored if NINPUT =
0 (input; no default allowed).
Character*2 INMCID (NINPUT) a list of machine identifiers used to define those system variables
that are to be perturbed (when the corresponding INTYPE is 1
through 4; ignored when the corresponding INTYPE is 5); ignored if
NINPUT = 0 (input; '1' by default).
Character*32 INIDENT (NINPUT) a list of text strings used to identify those system variables that are to
be perturbed; ignored if NINPUT = 0. If a blank identifier is specified,
the ASTR API provides an appropriate identifier (input; blank by de-
fault).
Character*260 OUTFILE name of the Matrix Output File into which the results of this API's cal-
culation are to be placed; this file may then be used as to the LSYSAN
program (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 generators are not converted
IERR = 2 invalid OPTION value
IERR = 3 invalid MAXDERIV value
IERR = 4 invalid PERTURB value
IERR = 5 derivative threshold exceeded--not in steady
state
IERR = 6 invalid code of input to be perturbed
IERR = 7 invalid perturbation amount
IERR = 8 machine is out-of-service
IERR = 9 invalid VAR index
IERR = 10 attempting to select more STATEs than are in
the system model
IERR = 11 too many channels selected
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1496
Dynamics Simulation ASTR
IERR = 12 prior initialization modified the loads--pick up
original converted case
IERR = 13 error opening OUTFILE
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
1497
Dynamics Simulation AULIST
7.1.3. AULIST
Use this API to list auxiliary signal models that inject signals into dc lines or FACTS devices connected to
subsystem buses, along with their storage locations in the dynamics data arrays.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_AULIST SID ALL STATUS
Python command syntax:
ierr = aulist(sid, all, status)
Fortran command syntax:
CALL AULIST(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 active/bypassed flag (input; 0 by default).
STATUS = 0 active and bypassed models
STATUS = 1 active models only
STATUS = 2 bypassed models only
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 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
1498
Dynamics Simulation CHANGE_CHANNEL_OUT_FILE
7.1.4. CHANGE_CHANNEL_OUT_FILE
Use this API to modify the dynamic simulation channel output filename in dynamics working memory (see
PSSE Program Operation Manual, activity ALTR).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_CHANGE_CHANNEL_OUT_FILE OUTFILE
Python command syntax:
ierr = change_channel_out_file(outfile)
Fortran command syntax:
CALL CHANGE_CHANNEL_OUT_FILE(OUTFILE, IERR)
Where:
Character*260 OUTFILE name of the Channel Output File (blank to bypass recording of the
output channel values in a Channel Output File) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 error opening OUTFILE
IERR = 2 prerequisite requirements for API are not met
IERR = -1 warnings: - None
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1499
Dynamics Simulation CHANGE_CHRICN
7.1.5. CHANGE_CHRICN
Use this API to change the value of an element of the CHRICN array (a character ICON). The element is
specified relative to the beginning of the CHRICN array.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CHANGE_CHRICN NUMBER 'NEWVAL'
Python command syntax:
ierr = change_chricn(number, newval)
Fortran command syntax:
CALL CHANGE_CHRICN(NUMBER, NEWVAL, IERR)
Where:
Integer NUMBER CHRICN number or array index (must be between 1 and the number
of ICONs allowed at the present size level of PSSE) (input; no default
allowed).
Character*12 NEWVAL new value to be assigned to CHRICN (NUMBER) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid CHRICN index
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
1500
Dynamics Simulation CHANGE_CON
7.1.6. CHANGE_CON
Use this API to change the value of an element of the CON array. The element is specified relative to the
beginning of the CON array.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CHANGE_CON NUMBER NEWVAL
Python command syntax:
ierr = change_con(number, newval)
Fortran command syntax:
CALL CHANGE_CON(NUMBER, NEWVAL, IERR)
Where:
Integer NUMBER CON number or array index (must be between 1 and the number of
CONs allowed at the present size level of PSSE) (input; no default al-
lowed).
Real NEWVAL new value to be assigned to CON (NUMBER) (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid CON index
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
1501
Dynamics Simulation CHANGE_GREF
7.1.7. CHANGE_GREF
Use this API to change the value of the element of the GREF (governor reference) array associated with a
specified machine.
This API routine was first introduced in release 31.0.2.
Batch command syntax:
BAT_CHANGE_GREF IBUS 'ID' NEWVAL
Python command syntax:
ierr = change_gref(ibus, id, newval)
Fortran command syntax:
CALL CHANGE_GREF(IBUS, ID, NEWVAL, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Real NEWVAL new value to be assigned to the GREF array entry associated with ma-
chine ID at bus IBUS (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 machine not found
IERR = 3 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - No turbine-gov-
ernor model at this machine - Turbine-gover-
nor model at this machine is bypassed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1502
Dynamics Simulation CHANGE_ICON
7.1.8. CHANGE_ICON
Use this API to change the value of an element of the ICON array (an integer ICON). The element is speci-
fied relative to the beginning of the ICON array.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CHANGE_ICON NUMBER NEWVAL
Python command syntax:
ierr = change_icon(number, newval)
Fortran command syntax:
CALL CHANGE_ICON(NUMBER, NEWVAL, IERR)
Where:
Integer NUMBER ICON number or array index (must be between 1 and the number of
ICONs allowed at the present size level of PSSE) (input; no default al-
lowed).
Integer NEWVAL new value to be assigned to ICON (NUMBER) (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid ICON index
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
1503
Dynamics Simulation CHANGE_STATE
7.1.9. CHANGE_STATE
Use this API to change the value of an element of the STATE array, as well as the values of the correspond-
ing time derivative (DSTATE) and the associated memory cell used in the integration algorithm (STORE).
The element is specified relative to the beginning of the STATE array.
Note: Although this API may be used to modify the value of a state variable (along with its time deriva-
tive and integration memory cell) used in state-space and response test simulations, this ability is rarely
required in normal dynamic simulation work. Unless some very special purpose is being served, this API
should not be used.
Note: This API should never be used during extended term simulations.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_STATE NUMBER NEWVAL(1)..NEWVAL(3)
Python command syntax:
ierr = change_state(number, newval)
Fortran command syntax:
CALL CHANGE_STATE(NUMBER, NEWVAL, IERR)
Where:
Integer NUMBER STATE number or array index (must be between 1 and the number of
STATEs allowed at the present size level of PSSE) (input; no default al-
lowed).
Real NEWVAL (3) array of 3 elements specifying (input).
NEWVAL(1) new value to be assigned to STATE(NUMBER)
(unchanged by default)
NEWVAL(2) new value to be assigned to
DSTATE(NUMBER) (unchanged by default)
NEWVAL(3) new value to be assigned to STORE(NUMBER)
(unchanged by default)
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATE index
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
1504
Dynamics Simulation CHANGE_SWSREF
7.1.10. CHANGE_SWSREF
This API routine is obsolete. It has been replaced by the API routine change_swsref_2 .
Use this API to change the value of the element of the SWREF array associated with a specified switched
shunt.
This API routine was first introduced in release 32.2.1.
Batch command syntax:
BAT_CHANGE_SWSREF IBUS NEWVAL
Python command syntax:
ierr = change_swsref(ibus, newval)
Fortran command syntax:
CALL CHANGE_SWSREF(IBUS, NEWVAL, IERR)
Where:
Integer IBUS switched shunt bus number (input).
Real NEWVAL new value to be assigned to the SWSREF array entry associated with
switched shunt at bus IBUS (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 switched shunt not found
IERR = 2 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - no table mode for
switched shunt at this bus. - switched shunt
dynamic model at this switched shunt is by-
passed.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1505
Dynamics Simulation CHANGE_SWSREF_2
7.1.11. CHANGE_SWSREF_2
Use this API to change the value of the element of the SWREF array associated with a specified switched
shunt.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_CHANGE_SWSREF_2 IBUS ID NEWVAL
Python command syntax:
ierr = change_swsref_2(ibus, id, newval)
Fortran command syntax:
CALL CHANGE_SWSREF_2(IBUS, ID, NEWVAL, IERR)
Where:
Integer IBUS switched shunt bus number (input).
Character*2 ID switched shunt identifier (input; blank by default).
Real NEWVAL new value to be assigned to the SWSREF array entry associated with
switched shunt at bus IBUS (input).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 switched shunt not found
IERR = 2 prerequisite requirements for API are not met
IERR = -1 data error, warning and information mes-
sages; one or more of: - no table mode for
switched shunt at this bus. - switched shunt
dynamic model at this switched shunt is by-
passed.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1506
Dynamics Simulation CHANGE_VAR
7.1.12. CHANGE_VAR
Use this API to change the value of an element of the VAR array. The element is specified relative to the be-
ginning of the VAR array.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_VAR NUMBER NEWVAL
Python command syntax:
ierr = change_var(number, newval)
Fortran command syntax:
CALL CHANGE_VAR(NUMBER, NEWVAL, IERR)
Where:
Integer NUMBER VAR number or array index (must be between 1 and the number of
VARs allowed at the present size level of PSSE) (input; no default al-
lowed).
Real NEWVAL new value to be assigned to VAR (NUMBER) (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid VAR index
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
1507
Dynamics Simulation CHANGE_VREF
7.1.13. CHANGE_VREF
Use this API to change the value of the element of the VREF array associated with a specified machine.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_VREF IBUS 'ID' NEWVAL
Python command syntax:
ierr = change_vref(ibus, id, newval)
Fortran command syntax:
CALL CHANGE_VREF(IBUS, ID, NEWVAL, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Real NEWVAL new value to be assigned to the VREF array entry associated with ma-
chine ID at bus IBUS (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 machine not found
IERR = 3 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - No excitation
system model at this machine - Excitation sys-
tem model at this machine is bypassed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1508
Dynamics Simulation DCLIST
7.1.14. DCLIST
Use this API to list dc line models connected to subsystem buses along with their storage locations in the
dynamics data arrays.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_DCLIST SID ALL STATUS(1) STATUS(2)
Python command syntax:
ierr = dclist(sid, all, status)
Fortran command syntax:
CALL DCLIST(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 (2) array of 2 elements specifying a two-element array(input).
STATUS(1) active/bypassed flag (0 by default)
STATUS(1) = 0 list active and bypassed models
STATUS(1) = 1 list active models only
STATUS(1) = 2 list bypassed models only
STATUS(2) dc line model type (1 by default)
STATUS(2) = 1 two-terminal dc line models
STATUS(2) = 2 multi-terminal dc line models
STATUS(2) = 3 VSC dc line models
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 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
1509
Dynamics Simulation DLST
7.1.15. DLST
Use this API to tabulate specified portions of one or more of the PSSE dynamics data storage arrays.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_DLST NTYPE ATYPE(1)..ATYPE(NTYPE) FIRST(1)..FIRST(NTYPE)
LAST(1)..LAST(NTYPE)
Python command syntax:
ierr = dlst(ntype, atype, first, last)
Fortran command syntax:
CALL DLSTAPI(NTYPE, ATYPE, FIRST, LAST, IERR)
Where:
Integer NTYPE number of array portion specifications to be supplied; must be be-
tween 1 and 6, inclusive (input; no default allowed).
Integer ATYPE (NTYPE) a list of PSSE array type codes. No more than one occurrence of each
of the valid ATYPE values is allowed in each use of this API (input; no
default allowed).
ATYPE = 1 for CONs
ATYPE = 2 for STATEs
ATYPE = 3 for VARs
ATYPE = 4 for ICONs and CHRICNs
ATYPE = 5 for output channels
ATYPE = 6 for CRT plot channels
Integer FIRST (NTYPE) a list of starting indices in the data array(s) specified by the corre-
sponding ATYPE entry (input; 1 by default).
Integer LAST (NTYPE) a list of ending indices in the data array(s) specified by the corre-
sponding ATYPE entry (input; next available - 1 by default for ATYPE =
1 through 5; 6 by default for ATYPE = 6).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid NTYPE value
IERR = 2 invalid ATYPE value (entry skipped)
IERR = 3 ATYPE value previously specified (entry
skipped)
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
1510
Dynamics Simulation DOCU
7.1.16. DOCU
Use this API to tabulate the data associated with equipment models referenced in the user's simulation set-
up.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_DOCU SID ALL STATUS(1)..STATUS(3)
Python command syntax:
ierr = docu(sid, all, status)
Fortran command syntax:
CALL DOCUNW(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 (3) array of 3 elements specifying reporting options(input).
STATUS(1) processing mode (0 by default)
STATUS(1) = 0 reporting mode
STATUS(1) = 1 data checking mode
STATUS(2) models to process (3 by default)
STATUS(2) = 0 process all CONEC models
STATUS(2) = 1 process all CONET models
STATUS(2) = 2 process all CHAN models
STATUS(2) = 3 process models by subsystem
STATUS(2) = 4 process Miscellaneous, "other," type models
STATUS(3) value depends on the value of STATUS(2). If
STATUS(2) = 3 then STATUS(3) is the type of
model for which data is to be processed (1 by
default)
If STATUS(2) = 4:
STATUS(3) = 0 Miscellaneous "Other" model. DOCU for
every model instance
STATUS(3) > 0 Miscellaneous "Other" model. DOCU for the
specified model instance
If STATUS(2) = 3:
STATUS(3) = 1 all models
STATUS(3) = 2 all plant models
STATUS(3) = 3 generator models
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1511
Dynamics Simulation DOCU
STATUS(3) = 4 compensator models
STATUS(3) = 5 stabilizer models
STATUS(3) = 6 minimum excitation limiter models
STATUS(3) = 7 maximum excitation limiter models
STATUS(3) = 8 excitation system models
STATUS(3) = 9 turbine governor models
STATUS(3) = 10 load characteristic models
STATUS(3) = 11 load relay models
STATUS(3) = 12 line relay models
STATUS(3) = 13 auxiliary signal models
STATUS(3) = 14 two-terminal dc line models
STATUS(3) = 15 multi-terminal dc line models
STATUS(3) = 16 VSC dc line models
STATUS(3) = 17 FACTS device models
STATUS(3) = 18 CONEC models
STATUS(3) = 19 CONET models
STATUS(3) = 20 CHAN models
STATUS(3) = 21 turbine load controller
STATUS(3) = 22 switched shunt models
STATUS(3) = 23 all renewable models
STATUS(3) = 24 renewable generator models
STATUS(3) = 25 renewable electrical control models
STATUS(3) = 26 renewable mechanical system models
STATUS(3) = 27 renewable pitch models
STATUS(3) = 28 renewable aerodynamic models
STATUS(3) = 29 renewable gust models
STATUS(3) = 30 renewable plant control models
STATUS(3) = 31 induction machine models
STATUS(3) = 32 branch device models
STATUS(3) = 33 two-winding transformer device models
STATUS(3) = 34 three-winding transformer models
STATUS(3) = 35 protection models associated with machines
STATUS(3) = 36 "other" models associated with machines
STATUS(3) = 37 "other" models associated with bus
STATUS(3) = 38 "other" models associated with two-terminal
dc lines
STATUS(3) = 40 renewable torque control models
STATUS(3) = 41 "other" models associated with branch
STATUS(3) = 42 "other" models associated with switched
shunt
STATUS(3) = 43 renewable weak grid control models
STATUS(3) = 44 renewable Inertia based fast frequency re-
sponse models
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1512
Dynamics Simulation DOCU
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 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
1513
Dynamics Simulation DROPMODELLIBRARY
7.1.17. DROPMODELLIBRARY
Use this API to remove a library from the list being searched for library models.
This API routine was first introduced in release 30.3.0.
Batch command syntax:
BAT_DROPMODELLIBRARY LIBRARYNAME
Python command syntax:
ierr = dropmodellibrary(libraryname)
Fortran command syntax:
CALL DROPMODELLIBRARY(LIBRARYNAME, IERR)
Where:
Character*260 LIBRARYNAME name of the library of model programs (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 library not found
IERR = 2 there are still models in use from this library;
unload not done
IERR = 3 library unload failed
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
1514
Dynamics Simulation DROPMODELPROGRAM
7.1.18. DROPMODELPROGRAM
Use this API to remove a model from the list of known library models; library models are added to this list
the first time that they are called.
This API routine was first introduced in release 30.3.0.
Batch command syntax:
BAT_DROPMODELPROGRAM PROGRAMNAME
Python command syntax:
ierr = dropmodelprogram(programname)
Fortran command syntax:
CALL DROPMODELPROGRAM(PROGRAMNAME, IERR)
Where:
Character*260 PROGRAMNAME name of the model program (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 program not found
IERR = 2 program unload failed
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
1515
Dynamics Simulation DYDA
7.1.19. DYDA
Use this API to replicate dynamics model data in the form of a Dynamics Data Input file.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_DYDA SID ALL STATUS(1)..STATUS(3) OUT OFILE
Python command syntax:
ierr = dyda(sid, all, status, out, ofile)
Fortran command syntax:
CALL DYDANW(SID, ALL, STATUS, 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 STATUS (3) array of 3 elements specifying a three-element array(input).
STATUS(1) models to process (2 by default)
STATUS(1) = 0 process all CONEC models
STATUS(1) = 1 process all CONET models
STATUS(1) = 2 process models by subsystem
STATUS(1) = 3 process Miscellaneous other type models
STATUS(2) value depends on the value of STATUS(1). If
STATUS(1) = 2 then STATUS(2) is the type of
model for which data is to be processed (1 by
default)
If STATUS(1) = 3:
STATUS(2) = 0 Miscellaneous, "Other," model DYDA for
every model instance.
STATUS(2) > 0 Miscellaneous, "Other," model DYDA for the
specificed model instance.
If STATUS(1) = 2:
STATUS(2) = 1 all models
STATUS(2) = 2 all plant models
STATUS(2) = 3 generator models
STATUS(2) = 4 compensator models
STATUS(2) = 5 stabilizer models
STATUS(2) = 6 minimum excitation limiter models
STATUS(2) = 7 maximum excitation limiter models
STATUS(2) = 8 excitation system models
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1516
Dynamics Simulation DYDA
STATUS(2) = 9 turbine governor models
STATUS(2) = 10 load characteristic models
STATUS(2) = 11 load relay models
STATUS(2) = 12 line relay models
STATUS(2) = 13 auxiliary signal models
STATUS(2) = 14 two-terminal dc line models
STATUS(2) = 15 multi-terminal dc line models
STATUS(2) = 16 VSC dc line models
STATUS(2) = 17 FACTS device models
STATUS(2) = 18 CONEC models
STATUS(2) = 19 CONET models
STATUS(2) = 20 turbine load controller
STATUS(2) = 21 switched shunt models
STATUS(2) = 22 all renewable models
STATUS(2) = 23 renewable generator models
STATUS(2) = 24 renewable electrical control models
STATUS(2) = 25 renewable mechanical system models
STATUS(2) = 26 renewable pitch models
STATUS(2) = 27 renewable aerodynamic models
STATUS(2) = 28 renewable gust models
STATUS(2) = 29 renewable plant control models
STATUS(2) = 30 induction machine models
STATUS(2) = 31 branch device models
STATUS(2) = 32 two-winding transformer device models
STATUS(2) = 33 three-winding transformer models
STATUS(2) = 34 protection models associated with machines
STATUS(2) = 35 "other" models associated with machines
STATUS(2) = 36 "other" models associated with bus
STATUS(2) = 37 "other" models associated with two-terminal
dc lines
STATUS(2) = 39 renewable torque control models
STATUS(2) = 40 "other" models associated with branch
STATUS(2) = 41 "other" models associated with switched
shunt
STATUS(2) = 42 renewable weak grid control models
STATUS(2) = 43 renewable Inertia based fast frequency re-
sponse models
STATUS(3) load model option (0 by default)
STATUS(3) = 0 include all subsystem load models attached
to loads in the specified subsystem
STATUS(3) = 1 exclude subsystem load models attached
to loads in the specified subsystem except
when subsystem number is explicitly in the
list
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1517
Dynamics Simulation DYDA
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 STATUS 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
1518
Dynamics Simulation DYNAMICSMODE
7.1.20. DYNAMICSMODE
Use this API to return PSSE to dynamics mode following the use of the POWERFLOWMODE API while in dy-
namics mode. (The POWERFLOWMODE API would normally be followed by the use of one or more of the
power flow data editor APIs).
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_DYNAMICSMODE OPT
Python command syntax:
ierr = dynamicsmode(opt)
Fortran command syntax:
CALL DSMODE(OPT, IERR)
Where:
Logical OPT factorize admittance matrix flag (input; FALSE).
OPT = TRUE (or T or 1 in batch command and Python) to
factorize the admittance matrix
OPT = FALSE (or F or 0 in batch command and Python) to
omit the matrix factorization
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 PSSE was started up at its powerflow entry
point
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
1519
Dynamics Simulation DYNAMICS_SOLUTION_PARAMS
7.1.21. DYNAMICS_SOLUTION_PARAMS
This API routine is obsolete. It has been replaced by the API routine dynamics_solution_param_2 .
Use this API to modify the dynamic simulation solution parameters in dynamics working memory.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_DYNAMICS_SOLUTION_PARAMS INTGAR(1)..INTGAR(8) REALAR(1)..REALAR(8)
OUTFILE
Python command syntax:
ierr = dynamics_solution_params(intgar, realar, outfile)
Fortran command syntax:
CALL DYNAMICS_SOLUTION_PARAMETERS(INTGAR, REALAR, OUTFILE, IERR)
Where:
Integer INTGAR (8) array of 8 elements specifying (input).
INTGAR(1) network solution maximum number of itera-
tions
INTGAR(2) number of channels being monitored; must
be less than or equal to the number of out-
put channels defined
INTGAR(3) number of state variables in use in the sim-
ulation model; should not normally be
changed by the user
INTGAR(4) next available location in the CON array
INTGAR(5) next available location in the STATE array
INTGAR(6) next available location in the VAR array
INTGAR(7) next available location in the ICON and
CHRICN arrays
INTGAR(8) next available location in the channel arrays
Real REALAR (8) array of 8 elements specifying (input).
REALAR(1) acceleration sfactor used in the network so-
lution
REALAR(2) convergence tolerance used in the network
solution
REALAR(3) simulation time step (DELT)
REALAR(4) filter time constant used in calculating bus
frequency deviations
REALAR(5) intermediate simulation mode time step
threshold used in extended term simulations
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1520
Dynamics Simulation DYNAMICS_SOLUTION_PARAMS
REALAR(6) large (island frequency) simulation mode
time step threshold used in extended term
simulations
REALAR(7) large (island frequency) simulation mode ac-
celeration factor used in extended term sim-
ulations
REALAR(8) large (island frequency) simulation mode
convergence tolerance used in extended
term simulations
Character*260 OUTFILE name of the Channel Output File (blank to bypass recording of the
output channel values in a Channel Output File) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 error opening OUTFILE
IERR = 2 prerequisite requirements for API are not met
IERR = -1 warnings: - None
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1521
Dynamics Simulation DYNAMICS_SOLUTION_PARAM_2
7.1.22. DYNAMICS_SOLUTION_PARAM_2
Use this API to modify the dynamic simulation solution parameters (except the channel output filename) in
dynamics working memory (see PSSE Program Operation Manual, activity ALTR).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_DYNAMICS_SOLUTION_PARAM_2 INTGAR(1)..INTGAR(8) REALAR(1)..REALAR(8)
Python command syntax:
ierr = dynamics_solution_param_2(intgar, realar)
Fortran command syntax:
CALL DYNAMICS_SOLUTION_PARAMETERS_2(INTGAR, REALAR, IERR)
Where:
Integer INTGAR (8) array of 8 elements specifying (input).
INTGAR(1) network solution maximum number of itera-
tions
INTGAR(2) number of channels being monitored; must
be less than or equal to the number of out-
put channels defined
INTGAR(3) number of state variables in use in the sim-
ulation model; should not normally be
changed by the user
INTGAR(4) next available location in the CON array
INTGAR(5) next available location in the STATE array
INTGAR(6) next available location in the VAR array
INTGAR(7) next available location in the ICON and
CHRICN arrays
INTGAR(8) next available location in the channel arrays
Real REALAR (8) array of 8 elements specifying (input).
REALAR(1) acceleration sfactor used in the network so-
lution
REALAR(2) convergence tolerance used in the network
solution
REALAR(3) simulation time step (DELT)
REALAR(4) filter time constant used in calculating bus
frequency deviations
REALAR(5) intermediate simulation mode time step
threshold used in extended term simulations
REALAR(6) large (island frequency) simulation mode
time step threshold used in extended term
simulations
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1522
Dynamics Simulation DYNAMICS_SOLUTION_PARAM_2
REALAR(7) large (island frequency) simulation mode ac-
celeration factor used in extended term sim-
ulations
REALAR(8) large (island frequency) simulation mode
convergence tolerance used in extended
term simulations
Integer IERR error code (output).
IERR = 0 no errors occurred
IERR > 0 error occurred
IERR = 1 prerequisite requirements for API are not met
IERR = -1 warnings: - None
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1523
Dynamics Simulation DYNEXPORTCSV
7.1.23. DYNEXPORTCSV
Use this API to export dynamics engine and dynamics model messages that are displayed after running a
dynamics simulation to CSV file format. If applicable the following data will be included in the specified
output file:
type, severity, model, model type, bus number, bus name, base kv, area number, owner number, and en-
gine/model messages
This API routine was first introduced in release 33.10.0 and 34.2.0.
Batch command syntax:
BAT_DYNEXPORTCSV CSVFILENAME
Python command syntax:
ierr = dynexportcsv(csvfilename)
Fortran command syntax:
CALL DYNEXPORTCSV(CSVFILENAME, IERR)
Where:
character*260 CSVFILENAME name of the CSV file to hold exported data (input).
Integer IERR error code (output).
IERR = -1 Prerequisite requirements for API not met
IERR = 0 no error
IERR = 1 error opening csv file
IERR = 2 error closing csv file; data may not have been
written to file
IERR = 3 error writing data to csv file
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1524
Dynamics Simulation DYRE_ADD
7.1.24. DYRE_ADD
Use this API to read a Dynamics Model Raw Data File and append the model references specified in its data
records to the simulation data already contained in dynamics working memory (activity DYRE,ADD).
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_DYRE_ADD STARTINDX(1)..STARTINDX(4) DYREFILE CONECFILE CONETFILE
Python command syntax:
ierr = dyre_add(startindx, dyrefile, conecfile, conetfile)
Fortran command syntax:
CALL DYRE_ADD(STARTINDX, DYREFILE, CONECFILE, CONETFILE, IERR)
Where:
Integer STARTINDX (4) array of 4 elements specifying starting locations in the dynamics data
storage arrays(input).
STARTINDX(1) starting CON index (the next available CON
by default)
STARTINDX(2) starting STATE index (the next available
STATE by default)
STARTINDX(3) starting VAR index (the next available VAR by
default)
STARTINDX(4) starting ICON index (the next available ICON
by default)
Character*260 DYREFILE name of the Dynamics Model Raw Data File (input; no default al-
lowed).
Character*260 CONECFILE name of the output file for CONEC additions; blank to route data to
the progress area (input; blank by default).
Character*260 CONETFILE name of the output file for CONET additions; blank to route data to
the progress area (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STARTINDX value
IERR = 2 machine model connection tables full--use
pack plant model tables function
IERR = 3 error opening output file DYREFILE
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
1525
Dynamics Simulation DYRE_NEW
7.1.25. DYRE_NEW
Use this API to clear dynamics working memory, read a Dynamics Data File, and place the model references
specified on its data records into dynamics working memory. It optionally creates a command file for com-
piling the CONEC and CONET subroutines.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_DYRE_NEW STARTINDX(1)..STARTINDX(4) DYREFILE CONECFILE CONETFILE
COMPILFIL
Python command syntax:
ierr = dyre_new(startindx,dyrefile,conecfile,conetfile,compilfil)
Fortran command syntax:
CALL DYRE_NEW(STARTINDX, DYREFILE, CONECFILE, CONETFILE, COMPILFIL, IERR)
Where:
Integer STARTINDX (4) array of 4 elements specifying starting locations in the dynamics data
storage arrays(input).
STARTINDX(1) starting CON index (1 by default)
STARTINDX(2) starting STATE index (1 by default)
STARTINDX(3) starting VAR index (1 by default)
STARTINDX(4) starting ICON index (1 by default)
Character*260 DYREFILE name of the Dynamics Model Raw Data File (input; no default al-
lowed).
Character*260 CONECFILE name of CONEC output file; blank for output to the progress area (in-
put; blank by default).
Character*260 CONETFILE name of CONET output file; blank for output to the progress area (in-
put; blank by default).
Character*260 COMPILFIL name of file containing commands to compile the CONEC and CONET
output files; blank for none (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STARTINDX value
IERR = 3 error opening output file DYREFILE
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
1526
Dynamics Simulation ERUN
7.1.26. ERUN
Use this API to calculate PSSE state-space dynamic simulations of excitation system response tests.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_ERUN TPAUSE NPRT NPLT CRTPLT
Python command syntax:
ierr = erun(tpause, nprt, nplt, crtplt)
Fortran command syntax:
CALL ERUNAPI(TPAUSE, NPRT, NPLT, CRTPLT, IERR)
Where:
Real TPAUSE value of simulated time at which the simulation should next pause
(input; no default allowed).
Integer NPRT number of time steps between the printing of the channel values (in-
put; unchanged).
Integer NPLT number of time steps between the writing of the output channel val-
ues to the current Channel Output File (input; unchanged).
Integer CRTPLT number of time steps between the plotting of those channel val-
ues that have been designated as CRT output channels (input; un-
changed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 activity ESTR needs to be executed
IERR = 2 error opening the current Channel Output File
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
1527
Dynamics Simulation ESTR_OPEN_CIRCUIT_TEST
7.1.27. ESTR_OPEN_CIRCUIT_TEST
Use this API to initialize a PSSE dynamic simulation for excitation system open circuit response simulations
(i.e., in preparation for activity ERUN) and to specify the Channel Output File into which the output chan-
nel values are to be recorded during the simulation.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_ESTR_OPEN_CIRCUIT_TEST OPTION VDELTA OUTFILE
Python command syntax:
ierr = estr_open_circuit_test(option, vdelta, outfile)
Fortran command syntax:
CALL ESTR_OPEN_CIRCUIT_TEST(OPTION, VDELTA, OUTFILE, IERR)
Where:
Integer OPTION bus flag indicating those buses to be tested (input; 0 by default).
OPTION = 0 run test on all in-service machines with exci-
tation system models.
OPTION > 0 bus number for which machines are to be
tested.
Real VDELTA per unit voltage reference step applied at TIME = 0.0 (input; 0.05).
Character*260 OUTFILE name of the Channel Output File (blank to bypass recording of the
output channel values in a Channel Output File) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 error opening OUTFILE
IERR = 3 generators are not "converted"
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
1528
Dynamics Simulation ESTR_RESPONSE_RATIO_TEST
7.1.28. ESTR_RESPONSE_RATIO_TEST
Use this API to initialize a PSSE dynamic simulation for excitation system response ratio test simulations
(i.e., in preparation for activity ERUN) and to specify the Channel Output File into which the output chan-
nel values are to be recorded during the simulation.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_ESTR_RESPONSE_RATIO_TEST OPTION PFDEFALT NMACHS
BUSARY(1)..BUSARY(NMACHS) IDARY(1)..IDARY(NMACHS)
PFARY(1)..PFARY(NMACHS) OUTFILE
Python command syntax:
ierr = estr_response_ratio_test(option, pfdefalt, nmachs, busary, idary,
pfary, outfile)
Fortran command syntax:
CALL ESTR_RESPONSE_RATIO_TEST(OPTION, PFDEFALT, NMACHS, BUSARY, IDARY,
PFARY, OUTFILE, IERR)
Where:
Integer OPTION bus flag indicating those buses to be tested (input; 0 by default).
OPTION = 0 run test on all in-service machines with exci-
tation system models.
OPTION > 0 bus number for which machines are to be
tested.
Real PFDEFALT default power factor at which machines are initialized (input; 0.95).
Integer NMACHS number of machines to be initialized at other power factors (input; 0
by default).
Integer BUSARY (NMACHS) a list of bus numbers identifying machines to be initialized at other
power factors; ignored if NMACHS = 0 (input; no default allowed).
Character*2 IDARY (NMACHS) a list of machine identifiers identifying machines to be initialized at
other power factors; ignored if NMACHS = 0 (input; '1' by default).
Real PFARY (NMACHS) a list of power factors; ignored if NMACHS = 0. Machine IDARY(n) at
bus BUSARY(n) is initialized to the power factor specified in PFARY(n)
(input; PFDEFALT).
Character*260 OUTFILE name of the Channel Output File (blank to bypass recording of the
output channel values in a Channel Output File) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 invalid power factor
IERR = 3 error opening OUTFILE
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1529
Dynamics Simulation ESTR_RESPONSE_RATIO_TEST
IERR = 4 generators are not "converted"
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
1530
Dynamics Simulation FCLIST
7.1.29. FCLIST
Use this API to list FACTS device models connected to subsystem buses along with their storage locations in
the dynamics data arrays.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_FCLIST SID ALL STATUS
Python command syntax:
ierr = fclist(sid, all, status)
Fortran command syntax:
CALL FCLIST(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 = 0 process only buses in subsystem SID
ALL = 1 process all buses
Integer STATUS active/bypassed flag (input; 0 by default).
STATUS = 0 active and bypassed models
STATUS = 1 active models only
STATUS = 2 bypassed models only
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 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
1531
Dynamics Simulation GRUN
7.1.30. GRUN
Use this API to calculate PSSE state-space dynamic simulations of turbine-governor response tests.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_GRUN TPAUSE NPRT NPLT CRTPLT
Python command syntax:
ierr = grun(tpause, nprt, nplt, crtplt)
Fortran command syntax:
CALL GRUNAPI(TPAUSE, NPRT, NPLT, CRTPLT, IERR)
Where:
Real TPAUSE value of simulated time at which the simulation should next pause
(input; no default allowed).
Integer NPRT number of time steps between the printing of the channel values (in-
put; unchanged).
Integer NPLT number of time steps between the writing of the output channel val-
ues to the current Channel Output File (input; unchanged).
Integer CRTPLT number of time steps between the plotting of those channel val-
ues that have been designated as CRT output channels (input; un-
changed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 activity GSTR needs to be executed
IERR = 2 error opening the current Channel Output File
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
1532
Dynamics Simulation GSTR
7.1.31. GSTR
Use this API to initialize a PSSE dynamic simulation for governor response simulations and to specify the
Channel Output File into which the output channel values are to be recorded during the simulation.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_GSTR OPTION PINITIAL PDELTA OUTFILE
Python command syntax:
ierr = gstr(option, pinitial, pdelta, outfile)
Fortran command syntax:
CALL GSTRAPI(OPTION, PINITIAL, PDELTA, OUTFILE, IERR)
Where:
Integer OPTION bus flag indicating those buses to be tested (input; 0 by default).
OPTION = 0 run test on all in-service machines with tur-
bine-governor models.
OPTION = 0 bus number for which machines are to be
tested.
Real PINITIAL initial per unit loading of all machines being tested (input; 0.8).
Real PDELTA per unit loading step applied at TIME = 0.0 (input; 0.1).
Character*260 OUTFILE name of the Channel Output File (blank to bypass recording of the
output channel values in a Channel Output File) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 bus not found
IERR = 2 error opening OUTFILE
IERR = 3 generators are not, "converted"
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
1533
Dynamics Simulation INCREMENT_GREF
7.1.32. INCREMENT_GREF
Use this API to add a specified value to the value of the element of the GREF (governor reference) array as-
sociated with a specified machine.
This API routine was first introduced in release 31.0.2.
Batch command syntax:
BAT_INCREMENT_GREF IBUS 'ID' NEWVAL
Python command syntax:
ierr = increment_gref(ibus, id, newval)
Fortran command syntax:
CALL INCREMENT_GREF(IBUS, ID, NEWVAL, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Real NEWVAL new value to be added to the GREF array entry associated with ma-
chine ID at bus IBUS (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 machine not found
IERR = 3 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - No turbine-gov-
ernor model at this machine - Turbine-gover-
nor model at this machine is bypassed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1534
Dynamics Simulation INCREMENT_SWSREF
7.1.33. INCREMENT_SWSREF
This API routine is obsolete. It has been replaced by the API routine increment_swsref_2 .
Use this API to add a specified value to the value of the element of the SWREF (switched shunt reference)
array associated with a specified switched shunt.
This API routine was first introduced in release 32.2.1.
Batch command syntax:
BAT_INCREMENT_SWSREF IBUS NEWVAL
Python command syntax:
ierr = increment_swsref(ibus, newval)
Fortran command syntax:
CALL INCREMENT_SWSREF(IBUS, NEWVAL, IERR)
Where:
Integer IBUS switched shunt bus number (input).
Real NEWVAL new value to be added to the SWREF array entry associated with
switched shunt at bus IBUS (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 switched shunt not found
IERR = 3 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - no table mod-
el for switched shunt at this bus. - switched
shunt dynamic model as this bus is bypassed.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1535
Dynamics Simulation INCREMENT_SWSREF_2
7.1.34. INCREMENT_SWSREF_2
Use this API to add a specified value to the value of the element of the SWREF (switched shunt reference)
array associated with a specified switched shunt.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_INCREMENT_SWSREF_2 IBUS ID NEWVAL
Python command syntax:
ierr = increment_swsref_2(ibus, id, newval)
Fortran command syntax:
CALL INCREMENT_SWSREF_2(IBUS, ID, NEWVAL, IERR)
Where:
Integer IBUS switched shunt bus number (input).
Character*2 ID switched shunt identifier (input; blank by default).
Real NEWVAL new value to be added to the SWREF array entry associated with
switched shunt at bus IBUS (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 switched shunt not found
IERR = 3 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - no table mod-
el for switched shunt at this bus. - switched
shunt dynamic model as this bus is bypassed.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1536
Dynamics Simulation INCREMENT_VREF
7.1.35. INCREMENT_VREF
Use this API to add a specified value to the value of the element of the VREF (voltage reference) array asso-
ciated with a specified machine.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_INCREMENT_VREF IBUS 'ID' NEWVAL
Python command syntax:
ierr = increment_vref(ibus, id, newval)
Fortran command syntax:
CALL INCREMENT_VREF(IBUS, ID, NEWVAL, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Real NEWVAL new value to be added to the VREF array entry associated with ma-
chine ID at bus IBUS (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 1 bus not found
IERR = 2 machine not found
IERR = 3 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - no excitation sys-
tem model at this machine - excitation system
model at this machine is bypassed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1537
Dynamics Simulation LDLIST
7.1.36. LDLIST
Use this API to list load models connected to subsystem loads along with their storage locations in the dy-
namics data arrays.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LDLIST SID ALL STATUS(1) STATUS(2)
Python command syntax:
ierr = ldlist(sid, all, status)
Fortran command syntax:
CALL LDLIST(SID, ALL, STATUS, IERR)
Where:
Integer SID 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 a two-element array(input).
STATUS(1) active/bypassed flag (0 by default)
STATUS(1) = 0 active and bypassed models
STATUS(1) = 1 active models only
STATUS(1) = 2 bypassed models only
STATUS(2) model connection report option (0 by de-
fault)
STATUS(2) = 0 list models connected to loads
STATUS(2) = 1 list loads connected to model
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 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
1538
Dynamics Simulation LOAD_ARRAY_CHANNEL
7.1.37. LOAD_ARRAY_CHANNEL
Use this API to add an output channel containing the active or reactive component of a designated load.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_LOAD_ARRAY_CHANNEL STATUS(1)..STATUS(3) 'ID' 'IDENT'
Python command syntax:
ierr = load_array_channel(status, id, ident)
Fortran command syntax:
CALL LOAD_ARRAY_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (3) array of 3 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) used to indicate the quantity to be placed in
an channel (1 by default)
STATUS(2) = 1 PLOAD
STATUS(2) = 2 QLOAD
STATUS(3) number of the bus to which the load for
which quantity is to be placed in an channel
is connected (no default allowed)
Character*2 ID load identifier (input; '1' by default).
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 bus not found
IERR = 4 load not found
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
1539
Dynamics Simulation MLST
7.1.38. MLST
Use this API to list plant models connected to subsystem machines along with their storage locations in the
dynamics data arrays.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_MLST SID ALL STATUS(1)..STATUS(3)
Python command syntax:
ierr = mlst(sid, all, status)
Fortran command syntax:
CALL MLSTNW(SID, ALL, STATUS, IERR)
Where:
Integer SID 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 a three-element array(input).
STATUS(1) connected/unconnected flag (1 by default)
STATUS(1) = 0 list all unconnected models
STATUS(1) = 1 list connected subsystem models
STATUS(2) active/bypassed flag (0 by default)
STATUS(2) = 0 active and bypassed models
STATUS(2) = 1 active models only
STATUS(2) = 2 bypassed models only
STATUS(3) plant model type (1 by default)
STATUS(3) = 1 all plant models
STATUS(3) = 2 generator models
STATUS(3) = 3 compensator models
STATUS(3) = 4 stabilizer models
STATUS(3) = 5 minimum excitation models
STATUS(3) = 6 maximum excitation models
STATUS(3) = 7 excitation system models
STATUS(3) = 8 governor models
STATUS(3) = 9 turbine load controller models
Integer IERR error code (output).
IERR = 0 no error
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1540
Dynamics Simulation MLST
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
1541
Dynamics Simulation MRUN
7.1.39. MRUN
Use this API to calculate PSSE extended term dynamic simulations.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_MRUN OPTION TPAUSE NPRT NPLT CRTPLT
Python command syntax:
ierr = mrun(option, tpause, nprt, nplt, crtplt)
Fortran command syntax:
CALL MRUNAPI(OPTION, TPAUSE, NPRT, NPLT, CRTPLT, IERR)
Where:
Integer OPTION network solution convergence monitor option (input; 0 by default).
OPTION = 1 automatically print the convergence monitor.
OPTION = 0 print the convergence monitor only if it is en-
abled via the CM interrupt control code.
Real TPAUSE value of simulated time at which the simulation should next pause
(input; no default allowed).
Integer NPRT number of time steps between the printing of the channel values (in-
put; unchanged).
Integer NPLT number of time steps between the writing of the output channel val-
ues to the current Channel Output File (input; unchanged).
Integer CRTPLT number of time steps between the plotting of those channel val-
ues that have been designated as CRT output channels (input; un-
changed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 long time step mode threshold is at or below
intermediate mode threshold
IERR = 2 activity MSTR needs to be executed
IERR = 3 invalid OPTION value
IERR = 4 generators are not converted
IERR = 5 error opening the current Channel Output File
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
1542
Dynamics Simulation MSTR
7.1.40. MSTR
Use this API to initialize a PSSE dynamic simulation for extended term simulations and to specify the Chan-
nel Output File into which the output channel values are to be recorded during the dynamic simulation.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_MSTR OPTION OUTFILE
Python command syntax:
ierr = mstr(option, outfile)
Fortran command syntax:
CALL MSTRAPI(OPTION, OUTFILE, IERR)
Where:
Integer OPTION network solution convergence monitor option (input; 0 by default).
OPTION = 1 automatically print the convergence monitor.
OPTION = 0 print the convergence monitor only if it is en-
abled via the CM interrupt control code.
Character*260 OUTFILE name of the Channel Output File (blank to bypass recording of the
output channel values in a Channel Output File) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 long time step mode threshold is at or below
intermediate mode threshold
IERR = 2 DELT is greater than intermediate time step
mode threshold
IERR = 3 generators are not converted
IERR = 4 invalid OPTION value
IERR = 5 Prior initialization modified the loads--pick up
original converted case
IERR = 6 error opening OUTFILE
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
1543
Dynamics Simulation POWERFLOWMODE
7.1.41. POWERFLOWMODE
Use this API to switch PSSE from dynamics mode to power flow mode. (This API would normally be fol-
lowed by the use of one or more of the power flow data editor APIs, and then the DYNAMICSMODE API).
Batch command syntax.
BAT_POWERFLOWMODE
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_POWERFLOWMODE
Python command syntax:
ierr = powerflowmode()
Fortran command syntax:
CALL PFMODE(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
1544
Dynamics Simulation PSAS
7.1.42. PSAS
Use this API to convert a PSAS Command File into a PSSE Response File.
This API routine was first introduced in release 30.0.0.
Batch command syntax:
BAT_PSAS INPFILE OUTFILE
Python command syntax:
ierr, respfil = psas(inpfile, outfile)
Fortran command syntax:
CALL PSASAPI(INPFILE, OUTFILE, RESPFIL, IERR)
Where:
Character*260 INPFILE name of the PSAS command file (input; no default allowed).
Character*260 OUTFILE name of Response file; blank to have PSAS assign the filename (in-
put; blank by default).
Character*260 RESPFIL pathname of the Response file constructed by PSAS (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 PSAS 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
1545
Dynamics Simulation RLLIST
7.1.43. RLLIST
Use this API to list line relay models connected to subsystem buses along with their storage locations in the
dynamics data arrays.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RLLIST SID ALL STATUS
Python command syntax:
ierr = rllist(sid, all, status)
Fortran command syntax:
CALL RLLIST(SID, ALL, STATUS, IERR)
Where:
Integer SID 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 active/bypassed flag (input; 0 by default).
STATUS = 0 active and bypassed models
STATUS = 1 active models only
STATUS = 2 bypassed models only
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 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
1546
Dynamics Simulation RSTR
7.1.44. RSTR
Use this API to read a dynamics Snapshot File into PSSE working memory.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RSTR SFILE
Python command syntax:
ierr = rstr(sfile)
Fortran command syntax:
CALL RSTRNW(SFILE, IERR)
Where:
Character*260 SFILE snapshot file; '*' to restore the most recently accessed snapshot file
in the current execution of PSSE (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 error opening SFILE
IERR = 2 error reading from SFILE
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
1547
Dynamics Simulation RUN
7.1.45. RUN
Use this API to calculate PSSE state-space dynamic simulations.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_RUN OPTION TPAUSE NPRT NPLT CRTPLT
Python command syntax:
ierr = run(option, tpause, nprt, nplt, crtplt)
Fortran command syntax:
CALL RUNAPI(OPTION, TPAUSE, NPRT, NPLT, CRTPLT, IERR)
Where:
Integer OPTION network solution convergence monitor option (input; 0 by default).
OPTION = 1 automatically print the convergence monitor
OPTION = 0 print the convergence monitor only if it is en-
abled via the CM interrupt control code
Real TPAUSE value of simulated time at which the simulation should next pause
(input; no default allowed).
Integer NPRT number of time steps between the printing of the channel values (in-
put; unchanged).
Integer NPLT number of time steps between the writing of the output channel val-
ues to the current channel output file (input; unchanged).
Integer CRTPLT number of time steps between the plotting of those channel val-
ues that have been designated as CRT output channels (input; un-
changed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 activity STRT needs to be executed
IERR = 2 invalid OPTION value
IERR = 3 generators are not converted
IERR = 4 error opening the current channel output file
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
1548
Dynamics Simulation RWDY
7.1.46. RWDY
Use this API to replicate portions of dynamics model data in the form of either a breaker duty data file, unit
inertia and governor data file, or PSSPLT relay characteristic data file.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_RWDY OPTIONS(1)..OPTIONS(3) OUT OFILE
Python command syntax:
ierr = rwdy(options, out, ofile)
Fortran command syntax:
CALL RWDYAPI(OPTIONS, OUT, OFILE, IERR)
Where:
Integer OPTIONS (3) array of 3 elements specifying (input).
OPTIONS(1) type of file to be (1 by default)
OPTIONS(1) = 1 breaker duty data file
OPTIONS(1) = 2 unit inertia and governor data file
OPTIONS(1) = 3 PSSPLT relay characteristic data file
OPTIONS(2) machine limits flag for activity INLF (ignored
unless OPTIONS(1) = 2) (0 by default)
OPTIONS(2) = 0 include machine limits
OPTIONS(2) = 1 suppress machine limits
OPTIONS(3) flag indicating the treatment of machines
without governor models in activity INLF (ig-
nored unless OPTIONS(1) = 2) (0 by default)
OPTIONS(3) = 0 use the working case limits
OPTIONS(3) = 1 treat them as non-dispatchable
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 (input; blank
by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid OPTIONS value
IERR = 2 invalid OUT value
IERR = 3 error opening OFILE
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
1549
Dynamics Simulation SET_CHNFIL_TYPE
7.1.47. SET_CHNFIL_TYPE
Use this API to set/Get the channel output file type (extended type or not).
This API routine was first introduced in release 33.8.0.
Batch command syntax:
BAT_SET_CHNFIL_TYPE STATUS ICODE
Python command syntax:
ierr = set_chnfil_type(status)
ierr, status = set_chnfil_type()
Fortran command syntax:
CALL SET_CHNFIL_TYPE(STATUS, ICODE, IERR)
Where:
Integer STATUS value of the option setting (input; if batch command or ICODE is 0 or
negative; unchanged by default) (if ICODE is positive).
STATUS = 0 channel output file is not of extended type
(.out)
STATUS = 1 channel output file is of extended type (.outx)
Integer ICODE indicates the operation mode of the API (1 by default).
ICODE = 0 set the option setting to the value specified in
STATUS
ICODE > 0 return the current value of the option setting
in STATUS
Integer IERR error code (output).
IERR = 0 no error
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
1550
Dynamics Simulation SET_DISABLE_RUN
7.1.48. SET_DISABLE_RUN
Use this API to enable or disable the simulation option setting that precludes dynamic simulation runs in
the event there are fatal errors in the model data.
This API routine was first introduced in release 33.10.0 and 34.2.0.
Batch command syntax:
BAT_SET_DISABLE_RUN STATUS
Python command syntax:
ierr = set_disable_run(status)
ierr, status = set_disable_run()
Fortran command syntax:
CALL SET_DISABLE_RUN(STATUS, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 0 Do not disable dynamic simulation run if
there is fatal data error
STATUS = 1 Disable dynamic simulation run if there is fa-
tal data error
Integer ICODE operation mode of the API (no default allowed).
ICODE = 0 set the option setting to the value specified in
STATUS
ICODE > 0 return the current value of the option setting
in STATUS
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 pre-requisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1551
Dynamics Simulation SET_FREQ_RELAY_V_THRESH
7.1.49. SET_FREQ_RELAY_V_THRESH
This API is used to set voltage threshold for use in frequency relay models.
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_SET_FREQ_RELAY_V_THRESH FRELVTHRESH
Python command syntax:
ierr = set_freq_relay_v_thresh(frelvthresh)
ierr, frelvthresh = set_freq_relay_v_thresh()
Fortran command syntax:
CALL SET_FREQ_RELAY_V_THRESH(FRELVTHRESH, ICODE, IERR)
Where:
Real FRELVTHRESH (input; Voltage threshold for use in frequency relay models: if batch
command or ICODE is 0 or negative; unchanged by default if ICODE
is positive. This value can be used in frequency relay models as the
minimum PU voltage for frequency measurement.).
Integer ICODE operation mode of API (no default allowed).
ICODE = 0 set the option setting to the value specified in
FRelVThresh.
ICODE = 1 return the current value of the option setting
in FRelVThresh.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 prerequisite requirements for API not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1552
Dynamics Simulation SET_GENANG
7.1.50. SET_GENANG
This API routine is obsolete. It has been replaced by the API routine set_genang_2 .
Use this API to enable or disable the simulation option setting that scans for generators for which the angle
differs from the angular average by more than a specified threshold.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SET_GENANG STATUS ANGLE
Python command syntax:
ierr = set_genang(status, angle)
ierr, status,angle = set_genang()
Fortran command syntax:
CALL SET_GENANG(STATUS, ANGLE, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 1 enable scanning for generators exceeding an-
gle threshold.
STATUS = 0 disable scanning option.
Real ANGLE deviation threshold (input; if batch command or ICODE is 0 or nega-
tive; unchanged by default) (if ICODE is positive).
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS and the threshold to the value speci-
fied in ANGLE.
ICODE > 0 return the current value of the option setting
in STATUS and the threshold in ANGLE.
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid angle threshold--must be >0.0 and
<360.0
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
1553
Dynamics Simulation SET_GENANG_2
7.1.51. SET_GENANG_2
This API routine is obsolete. It has been replaced by the API routine set_genang_3 .
Use this API to enable or disable the simulation option setting that scans for generators for which the angle
differs from the angular average by more than a specified threshold. Scanning, if enabled, will be done for
all machines whose machine MVA is greater than the specified value
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SET_GENANG_2 STATUS ANGLE MBASE
Python command syntax:
ierr = set_genang_2(status, angle, mbase)
ierr, status,angle,mbase = set_genang_2()
Fortran command syntax:
CALL SET_GENANG_2(STATUS, ANGLE, MBASE, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 1 enable scanning for generators exceeding an-
gle threshold.
STATUS = 0 disable scanning option.
Real ANGLE deviation threshold (input; if batch command or ICODE is 0 or nega-
tive; unchanged by default) (if ICODE is positive).
Real MBASE machine size (MVA) (input; if batch command or ICODE is 0 or nega-
tive; unchanged by default) (if ICODE is positive). All machines whose
MVAR ratings are above this threshold will be scanned).
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS and the threshold values specified in
ANGLE and MBASE.
ICODE > 0 return the current value of the option setting
in STATUS and the threshold values in ANGLE
and MBASE
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid angle threshold--must be >0.0 and
<360.0
IERR = 2 invalid angle threshold--must be >= 0.0
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
1554
Dynamics Simulation SET_GENANG_2
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1555
Dynamics Simulation SET_GENANG_3
7.1.52. SET_GENANG_3
Use this API to enable or disable the simulation option setting that scans for generators for which the angle
differs from the angular average by more than a specified threshold. Scanning, if enabled, will be done for
all machines whose machine MVA is greater than the specified value
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SET_GENANG_3 STATUS ANGLE MBASE TRIP
Python command syntax:
ierr = set_genang_3(status, angle, mbase, trip)
ierr, status, angle, mbase, trip = set_genang_3()
Fortran command syntax:
CALL SET_GENANG_3(STATUS, ANGLE, MBASE, TRIP, ICODE, IERR)
Where:
Integer STATUS value of the option setting (input; if batch command or ICODE is 0 or
negative; unchanged by default) (if ICODE is positive).
STATUS = 1 enable scanning for generators exceeding an-
gle threshold.
STATUS = 0 disable scanning option.
Real ANGLE value of the deviation threshold (input; if batch command or ICODE is
0 or negative; unchanged by default) (if ICODE is positive).
Real MBASE machine size (MVA) (input; if batch command or ICODE is 0 or nega-
tive; unchanged by default) (if ICODE is positive). All machines whose
MVAR ratings are above this threshold will be scanned).
Integer TRIP monitor trip flag (input; if batch command or ICODE is 0 or nega-
tive; unchanged by default) (if ICODE is positive). All machines whose
MVAR ratings are above this threshold will be scanned).
TRIP = 1 trip generators
TRIP = 1 monitor generators only
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS and the threshold values specified in
ANGLE, MBASE and TRIP
ICODE > 0 return the current value of the option setting
in STATUS and the threshold values in ANGLE,
MBASE and TRIP
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid angle threshold--must be >0.0 and
<360.0
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1556
Dynamics Simulation SET_GENANG_3
IERR = 2 invalid angle threshold--must be >= 0.0
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
1557
Dynamics Simulation SET_GENANG_SUBSYS_FLAG
7.1.53. SET_GENANG_SUBSYS_FLAG
Use this API api for get/set the flag that is used for the subsystem defintion for performing scan for gen-
erators exceeding angle threshold. When the subsystem flag is set, the API will also flag those buses con-
tained in subsystem SID.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SET_GENANG_SUBSYS_FLAG ALL SID
Python command syntax:
ierr = set_genang_subsys_flag(all, sid)
ierr, all = set_genang_subsys_flag()
Fortran command syntax:
CALL SET_GENANG_SUBSYS_FLAG(ALL, SID, ICODE, IERR)
Where:
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 SID valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
ALL
ICODE > 0 return the current value of the option setting
in ALL
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid ALL value
IERR = 2 invalid SID 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
1558
Dynamics Simulation SET_GENPWR
7.1.54. SET_GENPWR
Use this API to enable or disable the simulation option setting that scans for generators for which the me-
chanical power differs from its electrical power by more than a specified threshold.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SET_GENPWR STATUS POWER
Python command syntax:
ierr = set_genpwr(status, power)
ierr, status,power = set_genpwr()
Fortran command syntax:
CALL SET_GENPWR(STATUS, POWER, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 1 enable scanning for generators exceeding
power unbalance threshold
STATUS = 0 disable scanning option
Real POWER power unbalance threshold (input; if batch command or ICODE is 0
or negative; unchanged by default) (if ICODE is positive).
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS and the threshold values specified in
POWER
ICODE > 0 return the current value of the option setting
in STATUS and the threshold values in POWER
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid power unbalance threshold - must be
>0.0 and <10.0
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
1559
Dynamics Simulation SET_GENSPDEV
7.1.55. SET_GENSPDEV
Use this API to enable or disable the simulation option setting that scans for generators for which the
speed deviation is more than a specified threshold.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SET_GENSPDEV STATUS SPEED TRIP
Python command syntax:
ierr = set_genspdev(status, speed, trip)
ierr, status, speed, trip = set_genspdev()
Fortran command syntax:
CALL SET_GENSPDEV(STATUS, SPEED, TRIP, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 1 enable scanning for generator speeds exceed-
ing speed deviation threshold
STATUS = 0 disable scanning option
Real SPEED speed deviation threshold (input; if batch command or ICODE is 0 or
negative; unchanged by default) (if ICODE is positive).
Integer TRIP monitor trip flag (input; if batch command or ICODE is 0 or nega-
tive; unchanged by default) (if ICODE is positive). All machines whose
MVAR ratings are above this threshold will be scanned).
TRIP = 1 trip generators
TRIP = 0 monitor generators only
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS and the threshold values specified in
SPEED and TRIP
ICODE > 0 return the current value of the option setting
in STATUS and the threshold values in SPEED
and TRIP
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid speed deviation threshold - must be
>0.0
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
1560
Dynamics Simulation SET_GENSPDEV_SUBSYS_FLAG
7.1.56. SET_GENSPDEV_SUBSYS_FLAG
Use this API api for get/set the flag that is used for the subsystem defintion for performing scans for gener-
ators for which the speed deviation is more than a specified threshold.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SET_GENSPDEV_SUBSYS_FLAG ALL SID
Python command syntax:
ierr = set_genspdev_subsys_flag(all, sid)
ierr, all = set_genspdev_subsys_flag()
Fortran command syntax:
CALL SET_GENSPDEV_SUBSYS_FLAG(ALL, SID, ICODE, IERR)
Where:
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 SID valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
ALL
ICODE > 0 return the current value of the option setting
in ALL
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid ALL value
IERR = 2 invalid SID 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
1561
Dynamics Simulation SET_LOAD_MODEL_THRESH
7.1.57. SET_LOAD_MODEL_THRESH
This API is used to set the MW, P over Q, and load bus voltage thresholds for load models.
This API routine was first introduced in release 34.6.0.
Batch command syntax:
BAT_SET_LOAD_MODEL_THRESH LMWTHRESH LPQTHRESH LVTTHRESH
Python command syntax:
ierr = set_load_model_thresh(lmwthresh, lpqthresh, lvtthresh)
ierr, lmwthresh, lpqthresh, lvtthresh = set_load_model_thresh()
Fortran command syntax:
CALL SET_LOAD_MODEL_THRESH(LMWTHRESH, LPQTHRESH, LVTTHRESH, ICODE, IERR)
Where:
Real LMWTHRESH (input; MW threshold for applying load models: if batch command
or ICODE is 0 or negative; unchanged by default if ICODE is positive.
This threshold can be used in load models to decide whether the load
model should be applied or not.).
Real LPQTHRESH (input; P by Q (absolute value) threshold for applying load models: if
batch command or ICODE is 0 or negative; unchanged by default if
ICODE is positive. This threshold can be used in load models to decide
whether the load model should be applied or not.).
Real LVTTHRESH (input; pu load bus voltage threshold for applying load models: if
batch command or ICODE is 0 or negative; unchanged by default if
ICODE is positive. This threshold can be used in load models to decide
whether the load model should be applied or not.).
Integer ICODE operation mode of API (no default allowed).
ICODE = 0 set the option setting to the value specified in
LMWThresh, LPQThresh, and LVtThresh.
ICODE = 1 return the current value of the option setting
in LMWThresh, LPQThresh, and LVtThresh.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 prerequisite requirements for API not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1562
Dynamics Simulation SET_MODEL_DEBUG_OUTPUT_FLAG
7.1.58. SET_MODEL_DEBUG_OUTPUT_FLAG
Use this API to enable or disable the simulation option setting for dynamic model debug output.
This API routine was first introduced in release 33.12.0 and 34.5.0.
Batch command syntax:
BAT_SET_MODEL_DEBUG_OUTPUT_FLAG STATUS
Python command syntax:
ierr = set_model_debug_output_flag(status)
ierr, status = set_model_debug_output_flag()
Fortran command syntax:
CALL SET_MODEL_DEBUG_OUTPUT_FLAG(STATUS, ICODE, IERR)
Where:
Integer STATUS option setting (input; if Batch command or for Python if specified as
an argument, or for Fortran if ICODE is 0; no default allowed).
STATUS = 0 disable dynamic model debug output
STATUS = 1 enable dynamic model debug output
Integer ICODE 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 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1563
Dynamics Simulation SET_NETFRQ
7.1.59. SET_NETFRQ
Use this API to enable or disable the simulation option setting that models the frequency dependence of
network parameters.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SET_NETFRQ STATUS
Python command syntax:
ierr = set_netfrq(status)
ierr, status = set_netfrq()
Fortran command syntax:
CALL SET_NETFRQ(STATUS, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 0 disable network frequency dependence
STATUS = 1 enable network frequency dependence
Integer ICODE operation mode of the API (no default allowed).
ICODE = 0 set the option setting to the value specified in
STATUS
ICODE > 0 return the current value of the option setting
in STATUS
Integer IERR error code (output).
IERR = 0 no error
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
1564
Dynamics Simulation SET_NEXT_CHANNEL
7.1.60. SET_NEXT_CHANNEL
Use this API to assign the next available channel index value.
This API routine was first introduced in release 31.0.2.
Batch command syntax:
BAT_SET_NEXT_CHANNEL IVAL
Python command syntax:
ierr = set_next_channel(ival)
Fortran command syntax:
CALL SET_NEXT_CHANNEL(IVAL, IERR)
Where:
Integer IVAL value to assign as the next available channel index (input).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid channel index
IERR = 2 index is beyond the maximum allowed
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
1565
Dynamics Simulation SET_NEXT_ICON
7.1.61. SET_NEXT_ICON
Use this API to assign the next available ICON index value.
This API routine was first introduced in release 31.0.2.
Batch command syntax:
BAT_SET_NEXT_ICON IVAL
Python command syntax:
ierr = set_next_icon(ival)
Fortran command syntax:
CALL SET_NEXT_ICON(IVAL, IERR)
Where:
Integer IVAL value to assign as the next available ICON index (input).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid ICON index
IERR = 2 index is beyond the maximum allowed
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
1566
Dynamics Simulation SET_NEXT_VAR
7.1.62. SET_NEXT_VAR
Use this API to assign the next available VAR index value.
This API routine was first introduced in release 31.0.2.
Batch command syntax:
BAT_SET_NEXT_VAR IVAL
Python command syntax:
ierr = set_next_var(ival)
Fortran command syntax:
CALL SET_NEXT_VAR(IVAL, IERR)
Where:
Integer IVAL value to assign as the next available VAR index (input).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid VAR index
IERR = 2 index is beyond the maximum allowed
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
1567
Dynamics Simulation SET_OSSCAN
7.1.63. SET_OSSCAN
Use this API to enable or disable the simulation option setting that scans for out-of-step conditions using a
generic relay.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SET_OSSCAN STATUS TRIP
Python command syntax:
ierr = set_osscan(status, trip)
ierr, status,trip = set_osscan()
Fortran command syntax:
CALL SET_OSSCAN(STATUS, TRIP, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 0 disable out-of-step scanning
STATUS = 1 enable out-of-step scanning
Integer TRIP monitor trip flag (input; unchanged).
TRIP = 0 monitor only
TRIP = 1 trip out-of-step circuits
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS and the trip flag to the value specified
in TRIP.
ICODE > 0 return the current value of the option setting
in STATUS and the trip flag in TRIP.
Integer IERR error code (output).
IERR = 0 no error
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
1568
Dynamics Simulation SET_OSSCAN_2
7.1.64. SET_OSSCAN_2
This API routine is obsolete. It has been replaced by the API routine SET_OSSCAN_2 .
Use this API to enable or disable the simulation option setting that scans for out-of-step conditions using a
generic relay.
This API routine was first introduced in release 35.0.0.
Batch command syntax:
BAT_SET_OSSCAN_2 STATUS TRIP EXCLXFMR
Python command syntax:
ierr = set_osscan_2(status, trip, exclxfmr)
ierr, status,trip,exclxfmr = set_osscan_2()
Fortran command syntax:
CALL SET_OSSCAN_2(STATUS, TRIP, EXCLXFMR, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 0 disable out-of-step scanning
STATUS = 1 enable out-of-step scanning
Integer TRIP monitor or trip flag (input; unchanged).
TRIP = 0 monitor only
TRIP = 1 trip out-of-step circuits
Integer EXCLXFMR flag to include or exclude transformer for out-of-step check (input; no
default allowed).
EXCLXFMR = 1 exclude transformer in out-of-step scan
EXCLXFMR = 0 do not exclude (i.e., include) transformer in
out-of-step scan
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS, TRIP, and EXCLXFMR.
ICODE > 0 return the current value of the option setting
in STATUS, TRIP, and EXCLXFMR.
Integer IERR error code (output).
IERR = 0 no error
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
1569
Dynamics Simulation SET_OSSCAN_SUBSYS_FLAG
7.1.65. SET_OSSCAN_SUBSYS_FLAG
Use this API api for get/set the flag that is used for the subsystem defintion for performing scans for out-of-
step conditions using a generic relay.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SET_OSSCAN_SUBSYS_FLAG ALL SID
Python command syntax:
ierr = set_osscan_subsys_flag(all, sid)
ierr, all = set_osscan_subsys_flag()
Fortran command syntax:
CALL SET_OSSCAN_SUBSYS_FLAG(ALL, SID, ICODE, IERR)
Where:
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 SID valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ICODE indicates the operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
ALL
ICODE > 0 return the current value of the option setting
in ALL
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid ALL value
IERR = 2 invalid SID 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
1570
Dynamics Simulation SET_RELANG
7.1.66. SET_RELANG
Use this API to enable or disable the simulation option setting that expresses the ANGLE array relative to a
designated reference angle.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SET_RELANG SWITCH IBUSEX 'ID'
Python command syntax:
ierr = set_relang(switch, ibusex, id)
ierr, switch,ibusex,id = set_relang()
Fortran command syntax:
CALL SET_RELANG(SWITCH, IBUSEX, ID, ICODE, IERR)
Where:
Integer SWITCH option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
SWITCH = 0 disable relative angle calculation (use ab-
solute angles)
SWITCH = 1 enable relative angle calculation
Integer IBUSEX relative angle calculation to be applied (input; if batch command or
ICODE is 0 or negative; unchanged by default) (if ICODE is positive).
IBUSEX > 0 use machine ID at bus IBUSEX as the refer-
ence machine
IBUSEX = 0 use system average angle
IBUSEX = -1 use system weighted average angle
Character*2 ID machine identifier (input; if batch command or ICODE is 0 or nega-
tive; '1' by default) (if ICODE is positive).
Integer ICODE operation mode of the API (no default allowed).
ICODE < 0 set the option setting to the value specified in
SWITCH and the relative angle parameters to
the values specified in IBUSEX and ID.
ICODE > 0 return the current value of the option setting
in SWITCH and the relative angle parameters
in IBUSEX and ID.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid IBUSEX value
IERR = 2 bus not found
IERR = 3 machine not found
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
1571
Dynamics Simulation SET_RELANG
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1572
Dynamics Simulation SET_RELSCN
7.1.67. SET_RELSCN
Use this API to enable or disable the simulation option setting that scans branches using a generic branch
relay.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SET_RELSCN STATUS
Python command syntax:
ierr = set_relscn(status)
ierr, status = set_relscn()
Fortran command syntax:
CALL SET_RELSCN(STATUS, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 0 disable relay scanning
STATUS = 1 enable relay scanning
Integer ICODE operation mode of the API (no default allowed).
ICODE < 0 set the option setting to the value specified in
STATUS
ICODE > 0 return the current value of the option setting
in STATUS
Integer IERR error code (output).
IERR = 0 no error
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
1573
Dynamics Simulation SET_RELSCN_SUBSYS_FLAG
7.1.68. SET_RELSCN_SUBSYS_FLAG
Use this API api for get/set the flag that is used for the subsystem defintion for performing scans of branch-
es using a generic branch relay.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SET_RELSCN_SUBSYS_FLAG ALL SID
Python command syntax:
ierr = set_relscn_subsys_flag(all, sid)
ierr, all = set_relscn_subsys_flag()
Fortran command syntax:
CALL SET_RELSCN_SUBSYS_FLAG(ALL, SID, ICODE, IERR)
Where:
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 SID valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ICODE indicates the operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
ALL
ICODE > 0 return the current value of the option setting
in ALL
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid ALL value
IERR = 2 invalid SID 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
1574
Dynamics Simulation SET_VLTSCN
7.1.69. SET_VLTSCN
Use this API to enable or disable the simulation option setting that scans buses for high or low values of
voltage magnitude.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SET_VLTSCN STATUS VHI VLO
Python command syntax:
ierr = set_vltscn(status, vhi, vlo)
ierr, status,vhi,vlo = set_vltscn()
Fortran command syntax:
CALL SET_VLTSCN(STATUS, VHI, VLO, ICODE, IERR)
Where:
Integer STATUS option setting (input; if batch command or ICODE is 0 or negative;
unchanged by default) (if ICODE is positive).
STATUS = 1 enable voltage scanning
STATUS = 1 disable voltage scanning
Real VHI high voltage threshold (input; if batch command or ICODE is 0 or
negative; unchanged by default) (if ICODE is positive).
Real VLO low voltage threshold (input; if batch command or ICODE is 0 or neg-
ative; unchanged by default) (if ICODE is positive).
Integer ICODE operation mode of the API (no default allowed).
ICODE < 0 set the option setting to the value specified in
STATUS and the voltage limits to VHI and VLO.
ICODE > 0 return the current value of the option setting
in STATUS and the voltage limits in VHI and
VLO.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid specification of VHI and VLO
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
1575
Dynamics Simulation SET_VLTSCN_SUBSYS_FLAG
7.1.70. SET_VLTSCN_SUBSYS_FLAG
Use this API api for get/set the flag that is used for the subsystem definition for performing scans of buses
for high or low voltage magnitudes.
This API routine was first introduced in release 34.0.0.
Batch command syntax:
BAT_SET_VLTSCN_SUBSYS_FLAG ALL SID
Python command syntax:
ierr = set_vltscn_subsys_flag(all, sid)
ierr, all = set_vltscn_subsys_flag()
Fortran command syntax:
CALL SET_VLTSCN_SUBSYS_FLAG(ALL, SID, ICODE, IERR)
Where:
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 SID valid subsystem identifier. Valid subsystem identifiers range from 0
to 11. Subsystem SID must have been previously defined (input; 0 by
default).
Integer ICODE indicates the operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
ALL
ICODE > 0 return the current value of the option setting
in ALL
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid ALL value
IERR = 2 invalid SID 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
1576
Dynamics Simulation SET_VOLTAGE_DIP_CHECK
7.1.71. SET_VOLTAGE_DIP_CHECK
This API is used to enable or disable the simulation option setting which scans buses for voltage dip (back-
swing).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_SET_VOLTAGE_DIP_CHECK VDPCHK VDPTHR VDPDUR
Python command syntax:
ierr = set_voltage_dip_check(vdpchk, vdpthr, vdpdur)
ierr, vdpchk, vdpthr, vdpdur = set_voltage_dip_check()
Fortran command syntax:
CALL SET_VOLTAGE_DIP_CHECK(VDPCHK, VDPTHR, VDPDUR, ICODE, IERR)
Where:
Integer VDPCHK (input; flag to set voltage dip check: if command or ICODE is 0 or
negative; unchanged).
VDPCHK = 0 disable voltage dip check
VDPCHK = 1 enable voltage dip check
Real VDPTHR (input; voltage dip threshold in per unit: if batch command or ICODE
is 0 or negative; unchanged by default. if ICODE is positive. If the
voltage swings-back below this threshold a timer is imitated to check
for the dip duration).
Real VDPDUR (input; voltage dip duration in seconds: if batch command or ICODE
is 0 or negative; unchanged).
Integer ICODE operation mode of API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
VDPCHK, VDPTHR, and VDPDUR.
ICODE > 0 return the current value of the option setting
in VDPCHK, VDPTHR, and VDPDUR.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 prerequisite requirements for API not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1577
Dynamics Simulation SET_VOLTAGE_REC_CHECK
7.1.72. SET_VOLTAGE_REC_CHECK
This API is used to enable or disable the simulation option setting which scans buses for voltage recovery
(primary and secondary recovery).
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_SET_VOLTAGE_REC_CHECK VPRCHK VSRCHK VPRTHR VPRTIM VSRTHR
VSRTIM
Python command syntax:
ierr = set_voltage_rec_check(vprchk, vsrchk, vprthr, vprtim, vsrthr,
vsrtim)
ierr, vprchk, vsrchk, vprthr, vprtim, vsrthr, vsrtim =
set_voltage_rec_check()
Fortran command syntax:
CALL SET_VOLTAGE_REC_CHECK(VPRCHK, VSRCHK, VPRTHR, VPRTIM, VSRTHR, VSRTIM,
ICODE, IERR)
Where:
Integer VPRCHK (input; flag to set voltage primary recovery check: if batch command
or ICODE is 0 or negative; unchanged).
VPRCHK = 0 disable primary recovery check
VPRCHK = 1 enable primary recovery check
Integer VSRCHK (input; flag to set voltage secondary recovery check: if batch com-
mand or ICODE is 0 or negative; unchanged).
VSRCHK = 0 disable secondary recovery check
VSRCHK = 1 enable secondary recovery check
Real VPRTHR (input; voltage primary recovery threshold in per unit: if batch com-
mand or ICODE is 0 or negative; unchanged).
Real VPRTIM (input; voltage primary recovery time in seconds: if batch command
or ICODE is 0 or negative; unchanged).
Real VSRTHR (input; voltage secondary recovery threshold in per unit: if batch
command or ICODE is 0 or negative; unchanged).
Real VSRTIM (input; voltage secondary recovery time in seconds: if batch com-
mand or ICODE is 0 or negative; unchanged).
Integer ICODE operation mode of API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
VPRCHK, VSRCHK, VPRTHR, VPRTIM, VSRTHR
and VSRTIM.
ICODE > 0 return the current value of the option set-
ting in VPRCHK, VSRCHK, VPRTHR, VPRTIM,
VSRTHR and VSRTIM.
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1578
Dynamics Simulation SET_VOLTAGE_REC_CHECK
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid specification of VPRTHR and VSRTHR
IERR = 2 invalid specification of VPRTIM and VSRTIM
IERR = 3 prerequisite requirements for API not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1579
Dynamics Simulation SET_VOLT_VIOL_SUBSYS_FLAG
7.1.73. SET_VOLT_VIOL_SUBSYS_FLAG
This API is used to set the flag to denote the bus subsystem to be used for voltage violation (voltage recov-
ery and voltage dip) checks.
This API routine was first introduced in release 33.0.0.
Batch command syntax:
BAT_SET_VOLT_VIOL_SUBSYS_FLAG ALL
Python command syntax:
ierr = set_volt_viol_subsys_flag(all)
ierr, all = set_volt_viol_subsys_flag()
Fortran command syntax:
CALL SET_VOLT_VIOL_SUBSYS_FLAG(ALL, ICODE, IERR)
Where:
Integer ALL flag to set the subsystem definition for performing voltage viola-
tion check (input; if batch command or ICODE is 0 or negative; un-
changed by default) (if ICODE is positive).
ALL = 0 Use existing bus subsystem definition
ALL = 1 Do voltage violation check on all buses
Integer ICODE Indicates the operation mode of API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
ALL
ICODE > 0 return the current value of the option setting
in ALL
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 Invalid ALL value
IERR = 2 prerequisite requirements for API not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1580
Dynamics Simulation SET_ZSORCE_RECONCILE_FLAG
7.1.74. SET_ZSORCE_RECONCILE_FLAG
Use this API to enable or disable the simulation option setting for automatic ZSORCE reconciliation.
This API routine was first introduced in release 33.10.0 and 34.2.0.
Batch command syntax:
BAT_SET_ZSORCE_RECONCILE_FLAG STATUS
Python command syntax:
ierr = set_zsorce_reconcile_flag(status)
ierr, status = set_zsorce_reconcile_flag()
Fortran command syntax:
CALL SET_ZSORCE_RECONCILE_FLAG(STATUS, ICODE, IERR)
Where:
Integer STATUS option setting (input; if Batch command or for Python if specified as
an argument, or for Fortran if ICODE is 0; no default allowed).
STATUS = 0 disable ZSORCE reconciliation
STATUS = 1 enable ZSORCE reconciliation
Integer ICODE 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 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1581
Dynamics Simulation SIZE_DS
7.1.75. SIZE_DS
Use this API to obtain a summary of utilization in the general purpose dynamics data storage arrays as well
as in the various model connection and allocation tables contained in dynamics working memory.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_SIZE_DS
Python command syntax:
ierr = size_ds()
Fortran command syntax:
CALL SIZE_DS(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
1582
Dynamics Simulation SNAP
7.1.76. SNAP
Use this API to save PSSE dynamics working memory into a Snapshot file.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_SNAP STATUS(1)..STATUS(5) SFILE
Python command syntax:
ierr = snap(status, sfile)
Fortran command syntax:
CALL SNAPNW(STATUS, SFILE, IERR)
Where:
Integer STATUS (5) array of 5 elements specifying save options. For each entry, -1 may
be specified to indicate that the number of elements of the corre-
sponding array(s) to save in the Snapshot File is 1 through the next
available - 1(input).
STATUS(1) number of CONs to save (next available-1 by
default)
STATUS(2) number of STATEs to save (next available-1
by default)
STATUS(3) number of VARs to save (next available-1 by
default)
STATUS(4) number of ICONs to save (next available-1 by
default)
STATUS(5) number of channels to save (next available-1
by default)
Character*260 SFILE snapshot file; '*' to use the most recently accessed snapshot file in
the current execution of PSSE (input; no default allowed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS value
IERR = 2 error opening SFILE
IERR = 3 error writing to 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
1583
Dynamics Simulation STRT
7.1.77. STRT
This API routine is obsolete. It has been replaced by the API routine strt_2 .
Use this API to initialize a PSSE dynamic simulation for state-space simulations (i.e., in preparation for ac-
tivity RUN) and to specify the channel output file into which the output channel values are to be recorded
during the dynamic simulation.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_STRT OPTION OUTFILE
Python command syntax:
ierr = strt(option, outfile)
Fortran command syntax:
CALL STRTAPI(OPTION, OUTFILE, IERR)
Where:
Integer OPTION network solution convergence monitor option (input; 0 by default).
OPTION = 0 print the convergence monitor only if it is en-
abled via the CM interrupt control code.
OPTION = 1 automatically print the convergence monitor.
Character*260 OUTFILE name of the channel output file (blank to bypass recording of the
output channel values in a Channel Output File) (input; blank by de-
fault).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 generators are not converted
IERR = 2 invalid OPTION value
IERR = 3 Prior initialization modified the loads--pick up
original converted case
IERR = 4 error opening OUTFILE
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
1584
Dynamics Simulation STRT_2
7.1.78. STRT_2
This API routine is the second release of the dynamic simulation initialization function. Use this API routine
to initialize a PSSE dynamic simulation for state-space simulations (i.e., in preparation for activity RUN) and
to specify the channel output file into which the output channel values are to be recorded during the dy-
namic simulation.
This API routine was first introduced in release 33.9.0 and 34.2.0.
Batch command syntax:
BAT_STRT_2 OPTIONS OUTFILE
Python command syntax:
ierr = strt_2(options, outfile)
Fortran command syntax:
CALL STRT_2(OPTIONS, OUTFILE, IERR)
Where:
Integer OPTIONS (2) array of 2 elements specifying simulation initialization
options(input).
OPTIONS(1) Network solution convergence monitor op-
tion
OPTIONS(1) = 0 bypass printing of the network solution con-
vergence monitor
OPTIONS(1) = 1 print the network solution convergence mon-
itor
OPTIONS(2) Missing machine model netting option.
OPTIONS(2) = 0 treat as a fatal error
OPTIONS(2) = 1 net machine power
Character*260 OUTFILE channel output file (blank to bypass recording of the output channel
values in a channel output file) (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 generators are not converted
IERR = 2 invalid OPTIONS value
IERR = 3 prior initialization modified the loads - pick up
original converted case
IERR = 4 error opening OUTFILE
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
1585
Dynamics Simulation SWSLIST
7.1.79. SWSLIST
Use this API to list switched shunt models connected to subsystem buses along with their storage locations
in the dynamics data arrays.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_SWSLIST SID ALL STATUS
Python command syntax:
ierr = swslist(sid, all, status)
Fortran command syntax:
CALL SWSLIST(SID, ALL, STATUS, IERR)
Where:
Integer SID subsystem identifier. Valid subsystem identifiers range from 0 to 11.
Subsystem SID must have been previously defined (input; 0 by de-
fault).
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 active/bypassed flag (input; 0 by default).
STATUS = 0 active and bypassed models
STATUS = 1 active models only
STATUS = 2 bypassed models only
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 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
1586
Dynamics Simulation TRIG_VOLT_VIOLATION_CHECK
7.1.80. TRIG_VOLT_VIOLATION_CHECK
This API is used to trigger voltage violation (voltage recovery, voltage dip) checks.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_TRIG_VOLT_VIOLATION_CHECK STATUS
Python command syntax:
ierr = trig_volt_violation_check(status)
ierr, status = trig_volt_violation_check()
Fortran command syntax:
CALL TRIG_VOLT_VIOLATION_CHECK(STATUS, ICODE, IERR)
Where:
Integer STATUS option setting (input).
STATUS = 0 disable voltage violation check
STATUS = 1 trigger voltage violation
Integer ICODE operation mode of the API (no default allowed).
ICODE <= 0 set the option setting to the value specified in
STATUS
ICODE > 0 return the current value of the option setting
in STATUS
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 prerequisite requirements for API not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1587
Dynamics Simulation WNLIST
7.1.81. WNLIST
Use this API to list wind models connected to subsystem buses along with their storage locations in the dy-
namics data arrays.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_WNLIST SID ALL STATUS
Python command syntax:
ierr = wnlist(sid, all, status)
Fortran command syntax:
CALL WNLIST(SID, ALL, STATUS, IERR)
Where:
Integer SID subsystem identifier. Valid subsystem identifiers range from 0 to 11.
Subsystem SID must have been previously defined (input; 0 by de-
fault).
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 (2) array of 2 elements specifying API options(input).
STATUS(1) active/bypassed flag (0 by default)
STATUS(1) = 0 active and bypassed models
STATUS(1) = 1 active models only
STATUS(1) = 2 bypassed models only
STATUS(2) wind model type (1 by default)
STATUS(2) = 1 all wind models
STATUS(2) = 2 wind generator models
STATUS(2) = 3 wind electrical models
STATUS(2) = 4 wind mechanical models
STATUS(2) = 5 wind pitch models
STATUS(2) = 6 wind aerodynamic models
STATUS(2) = 7 wind gust models
STATUS(2) = 8 wind auxiliary signal models
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 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
1588
Dynamics Simulation WNLIST
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1589
Dynamics Simulation WNLIST
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1590
Dynamics Simulation Output Channel Operations
7.2. Output Channel Operations
Output Channel Operations contains API routines that deals with managing channel output operations, and
with assigning quantities to output channels.
7.2.1. Dynamic Simulation Output Channel Operation
7.2.1.1. CHANGE_CHANNEL
Use this API to change the channel address and the channel identifier of a specified output channel.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_CHANGE_CHANNEL CHNARG ADRARG IDNARG
Python command syntax:
ierr = change_channel(chnarg,adrarg, idnarg)
Fortran command syntax:
CALL CHANGE_CHANNEL(CHNARG, ADRARG, IDNARG, IERR)
Where:
Integer CHNARG channel number for which the channel address and/or channel iden-
tifier has to be changed (input; no default allowed).
Integer ADRARG channel address (input; unchanged).
Character*32 IDNARG channel identifier (input; unchanged).
Integer IERR error code (output).
IERR = -1 warnings - one or more of: - channel number
is larger than NCHAN
IERR = 0 no error
IERR = 1 invalid channel number
IERR = 2 channel number is at or beyond the next
available channel
IERR = 3 invalid channel address
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
1591
Dynamics Simulation Dynamic Simulation Output
Channel Operation
7.2.1.2. CHSB
Use this API to specify, on a subsystem basis, the simulation variables to monitor during dynamic simula-
tion runs (activity CHSB).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CHSB SID ALL STATUS(1)..STATUS(6)
Python command syntax:
ierr = chsb(sid, all, status)
Fortran command syntax:
CALL CHSBNW(SID, ALL, STATUS, IERR)
Where:
Integer SID valid area, bus, owner, or zone subsystem identifier. Valid subsystem
identifiers range from 0 to 11. Area, bus, owner, or zone 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 (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) used to indicate the type of quantities to be
placed in channels (1 by default)
STATUS(4) = 1 machine, bus, load, branch quantities by bus
subsystem
STATUS(4) = 2 tie quantity by area subsystem
STATUS(4) = 3 tie quantity by zone subsystem
STATUS(4) = 4 power totals for an area subsystem
STATUS(4) = 5 power totals for a zone subsystem
STATUS(4) = 6 power totals for an owner subsystem
STATUS(4) = 7 power totals for all buses
STATUS(4) = 8 machine angle statistics
STATUS(5) quantity code (1 by default). If STATUS(4) =
4, 5, 6, 7 or 8 then STATUS(5) is ignored)
If STATUS(4) = 1:
STATUS(5) = 1 ANGLE, machine relative rotor angle (de-
grees).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1592
Dynamics Simulation Dynamic Simulation Output
Channel Operation
STATUS(5) = 2 PELEC, machine electrical power (pu on
SBASE).
STATUS(5) = 3 QELEC, machine reactive power.
STATUS(5) = 4 ETERM, machine terminal voltage (pu).
STATUS(5) = 5 EFD, generator main field voltage (pu).
STATUS(5) = 6 PMECH, turbine mechanical power (pu on
MBASE).
STATUS(5) = 7 SPEED, machine speed deviation from nomi-
nal (pu).
STATUS(5) = 8 XADIFD, machine field current (pu).
STATUS(5) = 9 ECOMP, voltage regulator compensated volt-
age (pu).
STATUS(5) = 10 VOTHSG, stabilizer output signal (pu).
STATUS(5) = 11 VREF, voltage regulator voltage setpoint
(pu).
STATUS(5) = 12 BSFREQ, bus pu frequency deviations.
STATUS(5) = 13 VOLT, bus pu voltages (complex).
STATUS(5) = 14 voltage and angle
STATUS(5) = 15 flow (P).
STATUS(5) = 16 flow (P and Q).
STATUS(5) = 17 flow (MVA).
STATUS(5) = 18 apparent impedance (R and X).
STATUS(5) = 21 ITERM.
STATUS(5) = 22 machine apparent impedance
STATUS(5) = 23 VUEL, minimum excitation limiter output
signal (pu).
STATUS(5) = 24 VOEL, maximum excitation limiter output
signal (pu).
STATUS(5) = 25 PLOAD.
STATUS(5) = 26 QLOAD.
STATUS(5) = 27 GREF, turbine governor reference.
STATUS(5) = 28 LCREF, turbine load control reference.
STATUS(5) = 29 WVLCTY, wind velocity (m/s).
STATUS(5) = 30 WTRBSP, wind turbine rotor speed deviation
(pu).
STATUS(5) = 31 WPITCH, pitch angle (degrees).
STATUS(5) = 32 WAEROT, aerodynamic torque (pu on
MBASE).
STATUS(5) = 33 WROTRV, rotor voltage (pu on MBASE).
STATUS(5) = 34 WROTRI, rotor current (pu on MBASE).
STATUS(5) = 35 WPCMND, active power command from
wind control (pu on MBASE).
STATUS(5) = 36 WQCMND, reactive power command from
wind control (pu on MBASE).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1593
Dynamics Simulation Dynamic Simulation Output
Channel Operation
STATUS(5) = 37 WAUXSG, output of wind auxiliary control
(pu on MBASE).
STATUS(6) out-of-service equipment option (0 by de-
fault)
STATUS(6) = 0 omit out-of-service equipment
STATUS(6) = 1 include out-of-service equipment
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 have just assigned channel n, which is the
highest channel number
IERR = 5 trying to assign locations beyond the end of
the VAR or ICON array
IERR = 6 machine angle statistics are already assigned
to channels
IERR = 7 n monitoring models specified--pointer table
full
IERR = 8 next channel is greater than the maximum al-
lowed channel number
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
1594
Dynamics Simulation Dynamic Simulation Output
Channel Operation
7.2.1.3. CRT_PLOT_CHANNEL
Use this API to assign one of the main simulation output channels to a designated CRT plot channel.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CRT_PLOT_CHANNEL CRTCHAN CHANNEL CMIN CMAX
Python command syntax:
ierr = crt_plot_channel(crtchan, channel, cmin, cmax)
Fortran command syntax:
CALL CRT_PLOT_CHANNEL(CRTCHAN, CHANNEL, CMIN, CMAX, IERR)
Where:
Integer CRTCHAN CRT plot channel number (1 through 6) (input; no default allowed).
Integer CHANNEL number of the main simulation channel to be assigned to CRT chan-
nel number CRTCHAN (must be between 1 and the number of out-
put channels allowed at the present size level of PSSE), or 0 to disable
CRT plot channel CRTCHAN (input; unchanged).
Real CMIN minimum plotting scale value for this CRT plot channel (input; un-
changed).
Real CMAX maximum plotting scale value for this CRT plot channel (input; un-
changed).
Integer IERR error code (output).
IERR = 0 no error occurred
IERR > 0 error occurred
IERR = 1 invalid CRTCHAN value
IERR = 2 invalid CHANNEL value
IERR = 3 CMIN is not less than CMAX
IERR = 4 prerequisite requirements for API are not met
IERR = -1 warnings - one or more of: - CHANNEL is larg-
er than NCHAN
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1595
Dynamics Simulation Dynamic Simulation Output
Channel Operation
7.2.1.4. DELETE_ALL_PLOT_CHANNELS
Use this API to delete all the plot channels in the working case. Use of this API will reset the number of plot
channels to zero and the next channel to one.
This API routine was first introduced in release 32.2.1.
Batch command syntax:
BAT_DELETE_ALL_PLOT_CHANNELS
Python command syntax:
ierr = delete_all_plot_channels()
Fortran command syntax:
CALL DELETE_ALL_PLOT_CHANNELS(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
1596
Dynamics Simulation Dynamic Simulation Output
Channel Operation
7.2.1.5. DMPC
Use this API to replicate the output channel specifications from dynamics working memory in the form of a
response file suitable for transferring them to another snapshot that models essentially the same system.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_DMPC OPTIONS(1)..OPTIONS(4) OUT OFILE
Python command syntax:
ierr = dmpc(options, out, ofile)
Fortran command syntax:
CALL DMPCAPI(OPTIONS, OUT, OFILE, IERR)
Where:
Integer OPTIONS (4) array of 4 elements specifying (input).
OPTIONS(1) channel selection code (1 by default)
OPTIONS(1) = 0 skip channels containing STATEs or VARs not
associated with channel monitoring models
OPTIONS(1) = 1 include all channels
OPTIONS(2) starting channel code (-1 by default)
OPTIONS(2) < 0 start at next available channel
OPTIONS(2) = 0 keep existing channel numbers
OPTIONS(2) > 0 starting channel number
OPTIONS(3) starting VAR code for channel monitoring
models (-1 by default)
OPTIONS(3) < 0 start at next available VAR
OPTIONS(3) = 0 keep existing VAR indices
OPTIONS(3) > 0 starting VAR index
OPTIONS(4) starting ICON code for channel monitoring
models (-1 by default)
OPTIONS(4) < 0 start at next available ICON
OPTIONS(4) = 0 keep existing ICON indices
OPTIONS(4) > 0 starting ICON index
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 OPTIONS(1) value
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1597
Dynamics Simulation Dynamic Simulation Output
Channel Operation
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 invalid OUT value
IERR = 6 error opening file OFILE
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
1598
Dynamics Simulation Dynamic Simulation Output
Channel Operation
7.2.1.6. LIST_CHANNEL_MODELS
Use this API to tabulate the output channel monitoring models referenced in the dynamic model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_LIST_CHANNEL_MODELS STATUS
Python command syntax:
ierr = list_channel_models(status)
Fortran command syntax:
CALL LIST_CHANNEL_MODELS(STATUS, IERR)
Where:
Integer STATUS category of channel monitoring models to be listed (input; 0 by de-
fault).
STATUS = 0 all output channel monitoring models
STATUS = 1 only models monitoring equipment that ex-
ists in the power flow working case
STATUS = 2 only models monitoring equipment that is
not present in the power flow working case
Integer IERR error code (output).
IERR = 0 no error occurred
IERR = 1 invalid STATUS 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
1599
Dynamics Simulation Dynamic Simulation Output
Channel Operation
7.2.1.7. REMOVE_UNUSED_CHAN_MODELS
Use this API to delete from the output channel monitoring model table those model references indicating
equipment that is not present in the power flow working case.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_REMOVE_UNUSED_CHAN_MODELS
Python command syntax:
ierr = remove_unused_chan_models()
Fortran command syntax:
CALL REMOVE_UNUSED_CHAN_MODELS(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
1600
Dynamics Simulation Dynamic Simulation Output
Channel Operation
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1601
Dynamics Simulation Assign Machine Quantities to
Output Channels
7.2.2. Assign Machine Quantities to Output Channels
7.2.2.1. MACHINE_APP_R_X_CHANNEL
Use this API to add a pair of output channels containing the apparent impedance of the system, as seen
from the terminals of a specified machine, along with a corresponding call to the GENTMZ monitoring
model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_MACHINE_APP_R_X_CHANNEL STATUS(1)..STATUS(4) 'ID' 'IDENT(1)'
'IDENT(2)'
Python command syntax:
ierr = machine_app_r_x_channel(status, id, ident)
Fortran command syntax:
CALL MACHINE_APP_R_X_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (4) array of 4 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the bus to which the machine
for which the apparent impedance is to be
placed in channels is connected (no default
allowed)
Character*2 ID machine identifier (input; '1' by default).
Character*32 IDENT (2) two identifiers to be assigned to the two channels. If a blank channel
identifier is specified, the API generates an appropriate channel iden-
tifier (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1602
Dynamics Simulation Assign Machine Quantities to
Output Channels
IERR = 5 model GENTMZ needs 2 VARs but the last one
exceeds the largest VAR index allowed
IERR = 6 model GENTMZ needs 2 ICONs but the last
one exceeds the largest ICON index allowed
IERR = 7 the maximum number of channel monitoring
models has already been specified
IERR = 8 model GENTMZ needs 2 channels but the last
one exceeds the largest channel number al-
lowed
IERR = 9 bus not found
IERR = 10 machine not found
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
1603
Dynamics Simulation Assign Machine Quantities to
Output Channels
7.2.2.2. MACHINE_ARRAY_CHANNEL
Use this API to add an output channel containing a plant related model variable of a designated type for a
specified machine.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_MACHINE_ARRAY_CHANNEL STATUS(1)..STATUS(3) 'ID' 'IDENT'
Python command syntax:
ierr = machine_array_channel(status, id, ident)
Fortran command syntax:
CALL MACHINE_ARRAY_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (3) array of 3 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) used to indicate the quantity to be placed in
an channel (1 by default)
STATUS(2) = 1 ANGLE, machine relative rotor angle (de-
grees)
STATUS(2) = 2 PELEC, machine electrical power (pu on
SBASE)
STATUS(2) = 3 QELEC, machine reactive power
STATUS(2) = 4 ETERM, machine terminal voltage (pu)
STATUS(2) = 5 EFD, generator main field voltage (pu)
STATUS(2) = 6 PMECH, turbine mechanical power (pu on
MBASE)
STATUS(2) = 7 SPEED, machine speed deviation from nomi-
nal (pu)
STATUS(2) = 8 XADIFD, machine field current (pu)
STATUS(2) = 9 ECOMP, voltage regulator compensated volt-
age (pu)
STATUS(2) = 10 VOTHSG, stabilizer output signal (pu)
STATUS(2) = 11 VREF, voltage regulator voltage setpoint (pu)
STATUS(2) = 12 VUEL, minimum excitation limiter output sig-
nal (pu)
STATUS(2) = 13 VOEL, maximum excitation limiter output
signal (pu)
STATUS(2) = 14 GREF, turbine governor reference
STATUS(2) = 15 LCREF, turbine load control reference
STATUS(2) = 16 WVLCTY, wind velocity (m/s)
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1604
Dynamics Simulation Assign Machine Quantities to
Output Channels
STATUS(2) = 17 WTRBSP, wind turbine rotor speed deviation
(pu)
STATUS(2) = 18 WPITCH, pitch angle (degrees)
STATUS(2) = 19 WAEROT, aerodynamic torque (pu on MBASE)
STATUS(2) = 20 WROTRV, rotor voltage (pu on MBASE)
STATUS(2) = 21 WROTRI, rotor current (pu on MBASE)
STATUS(2) = 22 WPCMND, active power command from wind
control (pu on MBASE)
STATUS(2) = 23 WQCMND, reactive power command from
wind control (pu on MBASE)
STATUS(2) = 24 WAUXSG, output of wind auxiliary control
(pu on MBASE)
STATUS(3) number of the bus to which the machine
for which the quantity is to be placed in an
channel is connected (no default allowed)
Character*2 ID machine identifier (input; '1' by default).
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 bus not found
IERR = 4 machine not found
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
1605
Dynamics Simulation Assign Machine Quantities to
Output Channels
7.2.2.3. MACHINE_ITERM_CHANNEL
Use this API to add an output channel containing the terminal current of a specified machine, along with a
corresponding call to the GENTMC monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_MACHINE_ITERM_CHANNEL STATUS(1)..STATUS(4) 'ID' 'IDENT'
Python command syntax:
ierr = machine_iterm_channel(status, id, ident)
Fortran command syntax:
CALL MACHINE_ITERM_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (4) array of 4 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the bus to which the machine for
which the terminal current is to be placed in
an channel is connected (no default allowed)
Character*2 ID machine identifier (input; '1' by default).
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model GENTMC needs 2 VARs but the last one
exceeds the largest VAR index allowed
IERR = 6 model GENTMC needs 2 ICONs but the last
one exceeds the largest ICON index allowed
IERR = 7 the maximum number of channel monitoring
models has already been specified
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1606
Dynamics Simulation Assign Machine Quantities to
Output Channels
IERR = 8 bus not found
IERR = 9 machine not found
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
1607
Dynamics Simulation Assign Machine Quantities to
Output Channels
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1608
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3. Assign Branch Quantities to Output Channels
7.2.3.1. BRANCH_APP_R_X_CHANNEL
Use this API to add a pair of output channels containing the apparent impedance, as seen at the from bus
of a specified branch, along with a corresponding call to the RELAY2 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_BRANCH_APP_R_X_CHANNEL STATUS(1)..STATUS(5) 'ID' 'IDENT(1)'
'IDENT(2)'
Python command syntax:
ierr = branch_app_r_x_channel(status, id, ident)
Fortran command syntax:
CALL BRANCH_APP_R_X_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (5) array of 5 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the branch for
which apparent impedance is to be placed in
channels (no default allowed)
STATUS(5) number of the to bus of the branch for which
apparent impedance is to be placed in chan-
nels (no default allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT (2) two identifiers to be assigned to the two channels. If a blank channel
identifier is specified, the API generates an appropriate channel iden-
tifier (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1609
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 5 model RELAY2 needs 3 ICONs but the last one
exceeds the largest ICON index allowed
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 model RELAY2 needs 2 VARs but the last one
exceeds the largest VAR index allowed
IERR = 8 model RELAY2 needs 2 channels but the last
one exceeds the largest channel number al-
lowed
IERR = 9 bus not found
IERR = 10 branch not found
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
1610
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3.2. BRANCH_MVA_CHANNEL
Use this API to add an output channel containing the MVA flow at the from bus of a specified branch,
along with a corresponding call to the FLOW1 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_BRANCH_MVA_CHANNEL STATUS(1)..STATUS(5) 'ID' 'IDENT'
Python command syntax:
ierr = branch_mva_channel(status, id, ident)
Fortran command syntax:
CALL BRANCH_MVA_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (5) array of 5 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the branch for
which MVA flow is to be placed in an channel
(no default allowed)
STATUS(5) number of the to bus of the branch for which
MVA is to be placed in an channel (no default
allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model FLOW1 needs 3 ICONs but the last one
exceeds the largest ICON index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1611
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 bus not found
IERR = 8 branch not found
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
1612
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3.3. BRANCH_P_AND_Q_CHANNEL
Use this API to add a pair of output channels containing the active and reactive power flow at the from bus
of a specified branch, along with a corresponding call to the FLOW1 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_BRANCH_P_AND_Q_CHANNEL STATUS(1)..STATUS(5) 'ID' 'IDENT(1)'
'IDENT(2)'
Python command syntax:
ierr = branch_p_and_q_channel(status, id, ident)
Fortran command syntax:
CALL BRANCH_P_AND_Q_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (5) array of 5 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the branch for
which active and reactive power flows are to
be placed in channels (no default allowed)
STATUS(5) number of the to bus of the branch for which
active and reactive power flows are to be
placed in channels (no default allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT (2) two identifiers to be assigned to the two channels. If a blank channel
identifier is specified, the API generates an appropriate channel iden-
tifier (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model FLOW1 needs 3 ICONs but the last one
exceeds the largest ICON index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1613
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 model FLOW1 needs 2 VARs but the last one
exceeds the largest VAR index allowed
IERR = 8 model FLOW1 needs 2 channels but the last
one exceeds the largest channel number al-
lowed
IERR = 9 bus not found
IERR = 10 branch not found
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
1614
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3.4. BRANCH_P_CHANNEL
Use this API to add an output channel containing the active power flow at the from bus of a specified
branch, along with a corresponding call to the FLOW1 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_BRANCH_P_CHANNEL STATUS(1)..STATUS(5) 'ID' 'IDENT'
Python command syntax:
ierr = branch_p_channel(status, id, ident)
Fortran command syntax:
CALL BRANCH_P_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (5) array of 5 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the branch for
which active power flow is to be placed in an
channel (no default allowed)
STATUS(5) number of the to bus of the branch for which
active power flow is to be placed in an chan-
nel (no default allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model FLOW1 needs 3 ICONs but the last one
exceeds the largest ICON index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1615
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 bus not found
IERR = 8 branch not found
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
1616
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3.5. THREE_WND_APP_R_X_CHANNEL
Use this API to add a pair of output channels containing the apparent impedance as seen at the from bus
of a specified three-winding transformer, along with a corresponding call to the RELAY3 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_THREE_WND_APP_R_X_CHANNEL STATUS(1)..STATUS(6) 'ID' 'IDENT(1)'
'IDENT(2)'
Python command syntax:
ierr = three_wnd_app_r_x_channel(status, id, ident)
Fortran command syntax:
CALL THREE_WINDING_APP_R_X_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (6) array of 6 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the three-winding
transformer for which apparent impedance is
to be placed in channels (no default allowed)
STATUS(5) number of one of the to buses of the three-
winding transformer for which apparent im-
pedance is to be placed in channels (no de-
fault allowed)
STATUS(6) number of the third bus of the three-winding
transformer for which apparent impedance is
to be placed in channels (no default allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT (2) two identifiers to be assigned to the two channels. If a blank channel
identifier is specified, the API generates an appropriate channel iden-
tifier (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1617
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model RELAY3 needs 4 ICONs but the last one
exceeds the largest ICON index allowed
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 model RELAY3 needs 2 VARs but the last one
exceeds the largest VAR index allowed
IERR = 8 model RELAY3 needs 2 channels but the last
one exceeds the largest channel number al-
lowed
IERR = 9 bus not found
IERR = 10 branch not found
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
1618
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3.6. THREE_WND_MVA_CHANNEL
Use this API to add an output channel containing the MVA flow at the from bus of a specified three-wind-
ing transformer, along with a corresponding call to the FLOW3 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_THREE_WND_MVA_CHANNEL STATUS(1)..STATUS(6) 'ID' 'IDENT'
Python command syntax:
ierr = three_wnd_mva_channel(status, id, ident)
Fortran command syntax:
CALL THREE_WINDING_MVA_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (6) array of 6 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the three-wind-
ing transformer for which MVA flow is to be
placed in an channel (no default allowed)
STATUS(5) number of one of the to buses of the three-
winding transformer for which MVA flow is
to be placed in an channel (no default al-
lowed)
STATUS(6) number of the third bus of the three-wind-
ing transformer for which MVA flow is to be
placed in an channel (no default allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1619
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model FLOW3 needs 4 ICONs but the last one
exceeds the largest ICON index allowed
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 bus not found
IERR = 8 branch not found
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
1620
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3.7. THREE_WND_P_AND_Q_CHANNEL
Use this API to add a pair of output channels containing the active and reactive power flow at the from bus
of a specified three-winding transformer, along with a corresponding call to the FLOW3 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_THREE_WND_P_AND_Q_CHANNEL STATUS(1)..STATUS(6) 'ID' 'IDENT(1)'
'IDENT(2)'
Python command syntax:
ierr = three_wnd_p_and_q_channel(status, id, ident)
Fortran command syntax:
CALL THREE_WINDING_P_AND_Q_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (6) array of 6 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the three-wind-
ing transformer for which active and reactive
power flows are to be placed in channels (no
default allowed)
STATUS(5) number of one of the to buses of the three-
winding transformer for which active and re-
active power flows are to be placed in chan-
nels (no default allowed)
STATUS(6) number of the third bus of the three-wind-
ing transformer for which active and reactive
power flows are to be placed in channels (no
default allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT (2) two identifiers to be assigned to the two channels. If a blank channel
identifier is specified, the API generates an appropriate channel iden-
tifier (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1621
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model FLOW3 needs 4 ICONs but the last one
exceeds the largest ICON index allowed
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 model FLOW3 needs 2 VARs but the last one
exceeds the largest VAR index allowed
IERR = 8 model FLOW3 needs 2 channels but the last
one exceeds the largest channel number al-
lowed
IERR = 9 bus not found
IERR = 10 branch not found
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
1622
Dynamics Simulation Assign Branch Quantities to
Output Channels
7.2.3.8. THREE_WND_P_CHANNEL
Use this API to add an output channel containing the active power flow at the from bus of a specified
three-winding transformer, along with a corresponding call to the FLOW3 monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_THREE_WND_P_CHANNEL STATUS(1)..STATUS(6) 'ID' 'IDENT'
Python command syntax:
ierr = three_wnd_p_channel(status, id, ident)
Fortran command syntax:
CALL THREE_WINDING_P_CHANNEL(STATUS, ID, IDENT, IERR)
Where:
Integer STATUS (6) array of 6 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the from bus of the three-winding
transformer for which active power flow is to
be placed in an channel (no default allowed)
STATUS(5) number of one of the to buses of the three-
winding transformer for which active power
flow is to be placed in an channel (no default
allowed)
STATUS(6) number of the third bus of the three-winding
transformer for which active power flow is to
be placed in an channel (no default allowed)
Character*2 ID circuit identifier (input; '1' by default).
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1623
Dynamics Simulation Assign Branch Quantities to
Output Channels
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 model FLOW3 needs 4 ICONs but the last one
exceeds the largest ICON index allowed
IERR = 6 the maximum number of channel monitoring
models has already been specified
IERR = 7 bus not found
IERR = 8 branch not found
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
1624
Dynamics Simulation Assign Branch Quantities to
Output Channels
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1625
Dynamics Simulation Assign Other Quantities to Out-
put Channels
7.2.4. Assign Other Quantities to Output Channels
7.2.4.1. BUS_FREQUENCY_CHANNEL
Use this API to add an output channel containing the per unit frequency deviation at a specified bus.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_BUS_FREQUENCY_CHANNEL STATUS(1) STATUS(2) 'IDENT'
Python command syntax:
ierr = bus_frequency_channel(status, ident)
Fortran command syntax:
CALL BUS_FREQUENCY_CHANNEL(STATUS, IDENT, IERR)
Where:
Integer STATUS (2) array of 2 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) number of the bus for which frequency de-
viation is to be placed in an channel is con-
nected (no default allowed)
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 bus not found
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
1626
Dynamics Simulation Assign Other Quantities to Out-
put Channels
7.2.4.2. STATE_CHANNEL
Use this API to add an output channel containing the value of a specified STATE.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_STATE_CHANNEL STATUS(1) STATUS(2) 'IDENT'
Python command syntax:
ierr = state_channel(status, ident)
Fortran command syntax:
CALL STATE_CHANNEL(STATUS, IDENT, IERR)
Where:
Integer STATUS (2) array of 2 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) index of the STATE for which the value is to
be placed in an channel (no default allowed)
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 invalid STATE index
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
1627
Dynamics Simulation Assign Other Quantities to Out-
put Channels
7.2.4.3. VAR_CHANNEL
Use this API to add an output channel containing the value of a specified VAR.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_VAR_CHANNEL STATUS(1) STATUS(2) 'IDENT'
Python command syntax:
ierr = var_channel(status, ident)
Fortran command syntax:
CALL VAR_CHANNEL(STATUS, IDENT, IERR)
Where:
Integer STATUS (2) array of 2 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) index of the VAR for which the value is to be
placed in an channel (no default allowed)
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 invalid VAR index
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
1628
Dynamics Simulation Assign Other Quantities to Out-
put Channels
7.2.4.4. VOLTAGE_AND_ANGLE_CHANNEL
Use this API to add a pair of output channels containing the voltage magnitude in per unit and phase angle
in degrees of a specified bus, along with a corresponding call to the VOLMAG monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_VOLTAGE_AND_ANGLE_CHANNEL STATUS(1)..STATUS(4) 'IDENT(1)'
'IDENT(2)'
Python command syntax:
ierr = voltage_and_angle_channel(status, ident)
Fortran command syntax:
CALL VOLTAGE_AND_ANGLE_CHANNEL(STATUS, IDENT, IERR)
Where:
Integer STATUS (4) array of 4 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the bus for which voltage mag-
nitude and phase angle are to be placed in
channels (no default allowed)
Character*32 IDENT (2) two identifiers to be assigned to the two channels. If a blank channel
identifier is specified, the API generates an appropriate channel iden-
tifier (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 the maximum number of channel monitoring
models has already been specified
IERR = 6 bus not found
IERR = 7 model VOLMAG needs 2 VARs but the last one
exceeds the largest VAR index allowed
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1629
Dynamics Simulation Assign Other Quantities to Out-
put Channels
IERR = 8 model VOLMAG needs 2 channels but the last
one exceeds the largest channel number al-
lowed
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
1630
Dynamics Simulation Assign Other Quantities to Out-
put Channels
7.2.4.5. VOLTAGE_CHANNEL
Use this API to add an output channel containing the voltage magnitude in per unit of a specified bus,
along with a corresponding call to the VOLMAG monitoring model.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_VOLTAGE_CHANNEL STATUS(1)..STATUS(4) 'IDENT'
Python command syntax:
ierr = voltage_channel(status, ident)
Fortran command syntax:
CALL VOLTAGE_CHANNEL(STATUS, IDENT, IERR)
Where:
Integer STATUS (4) array of 4 elements specifying (input).
STATUS(1) starting channel index, or -1 for the next
available (next available by default)
STATUS(2) starting VAR index, or -1 for the next avail-
able (next available by default)
STATUS(3) starting ICON index, or -1 for the next avail-
able (next available by default)
STATUS(4) number of the bus for which voltage magni-
tude is to be placed in an channel (no default
allowed)
Character*32 IDENT identifier to be assigned to the channel. If a blank channel identifier
is specified, the API generates an appropriate channel identifier (in-
put; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid STATUS value
IERR = 2 starting channel number is greater than the
largest channel number allowed
IERR = 3 starting VAR index is greater than the largest
VAR index allowed
IERR = 4 starting ICON index is greater than the largest
ICON index allowed
IERR = 5 the maximum number of channel monitoring
models has already been specified
IERR = 6 bus not found
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
1631
Dynamics Simulation Assign Other Quantities to Out-
put Channels
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1632
Dynamics Simulation Assign Other Quantities to Out-
put Channels
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1633
Dynamics Simulation Plant Related Models
7.3. Plant Related Models
7.3.1. ADD_PLANT_MODEL
Use this API to add a plant related model of a designated type to a specified machine. If a model of the des-
ignated type already exists at the machine, it is replaced.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ADD_PLANT_MODEL IBUS 'ID' MTYPE 'NAME' IBUS2 'ID2' NICN IDATA
CHDATA NCON RDATA
Python command syntax:
ierr = add_plant_model(ibus, id, mtype, name, ibus2, id2, nicn, idata,
chdata, ncon, rdata)
Fortran command syntax:
CALL ADD_PLANT_MODEL(IBUS, ID, MTYPE, NAME, IBUS2, ID2, NICN, IDATA,
CHDATA, NCON, RDATA, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Integer MTYPE model type (input; 1 by default).
MTYPE = 1 generator model.
MTYPE = 2 compensator model.
MTYPE = 3 stabilizer model.
MTYPE = 4 minimum excitation limiter model.
MTYPE = 5 maximum excitation limiter model.
MTYPE = 6 excitation system model.
MTYPE = 7 turbine-governor model.
MTYPE = 8 turbine-load controller model.
Character*16 NAME model name (input; no default allowed).
Integer IBUS2 bus number of the second machine if this is a two machine model, or
0 for a single machine model (input; 0 by default).
Character*2 ID2 machine identifier of the second machine if this is a two machine
model, or ' ' for a single machine model (input; blank by default).
Integer NICN number of ICONs required by the model (input; no default allowed).
Integer IDATA (NICN) ICON data (input; 0 by default). When a character value is intended
for an ICON value, the corresponding IDATA entry is ignored and the
integer ICON is set to 0).
Character*12 CHDATA (NICN) character ICON data (no default allowed for an ICON for which a
character value is to be specified). When an integer value is intended
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1634
Dynamics Simulation ADD_PLANT_MODEL
for an ICON value, the corresponding CHDATA entry must be either
defaulted or specified as either '$$' or ' '; the character ICON is set to
'$$' (input; blank by default).
Integer NCON number of CONs required by the model (input; no default allowed).
Real RDATA (NCON) CON data (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 machine model connection tables full--use
pack plant model tables function
IERR = 2 plant model tables are corrupt
IERR = 3 invalid MTYPE value
IERR = 4 unknown model NAME
IERR = 5 model is not consistent with MTYPE
IERR = 6 # CONs specified is not the number expected
IERR = 7 # ICONs specified is not the number expected
IERR = 8 second machine not found where one is re-
quired
IERR = 9 same machine specified as the first and sec-
ond machines
IERR = 10 maximum number of array elements exceed-
ed
IERR = 11 bus not found
IERR = 12 machine not found
IERR = 13 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1635
Dynamics Simulation CHANGE_PLMOD_CHRICN
7.3.2. CHANGE_PLMOD_CHRICN
Use this API to change the value of a character ICON (i.e., an element of the CHRICN array) of a designated
plant related model at a specified machine. The corresponding integer ICON is set to 0.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_PLMOD_CHRICN IBUS 'ID' 'NAME' J 'CHDATA'
Python command syntax:
ierr = change_plmod_chricn(ibus, id, name, j, chdata)
Fortran command syntax:
CALL CHANGE_PLMOD_CHRICN(IBUS, ID, NAME, J, CHDATA, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Character*12 CHDATA new character ICON value (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a plant-related model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no input ICONs used in model NAME
IERR = 6 ICON number outside of the ICON range of
this model
IERR = 7 bus not found
IERR = 8 machine not found
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
1636
Dynamics Simulation CHANGE_PLMOD_CON
7.3.3. CHANGE_PLMOD_CON
Use this API to change the value of a CON of a designated plant related model at a specified machine.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_PLMOD_CON IBUS 'ID' 'NAME' J RDATA
Python command syntax:
ierr = change_plmod_con(ibus, id, name, j, rdata)
Fortran command syntax:
CALL CHANGE_PLMOD_CON(IBUS, ID, NAME, J, RDATA, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J CON number to change relative to the start of the block of CONs as-
signed to this model (1 for CON(J), 2 for CON(J+1), etc.) (input; no
default allowed).
Real RDATA new CON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a plant-related model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no CONs used in model NAME
IERR = 6 CON number outside of the CON range of this
model
IERR = 7 bus not found
IERR = 8 machine not found
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
1637
Dynamics Simulation CHANGE_PLMOD_DATA
7.3.4. CHANGE_PLMOD_DATA
This API routine is obsolete. It has been replaced by the API routines CHANGE_PLMOD_CON,
CHANGE_PLMOD_ICON, and CHANGE_PLMOD_CHRICN .
Use this API to change the value of an ICON and/or CON of a plant related model of a designated type at a
specified machine.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CHANGE_PLMOD_DATA IBUS 'ID' MTYPE 'NAME' J RDATA I IDATA
'CHDATA'
Python command syntax:
ierr = change_plmod_data(ibus,id,mtype,name,j,rdata,i,idata,chdata)
Fortran command syntax:
CALL CHANGE_PLMOD_DATA(IBUS,ID,MTYPE,NAME,J,RDATA,I,IDATA,CHDATA,IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; '1' by default).
Integer MTYPE model type (input; 1 by default).
MTYPE = 1 generator model.
MTYPE = 2 compensator model.
MTYPE = 3 stabilizer model.
MTYPE = 4 minimum excitation limiter model.
MTYPE = 5 maximum excitation limiter model.
MTYPE = 6 excitation system model.
MTYPE = 7 turbine-governor model.
MTYPE = 8 turbine-load controller model.
Character*16 NAME model name (input; no default allowed).
Integer J CON number to change relative to the start of the block of CONs as-
signed to this model, or 0 for no CON change (1 for CON(J), 2 for
CON(J+1), etc.) (input; 0 by default).
Real RDATA new CON value (input; unchanged).
Integer I ICON number to change relative to the start of the block of ICONs as-
signed to this model, or 0 for no ICON change (1 for ICON(I), 2 for
ICON(I+1), etc.) (input; 0 by default).
Integer IDATA new integer ICON value (input; unchanged by default). When a char-
acter value is intended for an ICON value, the IDATA entry is ignored
and the integer ICON is set to 0).
Character*12 CHDATA new character ICON value (no default allowed if the character ICON is
to be changed). When an integer value is intended for an ICON value,
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1638
Dynamics Simulation CHANGE_PLMOD_DATA
the CHDATA entry must be either defaulted or specified as either '$$'
or ' '; the character ICON is set to '$$' (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid MTYPE value
IERR = 2 unknown model NAME
IERR = 3 no model of type MTYPE at this machine
IERR = 4 type MTYPE model at this machine is aaa not
xxx
IERR = 5 CON number exceeds the number of CONs
used by the model
IERR = 6 ICON number exceeds the number of ICONs
used by the model
IERR = 7 neither the CON nor ICON number is positive
IERR = 8 bus not found
IERR = 9 machine not found
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
1639
Dynamics Simulation CHANGE_PLMOD_ICON
7.3.5. CHANGE_PLMOD_ICON
Use this API to change the value of an integer ICON of a designated plant related model at a specified ma-
chine. The corresponding character CHRICN is set to '$$'.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_PLMOD_ICON IBUS 'ID' 'NAME' J IDATA
Python command syntax:
ierr = change_plmod_icon(ibus, id, name, j, idata)
Fortran command syntax:
CALL CHANGE_PLMOD_ICON(IBUS, ID, NAME, J, IDATA, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Integer IDATA new integer ICON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a plant-related model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no input ICONs used in model NAME
IERR = 6 ICON number outside of the ICON range of
this model
IERR = 7 bus not found
IERR = 8 machine not found
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
1640
Dynamics Simulation CHANGE_PLMOD_VAR
7.3.6. CHANGE_PLMOD_VAR
Use this API to change the value of a VAR of a designated plant related model at a specified machine.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_CHANGE_PLMOD_VAR IBUS 'ID' 'NAME' J RDATA
Python command syntax:
ierr = change_plmod_var(ibus, id, name, j, rdata)
Fortran command syntax:
CALL CHANGE_PLMOD_VAR(IBUS, ID, NAME, J, RDATA, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J VAR number to change relative to the start of the block of VARs as-
signed to this model (1 for VAR(J), 2 for VAR(J+1), etc.) (input; no de-
fault allowed).
Real RDATA new VAR value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a plant-related model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no VARs used in model NAME
IERR = 6 VAR number outside of the VAR range of this
model
IERR = 7 bus not found
IERR = 8 machine not found
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
1641
Dynamics Simulation GMB_ADD_PLANT_MODEL
7.3.7. GMB_ADD_PLANT_MODEL
Use this API to add a plant related GMB model to a specified machine. If a model of the designated type al-
ready exists at the machine, it is replaced.
This API routine was first introduced in release 32.0.2.
Batch command syntax:
BAT_GMB_ADD_PLANT_MODEL IBUS 'ID' 'NAME' IBUS2 'ID2' NICN IDATA
CHDATA NCON RDATA
Python command syntax:
ierr = gmb_add_plant_model(ibus, id, name, ibus2, id2, nicn, idata,
chdata, ncon, rdata)
Fortran command syntax:
CALL GMB_ADD_PLANT_MODEL(IBUS, ID, NAME, IBUS2, ID2, NICN, IDATA, CHDATA,
NCON, RDATA, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer IBUS2 bus number of the second machine if this is a two machine model, or
0 for a single machine model (input; 0 by default).
Character*2 ID2 machine identifier of the second machine if this is a two machine
model, or ' ' for a single machine model (input; blank by default).
Integer NICN number of ICONs required by the model (input; no default allowed).
Integer IDATA (NICN) ICON data (input; 0 by default). When a character value is intended
for an ICON value, the corresponding IDATA entry is ignored and the
integer ICON is set to 0).
Character*12 CHDATA (NICN) character ICON data (no default allowed for an ICON for which a
character value is to be specified). When an integer value is intended
for an ICON value, the corresponding CHDATA entry must be either
defaulted or specified as either '$$' or ' '; the character ICON is set to
'$$' (input; blank by default).
Integer NCON number of CONs required by the model (input; no default allowed).
Real RDATA (NCON) CON data (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 machine model connection tables full--use
pack plant model tables function
IERR = 2 plant model tables are corrupt
IERR = 3 unlicensed GMB model
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1642
Dynamics Simulation GMB_ADD_PLANT_MODEL
IERR = 4 error reading GMB model
IERR = 5 GMB model is not a plant type model
IERR = 6 # CONs specified is not the number expected
IERR = 7 # ICONs specified is not the number expected
IERR = 8 second machine not found where one is re-
quired
IERR = 9 same machine specified as the first and sec-
ond machines
IERR = 10 maximum number of array elements exceed-
ed
IERR = 11 number of user-defined models exceeds max-
imum allowed
IERR = 12 bus not found
IERR = 13 machine not found
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
1643
Dynamics Simulation PLMOD_CONSISTENCY
7.3.8. PLMOD_CONSISTENCY
Use this API to check consistency among the plant related models referenced at each machine.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PLMOD_CONSISTENCY
Python command syntax:
ierr = plmod_consistency()
Fortran command syntax:
CALL PLMOD_CONSISTENCY(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error
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
1644
Dynamics Simulation PLMOD_PACK
7.3.9. PLMOD_PACK
Use this API to remove entries that are marked as unused from the plant model connection tables and the
plant model array allocation tables. It packs the entries remaining in these tables at the front of the various
arrays.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PLMOD_PACK
Python command syntax:
ierr = plmod_pack()
Fortran command syntax:
CALL PLMOD_PACK(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error
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
1645
Dynamics Simulation PLMOD_REMOVE
7.3.10. PLMOD_REMOVE
Use this API to remove a plant related model of a designated type from a specified machine.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PLMOD_REMOVE IBUS 'ID' MTYPE
Python command syntax:
ierr = plmod_remove(ibus, id, mtype)
Fortran command syntax:
CALL PLMOD_REMOVE(IBUS, ID, MTYPE, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Integer MTYPE model type (input; 1 by default).
MTYPE = 1 generator model
MTYPE = 2 compensator model
MTYPE = 3 stabilizer model
MTYPE = 4 minimum excitation limiter model
MTYPE = 5 maximum excitation limiter model
MTYPE = 6 excitation system model
MTYPE = 7 turbine-governor model
MTYPE = 8 turbine-load controller model.
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid MTYPE value
IERR = 2 no model of type MTYPE at this machine
IERR = 3 bus not found
IERR = 4 machine not found
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
1646
Dynamics Simulation PLMOD_STATUS
7.3.11. PLMOD_STATUS
Use this API to change the status of a plant related model of a designated type at a specified machine.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PLMOD_STATUS IBUS 'ID' MTYPE STATUS
Python command syntax:
ierr = plmod_status(ibus, id, mtype, status)
Fortran command syntax:
CALL PLMOD_STATUS(IBUS, ID, MTYPE, STATUS, IERR)
Where:
Integer IBUS plant bus number (input; no default allowed).
Character*2 ID machine identifier (input; blank by default).
Integer MTYPE model type (input; 1 by default).
MTYPE = 1 generator model
MTYPE = 2 compensator model
MTYPE = 3 stabilizer model
MTYPE = 4 minimum excitation limiter model
MTYPE = 5 maximum excitation limiter model
MTYPE = 6 excitation system model
MTYPE = 7 turbine-governor model
MTYPE = 8 turbine-load controller model.
Integer STATUS new model status (input; 1 by default).
STATUS = 0 out-of-service
STATUS = 1 in-service
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid MTYPE value
IERR = 2 no model of type MTYPE at this machine
IERR = 3 invalid STATUS value
IERR = 4 bus not found
IERR = 5 machine not found
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
1647
Dynamics Simulation PLMOD_UNCONNECTED
7.3.12. PLMOD_UNCONNECTED
Use this API to list or remove from dynamics working memory those plant related models that are assigned
to machines that are not present in the current power flow working case (unconnected).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PLMOD_UNCONNECTED OPT
Python command syntax:
ierr = plmod_unconnected(opt)
Fortran command syntax:
CALL PLMOD_UNCONNECTED(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list unconnected plant models
OPT = 1 remove unconnected plant models
Integer IERR error code (output).
IERR = 0 no error
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
1648
Dynamics Simulation PLMOD_USER
7.3.13. PLMOD_USER
Use this API to list user-written plant model definitions or to remove user-written plant model definitions
that are not assigned to any machines (unused) from the user model definition tables.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_PLMOD_USER OPT
Python command syntax:
ierr = plmod_user(opt)
Fortran command syntax:
CALL PLMOD_USER(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list user-written plant model definitions
OPT = 1 remove unused user-written plant model def-
initions
Integer IERR error code (output).
IERR = 0 no error
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
1649
Dynamics Simulation PLMOD_USER
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1650
Dynamics Simulation Wind Related Models
7.4. Wind Related Models
7.4.1. ADD_WIND_MODEL
Use this API to add a renewable related model of a designated type to a specified renewable machine. If a
model of the designated type already exists at the machine, it is replaced.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_ADD_WIND_MODEL IBUS 'ID' MTYPE 'NAME' NICN IDATA CHDATA NCON
RDATA
Python command syntax:
ierr = add_wind_model(ibus, id, mtype, name, nicn, idata, chdata, ncon,
rdata)
Fortran command syntax:
CALL ADD_WIND_MODEL(IBUS, ID, MTYPE, NAME, NICN, IDATA, CHDATA, NCON,
RDATA, IERR)
Where:
Integer IBUS renewable machine bus number (input; no default allowed).
Character*2 ID renewable machine identifier (input; blank by default).
Integer MTYPE model type (input; 1 by default).MTYPE = 1 wind generator model).
MTYPE = 2 renewable electrical control model
MTYPE = 3 renewable mechanical system model
MTYPE = 4 renewable pitch control model
MTYPE = 5 renewable aerodynamic model
MTYPE = 6 renewable gust model
MTYPE = 7 renewable auxiliary control model
Character*16 NAME model name (input; no default allowed).
Integer NICN number of ICONs required by the model (input; no default allowed).
Integer IDATA (NICN) ICON data (input; 0 by default). When a character value is intended
for an ICON value, the corresponding IDATA entry is ignored and the
integer ICON is set to 0).
Character*12 CHDATA (NICN) character ICON data (no default allowed for an ICON for which a
character value is to be specified). When an integer value is intended
for an ICON value, the corresponding CHDATA entry must be either
defaulted or specified as either '$$' or ' '; the character ICON is set to
'$$' (input; blank by default).
Integer NCON number of CONs required by the model (input; no default allowed).
Real RDATA (NCON) CON data (input; 0.0).
Integer IERR error code (output).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1651
Dynamics Simulation ADD_WIND_MODEL
IERR = 0 no error
IERR = 1 renewable machine model connection tables
full--use pack renewable model tables func-
tion
IERR = 2 renewable model tables are corrupt
IERR = 3 invalid MTYPE value
IERR = 4 unknown model NAME
IERR = 5 model is not consistent with MTYPE
IERR = 6 # CONs specified is not the number expected
IERR = 7 # ICONs specified is not the number expected
IERR = 8 maximum number of array elements exceed-
ed
IERR = 9 machine is not designated as a renewable
machine in power flow
IERR = 10 bus not found
IERR = 11 machine not found
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
1652
Dynamics Simulation CHANGE_WNMOD_CHRICN
7.4.2. CHANGE_WNMOD_CHRICN
Use this API to change the value of a character ICON (i.e., an element of the CHRICN array) of a designated
renewable related model at a specified renewable machine. The corresponding integer ICON is set to 0.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_CHANGE_WNMOD_CHRICN IBUS 'ID' 'NAME' J 'CHDATA'
Python command syntax:
ierr = change_wnmod_chricn(ibus, id, name, j, chdata)
Fortran command syntax:
CALL CHANGE_WNMOD_CHRICN(IBUS, ID, NAME, J, CHDATA, IERR)
Where:
Integer IBUS renewable machine bus number (input; no default allowed).
Character*2 ID renewable machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Character*12 CHDATA new character ICON value (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a renewable machine
model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no input ICONs used in model NAME
IERR = 6 ICON number outside of the ICON range of
this model
IERR = 7 machine is not designated as a renewable
machine in power flow
IERR = 8 bus not found
IERR = 9 machine not found
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
1653
Dynamics Simulation CHANGE_WNMOD_CON
7.4.3. CHANGE_WNMOD_CON
Use this API to change the value of a CON of a designated renewable machine related model at a specified
renewable machine.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_CHANGE_WNMOD_CON IBUS 'ID' 'NAME' J RDATA
Python command syntax:
ierr = change_wnmod_con(ibus, id, name, j, rdata)
Fortran command syntax:
CALL CHANGE_WNMOD_CON(IBUS, ID, NAME, J, RDATA, IERR)
Where:
Integer IBUS renewable machine bus number (input; no default allowed).
Character*2 ID renewable machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J CON number to change relative to the start of the block of CONs as-
signed to this model (1 for CON(J), 2 for CON(J+1), etc.) (input; no
default allowed).
Real RDATA new CON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a renewable machine
model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no input CONs used in model NAME
IERR = 6 CON number outside of the CON range of this
model
IERR = 7 machine is not designated as a renewable
machine in power flow
IERR = 8 bus not found
IERR = 9 machine not found
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
1654
Dynamics Simulation CHANGE_WNMOD_ICON
7.4.4. CHANGE_WNMOD_ICON
Use this API to change the value of an integer ICON of a designated renewable machine related model at a
specified renewable machine. The corresponding character CHRICN is set to '$$'.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_CHANGE_WNMOD_ICON IBUS 'ID' 'NAME' J IDATA
Python command syntax:
ierr = change_wnmod_icon(ibus, id, name, j, idata)
Fortran command syntax:
CALL CHANGE_WNMOD_ICON(IBUS, ID, NAME, J, IDATA, IERR)
Where:
Integer IBUS renewable machine bus number (input; no default allowed).
Character*2 ID renewable machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Integer IDATA new integer ICON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a renewable machine
model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no input ICONs used in model NAME
IERR = 6 ICON number outside of the ICON range of
this model
IERR = 7 machine is not designated as a renewable
machine in power flow
IERR = 8 bus not found
IERR = 9 machine not found
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
1655
Dynamics Simulation CHANGE_WNMOD_VAR
7.4.5. CHANGE_WNMOD_VAR
Use this API to change the value of a VAR of a designated renewable machine related model at a specified
renewable machine.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_CHANGE_WNMOD_VAR IBUS 'ID' 'NAME' J RDATA
Python command syntax:
ierr = change_wnmod_var(ibus, id, name, j, rdata)
Fortran command syntax:
CALL CHANGE_WNMOD_VAR(IBUS, ID, NAME, J, RDATA, IERR)
Where:
Integer IBUS renewable machine bus number (input; no default allowed).
Character*2 ID renewable machine identifier (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J VAR number to change relative to the start of the block of VARs as-
signed to this model (1 for VAR(J), 2 for VAR(J+1), etc.) (input; no de-
fault allowed).
Real RDATA new VAR value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a renewable machine
model
IERR = 3 no <model type> model at this machine
IERR = 4 the <model type> model at this machine is
aaa not NAME
IERR = 5 no input VARs used in model NAME
IERR = 6 VAR number outside of the VAR range of this
model
IERR = 7 machine is not designated as a renewable
machine in power flow
IERR = 8 bus not found
IERR = 9 machine not found
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
1656
Dynamics Simulation WNMOD_CONSISTENCY
7.4.6. WNMOD_CONSISTENCY
Use this API to check consistency among the renewable machine related models referenced at each ma-
chine.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_WNMOD_CONSISTENCY
Python command syntax:
ierr = wnmod_consistency()
Fortran command syntax:
CALL WNMOD_CONSISTENCY(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error
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
1657
Dynamics Simulation WNMOD_PACK
7.4.7. WNMOD_PACK
Use this API to remove entries that are marked as unused from the wind model connection tables and the
renewable machine model array allocation tables. It packs the entries remaining in these tables at the front
of the various arrays.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_WNMOD_PACK
Python command syntax:
ierr = wnmod_pack()
Fortran command syntax:
CALL WNMOD_PACK(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error
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
1658
Dynamics Simulation WNMOD_REMOVE
7.4.8. WNMOD_REMOVE
Use this API to remove a renewable machine related model of a designated type from a specified renew-
able machine.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_WNMOD_REMOVE IBUS 'ID' MTYPE
Python command syntax:
ierr = wnmod_remove(ibus, id, mtype)
Fortran command syntax:
CALL WNMOD_REMOVE(IBUS, ID, MTYPE, IERR)
Where:
Integer IBUS renewable machine bus number (input; no default allowed).
Character*2 ID renewable machine identifier (input; blank by default).
Integer MTYPE model type (input; 1 by default).
MTYPE = 1 renewable generator model
MTYPE = 2 renewable electrical control model
MTYPE = 3 renewable mechanical system model
MTYPE = 4 renewable pitch control model
MTYPE = 5 renewable aerodynamic model
MTYPE = 6 renewable gust model
MTYPE = 7 renewable auxiliary control model
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid MTYPE value
IERR = 2 no model of type MTYPE at this machine
IERR = 3 machine is not designated as a renewable
machine in power flow
IERR = 4 bus not found
IERR = 5 machine not found
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
1659
Dynamics Simulation WNMOD_STATUS
7.4.9. WNMOD_STATUS
Use this API to change the status of a renewable machine related model of a designated type at a specified
renewable machine.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_WNMOD_STATUS IBUS 'ID' MTYPE STATUS
Python command syntax:
ierr = wnmod_status(ibus, id, mtype, status)
Fortran command syntax:
CALL WNMOD_STATUS(IBUS, ID, MTYPE, STATUS, IERR)
Where:
Integer IBUS renewable machine bus number (input; no default allowed).
Character*2 ID renewable machine identifier (input; blank by default).
Integer MTYPE model type (input; 1 by default).
MTYPE = 1 renewable generator model
MTYPE = 2 renewable electrical control model
MTYPE = 3 renewable mechanical system model
MTYPE = 4 renewable pitch control model
MTYPE = 5 renewable aerodynamic model
MTYPE = 6 renewable gust model
MTYPE = 7 renewable auxiliary control model
Integer STATUS new model status (input; 1 by default).
STATUS = 0 out-of-service
STATUS = 1 in-service
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid MTYPE value
IERR = 2 no model of type MTYPE at this machine
IERR = 3 invalid STATUS value
IERR = 4 machine is not designated as a renewable
machine in power flow
IERR = 5 bus not found
IERR = 6 machine not found
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
1660
Dynamics Simulation WNMOD_UNCONNECTED
7.4.10. WNMOD_UNCONNECTED
Use this API to list or remove from dynamics working memory those renewable machine related models
that are assigned to renewable machines that are not present in the current power flow working case (un-
connected).
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_WNMOD_UNCONNECTED OPT
Python command syntax:
ierr = wnmod_unconnected(opt)
Fortran command syntax:
CALL WNMOD_UNCONNECTED(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list unconnected renewable machine models
OPT = 1 remove unconnected renewable machine
models
Integer IERR error code (output).
IERR = 0 no error
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
1661
Dynamics Simulation WNMOD_USER
7.4.11. WNMOD_USER
Use this API to list user-written renewable machine model definitions or to remove user-written renewable
machine model definitions that are not assigned to any renewable machines (unused) from the user model
definition tables.
This API routine was first introduced in release 31.0.0.
Batch command syntax:
BAT_WNMOD_USER OPT
Python command syntax:
ierr = wnmod_user(opt)
Fortran command syntax:
CALL WNMOD_USER(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list user-written renewable machine model
definitions
OPT = 1 remove unused user-written renewable ma-
chine model definitions
Integer IERR error code (output).
IERR = 0 no error
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
1662
Dynamics Simulation WNMOD_USER
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1663
Dynamics Simulation Load Related Models
7.5. Load Related Models
7.5.1. ADD_LOAD_MODEL
Use this API to add a load related model of a designated type to a specified load or subsystem. If a model of
the designated type already exists at the load or subsystem, it is replaced.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ADD_LOAD_MODEL IBUS 'ID' MTYPE LTYPE 'NAME' NICN IDATA CHDATA
NCON RDATA
Python command syntax:
ierr = add_load_model(ibus, id, mtype, ltype, name, nicn, idata, chdata,
ncon, rdata)
Fortran command syntax:
CALL ADD_LOAD_MODEL(IBUS, ID, MTYPE, LTYPE, NAME, NICN, IDATA, CHDATA,
NCON, RDATA, IERR)
Where:
Integer IBUS bus, owner, zone or area number. Ignored when MTYPE is 4 (when
MTYPE is less than 4) (input; no default allowed).
Character*2 ID load identifier, or "*" to apply the model to all loads in the subsystem
(input; blank by default).
Integer MTYPE subsystem type (input; 0 by default).
MTYPE = 0 bus model
MTYPE = 1 owner model
MTYPE = 2 zone model
MTYPE = 3 area model
MTYPE = 4 all model
Integer LTYPE load model type (input; 1 by default).
LTYPE = 1 load characteristic model
LTYPE = 2 load relay model
Character*16 NAME model name (input; no default allowed).
Integer NICN number of ICONs required by the model (input; no default allowed).
Integer IDATA (NICN) ICON data (input; 0 by default). When a character value is intended
for an ICON value, the corresponding IDATA entry is ignored and the
integer ICON is set to 0).
Character*12 CHDATA (NICN) character ICON data (no default allowed for an ICON for which a
character value is to be specified). When an integer value is intended
for an ICON value, the corresponding CHDATA entry must be either
defaulted or specified as either '$$' or ' '; the character ICON is set to
'$$' (input; blank by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1664
Dynamics Simulation ADD_LOAD_MODEL
Integer NCON number of CONs required by the model (input; no default allowed).
Real RDATA (NCON) CON data (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 load model connection tables full--use pack
load model tables function
IERR = 2 invalid MTYPE value
IERR = 3 invalid LTYPE value
IERR = 4 unknown model NAME
IERR = 5 model is not consistent with LTYPE
IERR = 6 model is not consistent with MTYPE
IERR = 7 # CONs specified is not the number expected
IERR = 8 # ICONs specified is not the number expected
IERR = 9 maximum number of array elements exceed-
ed
IERR = 10 type MTYPE load model table is full
IERR = 11 no loads with the specified load identifier
IERR = 12 invalid area/owner/zone number
IERR = 13 no loads with the specified load identifier for
specified subsystem
IERR = 14 no loads at bus
IERR = 15 bus not found
IERR = 16 load not found
IERR = 17 prerequisite requirements for API are not met
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1665
Dynamics Simulation CHANGE_LDMOD_CHRICN
7.5.2. CHANGE_LDMOD_CHRICN
Use this API to change the value of a character ICON (i.e., an element of the CHRICN array) of a load related
model at a specified load or subsystem. The corresponding integer ICON is set to 0.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_LDMOD_CHRICN IBUS 'ID' 'NAME' J 'CHDATA'
Python command syntax:
ierr = change_ldmod_chricn(ibus, id, name, j, chdata)
Fortran command syntax:
CALL CHANGE_LDMOD_CHRICN(IBUS, ID, NAME, J, CHDATA, IERR)
Where:
Integer IBUS bus, owner, zone or area number. Ignored when an all type load
model is specified (unless an all type load model is specified) (input;
no default allowed).
Character*2 ID load identifier, or "*" if the model is applied to all loads in the subsys-
tem (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Character*12 CHDATA new character ICON value (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a load-related model
IERR = 3 no <subsystem type> type <load type> model
for this id in tables for <subsystem type> IBUS
IERR = 4 no all type <load type> model for this id in ta-
bles
IERR = 5 <subsystem type> <load type> model for this
id for <subsystem type> IBUS is aaa not xxx
IERR = 6 all type <load type> model for this id is aaa
not xxx
IERR = 7 no input ICONs used in model NAME
IERR = 8 ICON number outside of the ICON range of
this model
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
1666
Dynamics Simulation CHANGE_LDMOD_CON
7.5.3. CHANGE_LDMOD_CON
Use this API to change the value of a CON of a load related model at a specified load or subsystem.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_LDMOD_CON IBUS 'ID' 'NAME' J RDATA
Python command syntax:
ierr = change_ldmod_con(ibus, id, name, j, rdata)
Fortran command syntax:
CALL CHANGE_LDMOD_CON(IBUS, ID, NAME, J, RDATA, IERR)
Where:
Integer IBUS bus, owner, zone or area number. Ignored when an all type load
model is specified (unless an all type load model is specified) (input;
no default allowed).
Character*2 ID load identifier, or "*" if the model is applied to all loads in the subsys-
tem (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J CON number to change relative to the start of the block of CONs as-
signed to this model (1 for CON(J), 2 for CON(J+1), etc.) (input; no
default allowed).
Real RDATA new CON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a load-related model
IERR = 3 no <subsystem type> type <load type> model
for this id in tables for <subsystem type> IBUS
IERR = 4 no all type <load type> model for this id in ta-
bles
IERR = 5 <subsystem type> <load type> model for this
id for <subsystem type> IBUS is aaa not xxx
IERR = 6 all type <load type> model for this id is aaa
not xxx
IERR = 7 no CONs used in model NAME
IERR = 8 CON number outside of the CON range of this
model
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
1667
Dynamics Simulation CHANGE_LDMOD_DATA
7.5.4. CHANGE_LDMOD_DATA
This API routine is obsolete. It has been replaced by the API routines CHANGE_LDMOD_CON,
CHANGE_LDMOD_ICON, and CHANGE_LDMOD_CHRICN .
Use this API to change the value of an ICON and/or CON of a load related model of a designated type at a
specified load or subsystem.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CHANGE_LDMOD_DATA IBUS 'ID' MTYPE LTYPE 'NAME' J RDATA I
IDATA 'CHDATA'
Python command syntax:
ierr = change_ldmod_data(ibus,id,mtype,ltype,name,j,rdata,i,idata,chdata)
Fortran command syntax:
CALL CHANGE_LDMOD_DATA(IBUS, ID, MTYPE, LTYPE, NAME, J, RDATA, I, IDATA,
CHDATA, IERR)
Where:
Integer IBUS bus, owner, zone or area number. Ignored when MTYPE is 4 (when
MTYPE is less than 4) (input; no default allowed).
Character*2 ID load identifier, or "*" if the model is applied to all loads in the subsys-
tem (input; blank by default).
Integer MTYPE subsystem type (input; 0 by default).
MTYPE = 0 bus model
MTYPE = 1 owner model
MTYPE = 2 zone model
MTYPE = 3 area model
MTYPE = 4 all model
Integer LTYPE load model type (input; 1 by default).
LTYPE = 1 load characteristic model
LTYPE = 2 load relay model
Character*16 NAME model name (input; no default allowed).
Integer J CON number to change relative to the start of the block of CONs as-
signed to this model, or 0 for no CON change (1 for CON(J), 2 for
CON(J+1), etc.) (input; 0 by default).
Real RDATA new CON value (input; unchanged).
Integer I ICON number to change relative to the start of the block of ICONs as-
signed to this model, or 0 for no ICON change (1 for ICON(I), 2 for
ICON(I+1), etc.) (input; 0 by default).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1668
Dynamics Simulation CHANGE_LDMOD_DATA
Integer IDATA new integer ICON value (input; unchanged by default). When a char-
acter value is intended for an ICON value, the IDATA entry is ignored
and the integer ICON is set to 0).
Character*12 CHDATA new character ICON value (no default allowed if the character ICON is
to be changed). When an integer value is intended for an ICON value,
the CHDATA entry must be either defaulted or specified as either '$$'
or ' '; the character ICON is set to '$$' (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid MTYPE value
IERR = 2 invalid LTYPE value
IERR = 3 unknown model NAME
IERR = 4 no all type LTYPE model for this id in tables
IERR = 5 no STYPE type LTYPE model for this id in ta-
bles for MTYPE IBUS
IERR = 6 all type LTYPE model for this id is aaa not xxx
IERR = 7 MTYPE type LTYPE model for this id for
MTYPE IBUS is aaa not xxx
IERR = 8 CON number exceeds the number of CONs
used by the model
IERR = 9 ICON number exceeds the number of input
ICONs used by the model
IERR = 10 neither the CON nor ICON number is positive
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
1669
Dynamics Simulation CHANGE_LDMOD_ICON
7.5.5. CHANGE_LDMOD_ICON
Use this API to change the value of an integer ICON of a load related model at a specified load or subsys-
tem. The corresponding character CHRICN is set to '$$'.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_LDMOD_ICON IBUS 'ID' 'NAME' J IDATA
Python command syntax:
ierr = change_ldmod_icon(ibus, id, name, j, idata)
Fortran command syntax:
CALL CHANGE_LDMOD_ICON(IBUS, ID, NAME, J, IDATA, IERR)
Where:
Integer IBUS bus, owner, zone or area number. Ignored when an all type load
model is specified (unless an all type load model is specified) (input;
no default allowed).
Character*2 ID load identifier, or "*" if the model is applied to all loads in the subsys-
tem (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Integer IDATA new integer ICON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a load-related model
IERR = 3 no <subsystem type> type <load type> model
for this id in tables for <subsystem type> IBUS
IERR = 4 no all type <load type> model for this id in ta-
bles
IERR = 5 <subsystem type> <load type> model for this
id for <subsystem type> IBUS is aaa not xxx
IERR = 6 all type <load type> model for this id is aaa
not xxx
IERR = 7 no input ICONs used in model NAME
IERR = 8 ICON number outside of the ICON range of
this model
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
1670
Dynamics Simulation CHANGE_LDMOD_VAR
7.5.6. CHANGE_LDMOD_VAR
Use this API to change the value of a VAR of a load related model at a specified load or subsystem.
This API can be used only for bus based load models. It cannot be used for changing VARs of owner, zone,
area, and "all" type load models.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_CHANGE_LDMOD_VAR IBUS 'ID' 'NAME' J RDATA
Python command syntax:
ierr = change_ldmod_var(ibus, id, name, j, rdata)
Fortran command syntax:
CALL CHANGE_LDMOD_VAR(IBUS, ID, NAME, J, RDATA, IERR)
Where:
Integer IBUS load bus number (input).
Character*2 ID load identifier, or "*" if the model is applied to all loads in the subsys-
tem (input; blank by default).
Character*16 NAME model name (input; no default allowed).
Integer J VAR number to change relative to the start of the block of VARs as-
signed to this model (1 for VAR(J), 2 for VAR(J+1), etc.) (input; no de-
fault allowed).
Real RDATA new VAR value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 unknown model NAME
IERR = 2 model NAME is not a load-related model
IERR = 3 no <subsystem type> type <load type> model
for this id in tables for <subsystem type> IBUS
IERR = 4 no "all" type <load type> model for this id in
tables
IERR = 5 <subsystem type> <load type> model for this
id for <subsystem type> IBUS is aaa not xxx
IERR = 6 "all" type <load type> model for this id is aaa
not xxx
IERR = 7 no VARs used in model NAME
IERR = 8 VAR number outside of the VAR range of this
model
IERR = 9 VARs of only bus based (load type) models
can be changed using this API
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
1671
Dynamics Simulation LDMOD_PACK
7.5.7. LDMOD_PACK
Use this API to remove entries that are marked as unused from the load model connection tables and the
load model array allocation tables. It packs the entries remaining in these tables at the front of the various
arrays.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LDMOD_PACK
Python command syntax:
ierr = ldmod_pack()
Fortran command syntax:
CALL LDMOD_PACK(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error
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
1672
Dynamics Simulation LDMOD_REMOVE
7.5.8. LDMOD_REMOVE
Use this API to remove a load related model of a designated type from a specified load or subsystem.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LDMOD_REMOVE MTYPE IBUS 'ID' LTYPE
Python command syntax:
ierr = ldmod_remove(mtype, ibus, id, ltype)
Fortran command syntax:
CALL LDMOD_REMOVE(MTYPE, IBUS, ID, LTYPE, IERR)
Where:
Integer MTYPE subsystem type (input; 0 by default).
MTYPE = 0 bus model.
MTYPE = 1 owner model.
MTYPE = 2 zone model.
MTYPE = 3 area model.
MTYPE = 4 all model.
Integer IBUS bus, owner, zone or area number. Ignored when MTYPE is 4 (when
MTYPE is less than 4) (input; no default allowed).
Character*2 ID load identifier, or "*" if the model is applied to all loads in the subsys-
tem (input; blank by default).
Integer LTYPE load model type (input; 1 by default).
LTYPE = 1 load characteristic model
LTYPE = 2 load relay model
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid number specified for IBUS
IERR = 2 invalid LTYPE value
IERR = 3 invalid MTYPE value
IERR = 4 no all type LTYPE model for this id in tables
IERR = 5 no MTYPE type LTYPE model for this id in ta-
bles for MTYPE IBUS
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
1673
Dynamics Simulation LDMOD_STATUS
7.5.9. LDMOD_STATUS
Use this API to change the status of a load related model of a designated type for all subsystem loads at
which it is applied.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LDMOD_STATUS MTYPE IBUS 'ID' LTYPE STATUS
Python command syntax:
ierr = ldmod_status(mtype, ibus, id, ltype, status)
Fortran command syntax:
CALL LDMOD_STATUS(MTYPE, IBUS, ID, LTYPE, STATUS, IERR)
Where:
Integer MTYPE subsystem type (input; 0 by default).
MTYPE = 0 bus model
MTYPE = 1 owner model
MTYPE = 2 zone model
MTYPE = 3 area model
MTYPE = 4 all model
Integer IBUS bus, owner, zone or area number. Ignored when MTYPE is 4 (when
MTYPE is less than 4) (input; no default allowed).
Character*2 ID load identifier, or "*" if the model is applied to all loads in the subsys-
tem (input; blank by default).
Integer LTYPE load model type (input; 1 by default).
LTYPE = 1 load characteristic model
LTYPE = 2 load relay model
Integer STATUS new model status (input; 1 by default).
STATUS = 0 out-of-service
STATUS = 1 in-service
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid number specified for IBUS
IERR = 2 invalid LTYPE value
IERR = 3 invalid MTYPE value
IERR = 4 no all type LTYPE model for this id in tables
IERR = 5 no MTYPE type LTYPE model for this id in ta-
bles for MTYPE IBUS
IERR = 6 invalid STATUS value
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
1674
Dynamics Simulation LDMOD_STATUS2
7.5.10. LDMOD_STATUS2
Use this API to change the status of a load related model of a designated type at a specified load.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LDMOD_STATUS2 IBUS 'ID' LTYPE STATUS
Python command syntax:
ierr = ldmod_status2(ibus, id, ltype, status)
Fortran command syntax:
CALL LDMOD_STATUS2(IBUS, ID, LTYPE, STATUS, IERR)
Where:
Integer IBUS load bus number (input; no default allowed).
Character*2 ID load identifier (input; '1' by default).
Integer LTYPE load model type (input; 1 by default).
LTYPE = 1 load characteristic model
LTYPE = 2 load relay model
Integer STATUS new model status (input; 1 by default).
STATUS = 0 out-of-service
STATUS = 1 in-service
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid LTYPE value
IERR = 2 invalid STATUS value
IERR = 3 no LTYPE model at this load
IERR = 4 bus not found
IERR = 5 load not found
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
1675
Dynamics Simulation LDMOD_UNCONNECTED
7.5.11. LDMOD_UNCONNECTED
Use this API to list or remove from dynamics working memory those load related models that are assigned
to loads that are not present in the current power flow working case (unconnected).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LDMOD_UNCONNECTED OPT
Python command syntax:
ierr = ldmod_unconnected(opt)
Fortran command syntax:
CALL LDMOD_UNCONNECTED(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list unconnected load models
OPT = 1 remove unconnected load models
Integer IERR error code (output).
IERR = 0 no error
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
1676
Dynamics Simulation LDMOD_USER
7.5.12. LDMOD_USER
Use this API to list user-written load model definitions or to remove user-written load model definitions
that are not assigned to any loads (unused) from the user model definition tables.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_LDMOD_USER OPT
Python command syntax:
ierr = ldmod_user(opt)
Fortran command syntax:
CALL LDMOD_USER(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list user-written load model definitions
OPT = 1 remove unused user-written load model defi-
nitions
Integer IERR error code (output).
IERR = 0 no error
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
1677
Dynamics Simulation LDMOD_USER
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1678
Dynamics Simulation Line Relay Models
7.6. Line Relay Models
7.6.1. ADD_RELAY_MODEL
Use this API to add a line relay model in the designated relay slot of the from bus end of a specified branch.
If a model already exists in the designated relay slot at the from bus end of the branch, it is replaced.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_ADD_RELAY_MODEL IBUS JBUS 'ID' RS 'NAME' NICN IDATA CHDATA
NCON RDATA
Python command syntax:
ierr = add_relay_model(ibus,jbus,id,rs,name,nicn,idata,chdata,ncon,rdata)
Fortran command syntax:
CALL ADD_RELAY_MODEL(IBUS, JBUS, ID, RS, NAME, NICN, IDATA, CHDATA, NCON,
RDATA, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; blank by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Character*16 NAME model name (input; no default allowed).
Integer NICN number of ICONs required by the model (input; no default allowed).
Integer IDATA (NICN) ICON data (input; 0 by default). When a character value is intended
for an ICON value, the corresponding IDATA entry is ignored and the
integer ICON is set to 0).
Character*12 CHDATA (NICN) character ICON data (no default allowed for an ICON for which a
character value is to be specified). When an integer value is intended
for an ICON value, the corresponding CHDATA entry must be either
defaulted or specified as either '$$' or ' '; the character ICON is set to
'$$' (input; blank by default).
Integer NCON number of CONs required by the model (input; no default allowed).
Real RDATA (NCON) CON data (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
IERR = 2 unknown model NAME
IERR = 3 model is not a line relay model
IERR = 4 # CONs specified is not the number expected
IERR = 5 # ICONs specified is not the number expected
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1679
Dynamics Simulation ADD_RELAY_MODEL
IERR = 6 maximum number of array elements exceed-
ed
IERR = 7 line relay model connection tables full--use
pack line relay model tables function
IERR = 8 line relay model tables are corrupt
IERR = 9 bus not found
IERR = 10 branch not found
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
1680
Dynamics Simulation CHANGE_RLMOD_CHRICN
7.6.2. CHANGE_RLMOD_CHRICN
Use this API to change the value of a character ICON (i.e., an element of the CHRICN array) of the line re-
lay model in the designated relay slot of the from bus end of a specified branch. The corresponding integer
ICON is set to 0.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_RLMOD_CHRICN IBUS JBUS 'ID' RS 'NAME' J 'CHDATA'
Python command syntax:
ierr = change_rlmod_chricn(ibus, jbus, id, rs, name, j, chdata)
Fortran command syntax:
CALL CHANGE_RLMOD_CHRICN(IBUS,JBUS,ID,RS,NAME,J,CHDATA,IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; blank by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Character*12 CHDATA new character ICON value (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
IERR = 2 unknown model NAME
IERR = 3 no relay model on this branch at the bus IBUS
end
IERR = 4 relay model at bus IBUS end is aaa not xxx
IERR = 5 no input ICONs used in model NAME
IERR = 6 ICON number outside of the ICON range of
this model
IERR = 7 bus not found
IERR = 8 branch not found
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
1681
Dynamics Simulation CHANGE_RLMOD_CON
7.6.3. CHANGE_RLMOD_CON
Use this API to change the value of a CON of the line relay model in the designated relay slot of the from
bus end of a specified branch.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_RLMOD_CON IBUS JBUS 'ID' RS 'NAME' J RDATA
Python command syntax:
ierr = change_rlmod_con(ibus, jbus, id, rs, name, j, rdata)
Fortran command syntax:
CALL CHANGE_RLMOD_CON(IBUS, JBUS, ID, RS, NAME, J, RDATA, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; blank by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Character*16 NAME model name (input; no default allowed).
Integer J CON number to change relative to the start of the block of CONs as-
signed to this model (1 for CON(J), 2 for CON(J+1), etc.) (input; no
default allowed).
Real RDATA new CON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
IERR = 2 unknown model NAME
IERR = 3 no relay model on this branch at the bus IBUS
end
IERR = 4 relay model at bus IBUS end is aaa not xxx
IERR = 5 no CONs used in model NAME
IERR = 6 CON number outside of the CON range of this
model
IERR = 7 bus not found
IERR = 8 branch not found
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
1682
Dynamics Simulation CHANGE_RLMOD_DATA
7.6.4. CHANGE_RLMOD_DATA
This API routine is obsolete. It has been replaced by the API routines CHANGE_RLMOD_CON,
CHANGE_RLMOD_ICON, and CHANGE_RLMOD_CHRICN .
Use this API to change the value of an ICON and/or CON of the line relay model in the designated relay slot
of the from bus end of a specified branch.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_CHANGE_RLMOD_DATA IBUS JBUS 'ID' RS 'NAME' J RDATA I IDATA
'CHDATA'
Python command syntax:
ierr = change_rlmod_data(ibus,jbus,id,rs,name,j,rdata,i,idata,chdata)
Fortran command syntax:
CALL CHANGE_RLMOD_DATA(IBUS, JBUS, ID, RS, NAME, J, RDATA, I, IDATA,
CHDATA, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; blank by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Character*16 NAME model name (input; no default allowed).
Integer J CON number to change relative to the start of the block of CONs as-
signed to this model, or 0 for no CON change (1 for CON(J), 2 for
CON(J+1), etc.) (input; 0 by default).
Real RDATA new CON value (input; unchanged).
Integer I ICON number to change relative to the start of the block of ICONs as-
signed to this model, or 0 for no ICON change (1 for ICON(I), 2 for
ICON(I+1), etc.) (input; 0 by default).
Integer IDATA new integer ICON value (input; unchanged by default). When a char-
acter value is intended for an ICON value, the IDATA entry is ignored
and the integer ICON is set to 0).
Character*12 CHDATA new character ICON value (no default allowed if the character ICON is
to be changed). When an integer value is intended for an ICON value,
the CHDATA entry must be either defaulted or specified as either '$$'
or ' '; the character ICON is set to '$$' (input; blank by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1683
Dynamics Simulation CHANGE_RLMOD_DATA
IERR = 2 unknown model NAME
IERR = 3 no relay model on this branch at the bus IBUS
end
IERR = 4 relay model at bus IBUS end is aaa not xxx
IERR = 5 CON number exceeds the number of CONs
used by the model
IERR = 6 ICON number exceeds the number of ICONs
used by the model
IERR = 7 neither the CON nor ICON number is positive
IERR = 8 bus not found
IERR = 9 branch not found
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
1684
Dynamics Simulation CHANGE_RLMOD_ICON
7.6.5. CHANGE_RLMOD_ICON
Use this API to change the value of an integer ICON of the line relay model in the designated relay slot of
the from bus end of a specified branch. The corresponding character CHRICN is set to '$$'.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_CHANGE_RLMOD_ICON IBUS JBUS 'ID' RS 'NAME' J IDATA
Python command syntax:
ierr = change_rlmod_icon(ibus, jbus, id, rs, name, j, idata)
Fortran command syntax:
CALL CHANGE_RLMOD_ICON(IBUS, JBUS, ID, RS, NAME, J, IDATA, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; blank by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Character*16 NAME model name (input; no default allowed).
Integer J ICON number to change relative to the start of the block of ICONs as-
signed to this model (1 for ICON(I), 2 for ICON(I+1), etc.) (input; no
default allowed).
Integer IDATA new integer ICON value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
IERR = 2 unknown model NAME
IERR = 3 no relay model on this branch at the bus IBUS
end
IERR = 4 relay model at bus IBUS end is aaa not xxx
IERR = 5 no input ICONs used in model NAME
IERR = 6 ICON number outside of the ICON range of
this model
IERR = 7 bus not found
IERR = 8 branch not found
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
1685
Dynamics Simulation CHANGE_RLMOD_VAR
7.6.6. CHANGE_RLMOD_VAR
Use this API to change the value of a VAR of the line relay model in the designated relay slot of the from
bus end of a specified branch.
This API routine was first introduced in release 32.0.0.
Batch command syntax:
BAT_CHANGE_RLMOD_VAR IBUS JBUS 'ID' RS 'NAME' J RDATA
Python command syntax:
ierr = change_rlmod_var(ibus, jbus, id, rs, name, j, rdata)
Fortran command syntax:
CALL CHANGE_RLMOD_VAR(IBUS, JBUS, ID, RS, NAME, J, RDATA, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; blank by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Character*16 NAME model name (input; no default allowed).
Integer J VAR number to change relative to the start of the block of VARs as-
signed to this model (1 for VAR(J), 2 for VAR(J+1), etc.) (input; no de-
fault allowed).
Real RDATA new VAR value (input; unchanged).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
IERR = 2 unknown model NAME
IERR = 3 no relay model on this branch at the bus IBUS
end
IERR = 4 relay model at bus IBUS end is aaa not xxx
IERR = 5 no VARs used in model NAME
IERR = 6 VAR number outside of the VAR range of this
model
IERR = 7 bus not found
IERR = 8 branch not found
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
1686
Dynamics Simulation RLMOD_PACK
7.6.7. RLMOD_PACK
Use this API to remove entries that are marked as unused from the line relay model connection tables and
the line relay model array allocation tables. It packs the entries remaining in these tables at the front of the
various arrays.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RLMOD_PACK
Python command syntax:
ierr = rlmod_pack()
Fortran command syntax:
CALL RLMOD_PACK(IERR)
Where:
Integer IERR error code (output).
IERR = 0 no error
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
1687
Dynamics Simulation RLMOD_REMOVE
7.6.8. RLMOD_REMOVE
Use this API to remove the line relay model in the designated relay slot of the from bus end of a specified
branch.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RLMOD_REMOVE IBUS JBUS 'ID' RS
Python command syntax:
ierr = rlmod_remove(ibus, jbus, id, rs)
Fortran command syntax:
CALL RLMOD_REMOVE(IBUS, JBUS, ID, RS, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; '1' by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
IERR = 2 no relay model on this branch at the bus IBUS
end
IERR = 3 bus not found
IERR = 4 branch not found
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
1688
Dynamics Simulation RLMOD_STATUS
7.6.9. RLMOD_STATUS
Use this API to change the status of the line relay model in the designated relay slot of the from bus end of
a specified branch.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RLMOD_STATUS IBUS JBUS 'ID' RS STATUS
Python command syntax:
ierr = rlmod_status(ibus, jbus, id, rs, status)
Fortran command syntax:
CALL RLMOD_STATUS(IBUS, JBUS, ID, RS, STATUS, IERR)
Where:
Integer IBUS from bus number (input; no default allowed).
Integer JBUS to bus number (input; no default allowed).
Character*2 ID circuit identifier (input; '1' by default).
Integer RS relay slot (1 or 2) (input; 1 by default).
Integer STATUS new model status (input; 1 by default).
STATUS = 0 out-of-service
STATUS = 1 in-service
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 invalid RS value
IERR = 2 no relay model on this branch at the bus IBUS
end
IERR = 3 invalid STATUS value
IERR = 4 bus not found
IERR = 5 branch not found
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
1689
Dynamics Simulation RLMOD_UNCONNECTED
7.6.10. RLMOD_UNCONNECTED
Use this API to list or remove from dynamics working memory those line relay models that are assigned to
branches that are not present in the current power flow working case (unconnected).
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RLMOD_UNCONNECTED OPT
Python command syntax:
ierr = rlmod_unconnected(opt)
Fortran command syntax:
CALL RLMOD_UNCONNECTED(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list unconnected line relay models
OPT = 1 remove unconnected line relay models
Integer IERR error code (output).
IERR = 0 no error
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
1690
Dynamics Simulation RLMOD_USER
7.6.11. RLMOD_USER
Use this API to list user-written line relay model definitions or to remove user-written line relay model defi-
nitions that are not assigned to any branches (unused) from the user model definition tables.
This API routine was first introduced in release 28.0.0.
Batch command syntax:
BAT_RLMOD_USER OPT
Python command syntax:
ierr = rlmod_user(opt)
Fortran command syntax:
CALL RLMOD_USER(OPT, IERR)
Where:
Integer OPT option code (input; 0 by default).
OPT = 0 list user-written line relay definitions
OPT = 1 remove unused user-written line relay defini-
tions
Integer IERR error code (output).
IERR = 0 no error
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
1691
Dynamics Simulation RLMOD_USER
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1692
Dynamics Simulation DC Line Related Models
7.7. DC Line Related Models
7.7.1. ADD_MTDCLINE_MODEL
Use this API to add a multi-terminal dc line model to the specified multi-terminal dc line. If a model already
exists at the multi-terminal dc line, it is replaced.
This API routine was first introduced in release 30.2.0.
Batch command syntax:
BAT_ADD_MTDCLINE_MODEL DC 'MODEL' NICN IDATA CHDATA NCON RDATA
IERR
Python command syntax:
ierr = add_mtdcline_model(dc, model, nicn, idata, chdata, ncon, rdata)
Fortran command syntax:
CALL ADD_MTDCLINE_MODEL(NUM, MODEL, NICN, IDATA, CHDATA, NCON, RDATA,
IERR)
CALL ADD_MTDCLINE_MODEL_I(NUM, MODEL, NICN, IDATA, CHDATA, NCON, RDATA,
IERR)
CALL ADD_MTDCLINE_MODEL_C(NAME, MODEL, NICN, IDATA, CHDATA, NCON, RDATA,
IERR)
Where:
Integer or Character*12 DC quoted name of the multi-terminal dc line to which the model is to
be added; if an unquoted integer value is specified, the API converts
it to a left-justified name (input; no default allowed).
Integer NUM number (which the API converts to a left-justified name) of the mul-
ti-terminal dc line to which the model is to be added (input; no de-
fault allowed).
Character*12 NAME name of the multi-terminal dc line to which the model is to be added
(input; no default allowed).
Character*16 MODEL model name (input; no default allowed).
Integer NICN number of ICONs required by the model (input; no default allowed).
Integer IDATA (NICN) ICON data (input; 0 by default). When a character value is intended
for an ICON value, the corresponding IDATA entry is ignored and the
integer ICON is set to 0).
Character*12 CHDATA (NICN) character ICON data (no default allowed for an ICON for which a
character value is to be specified). When an integer value is intended
for an ICON value, the corresponding CHDATA entry must be either
defaulted or specified as either '$$' or ' '; the character ICON is set to
'$$' (input; blank by default).
Integer NCON number of CONs required by the model (input; no default allowed).
All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
1693
Dynamics Simulation ADD_MTDCLINE_MODEL
Real RDATA (NCON) CON data (input; 0.0).
Integer IERR error code (output).
IERR = 0 no error
IERR = 1 dc line not found
IERR = 2
You might also like
- Digsilent Powerfactory: Technical Reference Documentation100% (2)Digsilent Powerfactory: Technical Reference Documentation152 pages
- EMTP, Transient Stability and Power Flow Models and Controls of VSC Based FACTS Controllers - E. Uzunovic - 2001100% (1)EMTP, Transient Stability and Power Flow Models and Controls of VSC Based FACTS Controllers - E. Uzunovic - 2001231 pages
- Aemo Load Modeling 062819 Final Dynamic Load PsseNo ratings yetAemo Load Modeling 062819 Final Dynamic Load Psse77 pages
- CIM Standard Dynamic Models Rev0 051208 DIgSILENTNo ratings yetCIM Standard Dynamic Models Rev0 051208 DIgSILENT2 pages
- RalphChristie How Calculate Zigzag TransformerNo ratings yetRalphChristie How Calculate Zigzag Transformer1 page
- PSCAD-Resolving-Launching-Compiling-and-Running IssuesNo ratings yetPSCAD-Resolving-Launching-Compiling-and-Running Issues319 pages
- CYMGRD 6.3 For Windows: User'S Guide and Reference Manual100% (2)CYMGRD 6.3 For Windows: User'S Guide and Reference Manual141 pages
- ABB Wind Turbine Converters: PCS6000, Full Power Converter, Up To 12 MWNo ratings yetABB Wind Turbine Converters: PCS6000, Full Power Converter, Up To 12 MW12 pages
- Determination of Critical Clearing Time in Transient Stability AnalysisNo ratings yetDetermination of Critical Clearing Time in Transient Stability Analysis5 pages
- Simulation of Some Power System, Control System and Power Electronics Case Studies Using Matlab and PowerWorld SimulatorFrom EverandSimulation of Some Power System, Control System and Power Electronics Case Studies Using Matlab and PowerWorld SimulatorNo ratings yet
- CWS-315-2I-en-StudentManual-1-3-days-v04No ratings yetCWS-315-2I-en-StudentManual-1-3-days-v04461 pages
- zVM720 CMS Macros and Functions Reference SC24-6262-02No ratings yetzVM720 CMS Macros and Functions Reference SC24-6262-02614 pages
- Module 11 - Aeroplane Aerodynamics, Structure and Systems: Aviation Training HubNo ratings yetModule 11 - Aeroplane Aerodynamics, Structure and Systems: Aviation Training Hub583 pages
- HBEF1103 Sociology and Philosophy in Education of MalaysiaNo ratings yetHBEF1103 Sociology and Philosophy in Education of Malaysia21 pages
- Lifting Plan Calculation (QTZ200 Tower Crane)No ratings yetLifting Plan Calculation (QTZ200 Tower Crane)3 pages
- Pratham Balodi FlowCV Resume 20250321 (1)No ratings yetPratham Balodi FlowCV Resume 20250321 (1)1 page
- ABP Fluent 2021R2 External Aero Automotive v0No ratings yetABP Fluent 2021R2 External Aero Automotive v094 pages
- Guide Backup Replication Community EditionNo ratings yetGuide Backup Replication Community Edition31 pages
- CDIP-Control of Documented Information Process V 1.0No ratings yetCDIP-Control of Documented Information Process V 1.010 pages
- pk80 Bluetooth Proximity Reader - 20230323 PDFNo ratings yetpk80 Bluetooth Proximity Reader - 20230323 PDF4 pages
- JVC KW-M845BW - B5a-2487-00 - KWV - K - enNo ratings yetJVC KW-M845BW - B5a-2487-00 - KWV - K - en104 pages
- Unoardusimv2.8.2 Full Help: Code Pane, Preferences, and Edit/ViewNo ratings yetUnoardusimv2.8.2 Full Help: Code Pane, Preferences, and Edit/View44 pages
- Microsoft 365 Information Protection Intro DECKNo ratings yetMicrosoft 365 Information Protection Intro DECK18 pages
- Importance of Numerical Solutions For Civil Engineering Problems100% (1)Importance of Numerical Solutions For Civil Engineering Problems3 pages
- HikCentral Professional Quick Start Guide 2.0.1 20210128No ratings yetHikCentral Professional Quick Start Guide 2.0.1 2021012848 pages
