joules 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98b2e0c6df0fd3755eb58eaad979471c569ac1a6
-  data.tar.gz: 275a48df9e2c4dff48105fbecfa35edb20b4c442
+  metadata.gz: 20266cc292103a7a4ec29036bf2eb5eca74653ea
+  data.tar.gz: df55eff3e23043443756fec9ea24ed7351313115
 SHA512:
-  metadata.gz: 37eb1b3cdd2c77fde36b2a2873cad5386885a2d2e5adb9410a943e784078a7e7def52dde7f661c132ff0059d67aacb03ee12b638d361666a38e17eb04f390f74
-  data.tar.gz: 6ab629ad3ea3ab4b4f87a520c2a524176dc6a37b8ff908e062572c53f3226961031ad9001ac3f1305d47e4d2d3d21ddd50e90de26c486c01df4ad53f08ba940a
+  metadata.gz: f744ec8a76f8a7fac6c7a74295eb01e8d3f29230729b5e447ec6f72d9c0dc6f25aa39dce9eb9c476a706a195196d1ba21932e27d52f9247aea646776836628db
+  data.tar.gz: 7f49d574908f32acb1c75332ee4f1e2d5f81413f4ad215049fc6122a820cd66386fc4039400b44857f08134bda28c136cf2fe6c254504cf0e9eb51d5fe2b175e

data/README.md

@@ -15,7 +15,7 @@ gem build joules.gemspec
 
 ### Library Installation
 ```Bash
-gem install joules-0.4.0.gem
+gem install joules-0.4.1.gem
 ```
 
 ### Library Import
@@ -69,6 +69,9 @@ This would return 23.4.
 #### Version 0.4.0
 * Added Physics formulas in circular motion
 
+#### Version 0.4.1
+* Added Physics formulas in oscillations
+
 ### Contribution
 Please feel free to submit any ideas, questions, or problems by reporting an issue. 
 

data/lib/joules/circular_motion.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing circular motion formulas
 # @author: Elisha Lai
-# @version: 0.4.0 06/06/2015
+# @version: 0.4.1 07/06/2015
 #==============================================================================
 
 # Circular motion module (circular_motion.rb)

data/lib/joules/constants.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/06/2015
 #==============================================================================
 
 # Energy, work, and power module (energy_work_power.rb)

data/lib/joules/forces.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing forces formulas
 # @author: Elisha Lai
-# @version: 0.4.0 06/06/2015
+# @version: 0.4.1 07/06/2015
 #==============================================================================
 
 # Forces module (forces.rb)

data/lib/joules/geometry.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing geometry formulas
 # @author: Elisha Lai
-# @version: 0.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/06/2015
 #==============================================================================
 
 # Magnetic fields module (magnetic_fields.rb)

data/lib/joules/mass_weight.rb

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

data/lib/joules/oscillations.rb

