joules 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7adc9f03a5ed56c45511fb95a55cd7501f4d7f31
-  data.tar.gz: 39a51410782c1e97170195ebaa9ff34f01e8246d
+  metadata.gz: 309af22d22628f2fecec4180108382f0edc324a9
+  data.tar.gz: 0729618e8e982c76cdecb3b9f30939c1e422e788
 SHA512:
-  metadata.gz: e7af5c6449cd3fefb2727aeb2f08bc3756f6348e3d395e63407581128b026ce6f8c385f83e108b95ec661657d08b833ae7c140a41339a2ca621a99a2f48a324a
-  data.tar.gz: 15dd96b54231c1bf7a9eecc213766eab174839e3766a22b4abc42f35b205a6e67d86ce3971a38d97cf897a40e877674ad5231ed2cbfe0bba1745da39735a9545
+  metadata.gz: 93f6ca64737cfe6099ebf0fd9f8593591187f14b3e0ced850c2e152fab903044e66a587aa3a20a96a34cf43242ff4371272de7a595d6996b1d9b8c43a36f9d44
+  data.tar.gz: bb671926e1b41cb3e8d8e7678152b7fcc8ee9673f6a458c4af7ac1e8c97117368b79f224e0e4f99be662481039254ecfb442625d32f263e6262b45e95c4a756f

data/lib/joules/constants.rb

@@ -3,59 +3,71 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Constants module (constants.rb)
 
-# Speed of light in free space
-# Note: This quantity is in meters per second.
+# Speed of light in free space.
+# @note This quantity is in meters per second.
 SPEED_OF_LIGHT = 3.00e8
 
-# Permeability of free space
-# Note: This quantity is in henries per meter.
+# Permeability of free space.
+# @note This quantity is in henries per meter.
 FREE_SPACE_PERMEABILITY = 4 * Math::PI * 1e-7
 
-# Permittivity of free space
-# Note: This quantity is in farads per meter.
+# Permittivity of free space.
+# @note This quantity is in farads per meter.
 FREE_SPACE_PERMITTIVITY = 8.85e-12
 
-# Elementary charge
-# Note: This quantity is in coulombs.
+# Elementary charge.
+# @note This quantity is in coulombs.
 ELEMENTARY_CHARGE = 1.6e-19
 
-# Planck constant
-# Note: This quantity is in joule seconds.
+# Planck constant.
+# @note This quantity is in joule seconds.
 PLANCK_CONSTANT = 6.63e-34
 
-# Unified atomic mass unit
-# Note: This quantiy is in kilograms.
+# Unified atomic mass unit.
+# @note This quantiy is in kilograms.
 UNIFIED_ATOMIC_MASS_UNIT = 1.66e-27
 
-# Rest mass of electron
-# Note: This quantity is in kilograms.
+# Rest mass of electron.
+# @note This quantity is in kilograms.
 ELECTRON_MASS = 9.11e-31
 
-# Rest mass of proton
-# Note: This quantity is in kilograms.
+# Rest mass of proton.
+# @note This quantity is in kilograms.
 PROTON_MASS = 1.67e-27
 
-# Molar gas constant
-# Note: This quantity is in joules per kelvin mole.
+# Rest mass of neutron.
+# @note This quantity is in kilograms.
+NEUTRON_MASS = 1.67e-27
+
+# Molar gas constant.
+# @note This quantity is in joules per kelvin mole.
 MOLAR_GAS_CONSTANT = 8.31
 
-# Avogadro constant
-# Note: This quantity is in per mole. 
+# Avogadro constant.
+# @note This quantity is in per mole. 
 AVOGADRO_CONSTANT = 6.02e23
 
-# Boltzmann constant
-# Note: This quantity is in joules per kelvin.
+# Boltzmann constant.
+# @note This quantity is in joules per kelvin.
 BOLTZMANN_CONSTANT = 1.38e-23
 
-# Gravitational constant
-# Note: This quantity is in newton metres squared per kilogram squared.
+# Stefan constant.
+# @note This quantity is in watts per meter squared kelvin to the fourth power.
+STEFAN_CONSTANT = 5.67e-8
+
+# Wien constant.
+# @note This quantity is in meter kelvins.
+WIEN_CONSTANT = 2.9e-3
+
+# Gravitational constant.
+# @note This quantity is in newton metres squared per kilogram squared.
 GRAVITATIONAL_CONSTANT = 6.67e-11
 
