:class:`Circuit`
================


.. py:class:: ansys.dyna.core.pre.dynaem.Circuit(loadcurve, circuit_type=CircuitType.IMPOSED_CURRENT_VS_TIME)

   
   Defines an electrical circuit.


   :Parameters:

       **circtyp** : :class:`python:int`
           Circuit type. Options are:
           
           - EQ.1: Imposed current vs time defined by a load curve
           - EQ.2: Imposed voltage vs time defined by a load curve

       **loadcurve** : :obj:`Curve`
           Load curve for when the ``circtyp`` parameter is set to ``1``,
           ``2``, ``21`` or ``22``.














   ..
       !! processed by numpydoc !!


.. py:currentmodule:: Circuit

Overview
--------

.. tab-set::



   .. tab-item:: Methods

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~set_current`
            - Define the segment set for the current.
          * - :py:attr:`~create`
            - Create a circuit.



   .. tab-item:: Attributes

      .. list-table::
          :header-rows: 0
          :widths: auto

          * - :py:attr:`~stub`
            - 
          * - :py:attr:`~circuit_type`
            - 
          * - :py:attr:`~lcid`
            - 






Import detail
-------------

.. code-block:: python

    from ansys.dyna.core.pre.dynaem import Circuit


Attribute detail
----------------

.. py:attribute:: stub

.. py:attribute:: circuit_type
   :value: 1


.. py:attribute:: lcid



Method detail
-------------

.. py:method:: set_current(current, current_inlet, current_outlet)

   
   Define the segment set for the current.


   :Parameters:

       **current** : :obj:`SegmentSet`
           Segment set for the current.

       **current_inlet** : :obj:`SegmentSet`
           Segment set for input voltage or input current
           for CIRCTYP.EQ.2/3/12/22 and CIRCTYP.EQ 1/11/21 respectively.

       **current_outlet** : :obj:`SegmentSet`
           Segment set for the output voltage or output current for
           CIRCTYP = 2/3/12/22 and CIRCTYP = 1/11/21 respectively.














   ..
       !! processed by numpydoc !!

.. py:method:: create()

   
   Create a circuit.
















   ..
       !! processed by numpydoc !!