joules 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 309af22d22628f2fecec4180108382f0edc324a9
-  data.tar.gz: 0729618e8e982c76cdecb3b9f30939c1e422e788
+  metadata.gz: fe0112745ba13a5455d979a35367768cdaa2f382
+  data.tar.gz: eca09701308ea046cf92d8a6b2777af12d4011b0
 SHA512:
-  metadata.gz: 93f6ca64737cfe6099ebf0fd9f8593591187f14b3e0ced850c2e152fab903044e66a587aa3a20a96a34cf43242ff4371272de7a595d6996b1d9b8c43a36f9d44
-  data.tar.gz: bb671926e1b41cb3e8d8e7678152b7fcc8ee9673f6a458c4af7ac1e8c97117368b79f224e0e4f99be662481039254ecfb442625d32f263e6262b45e95c4a756f
+  metadata.gz: bc5a94a2b8b9c9674d971c556335fb1ab4ccd116f2e95fe29c56f501d6b7daf89c7157a5cb1d38406d24c5cd71c1a359e9da3cdb6ec006283d99d73b6312520a
+  data.tar.gz: dea84c2a922ef20939c23216253bdaf0370e4b693609fb838f12c7f4260adc7517a594772134c74fcd9a66fb59d1abe916d6d00bea06c56d16964e83a843d32b

data/lib/joules/constants.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Constants module (constants.rb)

data/lib/joules/conversion.rb

@@ -0,0 +1,75 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing conversion formulas
+# @author: Elisha Lai
+# @version: 0.2.0 25/05/2015
+#==============================================================================
+
+# Conversion module (conversion.rb)
+
+# Calculates the equivalent angle in degrees given radians.
+# @param angle [Int, Float]
+#   angle is in radians
+# @return [Float]
+#   return value is in degrees
+# @example
+#   to_degrees(Math::PI/6) #=> 29.999999999999996
+def to_degrees(angle)
+  return (angle * 180) / Math::PI
+end
+
+# Calculates the equivalent angle in radians given degrees.
+# @param angle [Int, Float]
+#   angle is in degrees
+# @return [Float]
+#   return value is in radians
+# @example
+#   to_radians(30) #=> 0.5235987755982988
+def to_radians(angle)
+  return (angle * Math::PI) / 180
+end
+
+# Calculates the equivalent temperature in kelvins given celcius.
+# @param temperature [Int, Float]
+#   temperature is in celcius
+# @return [Float]
+#   return value is in kelvins
+# @example
+#   to_kelvins(20) #=> 293.15
+def to_kelvins(temperature)
+  return temperature + 273.15
+end
+
+# Calculates the equivalent temperature in celcius given kelvins.
+# @param temperature [Int, Float]
+#   temperature is in kelvins
+# @return [Float]
+#   return value is in celcius
+# @example
+#   to_celcius(293.15) #=> 20.0
+def to_celcius(temperature)
+  return temperature - 273.15
+end
+
+# Calculates the equivalent velocity in meters per second given kilometers per hour.
+# @param velocity [Int, Float]
+#   velocity is in kilometers per hour
+# @return [Float]
+#   return value is in meters per second
+# @example
+#   to_meters_per_second(200) #=> 55.55555555555556 
+def to_meters_per_second(velocity)
+  return (velocity * 1000) / 3600.0
+end
+
+# Calculates the equivalent velocity in kilometers per hour given meters per second.
+# @param velocity [Int, Float]
+#   velocity is in meters per second
+# @return [Float]
+#   return value is in kilometers per hour
+# @example
+#   to_kilometers_per_hour(50) #=> 180.0
+def to_kilometers_per_hour(velocity)
+  return (velocity * 3600) / 1000.0
+end

data/lib/joules/density.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing density formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Density module (density.rb)
@@ -14,7 +14,7 @@
 # @param volume [Int, Float]
 #   volume > 0; volume is in meters cubed
 # @return [Float]
-#   returned value >= 0; returned value is in kilograms per meter cubed
+#   return value >= 0; return value is in kilograms per meter cubed
 # @example
 #   density(8.96, 0.002) #=> 4480.0   
 def density(mass, volume)

