padne.problem
=============

.. py:module:: padne.problem


Classes
-------

.. autoapisummary::

   padne.problem.Layer
   padne.problem.NodeID
   padne.problem.Connection
   padne.problem.BaseLumped
   padne.problem.Network
   padne.problem.Resistor
   padne.problem.VoltageSource
   padne.problem.CurrentSource
   padne.problem.VoltageRegulator
   padne.problem.Problem


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

.. py:class:: Layer

   Represents a single copper layer of the input circuit board.

   The individual polygons are cached in the .geoms field to avoid expensive
   Shapely copying when accessing them repeatedly using shape.geoms[...].


   .. py:attribute:: shape
      :type:  shapely.geometry.MultiPolygon


   .. py:attribute:: name
      :type:  str


   .. py:attribute:: conductance
      :type:  float


   .. py:attribute:: geoms
      :type:  tuple[shapely.geometry.Polygon, Ellipsis]


.. py:class:: NodeID

   Opaque identifier for a node in the network.


.. py:class:: Connection

   Represents a connection between an internal node of the Network and
   a point in the layer.


   .. py:attribute:: layer
      :type:  Layer


   .. py:attribute:: point
      :type:  shapely.geometry.Point


   .. py:attribute:: node_id
      :type:  NodeID


.. py:class:: BaseLumped

   Represents a lumped element in the network.


   .. py:property:: terminals
      :type: list[NodeID]



   .. py:property:: is_source
      :type: bool



   .. py:property:: extra_variable_count
      :type: int



.. py:class:: Network

   .. py:attribute:: connections
      :type:  list[Connection]


   .. py:attribute:: elements
      :type:  list[BaseLumped]


   .. py:attribute:: nodes
      :type:  dict[NodeID, int]


   .. py:attribute:: has_source
      :type:  bool


.. py:class:: Resistor

   Bases: :py:obj:`BaseLumped`


   Represents a lumped element in the network.


   .. py:attribute:: a
      :type:  NodeID


   .. py:attribute:: b
      :type:  NodeID


   .. py:attribute:: resistance
      :type:  float


   .. py:property:: terminals
      :type: list[NodeID]



.. py:class:: VoltageSource

   Bases: :py:obj:`BaseLumped`


   Represents a lumped element in the network.


   .. py:attribute:: p
      :type:  NodeID


   .. py:attribute:: n
      :type:  NodeID


   .. py:attribute:: voltage
      :type:  float


   .. py:property:: terminals
      :type: list[NodeID]



   .. py:property:: is_source
      :type: bool



   .. py:property:: extra_variable_count
      :type: int



.. py:class:: CurrentSource

   Bases: :py:obj:`BaseLumped`


   Represents a lumped element in the network.


   .. py:attribute:: f
      :type:  NodeID


   .. py:attribute:: t
      :type:  NodeID


   .. py:attribute:: current
      :type:  float


   .. py:property:: terminals
      :type: list[NodeID]



   .. py:property:: is_source
      :type: bool



.. py:class:: VoltageRegulator

   Bases: :py:obj:`BaseLumped`


   Represents a lumped element in the network.


   .. py:attribute:: v_p
      :type:  NodeID


   .. py:attribute:: v_n
      :type:  NodeID


   .. py:attribute:: s_f
      :type:  NodeID


   .. py:attribute:: s_t
      :type:  NodeID


   .. py:attribute:: voltage
      :type:  float


   .. py:attribute:: gain
      :type:  float


   .. py:property:: terminals
      :type: list[NodeID]



   .. py:property:: is_source
      :type: bool



   .. py:property:: extra_variable_count
      :type: int



.. py:class:: Problem

   .. py:attribute:: layers
      :type:  list[Layer]


   .. py:attribute:: networks
      :type:  list[Network]


   .. py:attribute:: project_name
      :type:  str | None
      :value: None