.. _RenPitch:

================================================================================
RenPitch
================================================================================
Renewable generator pitch controller group.

Common Parameters: u, name, rea

Available models:
WTPTA1_

.. _WTPTA1:

--------------------------------------------------------------------------------
WTPTA1
--------------------------------------------------------------------------------
Wind turbine pitch control model.

Parameters
----------

+---------+----------------------+--------------------------------------+---------+--------+------------+
|  Name   |        Symbol        |             Description              | Default |  Unit  | Properties |
+=========+======================+======================================+=========+========+============+
|  idx    |                      | unique device idx                    |         |        |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  u      | :math:`u`            | connection status                    | 1       | *bool* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  name   |                      | device name                          |         |        |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  rea    |                      | Renewable aerodynamics model idx     |         |        | mandatory  |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  Kiw    | :math:`K_{iw}`       | Pitch-control integral gain          | 0.100   | *p.u.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  Kpw    | :math:`K_{pw}`       | Pitch-control proportional gain      | 0       | *p.u.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  Kic    | :math:`K_{ic}`       | Pitch-compensation integral gain     | 0.100   | *p.u.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  Kpc    | :math:`K_{pc}`       | Pitch-compensation proportional gain | 0       | *p.u.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  Kcc    | :math:`K_{cc}`       | Gain for P diff                      | 0       | *p.u.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  Tp     | :math:`T_{\theta}`   | Blade response time const.           | 0.300   | *s*    |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  thmax  | :math:`\theta_{max}` | Max. pitch angle                     | 30      | *deg.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  thmin  | :math:`\theta_{min}` | Min. pitch angle                     | 0       | *deg.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  dthmax | :math:`\theta_{max}` | Max. pitch angle rate                | 5       | *deg.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  dthmin | :math:`\theta_{min}` | Min. pitch angle rate                | -5      | *deg.* |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  rego   |                      |                                      | 0       |        |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+
|  ree    |                      |                                      | 0       |        |            |
+---------+----------------------+--------------------------------------+---------+--------+------------+

Variables
---------

+----------+-------------------+----------+--------------------------+------+------------+
|   Name   |      Symbol       |   Type   |       Description        | Unit | Properties |
+==========+===================+==========+==========================+======+============+
|  PIc_xi  | :math:`PIc_{\xi}` | State    | Integrator output        |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  PIw_xi  | :math:`PIw_{\xi}` | State    | Integrator output        |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  LG_y    | :math:`LG_{y}`    | State    | State in lag TF          |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  wt      | :math:`wt`        | ExtState |                          |      |            |
+----------+-------------------+----------+--------------------------+------+------------+
|  Pord    | :math:`Pord`      | ExtState |                          |      |            |
+----------+-------------------+----------+--------------------------+------+------------+
|  PIc_yul | :math:`PIc_{yul}` | Algeb    |                          |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  PIc_y   | :math:`PIc_{y}`   | Algeb    | PI output                |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  wref    | :math:`wref`      | Algeb    | optional speed reference |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  PIw_yul | :math:`PIw_{yul}` | Algeb    |                          |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  PIw_y   | :math:`PIw_{y}`   | Algeb    | PI output                |      | v_str      |
+----------+-------------------+----------+--------------------------+------+------------+
|  theta   | :math:`\theta`    | ExtAlgeb |                          |      |            |
+----------+-------------------+----------+--------------------------+------+------------+
|  Pref    | :math:`Pref`      | ExtAlgeb |                          |      |            |
+----------+-------------------+----------+--------------------------+------+------------+

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

+----------+-------------------+----------+-----------------------------------------------------------------------+
|   Name   |      Symbol       |   Type   |                             Initial Value                             |
+==========+===================+==========+=======================================================================+
|  PIc_xi  | :math:`PIc_{\xi}` | State    | :math:`0.0`                                                           |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  PIw_xi  | :math:`PIw_{\xi}` | State    | :math:`0.0`                                                           |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  LG_y    | :math:`LG_{y}`    | State    | :math:`1.0 PIc_{y} + 1.0 PIw_{y}`                                     |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  wt      | :math:`wt`        | ExtState |                                                                       |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  Pord    | :math:`Pord`      | ExtState |                                                                       |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  PIc_yul | :math:`PIc_{yul}` | Algeb    | :math:`Kpc \left(Pord - Pref\right)`                                  |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  PIc_y   | :math:`PIc_{y}`   | Algeb    | :math:`PIc_{hl zi} PIc_{yul} + PIc_{hl zl} thmin + PIc_{hl zu} thmax` |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  wref    | :math:`wref`      | Algeb    | :math:`wt`                                                            |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  PIw_yul | :math:`PIw_{yul}` | Algeb    | :math:`Kpw \left(Kcc \left(Pord - Pref\right) - wref + wt\right)`     |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  PIw_y   | :math:`PIw_{y}`   | Algeb    | :math:`PIw_{hl zi} PIw_{yul} + PIw_{hl zl} thmin + PIw_{hl zu} thmax` |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  theta   | :math:`\theta`    | ExtAlgeb |                                                                       |
+----------+-------------------+----------+-----------------------------------------------------------------------+
|  Pref    | :math:`Pref`      | ExtAlgeb |                                                                       |
+----------+-------------------+----------+-----------------------------------------------------------------------+

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

