Identify potential issues that could lead to the prerequisite requirements of an API not being met in power flow operations.

Potential issues leading to unmet prerequisite requirements for an API in power flow operations include incorrect configuration settings, missing or incomplete data files, and improperly defined subsystems. For instance, if essential setup files like DFXFILE or ACCFILE are not properly prepared or if subsystem identifiers are not correctly defined and mapped, the API might not execute successfully. Addressing these issues involves ensuring all input parameters are correctly specified, checking file integrity and accessibility, and validating subsystem configurations prior to API invocation to guarantee smooth operations .

In what scenarios would an invalid SID value result in an error during the execution of power flow operation APIs, and what are the implications?

An invalid SID value would result in an error during the execution of power flow operation APIs like BGEN, BKDY, and EEQV when the specified subsystem identifier is not within the valid range (0 to 11) or is not previously defined. The implications include failure to process the intended power flow operations, which may hinder the conversion of mismatched power to equivalent load or generation, misreporting of circuit breaker interrupting duty, or inaccurate creation of electrical equivalents for the subsystem. This typically results in an error code of IERR = 1, indicating the necessity for proper subsystem configuration before API invocation .

How does the N11_ACCC_PARALLEL API optimize the process of N-1-1 contingency analysis in power flow operations?

The N11_ACCC_PARALLEL API optimizes the N-1-1 contingency analysis process by distributing contingency cases across multiple processors. When the number of contingency processors in program settings exceeds one, the API operates in parallel, testing the assigned contingency cases and following tripping actions simultaneously. This parallel processing enhances efficiency, significantly reducing the time required for comprehensive contingency analysis of intricate power systems, thus enabling real-time responsiveness and improved decision-making in managing contingency scenarios .

Explain how the MACCC_2 API differs from traditional power flow operations in terms of contingency analysis.

The MACCC_2 API differs from traditional power flow operations by facilitating advanced multiple level contingency analysis. Unlike conventional methods that might evaluate single or isolated contingency scenarios, MACCC_2 evaluates user-specified and automatically-selected contingencies both individually and in combination, considering overlapping outages up to a specified evaluation level. This comprehensive approach allows for a more robust assessment of system vulnerabilities and the potential wide-ranging impact of multiple, concurrent disruptions, enabling improved contingency planning and risk mitigation .

What are the default settings for the generator, load, and phase shifter control flags in the Siemens power flow operation systems, and how do they differ when enabled?

The default settings for the Siemens power flow operation control flags are as follows: the generator control flag (OPTCOR(3)) is set to 1, enabling it by default; the load control flag (OPTCOR(4)) is set to 0, disabling it by default; and the phase shifter control flag (OPTCOR(5)) is set to 1, enabling it by default. When these flags are enabled, they allow the respective corrective actions to be applied: enabling generator control allows for generator adjustments, load control allows for load adjustments, and phase shifter control allows for phase angle adjustments. These settings impact the power flow by adjusting different elements to maintain balance and stability .

How does the Power Flow Operation ACCC_TRIP_COR handle bus voltage and branch flow tolerances, and what are their default values?

Within the Power Flow Operation ACCC_TRIP_COR, bus voltage violation tolerance and branch flow overload tolerance are managed by parameters set in the array REAL VALUES. The default bus voltage violation tolerance is 0.1, and the same value applies to branch flow overload tolerance. These tolerances are critical for ensuring that the voltage levels and the branch loadings remain within acceptable limits during corrective actions and contingency analyses, contributing to the stability and reliability of the power system .

What is the function of the BGEN API in power flow operation, and why is it necessary after removing a subsystem?

The BGEN API in power flow operation is used to convert the mismatch at boundary buses into equivalent load and/or generation. This is necessary after removing a subsystem from a solved working case because the flows to the deleted subsystem must be replaced. The API ensures that power previously transmitted to or drawn from the removed subsystem is now balanced by adjusting loads and generators at the remaining interfacing buses. By doing so, it maintains system integrity and avoids discrepancies in power distribution .

Discuss the importance of the VALUES parameter array in the ACCC_TRIP_COR_2 operation and how it influences power flow corrective actions.

The VALUES parameter array in the ACCC_TRIP_COR_2 operation is crucial as it defines the parameters for corrective actions in power flow operations. The array includes elements like bus voltage violation tolerance, branch flow overload tolerance, and control weighting factors for generators, loads, and phase shifters. These parameters guide the system's response to contingencies by specifying permissible tolerances and adjustments, thereby influencing the performance and stability of the power network. Properly set VALUES parameters enable effective management of power distribution and prevention of violations, contributing to system reliability .

What challenges might arise when using the BKDY API for calculating circuit breaker duty and how are they addressed within the API framework?

Several challenges might arise when using the BKDY API for calculating circuit breaker duty, such as ensuring accuracy across different buses and managing high computational load due to the complexity of 3-phase fault simulations in extensive networks. Within the API framework, these challenges are addressed by allowing users to specify the subsystem and define range parameters (e.g., SID and ALL) to focus calculations on relevant parts. Additionally, error codes like IERR inform users of issues such as invalid subsystem identifiers, facilitating troubleshooting and enabling precise targeting of problem areas to maintain system reliability .

What role does the ECHO API play in power flow operations, and how can it be configured to suit specific operational needs?

The ECHO API in power flow operations facilitates the enabling or disabling of response echoing. It plays a critical role in monitoring and logging by allowing users to create a Response File that records executed commands and responses during operations. Configuring the ECHO API involves setting the IDVFIL parameter: providing a file name enables logging, while leaving it blank disables it. This configurability suits various operational needs, whether detailed tracking and auditing are required or streamlined operations are prioritized without response logging .

Open navigation menu

Upload

100% found this document useful (3 votes)

1K views2,866 pages

API

Siemens PSSE V34 API

Uploaded by

Melih Bilgen

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

100% found this document useful (3 votes)

1K views2,866 pages

API

Siemens PSSE V34 API

Uploaded by

Melih Bilgen

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 2866

Application Program Interface (API)

PSS®E 34.6.0
July 2019

Siemens Industry, Inc.