data/lib/joules/electricity.rb

@@ -0,0 +1,215 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing electricity formulas
+# @author: Elisha Lai
+# @version: 0.2.0 25/05/2015
+#==============================================================================
+
+# Electricity module (electricity.rb)
+
+# Calculates the current given charge and time.
+# @param charge [Int, Float]
+#   charge is in coulombs
+# @param time [Int, Float]
+#   time > 0; time is in seconds
+# @return [Float]
+#   return value is in amperes
+# @example
+#   current(325, 5) #=> 65.0
+def current(charge, time)
+  return charge / time.to_f
+end
+
+# Calculates the resistance given voltage and current.
+# @param voltage [Int, Float]
+#   voltage is in volts
+# @param current [Int, Float]
+#   current != 0; current is in amperes
+# @return [Float]
+#   return value is in ohms
+# @example
+#   resistance(1.8, 0.6) #=> 3.0
+# @note There is one other method for calculating resistance.
+def resistance_v1(voltage, current)
+  return voltage / current.to_f	
+end
+
+# Calculates the resistance given resistivity, wire length, and cross sectional area.
+# @param resistivity [Int, Float]
+#   resistivity >= 0; resistivity is in ohm metres
+# @param wire_length [Int, Float]
+#   wire_length >= 0; wire_length is in meters
+# @param cross_sectional_area [Int, Float]
+#   cross_sectional_area > 0; cross_sectional_area is in meters squared
+# @return [Float]
+#   return value >= 0; return value is in ohms
+# @example
+#   resistance_v2(1e13, 250, 0.4) #=> 6.25e+15
+# @note There is one other method for calculating resistance.
+def resistance_v2(resistivity, wire_length, cross_sectional_area)
+  return (resistivity * wire_length) / cross_sectional_area.to_f
+end
+
+# Calculates the total resistance of resistors in series.
+# @param resistances [Array<Int, Float>]
+#   each resistance in resistances is in ohms
+# @return [Float]
+#   return value is in ohms
+# @example
+#   resistance_in_series([10, 5, 3.4, 6.3]) #=> 24.7
+def resistance_in_series(resistances)
+  total_resistance = 0
+  resistances.each do |resistance|
+    total_resistance += resistance
+  end
+  return total_resistance.to_f
+end
+
+# Calculates the total resistance of resistors in parallel.
+# @param resistances [Array<Int, Float>]
+#   each resistance in resistances != 0; each resistance in resistances is in ohms
+# @return [Float]
+#   return value is in ohms
+# @example
+#   resistance_in_parallel([0.5, 0.25, 0.125]) #=> 0.07142857142857142
+def resistance_in_parallel(resistances)
+  if resistances.empty?
+    raise ArgumentError.new('empty list of resistances')
+  end
+  total_resistance = 0
+  resistances.each do |resistance|
+    total_resistance += (1.0 / resistance)
+  end
+  return 1 / total_resistance
+end
+
+# Calculates the total capacitance given charge and voltage.
+# @param charge [Int, Float]
+#   charge is in coulombs
+# @param voltage [Int, Float]
+#   voltage != 0; voltage is in volts
+# @return [Float]
+#   return value is in farads
+def capacitance(charge, voltage)
+  return charge / voltage.to_f
+end
+
+# Calculates the total capacitance of capacitors in series.
+# @param capacitances [Array<Int, Float>]
+#   each capacitance in resistances != 0; each capacitance in capacitances is in farads
+# @return [Float]
+#   return value is in farads
+# @example
+#   capacitance_in_series([0.5, 0.25, 0.125]) #=> 0.07142857142857142
+def capacitance_in_series(capacitances)
+  if capacitances.empty?
+    raise ArgumentError.new('empty list of capacitances')
+  end
+  total_capacitance = 0
+  capacitances.each do |capacitance|
+  	total_capacitance += (1.0 / capacitance)
+  end
+  return 1 / total_capacitance
+end
+
+# Calculates the total capacitance in parallel given capacitances.
+# @param capacitances [Array<Int, Float>]
+#   each capacitance in capacitances is in farads
+# @return [Float]
+#   return value is in farads
+# @example
+#   capacitance_in_parallel([10, 5, 3.4, 6.3]) #=> 24.7
+def capacitance_in_parallel(capacitances)
+  total_capacitance = 0
+  capacitances.each do |capacitance|
+  	total_capacitance += capacitance
+  end
+  return total_capacitance.to_f
+end
+
+# Calculates the voltage given energy and charge.
+# @param energy [Int, Float]
+#   energy is in joules
+# @param charge [Int, Float]
+#   charge != 0; charge is in coulombs
+# @return [Float]
+#   return value is in volts
+# @example
+#   voltage_v1(1.8, 0.6) #=> 3.0
+# @note There is one other method for calculating voltage.
+def voltage_v1(energy, charge)
+  return energy / charge.to_f
+end
+
+# Calculates the voltage given current and resistance.
+# @param current [Int, Float]
+#   current is in amperes
+# @param resistance [Int, Float]
+#   resistance is in ohms
+# @return [Float]
+#   return value is in volts
+# @example
+#   voltage_v2(0.6, 3) #=> 1.8
+# @note There is one other method for calculating voltage.
+def voltage_v2(current, resistance)
+  return current * resistance.to_f
+end
+
+# Calculates the power given voltage and current.
+# @param voltage [Int, Float]
+#   voltage is in volts
+# @param current [Int, Float]
+#   current is in amperes
+# @return [Float]
+#   return value is in watts
+# @example
+#   power_v2(1.8, 0.6) #=> 1.08
+# @note There are three other methods for calculating power.
+def power_v2(voltage, current)
+  return voltage * current.to_f
+end
+
+# Calculates the power given current and resistance.
+# @param current [Int, Float]
+#   current is in amperes
+# @param resistance [Int, Float]
+#   resistance is in ohms
+# @return [Float]
+#   return value is in watts
+# @example
+#   power_v3(0.6, 3) #=> 1.08
+# @note There are three other methods for calculating power.
+def power_v3(current, resistance)
+  return (current ** 2.0) * resistance
+end
+
+# Calculates the power given voltage and resistance.
+# @param voltage [Int, Float]
+#   voltage is in volts
+# @param resistance [Int, Float]
+#   resistance != 0; resistance is in ohms
+# @return [Float]
+#   return value is in watts
+# @example
+#   power_v4(1.8, 3) #=> 1.08
+# @note There are three other methods for calculating power.
+def power_v4(voltage, resistance)
+  return (voltage ** 2.0) / resistance
+end
+
+# Calculates the energy given voltage, current, and time.
+# @param voltage [Int, Float]
+#   voltage is in volts
+# @param current [Int, Float]
+#   current is in amperes
+# @param time [Int, Float]
+#   time >= 0; time is in seconds
+# @return [Float]
+#   return value is in joules
+# @example
+#   energy_v3(1.8, 0.6, 5) #=> 5.4
+# @note There are two other methods for calculating energy.
+def energy_v3(voltage, current, time)
+  return power_v2(voltage, current) * time
+end

