joules 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73cc9f5843a96d24a698edd34d88f242df38678a
-  data.tar.gz: 76ca90cf9af87effc2f4adbaab64e5e1145c6925
+  metadata.gz: 98b2e0c6df0fd3755eb58eaad979471c569ac1a6
+  data.tar.gz: 275a48df9e2c4dff48105fbecfa35edb20b4c442
 SHA512:
-  metadata.gz: 6ac9efd15828c56da8c5268a7cb67de5f71325fee00e971c512cbd9f5963ed245b9f1a0e0285cd6883f24b3b4e12afa0e5ffbcc718d47bf3b1fe446fe360ba53
-  data.tar.gz: 0ac87b0cb54ccdb32d99cd1a53144f43539e6a2c3fcd5c814e634bd0d3f0a2306016e8a65e60377b2e549b8a0e555133c699188b6e3b553117211b066c0207a5
+  metadata.gz: 37eb1b3cdd2c77fde36b2a2873cad5386885a2d2e5adb9410a943e784078a7e7def52dde7f661c132ff0059d67aacb03ee12b638d361666a38e17eb04f390f74
+  data.tar.gz: 6ab629ad3ea3ab4b4f87a520c2a524176dc6a37b8ff908e062572c53f3226961031ad9001ac3f1305d47e4d2d3d21ddd50e90de26c486c01df4ad53f08ba940a

data/README.md

@@ -15,7 +15,7 @@ gem build joules.gemspec
 
 ### Library Installation
 ```Bash
-gem install joules-0.3.2.gem
+gem install joules-0.4.0.gem
 ```
 
 ### Library Import
@@ -64,8 +64,10 @@ This would return 23.4.
 * Added Physics formulas in gravitational fields and electric fields
 
 #### Version 0.3.2
-* Added Physics formulas in magnetic fields
-* Added Physics formulas in stress and strain
+* Added Physics formulas in magnetic fields, stress, and strain
+
+#### Version 0.4.0
+* Added Physics formulas in circular motion
 
 ### Contribution
 Please feel free to submit any ideas, questions, or problems by reporting an issue. 

data/lib/joules.rb

@@ -3,13 +3,14 @@
 #
 # @description: Module for providing Physics formulas
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Joules module (joules.rb)
 
 require 'joules/constants'
 require 'joules/kinematics'
+require 'joules/circular_motion'
 require 'joules/mass_weight'
 require 'joules/density'
 require 'joules/forces'

data/lib/joules/circular_motion.rb