-# Acceleration of free fall
-# Note: This quantity is in meters per second squared.
+# Acceleration of free fall.
+# @note This quantity is in meters per second squared.
 FREE_FALL_ACCELERATION = 9.81

data/lib/joules/density.rb

@@ -3,22 +3,20 @@
 #
 # @description: Module for providing density formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Density module (density.rb)
 
-# density: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: mass >= 0
-#          mass is in kilograms.
-#          volume > 0
-#          volume is in meters cubed.
-#     POST: Returns a Float.
-#           returned value >= 0 
-#           returned value is in kilograms per meter cubed.
-# Purpose: Consumes two numbers, mass and volume. Returns the
-# calculated density.
+# Calculates the density given mass and volume.
+# @param mass [Int, Float]
+#   mass >= 0; mass is in kilograms
+# @param volume [Int, Float]
+#   volume > 0; volume is in meters cubed
+# @return [Float]
+#   returned value >= 0; returned value is in kilograms per meter cubed
+# @example
+#   density(8.96, 0.002) #=> 4480.0   
 def density(mass, volume)
   return mass / volume.to_f
 end

data/lib/joules/energy_work_power.rb

@@ -3,106 +3,100 @@
 #
 # @description: Module for providing energy, work, and power formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)
 
 require_relative 'constants'
 
-# gravitational_potential_energy: (union Int Float) (union Int Float)
-# -> Float
-# Conditions:
-#     PRE: mass >= 0
-#          mass is in kilograms.
-#          height >= 0
-#          height is in meters.
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in joules.
-# Purpose: Consumes two numbers, mass and height. Returns the calculated
-# gravitational potential energy.
+# 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]
+#   returned value >= 0; returned 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
 
-# elastic_potential_energy: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: spring_constant >= 0
-#          spring constant is in newtons per meter.
-#          extension >= 0
-#          extension is in meters.
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in joules.
-# Purpose: Consumes two numbers, spring_constant and extension. Returns
-# the calculated elastic potential energy.
+# 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]
+#   returned 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
 
-# kinetic_energy: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: mass >= 0
-#          mass is in kilograms.
-#          velocity is in meters per second.
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in joules.
-# Purpose: Consumes two numbers, mass and velocity. Returns the calculated
-# kinetic energy.
+# 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]
+#   returned value >= 0; returned value is in joules
+# @example
+#   kinetic_energy(500, 22) #=> 121000.0 
 def kinetic_energy(mass, velocity)
   return 0.5 * mass * (velocity ** 2)
 end
 
-# work_done: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: force is in newtons.
-#          distance >= 0
-#          distance is in meters.
-#     POST: Returns a Float.
-#           returned value is in joules.
-# Purpose: Consumes two numbers, force and distance. Returns the
-# calculated work done.
+# Calculates the work done given force and distance.
+# @param force [Int, Float]
+#   force is in newtons
+# @param distance [Int, Float]
+#   distance >= 0; distance is in meters
+# @return [Float]
+#   returned value is in joules
+# @example
+#   work_done(40, 2.34) #=> 93.6
 def work_done(force, distance)
   return force * distance.to_f
 end
 
-# power: (union Int Float) (union Int Float) -> Float
-# Condition:
-#     PRE: work_done is in joules.
-#          time > 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in watts.
-# Purpose: Consumes two numbers, work done and time. Returns the
-# calculated power.
+# 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]
+#   returned value is in watts
+# @example
+#   power(28, 7) #=> 4.0
 def power(work_done, time)
   return work_done / time.to_f
 end
 
-# energy_efficiency: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: energy_input > 0
-#          0 <= useful_energy_output <= energy_input
-#          useful_energy_output and energy_input are in joules.
-#     POST: Returns a Float.
-#           returned value >= 0
-# Purpose: Consumes two numbers, useful_energy_output and energy_input.
-# Returns the calculated energy efficiency.
+# 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]
+#   returned 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
 
-# power_efficiency: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: power_input > 0
-#          0 <= useful_power_output <= power_input
-#          useful_power_output and power_input are in joules.
-#     POST: Returns a Float.
-#           returned value >= 0
-# Purpose: Consumes two numbers, useful_power_output and power_input.
-# Returns the calculated power efficiency.
+# 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]
+#   returned 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,63 +3,66 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Forces module (forces.rb)
 
