.. _RenPlant:

================================================================================
RenPlant
================================================================================
Renewable plant control group.

Common Parameters: u, name

Available models:
REPCA1_

.. _REPCA1:

--------------------------------------------------------------------------------
REPCA1
--------------------------------------------------------------------------------
REPCA1: renewable energy power plat control model.

The output of the model, ``Pext`` and ``Qext``,  are the increment signals
of active and reactive power for the electrical control model.

Notes for PSS/E DYR parser:

1. If ICONs M+1 and M+2 are set to 0 when using generator power, an error
   will be thrown by the parser, saying "<REPCA1> cannot retrieve <bus1>
   from <ACLine> using <line>: KeyError('Group <ACLine> does not contain
   device with idx=False')". Manual effort is required to run the converted
   file. In the REPCA1 sheet, provide the idx of a line that connects to the
   RenGen bus.

2. PSS/E enters ICONs M+3 as a string in single quotes. The pair of single
   quotes need to be removed, or the conversion will fail.

Parameters
----------

+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|   Name   |      Symbol      |                           Description                            | Default |    Unit     | Properties |
+==========+==================+==================================================================+=========+=============+============+
|  idx     |                  | unique device idx                                                |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  u       | :math:`u`        | connection status                                                | 1       | *bool*      |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  name    |                  | device name                                                      |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  ree     |                  | RenExciter idx                                                   |         |             | mandatory  |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  line    |                  | Idx of line that connect to measured bus                         |         |             | mandatory  |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  busr    |                  | Optional remote bus for voltage and freq. measurement            |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  busf    |                  | BusFreq idx for mode 2                                           |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  VCFlag  |                  | Droop flag; 0-with droop if power factor ctrl, 1-line drop comp. |         | *bool*      | mandatory  |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  RefFlag |                  | Q/V select; 0-Q control, 1-V control                             |         | *bool*      | mandatory  |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Fflag   |                  | Frequency control flag; 0-disable, 1-enable                      |         | *bool*      | mandatory  |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  PLflag  |                  | Pline ctrl. flag; 0-disable, 1-enable                            | True    | *bool*      |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Tfltr   | :math:`T_{fltr}` | V or Q filter time const.                                        | 0.020   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Kp      | :math:`K_p`      | Q proportional gain                                              | 1       |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Ki      | :math:`K_i`      | Q integral gain                                                  | 0.100   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Tft     | :math:`T_{ft}`   | Lead time constant                                               | 1       |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Tfv     | :math:`T_{fv}`   | Lag time constant                                                | 1       |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Vfrz    | :math:`V_{frz}`  | Voltage below which s2 is frozen                                 | 0.800   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Rc      | :math:`R_c`      | Line drop compensation R                                         |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Xc      | :math:`X_c`      | Line drop compensation R                                         |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Kc      | :math:`K_c`      | Reactive power compensation gain                                 | 0       |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  emax    | :math:`e_{max}`  | Upper limit on deadband output                                   | 999     |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  emin    | :math:`e_{min}`  | Lower limit on deadband output                                   | -999    |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  dbd1    | :math:`d_{bd1}`  | Lower threshold for reactive power control deadband (<=0)        | -0.100  |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  dbd2    | :math:`d_{bd2}`  | Upper threshold for reactive power control deadband (>=0)        | 0.100   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Qmax    | :math:`Q_{max}`  | Upper limit on output of V-Q control                             | 999     |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Qmin    | :math:`Q_{min}`  | Lower limit on output of V-Q control                             | -999    |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Kpg     | :math:`K_{pg}`   | Proportional gain for power control                              | 1       |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Kig     | :math:`K_{ig}`   | Integral gain for power control                                  | 0.100   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Tp      | :math:`T_p`      | Time constant for P measurement                                  | 0.020   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  fdbd1   | :math:`f_{dbd1}` | Lower threshold for freq. error deadband                         | -0.000  | *p.u. (Hz)* |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  fdbd2   | :math:`f_{dbd2}` | Upper threshold for freq. error deadband                         | 0.000   | *p.u. (Hz)* |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  femax   | :math:`f_{emax}` | Upper limit for freq. error                                      | 0.050   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  femin   | :math:`f_{emin}` | Lower limit for freq. error                                      | -0.050  |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Pmax    | :math:`P_{max}`  | Upper limit on power error (used by PI ctrl.)                    | 999     | *p.u. (MW)* | power      |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Pmin    | :math:`P_{min}`  | Lower limit on power error (used by PI ctrl.)                    | -999    | *p.u. (MW)* | power      |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Tg      | :math:`T_g`      | Power controller lag time constant                               | 0.020   |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Ddn     | :math:`D_{dn}`   | Reciprocal of droop for over-freq. conditions                    | 10      |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  Dup     | :math:`D_{up}`   | Reciprocal of droop for under-freq. conditions                   | 10      |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  reg     |                  | Retrieved RenGen idx                                             |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  bus     |                  | Retrieved bus idx                                                |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  bus1    |                  | Retrieved Line.bus1 idx                                          |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  bus2    |                  | Retrieved Line.bus2 idx                                          |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  r       |                  | Retrieved Line.r                                                 |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+
|  x       |                  | Retrieved Line.x                                                 |         |             |            |
+----------+------------------+------------------------------------------------------------------+---------+-------------+------------+

Variables
---------

+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|    Name     |       Symbol        |   Type   |               Description                |    Unit     | Properties |
+=============+=====================+==========+==========================================+=============+============+
|  s0_y       | :math:`y_{s_0}`     | State    | State in lag transfer function           |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s1_y       | :math:`y_{s_1}`     | State    | State in lag transfer function           |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s2_xi      | :math:`xi_{s_2}`    | State    | Integrator output                        |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s3_x       | :math:`x'_{s_3}`    | State    | State in lead-lag                        |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s4_y       | :math:`y_{s_4}`     | State    | State in lag transfer function           |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s5_xi      | :math:`xi_{s_5}`    | State    | Integrator output                        |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s6_y       | :math:`y_{s_6}`     | State    | State in lag transfer function           |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Vref       | :math:`Q_{ref}`     | Algeb    |                                          |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Qlinef     | :math:`Q_{linef}`   | Algeb    |                                          |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Refsel     | :math:`R_{efsel}`   | Algeb    |                                          |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  dbd_y      | :math:`y_{d^{bd}}`  | Algeb    | Deadband type 1 output                   |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  enf        | :math:`e_{nf}`      | Algeb    | e Hardlimit output before freeze         |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s2_ys      | :math:`ys_{s_2}`    | Algeb    | PI summation before limit                |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s2_y       | :math:`y_{s_2}`     | Algeb    | PI output                                |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s3_y       | :math:`y_{s_3}`     | Algeb    | Output of lead-lag                       |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  ferr       | :math:`f_{err}`     | Algeb    | Frequency deviation                      | *p.u. (Hz)* | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  fdbd_y     | :math:`y_{f^{dbd}}` | Algeb    | Deadband type 1 output                   |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Plant_pref | :math:`P_{ref}`     | Algeb    | Plant P ref                              |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Plerr      | :math:`P_{lerr}`    | Algeb    | Pline error                              |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Perr       | :math:`P_{err}`     | Algeb    | Power error before fe limits             |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s5_ys      | :math:`ys_{s_5}`    | Algeb    | PI summation before limit                |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  s5_y       | :math:`y_{s_5}`     | Algeb    | PI output                                |             | v_str      |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Pext       | :math:`P_{ext}`     | ExtAlgeb | Pref from RenExciter renamed as Pext     |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  Qext       | :math:`Q_{ext}`     | ExtAlgeb | Qref from RenExciter renamed as Qext     |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  v          | :math:`V`           | ExtAlgeb | Bus (or busr, if given) terminal voltage |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  a          | :math:`\theta`      | ExtAlgeb | Bus (or busr, if given) phase angle      |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  f          | :math:`f`           | ExtAlgeb | Bus frequency                            | *p.u.*      |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  v1         | :math:`V_{1}`       | ExtAlgeb | Voltage at Line.bus1                     |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  v2         | :math:`V_{2}`       | ExtAlgeb | Voltage at Line.bus2                     |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  a1         | :math:`\theta_{1}`  | ExtAlgeb | Angle at Line.bus1                       |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+
|  a2         | :math:`\theta_{2}`  | ExtAlgeb | Angle at Line.bus2                       |             |            |
+-------------+---------------------+----------+------------------------------------------+-------------+------------+

Initialization Equations
------------------------

+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|    Name     |       Symbol        |   Type   |                                                        Initial Value                                                        |
+=============+=====================+==========+=============================================================================================================================+
|  s0_y       | :math:`y_{s_0}`     | State    | :math:`V_{comp} s_1^{SW_{VC}} + s_0^{SW_{VC}} \left(K_{c} Q_{line} + V\right)`                                              |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s1_y       | :math:`y_{s_1}`     | State    | :math:`Q_{line}`                                                                                                            |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s2_xi      | :math:`xi_{s_2}`    | State    | :math:`0.0`                                                                                                                 |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s3_x       | :math:`x'_{s_3}`    | State    | :math:`y_{s_2}`                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s4_y       | :math:`y_{s_4}`     | State    | :math:`P_{line}`                                                                                                            |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s5_xi      | :math:`xi_{s_5}`    | State    | :math:`0.0`                                                                                                                 |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s6_y       | :math:`y_{s_6}`     | State    | :math:`y_{s_5}`                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Vref       | :math:`Q_{ref}`     | Algeb    | :math:`V_{ref0}`                                                                                                            |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Qlinef     | :math:`Q_{linef}`   | Algeb    | :math:`Q_{line0}`                                                                                                           |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Refsel     | :math:`R_{efsel}`   | Algeb    | :math:`s_0^{SW_{Ref}} \left(Q_{linef} - y_{s_1}\right) + s_1^{SW_{Ref}} \left(Q_{ref} - y_{s_0}\right)`                     |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  dbd_y      | :math:`y_{d^{bd}}`  | Algeb    | :math:`1.0 z_l^{db_{d^{bd}}} \left(R_{efsel} - d_{bd1}\right) + 1.0 z_u^{db_{d^{bd}}} \left(R_{efsel} - d_{bd2}\right)`     |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  enf        | :math:`e_{nf}`      | Algeb    | :math:`e_{max} z_u^{e_{HL}} + e_{min} z_l^{e_{HL}} + y_{d^{bd}} z_i^{e_{HL}}`                                               |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s2_ys      | :math:`ys_{s_2}`    | Algeb    | :math:`K_{p} e_{hld}`                                                                                                       |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s2_y       | :math:`y_{s_2}`     | Algeb    | :math:`Q_{max} z_u^{lim_{s_2}} + Q_{min} z_l^{lim_{s_2}} + ys_{s_2} z_i^{lim_{s_2}}`                                        |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s3_y       | :math:`y_{s_3}`     | Algeb    | :math:`y_{s_2}`                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  ferr       | :math:`f_{err}`     | Algeb    | :math:`- f + f_{ref}`                                                                                                       |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  fdbd_y     | :math:`y_{f^{dbd}}` | Algeb    | :math:`1.0 z_l^{db_{f^{dbd}}} \left(- f_{dbd1} + f_{err}\right) + 1.0 z_u^{db_{f^{dbd}}} \left(- f_{dbd2} + f_{err}\right)` |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Plant_pref | :math:`P_{ref}`     | Algeb    | :math:`P_{line0}`                                                                                                           |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Plerr      | :math:`P_{lerr}`    | Algeb    | :math:`P_{ref} - y_{s_4}`                                                                                                   |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Perr       | :math:`P_{err}`     | Algeb    | :math:`D_{dn} y_{f^{dbd}} z_1^{f_{dlt0}} + D_{up} y_{f^{dbd}} z_0^{f_{dlt0}} + P_{lerr} s_1^{SW_{PL}}`                      |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s5_ys      | :math:`ys_{s_5}`    | Algeb    | :math:`K_{pg} \left(P_{err} z_i^{f_{eHL}} + f_{emax} z_u^{f_{eHL}} + f_{emin} z_l^{f_{eHL}}\right)`                         |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  s5_y       | :math:`y_{s_5}`     | Algeb    | :math:`P_{max} z_u^{lim_{s_5}} + P_{min} z_l^{lim_{s_5}} + ys_{s_5} z_i^{lim_{s_5}}`                                        |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Pext       | :math:`P_{ext}`     | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  Qext       | :math:`Q_{ext}`     | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  v          | :math:`V`           | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  a          | :math:`\theta`      | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  f          | :math:`f`           | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  v1         | :math:`V_{1}`       | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  v2         | :math:`V_{2}`       | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  a1         | :math:`\theta_{1}`  | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+
|  a2         | :math:`\theta_{2}`  | ExtAlgeb |                                                                                                                             |
+-------------+---------------------+----------+-----------------------------------------------------------------------------------------------------------------------------+

Differential Equations
-----------------------------

+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+
|  Name  |      Symbol      | Type  |                                               RHS of Equation "T x' = f(x, y)"                                               |     T (LHS)      |
+========+==================+=======+==============================================================================================================================+==================+
|  s0_y  | :math:`y_{s_0}`  | State | :math:`V_{comp} s_1^{SW_{VC}} + s_0^{SW_{VC}} \left(K_{c} Q_{line} + V\right) - y_{s_0}`                                     | :math:`T_{fltr}` |
+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+
|  s1_y  | :math:`y_{s_1}`  | State | :math:`Q_{line} - y_{s_1}`                                                                                                   | :math:`T_{fltr}` |
+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+
|  s2_xi | :math:`xi_{s_2}` | State | :math:`K_{i} \left(e_{hld} + 2 y_{s_2} - 2 ys_{s_2}\right)`                                                                  |                  |
+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+
|  s3_x  | :math:`x'_{s_3}` | State | :math:`- x'_{s_3} + y_{s_2}`                                                                                                 | :math:`T_{fv}`   |
+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+
|  s4_y  | :math:`y_{s_4}`  | State | :math:`P_{line} - y_{s_4}`                                                                                                   | :math:`T_p`      |
+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+
|  s5_xi | :math:`xi_{s_5}` | State | :math:`K_{ig} \left(P_{err} z_i^{f_{eHL}} + f_{emax} z_u^{f_{eHL}} + f_{emin} z_l^{f_{eHL}} + 2 y_{s_5} - 2 ys_{s_5}\right)` |                  |
+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+
|  s6_y  | :math:`y_{s_6}`  | State | :math:`y_{s_5} - y_{s_6}`                                                                                                    | :math:`T_g`      |
+--------+------------------+-------+------------------------------------------------------------------------------------------------------------------------------+------------------+

Algebraic Equations
-----------------------------

+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|    Name     |       Symbol        |   Type   |                                                              RHS of Equation "0 = g(x, y)"                                                              |
+=============+=====================+==========+=========================================================================================================================================================+
|  Vref       | :math:`Q_{ref}`     | Algeb    | :math:`- Q_{ref} + V_{ref0}`                                                                                                                            |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Qlinef     | :math:`Q_{linef}`   | Algeb    | :math:`Q_{line0} - Q_{linef}`                                                                                                                           |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Refsel     | :math:`R_{efsel}`   | Algeb    | :math:`- R_{efsel} + s_0^{SW_{Ref}} \left(Q_{linef} - y_{s_1}\right) + s_1^{SW_{Ref}} \left(Q_{ref} - y_{s_0}\right)`                                   |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  dbd_y      | :math:`y_{d^{bd}}`  | Algeb    | :math:`- y_{d^{bd}} + 1.0 z_l^{db_{d^{bd}}} \left(R_{efsel} - d_{bd1}\right) + 1.0 z_u^{db_{d^{bd}}} \left(R_{efsel} - d_{bd2}\right)`                  |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  enf        | :math:`e_{nf}`      | Algeb    | :math:`e_{max} z_u^{e_{HL}} + e_{min} z_l^{e_{HL}} - e_{nf} + y_{d^{bd}} z_i^{e_{HL}}`                                                                  |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  s2_ys      | :math:`ys_{s_2}`    | Algeb    | :math:`K_{p} e_{hld} + xi_{s_2} - ys_{s_2}`                                                                                                             |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  s2_y       | :math:`y_{s_2}`     | Algeb    | :math:`Q_{max} z_u^{lim_{s_2}} + Q_{min} z_l^{lim_{s_2}} - y_{s_2} + ys_{s_2} z_i^{lim_{s_2}}`                                                          |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  s3_y       | :math:`y_{s_3}`     | Algeb    | :math:`T_{ft} \left(- x'_{s_3} + y_{s_2}\right) + T_{fv} x'_{s_3} - T_{fv} y_{s_3} + \left(z_1^{LT_{s_3}}\right)^{2} \left(- x'_{s_3} + y_{s_3}\right)` |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  ferr       | :math:`f_{err}`     | Algeb    | :math:`- f - f_{err} + f_{ref}`                                                                                                                         |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  fdbd_y     | :math:`y_{f^{dbd}}` | Algeb    | :math:`- y_{f^{dbd}} + 1.0 z_l^{db_{f^{dbd}}} \left(- f_{dbd1} + f_{err}\right) + 1.0 z_u^{db_{f^{dbd}}} \left(- f_{dbd2} + f_{err}\right)`             |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Plant_pref | :math:`P_{ref}`     | Algeb    | :math:`P_{line0} - P_{ref}`                                                                                                                             |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Plerr      | :math:`P_{lerr}`    | Algeb    | :math:`- P_{lerr} + P_{ref} - y_{s_4}`                                                                                                                  |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Perr       | :math:`P_{err}`     | Algeb    | :math:`D_{dn} y_{f^{dbd}} z_1^{f_{dlt0}} + D_{up} y_{f^{dbd}} z_0^{f_{dlt0}} - P_{err} + P_{lerr} s_1^{SW_{PL}}`                                        |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  s5_ys      | :math:`ys_{s_5}`    | Algeb    | :math:`K_{pg} \left(P_{err} z_i^{f_{eHL}} + f_{emax} z_u^{f_{eHL}} + f_{emin} z_l^{f_{eHL}}\right) + xi_{s_5} - ys_{s_5}`                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  s5_y       | :math:`y_{s_5}`     | Algeb    | :math:`P_{max} z_u^{lim_{s_5}} + P_{min} z_l^{lim_{s_5}} - y_{s_5} + ys_{s_5} z_i^{lim_{s_5}}`                                                          |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Pext       | :math:`P_{ext}`     | ExtAlgeb | :math:`s_1^{SW_{F}} y_{s_6}`                                                                                                                            |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  Qext       | :math:`Q_{ext}`     | ExtAlgeb | :math:`y_{s_3}`                                                                                                                                         |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  v          | :math:`V`           | ExtAlgeb | :math:`0`                                                                                                                                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  a          | :math:`\theta`      | ExtAlgeb | :math:`0`                                                                                                                                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  f          | :math:`f`           | ExtAlgeb | :math:`0`                                                                                                                                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  v1         | :math:`V_{1}`       | ExtAlgeb | :math:`0`                                                                                                                                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  v2         | :math:`V_{2}`       | ExtAlgeb | :math:`0`                                                                                                                                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  a1         | :math:`\theta_{1}`  | ExtAlgeb | :math:`0`                                                                                                                                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+
|  a2         | :math:`\theta_{2}`  | ExtAlgeb | :math:`0`                                                                                                                                               |
+-------------+---------------------+----------+---------------------------------------------------------------------------------------------------------------------------------------------------------+

Services
----------

+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|   Name    |      Symbol       |                                                                                  Equation                                                                                  |     Type     |
+===========+===================+============================================================================================================================================================================+==============+
|  Isign    | :math:`I_{sign}`  | :math:`0`                                                                                                                                                                  | CurrentSign  |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Iline    | :math:`I_{line}`  | :math:`\frac{I_{sign} \left(V_{1} e^{i \theta_{1}} - V_{2} e^{i \theta_{2}}\right)}{r + i x}`                                                                              | VarService   |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Iline0   | :math:`I_{line0}` | :math:`I_{line}`                                                                                                                                                           | ConstService |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Pline    | :math:`P_{line}`  | :math:`\operatorname{re}{\left(I_{sign} V_{1} \operatorname{conj}{\left(\frac{V_{1} e^{i \theta_{1}} - V_{2} e^{i \theta_{2}}}{r + i x} \right)} e^{i \theta_{1}}\right)}` | VarService   |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Pline0   | :math:`P_{line0}` | :math:`P_{line}`                                                                                                                                                           | ConstService |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Qline    | :math:`Q_{line}`  | :math:`\operatorname{im}{\left(I_{sign} V_{1} \operatorname{conj}{\left(\frac{V_{1} e^{i \theta_{1}} - V_{2} e^{i \theta_{2}}}{r + i x} \right)} e^{i \theta_{1}}\right)}` | VarService   |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Qline0   | :math:`Q_{line0}` | :math:`Q_{line}`                                                                                                                                                           | ConstService |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Vcomp    | :math:`V_{comp}`  | :math:`\left|{I_{line} \left(R_{cs} + i X_{cs}\right) - V e^{i \theta}}\right|`                                                                                            | VarService   |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Vref0    | :math:`V_{ref0}`  | :math:`V_{comp} s_1^{SW_{VC}} + s_0^{SW_{VC}} \left(K_{c} Q_{line0} + V\right)`                                                                                            | ConstService |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  zf       | :math:`z_f`       | :math:`f_{rz} \operatorname{Indicator}{\left(V < V_{frz} \right)}`                                                                                                         | VarService   |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  eHld     | :math:`e_{hld}`   | :math:`0`                                                                                                                                                                  | VarHold      |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+
|  Freq_ref | :math:`f_{ref}`   | :math:`1.0`                                                                                                                                                                | ConstService |
+-----------+-------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+--------------+

Discretes
-----------

+----------+----------------------+-------------+------------------------------------------+
|   Name   |        Symbol        |    Type     |                   Info                   |
+==========+======================+=============+==========================================+
|  SWVC    | :math:`SW_{VC}`      | Switcher    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  SWRef   | :math:`SW_{Ref}`     | Switcher    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  SWF     | :math:`SW_{F}`       | Switcher    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  SWPL    | :math:`SW_{PL}`      | Switcher    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  dbd_db  | :math:`db_{d^{bd}}`  | DeadBand    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  eHL     | :math:`e_{HL}`       | Limiter     | Hardlimit on deadband output             |
+----------+----------------------+-------------+------------------------------------------+
|  s2_lim  | :math:`lim_{s_2}`    | HardLimiter |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  s3_LT1  | :math:`LT_{s_3}`     | LessThan    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  s3_LT2  | :math:`LT_{s_3}`     | LessThan    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  fdbd_db | :math:`db_{f^{dbd}}` | DeadBand    |                                          |
+----------+----------------------+-------------+------------------------------------------+
|  fdlt0   | :math:`f_{dlt0}`     | LessThan    | frequency deadband output less than zero |
+----------+----------------------+-------------+------------------------------------------+
|  feHL    | :math:`f_{eHL}`      | Limiter     | Limiter for power (frequency) error      |
+----------+----------------------+-------------+------------------------------------------+
|  s5_lim  | :math:`lim_{s_5}`    | HardLimiter |                                          |
+----------+----------------------+-------------+------------------------------------------+

Blocks
-------

+-------+-----------------+-----------+------------------------------+
| Name  |     Symbol      |   Type    |             Info             |
+=======+=================+===========+==============================+
|  s0   | :math:`s_0`     | Lag       | V filter                     |
+-------+-----------------+-----------+------------------------------+
|  s1   | :math:`s_1`     | Lag       |                              |
+-------+-----------------+-----------+------------------------------+
|  dbd  | :math:`d^{bd}`  | DeadBand1 |                              |
+-------+-----------------+-----------+------------------------------+
|  s2   | :math:`s_2`     | PITrackAW | PI controller for eHL output |
+-------+-----------------+-----------+------------------------------+
|  s3   | :math:`s_3`     | LeadLag   |                              |
+-------+-----------------+-----------+------------------------------+
|  s4   | :math:`s_4`     | Lag       | Pline filter                 |
+-------+-----------------+-----------+------------------------------+
|  fdbd | :math:`f^{dbd}` | DeadBand1 | frequency error deadband     |
+-------+-----------------+-----------+------------------------------+
|  s5   | :math:`s_5`     | PITrackAW | PI for fe limiter output     |
+-------+-----------------+-----------+------------------------------+
|  s6   | :math:`s_6`     | Lag       | Output filter for Pext       |
+-------+-----------------+-----------+------------------------------+


Config Fields in [REPCA1]

+---------------+----------------+-------+------------------------------------------------+-----------------+
|    Option     |     Symbol     | Value |                      Info                      | Accepted values |
+===============+================+=======+================================================+=================+
|  allow_adjust |                | 1     | allow adjusting upper or lower limits          | (0, 1)          |
+---------------+----------------+-------+------------------------------------------------+-----------------+
|  adjust_lower |                | 0     | adjust lower limit                             | (0, 1)          |
+---------------+----------------+-------+------------------------------------------------+-----------------+
|  adjust_upper |                | 1     | adjust upper limit                             | (0, 1)          |
+---------------+----------------+-------+------------------------------------------------+-----------------+
|  kqs          | :math:`K_{qs}` | 2     | Tracking gain for reactive power PI controller |                 |
+---------------+----------------+-------+------------------------------------------------+-----------------+
|  ksg          | :math:`K_{sg}` | 2     | Tracking gain for active power PI controller   |                 |
+---------------+----------------+-------+------------------------------------------------+-----------------+
|  freeze       | :math:`f_{rz}` | 1     | Voltage dip freeze flag; 1-enable, 0-disable   |                 |
+---------------+----------------+-------+------------------------------------------------+-----------------+