Siemens Power Technologies International
400 State Street, P.O. Box 1058
Schenectady, NY 12301-1058 USA
+1 518-395-5000
www.siemens.com/power-technologies
Copyright © 1990, 2019 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 mechanical,
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 registered trade-
mark of Siemens Industry, Inc., Siemens Power Technologies International in the United States and other countries. The Windows® 2000
operating system, the Windows XP® operating system, the Windows Vista® operating system, the Windows 7® operating system, the
Visual C++® development system, Microsoft Office Excel® and Microsoft Visual Studio® are registered trademarks of Microsoft Corpo-
ration in the United States and other countries. Intel® Visual Fortran Compiler for Windows is a trademark of Intel 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 ........................................................................................................................................... xl
Power Flow Operation ...................................................................................................................... 1
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
ANSI ...................................................................................................................................... 93
ANSI_2 ................................................................................................................................... 95
ANSI_3 ................................................................................................................................... 97
APPEND_ACCC ...................................................................................................................... 100
AREA .................................................................................................................................... 102
AREA_2 ................................................................................................................................ 103
AREA_ZONE .......................................................................................................................... 104
ARNM .................................................................................................................................. 105
ARNM_2 ............................................................................................................................... 107
ASCC .................................................................................................................................... 109
ASCC_1A .............................................................................................................................. 111
ASCC_2 ................................................................................................................................ 113
ASCC_3 ................................................................................................................................ 115
ASCC_SCFILE ........................................................................................................................ 119
BASE_FREQUENCY ................................................................................................................. 120
BGEN ................................................................................................................................... 121

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
iii
BKDY .................................................................................................................................... 122
BRCH .................................................................................................................................... 124
BRCH_2 ................................................................................................................................ 126
BSNM ................................................................................................................................... 128
BUSN ................................................................................................................................... 131
BUS_INPUT ........................................................................................................................... 132
BUS_OUTPUT ........................................................................................................................ 133
BUS_SIZE_LEVEL ................................................................................................................... 134
CASE .................................................................................................................................... 135
CA_ITERATIONS ..................................................................................................................... 136
CHECKVOLTAGELIMITS ........................................................................................................... 137
CHECK_POWERFLOW_DATA .................................................................................................... 138
CHECK_SEQUENCE_DATA ....................................................................................................... 140
CHKCNTDUPLICON ................................................................................................................ 141
CHKCNTDUPLIDFX ................................................................................................................. 142
CLOSE_POWERFLOW .............................................................................................................. 143
CLOSE_REPORT ..................................................................................................................... 144
CMPR ................................................................................................................................... 145
CNTB .................................................................................................................................... 147
CONG ................................................................................................................................... 149
CONL ................................................................................................................................... 150
CONNECTIVITY_CHECK .......................................................................................................... 152
CONTROL_AREA_INTERCHANGE ............................................................................................. 153
DCCC ................................................................................................................................... 154
DCCC_2 ................................................................................................................................ 156
DCCOR ................................................................................................................................. 158
DCLF .................................................................................................................................... 160
DCLF_2 ................................................................................................................................ 162
DC_TAP_ADJUSTMENT ........................................................................................................... 164
DELTMPFILES ........................................................................................................................ 165
DFAX ................................................................................................................................... 166
DFAX_2 ................................................................................................................................ 168
DFAX_CONTINGENCY ............................................................................................................ 170
DFTI ..................................................................................................................................... 171
DIFF ..................................................................................................................................... 174
DSCN ................................................................................................................................... 176
DUPLICATE_CNTLABEL_CHECK ................................................................................................ 177
ECDI ..................................................................................................................................... 178
ECHO ................................................................................................................................... 180
EEQV ................................................................................................................................... 181
EQRD ................................................................................................................................... 183
EXAM ................................................................................................................................... 185
EXTR .................................................................................................................................... 186
FACT .................................................................................................................................... 187
FDNS ................................................................................................................................... 188
FILE_OVERWRITE ................................................................................................................... 190
FIND .................................................................................................................................... 191
FLAT .................................................................................................................................... 192
FLAT_2 ................................................................................................................................. 194
FNSL .................................................................................................................................... 197
GCAP ................................................................................................................................... 199

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
iv
GDIF .................................................................................................................................... 200
GENDSP ............................................................................................................................... 202
GENS ................................................................................................................................... 204
GEOL ................................................................................................................................... 205
GETCONTINGENCYSAVEDCASE ............................................................................................... 206
GIC ...................................................................................................................................... 207
GIC_2 ................................................................................................................................... 210
GIC_3 ................................................................................................................................... 216
GIC_4 ................................................................................................................................... 222
GIC_5 ................................................................................................................................... 229
GIC_6 ................................................................................................................................... 236
GIC_EFIELD_WAVESHAPE ....................................................................................................... 246
GIC_EFIELD_WAVESHAPE_REF ................................................................................................ 247
GIC_EFIELD_WAVESHAPE_SUPP .............................................................................................. 248
GIC_MVARLOSS_SCALING_FACTORS ........................................................................................ 249
GIC_PF ................................................................................................................................. 250
GIC_PF_OPTIONS ................................................................................................................... 252
GIC_THERMAL_IMPACT .......................................................................................................... 254
GNESTATUS .......................................................................................................................... 255
GNET ................................................................................................................................... 256
HARMONICS ......................................................................................................................... 257
IECS ..................................................................................................................................... 259
IECS_2 ................................................................................................................................. 261
IECS_3 ................................................................................................................................. 264
IECS_4 ................................................................................................................................. 267
IECS_SCFILE .......................................................................................................................... 271
IMNET .................................................................................................................................. 272
IMOUTAGE ............................................................................................................................ 273
IMPC .................................................................................................................................... 274
IMPLEMENT_TRANSFER .......................................................................................................... 275
IMPLEMENT_TRANSFER_2 ...................................................................................................... 278
INLF ..................................................................................................................................... 281
INLF_2 ................................................................................................................................. 283
INTA ..................................................................................................................................... 285
INTZ ..................................................................................................................................... 286
ISOLATE_LEVELS ................................................................................................................... 287
JOIN ..................................................................................................................................... 288
LAMP ................................................................................................................................... 289
LINES_PER_PAGE ................................................................................................................... 290
LINES_PER_PAGE_ONE_DEVICE ............................................................................................... 291
LINE_SHUNT_REPORTING ....................................................................................................... 292
LIST ..................................................................................................................................... 293
LISTCONTINGENCYSAVEDCASES ............................................................................................. 295
LLRF ..................................................................................................................................... 296
LOAD_REDUCTION ................................................................................................................. 298
LOUT .................................................................................................................................... 299
LTAP ..................................................................................................................................... 300
MACCC ................................................................................................................................. 301
MACCC_2 ............................................................................................................................. 306
MACCC_PARALLEL ................................................................................................................. 311
MACCC_TRIP_COR ................................................................................................................. 316

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
v
MACCC_TRIP_COR_2 .............................................................................................................. 322
MACCC_TRIP_COR_3 .............................................................................................................. 328
MACCC_WITH_COR ................................................................................................................ 335
MACCC_WITH_COR_2 ............................................................................................................ 340
MACCC_WITH_COR_3 ............................................................................................................ 346
MACCC_WITH_TRIP ................................................................................................................ 352
MACCC_WITH_TRIP_2 ............................................................................................................ 357
MACCC_WITH_TRIP_PARALLEL ................................................................................................ 362
MATRIX_GROWTH_FACTOR .................................................................................................... 367
MBID2DC .............................................................................................................................. 368
MBID3WND .......................................................................................................................... 369
MBIDATRN ............................................................................................................................ 370
MBIDBRN .............................................................................................................................. 371
MBIDFACTS ........................................................................................................................... 372
MBIDGNE ............................................................................................................................. 373
MBIDINDMAC ........................................................................................................................ 374
MBIDLOAD ............................................................................................................................ 375
MBIDMAC ............................................................................................................................. 376
MBIDMDC ............................................................................................................................. 377
MBIDMSL ............................................................................................................................. 378
MBIDSHUNT ......................................................................................................................... 379
MBIDVSC .............................................................................................................................. 380
MCRE ................................................................................................................................... 381
MODR .................................................................................................................................. 382
MOVE3WND ......................................................................................................................... 384
MOVEBRN ............................................................................................................................. 385
MOVEINDMAC ...................................................................................................................... 386
MOVEINDMACS ..................................................................................................................... 387
MOVELOAD .......................................................................................................................... 388
MOVELOADS ......................................................................................................................... 389
MOVEMAC ............................................................................................................................ 390
MOVEPLNT ........................................................................................................................... 391
MOVESHUNT ........................................................................................................................ 392
MOVESHUNTS ....................................................................................................................... 393
MOVESWS ............................................................................................................................ 394
MOV_ALPHA ......................................................................................................................... 395
MOV_ITERATIONS .................................................................................................................. 396
MOV_TOLERANCE ................................................................................................................. 397
MSLV ................................................................................................................................... 398
MSUM .................................................................................................................................. 400
MTDC ................................................................................................................................... 401
MULTISECTION_REPORTING .................................................................................................... 402
MWMI .................................................................................................................................. 403
MWOMWMSF ....................................................................................................................... 405
MWOMWOSF ........................................................................................................................ 406
N11_ACCC ............................................................................................................................ 407
N11_ACCC_2 ........................................................................................................................ 411
N11_ACCC_PARALLEL ............................................................................................................ 415
N11_ACCC_PSCOPF ............................................................................................................... 419
N11_ACCC_PSCOPF_2 ........................................................................................................... 426
NETG ................................................................................................................................... 433

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
vi
NEWCAS ............................................................................................................................... 434
NEWCASE_2 ......................................................................................................................... 435
NEWSEQ ............................................................................................................................... 436
NEWTON_TOLERANCE ........................................................................................................... 437
NEW_DIMENSION .................................................................................................................. 438
NON_DIVERGENT .................................................................................................................. 439
NON_TRANS_PERCENT_UNITS ................................................................................................ 440
NSOL ................................................................................................................................... 441
NUMBER_THREADS ................................................................................................................ 443
ORDR ................................................................................................................................... 444
OTDF ................................................................................................................................... 445
OUTPUT_Y_MATRIX ............................................................................................................... 446
OUTS ................................................................................................................................... 447
OWNM ................................................................................................................................. 448
OWNM_2 ............................................................................................................................. 450
OWNM_3 ............................................................................................................................. 452
OWNR .................................................................................................................................. 454
PATH .................................................................................................................................... 455
PHASE_SHIFT_ADJUSTMENT ................................................................................................... 456
POLY .................................................................................................................................... 457
POUT ................................................................................................................................... 460
POWER_OUTPUT ................................................................................................................... 461
PP_ACCC .............................................................................................................................. 462
PP_ACCC_MULTI_CASE ........................................................................................................... 464
PRINT_OUTAGED_BRANCHES .................................................................................................. 467
PRINT_WINDING_BUSES ......................................................................................................... 468
PROGRESS_OUTPUT ............................................................................................................... 469
PROMPT_OUTPUT .................................................................................................................. 470
PRTI ..................................................................................................................................... 471
PSCOPF ................................................................................................................................ 472
PSCOPF_2 ............................................................................................................................. 478
PSEB .................................................................................................................................... 484
PSSEHALT ............................................................................................................................. 485
PSSEHALT_2 .......................................................................................................................... 486
PURG ................................................................................................................................... 487
PURG2DC ............................................................................................................................. 489
PURG3WND .......................................................................................................................... 490
PURGAREA ............................................................................................................................ 491
PURGATRN ............................................................................................................................ 492
PURGBRN .............................................................................................................................. 493
PURGE_MULTI_TERM_DC_BUS ................................................................................................ 494
PURGE_MULTI_TERM_DC_CONVR ............................................................................................ 495
PURGE_MULTI_TERM_DC_LINK ............................................................................................... 497
PURGFACTS .......................................................................................................................... 498
PURGGNE ............................................................................................................................. 499
PURGINDMAC ....................................................................................................................... 500
PURGINDMACS ...................................................................................................................... 501
PURGLOAD ........................................................................................................................... 502
PURGLOADS .......................................................................................................................... 503
PURGMAC ............................................................................................................................. 504
PURGMDC ............................................................................................................................ 505

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
vii
PURGMSL ............................................................................................................................. 506
PURGMUT ............................................................................................................................. 507
PURGOWNER ........................................................................................................................ 508
PURGPLNT ............................................................................................................................ 509
PURGSHUNT ......................................................................................................................... 510
PURGSHUNTS ........................................................................................................................ 511
PURGSWS ............................................................................................................................. 512
PURGVSC .............................................................................................................................. 513
PURGZONE ........................................................................................................................... 514
PV_ENGINE ........................................................................................................................... 515
PV_ENGINE_1A ..................................................................................................................... 520
PV_ENGINE_2 ....................................................................................................................... 525
PV_ENGINE_3 ....................................................................................................................... 531
PV_ENGINE_4 ....................................................................................................................... 537
PV_ENGINE_5 ....................................................................................................................... 543
PV_ENGINE_6 ....................................................................................................................... 549
QV_ENGINE .......................................................................................................................... 555
QV_ENGINE_2 ....................................................................................................................... 558
QV_ENGINE_3 ....................................................................................................................... 561
QV_ENGINE_4 ....................................................................................................................... 564
RANK ................................................................................................................................... 568
RANK_BRN_AND_MAC ........................................................................................................... 570
RATE .................................................................................................................................... 572
RATE_2 ................................................................................................................................. 574
RATING_SET .......................................................................................................................... 576
RAWD ................................................................................................................................... 577
RAWD_2 ............................................................................................................................... 579
RDCH ................................................................................................................................... 581
RDCHRAWVERSION ................................................................................................................ 582
RDEQ ................................................................................................................................... 583
READ .................................................................................................................................... 585
READRAWVERSION ................................................................................................................ 586
READSUB .............................................................................................................................. 587
READSUBRAWVERSION .......................................................................................................... 589
RECN .................................................................................................................................... 591
RECORDING_OPTIONS ............................................................................................................ 592
REGB .................................................................................................................................... 593
RELIND ................................................................................................................................. 594
RELIND_2 ............................................................................................................................. 597
REMM .................................................................................................................................. 600
REPORT_OUTPUT ................................................................................................................... 601
RESQ .................................................................................................................................... 602
RESQVERSION ....................................................................................................................... 603
RETI ..................................................................................................................................... 604
RETRY_PSSUSERPF ................................................................................................................. 605
REV29_NAMES ...................................................................................................................... 606
RNFI ..................................................................................................................................... 607
RSOL .................................................................................................................................... 609
RUNLASTSOLUTION ............................................................................................................... 611
RWCM .................................................................................................................................. 612
RWMA .................................................................................................................................. 613

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
viii
RWMM ................................................................................................................................. 615
RWSQ ................................................................................................................................... 616
RWSQ_2 ............................................................................................................................... 618
SAVE .................................................................................................................................... 620
SCAL .................................................................................................................................... 621
SCAL_2 ................................................................................................................................ 624
SCEQ ................................................................................................................................... 627
SCGR .................................................................................................................................... 629
SCMU ................................................................................................................................... 631
SCMU_2 ............................................................................................................................... 637
SCOP .................................................................................................................................... 643
SENSITIVITY_FLOW ................................................................................................................ 645
SENSITIVITY_FLOWS .............................................................................................................. 649
SENSITIVITY_INTERFACE ......................................................................................................... 652
SENSITIVITY_VOLTAGE ........................................................................................................... 655
SENSITIVITY_VOLTAGES ......................................................................................................... 658
SEQD ................................................................................................................................... 661
SEQD_2 ................................................................................................................................ 662
SEQUENCE_NETWORK_SETUP ................................................................................................ 663
SET_INPUT_DEV .................................................................................................................... 664
SHNT ................................................................................................................................... 665
SHORT_CIRCUIT_COORDINATES .............................................................................................. 666
SHORT_CIRCUIT_MODELING ................................................................................................... 667
SHORT_CIRCUIT_UNITS .......................................................................................................... 668
SHORT_CIRCUIT_WARNING ..................................................................................................... 669
SHORT_CIRCUIT_Z_COORDINATES ........................................................................................... 670
SHORT_CIRCUIT_Z_UNITS ....................................................................................................... 671
SHOW .................................................................................................................................. 672
SIZE ..................................................................................................................................... 673
SOLV .................................................................................................................................... 674
SPCB .................................................................................................................................... 676
SPIL ..................................................................................................................................... 678
SPLT ..................................................................................................................................... 682
SQEX ................................................................................................................................... 683
SQLI ..................................................................................................................................... 684
SRAIND ................................................................................................................................ 686
STOP .................................................................................................................................... 688
STOP_2 ................................................................................................................................ 689
SUBS .................................................................................................................................... 690
SWITCHED_SHUNT_ADJUSTMENT ........................................................................................... 691
TAP_ADJUSTMENT ................................................................................................................. 692
TEXT .................................................................................................................................... 693
TFLG .................................................................................................................................... 694
TIES ..................................................................................................................................... 695
TIEZ ..................................................................................................................................... 696
TIME .................................................................................................................................... 697
TLST ..................................................................................................................................... 698
TLTG .................................................................................................................................... 699
TPCH .................................................................................................................................... 703
TRANSACTION_DELETE .......................................................................................................... 706
TRANSFORMER_PERCENT_UNITS ............................................................................................. 707

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
ix
TRANSMISSION_LINE_UNITS ................................................................................................... 708
TREE .................................................................................................................................... 709
TYSL .................................................................................................................................... 710
USER .................................................................................................................................... 711
VAMM .................................................................................................................................. 712
VAMO .................................................................................................................................. 713
VCHK ................................................................................................................................... 714
VOLTAGE_INPUT .................................................................................................................... 715
VOLTAGE_OUTPUT ................................................................................................................. 716
VSMO .................................................................................................................................. 717
WRITERAWVERSION ............................................................................................................... 718
WRITESEQVERSION ................................................................................................................ 719
WRITESEQVERSION_2 ............................................................................................................ 720
WRITE_OPTIONS_FILE ............................................................................................................ 721
XEQV ................................................................................................................................... 722
ZONE ................................................................................................................................... 724
ZONE_2 ............................................................................................................................... 725
ZONE_AREA .......................................................................................................................... 726
ZONM .................................................................................................................................. 727
ZONM_2 .............................................................................................................................. 729
Power Flow Data .......................................................................................................................... 731
AREA_DATA .......................................................................................................................... 732
BRANCH_CHNG ..................................................................................................................... 733
BRANCH_CHNG_3 ................................................................................................................. 735
BRANCH_DATA ...................................................................................................................... 738
BRANCH_DATA_3 .................................................................................................................. 741
BUS_CHNG_3 ........................................................................................................................ 744
BUS_CHNG_4 ........................................................................................................................ 746
BUS_DATA ............................................................................................................................ 748
BUS_DATA_2 ......................................................................................................................... 750
BUS_DATA_3 ......................................................................................................................... 752
BUS_DATA_4 ......................................................................................................................... 754
BUS_NUMBER ....................................................................................................................... 756
CASE_TITLE_DATA ................................................................................................................. 757
FACTS_CHNG_2 .................................................................................................................... 758
FACTS_CHNG_3 .................................................................................................................... 761
FACTS_DATA ......................................................................................................................... 764
FACTS_DATA_2 ...................................................................................................................... 767
FACTS_DATA_3 ...................................................................................................................... 770
GNE_CHNG ........................................................................................................................... 773
GNE_DATA ............................................................................................................................ 775
IMPEDANCE_CORRECTION_DATA ............................................................................................. 777
IMPEDANCE_CORRECTION_DATA_3 ......................................................................................... 778
INDUCTION_MACHINE_CHNG ................................................................................................. 779
INDUCTION_MACHINE_DATA .................................................................................................. 782
LOAD_CHNG_4 ..................................................................................................................... 785
LOAD_CHNG_5 ..................................................................................................................... 787
LOAD_DATA .......................................................................................................................... 789
LOAD_DATA_3 ....................................................................................................................... 791
LOAD_DATA_4 ....................................................................................................................... 793
LOAD_DATA_5 ....................................................................................................................... 795

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
x
LONG_TITLE_DATA ................................................................................................................. 797
MACHINE_CHNG_2 ................................................................................................................ 798
MACHINE_DATA .................................................................................................................... 800
MACHINE_DATA_2 ................................................................................................................. 802
MULTI_SECTION_LINE_DATA ................................................................................................... 804
MULTI_SECTION_LINE_EDIT .................................................................................................... 806
MULTI_TERM_DC_BUS_DATA .................................................................................................. 807
MULTI_TERM_DC_CONVR_DATA .............................................................................................. 809
MULTI_TERM_DC_LINE_CHNG ................................................................................................ 812
MULTI_TERM_DC_LINE_DATA .................................................................................................. 814
MULTI_TERM_DC_LINK_DATA ................................................................................................. 816
OWNER_DATA ....................................................................................................................... 818
PBUS_ADD_MOD ................................................................................................................... 819
PBUS_DELETE ........................................................................................................................ 820
PLANT_CHNG ........................................................................................................................ 821
PLANT_CHNG_3 .................................................................................................................... 822
PLANT_CHNG_4 .................................................................................................................... 823
PLANT_DATA ......................................................................................................................... 825
PLANT_DATA_3 ..................................................................................................................... 826
PLANT_DATA_4 ..................................................................................................................... 827
RATINGSETTEXTDATA ............................................................................................................. 829
SEQ_3_WIND_GROUNDING_DATA ........................................................................................... 830
SEQ_3_WIND_WINDING_DATA ................................................................................................ 831
SEQ_BRANCH_DATA ............................................................................................................... 832
SEQ_BRANCH_DATA_3 ........................................................................................................... 834
SEQ_BUS_DATA ..................................................................................................................... 836
SEQ_FIXED_SHUNT_DATA ...................................................................................................... 837
SEQ_INDUCTION_MACH_DATA ............................................................................................... 838
SEQ_INDUCTION_MACH_DATA_2 ............................................................................................ 840
SEQ_LOAD_DATA ................................................................................................................... 842
SEQ_MACHINE_DATA ............................................................................................................. 844
SEQ_MACHINE_DATA_3 ......................................................................................................... 846
SEQ_MACHINE_DATA_4 ......................................................................................................... 848
SEQ_MUTUAL_DATA .............................................................................................................. 850
SEQ_NCS_FLT_CNTRB_CHNG .................................................................................................. 852
SEQ_NCS_FLT_CNTRB_DATA ................................................................................................... 853
SEQ_NCS_FLT_CNTRB_PURG ................................................................................................... 854
SEQ_SWITCHED_SHUNT_DATA ................................................................................................ 855
SEQ_THREE_WINDING_DATA .................................................................................................. 857
SEQ_THREE_WINDING_DATA_3 ............................................................................................... 859
SEQ_TWO_WINDING_DATA .................................................................................................... 861
SEQ_TWO_WINDING_DATA_3 ................................................................................................. 863
SHUNT_CHNG ....................................................................................................................... 865
SHUNT_DATA ........................................................................................................................ 866
SOLUTION_PARAMETERS ........................................................................................................ 867
SOLUTION_PARAMETERS_2 .................................................................................................... 869
SOLUTION_PARAMETERS_3 .................................................................................................... 871
SOLUTION_PARAMETERS_4 .................................................................................................... 873
SWITCHED_SHUNT_CHNG_3 ................................................................................................... 875
SWITCHED_SHUNT_CHNG_4 ................................................................................................... 878
SWITCHED_SHUNT_DATA ....................................................................................................... 881

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xi
SWITCHED_SHUNT_DATA_3 .................................................................................................... 884
SWITCHED_SHUNT_DATA_4 .................................................................................................... 887
THREE_WINDING_DATA .......................................................................................................... 890
THREE_WND_IMPEDANCE_DATA ............................................................................................. 894
THREE_WND_IMPED_CHNG_3 ................................................................................................ 897
THREE_WND_IMPED_CHNG_4 ................................................................................................ 900
THREE_WND_IMPED_DATA_3 ................................................................................................. 903
THREE_WND_IMPED_DATA_4 ................................................................................................. 906
THREE_WND_WINDING_DATA ................................................................................................. 909
THREE_WND_WINDING_DATA_3 ............................................................................................. 911
THREE_WND_WINDING_DATA_4 ............................................................................................. 913
THREE_WND_WINDING_DATA_5 ............................................................................................. 916
TRANSACTION_ADD_MOD ..................................................................................................... 919
TRANSFER_CHNG .................................................................................................................. 920
TRANSFER_DATA ................................................................................................................... 921
TWO_TERMINAL_DC_LINE_CHNG ............................................................................................ 923
TWO_TERMINAL_DC_LINE_DATA ............................................................................................. 925
TWO_TERM_DC_CONVERTER_DATA_3 ..................................................................................... 927
TWO_TERM_DC_CONVR_DATA ................................................................................................ 930
TWO_WINDING_CHNG_4 ....................................................................................................... 933
TWO_WINDING_CHNG_5 ....................................................................................................... 937
TWO_WINDING_CHNG_6 ....................................................................................................... 941
TWO_WINDING_DATA ............................................................................................................ 946
TWO_WINDING_DATA_3 ........................................................................................................ 950
TWO_WINDING_DATA_4 ........................................................................................................ 954
TWO_WINDING_DATA_5 ........................................................................................................ 958
TWO_WINDING_DATA_6 ........................................................................................................ 962
VSC_DC_CONVERTER_DATA .................................................................................................... 967
VSC_DC_CONVERTER_DATA_3 ................................................................................................ 969
VSC_DC_LINE_CHNG ............................................................................................................. 971
VSC_DC_LINE_DATA ............................................................................................................... 972
ZONE_DATA .......................................................................................................................... 973
Optimal Power Flow ..................................................................................................................... 974
Optimal Power Flow Operation .............................................................................................. 975
ADD_DETAILS_TO_OPF_LOG ........................................................................................... 975
APPLY_ALTERNATE_STEP_SIZE ........................................................................................ 976
APPLY_AUTOMATIC_SCALING ......................................................................................... 977
BAD_ITER_COARSE_LIMIT ............................................................................................... 978
BAD_ITER_FINE_LIMIT .................................................................................................... 979
CLAMP_NONOPTIMIZED_GENS ....................................................................................... 980
CONSTRAIN_INTERFACE_FLOWS ..................................................................................... 981
FINAL_OPF_BARRIER_COEFF ........................................................................................... 982
IMPORT_ECDI ................................................................................................................ 983
INITIAL_OPF_BARRIER_COEFF ......................................................................................... 984
INTERFACE_FLOW_COST_COEFF ..................................................................................... 985
LSTO ............................................................................................................................ 986
MINIMIZE_ADJ_BUS_SHUNTS ......................................................................................... 988
MINIMIZE_FUEL_COST ................................................................................................... 989
MINIMIZE_INTERFACE_FLOWS ........................................................................................ 990
MINIMIZE_LOAD_ADJUSTMENTS ..................................................................................... 991
MINIMIZE_P_LOSSES ...................................................................................................... 992

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xii
MINIMIZE_P_SLACK ....................................................................................................... 993
MINIMIZE_Q_LOSSES ..................................................................................................... 994
MINIMIZE_Q_SLACK ...................................................................................................... 995
MINIMIZE_REACTIVE_RESERVE ........................................................................................ 996
MINIMIZE_SERIES_COMP ................................................................................................ 997
NOPF ........................................................................................................................... 998
OPEN_BUS_VOLTAGE_LIMITS .......................................................................................... 999
OPF_BARRIER_STEP_LENGTH ........................................................................................ 1000
OPF_CLAMP_DECAY_FACTOR ....................................................................................... 1001
OPF_FINAL_CLAMP_TOL .............................................................................................. 1002
OPF_FIXED_VOLTAGE_PENALTY .................................................................................... 1003
OPF_FIX_ALL_GENERATORS .......................................................................................... 1004
OPF_FIX_PHASE_SHIFTERS ........................................................................................... 1005
OPF_FIX_SWITCHED_SHUNTS ....................................................................................... 1006
OPF_FIX_TAP_RATIOS ................................................................................................... 1007
OPF_INITIAL_CLAMP_TOL ............................................................................................. 1008
OPF_INTERIOR_SHIFT_FACTOR ...................................................................................... 1009
OPF_LAMBDA_TOLERANCE ........................................................................................... 1010
OPF_LF_CONTROL_PENALTY ......................................................................................... 1011
OPF_MAX_TAP_RATIO_STEP ......................................................................................... 1012
OPF_MIN_TAP_RATIO_STEP .......................................................................................... 1013
OPF_REGULATE_AREA_INT ........................................................................................... 1014
OPF_ROUND_SWITCHED_SHUNTS ................................................................................. 1015
OPF_ROUND_TAP_RATIOS ............................................................................................ 1016
OPF_SCALE_QGEN_LIMITS ........................................................................................... 1017
OPF_STEP_LENGTH_TOLERANCE ................................................................................... 1018
OPF_USE_GENERATOR_VSCHED .................................................................................... 1019
OPTO ......................................................................................................................... 1020
PRODUCE_OPF_LOG_FILE ............................................................................................. 1026
P_LOSSES_COST_COEFF ............................................................................................... 1027
Q_LOSSES_COST_COEFF .............................................................................................. 1028
REACTIVE_RESV_COST_COEFF ...................................................................................... 1029
ROPF .......................................................................................................................... 1030
RWOP ......................................................................................................................... 1031
SET_OPF_REPORT_SUBSYSTEM ..................................................................................... 1032
USE_DUAL_CRITERIA .................................................................................................... 1033
USE_EMERGENCY_FLOW_LIMITS ................................................................................... 1034
USE_EMERGENCY_VOLT_LIMITS .................................................................................... 1035
WRITE_OPF_OPTIONS_FILE ........................................................................................... 1036
Optimal Power Flow Data .................................................................................................... 1038
NEWOPF ..................................................................................................................... 1038
OPF_ADJBRX_INDV ...................................................................................................... 1039
OPF_ADJBRX_SUBSYS .................................................................................................. 1041
OPF_ADJLOAD_TBL ...................................................................................................... 1044
OPF_ADJVAR_INDV ...................................................................................................... 1046
OPF_ADJVAR_INDV_2 .................................................................................................. 1048
OPF_ADJVAR_SUBSYS .................................................................................................. 1050
OPF_APDSP_TBL .......................................................................................................... 1053
OPF_BRFLW_3WT_INDV ............................................................................................... 1055
OPF_BRFLW_BRN_INDV ................................................................................................ 1057
OPF_BRFLW_SUBSYS .................................................................................................... 1059

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xiii
OPF_BUS_INDV ........................................................................................................... 1062
OPF_BUS_INDV_2 ........................................................................................................ 1064
OPF_BUS_SUBSYS ........................................................................................................ 1066
OPF_CSTTBL_LIN ......................................................................................................... 1069
OPF_CSTTBL_POLY ...................................................................................................... 1070
OPF_CSTTBL_QUAD ..................................................................................................... 1071
OPF_GENDSP_INDV ..................................................................................................... 1072
OPF_GENDSP_SUBSYS ................................................................................................. 1073
OPF_GENRSV_INDV ..................................................................................................... 1074
OPF_GENRSV_SUBSYS .................................................................................................. 1075
OPF_GEN_RCAP_INDV .................................................................................................. 1077
OPF_GEN_RCAP_SUBSYS .............................................................................................. 1079
OPF_INTFLW_3WT ....................................................................................................... 1082
OPF_INTFLW_BRN ........................................................................................................ 1083
OPF_INTFLW_MAIN ..................................................................................................... 1084
OPF_INTFLW_RESET ..................................................................................................... 1086
OPF_LNCEQN_ADJLOAD ............................................................................................... 1087
OPF_LNCEQN_ADJVAR ................................................................................................. 1088
OPF_LNCEQN_BRFLOW ................................................................................................ 1089
OPF_LNCEQN_INTFLOW ............................................................................................... 1090
OPF_LNCEQN_MAIN .................................................................................................... 1091
OPF_LNCEQN_PGEN .................................................................................................... 1092
OPF_LNCEQN_QGEN ................................................................................................... 1093
OPF_LNCEQN_RESET ................................................................................................... 1094
OPF_LNCEQN_SWSHUNT ............................................................................................. 1095
OPF_LNCEQN_TRAN .................................................................................................... 1096
OPF_LNCEQN_VANG .................................................................................................... 1097
OPF_LNCEQN_VANG_2 ................................................................................................ 1098
OPF_LNCEQN_VMAG ................................................................................................... 1099
OPF_LNCEQN_VMAG_2 ................................................................................................ 1100
OPF_LOAD_INDV ......................................................................................................... 1101
OPF_LOAD_SUBSYS ..................................................................................................... 1102
OPF_PERRSV_GEN ....................................................................................................... 1103
OPF_PERRSV_MAIN ...................................................................................................... 1104
OPF_PERRSV_RESET ..................................................................................................... 1105
PURGE_ALL_OPF_DATA ................................................................................................ 1106
PURGE_OPF_ADJBRX_INDV ........................................................................................... 1107
PURGE_OPF_ADJBRX_SUBSYS ....................................................................................... 1108
PURGE_OPF_ADJLOAD_TBL ........................................................................................... 1109
PURGE_OPF_ADJVAR_INDV ........................................................................................... 1110
PURGE_OPF_ADJVAR_INDV_3 ....................................................................................... 1111
PURGE_OPF_ADJVAR_SUBSYS ....................................................................................... 1112
PURGE_OPF_APDSP_TBL ............................................................................................... 1113
PURGE_OPF_BRFLW_3WT ............................................................................................. 1114
PURGE_OPF_BRFLW_BRN .............................................................................................. 1115
PURGE_OPF_BRFLW_SUBSYS ........................................................................................ 1116
PURGE_OPF_BUS_INDV ................................................................................................ 1117
PURGE_OPF_BUS_INDV_3 ............................................................................................ 1118
PURGE_OPF_BUS_SUBSYS ............................................................................................ 1119
PURGE_OPF_CSTTBL_LIN .............................................................................................. 1120
PURGE_OPF_CSTTBL_POLY ........................................................................................... 1121

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xiv
PURGE_OPF_CSTTBL_QUAD .......................................................................................... 1122
PURGE_OPF_GENDSP_INDV .......................................................................................... 1123
PURGE_OPF_GENDSP_SUBSYS ...................................................................................... 1124
PURGE_OPF_GENRSV_INDV .......................................................................................... 1125
PURGE_OPF_GENRSV_SUBSYS ...................................................................................... 1126
PURGE_OPF_GEN_RCAP_INDV ...................................................................................... 1127
PURGE_OPF_GEN_RCAP_SUBSYS .................................................................................. 1128
PURGE_OPF_INTFLW .................................................................................................... 1129
PURGE_OPF_INTFLW_3WT ............................................................................................ 1130
PURGE_OPF_INTFLW_BRN ............................................................................................ 1131
PURGE_OPF_LNCEQN .................................................................................................. 1132
PURGE_OPF_LNCEQN_ADJLOAD ................................................................................... 1133
PURGE_OPF_LNCEQN_ADJVAR ...................................................................................... 1134
PURGE_OPF_LNCEQN_BRFLOW ..................................................................................... 1135
PURGE_OPF_LNCEQN_INTFLOW .................................................................................... 1136
PURGE_OPF_LNCEQN_PGEN ......................................................................................... 1137
PURGE_OPF_LNCEQN_QGEN ........................................................................................ 1138
PURGE_OPF_LNCEQN_SWSHUNT .................................................................................. 1139
PURGE_OPF_LNCEQN_TRAN ......................................................................................... 1140
PURGE_OPF_LNCEQN_VANG ........................................................................................ 1141
PURGE_OPF_LNCEQN_VANG_2 ..................................................................................... 1142
PURGE_OPF_LNCEQN_VMAG ........................................................................................ 1143
PURGE_OPF_LNCEQN_VMAG_2 .................................................................................... 1144
PURGE_OPF_LOAD_INDV .............................................................................................. 1145
PURGE_OPF_LOAD_SUBSYS .......................................................................................... 1146
PURGE_OPF_PERRSV .................................................................................................... 1147
PURGE_OPF_PERRSV_GEN ............................................................................................ 1148
Dynamics Simulation ................................................................................................................... 1150
Dynamic Simulation Operation ............................................................................................ 1151
ADDMODELLIBRARY ..................................................................................................... 1151
ASTR .......................................................................................................................... 1152
AULIST ....................................................................................................................... 1155
CHANGE_CHANNEL_OUT_FILE ...................................................................................... 1156
CHANGE_CHRICN ........................................................................................................ 1157
CHANGE_CON ............................................................................................................. 1158
CHANGE_GREF ............................................................................................................ 1159
CHANGE_ICON ............................................................................................................ 1160
CHANGE_STATE ........................................................................................................... 1161
CHANGE_SWSREF ........................................................................................................ 1162
CHANGE_VAR .............................................................................................................. 1163
CHANGE_VREF ............................................................................................................ 1164
DCLIST ....................................................................................................................... 1165
DLST .......................................................................................................................... 1166
DOCU ......................................................................................................................... 1167
DROPMODELLIBRARY ................................................................................................... 1169
DROPMODELPROGRAM ................................................................................................ 1170
DYDA ......................................................................................................................... 1171
DYNAMICSMODE ......................................................................................................... 1174
DYNAMICS_SOLUTION_PARAMS ................................................................................... 1175
DYNAMICS_SOLUTION_PARAM_2 .................................................................................. 1177
DYNEXPORTCSV .......................................................................................................... 1179

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xv
DYRE_ADD .................................................................................................................. 1180
DYRE_NEW ................................................................................................................. 1181
ERUN ......................................................................................................................... 1182
ESTR_OPEN_CIRCUIT_TEST ........................................................................................... 1183
ESTR_RESPONSE_RATIO_TEST ....................................................................................... 1184
FCLIST ........................................................................................................................ 1186
GRUN ......................................................................................................................... 1187
GSTR .......................................................................................................................... 1188
INCREMENT_GREF ....................................................................................................... 1189
INCREMENT_SWSREF ................................................................................................... 1190
INCREMENT_VREF ....................................................................................................... 1191
LDLIST ........................................................................................................................ 1192
LOAD_ARRAY_CHANNEL ............................................................................................... 1193
MLST ......................................................................................................................... 1194
MRUN ........................................................................................................................ 1196
MSTR ......................................................................................................................... 1197
POWERFLOWMODE ..................................................................................................... 1198
PSAS .......................................................................................................................... 1199
RLLIST ........................................................................................................................ 1200
RSTR .......................................................................................................................... 1201
RUN ........................................................................................................................... 1202
RWDY ......................................................................................................................... 1203
SET_CHNFIL_TYPE ....................................................................................................... 1204
SET_DISABLE_RUN ....................................................................................................... 1205
SET_FREQ_RELAY_V_THRESH ........................................................................................ 1206
SET_GENANG .............................................................................................................. 1207
SET_GENANG_2 .......................................................................................................... 1208
SET_GENANG_3 .......................................................................................................... 1210
SET_GENANG_SUBSYS_FLAG ........................................................................................ 1212
SET_GENPWR .............................................................................................................. 1213
SET_GENSPDEV ........................................................................................................... 1214
SET_GENSPDEV_SUBSYS_FLAG ..................................................................................... 1215
SET_LOAD_MODEL_THRESH ......................................................................................... 1216
SET_MODEL_DEBUG_OUTPUT_FLAG ............................................................................. 1217
SET_NETFRQ ............................................................................................................... 1218
SET_NEXT_CHANNEL ................................................................................................... 1219
SET_NEXT_ICON .......................................................................................................... 1220
SET_NEXT_VAR ........................................................................................................... 1221
SET_OSSCAN .............................................................................................................. 1222
SET_OSSCAN_SUBSYS_FLAG ........................................................................................ 1223
SET_RELANG ............................................................................................................... 1224
SET_RELSCN ............................................................................................................... 1226
SET_RELSCN_SUBSYS_FLAG ......................................................................................... 1227
SET_VLTSCN ................................................................................................................ 1228
SET_VLTSCN_SUBSYS_FLAG .......................................................................................... 1229
SET_VOLTAGE_DIP_CHECK ............................................................................................ 1230
SET_VOLTAGE_REC_CHECK ........................................................................................... 1231
SET_VOLT_VIOL_SUBSYS_FLAG ..................................................................................... 1233
SET_ZSORCE_RECONCILE_FLAG .................................................................................... 1234
SIZE_DS ...................................................................................................................... 1235
SNAP .......................................................................................................................... 1236

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xvi
STRT .......................................................................................................................... 1237
STRT_2 ....................................................................................................................... 1238
SWSLIST ..................................................................................................................... 1239
TRIG_VOLT_VIOLATION_CHECK ..................................................................................... 1240
WNLIST ...................................................................................................................... 1241
Output Chanel Operations ................................................................................................... 1244
Dynamic Simulation Output Channel Operation ............................................................ 1244
CHANGE_CHANNEL ............................................................................................. 1244
CHSB .................................................................................................................. 1245
CRT_PLOT_CHANNEL ........................................................................................... 1248
DELETE_ALL_PLOT_CHANNELS ............................................................................. 1249
DMPC ................................................................................................................. 1250
LIST_CHANNEL_MODELS ...................................................................................... 1252
REMOVE_UNUSED_CHAN_MODELS ....................................................................... 1253
Assign Machine Quantities to Output Channels ............................................................. 1255
MACHINE_APP_R_X_CHANNEL .............................................................................. 1255
MACHINE_ARRAY_CHANNEL ................................................................................. 1257
MACHINE_ITERM_CHANNEL ................................................................................. 1259
Assign Branch Quantities to Output Channels ............................................................... 1262
BRANCH_APP_R_X_CHANNEL ............................................................................... 1262
BRANCH_MVA_CHANNEL ..................................................................................... 1264
BRANCH_P_AND_Q_CHANNEL .............................................................................. 1266
BRANCH_P_CHANNEL .......................................................................................... 1268
THREE_WND_APP_R_X_CHANNEL ......................................................................... 1270
THREE_WND_MVA_CHANNEL ............................................................................... 1272
THREE_WND_P_AND_Q_CHANNEL ........................................................................ 1274
THREE_WND_P_CHANNEL .................................................................................... 1276
Assign Other Quantities to Output Channels ................................................................. 1279
BUS_FREQUENCY_CHANNEL ................................................................................. 1279
STATE_CHANNEL ................................................................................................. 1280
VAR_CHANNEL .................................................................................................... 1281
VOLTAGE_AND_ANGLE_CHANNEL ......................................................................... 1282
VOLTAGE_CHANNEL ............................................................................................. 1284
Plant Related Models ........................................................................................................... 1287
ADD_PLANT_MODEL .................................................................................................... 1287
CHANGE_PLMOD_CHRICN ............................................................................................ 1289
CHANGE_PLMOD_CON ................................................................................................ 1290
CHANGE_PLMOD_DATA ............................................................................................... 1291
CHANGE_PLMOD_ICON ................................................................................................ 1293
CHANGE_PLMOD_VAR ................................................................................................. 1294
GMB_ADD_PLANT_MODEL ........................................................................................... 1295
PLMOD_CONSISTENCY ................................................................................................. 1297
PLMOD_PACK .............................................................................................................. 1298
PLMOD_REMOVE ......................................................................................................... 1299
PLMOD_STATUS .......................................................................................................... 1300
PLMOD_UNCONNECTED ............................................................................................... 1301
PLMOD_USER .............................................................................................................. 1302
Wind Related Models .......................................................................................................... 1304
ADD_WIND_MODEL ..................................................................................................... 1304
CHANGE_WNMOD_CHRICN .......................................................................................... 1306
CHANGE_WNMOD_CON ............................................................................................... 1307

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xvii
CHANGE_WNMOD_ICON .............................................................................................. 1308
CHANGE_WNMOD_VAR ............................................................................................... 1309
WNMOD_CONSISTENCY ............................................................................................... 1310
WNMOD_PACK ............................................................................................................ 1311
WNMOD_REMOVE ....................................................................................................... 1312
WNMOD_STATUS ......................................................................................................... 1313
WNMOD_UNCONNECTED ............................................................................................. 1314
WNMOD_USER ............................................................................................................ 1315
Load Related Models ........................................................................................................... 1317
ADD_LOAD_MODEL ..................................................................................................... 1317
CHANGE_LDMOD_CHRICN ........................................................................................... 1319
CHANGE_LDMOD_CON ................................................................................................ 1320
CHANGE_LDMOD_DATA ............................................................................................... 1321
CHANGE_LDMOD_ICON ............................................................................................... 1323
CHANGE_LDMOD_VAR ................................................................................................. 1324
LDMOD_PACK ............................................................................................................. 1325
LDMOD_REMOVE ........................................................................................................ 1326
LDMOD_STATUS .......................................................................................................... 1327
LDMOD_STATUS2 ........................................................................................................ 1328
LDMOD_UNCONNECTED .............................................................................................. 1329
LDMOD_USER ............................................................................................................. 1330
Line Relay Models ............................................................................................................... 1332
ADD_RELAY_MODEL .................................................................................................... 1332
CHANGE_RLMOD_CHRICN ............................................................................................ 1334
CHANGE_RLMOD_CON ................................................................................................ 1335
CHANGE_RLMOD_DATA ............................................................................................... 1336
CHANGE_RLMOD_ICON ............................................................................................... 1338
CHANGE_RLMOD_VAR ................................................................................................. 1339
RLMOD_PACK .............................................................................................................. 1340
RLMOD_REMOVE ......................................................................................................... 1341
RLMOD_STATUS .......................................................................................................... 1342
RLMOD_UNCONNECTED .............................................................................................. 1343
RLMOD_USER .............................................................................................................. 1344
DC Line Related Models ....................................................................................................... 1346
ADD_MTDCLINE_MODEL .............................................................................................. 1346
ADD_TTDCLINE_MODEL ............................................................................................... 1348
ADD_VSDCLINE_MODEL ............................................................................................... 1350
CHANGE_MTDCLMOD_CHRICN ..................................................................................... 1351
CHANGE_MTDCLMOD_CON ......................................................................................... 1352
CHANGE_MTDCLMOD_DATA ......................................................................................... 1353
CHANGE_MTDCLMOD_ICON ......................................................................................... 1355
CHANGE_MTDCLMOD_VAR .......................................................................................... 1356
CHANGE_TTDCLMOD_CHRICN ...................................................................................... 1357
CHANGE_TTDCLMOD_CON .......................................................................................... 1358
CHANGE_TTDCLMOD_DATA ......................................................................................... 1359
CHANGE_TTDCLMOD_ICON .......................................................................................... 1361
CHANGE_TTDCLMOD_VAR ........................................................................................... 1362
CHANGE_VSDCLMOD_CHRICN ...................................................................................... 1363
CHANGE_VSDCLMOD_CON .......................................................................................... 1364
CHANGE_VSDCLMOD_DATA ......................................................................................... 1365
CHANGE_VSDCLMOD_ICON ......................................................................................... 1367

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xviii
CHANGE_VSDCLMOD_VAR ........................................................................................... 1368
DCLMOD_PACK ........................................................................................................... 1369
DCLMOD_UNCONNECTED ............................................................................................ 1370
DCLMOD_USER ........................................................................................................... 1371
MTDCLMOD_REMOVE .................................................................................................. 1372
MTDCLMOD_STATUS ................................................................................................... 1373
TTDCLMOD_REMOVE ................................................................................................... 1374
TTDCLMOD_STATUS .................................................................................................... 1375
VSDCLMOD_REMOVE ................................................................................................... 1376
VSDCLMOD_STATUS .................................................................................................... 1377
FACTS Device Models .......................................................................................................... 1379
ADD_FACTS_DEVICE_MODEL ........................................................................................ 1379
CHANGE_FCTMOD_CHRICN .......................................................................................... 1381
CHANGE_FCTMOD_CON .............................................................................................. 1382
CHANGE_FCTMOD_DATA ............................................................................................. 1383
CHANGE_FCTMOD_ICON .............................................................................................. 1385
CHANGE_FCTMOD_VAR ............................................................................................... 1386
FCTMOD_PACK ............................................................................................................ 1387
FCTMOD_REMOVE ....................................................................................................... 1388
FCTMOD_STATUS ........................................................................................................ 1389
FCTMOD_UNCONNECTED ............................................................................................ 1390
FCTMOD_USER ............................................................................................................ 1391
GMB_ADD_FACTS_DEV_MODEL .................................................................................... 1392
Switched Shunt Models ....................................................................................................... 1395
ADD_SWSHUNT_MODEL .............................................................................................. 1395
CHANGE_SWSMOD_CHRICN ......................................................................................... 1397
CHANGE_SWSMOD_CON ............................................................................................. 1398
CHANGE_SWSMOD_ICON ............................................................................................. 1399
CHANGE_SWSMOD_VAR .............................................................................................. 1400
GMB_ADD_SWSHUNT_MODEL ...................................................................................... 1401
SWSMOD_PACK ........................................................................................................... 1403
SWSMOD_REMOVE ...................................................................................................... 1404
SWSMOD_STATUS ....................................................................................................... 1405
SWSMOD_UNCONNECTED ............................................................................................ 1406
SWSMOD_USER ........................................................................................................... 1407
Auxiliary Signal Models ....................................................................................................... 1409
ADD_FCTSAUXSIGNAL_MODEL ..................................................................................... 1409
ADD_MTDCAUXSIGNAL_MODEL ................................................................................... 1411
ADD_TTDCAUXSIGNAL_MODEL .................................................................................... 1413
ADD_VSDCAUXSIGNAL_MODEL .................................................................................... 1415
AUXMOD_PACK ........................................................................................................... 1417
AUXMOD_UNCONNECTED ............................................................................................ 1418
AUXMOD_USER ........................................................................................................... 1419
CHANGE_FCTSAUXMOD_CHRICN .................................................................................. 1420
CHANGE_FCTSAUXMOD_CON ...................................................................................... 1422
CHANGE_FCTSAUXMOD_DATA ..................................................................................... 1424
CHANGE_FCTSAUXMOD_ICON ...................................................................................... 1426
CHANGE_FCTSAUXMOD_VAR ....................................................................................... 1428
CHANGE_MTDCAUXMOD_CHRICN ................................................................................ 1430
CHANGE_MTDCAUXMOD_CON ..................................................................................... 1432
CHANGE_MTDCAUXMOD_DATA .................................................................................... 1434

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xix
CHANGE_MTDCAUXMOD_ICON .................................................................................... 1436
CHANGE_MTDCAUXMOD_VAR ...................................................................................... 1438
CHANGE_TTDCAUXMOD_CHRICN ................................................................................. 1440
CHANGE_TTDCAUXMOD_CON ...................................................................................... 1442
CHANGE_TTDCAUXMOD_DATA ..................................................................................... 1444
CHANGE_TTDCAUXMOD_ICON ..................................................................................... 1446
CHANGE_TTDCAUXMOD_VAR ...................................................................................... 1448
CHANGE_VSDCAUXMOD_CHRICN ................................................................................. 1450
CHANGE_VSDCAUXMOD_CON ...................................................................................... 1451
CHANGE_VSDCAUXMOD_DATA ..................................................................................... 1452
CHANGE_VSDCAUXMOD_ICON ..................................................................................... 1454
CHANGE_VSDCAUXMOD_VAR ...................................................................................... 1455
FCTSAUXMOD_REMOVE ............................................................................................... 1456
FCTSAUXMOD_STATUS ................................................................................................ 1457
MTDCAUXMOD_REMOVE ............................................................................................. 1458
MTDCAUXMOD_STATUS ............................................................................................... 1459
TTDCAUXMOD_REMOVE .............................................................................................. 1460
TTDCAUXMOD_STATUS ................................................................................................ 1461
VSDCAUXMOD_REMOVE .............................................................................................. 1462
VSDCAUXMOD_STATUS ................................................................................................ 1463
Induction Machine Models .................................................................................................. 1465
ADD_INDMAC_MODEL ................................................................................................. 1465
CHANGE_IMMOD_CHRICN ............................................................................................ 1467
CHANGE_IMMOD_CON ................................................................................................ 1468
CHANGE_IMMOD_ICON ............................................................................................... 1469
CHANGE_IMMOD_VAR ................................................................................................. 1470
IMMOD_PACK ............................................................................................................. 1471
IMMOD_REMOVE ........................................................................................................ 1472
IMMOD_STATUS .......................................................................................................... 1473
IMMOD_UNCONNECTED .............................................................................................. 1474
IMMOD_USER ............................................................................................................. 1475
CCT Models ........................................................................................................................ 1477
ADD_CCT2DCO_MODEL ............................................................................................... 1477
ADD_CCT2WTD_MODEL ............................................................................................... 1479
ADD_CCT3WTD_MODEL ............................................................................................... 1481
ADD_CCTBRND_MODEL ............................................................................................... 1483
ADD_CCTBRNO_MODEL ............................................................................................... 1485
ADD_CCTBUSO_MODEL ............................................................................................... 1487
ADD_CCTMCNO_MODEL .............................................................................................. 1488
ADD_CCTMCNP_MODEL ............................................................................................... 1490
ADD_CCTMSCO_MODEL ............................................................................................... 1492
ADD_CCTSWSO_MODEL ............................................................................................... 1493
CCT2DCOMOD_REMOVE .............................................................................................. 1495
CCT2DCOMOD_STATUS ................................................................................................ 1496
CCT2DCO_LIST ............................................................................................................ 1497
CCT2WTDMOD_REMOVE .............................................................................................. 1498
CCT2WTDMOD_STATUS ............................................................................................... 1499
CCT2WTD_LIST ............................................................................................................ 1500
CCT3WTDMOD_REMOVE .............................................................................................. 1501
CCT3WTDMOD_STATUS ............................................................................................... 1502
CCT3WTD_LIST ............................................................................................................ 1503

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xx
CCTBRNDMOD_REMOVE .............................................................................................. 1504
CCTBRNDMOD_STATUS ................................................................................................ 1505
CCTBRND_LIST ............................................................................................................ 1506
CCTBRNOMOD_REMOVE .............................................................................................. 1507
CCTBRNOMOD_STATUS ................................................................................................ 1508
CCTBRNO_LIST ............................................................................................................ 1509
CCTBUSOMOD_REMOVE .............................................................................................. 1510
CCTBUSOMOD_STATUS ................................................................................................ 1511
CCTBUSO_LIST ............................................................................................................ 1512
CCTMCNOMOD_REMOVE ............................................................................................. 1513
CCTMCNOMOD_STATUS ............................................................................................... 1514
CCTMCNO_LIST ........................................................................................................... 1515
CCTMCNPMOD_REMOVE .............................................................................................. 1516
CCTMCNPMOD_STATUS ............................................................................................... 1517
CCTMCNP_LIST ............................................................................................................ 1518
CCTMOD_PACK ........................................................................................................... 1519
CCTMOD_USER ........................................................................................................... 1520
CCTMSCOMOD_REMOVE .............................................................................................. 1521
CCTMSCOMOD_STATUS ............................................................................................... 1522
CCTMSCO_LIST ............................................................................................................ 1523
CCTSWSOMOD_REMOVE .............................................................................................. 1524
CCTSWSOMOD_STATUS ............................................................................................... 1525
CCTSWSO_LIST ............................................................................................................ 1526
CHANGE_CCT2DCOMOD_CHRICN ................................................................................. 1527
CHANGE_CCT2DCOMOD_CON ...................................................................................... 1528
CHANGE_CCT2DCOMOD_ICON ..................................................................................... 1529
CHANGE_CCT2DCOMOD_VAR ....................................................................................... 1530
CHANGE_CCT2WTDMOD_CHRICN ................................................................................. 1531
CHANGE_CCT2WTDMOD_CON ..................................................................................... 1532
CHANGE_CCT2WTDMOD_ICON ..................................................................................... 1533
CHANGE_CCT2WTDMOD_VAR ...................................................................................... 1534
CHANGE_CCT3WTDMOD_CHRICN ................................................................................. 1535
CHANGE_CCT3WTDMOD_CON ..................................................................................... 1536
CHANGE_CCT3WTDMOD_ICON ..................................................................................... 1537
CHANGE_CCT3WTDMOD_VAR ...................................................................................... 1538
CHANGE_CCTBRNDMOD_CHRICN .................................................................................. 1539
CHANGE_CCTBRNDMOD_CON ...................................................................................... 1540
CHANGE_CCTBRNDMOD_ICON ..................................................................................... 1541
CHANGE_CCTBRNDMOD_VAR ....................................................................................... 1542
CHANGE_CCTBRNOMOD_CHRICN ................................................................................. 1543
CHANGE_CCTBRNOMOD_CON ...................................................................................... 1544
CHANGE_CCTBRNOMOD_ICON ..................................................................................... 1545
CHANGE_CCTBRNOMOD_VAR ....................................................................................... 1546
CHANGE_CCTBUSOMOD_CHRICN ................................................................................. 1547
CHANGE_CCTBUSOMOD_CON ...................................................................................... 1548
CHANGE_CCTBUSOMOD_ICON ..................................................................................... 1549
CHANGE_CCTBUSOMOD_VAR ....................................................................................... 1550
CHANGE_CCTMCNOMOD_CHRICN ................................................................................ 1551
CHANGE_CCTMCNOMOD_CON ..................................................................................... 1552
CHANGE_CCTMCNOMOD_ICON .................................................................................... 1553
CHANGE_CCTMCNOMOD_VAR ..................................................................................... 1554

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxi
CHANGE_CCTMCNPMOD_CHRICN ................................................................................. 1555
CHANGE_CCTMCNPMOD_CON ..................................................................................... 1556
CHANGE_CCTMCNPMOD_ICON ..................................................................................... 1557
CHANGE_CCTMCNPMOD_VAR ...................................................................................... 1558
CHANGE_CCTMSCOMOD_CHRICN ................................................................................. 1559
CHANGE_CCTMSCOMOD_CON ..................................................................................... 1560
CHANGE_CCTMSCOMOD_ICON ..................................................................................... 1561
CHANGE_CCTMSCOMOD_VAR ...................................................................................... 1562
CHANGE_CCTSWSOMOD_CHRICN ................................................................................. 1563
CHANGE_CCTSWSOMOD_CON ..................................................................................... 1564
CHANGE_CCTSWSOMOD_ICON ..................................................................................... 1565
CHANGE_CCTSWSOMOD_VAR ...................................................................................... 1566
Set Disturbance .................................................................................................................. 1568
DIST_3WIND_CLOSE .................................................................................................... 1568
DIST_3WIND_FAULT ..................................................................................................... 1569
DIST_3WIND_TRIP ........................................................................................................ 1571
DIST_BRANCH_CLOSE .................................................................................................. 1572
DIST_BRANCH_FAULT ................................................................................................... 1573
DIST_BRANCH_TRIP ..................................................................................................... 1575
DIST_BUS_FAULT ......................................................................................................... 1576
DIST_BUS_FAULT_2 ..................................................................................................... 1578
DIST_BUS_TRIP ............................................................................................................ 1580
DIST_CLEAR_FAULT ...................................................................................................... 1581
DIST_MACHINE_TRIP .................................................................................................... 1582
DIST_SCMU_FAULT ...................................................................................................... 1583
DIST_SCMU_FAULT_2 ................................................................................................... 1585
DIST_SPCB_FAULT ........................................................................................................ 1587
DIST_SPCB_FAULT_2 .................................................................................................... 1589
Subsystem Definition .................................................................................................................. 1592
Area Subsystems ................................................................................................................. 1593
ASYS .......................................................................................................................... 1593
ASYSDEF .................................................................................................................... 1594
ASYSINIT .................................................................................................................... 1595
Bus Subsystems .................................................................................................................. 1597
BSYS .......................................................................................................................... 1597
BSYSADD .................................................................................................................... 1599
BSYSDEF ..................................................................................................................... 1601
BSYSDELO .................................................................................................................. 1602
BSYSINIT ..................................................................................................................... 1603
BSYSMEM ................................................................................................................... 1604
BSYSO ........................................................................................................................ 1605
BSYSRCL ..................................................................................................................... 1606
Owner Subsystems ............................................................................................................. 1608
OSYS .......................................................................................................................... 1608
OSYSDEF .................................................................................................................... 1609
OSYSINIT .................................................................................................................... 1610
Zone Subsystems ................................................................................................................ 1612
ZSYS .......................................................................................................................... 1612
ZSYSDEF ..................................................................................................................... 1613
ZSYSINIT ..................................................................................................................... 1614
Diagram View ............................................................................................................................. 1616

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxii
CHANGEDIAGCONTOUR ....................................................................................................... 1617
CHECKDIAGFILE ................................................................................................................... 1619
CLOSEDIAGFILE ................................................................................................................... 1620
DELETEDIAGCONTOUR ......................................................................................................... 1621
ENABLEDIAGCONTOUR ........................................................................................................ 1622
EXPORTBUSLOCFILE ............................................................................................................. 1624
EXPORTIMAGEFILE ............................................................................................................... 1625
GEXMBUS ........................................................................................................................... 1626
GROWBUS .......................................................................................................................... 1627
GROWBUSLEVELS ................................................................................................................ 1628
GROWDIAGRAM .................................................................................................................. 1629
GROWDIAGRAM_2 ............................................................................................................... 1630
GROWSTATION .................................................................................................................... 1632
GRPG ................................................................................................................................. 1633
IMPORTDRAWFILE ............................................................................................................... 1634
IMPORTIMAGEFILE ............................................................................................................... 1635
NEWDIAGFILE ..................................................................................................................... 1636
NEXTDIAGFILEDATASET ........................................................................................................ 1637
OPENACCFILE ...................................................................................................................... 1638
OPENACCFILE_2 .................................................................................................................. 1639
OPENBUSLOCFILE ................................................................................................................ 1640
OPENDIAGFILE .................................................................................................................... 1641
PREVDIAGFILEDATASET ........................................................................................................ 1642
PRINTDIAGFILE .................................................................................................................... 1643
REFRESHDIAGCONTOUR ....................................................................................................... 1644
REFRESHDIAGFILE ................................................................................................................ 1645
RENUMDIAGFILE ................................................................................................................. 1646
SAVEDIAGFILE ..................................................................................................................... 1647
SETDIAGAUTOFILE ............................................................................................................... 1648
SETDIAGFONT ..................................................................................................................... 1649
SETDIAGPREC ...................................................................................................................... 1650
SETDIAGPREC_2 .................................................................................................................. 1651
SETDIAGPROP ..................................................................................................................... 1652
SETDIAGPROP_2 .................................................................................................................. 1655
SETDIAGPROP_3 .................................................................................................................. 1658
SETDIAGPROP_4 .................................................................................................................. 1661
SETDIAGPROP_5 .................................................................................................................. 1664
SETDIAGRESACCC ................................................................................................................ 1667
SETDIAGRESACCC_2 ............................................................................................................ 1668
SETDIAGRESACCC_3 ............................................................................................................ 1669
SETDIAGRESASCC ................................................................................................................ 1670
SETDIAGRESASCC_2 ............................................................................................................ 1672
SETDIAGRESASCC_3 ............................................................................................................ 1674
SETDIAGRESDATA ................................................................................................................ 1676
SETDIAGRESDATA_2 ............................................................................................................. 1679
SETDIAGRESDATA_3 ............................................................................................................. 1680
SETDIAGRESDYN ................................................................................................................. 1681
SETDIAGRESDYN_2 .............................................................................................................. 1682
SETDIAGRESGDIF ................................................................................................................. 1683
SETDIAGRESIEC ................................................................................................................... 1686
SETDIAGRESIEC_2 ................................................................................................................ 1688

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxiii
SETDIAGRESIEC_3 ................................................................................................................ 1690
SETDIAGRESOPF .................................................................................................................. 1692
SETDIAGRESOPF_2 .............................................................................................................. 1693
SETDIAGRESOPF_3 .............................................................................................................. 1694
SETDIAGRESPFLOWCHECK .................................................................................................... 1695
SETDIAGRESPFLOWCHECK_2 ................................................................................................ 1699
SETDIAGRESPFLOWCHECK_3 ................................................................................................ 1702
SETDIAGRESPFLOWOPTIONS ................................................................................................. 1705
SETDIAGRESPFLOWOPTIONS_2 ............................................................................................. 1707
SETDIAGRESPFLOWOPTIONS_3 ............................................................................................. 1709
SETDIAGRESREL ................................................................................................................... 1711
SETDIAGRESREL_2 ............................................................................................................... 1713
SETDIAGRESREL_3 ............................................................................................................... 1715
SETDIAGRESSCGR ................................................................................................................ 1717
SETDIAGRESTYPEACC ........................................................................................................... 1720
SETDIAGRESTYPEASCC ......................................................................................................... 1721
SETDIAGRESTYPEDATA ......................................................................................................... 1722
SETDIAGRESTYPEDYN .......................................................................................................... 1723
SETDIAGRESTYPEGDIF .......................................................................................................... 1724
SETDIAGRESTYPEGIC ............................................................................................................ 1725
SETDIAGRESTYPEHARM ........................................................................................................ 1726
SETDIAGRESTYPEIEC ............................................................................................................ 1727
SETDIAGRESTYPEOPF ........................................................................................................... 1728
SETDIAGRESTYPEPFLOW ....................................................................................................... 1729
SETDIAGRESTYPEREL ........................................................................................................... 1730
SETDIAGRESTYPESCGR ......................................................................................................... 1731
SETDIAGRESVRCS ................................................................................................................ 1732
SETDIAGRESVRCS_2 ............................................................................................................. 1735
SETDIAGTITLE ..................................................................................................................... 1738
SWITCHDIAGFILEDATASET .................................................................................................... 1739
UPDATEBUSLOCDIAGFILE ..................................................................................................... 1740
Single Element Data ................................................................................................................... 1741
APIERRSTR .......................................................................................................................... 1742
ARDAT ................................................................................................................................ 1743
AREDAT .............................................................................................................................. 1745
AREINT ............................................................................................................................... 1746
ARENAM ............................................................................................................................. 1747
ARENUM ............................................................................................................................ 1748
AREUSE .............................................................................................................................. 1749
ARITOJ ............................................................................................................................... 1750
BRNCUR .............................................................................................................................. 1751
BRNDAT .............................................................................................................................. 1752
BRNDT2 .............................................................................................................................. 1754
BRNFLO .............................................................................................................................. 1756
BRNINT ............................................................................................................................... 1757
BRNMSC ............................................................................................................................. 1759
BRNMVA ............................................................................................................................. 1761
BRNNAM ............................................................................................................................ 1762
BRNSTT .............................................................................................................................. 1763
BSYSISDEF .......................................................................................................................... 1764
BUSDAT .............................................................................................................................. 1765

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxiv
BUSDT1 .............................................................................................................................. 1766
BUSDT2 .............................................................................................................................. 1768
BUSEXS .............................................................................................................................. 1770
BUSINT ............................................................................................................................... 1771
BUSMSM ............................................................................................................................ 1772
BUSORDPOS ....................................................................................................................... 1773
BUSSECTDAT ....................................................................................................................... 1774
BUSSECTDT1 ....................................................................................................................... 1775
BUSSECTDT2 ....................................................................................................................... 1777
BUSSECTEXS ....................................................................................................................... 1779
BUSSECTINT ........................................................................................................................ 1780
CCTMDLNAM_2WTD ............................................................................................................ 1781
CCTMDLNAM_3WTD ............................................................................................................ 1782
CCTMDLNAM_BRND ............................................................................................................ 1783
CCTMDLNAM_MSCO ............................................................................................................ 1784
CCTMIND_2DCO .................................................................................................................. 1785
CCTMIND_2WTD ................................................................................................................. 1786
CCTMIND_3WTD ................................................................................................................. 1788
CCTMIND_BRND .................................................................................................................. 1790
CCTMIND_BRNO .................................................................................................................. 1792
CCTMIND_BUSO .................................................................................................................. 1794
CCTMIND_MCNO ................................................................................................................. 1795
CCTMIND_MCNP ................................................................................................................. 1796
CCTMIND_MSCO ................................................................................................................. 1797
CCTMIND_SWSO ................................................................................................................. 1798
CHKTRE .............................................................................................................................. 1800
CHNVAL ............................................................................................................................. 1801
DC2AUXMIND ..................................................................................................................... 1802
DC2AUXMNAM ................................................................................................................... 1804
DC2DAT .............................................................................................................................. 1805
DC2DAT_2 .......................................................................................................................... 1807
DC2INT ............................................................................................................................... 1809
DC2INT_2 ........................................................................................................................... 1810
DC2MIND ........................................................................................................................... 1811
DC2MNAM ......................................................................................................................... 1813
DCNAUXMIND ..................................................................................................................... 1814
DCNAUXMNAM ................................................................................................................... 1816
DCNCIN .............................................................................................................................. 1817
DCNCIN_2 .......................................................................................................................... 1818
DCNDAT ............................................................................................................................. 1819
DCNDAT_2 .......................................................................................................................... 1821
DCNINT .............................................................................................................................. 1823
DCNINT_2 ........................................................................................................................... 1824
DCNMIND ........................................................................................................................... 1825
DCNMNAM ......................................................................................................................... 1827
DSCVAL .............................................................................................................................. 1828
DSIVAL ............................................................................................................................... 1829
DSRVAL .............................................................................................................................. 1830
FCDAUXMIND ..................................................................................................................... 1831
FCDAUXMNAM ................................................................................................................... 1833
FCDDAT .............................................................................................................................. 1834

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxv
FCDDAT_2 .......................................................................................................................... 1837
FCDINT ............................................................................................................................... 1840
FCDINT_2 ........................................................................................................................... 1841
FCDMIND ........................................................................................................................... 1842
FCDMNAM .......................................................................................................................... 1843
FXSDT1 .............................................................................................................................. 1844
FXSDT2 .............................................................................................................................. 1846
FXSINT ............................................................................................................................... 1848
GENCNV ............................................................................................................................. 1849
GENDAT ............................................................................................................................. 1850
GENDT1 ............................................................................................................................. 1851
GENSECTDAT ...................................................................................................................... 1852
GENSECTDT1 ...................................................................................................................... 1853
GETHOMEPATH ................................................................................................................... 1854
GET_MSTATE ....................................................................................................................... 1855
GNECHR ............................................................................................................................. 1856
GNEDAT ............................................................................................................................. 1857
GNEINT .............................................................................................................................. 1858
INDDT1 .............................................................................................................................. 1860
INDDT2 .............................................................................................................................. 1862
INDINT ............................................................................................................................... 1864
INI2DC ............................................................................................................................... 1866
INIBRN ............................................................................................................................... 1867
INIBRN_2 ............................................................................................................................ 1868
INIBRX ................................................................................................................................ 1869
INIBRX_2 ............................................................................................................................ 1870
INIBUS ................................................................................................................................ 1871
INIBUS_2 ............................................................................................................................ 1872
INIBUX ............................................................................................................................... 1873
INIFAX ................................................................................................................................ 1874
INIFXS ................................................................................................................................ 1875
INIIND ................................................................................................................................ 1876
INILOD ............................................................................................................................... 1877
INIMAC ............................................................................................................................... 1878
INIMDC .............................................................................................................................. 1879
INIMSL ............................................................................................................................... 1880
ININAM .............................................................................................................................. 1881
ININAM_2 ........................................................................................................................... 1882
ININAX ............................................................................................................................... 1883
INISTABUSSECT ................................................................................................................... 1884
INISTANODE ........................................................................................................................ 1885
INISTASWDEV ...................................................................................................................... 1886
INITIE ................................................................................................................................. 1887
INITIX ................................................................................................................................. 1888
INIVSC ................................................................................................................................ 1889
ISLAND ............................................................................................................................... 1890
ITERAT ................................................................................................................................ 1891
LMODIND ........................................................................................................................... 1892
LMODNAM ......................................................................................................................... 1894
LODCNV ............................................................................................................................. 1895
LODDT1 .............................................................................................................................. 1896

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxvi
LODDT2 .............................................................................................................................. 1898
LODIND .............................................................................................................................. 1900
LODINT .............................................................................................................................. 1901
MACDAT ............................................................................................................................. 1902
MACDT2 ............................................................................................................................. 1904
MACIND ............................................................................................................................. 1906
MACINT .............................................................................................................................. 1907
MACSTT ............................................................................................................................. 1909
MAXMSM ........................................................................................................................... 1910
MDLIND .............................................................................................................................. 1911
MDLLIBCNT ......................................................................................................................... 1913
MDLNAM ............................................................................................................................ 1914
MDLPGMCNT ...................................................................................................................... 1915
NATONO ............................................................................................................................. 1916
NOTONA ............................................................................................................................ 1917
NOTONASECT ..................................................................................................................... 1918
NXT2DC ............................................................................................................................. 1919
NXTBRN ............................................................................................................................. 1920
NXTBRN3 ............................................................................................................................ 1921
NXTBRN3_2 ........................................................................................................................ 1922
NXTBRN_2 .......................................................................................................................... 1923
NXTBUS .............................................................................................................................. 1924
NXTBUS_2 .......................................................................................................................... 1925
NXTFAX .............................................................................................................................. 1926
NXTFXS .............................................................................................................................. 1927
NXTIND .............................................................................................................................. 1928
NXTLOD ............................................................................................................................. 1929
NXTMAC ............................................................................................................................. 1930
NXTMDC ............................................................................................................................ 1931
NXTMSL ............................................................................................................................. 1932
NXTSTABUSSECT ................................................................................................................. 1933
NXTSTANODE ..................................................................................................................... 1934
NXTSTASWDEV .................................................................................................................... 1935
NXTTIE ............................................................................................................................... 1936
NXTTIE3 ............................................................................................................................. 1937
NXTVSC .............................................................................................................................. 1938
OKSTRT .............................................................................................................................. 1939
OPENUN ............................................................................................................................. 1940
ORDBUS ............................................................................................................................. 1941
ORDBUSSECT ...................................................................................................................... 1942
OWNDAT ............................................................................................................................ 1943
OWNNAM ........................................................................................................................... 1945
OWNNUM ........................................................................................................................... 1946
OWNUSE ............................................................................................................................ 1947
PRMDAT ............................................................................................................................. 1948
PRMINT .............................................................................................................................. 1950
RATCHR .............................................................................................................................. 1951
RMODIND ........................................................................................................................... 1952
RMODNAM ......................................................................................................................... 1954
SBSGTBKV .......................................................................................................................... 1955
SC3WND ............................................................................................................................. 1956

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxvii
SCBRN2 .............................................................................................................................. 1958
SCBUS2 .............................................................................................................................. 1959
SCDONE ............................................................................................................................. 1961
SCINIT ................................................................................................................................ 1962
SCMAC2 ............................................................................................................................. 1963
SELCTR ............................................................................................................................... 1964
SETHOMEPATH .................................................................................................................... 1965
SFILES ................................................................................................................................ 1966
SLMODIND ......................................................................................................................... 1967
SLMODNAM ........................................................................................................................ 1969
SOLSTR .............................................................................................................................. 1970
SOLVED .............................................................................................................................. 1971
SOLVED_CA ........................................................................................................................ 1972
STADAT .............................................................................................................................. 1973
STAINT ............................................................................................................................... 1974
STANAME ........................................................................................................................... 1975
STANODEINT ....................................................................................................................... 1976
STANODENAME ................................................................................................................... 1977
STAREA ............................................................................................................................... 1978
STASWDEVDAT .................................................................................................................... 1979
STASWDEVINT ..................................................................................................................... 1981
STASWDEVNAME ................................................................................................................. 1982
STBSKV ............................................................................................................................... 1983
STZONE .............................................................................................................................. 1984
SWSBLK .............................................................................................................................. 1985
SWSBLZ .............................................................................................................................. 1986
SWSBLZ2 ............................................................................................................................ 1987
SWSDAT ............................................................................................................................. 1988
SWSDT1 ............................................................................................................................. 1989
SWSINT .............................................................................................................................. 1990
SWSMIND ........................................................................................................................... 1991
SWSMNAM ......................................................................................................................... 1993
SYSMSM ............................................................................................................................. 1994
SYSMVA ............................................................................................................................. 1995
SYSTOT .............................................................................................................................. 1996
TITLDT ................................................................................................................................ 1997
TOTBUS .............................................................................................................................. 1998
TR3DAT .............................................................................................................................. 1999
TR3DT2 .............................................................................................................................. 2000
TR3INT ............................................................................................................................... 2002
TR3NAM ............................................................................................................................. 2004
TRNDAT .............................................................................................................................. 2005
TRXDAT .............................................................................................................................. 2006
VSCAUXMIND ..................................................................................................................... 2007
VSCAUXMNAM ................................................................................................................... 2009
VSCCDT .............................................................................................................................. 2010
VSCCIN ............................................................................................................................... 2012
VSCINT ............................................................................................................................... 2013
VSCMIND ............................................................................................................................ 2014
VSCMNAM .......................................................................................................................... 2015
WINDMIND ......................................................................................................................... 2016

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxviii
WINDMNAM ....................................................................................................................... 2018
WNDDAT ............................................................................................................................ 2019
WNDDT2 ............................................................................................................................ 2021
WNDINT ............................................................................................................................. 2023
XFRDAT .............................................................................................................................. 2025
XFRINT ............................................................................................................................... 2027
XFRNAM ............................................................................................................................. 2029
ZNDAT ................................................................................................................................ 2030
ZNITOJ ............................................................................................................................... 2032
ZONNAM ............................................................................................................................ 2033
ZONNUM ............................................................................................................................ 2034
ZONUSE ............................................................................................................................. 2035
Subsystem Data Retrieval ............................................................................................................ 2036
Character Data .................................................................................................................... 2037
GET_CHAR_LENGTH ..................................................................................................... 2037
Bus Data ............................................................................................................................ 2039
ABUSCHAR .................................................................................................................. 2039
ABUSCOUNT ............................................................................................................... 2041
ABUSCPLX .................................................................................................................. 2042
ABUSINT ..................................................................................................................... 2044
ABUSREAL .................................................................................................................. 2046
ABUSTYPES ................................................................................................................. 2048
Plant Bus Data .................................................................................................................... 2050
AGENBUSCHAR ........................................................................................................... 2050
AGENBUSCOUNT ......................................................................................................... 2052
AGENBUSCPLX ............................................................................................................ 2053
AGENBUSINT ............................................................................................................... 2055
AGENBUSREAL ............................................................................................................ 2057
AGENBUSTYPES ........................................................................................................... 2060
Machine Data ..................................................................................................................... 2062
AMACHCHAR .............................................................................................................. 2062
AMACHCOUNT ............................................................................................................ 2064
AMACHCPLX ............................................................................................................... 2065
AMACHINT .................................................................................................................. 2067
AMACHREAL ............................................................................................................... 2069
AMACHTYPES ............................................................................................................. 2072
Load Bus Data .................................................................................................................... 2074
ALODBUSCHAR ............................................................................................................ 2074
ALODBUSCOUNT ......................................................................................................... 2076
ALODBUSCPLX ............................................................................................................ 2078
ALODBUSINT ............................................................................................................... 2081
ALODBUSREAL ............................................................................................................ 2083
ALODBUSTYPES ........................................................................................................... 2086
Load Data .......................................................................................................................... 2088
ALOADCHAR ............................................................................................................... 2088
ALOADCOUNT ............................................................................................................. 2090
ALOADCPLX ................................................................................................................ 2091
ALOADINT .................................................................................................................. 2094
ALOADREAL ................................................................................................................ 2096
ALOADTYPES ............................................................................................................... 2099
Fixed Shunt Bus Data .......................................................................................................... 2101

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxix
AFXSHNTBUSCHAR ...................................................................................................... 2101
AFXSHNTBUSCOUNT ................................................................................................... 2103
AFXSHNTBUSCPLX ....................................................................................................... 2104
AFXSHNTBUSINT ......................................................................................................... 2106
AFXSHNTBUSREAL ....................................................................................................... 2108
AFXSHNTBUSTYPES ..................................................................................................... 2110
Fixed Shunt Data ................................................................................................................ 2112
AFXSHUNTCHAR .......................................................................................................... 2112
AFXSHUNTCOUNT ....................................................................................................... 2114
AFXSHUNTCPLX .......................................................................................................... 2115
AFXSHUNTINT ............................................................................................................. 2117
AFXSHUNTREAL .......................................................................................................... 2119
AFXSHUNTTYPES ........................................................................................................ 2121
Switched Shunt Data .......................................................................................................... 2123
ASWSHCHAR ............................................................................................................... 2123
ASWSHCOUNT ............................................................................................................ 2125
ASWSHCPLX ................................................................................................................ 2126
ASWSHINT .................................................................................................................. 2128
ASWSHREAL ................................................................................................................ 2130
ASWSHTYPES .............................................................................................................. 2134
Branch Flow Data ............................................................................................................... 2136
AFLOWCHAR ............................................................................................................... 2136
AFLOWCOUNT ............................................................................................................. 2139
AFLOWCPLX ................................................................................................................ 2141
AFLOWINT .................................................................................................................. 2143
AFLOWREAL ................................................................................................................ 2145
AFLOWTYPES .............................................................................................................. 2148
Branch Data ....................................................................................................................... 2150
ABRNCHAR ................................................................................................................. 2150
ABRNCOUNT ............................................................................................................... 2153
ABRNCPLX .................................................................................................................. 2155
ABRNINT ..................................................................................................................... 2157
ABRNREAL .................................................................................................................. 2159
ABRNTYPES ................................................................................................................. 2167
Two-Winding Transformer Data ............................................................................................ 2169
ATRNCHAR .................................................................................................................. 2169
ATRNCOUNT ............................................................................................................... 2172
ATRNCPLX ................................................................................................................... 2174
ATRNINT ..................................................................................................................... 2177
ATRNREAL ................................................................................................................... 2180
ATRNTYPES ................................................................................................................. 2184
Three-Winding Transformer Data .......................................................................................... 2186
ATR3CHAR .................................................................................................................. 2186
ATR3COUNT ................................................................................................................ 2189
ATR3CPLX ................................................................................................................... 2191
ATR3INT ..................................................................................................................... 2194
ATR3REAL ................................................................................................................... 2196
ATR3TYPES ................................................................................................................. 2198
Three-Winding Transformer Winding Data ............................................................................. 2200
AWNDCHAR ................................................................................................................ 2200
AWNDCOUNT .............................................................................................................. 2203

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxx
AWNDCPLX ................................................................................................................. 2205
AWNDINT ................................................................................................................... 2207
AWNDREAL ................................................................................................................. 2210
AWNDTYPES ............................................................................................................... 2214
Two-Terminal dc Line Data .................................................................................................. 2216
A2TRMDCCHAR ........................................................................................................... 2216
A2TRMDCCOUNT ......................................................................................................... 2218
A2TRMDCCPLX ............................................................................................................ 2219
A2TRMDCINT .............................................................................................................. 2221
A2TRMDCREAL ............................................................................................................ 2223
A2TRMDCTYPES .......................................................................................................... 2227
Two-Terminal dc Line Converter Data ................................................................................... 2229
A2TRMDCCONVCHAR ................................................................................................... 2229
A2TRMDCCONVCOUNT ................................................................................................ 2232
A2TRMDCCONVCPLX ................................................................................................... 2234
A2TRMDCCONVINT ...................................................................................................... 2236
A2TRMDCCONVREAL ................................................................................................... 2238
A2TRMDCCONVTYPES .................................................................................................. 2241
Multi-Terminal dc Line Data ................................................................................................. 2243
AMULTITRMDCCHAR .................................................................................................... 2243
AMULTITRMDCCOUNT .................................................................................................. 2245
AMULTITRMDCCPLX ..................................................................................................... 2246
AMULTITRMDCINT ....................................................................................................... 2248
AMULTITRMDCREAL ..................................................................................................... 2250
AMULTITRMDCTYPES ................................................................................................... 2252
Multi-Terminal dc Line Converter Data .................................................................................. 2254
AMULTITRMDCCONVCHAR ............................................................................................ 2254
AMULTITRMDCCONVCOUNT ......................................................................................... 2257
AMULTITRMDCCONVCPLX ............................................................................................ 2259
AMULTITRMDCCONVINT ............................................................................................... 2261
AMULTITRMDCCONVREAL ............................................................................................ 2263
AMULTITRMDCCONVTYPES .......................................................................................... 2266
VSC dc Line Data ................................................................................................................ 2268
AVSCDCCHAR .............................................................................................................. 2268
AVSCDCCOUNT ........................................................................................................... 2270
AVSCDCCPLX .............................................................................................................. 2271
AVSCDCINT ................................................................................................................. 2273
AVSCDCREAL ............................................................................................................... 2275
AVSCDCTYPES ............................................................................................................. 2277
VSC dc Line Converter Data ................................................................................................. 2279
AVSCDCCONVCHAR ..................................................................................................... 2279
AVSCDCCONVCOUNT ................................................................................................... 2282
AVSCDCCONVCPLX ...................................................................................................... 2284
AVSCDCCONVINT ........................................................................................................ 2286
AVSCDCCONVREAL ...................................................................................................... 2288
AVSCDCCONVTYPES .................................................................................................... 2291
FACTS Device Data .............................................................................................................. 2293
AFACTSCHAR .............................................................................................................. 2293
AFACTSCOUNT ............................................................................................................ 2295
AFACTSCPLX ............................................................................................................... 2297
AFACTSINT .................................................................................................................. 2299

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxi
AFACTSREAL ............................................................................................................... 2301
AFACTSTYPES .............................................................................................................. 2305
FACTS Device Bus Data ........................................................................................................ 2307
AFACTSBUSCHAR ......................................................................................................... 2307
AFACTSBUSCOUNT ...................................................................................................... 2310
AFACTSBUSCPLX ......................................................................................................... 2312
AFACTSBUSINT ............................................................................................................ 2314
AFACTSBUSREAL ......................................................................................................... 2317
AFACTSBUSTYPES ........................................................................................................ 2320
Area Data ........................................................................................................................... 2322
AAREACHAR ................................................................................................................ 2322
AAREACOUNT ............................................................................................................. 2324
AAREACPLX ................................................................................................................. 2325
AAREAINT ................................................................................................................... 2327
AAREAREAL ................................................................................................................ 2329
AAREATYPES ............................................................................................................... 2332
Owner Data ........................................................................................................................ 2334
AOWNERCHAR ............................................................................................................ 2334
AOWNERCOUNT .......................................................................................................... 2336
AOWNERCPLX ............................................................................................................. 2337
AOWNERINT ................................................................................................................ 2339
AOWNERREAL ............................................................................................................. 2341
AOWNERTYPES ............................................................................................................ 2344
Zone Data .......................................................................................................................... 2346
AZONECHAR ............................................................................................................... 2346
AZONECOUNT ............................................................................................................. 2348
AZONECPLX ................................................................................................................ 2349
AZONEINT .................................................................................................................. 2351
AZONEREAL ................................................................................................................ 2353
AZONETYPES .............................................................................................................. 2356
Induction Machine Bus Data ................................................................................................ 2358
AINDMACBUSCHAR ...................................................................................................... 2358
AINDMACBUSCOUNT ................................................................................................... 2360
AINDMACBUSCPLX ...................................................................................................... 2362
AINDMACBUSINT ......................................................................................................... 2364
AINDMACBUSREAL ...................................................................................................... 2366
AINDMACBUSTYPES ..................................................................................................... 2369
Induction Machine Data ...................................................................................................... 2371
AINDMACCHAR ........................................................................................................... 2371
AINDMACCOUNT ......................................................................................................... 2373
AINDMACCPLX ............................................................................................................ 2375
AINDMACINT .............................................................................................................. 2377
AINDMACREAL ............................................................................................................ 2380
AINDMACTYPES .......................................................................................................... 2383
Substation Data .................................................................................................................. 2385
ASTATIONCHAR ........................................................................................................... 2385
ASTATIONCOUNT ......................................................................................................... 2387
ASTATIONINT .............................................................................................................. 2388
ASTATIONREAL ............................................................................................................ 2390
ASTATIONTYPES .......................................................................................................... 2391
Substation Node Data ......................................................................................................... 2393

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxii
ANODECHAR ............................................................................................................... 2393
ANODECOUNT ............................................................................................................ 2395
ANODEINT .................................................................................................................. 2396
ANODEREAL ................................................................................................................ 2398
ANODETYPES .............................................................................................................. 2399
Substation Switching Device Data ........................................................................................ 2401
ASTASWDEVCHAR ........................................................................................................ 2401
ASTASWDEVCOUNT ..................................................................................................... 2403
ASTASWDEVCPLX ........................................................................................................ 2404
ASTASWDEVINT ........................................................................................................... 2406
ASTASWDEVREAL ........................................................................................................ 2408
ASTASWDEVTYPES ....................................................................................................... 2410
Substation Terminal Data .................................................................................................... 2412
ATERMINALCHAR ......................................................................................................... 2412
ATERMINALCOUNT ...................................................................................................... 2414
ATERMINALINT ............................................................................................................ 2415
ATERMINALTYPES ........................................................................................................ 2417
Zero Sequence Mutuals Data ............................................................................................... 2419
AZMUTCHAR ............................................................................................................... 2419
AZMUTCOUNT ............................................................................................................ 2421
AZMUTCPLX ................................................................................................................ 2423
AZMUTINT .................................................................................................................. 2425
AZMUTREAL ................................................................................................................ 2427
AZMUTTYPES .............................................................................................................. 2429
Graphical Analysis Output ........................................................................................................... 2431
POLY_PRINT ........................................................................................................................ 2432
PV_PRINT ............................................................................................................................ 2433
QV_PRINT ........................................................................................................................... 2435
SETFULLVIEWGRAPHAREA .................................................................................................... 2436
SETFULLVIEWSCALE ............................................................................................................. 2439
Scenarios .................................................................................................................................... 2441
CLOSESCENARIOFILE ........................................................................................................... 2442
NEWSCENARIOFILE .............................................................................................................. 2443
OPENSCENARIOFILE ............................................................................................................. 2444
SAVESCENARIOFILE ............................................................................................................. 2445
SCENARIOCLOSE ................................................................................................................. 2446
SCENARIOCOPYFILE ............................................................................................................. 2447
SCENARIOFILEADD .............................................................................................................. 2448
SCENARIOFILECOUNT .......................................................................................................... 2449
SCENARIOFILEGETATTRS ...................................................................................................... 2450
SCENARIOFILEGETCOMMENTS .............................................................................................. 2451
SCENARIOFILELENGTHCOMMENTS ........................................................................................ 2452
SCENARIOFILELIST ............................................................................................................... 2453
SCENARIOFILEREMOVE ........................................................................................................ 2454
SCENARIOFILERENAME ........................................................................................................ 2455
SCENARIOFILESETATTRS ....................................................................................................... 2456
SCENARIOFILESETCOMMENTS .............................................................................................. 2457
SCENARIOGETATTRS ............................................................................................................ 2458
SCENARIOGETCOMMENTS .................................................................................................... 2459
SCENARIOGETOPT ............................................................................................................... 2460
SCENARIOGROUPADD .......................................................................................................... 2462

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxiii
SCENARIOGROUPCOUNT ...................................................................................................... 2463
SCENARIOGROUPGETCOMMENTS ......................................................................................... 2464
SCENARIOGROUPLENGTHCOMMENTS ................................................................................... 2465
SCENARIOGROUPLIST .......................................................................................................... 2466
SCENARIOGROUPOPEN ........................................................................................................ 2467
SCENARIOGROUPREMOVE .................................................................................................... 2468
SCENARIOGROUPRENAME .................................................................................................... 2469
SCENARIOGROUPSETCOMMENTS .......................................................................................... 2470
SCENARIOISDIRTY ............................................................................................................... 2471
SCENARIOISVALID ............................................................................................................... 2472
SCENARIOLENGTHCOMMENTS ............................................................................................. 2473
SCENARIOMODELGROUP ...................................................................................................... 2474
SCENARIOMOVEFILE ............................................................................................................ 2475
SCENARIONEW .................................................................................................................... 2476
SCENARIOOPEN .................................................................................................................. 2477
SCENARIOSAVE ................................................................................................................... 2478
SCENARIOSETATTRS ............................................................................................................. 2479
SCENARIOSETCOMMENTS .................................................................................................... 2480
SCENARIOSETOPT ................................................................................................................ 2481
SCENARIOTRACKFILEADD ..................................................................................................... 2483
SCENARIOTRACKFILELIST ...................................................................................................... 2484
SCENARIOTRACKFILENUM .................................................................................................... 2485
SCENARIOUNZIP .................................................................................................................. 2486
SCENARIOUNZIPPROBLEMS .................................................................................................. 2487
SCENARIOUNZIPSOLUTIONS ................................................................................................. 2488
SCENARIOZIP ...................................................................................................................... 2489
SCENARIOZIPACTIVE ............................................................................................................ 2490
SCENARIOZIPOPEN .............................................................................................................. 2491
SCENARIOZIPSAVE ............................................................................................................... 2492
Event Studies .............................................................................................................................. 2493
CLOSEEVENTSTUDYFILE ....................................................................................................... 2494
OPENEVENTSTUDYFILE ........................................................................................................ 2495
RUNDYNAMICEVENTSTUDY .................................................................................................. 2496
RUNPOWERFLOWEVENTSTUDY ............................................................................................. 2497
SAVEEVENTSTUDYFILE ......................................................................................................... 2498
SETACTIVEEVENTSTUDY ....................................................................................................... 2499
Node Breaker .............................................................................................................................. 2500
CONVERT_SECTION_TO_BUS ................................................................................................ 2501
ISOLATE2DCLINEBYBREAKER ................................................................................................ 2502
ISOLATE3WTBYBREAKER ...................................................................................................... 2503
ISOLATEBUSBYBREAKER ....................................................................................................... 2504
ISOLATEFACTSBYBREAKER .................................................................................................... 2505
ISOLATEINDMACHINEBYBREAKER .......................................................................................... 2506
ISOLATELINEBYBREAKER ...................................................................................................... 2507
ISOLATELOADBYBREAKER ..................................................................................................... 2508
ISOLATEMACHINEBYBREAKER ............................................................................................... 2509
ISOLATEMSLINEBYBREAKER .................................................................................................. 2510
ISOLATEMTDCLINEBYBREAKER .............................................................................................. 2511
ISOLATENODEBYBREAKER .................................................................................................... 2512
ISOLATESHUNTBYBREAKER ................................................................................................... 2513
ISOLATESWDBYBREAKER ...................................................................................................... 2514

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxiv
ISOLATESWSHUNTBYBREAKER .............................................................................................. 2515
ISOLATEVSCDCLINEBYBREAKER ............................................................................................. 2516
PLANT_BUS_SECTION_CHNG ................................................................................................ 2517
RESTORESTATESFROMISOLATE .............................................................................................. 2518
STATION_2DC_CONV_TERM_CHNG ....................................................................................... 2519
STATION_ADJVAR_TERM_CHNG ............................................................................................ 2520
STATION_BRANCH_TERM_CHNG ........................................................................................... 2521
STATION_BRANCH_TERM_MOVE ........................................................................................... 2522
STATION_BUILD_CONFIG ...................................................................................................... 2523
STATION_BUS_PURG ............................................................................................................ 2525
STATION_CHNG ................................................................................................................... 2526
STATION_DATA .................................................................................................................... 2527
STATION_FACTS_TERM_CHNG .............................................................................................. 2528
STATION_INDMACHINE_TERM_CHNG .................................................................................... 2529
STATION_LIST ...................................................................................................................... 2530
STATION_LOAD_TERM_CHNG ............................................................................................... 2531
STATION_MACHINE_TERM_CHNG .......................................................................................... 2532
STATION_MTDC_TERM_CHNG ............................................................................................... 2533
STATION_NODE_CHNG ......................................................................................................... 2534
STATION_NODE_DATA .......................................................................................................... 2535
STATION_NODE_NUMBER ..................................................................................................... 2536
STATION_NODE_PURG ......................................................................................................... 2537
STATION_NUMBER ............................................................................................................... 2538
STATION_POUT ................................................................................................................... 2539
STATION_POUT_2 ................................................................................................................ 2540
STATION_PURG .................................................................................................................... 2541
STATION_SHUNT_TERM_CHNG ............................................................................................. 2542
STATION_SWD_CHNG .......................................................................................................... 2543
STATION_SWD_DATA ............................................................................................................ 2545
STATION_SWD_MBID ........................................................................................................... 2547
STATION_SWD_MOVE .......................................................................................................... 2548
STATION_SWD_PURG ........................................................................................................... 2549
STATION_SWS_SHUNT_TERM_CHNG ..................................................................................... 2550
STATION_THREE_WND_TERM_CHNG ..................................................................................... 2551
STATION_THREE_WND_TERM_MOVE ..................................................................................... 2552
STATION_TREE .................................................................................................................... 2553
STATION_VSCDC_CONV_TERM_CHNG .................................................................................... 2554
SYSTEM_SWD_CHNG ........................................................................................................... 2555
SYSTEM_SWD_DATA ............................................................................................................ 2557
Harmonics .................................................................................................................................. 2559
HAR_2TDC .......................................................................................................................... 2560
HAR_2TDC_CHNG ................................................................................................................ 2561
HAR_2TDC_PURG ................................................................................................................ 2562
HAR_BRN ............................................................................................................................ 2563
HAR_BRN_CHNG ................................................................................................................. 2564
HAR_BRN_PURG .................................................................................................................. 2565
HAR_CURSRC ...................................................................................................................... 2566
HAR_CURSRC_CHNG ............................................................................................................ 2567
HAR_CURSRC_CHNG_NAME ................................................................................................. 2568
HAR_CURSRC_CHNG_ONEPT ................................................................................................ 2569
HAR_CURSRC_NAME ............................................................................................................ 2570

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxv
HAR_CURSRC_ONEPT ........................................................................................................... 2571
HAR_CURSRC_PURG ............................................................................................................. 2572
HAR_CURSRC_PURG_ONEPT ................................................................................................. 2573
HAR_FACTS ......................................................................................................................... 2574
HAR_FACTS_CHNG .............................................................................................................. 2575
HAR_FACTS_PURG ............................................................................................................... 2576
HAR_IMPCHAR .................................................................................................................... 2577
HAR_IMPCHAR_CHNG .......................................................................................................... 2578
HAR_IMPCHAR_CHNG_NAME ............................................................................................... 2579
HAR_IMPCHAR_CHNG_ONEPT .............................................................................................. 2580
HAR_IMPCHAR_NAME .......................................................................................................... 2581
HAR_IMPCHAR_ONEPT ......................................................................................................... 2582
HAR_IMPCHAR_PURG ........................................................................................................... 2583
HAR_IMPCHAR_PURG_ONEPT ............................................................................................... 2584
HAR_INDMC ........................................................................................................................ 2585
HAR_INDMC_CHNG ............................................................................................................. 2586
HAR_INDMC_PURG .............................................................................................................. 2587
HAR_LOAD .......................................................................................................................... 2588
HAR_LOAD_CHNG ............................................................................................................... 2589
HAR_LOAD_PURG ................................................................................................................ 2590
HAR_MACH ......................................................................................................................... 2591
HAR_MACH_CHNG .............................................................................................................. 2592
HAR_MACH_PURG ............................................................................................................... 2593
HAR_MTDC ......................................................................................................................... 2594
HAR_MTDC_CHNG ............................................................................................................... 2595
HAR_MTDC_PURG ............................................................................................................... 2596
HAR_NEW ........................................................................................................................... 2597
HAR_PURG .......................................................................................................................... 2598
HAR_READ .......................................................................................................................... 2599
HAR_READX ........................................................................................................................ 2600
HAR_TRN ............................................................................................................................ 2601
HAR_TRN_CHNG .................................................................................................................. 2602
HAR_TRN_PURG .................................................................................................................. 2603
HAR_VLTSRC ....................................................................................................................... 2604
HAR_VLTSRC_CHNG ............................................................................................................. 2605
HAR_VLTSRC_CHNG_NAME .................................................................................................. 2606
HAR_VLTSRC_CHNG_ONEPT ................................................................................................. 2607
HAR_VLTSRC_NAME ............................................................................................................. 2608
HAR_VLTSRC_ONEPT ............................................................................................................ 2609
HAR_VLTSRC_PURG .............................................................................................................. 2610
HAR_VLTSRC_PURG_ONEPT .................................................................................................. 2611
HAR_VSCDC ........................................................................................................................ 2612
HAR_VSCDC_CHNG .............................................................................................................. 2613
HAR_VSCDC_PURG .............................................................................................................. 2614
HAR_WRITE ......................................................................................................................... 2615
HAR_WRITEX ....................................................................................................................... 2616
Measurement Interface ............................................................................................................... 2617
HDAIMPORTDATA ................................................................................................................ 2618
Multiple Element Data ................................................................................................................ 2619
GETMODELLIBRARIES ........................................................................................................... 2620
GETMODELPROGRAMS ......................................................................................................... 2621

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxvi
LAST_PF ............................................................................................................................. 2622
TREEDAT ............................................................................................................................. 2623
Non-Engineering ......................................................................................................................... 2625
ALERT ................................................................................................................................. 2626
BEGINREPORT ..................................................................................................................... 2627
CLEARALERTOUTPUT ............................................................................................................ 2628
CLEARPROGRESSOUTPUT ..................................................................................................... 2629
FILEIN ................................................................................................................................ 2630
GETBATDEFAULTS ................................................................................................................ 2631
GETDEFAULTCHAR ............................................................................................................... 2632
GETDEFAULTINT .................................................................................................................. 2633
GETDEFAULTREAL ................................................................................................................ 2634
GETLOADEDMODULES ......................................................................................................... 2635
GETMODFUNCLIST .............................................................................................................. 2636
IOFLUSH ............................................................................................................................. 2637
LAUNCH_PROGRAM ............................................................................................................. 2638
PAGEREPORT ....................................................................................................................... 2639
PROGRESS .......................................................................................................................... 2640
PROMPT ............................................................................................................................. 2641
PSSEINIT ............................................................................................................................. 2642
PSSEVERSION ...................................................................................................................... 2643
REFRESHGUI ....................................................................................................................... 2644
REPORT .............................................................................................................................. 2645
RUNIPLANFILE ..................................................................................................................... 2646
RUNRSPNSFILE .................................................................................................................... 2647
STARTRECORDING ................................................................................................................ 2648
STOPRECORDING ................................................................................................................. 2649
T_ALERT_OUTPUT ................................................................................................................ 2650
T_PROGRESS_OUTPUT ......................................................................................................... 2652
T_PROMPT_OUTPUT ............................................................................................................ 2654
T_REPORT_OUTPUT ............................................................................................................. 2656
USERIN ............................................................................................................................... 2658
PSSPLOT Module ......................................................................................................................... 2659
ADDFUNCTION .................................................................................................................... 2660
CHANNELFILEEXCELEXPORT ................................................................................................. 2661
DELETESELPLOT .................................................................................................................. 2662
DRAGDROPPLOTDATA ........................................................................................................... 2663
EXPORTPLOT ....................................................................................................................... 2664
INSERTPAGE ........................................................................................................................ 2665
INSERTPLOT ........................................................................................................................ 2666
MULTICHANNEXCELEXPORT ................................................................................................. 2667
NEWPLOTBOOK ................................................................................................................... 2668
OPENCHANDATAFILE ........................................................................................................... 2669
PRINTSELPLOT ..................................................................................................................... 2670
SETSELECTEDPAGE .............................................................................................................. 2671
SETSELECTEDPLOT ............................................................................................................... 2672
SHOWPLOTEDITOR ............................................................................................................... 2673
XYPLOT .............................................................................................................................. 2674
PSSRDB Module .......................................................................................................................... 2675
DVRMATTACHANDLAUNCHWORKBOOK ................................................................................. 2676
DVRMCREATEACCDATABASE ................................................................................................. 2678

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxvii
DVRMCREATEDYNDATABASE ................................................................................................. 2679
PSSARRAYS Module ..................................................................................................................... 2680
ACCC_SUMMARY ................................................................................................................. 2681
ACCC_SOLUTION ................................................................................................................. 2684
ACCC_SUMMARY_REPORT .................................................................................................... 2686
SENSITIVITY_FLOW_TO_MW ................................................................................................. 2687
ACCC_SOLUTION_REPORT .................................................................................................... 2688
ACCC_VIOLATIONS_REPORT ................................................................................................. 2689
ASCC_CURRENTS ................................................................................................................. 2690
IECS_CURRENTS .................................................................................................................. 2695
OTDF_FACTORS ................................................................................................................... 2701
PV_SUMMARY ..................................................................................................................... 2703
PV_SUMMARY_REPORT ........................................................................................................ 2705
PV_SOLUTION ..................................................................................................................... 2706
PV_SOLUTION_REPORT ........................................................................................................ 2708
QV_SOLUTION .................................................................................................................... 2709
QV_SOLUTION_REPORT ........................................................................................................ 2710
QV_SUMMARY .................................................................................................................... 2711
QV_SUMMARY_REPORT ....................................................................................................... 2713
PSSEXCEL Module ....................................................................................................................... 2714
ACCC .................................................................................................................................. 2715
iec_data_file ....................................................................................................................... 2719
pv ...................................................................................................................................... 2721
qv ...................................................................................................................................... 2724
EXCELPY Module ......................................................................................................................... 2726
Methods ............................................................................................................................. 2730
Workbook Functions ........................................................................................................... 2736
GICDATA Module ......................................................................................................................... 2737
PSSPIHIST Module ....................................................................................................................... 2740
PFCONTROL Module .................................................................................................................... 2742
PFDSCNBUS ........................................................................................................................ 2743
PFBRCHINT ......................................................................................................................... 2744
PFSUBSWDINT ..................................................................................................................... 2745
PFFXSINT ............................................................................................................................ 2746
PFFXSREAL ......................................................................................................................... 2747
PFSWSINT ........................................................................................................................... 2748
PFSWSREAL ......................................................................................................................... 2749
PFLODINT ........................................................................................................................... 2750
PFLODREAL ......................................................................................................................... 2751
PFMACINT .......................................................................................................................... 2752
PFMACREAL ........................................................................................................................ 2753
PFPLNTREAL ........................................................................................................................ 2754
PFCNTLVSC ......................................................................................................................... 2756
PSSACCSS Module ....................................................................................................................... 2757
ACCC_FILE_INIT ................................................................................................................... 2758
ACCC_FILE_SIZE .................................................................................................................. 2760
ACCC_FILE_GET_SUM_VOLT ................................................................................................. 2762
ACCC_FILE_CLOSE ............................................................................................................... 2765
ACCC_FILE_SUMMARY ......................................................................................................... 2766
ACCC_FILE_SUMMARY_2 ...................................................................................................... 2770
ACCC_FILE_SUMMARY_3 ...................................................................................................... 2774

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxviii
ACCC_FILE_SUM_AREAS ....................................................................................................... 2779
ACCC_FILE_CNTG_VOLT ....................................................................................................... 2782
ACCC_FILE_CNTG_FLOW ...................................................................................................... 2785
ACCC_FILE_CNTG_FLOW_2 ................................................................................................... 2788
ACCC_FILE_CNTG_VOLT_FLOW ............................................................................................. 2791
ACCC_FILE_CNTG_VOLT_FLOW_2 .......................................................................................... 2794
ACCC_FILE_CNTG_DSCR ....................................................................................................... 2797
ACCC_FILE_CNTG_LOAD ....................................................................................................... 2800
ACCC_FILE_SOLUTION ......................................................................................................... 2803
ACCC_FILE_SOLUTION_2 ...................................................................................................... 2807
Other Python Modules ................................................................................................................ 2811
Modules Supplied with a GUI ............................................................................................... 2812
Modules that Define Functions ............................................................................................ 2813
Index ......................................................................................................................................... 2814

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xxxix
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. myarray06=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
xl
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)

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 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