@@ -0,0 +1,160 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing circular motion formulas
+# @author: Elisha Lai
+# @version: 0.4.0 06/06/2015
+#==============================================================================
+
+# Circular motion module (circular_motion.rb)
+
+module Joules
+  module_function
+
+  # Calculates the angular velocity given linear velocity and radius.
+  # @param linear_velocity [Int, Float]
+  #   linear_velocity is in metres per second
+  # @param radius [Int, Float]
+  #   radius > 0; radius is in metres
+  # @return [Float]
+  #   return value is in radians per second
+  # @raise [ZeroDivisionError] if radius = 0
+  # @example
+  #   Joules.angular_velocity_v1(9, 3) #=> 3.0
+  # @note There is one other method for calculating angular velocity. 
+  def angular_velocity_v1(linear_velocity, radius)
+  	if radius.zero?
+      raise ZeroDivisionError.new('divided by 0')
+  	else 
+      return linear_velocity / radius.to_f
+    end
+  end
+
+  # Calculates the angular velocity given frequency of rotation.
+  # @param frequency_of_rotation [Int, Float]
+  #   frequency_of_rotation >= 0; frequency_of_rotation is in hertz
+  # @return [Float]
+  #   return value >= 0; return value is in radians per second
+  # @example
+  #   Joules.angular_velocity_v2(1.5) #=> 9.42477796076938
+  # @note There is one other method for calculating angular velocity. 
+  def angular_velocity_v2(frequency_of_rotation)
+  	return 2 * Math::PI * frequency_of_rotation
+  end
+
+  # Calculates the angular acceleration given initial angular velocity, final angular velocity, and time.
+  # @param initial_angular_velocity [Int, Float]
+  #   initial_angular_velocity is in radians per second
+  # @param final_angular_velocity [Int, Float]
+  #   final_angular_velocity is in radians per second
+  # @param time [Int, Float]
+  #   time > 0; time is in seconds
+  # @return [Float]
+  #   return value is in radians per second squared
+  # @raise [ZeroDivisionError] if time = 0
+  # @example
+  #   Joules.angular_acceleration(20, 35, 2.4) #=> 6.25
+  def angular_acceleration(initial_angular_velocity, final_angular_velocity, time)
+  	if time.zero?
+      raise ZeroDivisionError.new('divided by 0')
+  	else
+      return (final_angular_velocity - initial_angular_velocity) / time.to_f
+    end
+  end
+
+  # Calculates the centripetal acceleration given linear velocity and radius.
+  # @param linear_velocity [Int, Float]
+  #   linear_velocity is in metres per second
+  # @param radius [Int, Float]
+  #   radius > 0; radius is in metres
+  # @return [Float]
+  #   return value >= 0; return value is in metres per second squared
+  # @raise [ZeroDivisionError] if radius = 0
+  # @example
+  #   Joules.centripetal_acceleration_v1(9, 3) #=> 27.0
+  # @note There is one other method for calculating centripetal acceleration.
+  def centripetal_acceleration_v1(linear_velocity, radius)
+  	if radius.zero?
+      raise ZeroDivisionError.new('divided by 0')
+  	else 
+  	  return (linear_velocity ** 2.0) / radius
+    end
+  end
+
+  # Calculates the centripetal acceleration given angular velocity and radius.
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @param radius [Int, Float]
+  #   radius >= 0; radius is in metres
+  # @return [Float]
+  #   return value >= 0; return value is in metres per second squared
+  # @example
+  #   Joules.centripetal_acceleration_v2(3, 3) #=> 27.0
+  # @note There is one other method for calculating centripetal acceleration.
+  def centripetal_acceleration_v2(angular_velocity, radius)
+  	return (angular_velocity ** 2.0) * radius
+  end
+
+  # Calculates the centripetal force given mass, linear velocity, and radius.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param linear_velocity [Int, Float]
+  #   linear_velocity is in metres per second
+  # @param radius [Int, Float]
+  #   radius >= 0; radius is in metres
+  # @return [Float]
+  #   return value >= 0; return value is in newtons
+  # @example
+  #   Joules.centripetal_force_v1(2000, 5.56, 2.1) #=> 29441.523809523802
+  # @note There is one other method for calculating centripetal force.
+  def centripetal_force_v1(mass, linear_velocity, radius)
+  	if radius.zero?
+      raise ZeroDivisionError.new('divided by 0')
+  	else
+      return (mass * (linear_velocity ** 2.0)) / radius
+    end 
+  end
+
+  # Calculates the centripetal force given mass, angular velocity, and radius.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @param radius [Int, Float]
+  #   radius >= 0; radius is in metres
+  # @return [Float]
+  #   return value >= 0; return value is in newtons
+  # @example
+  #   Joules.centripetal_force_v2(53.5, 3, 3) #=> 1444.5
+  # @note There is one other method for calculating centripetal force.
+  def centripetal_force_v2(mass, angular_velocity, radius)
+  	return mass * (angular_velocity ** 2.0) * radius
+  end
+
+  # Calculates the angular momentum given moment of inertia and angular velocity.
+  # @param moment_of_inertia [Int, Float]
+  #   moment_of_inertia is in kilogram metres squared
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @return [Float]
+  #   return value is in kilogram metres squared per second
+  # @example
+  #   Joules.angular_momentum(2, 2.5) #=> 5.0
+  def angular_momentum(moment_of_inertia, angular_velocity)
+    return moment_of_inertia * angular_velocity.to_f
+  end
+
+  # Calculates the angular kinetic energy given moment of inertia and angular velocity.
+  # @param moment_of_inertia [Int, Float]
+  #   moment_of_inertia is in kilogram metres squared
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @return [Float]
+  #   return value is in joules
+  # @example
+  #   Joules.angular_kinetic_energy(5, 2.3) #=> 13.224999999999998
+  def angular_kinetic_energy(moment_of_inertia, angular_velocity)
+    return 0.5 * moment_of_inertia * (angular_velocity ** 2)
+  end
+
+end

data/lib/joules/constants.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Constants module (constants.rb)

data/lib/joules/conversion.rb

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

data/lib/joules/density.rb

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

data/lib/joules/electric_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing electric fields formulas
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Electric fields module (electric_fields.rb)

data/lib/joules/electricity.rb

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

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.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)
@@ -51,7 +51,7 @@ module Joules
     return 0.5 * mass * (velocity ** 2)
   end
 