@@ -0,0 +1,124 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing oscillations formulas
+# @author: Elisha Lai
+# @version: 0.4.1 07/06/2015
+#==============================================================================
+
+# Oscillations module (oscillations.rb)
+
+module Joules
+  module_function
+
+  # Calculates the acceleration of a particle in oscillation given angular velocity and particle displacement.
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @param particle_displacement [Int, Float]
+  #   particle_displacement is in metres
+  # @return [Float]
+  #   return value is in metres per second squared
+  # @example
+  #   Joules.particle_acceleration(2.4, 3) #=> -17.28
+  # @note There is one other method for calculating acceleration.
+  def particle_acceleration(angular_velocity, particle_displacement)
+    return (- (angular_velocity ** 2.0) * displacement)
+  end
+
+  # Calculates the displacement of a particle in oscillation given amplitude, angular velocity, and time.
+  # @param amplitude [Int, Float]
+  #   amplitude >= 0; amplitude is in metres
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @param time [Int, Float]
+  #   time >= 0; time is in seconds
+  # @return [Float]
+  #   return value is in metres
+  # @example
+  #   Joules.particle_displacement(5, 2.4, 3) #=> 3.041756572661276
+  def particle_displacement(amplitude, angular_velocity, time)
+    return amplitude * Math.cos(angular_velocity * time)
+  end
+
+  # Calculates the velocity of a particle in oscillation given angular velocity, amplitude, and particle displacement.
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @param amplitude [Int, Float]
+  #   amplitude >= 0; amplitude is in metres
+  # @param particle_displacement [Int, Float]
+  #   particle_displacement is in metres
+  # @param return_sign [String]
+  #   return_sign is either '-' or '+'
+  # @return [Float, Array<Float>]
+  #   return list has a length of 2; each velocity in return list or return value is in metres per second
+  # @example
+  #   Joules.particle_velocity(2.4, 5, 3) #=> [9.6, -9.6]
+  def particle_velocity(angular_velocity, amplitude, particle_displacement, return_sign = nil)
+    return_value = angular_velocity * (((amplitude ** 2) - (particle_displacement ** 2)) ** 0.5)
+    if return_sign == '-'
+      return (- return_value)
+    elsif return_sign == '+'
+      return return_value
+    else
+      return [return_value, (- return_value)]
+    end
+  end
+
+  # Calculates the maximum speed of a particle in oscillation given angular velocity and amplitude.
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @param amplitude [Int, Float]
+  #   amplitude >= 0; amplitude is in metres
+  # @return [Float]
+  #   return value is in metres per second
+  # @example
+  #   Joules.maximum_speed(2.4, 5) #=> 12.0
+  def max_particle_speed(angular_velocity, amplitude)
+    return angular_velocity * amplitude.to_f
+  end
+
+  # Calculates the maximum acceleration of a particle in oscillation given angular velocity and amplitude.
+  # @param angular_velocity [Int, Float]
+  #   angular_velocity is in radians per second
+  # @param amplitude [Int, Float]
+  #   amplitude >= 0; amplitude is in metres
+  # @return [Float]
+  #   return value >= 0; return value is in metres per second squared
+  # @example
+  #   Joules.maximum_acceleration(2.4, 5) #=> 28.799999999999997
+  def max_particle_acceleration(angular_velocity, amplitude)
+    return (angular_velocity ** 2.0) * amplitude
+  end
+
+  # Calculates the time period of a mass-spring system given mass and spring constant.
+  # @param mass [Int, Float]
+  #   mass >= 0; mass is in kilograms
+  # @param spring_constant [Int, Float]
+  #   spring_constant > 0; spring_constant is in newtons per metre
+  # @return [Float]
+  #   return value >= 0; return value is in seconds
+  # @raise [ZeroDivisionError] if spring_constant = 0
+  # @example
+  #   Joules.time_period_v2(20, 5) #=> 12.566370614359172
+  # @note There are two other methods for calculating time period.
+  def time_period_v2(mass, spring_constant)
+    if spring_constant.zero?
+      raise ZeroDivisionError.new('divided by 0')
+    else
+      return 2 * Math::PI * ((mass / spring_constant.to_f) ** 0.5)
+    end
+  end
+
+  # Calculates the time period of a simple pendulum given pendulum length.
+  # @param pendulum_length [Int, Float]
+  #   pendulum_length >= 0; pendulum_length is in metres
+  # @return [Float]
+  #   return value >= 0; return value is in seconds
+  # @example
+  #   Joules.time_period_v3(8.4) #=> 5.814133609631141
+  # @note There are two other methods for calculating time period.
+  def time_period_v3(pendulum_length)
+    return 2 * Math::PI * ((pendulum_length / FREE_FALL_ACCELERATION) ** 0.5)
+  end
+
+end

data/lib/joules/pressure.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing pressure formulas
 # @author: Elisha Lai
-# @version: 0.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/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.4.0 06/06/2015
+# @version: 0.4.1 07/06/2015
 #==============================================================================
 
 # Waves module (waves.rb)
@@ -82,11 +82,12 @@ module Joules
   # @param frequency [Int, Float]
   #   frequency > 0; frequency is in hertz
   # @return [Float]
-  #   return value > 0; return value is in hertz
+  #   return value > 0; return value is in seconds
   # @raise [ZeroDivisionError] if frequency = 0
   # @example
-  #   Joules.time_period(0.08) #=> 12.5
-  def time_period(frequency)
+  #   Joules.time_period_v1(0.08) #=> 12.5
+  # @note There are two other methods for calculating time period.
+  def time_period_v1(frequency)
     if frequency.zero?
       raise ZeroDivisionError.new('divided by 0')
     else

data/lib/joules.rb

@@ -3,7 +3,7 @@
 #
 # @description: Module for providing Physics formulas
 # @author: Elisha Lai
-# @version: 0.4.0 06/06/2015
+# @version: 0.4.1 07/06/2015
 #==============================================================================
 
 # Joules module (joules.rb)
@@ -20,6 +20,7 @@ require 'joules/stress_strain'
 require 'joules/pressure'
 require 'joules/thermodynamics'
 require 'joules/waves'
+require 'joules/oscillations'
 require 'joules/electricity'
 require 'joules/quantum'
 require 'joules/gravitational_fields'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joules
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Elisha Lai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-06 00:00:00.000000000 Z
+date: 2015-06-07 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
@@ -35,6 +35,7 @@ files:
 - lib/joules/magnetic_fields.rb
 - lib/joules/mass_weight.rb
 - lib/joules/momentum_impulse.rb
+- lib/joules/oscillations.rb
 - lib/joules/pressure.rb
 - lib/joules/quantum.rb
 - lib/joules/stress_strain.rb