joules 0.3.1 → 0.3.2

data/lib/joules/geometry.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing geometry formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Geometry module (geometry.rb)
@@ -17,7 +17,7 @@ module Joules
   # @param width [Int, Float]
   #   width >= 0; width has the same units as length
   # @return [Float]
-  #   return value >= 0; return value has the same units as length
+  #   return value >= 0; return value has the same units squared as length 
   # @example
   #   Joules.rectangle_area(2, 3.4) #=> 6.8
   def rectangle_area(length, width)
@@ -52,7 +52,7 @@ module Joules
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
   # @return [Float]
-  #   return value >= 0; return value has the same units as radius
+  #   return value >= 0; return value has the same units squared as radius
   # @example
   #   Joules.circle_area(12) #=> 452.38934211693 
   def circle_area(radius)
@@ -63,7 +63,7 @@ module Joules
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
   # @return [Float]
-  #   return value >= 0; return value has the same units as radius
+  #   return value >= 0; return value has the same units squared as radius
   # @example
   #   Joules.sphere_surface_area(12) #=> 1809.5573684677208
   def sphere_surface_area(radius)
@@ -74,7 +74,7 @@ module Joules
   # @param radius [Int, Float]
   #   radius >= 0; radius is in a unit of length
   # @return [Float]
-  #   return value >= 0; return value has the same units as radius
+  #   return value >= 0; return value has the same units cubed as radius
   # @example
   #   Joules.sphere_volume(12) #=> 7238.229473870883
   def sphere_volume(radius)
@@ -87,7 +87,7 @@ module Joules
   # @param slant_height [Int, Float]
   #   slant_height >= 0; slant_height has the same units as radius
   # @return [Float]
-  #   return value >= 0; return value has the same units as radius
+  #   return value >= 0; return value has the same units squared as radius
   # @example
   #   Joules.cone_surface_area(3, 5.83) #=> 83.22078939359362
   def cone_surface_area(radius, slant_height)
@@ -100,7 +100,7 @@ module Joules
   # @param height [Int, Float]
   #   height >= 0; height has the same units as radius
   # @return [Float]
-  #   return value >= 0; return value has the same units as radius
+  #   return value >= 0; return value has the same units cubed as radius
   # @example
   #   Joules.cone_volume(6.5, 3) #=> 132.73228961416876
   def cone_volume(radius, height)
@@ -113,7 +113,7 @@ module Joules
   # @param height [Int, Float]
   #   height >= 0; height has the same units as radius
   # @return [Float]
-  #   return value >= 0; return value has the same units as radius
+  #   return value >= 0; return value has the same units squared as radius
   # @example
   #   Joules.cylinder_surface_area(6.5, 3) #=> 122.522113490002
   def cylinder_surface_area(radius, height)
@@ -126,7 +126,7 @@ module Joules
   # @param height [Int, Float]
   #   height >= 0; height has the same units as radius
   # @return [Float]
-  #   return value >= 0; return value has the same units as radius
+  #   return value >= 0; return value has the same units cubed as radius
   # @example
   #   Joules.cylinder_volume(6.5, 3) #=> 398.196868842506 
   def cylinder_volume(radius, height)

data/lib/joules/gravitational_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing gravitational fields formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Gravitational fields module (gravitational_fields.rb)
@@ -17,14 +17,19 @@ module Joules
   # @param object_mass2 [Int, Float]
   #   object_mass2 >= 0; object_mass2 is in kilograms
   # @param distance [Int, Float]
-  #   distance > 0; distance is in meters
+  #   distance > 0; distance is in metres
   # @return [Float]
   #   return value >= 0; return value is in newtons
+  # @raise [ZeroDivisionError] if distance = 0
   # @example
   #   Joules.gravitational_force(2e30, 1.9e27, 7.8e11) #=> 4.166009204470743e+23
   def gravitational_force(object_mass1, object_mass2, distance)
