electronics.half_wave_rectifier
===============================

.. py:module:: electronics.half_wave_rectifier


Classes
-------

.. autoapisummary::

   electronics.half_wave_rectifier.Result


Functions
---------

.. autoapisummary::

   electronics.half_wave_rectifier.dc_current
   electronics.half_wave_rectifier.dc_voltage
   electronics.half_wave_rectifier.max_current
   electronics.half_wave_rectifier.max_load_current
   electronics.half_wave_rectifier.rms_current
   electronics.half_wave_rectifier.rms_voltage


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

.. py:class:: Result

   Bases: :py:obj:`NamedTuple`


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


   .. py:attribute:: value
      :type:  float


.. py:function:: dc_current(im: float) -> tuple

   This function can calculate the Average DC Current(Idc) in a circuit.
   In all cases, a negative sign shows
   the opposite direction of current or voltage.
   Idc = average direct current (DC)
   im = maximum current or peak current
   cases:
   >>> dc_current(im=2)
   Result(name='Idc', value=0.636)
   >>> dc_current(im=0)
   Result(name='Idc', value=0.0)


.. py:function:: dc_voltage(vm: float) -> tuple

   This function can calculate the Average DC Voltage(Vdc) in a circuit.
   In all cases, a negative sign shows
   the opposite direction of current or voltage.
   Vdc = average direct current (DC)
   vm = maximum voltage or peak voltage
   cases:
   >>> dc_voltage(vm=2)
   Result(name='Vdc', value=0.636)
   >>> dc_voltage(vm=0)
   Result(name='Vdc', value=0.0)


.. py:function:: max_current(vm: float, rl: float) -> tuple

   This function can calculate the maximum current(Im) in a circuit.
   In all cases, a negative sign shows the
   opposite direction of current or voltage.
   vm = maximum voltage or peak voltage
   rl = load resistance
   cases:
   >>> max_current(vm=2, rl=5)
   Result(name='Max_current_Im', value=0.4)
   >>> max_current(vm=2, rl=-5)
   Traceback (most recent call last):
       ...
   ValueError: Resistance cannot be negative or equal to zero



.. py:function:: max_load_current(rf: float, rs: float, rl: float, vm: float) -> tuple

   This function can calculate the maximum load current(Im)
   in a half-wave rectifier circuit.
   Im = maximum load current
   rf = Forward Resistance of Diode
   rs = Transformer secondary winding resistance
   rl = load resistance
   vm = maximum voltage or peak voltage
   Cases:-
   >>> max_load_current(rf=2 , rs=4 , rl=6 , vm=15 )
   Result(name='max_load_current', value=1.25)
   >>> max_load_current(rf=2 , rs=4 , rl=6 , vm=0 )
   Result(name='max_load_current', value=0.0)
   >>> max_load_current(rf=2 , rs=-4 , rl=6 , vm=15 )
   Traceback (most recent call last):
       ...
   ValueError: Resistance cannot be negative
   >>> max_load_current(rf=0 , rs=0 , rl=0 , vm=15 )
   Traceback (most recent call last):
       ...
   ValueError: At least one Resistance must be non-zero


.. py:function:: rms_current(im: float) -> tuple

   This function calculates the RMS(Root Mean Square) value of current(Irms).
   In all cases, a negative sign shows
   the opposite direction of current or voltage.
   Irms = Root Mean Square Value of current
   im = maximum current or peak current
   cases:
   >>> rms_current(im=10)
   Result(name='Irms', value=5.0)
   >>> rms_current(im=0)
   Result(name='Irms', value=0.0)


.. py:function:: rms_voltage(vm: float) -> tuple

   This function calculates the RMS(Root Mean Square) value of voltage(Vrms).
   In all cases, a negative sign shows
   the opposite direction of current or voltage.
   Vrms = Root Mean Square Value of voltage
   vm = maximum voltage or peak voltage
   cases:
   >>> rms_voltage(vm=20)
   Result(name='Vrms', value=10.0)
   >>> rms_voltage(vm=0)
   Result(name='Vrms', value=0.0)