joules 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c20098c6f822a1b455a45e4a0a569545939be0c0
+  data.tar.gz: 13cf60542b4b7dd226b6d4da3ea265982734ef8d
+SHA512:
+  metadata.gz: b74fffa6a1b01114f96bf41f3c62855ca461007cfd63fe824f38eb53d5294c9e6d9090c1e81d344cc43e75aa5f8b7d073992969bf2067e266dfcdd62ba824e75
+  data.tar.gz: cec724aa534074607f287b5cfb606d35a4d1d10e658515c880d78631e8dd080ad681d0f727970e87187cc9a47ad68b93081af7647ccedfe740cb6c283142a708

data/lib/joules/constants.rb

@@ -0,0 +1,17 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing constants
+# @author: Elisha Lai
+# @version: 0.0.2 16/05/2015
+#==============================================================================
+
+# Constants module (constants.rb)
+
+# Speed of light in free space
+# Note: This quantity is in meters per second.
+SPEED_OF_LIGHT = 3.00e8
+
+# Acceleration of free fall
+# Note: This quantity is in meters per second squared.
+FREE_FALL_ACCELERATION = 9.81

data/lib/joules/density.rb

@@ -0,0 +1,24 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing density formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/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.
+def density(mass, volume)
+  return mass / volume.to_f
+end

data/lib/joules/energy_work_power.rb

@@ -0,0 +1,108 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing energy, work, and power formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/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.
+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.
+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.
+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.
+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.
+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.
+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.
+def power_efficiency(useful_power_output, power_input)
+  return (useful_power_output / power_input.to_f) * 100
+end

data/lib/joules/forces.rb

@@ -0,0 +1,65 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing forces formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/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.
+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.
+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.
+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.
+def moment(force, distance)
+  return force * distance.to_f
+end

data/lib/joules/kinematics.rb

@@ -0,0 +1,124 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing kinematics formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/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.
+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.
+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.
+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.
+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.
+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.
+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.
+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.
+def displacement_v3(final_velocity, acceleration, time)
+  return (final_velocity * time) - (0.5 * acceleration * (time ** 2))
+end

data/lib/joules/mass_weight.rb

@@ -0,0 +1,35 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing mass and weight formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/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.
+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.
+def mass(weight)
+  return weight / FREE_FALL_ACCELERATION
+end

data/lib/joules/momentum_impulse.rb

@@ -0,0 +1,49 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing momentum and impulse formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/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.
+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.
+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.
+def impulse_v2(initial_velocity, final_velocity, mass)
+  return (final_velocity - initial_velocity) * mass.to_f
+end

data/lib/joules/pressure.rb

@@ -0,0 +1,41 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing pressure formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/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.
+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.
+def hydrostatic_pressure(density, height)
+  return density * FREE_FALL_ACCELERATION * height
+end

data/lib/joules.rb

@@ -0,0 +1,18 @@
+#==============================================================================
+# Joules
+#
+# @description: Module for providing Physics formulas
+# @author: Elisha Lai
+# @version: 0.0.2 16/05/2015
+#==============================================================================
+
+# Joules module (joules.rb)
+
+require 'joules/constants'
+require 'joules/kinematics'
+require 'joules/mass_weight'
+require 'joules/density'
+require 'joules/forces'
+require 'joules/momentum_impulse'
+require 'joules/energy_work_power'
+require 'joules/pressure'

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: joules
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Elisha Lai
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-16 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
+  of fundamental constants are also provided. It is \n    written entirely in Ruby.\n"
+email: elisha.lai@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/joules.rb
+- lib/joules/constants.rb
+- lib/joules/density.rb
+- lib/joules/energy_work_power.rb
+- lib/joules/forces.rb
+- lib/joules/kinematics.rb
+- lib/joules/mass_weight.rb
+- lib/joules/momentum_impulse.rb
+- lib/joules/pressure.rb
+homepage: http://elailai94.github.io/Joules
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.7
+signing_key: 
+specification_version: 4
+summary: A library (gem) for providing Physics formulas
+test_files: []