-    return (GRAVITATIONAL_CONSTANT * object_mass1 * object_mass2) /
-           (distance ** 2)
+    if distance.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return (GRAVITATIONAL_CONSTANT * object_mass1 * object_mass2) /
+             (distance ** 2)
+    end
   end
 
   # Calculates the gravitational field strength given force and mass.
@@ -33,39 +38,54 @@ module Joules
   # @param mass [Int, Float]
   #   mass > 0; mass is in kilograms
   # @return [Float]
-  #   return value is in meters per second squared
+  #   return value is in metres per second squared
+  # @raise [ZeroDivisionError] if mass = 0
   # @example
   #   Joules.gravitational_field_strength_v1(20, 0.5) #=> 40.0
   # @note There is one other method for calculating gravitational field strength.
   def gravitational_field_strength_v1(force, mass)
-    return force / mass.to_f
+    if mass.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return force / mass.to_f
+    end
   end
 
   # Calculates the gravitational field strength given mass and distance.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
   # @param distance [Int, Float]
-  #   distance > 0; distance is in meters
+  #   distance > 0; distance is in metres
   # @return [Float]
-  #   return value >= 0; return value is in meters per second squared
+  #   return value >= 0; return value is in metres per second squared
+  # @raise [ZeroDivisionError] if distance = 0
   # @example
   #   Joules.gravitational_field_strength_v2(34.7, 9.3) #=> 2.6760203491733148e-11
   # @note There is one other method for calculating gravitational field strength.
   def gravitational_field_strength_v2(mass, distance)
-  	return (GRAVITATIONAL_CONSTANT * mass) / (distance ** 2)
+    if distance.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return (GRAVITATIONAL_CONSTANT * mass) / (distance ** 2)
+    end
   end
 
   # Calculates the gravitational potential given mass and distance.
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
   # @param distance [Int, Float]
-  #   distance > 0; distance is in meters
+  #   distance > 0; distance is in metres
   # @return [Float]
   #   return value <= 0; return value is in joules per kilogram
+  # @raise [ZeroDivisionError] if distance = 0
   # @example
   #   Joules.gravitational_potential(6e24, 6.4e6) #=> -62531250.0
   def gravitational_potential(mass, distance)
-  	return (-GRAVITATIONAL_CONSTANT * mass) / distance
+    if distance.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return (-GRAVITATIONAL_CONSTANT * mass) / distance
+    end
   end
 
 end

data/lib/joules/kinematics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing kinematics formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Kinematics module (kinematics.rb)
@@ -13,54 +13,69 @@ module Joules
 
   # Calculates the average speed given distance and time.
   # @param distance [Int, Float]
-  #   distance >= 0; distance is in meters
+  #   distance >= 0; distance is in metres
   # @param time [Int, Float]
   #   time > 0; time is in seconds
   # @return [Float]
-  #   return value >= 0; return value is in meters per second
+  #   return value >= 0; return value is in metres per second
+  # @raise [ZeroDivisionError] if time = 0
   # @example
   #   Joules.avg_speed(30, 2.4) #=> 12.5
   def avg_speed(distance, time)
-    return distance / time.to_f 
+    if time.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return distance / time.to_f
+    end
   end
 
   # Calculates the average velocity given displacement and time.
   # @param displacement [Int, Float]
-  #   displacement is in meters
+  #   displacement is in metres
   # @param time [Int, Float]
   #   time > 0; time is in seconds
   # @return [Float]
-  #   return value is in meters per second
+  #   return value is in metres per second
+  # @raise [ZeroDivisionError] if time = 0
   # @example
   #   Joules.avg_velocity(180, 4.8) #=> 37.5 
   def avg_velocity(displacement, time)
-    return displacement / time.to_f
+    if time.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return displacement / time.to_f
+    end
   end
 
   # Calculates the acceleration given initial velocity, final velocity, and time.
   # @param initial_velocity [Int, Float]
-  #   initial_velocity is in meters per second
+  #   initial_velocity is in metres per second
   # @param final_velocity [Int, Float]
-  #   final_velocity is in meters per second
+  #   final_velocity is in metres per second
   # @param time [Int, Float]
   #   time > 0; time is in seconds
   # @return [Float]
