joules 0.3.0 → 0.3.1

data/lib/joules/energy_work_power.rb

@@ -3,115 +3,118 @@
 #
 # @description: Module for providing energy, work, and power formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)
 
-require_relative 'constants'
+module Joules
+  module_function
 
-# Calculates the gravitational potential energy given mass and height.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @param height [Int, Float]
-#   height >= 0; height is in meters
-# @return [Float]
-#   return value >= 0; return value is in joules
-# @example
-#   gravitational_potential_energy(0.5, 6) #=> 29.43
-def gravitational_potential_energy(mass, height)
-  return mass * FREE_FALL_ACCELERATION * height
-end
+  # Calculates the gravitational potential energy given mass and height.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param height [Int, Float]
+  #   height >= 0; height is in meters
+  # @return [Float]
+  #   return value >= 0; return value is in joules
+  # @example
+  #   Joules.gravitational_potential_energy(0.5, 6) #=> 29.43
+  def gravitational_potential_energy(mass, height)
+    return mass * FREE_FALL_ACCELERATION * height
+  end
 
-# Calculates the elastic potential energy given spring constant and extension.
-# @param spring_constant [Int, Float]
-#   spring_constant >= 0; spring_constant is in newtons per meter
-# @param extension [Int, Float]
-#   extension >= 0; extension is in meters
-# @return [Float]
-#   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)
-  return 0.5 * spring_constant * (extension ** 2)
-end
+  # Calculates the elastic potential energy given spring constant and extension.
+  # @param spring_constant [Int, Float]
+  #   spring_constant >= 0; spring_constant is in newtons per meter
+  # @param extension [Int, Float]
+  #   extension >= 0; extension is in meters
+  # @return [Float]
+  #   return value >= 0; return value is in joules
+  # @example
+  #   Joules.elastic_potential_energy(81.75, 2.4) #=> 235.44
+  def elastic_potential_energy(spring_constant, extension)
+    return 0.5 * spring_constant * (extension ** 2)
+  end
 
-# Calculates the kinetic energy given mass and velocity.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @param velocity [Int, Float]
-#   velocity is in meters per second
-# @return [Float]
-#   return value >= 0; return value is in joules
-# @example
-#   kinetic_energy(500, 22) #=> 121000.0 
-def kinetic_energy(mass, velocity)
-  return 0.5 * mass * (velocity ** 2)
-end
+  # Calculates the kinetic energy given mass and velocity.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param velocity [Int, Float]
+  #   velocity is in meters per second
+  # @return [Float]
+  #   return value >= 0; return value is in joules
+  # @example
+  #   Joules.kinetic_energy(500, 22) #=> 121000.0 
+  def kinetic_energy(mass, velocity)
+    return 0.5 * mass * (velocity ** 2)
+  end
 
-# Calculates the work done given force and displacement.
-# @param force [Int, Float]
-#   force is in newtons
-# @param displacement [Int, Float]
-#   displacement is in meters
-# @return [Float]
-#   return value is in joules
-# @example
-#   work_done(40, 2.34) #=> 93.6
-def work_done(force, displacement)
-  return force * displacement.to_f
-end
+  # Calculates the work done given force and displacement.
+  # @param force [Int, Float]
+  #   force is in newtons
+  # @param displacement [Int, Float]
+  #   displacement is in meters
+  # @return [Float]
+  #   return value is in joules
+  # @example
+  #   Joules.work_done(40, 2.34) #=> 93.6
+  def work_done(force, displacement)
+    return force * displacement.to_f
+  end
 
-# Calculates the power given work done and time.
-# @param work_done [Int, Float]
-#   work_done is in joules
-# @param time [Int, Float]
-#   time > 0; time is in seconds
-# @return [Float]
-#   return value is in watts
-# @example
-#   power_v1(28, 7) #=> 4.0
-# @note There are four other methods for calculating power.
-def power_v1(work_done, time)
-  return work_done / time.to_f
-end
+  # Calculates the power given work done and time.
+  # @param work_done [Int, Float]
+  #   work_done is in joules
+  # @param time [Int, Float]
+  #   time > 0; time is in seconds
+  # @return [Float]
+  #   return value is in watts
+  # @example
+  #   Joules.power_v1(28, 7) #=> 4.0
+  # @note There are four other methods for calculating power.
+  def power_v1(work_done, time)
+    return work_done / time.to_f
+  end
 