case(filename)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
xli
Chapter 1
Power Flow Operation
This chapter describes the API routines corresponding to the operational functions of the PSS®E Power Flow
and Fault Analysis. Also included are those routines that control basic program operations and the Open
Access option.

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

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
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
2
Power Flow Operation ACCC

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 Operation ACCC_2

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 Operation ACCC_2

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

1.3. ACCC_MULTIPLE_MERGE
Use this API to merge a number of AC contingency solution files (acc files) into one acc 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, PSS/E 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 Operation ACCC_MULTIPLE_MERGE

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

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 Operation 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 Operation 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 Operation ACCC_MULTIPLE_RUN_REPORT_2

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 Operation 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 Operation 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 Operation 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 Operation ACCC_PARALLEL

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 Operation 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 Operation 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 Operation ACCC_PARALLEL_2

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 Operation 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 Operation 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 Operation ACCC_SINGLE_RUN_REPORT

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 Operation 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 Operation 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 Operation ACCC_SINGLE_RUN_REPORT_2

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 Operation 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 Operation 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 Operation ACCC_SINGLE_RUN_REPORT_3

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 Operation 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 Operation 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 Operation ACCC_SINGLE_RUN_REPORT_4

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 Operation 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 Operation 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 Operation ACCC_SINGLE_RUN_REPORT_5

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 Operation 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 Operation 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 Operation ACCC_SINGLE_RUN_REPORT_5