-# force_v1: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: mass >= 0
-#          mass is in kilograms.
-#          acceleration is in meters per second squared.
-#     POST: Returns a Float.
-#           returned value is in newtons.
-# Purpose: Consumes two numbers, mass and acceleration. Returns the
-# calculated force.
+# 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]
+#   returned 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
 
-# force_v2: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: spring_constant >= 0
-#          spring constant is in newtons per meter.
-#          extension >= 0
-#          extension is in meters. 
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in newtons.
-# Purpose: Consumes two numbers, spring_constant and extension. Returns the
-# calculated force.
+# 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]
+#   returned value >= 0; returned 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
 
-# force_v3: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: initial_velocity and final_velocity are in meters per second.
-#          mass >= 0
-#          mass is in kilograms.
-#          time > 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in newtons.
-# Purpose: Consumes four numbers, initial_velocity, final_velocity, mass,
-# and time. Returns the calculated force.
+# 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]
+#   returned 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
 
-# moment: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: force is in newtons.
-#          distance >= 0
-#          distance is in meters.
-#     POST: Returns a Float.
-#           returned value is in newton metres.
-# Purpose: Consumes two numbers, force and distance. Returns the
-# calculated moment.
+# 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]
+#   returned 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/kinematics.rb

@@ -3,122 +3,128 @@
 #
 # @description: Module for providing kinematics formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Kinematics module (kinematics.rb)
 
-# avg_speed: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: distance >= 0
-#          distance is in meters.
-#          time > 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in meters per second.
-# Purpose: Consumes two numbers, distance and time. Returns the
-# calculated average speed.
+# Calculates the average speed given distance and time.
+# @param distance [Int, Float]
+#   distance >= 0; distance is in meters
+# @param time [Int, Float]
+#   time > 0; time is in seconds
+# @return [Float]
+#   returned value >= 0; returned value is in meters per second
+# @example
+#   avg_speed(30, 2.4) #=> 12.5
 def avg_speed(distance, time)
   return distance / time.to_f 
 end
 
-# avg_velocity: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: displacement is in meters.
-#          time > 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in meters per second.
-# Purpose: Consumes two numbers, displacement and time. Returns the
-# calculated average velocity.
+# Calculates the average velocity given displacement and time.
+# @param displacement [Int, Float]
+#   displacement is in meters
+# @param time [Int, Float]
+#   time > 0; time is in seconds
+# @return [Float]
+#   returned value is in meters per second
+# @example
+#   avg_velocity(180, 4.8) #=> 37.5 
 def avg_velocity(displacement, time)
   return displacement / time.to_f
 end
 
-# acceleration: (union Int Float) (union Int Float) (union Int Float)
-# -> Float
-# Conditions:
-#     PRE: initial_velocity and final_velocity are in meters per second.
-#          time > 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in meters per second squared.
-# Purpose: Consumes three numbers: initial_velocity, final_velocity,
-# and time. Returns the calculated acceleration.
+# Calculates the acceleration given initial velocity, final velocity, 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 time [Int, Float]
+#   time > 0; time is in seconds
+# @return [Float]
+#   returned value is in meters per second squared
+# @example
+#   acceleration(20, 35, 2.4) #=> 6.25
 def acceleration(initial_velocity, final_velocity, time)
   return (final_velocity - initial_velocity) / time.to_f
 end
 
-# final_velocity_v1: (union Int Float) (union Int Float) (union Int Float)
-# -> Float
-# Conditions: 
-#     PRE: initial_velocity is in meters per second.
-#          acceleration is in meters per second squared.
-#          time >= 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in meters per second.
-# Purpose: Consumes three numbers: initial_velocity, acceleration, and
-# time. Returns the calculated final velocity.
+# Calculates the final velocity given initial velocity, acceleration, and time.
+# @param initial_velocity [Int, Float]
+#   initial_velocity is in meters per second
+# @param acceleration [Int, Float]
+#   acceleration is in meters per second squared
+# @param time [Int, Float]
+#   time >= 0; time is in seconds
+# @return [Float]
+#   returned 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.
 def final_velocity_v1(initial_velocity, acceleration, time)
   return initial_velocity + (acceleration * time.to_f)
 end
 