-# Calculates the power given force and velocity.
-# @param force [Int, Float]
-#   force is in newtons
-# @param velocity [Int, Float]
-#   velocity is in meters per second
-# @return [Float]
-#   return value is in watts
-# @example
-#   power_v2(42, 2.3) #=> 96.6
-# @note There are four other methods for calculating power.
-def power_v2(force, velocity)
-  return force * velocity.to_f
-end
+  # Calculates the power given force and velocity.
+  # @param force [Int, Float]
+  #   force is in newtons
+  # @param velocity [Int, Float]
+  #   velocity is in meters per second
+  # @return [Float]
+  #   return value is in watts
+  # @example
+  #   Joules.power_v2(42, 2.3) #=> 96.6
+  # @note There are four other methods for calculating power.
+  def power_v2(force, velocity)
+    return force * velocity.to_f
+  end
 
-# Calculates the energy efficiency given useful energy output and energy input.
-# @param useful_energy_output [Int, Float]
-#   0 <= useful_energy_output <= energy_input; useful_energy_output is in joules
-# @param energy_input [Int, Float]
-#   energy_input > 0; energy_input is in joules
-# @return [Float]
-#   return value >= 0
-# @example
-#   energy_efficiency(16, 20) #=> 80.0 
-def energy_efficiency(useful_energy_output, energy_input)
-  return (useful_energy_output / energy_input.to_f) * 100
-end
+  # Calculates the energy efficiency given useful energy output and energy input.
+  # @param useful_energy_output [Int, Float]
+  #   0 <= useful_energy_output <= energy_input; useful_energy_output is in joules
+  # @param energy_input [Int, Float]
+  #   energy_input > 0; energy_input is in joules
+  # @return [Float]
+  #   return value >= 0
+  # @example
+  #   Joules.energy_efficiency(16, 20) #=> 80.0 
+  def energy_efficiency(useful_energy_output, energy_input)
+    return (useful_energy_output / energy_input.to_f) * 100
+  end
+
+  # Calculates the power efficiency given useful power output and power input.
+  # @param useful_power_output [Int, Float]
+  #   0 <= useful_power_output <= power_input; useful_power_output is in watts
+  # @param power_input [Int, Float]
+  #   power_input > 0; power_input is in watts
+  # @return [Float]
+  #   return value >= 0
+  # @example
+  #   Joules.power_efficiency(26, 40) #=> 65.0
+  def power_efficiency(useful_power_output, power_input)
+    return (useful_power_output / power_input.to_f) * 100
+  end
 
-# Calculates the power efficiency given useful power output and power input.
-# @param useful_power_output [Int, Float]
-#   0 <= useful_power_output <= power_input; useful_power_output is in watts
-# @param power_input [Int, Float]
-#   power_input > 0; power_input is in watts
-# @return [Float]
-#   return value >= 0
-# @example
-#   power_efficiency(26, 40) #=> 65.0
-def power_efficiency(useful_power_output, power_input)
-  return (useful_power_output / power_input.to_f) * 100
 end

data/lib/joules/forces.rb

@@ -3,66 +3,71 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Forces module (forces.rb)
 
-# Calculates the force given mass and acceleration.
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @param acceleration [Int, Float]
-#   acceleration is in meters per second squared
-# @return [Float]
-#   return value is in newtons
-# @example
-#   force_v1(120, 2.67) #=> 320.4
-# @note There are two other methods for calculating force. 
-def force_v1(mass, acceleration)
-  return mass * acceleration.to_f
-end
+module Joules
+  module_function
 