REALVAL(4) in overload reports, minimum contingency

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

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 Operation 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 Operation 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 Operation 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 Operation ACCC_TRIP_COR_2

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 Operation 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 Operation 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 Operation 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 Operation ACCC_TRIP_COR_3

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 Operation 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 Operation 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 Operation 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 Operation 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 Operation ACCC_WITH_COR

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 Operation 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 Operation 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 Operation 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 Operation ACCC_WITH_COR_2

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 Operation 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 Operation 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 Operation 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 Operation ACCC_WITH_COR_3

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 Operation 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 Operation ACCC_WITH_COR_3

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
60
Power Flow Operation 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 Operation ACCC_WITH_DSP

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 Operation 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 Operation 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 Operation ACCC_WITH_DSP_2

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 Operation 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 Operation 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 Operation ACCC_WITH_DSP_3

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 Operation 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 Operation 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 Operation ACCC_WITH_TRIP

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 Operation 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 Operation 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 Operation ACCC_WITH_TRIP_2

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 Operation 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 Operation 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 Operation ACCC_WITH_TRIP_PARALLEL

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 Operation 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 Operation 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 Operation ACCOR

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 Operation 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 Operation 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 Operation ACCOR_2

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 Operation 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 Operation 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 Operation ACCOR_3

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 Operation 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 Operation 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 Operation ALERT_OUTPUT

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 Operation ALERT_OUTPUT

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

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 Operation ALPH

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:

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