+---------+-------------------+----------+-------------------------------------------------------------------+--------------------+
|  Name   |      Symbol       |   Type   |                 RHS of Equation "T x' = f(x, y)"                  |      T (LHS)       |
+=========+===================+==========+===================================================================+====================+
|  PIc_xi | :math:`PIc_{\xi}` | State    | :math:`Kic \left(Pord - Pref\right)`                              |                    |
+---------+-------------------+----------+-------------------------------------------------------------------+--------------------+
|  PIw_xi | :math:`PIw_{\xi}` | State    | :math:`Kiw \left(Kcc \left(Pord - Pref\right) - wref + wt\right)` |                    |
+---------+-------------------+----------+-------------------------------------------------------------------+--------------------+
|  LG_y   | :math:`LG_{y}`    | State    | :math:`- LG_{y} + 1.0 PIc_{y} + 1.0 PIw_{y}`                      | :math:`T_{\theta}` |
+---------+-------------------+----------+-------------------------------------------------------------------+--------------------+
|  wt     | :math:`wt`        | ExtState | :math:`0`                                                         |                    |
+---------+-------------------+----------+-------------------------------------------------------------------+--------------------+
|  Pord   | :math:`Pord`      | ExtState | :math:`0`                                                         |                    |
+---------+-------------------+----------+-------------------------------------------------------------------+--------------------+

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

+----------+-------------------+----------+-------------------------------------------------------------------------------------------+
|   Name   |      Symbol       |   Type   |                               RHS of Equation "0 = g(x, y)"                               |
+==========+===================+==========+===========================================================================================+
|  PIc_yul | :math:`PIc_{yul}` | Algeb    | :math:`Kpc \left(Pord - Pref\right) + PIc_{\xi} - PIc_{yul}`                              |
+----------+-------------------+----------+-------------------------------------------------------------------------------------------+
|  PIc_y   | :math:`PIc_{y}`   | Algeb    | :math:`PIc_{hl zi} PIc_{yul} + PIc_{hl zl} thmin + PIc_{hl zu} thmax - PIc_{y}`           |
+----------+-------------------+----------+-------------------------------------------------------------------------------------------+
|  wref    | :math:`wref`      | Algeb    | :math:`- wref + wref_{0}`                                                                 |
+----------+-------------------+----------+-------------------------------------------------------------------------------------------+
|  PIw_yul | :math:`PIw_{yul}` | Algeb    | :math:`Kpw \left(Kcc \left(Pord - Pref\right) - wref + wt\right) + PIw_{\xi} - PIw_{yul}` |
+----------+-------------------+----------+-------------------------------------------------------------------------------------------+
|  PIw_y   | :math:`PIw_{y}`   | Algeb    | :math:`PIw_{hl zi} PIw_{yul} + PIw_{hl zl} thmin + PIw_{hl zu} thmax - PIw_{y}`           |
+----------+-------------------+----------+-------------------------------------------------------------------------------------------+
|  theta   | :math:`\theta`    | ExtAlgeb | :math:`LG_{y} - \theta_{0}`                                                               |
+----------+-------------------+----------+-------------------------------------------------------------------------------------------+
|  Pref    | :math:`Pref`      | ExtAlgeb | :math:`0`                                                                                 |
+----------+-------------------+----------+-------------------------------------------------------------------------------------------+

Services
----------

+--------+---------------+--------------+-----------------+
|  Name  |    Symbol     |   Equation   |      Type       |
+========+===============+==============+=================+
|  wref0 | :math:`wref0` | :math:`wref` | PostInitService |
+--------+---------------+--------------+-----------------+

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

+---------+-------------------+----------------+----------------+
|  Name   |      Symbol       |      Type      |      Info      |
+=========+===================+================+================+
|  PIc_aw | :math:`aw_{PI_c}` | AntiWindup     |                |
+---------+-------------------+----------------+----------------+
|  PIc_hl | :math:`hl_{PI_c}` | HardLimiter    |                |
+---------+-------------------+----------------+----------------+
|  PIw_aw | :math:`aw_{PI_w}` | AntiWindup     |                |
+---------+-------------------+----------------+----------------+
|  PIw_hl | :math:`hl_{PI_w}` | HardLimiter    |                |
+---------+-------------------+----------------+----------------+
|  LG_lim | :math:`lim_{LG}`  | AntiWindupRate | Limiter in Lag |
+---------+-------------------+----------------+----------------+

Blocks
-------

+------+--------------+-------------------+-----------------------------------------+
| Name |    Symbol    |       Type        |                  Info                   |
+======+==============+===================+=========================================+
|  PIc | :math:`PI_c` | PIAWHardLimit     | PI for active power diff compensation   |
+------+--------------+-------------------+-----------------------------------------+
|  PIw | :math:`PI_w` | PIAWHardLimit     | PI for speed and active power deviation |
+------+--------------+-------------------+-----------------------------------------+
|  LG  | :math:`LG`   | LagAntiWindupRate | Output lag anti-windup rate limiter     |
+------+--------------+-------------------+-----------------------------------------+


Config Fields in [WTPTA1]

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