-# Calculates the force given spring constant and extension.
-# @param spring_constant [Int, Float]
-#   spring_constant >= 0; spring_constant is in newtons per meter
-# @param extension [Int, Float]
-#   extension >= 0; extension is in meters
-# @return [Float]
-#   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.
-def force_v2(spring_constant, extension)
-  return spring_constant * extension.to_f
-end
+  # Calculates the force given mass and acceleration.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param acceleration [Int, Float]
+  #   acceleration is in meters per second squared
+  # @return [Float]
+  #   return value is in newtons
+  # @example
+  #   Joules.force_v1(120, 2.67) #=> 320.4
+  # @note There are two other methods for calculating force. 
+  def force_v1(mass, acceleration)
+    return mass * acceleration.to_f
+  end
 
-# Calculates the force given initial velocity, final velocity, mass, and time.
-# @param initial_velocity [Int, Float]
-#   initial_velocity is in meters per second
-# @param final_velocity [Int, Float]
-#   final_velocity is in meters per second
-# @param mass [Int, Float]
-#   mass >= 0; mass is in kilograms
-# @param time [Int, Float]
-#   time > 0; time is in seconds
-# @return [Float]
-#   return value is in newtons
-# @example
-#   force_v3(20, 35, 50, 2.4) #=> 312.5
-# @note There are two other methods for calculating force.
-def force_v3(initial_velocity, final_velocity, mass, time)
-  return ((final_velocity - initial_velocity) * mass) / time.to_f
-end
+  # Calculates the force given spring constant and extension.
+  # @param spring_constant [Int, Float]
+  #   spring_constant >= 0; spring_constant is in newtons per meter
+  # @param extension [Int, Float]
+  #   extension >= 0; extension is in meters
+  # @return [Float]
+  #   return value >= 0; return value is in newtons
+  # @example
+  #   Joules.force_v2(81.75, 2.4) #=> 196.2
+  # @note There are two other methods for calculating force.
+  def force_v2(spring_constant, extension)
+    return spring_constant * extension.to_f
+  end
+
+  # Calculates the force given initial velocity, final velocity, mass, and time.
+  # @param initial_velocity [Int, Float]
+  #   initial_velocity is in meters per second
+  # @param final_velocity [Int, Float]
+  #   final_velocity is in meters per second
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param time [Int, Float]
+  #   time > 0; time is in seconds
+  # @return [Float]
+  #   return value is in newtons
+  # @example
+  #   Joules.force_v3(20, 35, 50, 2.4) #=> 312.5
+  # @note There are two other methods for calculating force.
+  def force_v3(initial_velocity, final_velocity, mass, time)
+    return ((final_velocity - initial_velocity) * mass) / time.to_f
+  end
+
+  # Calculates the moment given force and distance.
+  # @param force [Int, Float]
+  #   force is in newtons
+  # @param distance [Int, Float]
+  #   distance >= 0; distance is in meters
+  # @return [Float]
+  #   return value is in newton metres
+  # @example
+  #   Joules.moment(23, 4.5) #=> 103.5
+  def moment(force, distance)
+    return force * distance.to_f
+  end
 
-# Calculates the moment given force and distance.
-# @param force [Int, Float]
-#   force is in newtons
-# @param distance [Int, Float]
-#   distance >= 0; distance is in meters
-# @return [Float]
-#   return value is in newton metres
-# @example
-#   moment(23, 4.5) #=> 103.5
-def moment(force, distance)
-  return force * distance.to_f
 end

data/lib/joules/geometry.rb

@@ -3,129 +3,134 @@
 #
 # @description: Module for providing geometry formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Geometry module (geometry.rb)
 
-# Calculates the area of a rectangle given length and width.
-# @param length [Int, Float]
-#   length >= 0; length is in a unit of length
-# @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
-# @example
-#   rectangle_area(2, 3.4) #=> 6.8
-def rectangle_area(length, width)
-  return length * width.to_f
-end
+module Joules
+  module_function
 
