hermess.devices.svc
===================

.. py:module:: hermess.devices.svc


Attributes
----------

.. autoapisummary::

   hermess.devices.svc.sqrt


Classes
-------

.. autoapisummary::

   hermess.devices.svc.SVC


Module Contents
---------------

.. py:data:: sqrt

.. py:class:: SVC

   Bases: :py:obj:`hermess.devices.device.DeviceRect`


   Static Var Compensator: voltage-regulated shunt susceptance.

   :param KA: Integrator gain of the voltage regulator [pu B (system base) / s / pu V].
   :type KA: float
   :param Kd: Q/Vt droop gain [pu V / pu Q (system base)].
   :type Kd: float
   :param Td: Thyristor-control lag time constant [s].
   :type Td: float
   :param B_min: Susceptance limits in pu on the system base (from the SVC Mvar range
                 at 1.0 pu voltage).
   :type B_min: float
   :param B_max: Susceptance limits in pu on the system base (from the SVC Mvar range
                 at 1.0 pu voltage).
   :type B_max: float
   :param Setpoints (closed-form finit):
   :param -----------------------------:
   :param Vref:
   :type Vref: voltage reference of the regulator [pu].
   :param Bref:
   :type Bref: initial Q/Vt operating point anchoring the droop [pu].
   :param Initialization is sequential (closed-form):
   :type Initialization is sequential (closed-form): SVC buses typically also carry
   :param loads:
   :param and a joint Newton solve would attribute the whole bus current to this:
   :param device. The initial reactive output ``q`` [Mvar] is a device input (the:
   :param loadflow result at the SVC bus:
   :param e.g. Table 9 of the SEA benchmark):
   :param from which:
   :param B₀ = (q/Sb)/V₀²:
   :param xB₀ = B₀/2.5:
   :param Vref = V₀ and Bref = B₀·V₀ follow directly.:
   :param Consistency with the actual power flow is verified by the standard:
   :param zero-residual initialization check.:


   .. py:attribute:: _init_method
      :value: 'sequential'



   .. py:attribute:: _type
      :value: 'SVC'



   .. py:attribute:: _name
      :value: 'Static_var_compensator'



   .. py:attribute:: ns
      :value: 2



   .. py:attribute:: xB


   .. py:attribute:: B


   .. py:attribute:: KA


   .. py:attribute:: Kd


   .. py:attribute:: Td


   .. py:attribute:: B_min


   .. py:attribute:: B_max


   .. py:attribute:: q


   .. py:attribute:: Vref


   .. py:attribute:: Bref


   .. py:method:: _finit_sequential(dae: hermess.system.Dae) -> None

      Staged, device-specific initialization. Devices that declare
      ``_init_method = 'sequential'`` implement this; the default has none.



   .. py:method:: input_current(dae: hermess.system.Dae)

      Load-convention terminal currents of the shunt susceptance.



   .. py:method:: fgcall(dae: hermess.system.Dae) -> None

      A method that executes the differential and algebraic equations of the model
      and adds them to the appropriate places in the Dae class

      :param dae: an instance of a class Dae

      :type dae:

      :return: None

      :rtype: None