IscEquivalentRadial
====================

The ``IscEquivalentRadial`` class provides access to an IPSA equivalent radial (generated by network reduction), to set and get data values and to retrieve load flow results.

Field Values
-------------

.. tabularcolumns:: |\Y{0.15}|\Y{0.25}|\Y{0.6}|
.. list-table:: **IscEquivalentRadial Field Values**
   :widths: 2 5 15
   :class: tight-table, longtable
   :header-rows: 1

   * - Type
     - Field Name
     - Description
   * - Integer
     - FromUID
     - Gets the unique ID for busbar.
   * - String
     - BusName
     - Gets the busbar name.
   * - String
     - Name
     - Gets the equivalent radial name.
   * - Integer
     - Status
     - Status:

        - 0 = Switched in
        - -1 = Switched out
   * - Integer
     - EquivalentType
     - The type of equivalent used in network reduction:

        - 0 = Manual/none (allows users to enforce voltage control)
        - 1 = Ward equivalent
        - 2 = Extended ward equivalent (must be set to include EWE effects)
   * - Float
     - RealPowerMW
     - Gets and sets the active power output.
   * - Float
     - ReactivePowerMVAr
     - Gets and sets the reactive power output.
   * - Float
     - ResistancePU
     - Gets the resistance from the shunt equivalent in per unit.
   * - Float
     - ReactancePU
     - Gets the reactance from the shunt equivalent in per unit.
   * - Float
     - ExtResistancePU
     - Gets the resistance in per unit from the diagonal shunt component generated in the Extended Ward method.
   * - Float
     - ExtReactancePU
     - Gets the reactance in per unit from the diagonal shunt component generated in the Extended Ward method.
   * - Float
     - TargetVoltagePU
     - Gets and sets the target voltage in per unit.
   * - Boolean
     - IncludesReducedSlack
     - Gets whether the equivalent radial includes a reduced slack busbar.
   * - List[Int]
     - CatalogTypes
     - Gets a list of the type of objects in the catalog (generator, load).
   * - List[Int]
     - CatalogTechs
     - Gets a list of the technology for the objects in the catalog. The generator technnologies are:
     
        - 0 = Synchronous machine (default)
        - 1 = Energy storage
        - 2 = Solar
        - 3 = Wind
        - 4 = Hydroelectric
        - 5 = Nuclear
        - 6 = Gas
        - 7 = Coal
        - 8 = Diesel
        - 9 = Geothermal
        - 10 = Tidal
        - 11 = Future generation (TBC)
   * - List[Int]
     - CatalogStagings
     - Gets a list of the development stage for the objects in the catalog. The stages are:

        - 0 = Proposed
        - 1 = Accepted
        - 2 = Completed
        - 3 = Energized (default, in service)
   * - List[Float]
     - CatalogPowersMW
     - Gets a list of the real power in MW for the objects in the catalog.
   * - String
     - Comment
     - Gets and sets the comments.

Note, the indices of the catalog lists map to the same item, e.g., CatalogTechs[1] refers to the staging in CatalogStaging[1].


IscEquivalentRadial Class
----------------------------

.. autoclass:: ipsa.IscEquivalentRadial
   :members: