added spring potential energy

Author: autobotx343

physics/potential_energy.py

@@ -2,48 +2,50 @@
 
 """
 Finding the gravitational potential energy of an object with reference
-to the earth,by taking its mass and height above the ground as input
+to the earth,by taking its mass and height above the ground as input.
 
+Description : Potential energy is stored energy that depends on the
+position or configuration of objects within a force field. It can be
+released as kinetic energy when the objects move under that force.
 
-Description : Gravitational energy or gravitational potential energy
-is the potential energy a massive object has in relation to another
-massive object due to gravity. It is the potential energy associated
-with the gravitational field, which is released (converted into
-kinetic energy) when the objects fall towards each other.
-Gravitational potential energy increases when two objects
-are brought further apart.
+Gravitational potential energy is the energy an object has because of
+its position in a gravitational field. It is the potential energy a
+massive object has in relation to another massive object due to gravity.
+This energy is associated with the gravitational field and is released
+when the objects fall toward each other. Near the Earth's surface this
+potential energy is approximately proportional to mass, gravity, and
+height, so it is often written as U = mgh for a body close to Earth.
 
-For two pairwise interacting point particles, the gravitational
-potential energy U is given by
+Spring potential energy is the stored energy in an elastic spring when
+it is compressed or stretched from its rest length. For small deformations,
+it is proportional to the square of the displacement from equilibrium.
+
+For two point particles interacting pairwise, the gravitational potential
+energy U is given by
 U=-GMm/R
 where M and m are the masses of the two particles, R is the distance
 between them, and G is the gravitational constant.
-Close to the Earth's surface, the gravitational field is approximately
-constant, and the gravitational potential energy of an object reduces to
-U=mgh
-where m is the object's mass, g=GM/R² is the gravity of Earth, and h is
-the height of the object's center of mass above a chosen reference level.
 
 Reference : "https://en.m.wikipedia.org/wiki/Gravitational_energy"
 """
 
 
-def potential_energy(mass: float, height: float) -> float:
+def gravitational_potential_energy(mass: float, height: float) -> float:
     # function will accept mass and height as parameters and return potential energy
     """
-    >>> potential_energy(10,10)
+    >>> gravitational_potential_energy(10,10)
     980.665
-    >>> potential_energy(0,5)
+    >>> gravitational_potential_energy(0,5)
     0.0
-    >>> potential_energy(8,0)
+    >>> gravitational_potential_energy(8,0)
     0.0
-    >>> potential_energy(10,5)
+    >>> gravitational_potential_energy(10,5)
     490.3325
-    >>> potential_energy(0,0)
+    >>> gravitational_potential_energy(0,0)
     0.0
-    >>> potential_energy(2,8)
+    >>> gravitational_potential_energy(2,8)
     156.9064
-    >>> potential_energy(20,100)
+    >>> gravitational_potential_energy(20,100)
     19613.3
     """
     if mass < 0:
@@ -52,10 +54,27 @@ def potential_energy(mass: float, height: float) -> float:
     if height < 0:
         # handling of negative values of height
         raise ValueError("The height above the ground cannot be negative")
+        
     return mass * g * height
 
+def spring_potential_energy(spring_constant: float, displacement: float):
+    #Function will except the spring constant and the displacemnt of the spring from equilibrium 
+    """
+    >>> spring_potential_energy(100,2)
+    200
+    >>> gravitational_potential_energy(10,0.5)
+    1.25
+    >>> spring_potential_energy(8,0)
+    0.0
+    """
+    if spring_constant < 0  :
+        raise ValueError("The values for spring_constant cannot be negative")
+    
+    return 0.5 * spring_constant * (displacement ** 2)
+
+
 
 if __name__ == "__main__":
     from doctest import testmod
 
-    testmod(name="potential_energy")
+    testmod(name="gravitational_potential_energy")