data/lib/joules/energy_work_power.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing energy, work, and power formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)
@@ -16,7 +16,7 @@ require_relative 'constants'
 # @param height [Int, Float]
 #   height >= 0; height is in meters
 # @return [Float]
-#   returned value >= 0; returned value is in joules
+#   return value >= 0; return value is in joules
 # @example
 #   gravitational_potential_energy(0.5, 6) #=> 29.43
 def gravitational_potential_energy(mass, height)
@@ -29,7 +29,7 @@ end
 # @param extension [Int, Float]
 #   extension >= 0; extension is in meters
 # @return [Float]
-#   returned value is in joules
+#   return value >= 0; return value is in joules
 # @example
 #   elastic_potential_energy(81.75, 2.4) #=> 235.44
 def elastic_potential_energy(spring_constant, extension)
@@ -42,7 +42,7 @@ end
 # @param velocity [Int, Float]
 #   velocity is in meters per second
 # @return [Float]
-#   returned value >= 0; returned value is in joules
+#   return value >= 0; return value is in joules
 # @example
 #   kinetic_energy(500, 22) #=> 121000.0 
 def kinetic_energy(mass, velocity)
@@ -55,7 +55,7 @@ end
 # @param distance [Int, Float]
 #   distance >= 0; distance is in meters
 # @return [Float]
