.. _DCTopology:

================================================================================
DCTopology
================================================================================
Common Parameters: u, name

Common Variables: v

Available models:
Node_

.. _Node:

--------------------------------------------------------------------------------
Node
--------------------------------------------------------------------------------
DC Node model.

A DC Node is like an AC Bus. DC devices need to be connected to
Nodes to inject power flow.

Parameters
----------

+---------+-----------------+---------------------------+---------+--------+------------+
|  Name   |     Symbol      |        Description        | Default |  Unit  | Properties |
+=========+=================+===========================+=========+========+============+
|  idx    |                 | unique device idx         |         |        |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  u      | :math:`u`       | connection status         | 1       | *bool* |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  name   |                 | device name               |         |        |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  Vdcn   | :math:`V_{dcn}` | DC voltage rating         | 100     | *kV*   | non_zero   |
+---------+-----------------+---------------------------+---------+--------+------------+
|  Idcn   | :math:`I_{dcn}` | DC current rating         | 1       | *kA*   | non_zero   |
+---------+-----------------+---------------------------+---------+--------+------------+
|  v0     | :math:`V_{dc0}` | initial voltage magnitude | 1       | *p.u.* |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  xcoord |                 | x coordinate (longitude)  | 0       |        |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  ycoord |                 | y coordinate (latitude)   | 0       |        |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  area   |                 | Area code                 |         |        |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  zone   |                 | Zone code                 |         |        |            |
+---------+-----------------+---------------------------+---------+--------+------------+
|  owner  |                 | Owner code                |         |        |            |
+---------+-----------------+---------------------------+---------+--------+------------+

Variables
---------

+------+-----------+-------+-------------------+--------+------------+
| Name |  Symbol   | Type  |    Description    |  Unit  | Properties |
+======+===========+=======+===================+========+============+
|  v   | :math:`v` | Algeb | voltage magnitude | *p.u.* | v_str      |
+------+-----------+-------+-------------------+--------+------------+

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

+------+-----------+-------+----------------------------------------------------------+
| Name |  Symbol   | Type  |                      Initial Value                       |
+======+===========+=======+==========================================================+
|  v   | :math:`v` | Algeb | :math:`v_{0} \cdot \left(1 - z_{flat}\right) + z_{flat}` |
+------+-----------+-------+----------------------------------------------------------+

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

+------+-----------+-------+-------------------------------+
| Name |  Symbol   | Type  | RHS of Equation "0 = g(x, y)" |
+======+===========+=======+===============================+
|  v   | :math:`v` | Algeb | :math:`0`                     |
+------+-----------+-------+-------------------------------+


Config Fields in [Node]

+---------------+------------------+-------+---------------------------------------+-----------------+
|    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)          |
+---------------+------------------+-------+---------------------------------------+-----------------+
|  flat_start   | :math:`z_{flat}` | 0     | flat start for voltages               | (0, 1)          |
+---------------+------------------+-------+---------------------------------------+-----------------+