joules 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7a405f59eae561b636acb954b03228a898fe036
-  data.tar.gz: fbc765fa0f3a42672c49068e9db10ab840899f04
+  metadata.gz: 7a84b8c006d8d0a2350bf289f2ed38840d872fb3
+  data.tar.gz: 26f4381a896f244a451e3582a1f190a423143fb2
 SHA512:
-  metadata.gz: f3301f33a9aab8819c5e5d86c53840ae9304e723f45da88c1c0f5921543bd3168baacb80b6c6b6aa2c5d377eb956a2df3f58a1e50626a194fafa74623098ac77
-  data.tar.gz: 1bea761dbed0cffff0e120e67131dcd2d37b44f06020ef539683e70f8033fcb433df670126a01baba0ad252707baae1e3301a2f7a342939055484f20e869fd90
+  metadata.gz: e95c4f6be852c8356a034f295a5e913187df2acc6437f887d2510eccfb539f69fcf228f5234f8f9990c7095f7a41aaaed1febdf403346fbaba92239c044f02d9
+  data.tar.gz: f6de041a305570a7e25f5544c6f61ea13afdf05cea7bf018eb8c984d80b395479159a583571cc382f4cb5e32686f2bbd55b8bc8e63b6c5d5dc0c22396530c515

data/LICENSE.md

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Elisha Lai
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -15,7 +15,7 @@ gem build joules.gemspec
 
 ### Library Installation
 ```Bash
-gem install joules-0.3.0.gem
+gem install joules-0.3.1.gem
 ```
 
 ### Library Import
@@ -60,6 +60,9 @@ This would return 23.4.
 * Added Physics formulas in quantum
 * Added more geometric and conversion formulas commonly used in Physics
 
+#### Version 0.3.1
+* Added Physics formulas in gravitational fields and electric fields 
+
 ### Contribution
 Please feel free to submit any ideas, questions, or problems by reporting an issue. 
 

data/lib/joules/constants.rb

@@ -3,71 +3,75 @@
 #
 # @description: Module for providing constants
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Constants module (constants.rb)
 
-# Speed of light in free space.
-# @note This quantity is in meters per second.
-SPEED_OF_LIGHT = 3.00e8
+module Joules
+  
+  # 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.
-FREE_SPACE_PERMEABILITY = 4 * Math::PI * 1e-7
+  # 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.
-FREE_SPACE_PERMITTIVITY = 8.85e-12
+  # 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 = 1.6e-19
+  # Elementary charge.
+  # @note This quantity is in coulombs.
+  ELEMENTARY_CHARGE = 1.6e-19
 
-# Planck constant.
-# @note This quantity is in joule seconds.
-PLANCK_CONSTANT = 6.63e-34
+  # 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 = 1.66e-27
+  # 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.
-ELECTRON_MASS = 9.11e-31
+  # 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.
-PROTON_MASS = 1.67e-27
+  # Rest mass of proton.
+  # @note This quantity is in kilograms.
+  PROTON_MASS = 1.67e-27
 
-# Rest mass of neutron.
-# @note This quantity is in kilograms.
-NEUTRON_MASS = 1.67e-27
+  # 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
+  # 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 = 6.02e23
+  # 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 = 1.38e-23
+  # Boltzmann constant.
+  # @note This quantity is in joules per kelvin.
+  BOLTZMANN_CONSTANT = 1.38e-23
 
-# Stefan constant.
-# @note This quantity is in watts per meter squared kelvin to the fourth power.
-STEFAN_CONSTANT = 5.67e-8
+  # 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
+  # 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
+  # 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.
-FREE_FALL_ACCELERATION = 9.81
+  # Acceleration of free fall.
+  # @note This quantity is in meters per second squared.
+  FREE_FALL_ACCELERATION = 9.81
+
+end

data/lib/joules/conversion.rb

@@ -3,73 +3,78 @@
 #
 # @description: Module for providing conversion formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/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
+module Joules
+  module_function
 