-# final_velocity_v2: (union Int Float) (union Int Float) (union Int Float)
-# -> Float
-# Conditions:
-#     PRE: initial_velocity is in meters per second.
-#          acceleration is in meters per second squared.
-#          displacement is in meters.
-#     POST: Returns a Float.
-#           returned value is in meters per second.
-# Purpose: Consumes three numbers: initial_velocity, acceleration, and
-# displacement. Returns the calculated final velocity.
+# Calculates the final velocity given initial velocity, acceleration, and displacement.
+# @param initial_velocity [Int, Float]
+#   initial_velocity is in meters per second
+# @param acceleration [Int, Float]
+#   acceleration is in meters per second squared
+# @param displacement [Int, Float]
+#   displacement is in meters
+# @return [Float]
+#   returned 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.
 def final_velocity_v2(initial_velocity, acceleration, displacement)
   return ((initial_velocity ** 2) + (2 * acceleration * displacement)) ** 0.5
 end
 
-# displacement_v1: (union Int Float) (union Int Float) (union Int Float)
-# -> Float
-# Conditions:
-#     PRE: initial_velocity and final_velocity are in meters per second.
-#          time >= 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in meters.
-# Purpose: Consumes three numbers: initial_velocity, final_velocity, and
-# time. Returns the calculated displacement.
+# Calculates the displacement given initial velocity, final velocity, 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 time [Int, Float]
+#   time >= 0; time is in seconds
+# @return [Float]
+#   returned value is in meters
+# @example
+#   displacement_v1(20, 35, 2.4) #=> 66.0
+# @note There are two other methods for calculating displacement.
 def displacement_v1(initial_velocity, final_velocity, time)
   return 0.5 * (initial_velocity + final_velocity) * time
 end
 
-# displacement_v2: (union Int Float) (union Int Float) (union Int Float)
-# -> Float
-# Conditions:
-#     PRE: initial_velocity is in meters per second.
-#          acceleration is in meters per second squared.
-#          time >= 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in meters.
-# Purpose: Consumes three numbers: initial_velocity, acceleration, and
-# time. Returns the calculated displacement.
+# Calculates the displacement given initial velocity, acceleration, and time.
+# @param initial_velocity [Int, Float]
+#   initial_velocity is in meters per second
+# @param acceleration [Int, Float]
+#   acceleration is in meters per second squared
+# @param time [Int, Float]
+#   time >= 0; time is in seconds
+# @return [Float]
+#   returned value is in meters
+# @example
+#   displacement_v2(20, 6.25, 2.4) #=> 66.0
+# @note There are two other methods for calculating displacement.
 def displacement_v2(initial_velocity, acceleration, time)
   return (initial_velocity * time) + (0.5 * acceleration * (time ** 2))
 end
 
-# displacement_v3: (union Int Float) (union Int Float) (union Int Float)
-# -> Float
-# Conditions:
-#     PRE: final_velocity is in meters per second.
-#          acceleration is in meters per second squared.
-#          time >= 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in meters.
-# Purpose: Consumes three numbers: final_velocity, acceleration, and
-# time. Returns the calculated displacement.
+# Calculates the displacement given final velocity, acceleration, and time.
+# @param final_velocity [Int, Float]
+#   final_velocity is in meters per second
+# @param acceleration [Int, Float]
+#   acceleration is in meters per second squared
+# @param time [Int, Float]
+#   time >= 0; time is in seconds
+# @return [Float]
+#   returned value is in meters
+# @example
+#   displacement_v3(35, 6.25, 2.4) #=> 66.0
+# @note There are two other methods for calculating displacement.
 def displacement_v3(final_velocity, acceleration, time)
   return (final_velocity * time) - (0.5 * acceleration * (time ** 2))
 end

data/lib/joules/mass_weight.rb

@@ -3,33 +3,31 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Mass and weight module (mass_weight.rb)
 
 require_relative 'constants'
 
-# weight: (union Int Float) -> Float
-# Conditions:
-#     PRE: mass >= 0
-#          mass is in kilograms.
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in newtons.
-# Purpose: Consumes a number, mass, and returns the calculated weight.
+# Calculates the weight given mass.
+# @param mass [Int, Float]
+#   mass >= 0; mass is in kilograms
+# @return [Float]
+#   returned value >= 0; returned value is in newtons
+# @example
+#   weight(79.41) #=> 779.0121
 def weight(mass)
   return mass * FREE_FALL_ACCELERATION 
 end
 