-  #   return value is in meters per second squared
+  #   return value is in metres per second squared
+  # @raise [ZeroDivisionError] if time = 0
   # @example
   #   Joules.acceleration(20, 35, 2.4) #=> 6.25
   def acceleration(initial_velocity, final_velocity, time)
-    return (final_velocity - initial_velocity) / time.to_f
+    if time.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return (final_velocity - initial_velocity) / time.to_f
+    end
   end
 
   # Calculates the final velocity given initial velocity, acceleration, and time.
   # @param initial_velocity [Int, Float]
-  #   initial_velocity is in meters per second
+  #   initial_velocity is in metres per second
   # @param acceleration [Int, Float]
-  #   acceleration is in meters per second squared
+  #   acceleration is in metres per second squared
   # @param time [Int, Float]
   #   time >= 0; time is in seconds
   # @return [Float]
-  #   return value is in meters per second
+  #   return value is in metres per second
   # @example
   #   Joules.final_velocity_v1(20, 6.25, 2.4) #=> 35.0
   # @note There is one other method for calculating final velocity.
@@ -70,13 +85,13 @@ module Joules
 
   # Calculates the final velocity given initial velocity, acceleration, and displacement.
   # @param initial_velocity [Int, Float]
-  #   initial_velocity is in meters per second
+  #   initial_velocity is in metres per second
   # @param acceleration [Int, Float]
-  #   acceleration is in meters per second squared
+  #   acceleration is in metres per second squared
   # @param displacement [Int, Float]
-  #   displacement is in meters
+  #   displacement is in metres
   # @return [Float]
-  #   return value is in meters per second
+  #   return value is in metres per second
   # @example
   #   Joules.final_velocity_v2(20, 6.25, 66) #=> 35.0
   # @note There is one other method for calculating final velocity.
@@ -86,13 +101,13 @@ module Joules
 
   # Calculates the displacement given initial velocity, final velocity, and time.
   # @param initial_velocity [Int, Float]
-  #   initial_velocity is in meters per second
+  #   initial_velocity is in metres per second
   # @param final_velocity [Int, Float]
-  #   final_velocity is in meters per second
+  #   final_velocity is in metres per second
   # @param time [Int, Float]
   #   time >= 0; time is in seconds
   # @return [Float]
-  #   return value is in meters
+  #   return value is in metres
   # @example
   #   Joules.displacement_v1(20, 35, 2.4) #=> 66.0
   # @note There are two other methods for calculating displacement.
@@ -102,13 +117,13 @@ module Joules
 
   # Calculates the displacement given initial velocity, acceleration, and time.
   # @param initial_velocity [Int, Float]
-  #   initial_velocity is in meters per second
+  #   initial_velocity is in metres per second
   # @param acceleration [Int, Float]
-  #   acceleration is in meters per second squared
+  #   acceleration is in metres per second squared
   # @param time [Int, Float]
   #   time >= 0; time is in seconds
   # @return [Float]
-  #   return value is in meters
+  #   return value is in metres
   # @example
   #   Joules.displacement_v2(20, 6.25, 2.4) #=> 66.0
   # @note There are two other methods for calculating displacement.
@@ -118,13 +133,13 @@ module Joules
 
   # Calculates the displacement given final velocity, acceleration, and time.
   # @param final_velocity [Int, Float]
-  #   final_velocity is in meters per second
+  #   final_velocity is in metres per second
   # @param acceleration [Int, Float]
-  #   acceleration is in meters per second squared
+  #   acceleration is in metres per second squared
   # @param time [Int, Float]
   #   time >= 0; time is in seconds
   # @return [Float]
-  #   return value is in meters
+  #   return value is in metres
   # @example
   #   Joules.displacement_v3(35, 6.25, 2.4) #=> 66.0
   # @note There are two other methods for calculating displacement.

data/lib/joules/magnetic_fields.rb