1.31. 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
93
Power Flow Operation 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
94
Power Flow Operation ANSI_2

1.32. 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
95
Power Flow Operation 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
96
Power Flow Operation ANSI_3

1.33. 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:

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
97
Power Flow Operation 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
98
Power Flow Operation 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
99
Power Flow Operation APPEND_ACCC

1.34. 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
100
Power Flow Operation 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

CALL AREA_ZONE(SID, ALL, IERR)

Where:

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

1.38. 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
105
Power Flow Operation 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
106
Power Flow Operation ARNM_2

1.39. 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
107
Power Flow Operation 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
108
Power Flow Operation ASCC

1.40. 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 (default
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 (default alias is linout) (0 by
default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (default alias is linend) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) flat conditions option (default 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 (de-
fault alias is nouse1) (ignored, but must be
specified as 0 or 1; 0 by default; double pre-
cision always used)

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

STATUS(6) report option (default alias is rptop) (1 by de-

fault)
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 (default
alias is rptlvl) (0 by default)
STATUS(8) branch quantity code for line to ground
faults (default 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 (default alias
is dcload) (0 by default)
STATUS(9) = 0 blocked
STATUS(9) = 1 represent as load
STATUS(10) transformer impedance correction option
(default 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
110
Power Flow Operation ASCC_1A

1.41. 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 (default
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 (default alias is linout) (0 by
default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (default alias is linend) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) flat conditions option (default 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" (default alias is genxop) (0 by de-
fault)

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

STATUS(5) = 0 use subtransient reactance

STATUS(5) = 1 use transient reactance
STATUS(5) = 2 use synchronous reactance
STATUS(6) option (default 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 (default
alias is rptlvl) (0 by default)
STATUS(8) branch quantity code for line to ground
faults (default 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 (default alias
is dcload) (0 by default)
STATUS(9) = 0 blocked
STATUS(9) = 1 represent as load
STATUS(10) transformer impedance correction option
(default 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
112
Power Flow Operation ASCC_2

1.42. 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 (default alias is fltlg) (0
by default)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-out faults (default alias is linout) (0 by
default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (default alias is linend) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) flat conditions option (default 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 (de-
fault alias is nouse1) (ignored, but must be
specified as 0 or 1; 0 by default; double pre-
cision always used)

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

STATUS(6) report option (default alias is rptop) (1 by de-

fault)
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 (de-
fault alias is rptlvl) (0 by default)
STATUS(7) >= 0 used if STATUS(6) = 2 or 3
STATUS(8) branch quantity code (default alias is
nouse2) (ignored, but must be specified as 0
or 1; 0 by default)
STATUS(9) dc line and FACTS device option (default 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 (default alias is zcorec) (0 by
default)
STATUS(10) = 0 ignore
STATUS(10) = 1 apply
STATUS(11) three phase faults (default alias is flt3ph) (0
by default)
STATUS(11) = 0 omit
STATUS(11) = 1 include
STATUS(12) line-line-to-ground faults (default alias is
fltllg) (0 by default)
STATUS(12) = 0 omit
STATUS(12) = 1 include
STATUS(13) line-to-line faults (default 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
114
Power Flow Operation ASCC_3

1.43. 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 (default alias is fltlg) (0
by default)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-out faults (default alias is linout) (0 by
default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-end faults (default alias is linend) (0 by
default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) bus voltage option (default alias is voltop) (0
by default)
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" (default alias is genxop) (0 by de-
fault)

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

STATUS(5) = 0 use subtransient reactance

STATUS(5) = 1 use transient reactance
STATUS(5) = 2 use synchronous reactance
STATUS(6) report option (default alias is rptop) (1 by de-
fault)
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 (de-
fault 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 (default 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 (default 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 (default alias is zcorec) (1 by
default)
STATUS(10) = 0 ignore
STATUS(10) = 1 apply
STATUS(11) three phase faults (default alias is flt3ph) (0
by default)
STATUS(11) = 0 omit
STATUS(11) = 1 include
STATUS(12) line-line-to-ground faults (default alias is
fltllg) (0 by default)
STATUS(12) = 0 omit
STATUS(12) = 1 include
STATUS(13) line-to-line faults (default alias is fltll) (0 by
default)
STATUS(13) = 0 omit
STATUS(13) = 1 include

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

STATUS(14) line charging option (default alias is lnchrg)

(0 by default)
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
STATUS(15) line, fixed and switched shunts, and magne-
tizing admittance option (default alias is shn-
top) (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 (default alias is loadop) (0 by de-
fault)
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 (default 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) (default 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

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

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 ncorrect SCFILE
IERR = 15 SCFILE not allowed

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

1.44. 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
119
Power Flow Operation BASE_FREQUENCY

1.45. 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
120
Power Flow Operation BGEN

1.46. 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:

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

1.47. 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
122
Power Flow Operation 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
123
Power Flow Operation BRCH

1.48. 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
124
Power Flow Operation 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
125
Power Flow Operation BRCH_2

1.49. 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
126
Power Flow Operation 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
127
Power Flow Operation BSNM

1.50. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
128
Power Flow Operation 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
129
Power Flow Operation 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
130
Power Flow Operation BUSN

1.51. 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
131
Power Flow Operation BUS_INPUT

1.52. 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
132
Power Flow Operation BUS_OUTPUT

1.53. 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:

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

1.54. 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

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

1.55. 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
135
Power Flow Operation CA_ITERATIONS

1.56. 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
136
Power Flow Operation CHECKVOLTAGELIMITS

1.57. 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
137
Power Flow Operation CHECK_POWERFLOW_DATA

1.58. 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
138
Power Flow Operation CHECK_POWERFLOW_DATA

OPT = 20 zone 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 prerequisite requirements for API are not met

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

1.59. 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:

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

1.60. 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
141
Power Flow Operation CHKCNTDUPLIDFX

1.61. 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
142
Power Flow Operation CLOSE_POWERFLOW

1.62. 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
143
Power Flow Operation CLOSE_REPORT

1.63. 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
144
Power Flow Operation CMPR

1.64. 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
145
Power Flow Operation 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
146
Power Flow Operation CNTB

1.65. 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
STATUS(3) varies by APIOPT

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

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.\n
Returned 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
148
Power Flow Operation CONG

1.66. 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
149
Power Flow Operation CONL

1.67. 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
150
Power Flow Operation 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
151
Power Flow Operation CONNECTIVITY_CHECK

1.68. 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
152
Power Flow Operation CONTROL_AREA_INTERCHANGE

1.69. 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
153
Power Flow Operation DCCC

1.70. 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
154
Power Flow Operation 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
155
Power Flow Operation DCCC_2

1.71. 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 (in-
put). 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 de-
fault).
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)

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

OPTIONS(7) = 0 no.
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 (input). 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 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 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
error code (output).

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

1.72. 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
158
Power Flow Operation 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
159
Power Flow Operation DCLF

1.73. 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
160
Power Flow Operation 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').
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
161
Power Flow Operation DCLF_2

1.74. 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
162
Power Flow Operation 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').
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
163
Power Flow Operation DC_TAP_ADJUSTMENT

1.75. 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
164
Power Flow Operation DELTMPFILES

1.76. 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
165
Power Flow Operation DFAX

1.77. 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
166
Power Flow Operation 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
167
Power Flow Operation DFAX_2

1.78. 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
168
Power Flow Operation 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
169
Power Flow Operation DFAX_CONTINGENCY

1.79. 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
170
Power Flow Operation DFTI

1.80. 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
171
Power Flow Operation 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
172
Power Flow Operation 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
173
Power Flow Operation DIFF

1.81. 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 = 1 process all buses.
ALL = 0 process only buses in subsystem SID.
Integer APIOPT mode of operation in the API (input).
APIOPT = 1 initialize for case comparison.
APIOPT = 2 run case comparison for specified data cate-
gory.
APIOPT = 3 postprocessing housekeeping.
Integer STATUS (4) STATUS has different values/meanings depending on the value of
APIOPT. If APIOPT = 1, STATUS(1) is the case to leave in the work-
ing case (input; 0 by default). STATUS(1) = 0 original working case.
STATUS(1) = 1 saved case specified in CFILE. If APIOPT = 1, STATUS(2)
is the method used to consider two buses the same for compari-
son (0 by default). STATUS(2) = 0 bus numbers must be the same.
STATUS(2) = 1 bus names must be the same. STATUS(2) = 2 bus
names and numbers must be the same. If APIOPT = 2, STATUS(1) is
the method used for specifying difference thresholds (0 by default).
STATUS(1) = 0 threshold in engineering units. STATUS(1) = 1 thresh-
old as a percent. If APIOPT = 2, STATUS(2) is the comparison to be run
(1 by default). = 1, bus identifiers = 2, bus type codes = 3, machine
status = 4, generator MW = 5, generator MW or MVAR = 6, bus loads
= 7, bus shunts = 8, switched shunts = 9, voltage = 10, voltage and
angle = 11, Mbase and Zsorce = 12, Mbase, Rpos and X" = 13, Mbase
and Zneg = 14, Mbase and Zzero = 15, negative sequence loads = 16,
zero sequence loads = 17, branch status = 18, line R, X, B = 19, line
shunts = 20, line ratings = 21, metered end = 22, transformers = 23,

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

flow MW or MVAR (from bus) = 24, flow MW or MVAR (from & to) =
25, line MW or MVAR losses= 26, zero sequence R, X, B = 27, zero se-
quence line shunts = 28, connection codes = 29, zero sequence mu-
tuals = 30, multi-section lines = 31, multi-section metered end = 32,
load status = 33, line lengths = 34, generator MVAR = 35, flow MW
(from bus) = 36, flow MVAR (from bus) = 37, flow MW (from and to)
= 38, flow MVAR (from and to) = 39, line MW losses = 40, line MVAR
losses = 41, fixed bus shunt status = 42, switched shunt status = 43,
scalable load flag = 44, Mbase, Rpos and X' = 45, Mbase, Rpos and
Xs If APIOPT = 2, STATUS(3) is the load characteristic to be compared
(0 by default). STATUS(3) = 0 total nominal load. STATUS(3) = 1 con-
stant MVA. STATUS(3) = 2 constant current. STATUS(3) = 3 constant
admittance. If APIOPT = 2, STATUS(4) is the line rating set to be com-
pared (0 by default). STATUS(4) = 0 all ratings. STATUS(4) = 1 RATEA.
STATUS(4) = 2 RATEB. STATUS(4) = 3 RATEC. If APIOPT = 3, STATUS(1)
is the case to leave in the working case (0 by default). STATUS(1) = 0
original working case. STATUS(1) = 1 saved case specified in CFILE).
Real THRSH (3) array of 3 elements specifying (used only when APIOPT is 2)(input).
THRSH(1) difference threshold
THRSH(2) voltage or tap ratio threshold
THRSH(3) le threshold
Character*260 CFILE saved case to be compared against the data currently in the working
case (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
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
175
Power Flow Operation DSCN

1.82. 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
176
Power Flow Operation DUPLICATE_CNTLABEL_CHECK

1.83. 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
177
Power Flow Operation ECDI

1.84. 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
178
Power Flow Operation 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
179
Power Flow Operation ECHO

1.85. 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:

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

1.89. 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
186
Power Flow Operation FACT

1.90. 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
187
Power Flow Operation FDNS

1.91. 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
188
Power Flow Operation 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
189
Power Flow Operation FILE_OVERWRITE

1.92. 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
190
Power Flow Operation FIND

1.93. 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
191
Power Flow Operation FLAT

1.94. 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
192
Power Flow Operation 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
193
Power Flow Operation FLAT_2

1.95. 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
194
Power Flow Operation 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
195
Power Flow Operation FLAT_2

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

1.96. 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).

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

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

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

1.97. GCAP
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:

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

1.98. 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
200
Power Flow Operation 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
201
Power Flow Operation GENDSP

1.99. 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
202
Power Flow Operation 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 prerequisite requirements for function not
met

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

1.100. 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.

1.103. 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 and 33.3.

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 (default alias is
efield_type) (0 by default)
APIOPTNS(1) = 0 for uniform geoelectric field
APIOPTNS(2) Units of Electric Field Magnitude (default
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 (de-
fault 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 (default alias is tielevels) (0
by default)
APIOPTNS(4) = 0 consider only study subsystem buses, no
buses from inter-ties

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

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 (default 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 (default alias is efield_deg) (0
by default)
VALUES(2) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
VALUES(3) substation grounding dc resistance in ohms
(default 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 (default 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 resistance
if R=0.0 in network data (default 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 (default alias is rptoptn) (-1 by
default)
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 (default 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
208
Power Flow Operation GIC

RPTOPTNS(3) report DC bus voltages (default alias is

rptdc_busv) (0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (default alias is
rptbrn_gic) (0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (default alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (default alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (default 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
209
Power Flow Operation GIC_2

1.104. 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 (default alias is tielevels) (0
by default)
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. (default 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
210
Power Flow Operation GIC_2

INTGOPTNS(3) Subsystem sid for local GMD hot spots (de-

fault 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) (default 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 (default 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 (default alias is efield_deg) (0
by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark,
not used when charoptns(1)=nonuniform
REALOPTNS(3) substation grounding dc resistance in ohms
(default 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 (default 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 resistance
if R=0.0 in network data (default 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
211
Power Flow Operation GIC_2

REALOPTNS(6) local GMD hot spots electric field magnitude

in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (default
alias is efield_mag_local) (realoptns(1) by de-
fault)
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 (default
alias is efield_deg_local) (realoptns(2) by de-
fault)
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 (default alias is
efield_type) (uniform 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 (default
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 (de-
fault 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 (default 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. (default
alias is earth_model_name) ( by default)

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

CHAROPTNS(6) Option to scan storm event scenarios (de-

fault 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 loss-
es added to the base case (default 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
213
Power Flow Operation GIC_2

EJETOPTNS(1) eletrojet current in million amperes, must be

>0 (default alias is ejet_million_amps) (no
default allowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (default alias is ejet_halfwidth_km) (no
default allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(default alias is ejet_period_min) (no default
allowed)
EJETOPTNS(4) height of current in km, must be >0 (default
alias is ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees (de-
fault 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). (default alias is
gicfile) (no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(default 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). (default 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) (default 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 (default alias is rptoptn) (-1 by
default)
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 (default alias
is rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (default alias is
rptdc_busv) (0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes

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

RPTOPTNS(4) report branch GIC flows (default alias is

rptbrn_gic) (0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (default alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (default alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (default 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
215
Power Flow Operation GIC_3

1.105. 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 (default alias is tielevels) (0
by default)
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. (default 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
216
Power Flow Operation GIC_3

INTGOPTNS(3) Subsystem sid for local GMD hot spots (de-

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

REALOPTNS(6) local GMD hot spots electric field magnitude

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

CHAROPTNS(6) Option to scan storm event scenarios (de-

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

EJETOPTNS(1) eletrojet current in million amperes, must be

>0 (default alias is ejet_million_amps) (no
default allowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (default alias is ejet_halfwidth_km) (no
default allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(default alias is ejet_period_min) (no default
allowed)
EJETOPTNS(4) height of current in km, must be >0 (default
alias is ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees (de-
fault 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). (default alias is
gicfile) (no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(default 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). (default 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) (default 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. (default alias is pygicfile)
( by default)
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 (default alias is rptoptn) (-1 by
default)
RPTOPTNS(1) = -1 report all
RPTOPTNS(1) = 0 no report

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

RPTOPTNS(1) > 0 Report these many maximum values in each

category
RPTOPTNS(2) report induced branch voltages (default alias
is rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (default alias is
rptdc_busv) (0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (default alias is
rptbrn_gic) (0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (default alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (default alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (default 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
221
Power Flow Operation GIC_4

1.106. 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 (default alias is tielevels) (0
by default)
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 es-
timated geoelectric field magnitude and are
provided in NERC TPL-007. (default 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
222
Power Flow Operation GIC_4

INTGOPTNS(3) Subsystem sid for supplemental GMD event

(default 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 (de-
fault alias is thermal_ana_optn) (0 by de-
fault)
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
(default 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
(default alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(default 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 (default 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 resistance
if R=0.0 in network data (default 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
223
Power Flow Operation GIC_4

REALOPTNS(6) supplemental event electric field magnitude

in units defined by charoptns(2), not used
when charoptns(1)=nonuniform (default
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 (default
alias is efield_deg_supp) (realoptns(2) by de-
fault)
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 con-
version factor, must be >0 (default 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 (default 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 (default alias is
efield_type) (uniform 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 (default
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 (de-
fault alias is addfile_optn) (rdch by default)

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

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 (default 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. (default
alias is earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (de-
fault 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

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

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 loss-
es added to the base case (default 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 (default alias is ejet_million_amps) (no
default allowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (default alias is ejet_halfwidth_km) (no
default allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(default alias is ejet_period_min) (no default
allowed)
EJETOPTNS(4) height of current in km, must be >0 (default
alias is ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees (de-
fault 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). (default alias is
gicfile) (no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(default 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). (default alias is purgfile) (blank by de-
fault)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC dc resistive network raw file. This rep-
resents the dc network used to calculate
GIC flow (output). (default alias is rnwkfile)
(blank by default)
FILEOPTNS(4) = ' ' no file created

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

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. (default alias is pygicfile)
(nooutput by default)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput
FILEOPTNS(6) Transformer Thermal Analysis GIC(t) CSV file
(output). (default alias is gictfile) (nooutput
by default)
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 (default alias is rptoptn) (-1 by
default)
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 (default alias
is rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (default alias is
rptdc_busv) (0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (default alias is
rptbrn_gic) (0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (default alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (default alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (default alias is
rpttrn_q) (1 by default)
RPTOPTNS(7) = 0 No

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

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
228
Power Flow Operation GIC_5

1.107. 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 (default alias is tielevels) (0
by default)
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 es-
timated geoelectric field magnitude and are

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

provided in NERC TPL-007. (default 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
(default 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 (de-
fault alias is thermal_ana_optn) (0 by de-
fault)
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 de-
gree scan calculation (default 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
(default 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
(default alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(default alias is substation_r) (0.1 by default)
REALOPTNS(3) = 0 Substation is ungrounded
REALOPTNS(3) > 0 Use specified grounding dc resistance

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

REALOPTNS(4) transmission line X/R ratio, must be >0, used

to calculate branch DC resistance if R=0.0 in
network data (default 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 resistance
if R=0.0 in network data (default 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 (default
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 (default
alias is efield_deg_supp) (realoptns(2) by de-
fault)
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 con-
version factor, must be >0 (default 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 (default 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 (default alias is degscan_step) (10.0 by
default)
REALOPTNS(10) = 0 Use default
REALOPTNS(10) > 0 Use specified
REALOPTNS(11) Magnitude Scan step size, must be >1.0 V/
km (default alias is magscan_step) (4.0 by
default)
REALOPTNS(11) = 0 Use default

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

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 (default alias is pf_qpct_step) (100.0 by
default)
REALOPTNS(12) = 0 Use default
REALOPTNS(12) > 0 Use specified
REALOPTNS(13) Magnitude Scan maximum storm strength,
must be >1.0 (default 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 (default alias is
efield_type) (uniform 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 (default
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 (de-
fault 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 (default 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

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

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. (default
alias is earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (de-
fault 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 loss-
es added to the base case (default 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

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

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 (default alias is ejet_million_amps) (no
default allowed)
EJETOPTNS(2) Cauchy distribution half-width in km, must
be >0 (default alias is ejet_halfwidth_km) (no
default allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(default alias is ejet_period_min) (no default
allowed)
EJETOPTNS(4) height of current in km, must be >0 (default
alias is ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees (de-
fault 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). (default alias is
gicfile) (no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(default 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). (default alias is purgfile) (blank by de-
fault)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC dc resistive network raw file. This rep-
resents the dc network used to calculate
GIC flow (output). (default alias is rnwkfile)
(blank 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. (default alias is pygicfile)
(nooutput by default)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput

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

FILEOPTNS(6) Transformer Thermal Analysis GIC(t) CSV file

(output). (default alias is gictfile) (nooutput
by default)
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 (default alias is rptoptn) (-1 by
default)
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 (default alias
is rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (default alias is
rptdc_busv) (0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (default alias is
rptbrn_gic) (0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (default alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (default alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (default 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
235
Power Flow Operation GIC_6

1.108. 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.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 (default alias is tielevels) (0
by default)
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 es-
timated geoelectric field magnitude and are
provided in NERC TPL-007. (default alias is
study_year) (0 by default)

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

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
(default 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 (de-
fault alias is thermal_ana_optn) (0 by de-
fault)
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 de-
gree scan calculation (default 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 trans-
formers in study subsystem (default 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 (default 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
(default 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
237
Power Flow Operation 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 (default
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 (default 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
(default 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)

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

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
(default alias is efield_deg) (0 by default)
REALOPTNS(2) > 0 when charoptns(1)=uniform or benchmark
REALOPTNS(3) substation grounding dc resistance in ohms
(default 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 (default 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 resistance
if R=0.0 in network data (default 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 (default
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 (default
alias is efield_deg_supp) (realoptns(2) by de-
fault)
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 con-
version factor, must be >0 (default alias is
branch_rac2rdc) (1.0 by default)
REALOPTNS(8) = 0 Use default
REALOPTNS(8) > 0 Use specified

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

REALOPTNS(9) transformer winding AC to DC resistance

conversion factor, must be >0 (default 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 (default alias is degscan_step) (10.0 by
default)
REALOPTNS(10) = 0 Use default
REALOPTNS(10) > 0 Use specified
REALOPTNS(11) Magnitude Scan step size, must be >1.0 V/
km (default 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 (default alias is pf_qpct_step) (100.0 by
default)
REALOPTNS(12) = 0 Use default
REALOPTNS(12) > 0 Use specified
REALOPTNS(13) Magnitude Scan maximum storm strength,
must be >1.0 (default 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 (default 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 intgoptns(8)>0 (default 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 cen-
ter point longitude in degrees, used on-
ly when intgoptns(8)=4 (default 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-

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

goptns(8)=4 (default 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).
CHAROPTNS(1) Electric Field Type (default alias is
efield_type) (uniform 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 (default
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 (de-
fault 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 (default 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. (default
alias is earth_model_name) ( by default)
CHAROPTNS(6) Option to scan storm event scenarios (de-
fault alias is scan_storm_event) ( by default)
CHAROPTNS(6) = no storm orientation and/or magnitude scan

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

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 loss-
es added to the base case (default 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 (default alias is ejet_million_amps) (no
default allowed)

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

EJETOPTNS(2) Cauchy distribution half-width in km, must

be >0 (default alias is ejet_halfwidth_km) (no
default allowed)
EJETOPTNS(3) period of variation in minutes, must be >0
(default alias is ejet_period_min) (no default
allowed)
EJETOPTNS(4) height of current in km, must be >0 (default
alias is ejet_height_km) (no default allowed)
EJETOPTNS(5) latitude of center of electrojet in degrees (de-
fault 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). (default alias is
gicfile) (no default allowed)
FILEOPTNS(2) GIC updates to Base Case file name (output).
(default 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). (default alias is purgfile) (blank by de-
fault)
FILEOPTNS(3) = ' ' no file created
FILEOPTNS(4) GIC dc resistive network raw file. This rep-
resents the dc network used to calculate
GIC flow (output). (default alias is rnwkfile)
(blank 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. (default alias is pygicfile)
(nooutput by default)
FILEOPTNS(5) = ' ' temporary file created
FILEOPTNS(5) = no file created
nooutput
FILEOPTNS(6) Transformer Thermal Analysis GIC(t) CSV file
(output). (default alias is gictfile) (nooutput
by default)
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 (default alias is rptoptn) (-1 by
default)

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

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 (default alias
is rptbrn_indv) (0 by default)
RPTOPTNS(2) = 0 No
RPTOPTNS(2) = 1 Yes
RPTOPTNS(3) report DC bus voltages (default alias is
rptdc_busv) (0 by default)
RPTOPTNS(3) = 0 No
RPTOPTNS(3) = 1 Yes
RPTOPTNS(4) report branch GIC flows (default alias is
rptbrn_gic) (0 by default)
RPTOPTNS(4) = 0 No
RPTOPTNS(4) = 1 Yes
RPTOPTNS(5) report transformer GIC flows (default alias is
rpttrn_gic) (1 by default)
RPTOPTNS(5) = 0 No
RPTOPTNS(5) = 1 Yes
RPTOPTNS(6) report substation GIC flows (default alias is
rptstn_gic) (0 by default)
RPTOPTNS(6) = 0 No
RPTOPTNS(6) = 1 Yes
RPTOPTNS(7) report transformer losses (default alias is
rpttrn_q) (1 by default)
RPTOPTNS(7) = 0 No
RPTOPTNS(7) = 1 Yes
RPTOPTNS(8) Subsystem sid for report (default 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 = 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

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

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 Earth Model is neither a Standard Earth Mod-
el nor defined as User Earth Model
IERR = 28 Earth model is required for Benchmark Event/
Nonuniform Electric Field calculations and/or
Transformer Thermal anallysis
IERR = 29 Transformer T model GIC data: WRI, WRJ and
WRK dc resistances must be specified for T
model
IERR = 30 Info - The Geographic Coordinates of the
magnetic dipole axis for study year %% are
not defined, used data from year %%
IERR = 31 gic.dll not loaded or entry point not found
IERR = 32 Error - All transformers must have vector
group specified
IERR = 33 Invalid Magnitude Scan maximum storm
strength

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

1.109. 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 = 0 no error occurred
IERR = 64 GIC Electric Field Waveshape Data file open
error, file ignored, GIC(t) calculations not
done
IERR = 65 GIC Electric Field Waveshape Data file error,
file ignored, GIC(t) calculations not done

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

1.110. 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
247
Power Flow Operation GIC_EFIELD_WAVESHAPE_SUPP

1.111. 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
248
Power Flow Operation GIC_MVARLOSS_SCALING_FACTORS

1.112. 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
249
Power Flow Operation GIC_PF

1.113. 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
250
Power Flow Operation 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
251
Power Flow Operation GIC_PF_OPTIONS

1.114. 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
252
Power Flow Operation GIC_PF_OPTIONS

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

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

1.115. GIC_THERMAL_IMPACT
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:

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
OPTIONS(5) = 0 Not In Use
OPTIONS(5) = 1 In Use

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

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
258
Power Flow Operation IECS

1.119. 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 (default alias is flt3ph) (0
by default)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-to-ground faults (default alias is fltlg) (0
by default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-line-to-ground faults (default alias is
fltllg) (0 by default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) line-to-line faults (default alias is fltll) (0 by
default)
STATUS(4) = 0 omit
STATUS(4) = 1 include
STATUS(5) report option (default alias is rptop) (1 by de-
fault)
STATUS(5) = 1 total fault currents

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

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
260
Power Flow Operation IECS_2

1.120. 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)

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

STATUS(5) = 2 fault contributions to N levels away

STATUS(5) = 3 total fault currents and fault contributions to
N levels away
STATUS(6) number of levels back for contributions (de-
fault alias is rptlvl) (0 by default)
STATUS(6) >= 0 used if STATUS(5) = 2 or 3
STATUS(7) location of fault (default 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 (default alias is linout) (0 by
default)
STATUS(8) = 0 omit
STATUS(8) = 1 include
STATUS(9) line-end faults (default alias is linend) (0 by
default)
STATUS(9) = 0 omit
STATUS(9) = 1 include
STATUS(10) transformer tap ratios and phase angles op-
tion (default 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 (default alias is lnchrg)
(1 by default)
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 (default alias
is shntop) (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 (default 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 (default alias is zcorec) (0 by
default)
STATUS(14) = 0 ignore

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

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).
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
263
Power Flow Operation IECS_3

1.121. 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)

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

STATUS(5) = 1 total fault currents

STATUS(5) = 2 fault contributions to N levels away
STATUS(5) = 3 total fault currents and fault contributions to
N levels away
STATUS(6) number of levels back for contributions (de-
fault alias is rptlvl) (0 by default)
STATUS(6) >= 0 used if STATUS(5) = 2 or 3
STATUS(7) location of fault (default 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 (default alias is linout) (0 by
default)
STATUS(8) = 0 omit
STATUS(8) = 1 include
STATUS(9) line-end faults (default alias is linend) (0 by
default)
STATUS(9) = 0 omit
STATUS(9) = 1 include
STATUS(10) transformer tap ratios and phase angles op-
tion (default 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 (default alias is lnchrg)
(1 by default)
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 (default alias
is shntop) (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 (default 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 (default alias is zcorec) (0 by
default)

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

STATUS(14) = 0 ignore
STATUS(14) = 1 apply
STATUS(15) option for Voltage Factor C (default alias is
cfactor) (1 by default)
STATUS(15) = 1 Voltage Factor C for maximum fault currents
(default)
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 (de-
fault alias is brktim) (5/base Frequency by de-
fault)
VALUES(2) user specified voltage factor c (default alias
is ucfactor) (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
266
Power Flow Operation IECS_4

1.122. 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 (default alias is flt3ph) (0
by default)
STATUS(1) = 0 omit
STATUS(1) = 1 include
STATUS(2) line-to-ground faults (default alias is fltlg) (0
by default)
STATUS(2) = 0 omit
STATUS(2) = 1 include
STATUS(3) line-line-to-ground faults (default alias is
fltllg) (0 by default)
STATUS(3) = 0 omit
STATUS(3) = 1 include
STATUS(4) line-to-line faults (default alias is fltll) (0 by
default)
STATUS(4) = 0 omit
STATUS(4) = 1 include
STATUS(5) report option (default alias is rptop) (1 by de-
fault)
STATUS(5) = 0 fault current summary table
STATUS(5) = 1 total fault currents

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

STATUS(5) = 2 fault contributions to N levels away

STATUS(5) = 3 total fault currents and fault contributions to
N levels away
STATUS(6) number of levels back for contributions (de-
fault alias is rptlvl) (0 by default)
STATUS(6) >= 0 used if STATUS(5) = 2 or 3
STATUS(7) location of fault (default 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 (default alias is linout) (0 by
default)
STATUS(8) = 0 omit
STATUS(8) = 1 include
STATUS(9) line-end faults (default alias is linend) (0 by
default)
STATUS(9) = 0 omit
STATUS(9) = 1 include
STATUS(10) transformer tap ratios and phase shift angles
option (default 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 (default alias is lnchrg)
(1 by default)
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 (default alias is shn-
top) (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 (default alias
is dcload) (0 by default)
STATUS(13) = 0 blocked

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

STATUS(13) = 1 represent as load

STATUS(14) zero sequence transformer impedance cor-
rection option (default alias is zcorec) (0 by
default)
STATUS(14) = 0 ignore
STATUS(14) = 1 apply
STATUS(15) option for Voltage Factor C (default 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 (default alias is loadop) (1 by de-
fault)
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" (default alias is genxop) (0 by de-
fault)
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 (de-
fault alias is brktim) (5/base Frequency by de-
fault)
VALUES(2) user specified voltage factor c (default alias
is ucfactor) (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

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

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
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
270
Power Flow Operation IECS_SCFILE

1.123. 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:

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
274
Power Flow Operation IMPLEMENT_TRANSFER

1.127. 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
275
Power Flow Operation 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
276
Power Flow Operation 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
277
Power Flow Operation IMPLEMENT_TRANSFER_2

1.128. 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 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 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
278
Power Flow Operation 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
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 2 elements specifying transfer increment in MW(input).
RVAL(1) transfer increment in MW (no default al-
lowed)
RVAL(2) power factor for load increases in dispatch
methods 2, 3 and 4. < OR = 0.0 to retain the
original power factor at each load 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 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).

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

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 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
280
Power Flow Operation INLF

1.129. 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
281
Power Flow Operation 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
282
Power Flow Operation INLF_2

1.130. 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).

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

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
287
Power Flow Operation JOIN

1.134. 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
288
Power Flow Operation LAMP

1.135. 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)

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
292
Power Flow Operation LIST

1.139. 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
293
Power Flow Operation 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
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
294
Power Flow Operation LISTCONTINGENCYSAVEDCASES

1.140. 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
295
Power Flow Operation LLRF

1.141. 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
296
Power Flow Operation 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
297
Power Flow Operation LOAD_REDUCTION

1.142. 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.

1.145. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
301
Power Flow Operation 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
302
Power Flow Operation 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
303
Power Flow Operation 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
304
Power Flow Operation 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
305
Power Flow Operation MACCC_2

1.146. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
306
Power Flow Operation 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
307
Power Flow Operation 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
308
Power Flow Operation 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
309
Power Flow Operation 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
310
Power Flow Operation MACCC_PARALLEL

1.147. 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
311
Power Flow Operation 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
312
Power Flow Operation 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
313
Power Flow Operation 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
314
Power Flow Operation 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
315
Power Flow Operation MACCC_TRIP_COR

1.148. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
316
Power Flow Operation 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
317
Power Flow Operation 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
318
Power Flow Operation 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
319
Power Flow Operation 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
320
Power Flow Operation MACCC_TRIP_COR

IERR = 12 invalid VALUES value

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

1.149. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
322
Power Flow Operation 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
323
Power Flow Operation 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
324
Power Flow Operation 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
325
Power Flow Operation 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
326
Power Flow Operation 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
327
Power Flow Operation MACCC_TRIP_COR_3

1.150. 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

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

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) 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

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

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
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

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

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
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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
331
Power Flow Operation MACCC_TRIP_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 (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
332
Power Flow Operation 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
333
Power Flow Operation 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
334
Power Flow Operation MACCC_WITH_COR

1.151. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
335
Power Flow Operation 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
336
Power Flow Operation 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
337
Power Flow Operation 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
338
Power Flow Operation 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
339
Power Flow Operation MACCC_WITH_COR_2

1.152. 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,

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
340
Power Flow Operation 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
341
Power Flow Operation 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
342
Power Flow Operation 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
343
Power Flow Operation 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
344
Power Flow Operation 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
345
Power Flow Operation MACCC_WITH_COR_3

1.153. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
346
Power Flow Operation 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
347
Power Flow Operation 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
348
Power Flow Operation 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
349
Power Flow Operation 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
350
Power Flow Operation 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
351
Power Flow Operation MACCC_WITH_TRIP

1.154. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
352
Power Flow Operation 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
353
Power Flow Operation 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
354
Power Flow Operation 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
355
Power Flow Operation 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
356
Power Flow Operation MACCC_WITH_TRIP_2

1.155. 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)

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
357
Power Flow Operation 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
358
Power Flow Operation 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
359
Power Flow Operation 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
360
Power Flow Operation 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
361
Power Flow Operation MACCC_WITH_TRIP_PARALLEL

1.156. 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
362
Power Flow Operation 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
363
Power Flow Operation 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
364
Power Flow Operation 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
365
Power Flow Operation 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
366
Power Flow Operation MATRIX_GROWTH_FACTOR

1.157. 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
367
Power Flow Operation MBID2DC

1.158. 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:

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

1.162. 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:

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

1.167. 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:

1.172. 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
382
Power Flow Operation MODR

Where:

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

1.186. 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
397
Power Flow Operation MSLV

1.187. 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)

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
402
Power Flow Operation MWMI

1.191. 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
403
Power Flow Operation 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
404
Power Flow Operation MWOMWMSF

1.192. 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
405
Power Flow Operation MWOMWOSF

1.193. 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).

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

1.194. 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
407
Power Flow Operation 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
408
Power Flow Operation 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 PSS/E-25 or later
DFAX file--run DFAX

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
409
Power Flow Operation 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
410
Power Flow Operation N11_ACCC_2

1.195. 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
411
Power Flow Operation 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
412
Power Flow Operation 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
413
Power Flow Operation 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 PSS/E-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
414
Power Flow Operation N11_ACCC_PARALLEL

1.196. 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
415
Power Flow Operation 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
416
Power Flow Operation 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
417
Power Flow Operation 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
418
Power Flow Operation N11_ACCC_PSCOPF

1.197. 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:

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
419
Power Flow Operation 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
420
Power Flow Operation 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
421
Power Flow Operation 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
422
Power Flow Operation 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
423
Power Flow Operation 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 PSS/E-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
424
Power Flow Operation 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
425
Power Flow Operation N11_ACCC_PSCOPF_2

1.198. 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, thrfile, inlfile)

Fortran command syntax:

CALL N11_ACCC_PSCOPF_2(OPTIONS, OPTCOR, VALUES, LABELS, 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

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
426
Power Flow Operation 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
427
Power Flow Operation 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
428
Power Flow Operation 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
429
Power Flow Operation 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
430
Power Flow Operation 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
431
Power Flow Operation 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
432
Power Flow Operation NETG

1.199. 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.

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
436
Power Flow Operation NEWTON_TOLERANCE

1.203. 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
437
Power Flow Operation NEW_DIMENSION

1.204. 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

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

1.205. 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
439
Power Flow Operation NON_TRANS_PERCENT_UNITS

1.206. 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
440
Power Flow Operation NSOL

1.207. 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).

All material contained in this documentation is proprietary to Siemens Industry Inc., Siemens Power Technologies International
441
Power Flow Operation 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
442
Power Flow Operation NUMBER_THREADS

1.208. 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
443
Power Flow Operation ORDR

1.209. 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
444
Power Flow Operation OTDF

1.210. 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:

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
448
Power Flow Operation OWNM

STATUS(6) = 1 change VSC dc line owners to IONEW

1.217. PATH
Use this API to specify a directory pathname.

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
455
Power Flow Operation PHASE_SHIFT_ADJUSTMENT

1.218. 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:

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

1.219. 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
457
Power Flow Operation 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
458
Power Flow Operation 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
459
Power Flow Operation POUT

1.220. 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:

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

1.221. 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
461
Power Flow Operation PP_ACCC

1.222. 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
462
Power Flow Operation 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
463
Power Flow Operation PP_ACCC_MULTI_CASE

1.223. 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
464
Power Flow Operation 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
465
Power Flow Operation 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
466
Power Flow Operation PRINT_OUTAGED_BRANCHES

1.224. 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
467
Power Flow Operation PRINT_WINDING_BUSES

1.225. 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
468
Power Flow Operation PROGRESS_OUTPUT

1.226. 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
469
Power Flow Operation PROMPT_OUTPUT

1.227. 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
470
Power Flow Operation PRTI

1.228. 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()