charging_capacitor_algo

Author: dhruvtrigotra

electronics/charging_capacitor.py

@@ -5,7 +5,7 @@
 """
 Description
 -----------
-when a capacitor is connected with a potential source(AC or DC). It is starts to charge
+When a capacitor is connected with a potential source (AC or DC). It starts to charge
 at a general speed but when a resistor is connected in the  circuit with in series to
 a capacitor then the capacitor charges slowly means it will take more time than usual.
 while the capacitor is being charged, the voltage is in exponential function with time.
@@ -26,30 +26,25 @@ def charging_capacitor(
     time_sec: float,  # time in seconds after charging initiation of capacitor.
 ) -> float:
     """
-    find voltage of capacitor at any nth second after the initiation of it's charging.
-
-    Parameters
-    ----------
-    source_voltage : float
-        it is going to multiply with rest of the function.
-    resistance : float
-        it is using in RC function.
-    capacitance : float
-        it is multiplying with resistance_ohms to yield output.
-    time_sec : float
-        it is dividing by RC.To find the voltage at nth second.
+    Find capacitor voltage at any nth second after initiating its charging.
 
     Examples
     --------
+    >>> charging_capacitor(source_voltage=.2,resistance=.9,capacitance=8.4,time_sec=.5)
+    0.013
+
+    >>> charging_capacitor(source_voltage=2.2,resistance=3.5,capacitance=2.4,time_sec=9)
+    1.446
+
     >>> charging_capacitor(source_voltage=15,resistance=200,capacitance=20,time_sec=2)
     0.007
 
-    >>> charging_capacitor(source_voltage=0,resistance=1000,capacitance=30,time_sec=3)
+    >>> charging_capacitor(source_voltage=0,resistance=10.0,capacitance=.30,time_sec=3)
     Traceback (most recent call last):
         ...
     ValueError: source voltage cannot be zero.
 
-    >>> charging_capacitor(20,2000,30*pow(10,-5),4)
+    >>> charging_capacitor(20, 2000, 30*pow(10,-5), 4)
     19.975
 
     >>> charging_capacitor(source_voltage=20,resistance=-2000,capacitance=30,time_sec=4)
@@ -83,20 +78,28 @@ def charging_capacitor(
             raise ValueError("source voltage cannot be negative.")
         elif source_voltage == 0:
             raise ValueError("source voltage cannot be zero.")
+        else:
+            return 0
+
     elif resistance <= 0:
         if resistance < 0:
             raise ValueError("Resistance cannot be negative.")
         elif resistance == 0:
             raise ValueError("Resistance cannot be zero.")
+        else:
+            return 0
+
     elif capacitance <= 0:
         if capacitance < 0:
             raise ValueError("Capacitance cannot be negative.")
         elif capacitance == 0:
             raise ValueError("Capacitance cannot be zero.")
+        else:
+            return 0
+
     else:
         return round(
-            source_voltage * (1 - exp(-time_sec / (resistance * capacitance))),
-            3,
+            source_voltage * (1 - exp(-time_sec / (resistance * capacitance))), 3
         )