@@ -0,0 +1,78 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing magnetic fields formulas
+# @author: Elisha Lai
+# @version: 0.3.2 03/06/2015
+#==============================================================================
+
+# Magnetic fields module (magnetic_fields.rb)
+
+module Joules
+  module_function
+
+  # Calculates the magnetic force on a current given flux density, current, and conductor length.
+  # @param flux_density [Int, Float]
+  #   flux_density is in teslas
+  # @param current [Int, Float]
+  #   current is in amperes
+  # @param conductor_length [Int, Float]
+  #   conductor_length >= 0; conductor_length is in metres
+  # @param angle [Int, Float]
+  #   angle is in degrees
+  # @return [Float]
+  #   return value is in newtons
+  # @example
+  #   Joules.magnetic_force_v1(0.06, 20, 4.5) #=> 5.3999999999999995
+  # @note There is one other method for calculating magnetic force.
+  def magnetic_force_v1(flux_density, current, conductor_length, angle = 90)
+    return flux_density * current * conductor_length * Math.sin(to_radians(angle))
+  end
+
+  # Calculates the magnetic force on a moving charge given flux density, charge, and velocity.
+  # @param flux_density [Int, Float]
+  #   flux_density is in teslas
+  # @param charge [Int, Float]
+  #   charge is in coulombs
+  # @param velocity [Int, Float]
+  #   velocity is in metres per second
+  # @param angle [Int, Float]
+  #   angle is in degrees
+  # @return [Float]
+  #   return value is in newtons
+  # @example
+  #   Joules.magnetic_force_v2(0.06, 34, 60) #=> 122.4
+  # @note There is one other method for calculating magnetic force.
+  def magnetic_force_v2(flux_density, charge, velocity, angle = 90)
+    return flux_density * charge * velocity * Math.sin(to_radians(angle))
+  end
+
+  # Calculates the magnetic flux given flux density and area.
+  # @param flux_density [Int, Float]
+  #   flux_density is in teslas
+  # @param area [Int, Float]
+  #   area >= 0; area is in metres squared
+  # @param angle [Int, Float]
+  #   angle is in degrees
+  # @return [Float]
+  #   return value is in webers
+  # @example
+  #   Joules.magnetic_flux(0.945, 9e-4) #=> 0.0008504999999999999
+  def magnetic_flux(flux_density, area, angle = 0)
+    return flux_density * area * Math.cos(to_radians(angle))
+  end
+
+  # Calculates the magnetic flux linkage given magnetic flux and number of coils in the wire.
+  # @param magnetic_flux [Int, Float]
+  #   magnetic_flux is in webers
+  # @param number_of_coils [Int, Float]
+  #   number_of_coils >= 0
+  # @return [Float]
+  #   return value is in webers
+  # @example
+  #   Joules.magnetic_flux_linkage(9.4, 10) #=> 94.0
+  def magnetic_flux_linkage(magnetic_flux, number_of_coils)
+    return magnetic_flux * number_of_coils.to_f
+  end
+
+end

data/lib/joules/mass_weight.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Mass and weight module (mass_weight.rb)

data/lib/joules/momentum_impulse.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing momentum and impulse formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)
@@ -15,7 +15,7 @@ module Joules
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
   # @param velocity [Int, Float]
-  #   velocity is in meters per second
+  #   velocity is in metres per second
   # @return [Float]
   #   return value is in newton seconds
   # @example
@@ -40,9 +40,9 @@ module Joules
 
   # Calculates the impulse given initial velocity, final velocity, and mass.
   # @param initial_velocity [Int, Float]
-  #   initial_velocity is in meters per second
+  #   initial_velocity is in metres per second
   # @param final_velocity [Int, Float]
-  #   final_velocity is in meters per second
+  #   final_velocity is in metres per second
   # @param mass [Int, Float]
   #   mass >= 0; mass is in kilograms
   # @return [Float]

data/lib/joules/pressure.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Pressure module (pressure.rb)
@@ -15,20 +15,25 @@ module Joules
   # @param force [Int, Float]
   #   force >= 0; force is in newtons
   # @param area [Int, Float]
-  #   area > 0; area is in meters cubed
+  #   area > 0; area is in metres squared
   # @return [Float]
   #   return value >= 0; return value is in pascals