-# mass: (union Int Float) -> Float
-# Conditions:
-#     PRE: weight >= 0
-#          weight is in newtons. 
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in kilograms.
-# Purpose: Consumes a numberm weight, and returns the calculated mass.
+# Calculates the mass given weight.
+# @param weight [Int, Float]
+#   weight >= 0; weight is in newtons
+# @return [Float]
+#   returned value >= 0; returned value is in kilograms
+# @example
+#   mass(779.0121) #=> 79.41
 def mass(weight)
   return weight / FREE_FALL_ACCELERATION
 end

data/lib/joules/momentum_impulse.rb

@@ -3,47 +3,50 @@
 #
 # @description: Module for providing momentum and impulse formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)
 
-# momentum: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: mass >= 0
-#          mass is in kilograms.
-#          velocity is in meters per second.
-#     POST: Returns a Float.
-#           returned value is in newton seconds.
-# Purpose: Consumes two numbers, mass and velocity. Returns the calculated
-# momentum.
+# Calculates the momentum 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]
+#   returned value is in newton seconds
+# @example
+#   momentum(52, 4.7) #=> 244.4
 def momentum(mass, velocity)
   return mass * velocity.to_f
 end
 
-# impulse_v1: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: force is in newtons.
-#          time >= 0
-#          time is in seconds.
-#     POST: Returns a Float.
-#           returned value is in newton seconds.
-# Purpose: Consumes two numbers, force and time. Returns the calculated
-# impulse.
+# Calculates the impulse given force and time.
+# @param force [Int, Float]
+#   force is in newtons
+# @param time [Int, Float]
+#   time >= 0; time is in seconds
+# @return [Float]
+#   returned value is in newton seconds
+# @example
+#   impulse_v1(30.8, 9.6) #=> 295.68
+# @note There is one other method for calculating impulse.
 def impulse_v1(force, time)
   return force * time.to_f
 end
 
-# impulse_v2: (union Int Float) (union Int Float) (union Int Float)
-# -> Float
-# Condition:
-#     PRE: initial_velocity and final_velocity are in meters per second.
-#          mass >= 0
-#          mass is in kilograms.
-#     POST: Returns a Float.
-#           returned value is in newton seconds.
-# Purpose: Consumes three numbers, initial_velocity, final_velocity, and
-# mass. Returns the calculated impulse.
+# Calculates the impulse given initial velocity, final velocity, and mass.
+# @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
+# @return [Float]
+#   returned value is in newton seconds
+# @example
+#   impulse_v2(20, 35, 2.4) #=> 36.0
+# @note There is one other method for calculating impulse.
 def impulse_v2(initial_velocity, final_velocity, mass)
   return (final_velocity - initial_velocity) * mass.to_f
 end

data/lib/joules/pressure.rb

@@ -3,39 +3,35 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Pressure module (pressure.rb)
 
 require_relative 'constants'
 
-# pressure: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: force >= 0
-#          force is in newtons.
-#          area > 0
-#          area is in meters cubed.
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in pascals.
-# Purpose: Consumes two numbers, force and area. Returns the calculated
-# pressure.
+# Calculates the pressure given force and area.
+# @param force [Int, Float]
+#   force >= 0; force is in newtons
+# @param area [Int, Float]
+#   area > 0; area is in meters cubed
+# @return [Float]
+#   returned value >= 0; returned value is in pascals
+# @example
+#   pressure(98, 0.04) #=> 2450.0 
 def pressure(force, area)
   return force / area.to_f
 end
 
-# hydrostatic_pressure: (union Int Float) (union Int Float) -> Float
-# Conditions:
-#     PRE: density >= 0
-#          density is in kilograms per meter cubed.
-#          height >= 0
-#          height is in meters.
-#     POST: Returns a Float.
-#           returned value >= 0
-#           returned value is in pascals.
-# Purpose: Consumes two numbers, density and height. Returns the calculated
-# hydrostatic pressure.
+# Calculates the hydrostatic pressure given density and height.
+# @param density [Int, Float]
+#   density >= 0; density is in kilograms per meter cubed
+# @param height [Int, Float]
+#   height >= 0; height is in meters
+# @return [Float]
+#   returned value >= 0; returned value is in pascals
+# @example
+#   hydrostatic_pressure(1000, 5) #=> 49050.0
 def hydrostatic_pressure(density, height)
   return density * FREE_FALL_ACCELERATION * height
 end

data/lib/joules/thermodynamics.rb