-#   returned value is in joules
+#   return value is in joules
 # @example
 #   work_done(40, 2.34) #=> 93.6
 def work_done(force, distance)
@@ -68,10 +68,11 @@ end
 # @param time [Int, Float]
 #   time > 0; time is in seconds
 # @return [Float]
-#   returned value is in watts
+#   return value is in watts
 # @example
-#   power(28, 7) #=> 4.0
-def power(work_done, time)
+#   power_v1(28, 7) #=> 4.0
+# @note There are three other methods for calculating power.
+def power_v1(work_done, time)
   return work_done / time.to_f
 end
 
@@ -81,7 +82,7 @@ end
 # @param energy_input [Int, Float]
 #   energy_input > 0; energy_input is in joules
 # @return [Float]
-#   returned value >= 0
+#   return value >= 0
 # @example
 #   energy_efficiency(16, 20) #=> 80.0 
 def energy_efficiency(useful_energy_output, energy_input)
@@ -94,7 +95,7 @@ end
 # @param power_input [Int, Float]
 #   power_input > 0; power_input is in watts
 # @return [Float]
-#   returned value >= 0
+#   return value >= 0
 # @example
 #   power_efficiency(26, 40) #=> 65.0
 def power_efficiency(useful_power_output, power_input)

data/lib/joules/forces.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Forces module (forces.rb)
@@ -14,7 +14,7 @@
 # @param acceleration [Int, Float]
 #   acceleration is in meters per second squared
 # @return [Float]
-#   returned value is in newtons
+#   return value is in newtons
 # @example
 #   force_v1(120, 2.67) #=> 320.4
 # @note There are two other methods for calculating force. 
@@ -28,7 +28,7 @@ end
 # @param extension [Int, Float]
 #   extension >= 0; extension is in meters
 # @return [Float]
-#   returned value >= 0; returned value is in newtons
+#   return value >= 0; return value is in newtons
 # @example
 #   force_v2(81.75, 2.4) #=> 196.2
 # @note There are two other methods for calculating force.
@@ -46,7 +46,7 @@ end
 # @param time [Int, Float]
 #   time > 0; time is in seconds
 # @return [Float]
-#   returned value is in newtons
+#   return value is in newtons
 # @example
 #   force_v3(20, 35, 50, 2.4) #=> 312.5
 # @note There are two other methods for calculating force.
@@ -60,7 +60,7 @@ end
 # @param distance [Int, Float]
 #   distance >= 0; distance is in meters
 # @return [Float]
-#   returned value is in newton metres
+#   return value is in newton metres
 # @example
 #   moment(23, 4.5) #=> 103.5
 def moment(force, distance)

data/lib/joules/geometry.rb