+  # @raise [ZeroDivisionError] if area = 0
   # @example
   #   Joules.pressure(98, 0.04) #=> 2450.0 
   def pressure(force, area)
-    return force / area.to_f
+    if area.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return force / area.to_f
+    end
   end
 
   # Calculates the hydrostatic pressure given density and height.
   # @param density [Int, Float]
-  #   density >= 0; density is in kilograms per meter cubed
+  #   density >= 0; density is in kilograms per metre cubed
   # @param height [Int, Float]
-  #   height >= 0; height is in meters
+  #   height >= 0; height is in metres
   # @return [Float]
   #   return value >= 0; return value is in pascals
   # @example

data/lib/joules/quantum.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing quantum formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Quantum module (quantum.rb)
@@ -39,10 +39,15 @@ module Joules
   #   decay_constant != 0; decay_constant is in per second
   # @return [Float]
   #   return value is in seconds
+  # @raise [ZeroDivisionError] if decay_constant = 0
   # @example
   #   Joules.half_life(7.7e4) #=> 9.001911435843445e-06
   def half_life(decay_constant)
-    return Math.log(2) / decay_constant
+    if decay_constant.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return Math.log(2) / decay_constant
+    end
   end
 
   # Calculates the decay constant of a decaying quantity given half-life.
@@ -50,10 +55,15 @@ module Joules
   #   half_life != 0; half_life is in seconds
   # @return [Float]
   #   return value is in per second
+  # @raise [ZeroDivisionError] if half_life = 0
   # @example
   #   Joules.decay_constant(9) #=> 0.0770163533955495
   def decay_constant(half_life)
-    return Math.log(2) / half_life
+    if half_life.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return Math.log(2) / half_life
+    end
   end
 
 end

data/lib/joules/stress_strain.rb

@@ -0,0 +1,68 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing stress and strain formulas
+# @author: Elisha Lai
+# @version: 0.3.2 03/06/2015
+#==============================================================================
+
+# Stress and strain module (stress_strain.rb)
+
+module Joules
+  module_function
+
+  # Calculates the tensile stress given force and area.
+  # @param force [Int, Float]
+  #   force >= 0; force is in newtons
+  # @param area [Int, Float]
+  #   area > 0; area is in metres squared
+  # @return [Float]
+  #   return value >= 0; return value is in pascals
+  # @raise [ZeroDivisionError] if area = 0
+  # @example
+  #   Joules.tensile_stress(98, 0.04) #=> 2450.0
+  def tensile_stress(force, area)
+    if area.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return force / area.to_f
+    end
+  end
+
+  # Calculates the tensile strain given extension and length.
+  # @param extension [Int, Float]
+  #   extension >= 0; extension is in metres
+  # @param length [Int, Float]
+  #   length > 0; length is in metres
+  # @return [Float]
+  #   return value >= 0
+  # @raise [ZeroDivisionError] if length = 0 
+  # @example
+  #   Joules.tensile_strain(2, 10) #=> 0.2
+  def tensile_strain(extension, length)
+    if length.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return extension / length.to_f
+    end
+  end
+
+  # Calculates the Young modulus given tensile stress and tensile strain.
+  # @param tensile_stress [Int, Float]
+  #   tensile_stress >= 0; tensile_stress is in pascals
+  # @param tensile_strain [Int, Float]
+  #   tensile_strain > 0
+  # @return [Float]
+  #   return value >= 0; return value is in pascals
+  # @raise [ZeroDivisionError] if tensile_strain = 0
+  # @example
+  #   Joules.young_modulus(2450, 0.2) #=> 12250.0
+  def young_modulus(tensile_stress, tensile_strain)
+    if tensile_strain.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return tensile_stress / tensile_strain.to_f
+    end
+  end
+	
+end

data/lib/joules/thermodynamics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing thermodynamics formulas
 # @author: Elisha Lai
-# @version: 0.3.1 01/06/2015
+# @version: 0.3.2 03/06/2015
 #==============================================================================
 
 # Thermodynamics module (thermodynamics.rb)