@@ -0,0 +1,39 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing thermodynamics formulas
+# @author: Elisha Lai
+# @version: 0.1.0 23/05/2015
+#==============================================================================
+
+# Thermodynamics module (thermodynamics.rb)
+
+# Calculates the energy given mass, specific heat capacity, and temperature change.
+# @param mass [Int, Float]
+#   mass >= 0; mass is in kilograms
+# @param specific_heat_capacity [Int, Float]
+#   specific_heat_capacity >= 0; specific_heat_capacity is in joules per kilogram celcius
+# @param temperature_change [Int, Float]
+#   temperature_change is in celcius
+# @return [Float]
+#   returned value is in joules
+# @example
+#   energy_v1(500, 2.46, 3.6) #=> 4428.0
+# @note There is one other method for calculating energy.
+def energy_v1(mass, specific_heat_capacity, temperature_change)
+  return mass * specific_heat_capacity * temperature_change.to_f
+end
+
+# Calculates the energy given mass and specific latent heat.
+# @param mass [Int, Float]
+#   mass >= 0; mass is in kilograms
+# @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
+# @example
+#   energy_v2(84.3, 72.1) #=> 6078.03
+# @note There is one other method for calculating energy.
+def energy_v2(mass, specific_latent_heat)
+  return mass * specific_latent_heat.to_f
+end

data/lib/joules/waves.rb

@@ -0,0 +1,72 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing waves formulas
+# @author: Elisha Lai
+# @version: 0.1.0 23/05/2015
+#==============================================================================
+
+# Waves module (waves.rb)
+
+# 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
+# @example
+#    wave_speed(3250, 0.1) #=> 325.0
+def wave_speed(frequency, wavelength)
+  return frequency * wavelength.to_f
+end
+
+# Calculates the wavelength given wave speed and frequency.
+# @param wave_speed [Int, Float]
+#   wave_speed >= 0; wave_speed is in meters per second
+# @param frequency [Int, Float]
+#   frequency > 0; frequency is in hertz
+# @return [Float]
+#   returned value is in meters
+# @example
+#   wavelength(325, 3250) #=> 0.1
+def wavelength(wave_speed, frequency)
+  return wave_speed / frequency.to_f
+end
+
+# Calculates the frequency given wave speed and wavelength.
+# @param wave_speed [Int, Float]
+#   wave_speed >= 0; wave_speed is in meters per second
+# @param wavelength [Int, Float]
+#   wavelength > 0; wavelength is in meters
+# @return [Float]
+#   returned value is in hertz
+# @example
+#   frequency_v1(325, 0.1) #=> 3250.0
+# @note There is one other method for calculating frequency.
+def frequency_v1(wave_speed, wavelength)
+  return wave_speed / wavelength.to_f
+end
+
+# Calculates the frequency given time period.
+# @param time_period [Int, Float]
+#   time_period > 0; time_period is in seconds
+# @return [Float]
+#   returned value > 0; returned value is in hertz
+# @example
+#   frequency_v2(12.5) #=> 0.08
+# @note There is one other method for calculating frequency.
+def frequency_v2(time_period)
+  return 1.0 / time_period
+end
+
+# Calculates the time period given frequency.
+# @param frequency [Int, Float]
+#   frequency > 0; frequency is in hertz
+# @return [Float]
+#   returned value > 0; returned value is in hertz
+# @example
+#   time_period(0.08) #=> 12.5
+def time_period(frequency)
+  return 1.0 / frequency
+end

data/lib/joules.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing Physics formulas
 # @author: Elisha Lai
-# @version: 0.0.3 16/05/2015
+# @version: 0.1.0 23/05/2015
 #==============================================================================
 
 # Joules module (joules.rb)
@@ -16,3 +16,5 @@ require 'joules/forces'
 require 'joules/momentum_impulse'
 require 'joules/energy_work_power'
 require 'joules/pressure'
+require 'joules/thermodynamics'
+require 'joules/waves'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-22 00:00:00.000000000 Z
+date: 2015-05-23 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
@@ -27,6 +27,8 @@ files:
 - lib/joules/mass_weight.rb
 - lib/joules/momentum_impulse.rb
 - lib/joules/pressure.rb
+- lib/joules/thermodynamics.rb
+- lib/joules/waves.rb
 homepage: http://elailai94.github.io/Joules
 licenses:
 - MIT