@@ -0,0 +1,92 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing geometry formulas
+# @author: Elisha Lai
+# @version: 0.2.0 25/05/2015
+#==============================================================================
+
+# Geometry module (geometry.rb)
+
+# Calculates the arc length of a circle given radius and central angle.
+# @param radius [Int, Float]
+#   radius >= 0; radius is in a unit of length
+# @param central_angle [Int, Float]
+#   central_angle >= 0; central_angle is in radians
+# @return [Float]
+#   return value >= 0; return value has the same units as radius
+# @example
+#   arc_length(12, (Math::PI/4)) #=> 9.42477796076938
+def arc_length(radius, central_angle)
+  return radius * central_angle.to_f
+end
+
+# Calculates the circumference of a circle given radius.
+# @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
+# @example
+#   circumference(12) #=> 75.398223686155 
+def circumference(radius)
+  return 2 * Math::PI * radius
+end
+
+# Calculates the area of a circle given radius.
+# @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
+# @example
+#   circle_area(12) #=> 452.38934211693 
+def circle_area(radius)
+  return Math::PI * (radius ** 2)
+end
+
+# Calculates the surface area of a sphere given radius.
+# @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
+# @example
+#   sphere_surface_area(12) #=> 1809.55736846772
+def sphere_surface_area(radius)
+  return 4 * Math::PI * (radius ** 2)
+end
+
+# Calculates the volume of a sphere given radius.
+# @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
+# @example
+#   sphere_volume(12) #=> 7238.22947387088
+def sphere_volume(radius)
+  return (4 * Math::PI * (radius ** 3)) / 3
+end
+
+# Calulates the surface area of a cylinder given radius and height.
+# @param radius [Int, Float]
+#   radius >= 0; radius is in a unit of length
+# @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
+# @example
+#   cylinder_surface_area(6.5, 3) #=> 122.522113490002
+def cylinder_surface_area(radius, height)
+  return circumference(radius) * height
+end
+
+# Calculates the volume of a cylinder given radius and height.
+# @param radius [Int, Float]
+#   radius >= 0; radius is in a unit of length
+# @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
+# @example
+#   cylinder_volume(6.5, 3) #=> 398.196868842506 
+def cylinder_volume(radius, height)
+  return circle_area(radius) * height
+end

data/lib/joules/kinematics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing kinematics formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Kinematics module (kinematics.rb)
@@ -14,7 +14,7 @@
 # @param time [Int, Float]
 #   time > 0; time is in seconds
 # @return [Float]
-#   returned value >= 0; returned value is in meters per second
+#   return value >= 0; return value is in meters per second
 # @example
 #   avg_speed(30, 2.4) #=> 12.5
 def avg_speed(distance, time)
@@ -27,7 +27,7 @@ end
 # @param time [Int, Float]
 #   time > 0; time is in seconds
 # @return [Float]
-#   returned value is in meters per second
+#   return value is in meters per second
 # @example
 #   avg_velocity(180, 4.8) #=> 37.5 
 def avg_velocity(displacement, time)
@@ -42,7 +42,7 @@ end
 # @param time [Int, Float]
 #   time > 0; time is in seconds
 # @return [Float]
-#   returned value is in meters per second squared
+#   return value is in meters per second squared
 # @example
 #   acceleration(20, 35, 2.4) #=> 6.25
 def acceleration(initial_velocity, final_velocity, time)
@@ -57,7 +57,7 @@ end
 # @param time [Int, Float]
 #   time >= 0; time is in seconds
 # @return [Float]
-#   returned value is in meters per second
+#   return value is in meters per second
 # @example
 #   final_velocity_v1(20, 6.25, 2.4) #=> 35.0
 # @note There is one other method for calculating final velocity.
@@ -73,7 +73,7 @@ end
 # @param displacement [Int, Float]
 #   displacement is in meters
 # @return [Float]
-#   returned value is in meters per second
+#   return value is in meters per second
 # @example
 #   final_velocity_v2(20, 6.25, 66) #=> 35.0
 # @note There is one other method for calculating final velocity.
@@ -89,7 +89,7 @@ end
 # @param time [Int, Float]
 #   time >= 0; time is in seconds
 # @return [Float]
-#   returned value is in meters
+#   return value is in meters
 # @example
 #   displacement_v1(20, 35, 2.4) #=> 66.0
 # @note There are two other methods for calculating displacement.
@@ -105,7 +105,7 @@ end
 # @param time [Int, Float]
 #   time >= 0; time is in seconds
 # @return [Float]
-#   returned value is in meters
+#   return value is in meters
 # @example
 #   displacement_v2(20, 6.25, 2.4) #=> 66.0
 # @note There are two other methods for calculating displacement.
@@ -121,7 +121,7 @@ end
 # @param time [Int, Float]
 #   time >= 0; time is in seconds
 # @return [Float]
-#   returned value is in meters
+#   return value is in meters
 # @example
 #   displacement_v3(35, 6.25, 2.4) #=> 66.0
 # @note There are two other methods for calculating displacement.