-# 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 area of a rectangle given length and width.
+  # @param length [Int, Float]
+  #   length >= 0; length is in a unit of length
+  # @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
+  # @example
+  #   Joules.rectangle_area(2, 3.4) #=> 6.8
+  def rectangle_area(length, width)
+    return length * width.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 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
+  #   Joules.arc_length(12, (Math::PI/4)) #=> 9.42477796076938
+  def arc_length(radius, central_angle)
+    return radius * central_angle.to_f
+  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 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
+  #   Joules.circumference(12) #=> 75.398223686155 
+  def circumference(radius)
+    return 2 * Math::PI * radius
+  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.5573684677208
-def sphere_surface_area(radius)
-  return 4 * circle_area(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
+  #   Joules.circle_area(12) #=> 452.38934211693 
+  def circle_area(radius)
+    return 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.229473870883
-def sphere_volume(radius)
-  return (4 * circle_area(radius) * radius) / 3
-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
+  #   Joules.sphere_surface_area(12) #=> 1809.5573684677208
+  def sphere_surface_area(radius)
+    return 4 * circle_area(radius)
+  end
 
-# Calculates the surface area of a cone given radius and slant height.
-# @param radius [Int, Float]
-#   radius >= 0; radius is in a unit of length
-# @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
-# @example
-#   cone_surface_area(3, 5.83) #=> 83.22078939359362
-def cone_surface_area(radius, slant_height)
-  return circle_area(radius) + (Math::PI * radius * slant_height)
-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
+  #   Joules.sphere_volume(12) #=> 7238.229473870883
+  def sphere_volume(radius)
+    return (4 * circle_area(radius) * radius) / 3
+  end
 
-# Calculates the volume of a cone 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
-#   cone_volume(6.5, 3) #=> 132.73228961416876
-def cone_volume(radius, height)
-  return (circle_area(radius) * height) / 3
-end
+  # Calculates the surface area of a cone given radius and slant height.
+  # @param radius [Int, Float]
+  #   radius >= 0; radius is in a unit of length
+  # @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
+  # @example
+  #   Joules.cone_surface_area(3, 5.83) #=> 83.22078939359362
+  def cone_surface_area(radius, slant_height)
+    return circle_area(radius) + (Math::PI * radius * slant_height)
+  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 cone 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
+  #   Joules.cone_volume(6.5, 3) #=> 132.73228961416876
+  def cone_volume(radius, height)
+    return (circle_area(radius) * height) / 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
+  #   Joules.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
+  #   Joules.cylinder_volume(6.5, 3) #=> 398.196868842506 
+  def cylinder_volume(radius, height)
+    return circle_area(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/gravitational_fields.rb

@@ -0,0 +1,71 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing gravitational fields formulas
+# @author: Elisha Lai
+# @version: 0.3.1 01/06/2015
+#==============================================================================
+
+# Gravitational fields module (gravitational_fields.rb)
+
+module Joules
+  module_function
+
+  # Calculates the gravitational force given object mass 1, object mass 2, and distance between the centres of the two objects.
+  # @param object_mass1 [Int, Float]
+  #   object_mass1 >= 0; object_mass1 is in kilograms
+  # @param object_mass2 [Int, Float]
+  #   object_mass2 >= 0; object_mass2 is in kilograms
+  # @param distance [Int, Float]
+  #   distance > 0; distance is in meters
+  # @return [Float]
+  #   return value >= 0; return value is in newtons
+  # @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)
+  end
+
+  # Calculates the gravitational field strength given force and mass.
+  # @param force [Int, Float]
+  #   force is in newtons
+  # @param mass [Int, Float]
+  #   mass > 0; mass is in kilograms
+  # @return [Float]
+  #   return value is in meters per second squared
+  # @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
+  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
+  # @return [Float]
+  #   return value >= 0; return value is in meters per second squared
+  # @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)
+  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
+  # @return [Float]
+  #   return value <= 0; return value is in joules per kilogram
+  # @example
+  #   Joules.gravitational_potential(6e24, 6.4e6) #=> -62531250.0
+  def gravitational_potential(mass, distance)
+  	return (-GRAVITATIONAL_CONSTANT * mass) / distance
+  end
+
+end