sda.rlc.rlc_circuit
===================

.. py:module:: sda.rlc.rlc_circuit


Attributes
----------

.. autoapisummary::

   sda.rlc.rlc_circuit.R


Classes
-------

.. autoapisummary::

   sda.rlc.rlc_circuit.RLC


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

.. py:class:: RLC(R, L, C)

   .. py:attribute:: R


   .. py:attribute:: L


   .. py:attribute:: C


   .. py:attribute:: omega_0


   .. py:attribute:: lambda_


   .. py:attribute:: alpha


   .. py:attribute:: times
      :type:  numpy.ndarray | None
      :value: None



   .. py:attribute:: tau
      :type:  float | None
      :value: None



   .. py:attribute:: current
      :type:  numpy.ndarray | None
      :value: None



   .. py:attribute:: input_signal
      :type:  numpy.ndarray | None
      :value: None



   .. py:method:: pulsed_signal(t, tau, V)
      :staticmethod:


      Pulsed signal, serving as an input signal to the RLC circuit.

      The pulse is defined here as step function that goes from 0 to V at t = 0,
      and stays at V for 0 < t <= tau. The pulse is 0 for t > tau.

      :param t: Time in seconds.
      :type t: :py:class:`np.ndarray`
      :param tau: Pulse duration in seconds.
      :type tau: :py:class:`float`
      :param V: Pulse amplitude in volts.
      :type V: :py:class:`float`

      :returns: The pulse value at time t.
      :rtype: :py:class:`np.ndarray`



   .. py:method:: compute_current(t, tau, V)

      Compute the current across the RLC circuit in response to a pulsed signal.

      :param t: Time in seconds.
      :type t: :py:class:`np.ndarray`
      :param tau: Pulse duration in seconds.
      :type tau: :py:class:`float`
      :param V: Pulse amplitude in Volts.
      :type V: :py:class:`float`

      :returns: The current across the RLC circuit at time t.
      :rtype: :py:class:`np.ndarray`



   .. py:method:: voltage_inductor()

      Voltage across the inductor.

      :returns: The voltage across the inductor.
      :rtype: :py:class:`np.ndarray`



   .. py:method:: voltage_resistor()

      Voltage across the resistor.

      :returns: The voltage across the resistor.
      :rtype: :py:class:`np.ndarray`



   .. py:method:: voltage_capacitor()

      Voltage across the capacitor.

      It uses Kirchhoff's voltage law (KVL) to calculate the voltage across the capacitor.

      :returns: The voltage across the capacitor.
      :rtype: :py:class:`np.ndarray`



   .. py:method:: compute_energy()

      Energy stored in the RLC circuit.

      :returns: The magnetic energy, electric energy, joule loss and total energy.
                For each of these, the energy is calculated at each time step.
      :rtype: :py:class:`tuple[np.ndarray`, :py:class:`np.ndarray`, :py:class:`np.ndarray`, :py:class:`np.ndarray]`



   .. py:method:: compute_power()

      Power in the RLC circuit.

      :returns: The magnetic power, electric power, joule power and total power.
                For each of these, the power is calculated at each time step.
      :rtype: :py:class:`tuple[np.ndarray`, :py:class:`np.ndarray`, :py:class:`np.ndarray`, :py:class:`np.ndarray]`



.. py:data:: R
   :value: 10