data/lib/joules/mass_weight.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Mass and weight module (mass_weight.rb)
@@ -14,7 +14,7 @@ require_relative 'constants'
 # @param mass [Int, Float]
 #   mass >= 0; mass is in kilograms
 # @return [Float]
-#   returned value >= 0; returned value is in newtons
+#   return value >= 0; return value is in newtons
 # @example
 #   weight(79.41) #=> 779.0121
 def weight(mass)
@@ -25,7 +25,7 @@ end
 # @param weight [Int, Float]
 #   weight >= 0; weight is in newtons
 # @return [Float]
-#   returned value >= 0; returned value is in kilograms
+#   return value >= 0; return value is in kilograms
 # @example
 #   mass(779.0121) #=> 79.41
 def mass(weight)

data/lib/joules/momentum_impulse.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing momentum and impulse formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)
@@ -14,7 +14,7 @@
 # @param velocity [Int, Float]
 #   velocity is in meters per second
 # @return [Float]
-#   returned value is in newton seconds
+#   return value is in newton seconds
 # @example
 #   momentum(52, 4.7) #=> 244.4
 def momentum(mass, velocity)
@@ -27,7 +27,7 @@ end
 # @param time [Int, Float]
 #   time >= 0; time is in seconds
 # @return [Float]
-#   returned value is in newton seconds
+#   return value is in newton seconds
 # @example
 #   impulse_v1(30.8, 9.6) #=> 295.68
 # @note There is one other method for calculating impulse.
@@ -43,7 +43,7 @@ end
 # @param mass [Int, Float]
 #   mass >= 0; mass is in kilograms
 # @return [Float]
-#   returned value is in newton seconds
+#   return value is in newton seconds
 # @example
 #   impulse_v2(20, 35, 2.4) #=> 36.0
 # @note There is one other method for calculating impulse.

data/lib/joules/pressure.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Pressure module (pressure.rb)
@@ -16,7 +16,7 @@ require_relative 'constants'
 # @param area [Int, Float]
 #   area > 0; area is in meters cubed
 # @return [Float]
-#   returned value >= 0; returned value is in pascals
+#   return value >= 0; return value is in pascals
 # @example
 #   pressure(98, 0.04) #=> 2450.0 
 def pressure(force, area)
@@ -29,7 +29,7 @@ end
 # @param height [Int, Float]
 #   height >= 0; height is in meters
 # @return [Float]
-#   returned value >= 0; returned value is in pascals
+#   return value >= 0; return value is in pascals
 # @example
 #   hydrostatic_pressure(1000, 5) #=> 49050.0
 def hydrostatic_pressure(density, height)

data/lib/joules/thermodynamics.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing thermodynamics formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Thermodynamics module (thermodynamics.rb)
@@ -16,10 +16,10 @@
 # @param temperature_change [Int, Float]
 #   temperature_change is in celcius
 # @return [Float]
-#   returned value is in joules
+#   return value is in joules
 # @example
 #   energy_v1(500, 2.46, 3.6) #=> 4428.0
-# @note There is one other method for calculating energy.
+# @note There are two other methods for calculating energy.
 def energy_v1(mass, specific_heat_capacity, temperature_change)
   return mass * specific_heat_capacity * temperature_change.to_f
 end
@@ -30,10 +30,10 @@ end
 # @param specific_latent_heat [Int, Float]
 #   specific_latent_heat >= 0; specific_latent_heat is in joules per kilogram
 # @return [Float]
-#   returned value is in joules
+#   return value is in joules
 # @example
 #   energy_v2(84.3, 72.1) #=> 6078.03
-# @note There is one other method for calculating energy.
+# @note There are two other methods for calculating energy.
 def energy_v2(mass, specific_latent_heat)
   return mass * specific_latent_heat.to_f
 end

data/lib/joules/waves.rb

@@ -3,18 +3,20 @@
 #
 # @description: Module for providing waves formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Waves module (waves.rb)
 
+require_relative 'conversion'
+
 # Calculates the wave speed given frequency and wavelength.
 # @param frequency [Int, Float]
 #   frequency > 0; frequency is in hertz
 # @param wavelength [Int, Float]
 #   wavelength >= 0; wavelength is in meters
 # @return [Float]