-# 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 angle in degrees given radians.
+  # @param angle [Int, Float]
+  #   angle is in radians
+  # @return [Float]
+  #   return value is in degrees
+  # @example
+  #   Joules.to_degrees(Math::PI/6) #=> 29.999999999999996
+  def to_degrees(angle)
+    return (angle * 180) / Math::PI
+  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 angle in radians given degrees.
+  # @param angle [Int, Float]
+  #   angle is in degrees
+  # @return [Float]
+  #   return value is in radians
+  # @example
+  #   Joules.to_radians(30) #=> 0.5235987755982988
+  def to_radians(angle)
+    return (angle * Math::PI) / 180
+  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 temperature in kelvins given celcius.
+  # @param temperature [Int, Float]
+  #   temperature is in celcius
+  # @return [Float]
+  #   return value is in kelvins
+  # @example
+  #   Joules.to_kelvins(20) #=> 293.15
+  def to_kelvins(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 temperature in celcius given kelvins.
+  # @param temperature [Int, Float]
+  #   temperature is in kelvins
+  # @return [Float]
+  #   return value is in celcius
+  # @example
+  #   Joules.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
+  #   Joules.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
+  #   Joules.to_kilometers_per_hour(50) #=> 180.0
+  def to_kilometers_per_hour(velocity)
+    return (velocity * 3600) / 1000.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,20 +3,25 @@
 #
 # @description: Module for providing density formulas
 # @author: Elisha Lai
-# @version: 0.3.0 29/05/2015
+# @version: 0.3.1 01/06/2015
 #==============================================================================
 
 # Density module (density.rb)
 
-# 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]
-#   return value >= 0; return value is in kilograms per meter cubed
-# @example
-#   density(8.96, 0.002) #=> 4480.0   
-def density(mass, volume)
-  return mass / volume.to_f
+module Joules
+  module_function
+
+  # 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]
+  #   return value >= 0; return value is in kilograms per meter cubed
+  # @example
+  #   Joules.density(8.96, 0.002) #=> 4480.0   
+  def density(mass, volume)
+    return mass / volume.to_f
+  end
+
 end

data/lib/joules/electric_fields.rb

@@ -0,0 +1,69 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing electric fields formulas
+# @author: Elisha Lai
+# @version: 0.3.1 01/06/2015
+#==============================================================================
+
+# Electric fields module (electric_fields.rb)
+
+module Joules
+  module_function
+
+  # Calculates the electric field strength given voltage and distance between two plates.
+  # @param voltage [Int, Float]
+  #   voltage is in volts
+  # @param distance [Int, Float]
+  #   distance > 0; distance is in meters
+  # @return [Float]
+  #   return value is in newtons per coulomb/volts per metre
+  # @example
+  #   Joules.electric_field_strength_v1(9, 0.1) #=> 90.0
+  # @note There are two other method for calculating electric field strength.
+  def electric_field_strength_v1(voltage, distance)
+  	return voltage / distance.to_f
+  end
+
+  # Calculates the electric field strength for an uniform field given force and charge.
+  # @param force [Int, Float]
+  #   force is in newtons
+  # @param charge [Int, Float]
+  #   charge is in coulombs
+  # @return [Float]
+  #   return value is in newtons per coulomb/volts per metre
+  # @example
+  #   Joules.electric_field_strength_v2(50, 1.3e-6) #=> 38461538.461538464
+  # @note There are two other method for calculating electric field strength.
+  def electric_field_strength_v2(force, charge)
+    return force / charge.to_f
+  end
+
+  # Calculates the electric field strength for a radial field given charge and distance.
+  # @param charge [Int, Float]
+  #   charge is in coulombs
+  # @param distance [Int, Float]
+  #   distance > 0; distance is in meters
+  # @return [Float]
+  #   return value is in newtons per coulomb/volts per metre
+  # @example
+  #   Joules.electric_field_strength_v3(3.2e-19, 0.2) #=> 7.193443755565889e-08
+  # @note There are two other method for calculating electric field strength.
+  def electric_field_strength_v3(charge, distance)
+    return charge / (4 * Math::PI * FREE_SPACE_PERMITTIVITY * (distance ** 2))
+  end
+
+  # Calculates the electric potential given charge and distance.
+  # @param charge [Int, Float]
+  #   charge is in coulombs
+  # @param distance [Int, Float]
+  #   distance > 0; distance is in meters
+  # @return [Float]
+  #   return value is in volts
+  # @example
+  #   Joules.electric_potential(3.2e-19, 0.2) #=> 1.4386887511131779e-08
+  def electric_potential(charge, distance)
+    return charge / (4 * Math::PI * FREE_SPACE_PERMITTIVITY * distance)
+  end
+
+end