-  # Calculates the work done given force and displacement.
+  # Calculates the work done given force, displacement, and angle.
   # @param force [Int, Float]
   #   force is in newtons
   # @param displacement [Int, Float]
@@ -63,7 +63,7 @@ module Joules
   # @example
   #   Joules.work_done(40, 2.34) #=> 93.6
   def work_done(force, displacement, angle = 0)
-    return force * displacement.to_f * Math.cos(to_radians(angle))
+    return force * displacement * Math.cos(to_radians(angle))
   end
 
   # Calculates the power given work done and time.
@@ -85,18 +85,20 @@ module Joules
     end
   end
 
-  # Calculates the power given force and velocity.
+  # Calculates the power given force, velocity, and angle.
   # @param force [Int, Float]
   #   force is in newtons
   # @param velocity [Int, Float]
   #   velocity is in meters per second
+  # @param angle [Int, Float]
+  #   angle is in degrees
   # @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
+  def power_v2(force, velocity, angle = 0)
+    return force * velocity * Math.cos(to_radians(angle))
   end
 
   # Calculates the energy efficiency given useful energy output and energy input.

data/lib/joules/forces.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Forces module (forces.rb)
@@ -62,17 +62,32 @@ module Joules
     end
   end
 
-  # Calculates the moment given force and distance.
+  # Calculates the maximum friction force given coefficient of friction and normal force.
+  # @param coefficient_of_friction [Int, Float]
+  #   coefficient_of_friction >= 0
+  # @param normal_force [Int, Force]
+  #   normal_force is in newtons
+  # @return [Float]
+  #   return value is in newtons
+  # @example
+  #   Joules.maximum_friction_force(0.4, 29.43) #=> 11.772
+  def maximum_friction_force(coefficient_of_friction, normal_force)
+    return coefficient_of_friction * normal_force.to_f
+  end
+
+  # Calculates the moment given force, distance, and angle.
   # @param force [Int, Float]
   #   force is in newtons
   # @param distance [Int, Float]
   #   distance >= 0; distance is in metres
+  # @param angle [Int, Float]
+  #   angle is in degrees
   # @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
+  def moment(force, distance, angle = 90)
+    return force * distance * Math.sin(to_radians(angle))
   end
 
 end

data/lib/joules/geometry.rb

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

data/lib/joules/gravitational_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing gravitational fields formulas
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Gravitational fields module (gravitational_fields.rb)

data/lib/joules/kinematics.rb

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

data/lib/joules/magnetic_fields.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing magnetic fields formulas
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Magnetic fields module (magnetic_fields.rb)
@@ -11,7 +11,7 @@
 module Joules
   module_function
 
-  # Calculates the magnetic force on a current given flux density, current, and conductor length.
+  # Calculates the magnetic force on a current given flux density, current, conductor length, and angle.
   # @param flux_density [Int, Float]
   #   flux_density is in teslas
   # @param current [Int, Float]
@@ -29,7 +29,7 @@ module Joules
     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.
+  # Calculates the magnetic force on a moving charge given flux density, charge, velocity, and angle.
   # @param flux_density [Int, Float]
   #   flux_density is in teslas
   # @param charge [Int, Float]
@@ -47,7 +47,7 @@ module Joules
     return flux_density * charge * velocity * Math.sin(to_radians(angle))
   end
 
-  # Calculates the magnetic flux given flux density and area.
+  # Calculates the magnetic flux given flux density, area, and angle.
   # @param flux_density [Int, Float]
   #   flux_density is in teslas
   # @param area [Int, Float]

data/lib/joules/mass_weight.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing mass and weight formulas
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/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.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Momentum and impulse module (momentum_impulse.rb)

data/lib/joules/pressure.rb

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

data/lib/joules/quantum.rb

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

data/lib/joules/stress_strain.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing stress and strain formulas
 # @author: Elisha Lai
-# @version: 0.3.2 03/06/2015
+# @version: 0.4.0 06/06/2015
 #==============================================================================
 
 # Stress and strain module (stress_strain.rb)

data/lib/joules/thermodynamics.rb

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

data/lib/joules/waves.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-03 00:00:00.000000000 Z
+date: 2015-06-06 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
@@ -21,6 +21,7 @@ files:
 - LICENSE.md
 - README.md
 - lib/joules.rb
+- lib/joules/circular_motion.rb
 - lib/joules/constants.rb
 - lib/joules/conversion.rb
 - lib/joules/density.rb