-#   returned value >= 0; returned value is in meters per second
+#   return value >= 0; return value is in meters per second
 # @example
 #    wave_speed(3250, 0.1) #=> 325.0
 def wave_speed(frequency, wavelength)
@@ -27,7 +29,7 @@ end
 # @param frequency [Int, Float]
 #   frequency > 0; frequency is in hertz
 # @return [Float]
-#   returned value is in meters
+#   return value is in meters
 # @example
 #   wavelength(325, 3250) #=> 0.1
 def wavelength(wave_speed, frequency)
@@ -40,7 +42,7 @@ end
 # @param wavelength [Int, Float]
 #   wavelength > 0; wavelength is in meters
 # @return [Float]
-#   returned value is in hertz
+#   return value is in hertz
 # @example
 #   frequency_v1(325, 0.1) #=> 3250.0
 # @note There is one other method for calculating frequency.
@@ -52,7 +54,7 @@ end
 # @param time_period [Int, Float]
 #   time_period > 0; time_period is in seconds
 # @return [Float]
-#   returned value > 0; returned value is in hertz
+#   return value > 0; return value is in hertz
 # @example
 #   frequency_v2(12.5) #=> 0.08
 # @note There is one other method for calculating frequency.
@@ -64,9 +66,34 @@ end
 # @param frequency [Int, Float]
 #   frequency > 0; frequency is in hertz
 # @return [Float]
-#   returned value > 0; returned value is in hertz
+#   return value > 0; return value is in hertz
 # @example
 #   time_period(0.08) #=> 12.5
 def time_period(frequency)
   return 1.0 / frequency
 end
+
+# Calculates the refractive index of a substance given angle of incidence and angle of refraction.
+# @param angle_of_incidence [Int, Float]
+#   angle_of_incidence is in degrees
+# @param angle_of_refraction [Int, Float]
+#   angle_of_refraction is in degrees
+# @return [Float]
+# @example
+#   refractive_index_v1(50, 35) #=> 1.3355577296591308
+# @note There is one other method for calculating refractive index.
+def refractive_index_v1(angle_of_incidence, angle_of_refraction)
+  return Math.sin(to_radians(angle_of_incidence)) /
+         Math.sin(to_radians(angle_of_refraction))
+end
+
+# Calculates the refractive index of a substance given critical angle.
+# @param critical_angle [Int, Float]
+#   critical_angle != 0; critical_angle is in degrees
+# @return [Float]
+# @example
+#   refractive_index_v2(48.7535) #=> 1.3299993207924483
+# @note There is one other method for calculating refractive index.
+def refractive_index_v2(critical_angle)
+  return 1.0 / Math.sin(to_radians(critical_angle))
+end

data/lib/joules.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing Physics formulas
 # @author: Elisha Lai
-# @version: 0.1.0 23/05/2015
+# @version: 0.2.0 25/05/2015
 #==============================================================================
 
 # Joules module (joules.rb)
@@ -18,3 +18,6 @@ require 'joules/energy_work_power'
 require 'joules/pressure'
 require 'joules/thermodynamics'
 require 'joules/waves'
+require 'joules/electricity'
+require 'joules/geometry'
+require 'joules/conversion'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-23 00:00:00.000000000 Z
+date: 2015-05-25 00:00:00.000000000 Z
 dependencies: []
 description: "    Joules is a library (gem) for providing simple Physics formulas\n
   \   in kinematics, forces, waves, electricity, and so much more. A\n    selection
@@ -20,9 +20,12 @@ extra_rdoc_files: []
 files:
 - lib/joules.rb
 - lib/joules/constants.rb
+- lib/joules/conversion.rb
 - lib/joules/density.rb
+- lib/joules/electricity.rb
 - lib/joules/energy_work_power.rb
 - lib/joules/forces.rb
+- lib/joules/geometry.rb
 - lib/joules/kinematics.rb
 - lib/joules/mass_weight.rb
 - lib/joules/momentum_impulse.rb