ballistics-ng 0.1.0.1

data/lib/ballistics/gun.rb

@@ -0,0 +1,123 @@
+require 'ballistics/yaml'
+
+class Ballistics::Gun
+  class ChamberNotFound < KeyError; end
+
+  MANDATORY = {
+    "name"          => :string,
+    "chamber"       => :string,
+    "barrel_length" => :float,
+    "sight_height"  => :float,
+  }
+  OPTIONAL = {
+    "zero_range" => :float,
+  }
+
+  # map a chamber name to a built-in cartridge YAML filename
+  CHAMBER_CARTRIDGE = {
+    '5.56' => '5_56',
+    '300 BLK' => '300_blk',
+    # TODO: create these cartridge yamls
+    # '.45 ACP' => '45_acp',
+    # '12ga' => '12ga',
+  }
+
+  # Load a built-in YAML file and instantiate gun objects
+  # Return a hash of gun objects keyed by gun id (per the YAML)
+  #
+  def self.find(short_name)
+    objects = {}
+    Ballistics::YAML.load_built_in('guns', short_name).each { |id, hsh|
+      obj = self.new(hsh)
+      if block_given?
+        objects[id] = obj if yield obj
+      else
+        objects[id] = obj
+      end
+    }
+    objects
+  end
+
+  def self.find_id(id)
+    Ballistics::YAML::BUILT_IN.fetch('guns').each { |short_name|
+      object = self.find(short_name)[id]
+      return object if object
+    }
+    nil
+  end
+
+  def self.fetch_id(id)
+    self.find_id(id) or raise("id #{id} not found")
+  end
+
+  attr_reader(*MANDATORY.keys)
+  attr_reader(*OPTIONAL.keys)
+  attr_reader(:yaml_data, :extra)
+
+  def initialize(hsh)
+    @yaml_data = hsh
+    MANDATORY.each { |field, type|
+      val = hsh.fetch(field)
+      val = val.to_s if field == "chamber"
+      Ballistics::YAML.check_type!(val, type)
+      self.instance_variable_set("@#{field}", val)
+    }
+
+    OPTIONAL.each { |field, type|
+      if hsh.key?(field)
+        val = hsh[field]
+        Ballistics::YAML.check_type!(val, type)
+        self.instance_variable_set("@#{field}", val)
+      end
+    }
+
+    # Keep track of fields that we don't expect
+    @extra = {}
+    (hsh.keys - MANDATORY.keys - OPTIONAL.keys).each { |k|
+      @extra[k] = hsh[k]
+    }
+    @cartridges = []
+  end
+
+  def chamber=(new_chamber)
+    @cartridges = []
+    @chamber = new_chamber
+  end
+
+  def cartridge_file
+    CHAMBER_CARTRIDGE[@chamber] or raise(ChamberNotFound, @chamber)
+  end
+
+  # this will pull in cartridges and projectiles based on the gun chamber
+  def cartridges
+    if @cartridges.empty?
+      require 'ballistics/cartridge'
+
+      cartridge_file = CHAMBER_CARTRIDGE[@chamber] or
+        raise(ChamberNotFound, @chamber)
+      @cartridges =
+        Ballistics::Cartridge.find_with_projectiles(cartridge_file)
+    end
+    @cartridges
+  end
+
+  def params
+    params = { sight_height: @sight_height }
+    params[:zero_range] = @zero_range if @zero_range
+    params
+  end
+
+  def multiline
+    lines = ["GUN: #{name}", "==="]
+    fields = {
+      "Chamber" => @chamber,
+      "Barrel length" => @barrel_length,
+      "Sight height" => @sight_height,
+    }
+    fields["Zero Range"] = @zero_range if @zero_range
+    fields.each { |name, val|
+      lines << [name.rjust(13, ' ' ), val].join(': ')
+    }
+    lines.join("\n")
+  end
+end

data/lib/ballistics/guns/pistols.yaml

@@ -0,0 +1,6 @@
+"1911":
+  name: M1911A1
+  sight_height: 0.8
+  barrel_length: 5
+  zero_range: 25
+  chamber: .45 ACP

data/lib/ballistics/guns/rifles.yaml

@@ -0,0 +1,34 @@
+ar15_carbine:
+  name: Standard AR-15 carbine with 16 inch barrel (5.56)
+  sight_height: 2.6
+  barrel_length: 16
+  zero_range: 50
+  chamber: 5.56
+
+m4:
+  name: Standard M4 carbine with 14.5 inch barrel (5.56)
+  sight_height: 2.6
+  barrel_length: 14.5
+  zero_range: 50
+  chamber: 5.56
+
+m16:
+  name: Standard M16 rifle with 20 inch barrel (5.56)
+  sight_height: 2.6
+  barrel_length: 20
+  zero_range: 100
+  chamber: 5.56
+
+ar15_sbr:
+  name: AR-15 SBR with 10.5 inch barrel (5.56)
+  sight_height: 2.6
+  barrel_length: 10.5
+  zero_range: 50
+  chamber: 5.56
+
+ar15_300_blk:
+  name: AR-15 with 10.5 inch barrel (300 BLK)
+  sight_height: 2.6
+  barrel_length: 10.5
+  zero_range: 50
+  chamber: 300 BLK

data/lib/ballistics/guns/shotguns.yaml

@@ -0,0 +1,6 @@
+mossberg_500:
+  name: "Mossberg 500 12ga 18.5in"
+  sight_height: 1.2
+  barrel_length: 18.5
+  zero_range: 25
+  chamber: 12ga

data/lib/ballistics/problem.rb

@@ -0,0 +1,102 @@
+require 'ballistics'
+require 'ballistics/projectile'
+require 'ballistics/cartridge'
+require 'ballistics/gun'
+require 'ballistics/atmosphere'
+
+class Ballistics::Problem
+  DEFAULTS = {
+    shooting_angle: 0, # degrees; downhill 0 to -90, uphill 0 to +90
+    wind_speed:     0, # mph
+    wind_angle:    90, # degrees; 0-360 clockwise; 90 right, 270 left
+    interval:      50, # yards
+    max_range:    500, # yards
+    y_intercept:    0, # inches; -2 means POI 2 inches below POA @ zero range
+  }
+
+  def self.simple(gun_id:, cart_id:, gun_family: nil)
+    if gun_family
+      gun = Ballistics::Gun.find(gun_family).fetch(gun_id)
+    else
+      gun = Ballistics::Gun.fetch_id(gun_id)
+    end
+    cart = gun.cartridges.fetch(cart_id)
+    self.new(projectile: cart.projectile,
+             cartridge: cart,
+             gun: gun)
+  end
+
+  attr_accessor :projectile, :cartridge, :gun, :atmosphere
+
+  def initialize(projectile: nil,
+                 cartridge: nil,
+                 gun: nil,
+                 atmosphere: nil)
+    @projectile = projectile
+    @cartridge = cartridge
+    @gun = gun
+    @atmosphere = atmosphere
+  end
+
+  # Given a hash of specified options / params
+  # Return a hash of params enriched by DEFAULTS as well as any inferred
+  #   parameters from @projectile, @cartridge, @gun, and @atmosphere
+  #
+  def enrich(opts = {})
+    mine = {}
+    mine.merge!(@projectile.params) if @projectile
+    mine.merge!(@gun.params) if @gun
+    mine[:velocity] = @cartridge.mv(@gun.barrel_length) if @cartridge and @gun
+
+    # Set up the return hash
+    # opts overrides mine overrides DEFAULT
+    ret = DEFAULTS.merge(mine.merge(opts))
+
+    # validate drag function and replace with the numeral
+    if ret[:drag_function] and !ret[:drag_number]
+      ret[:drag_number] =
+        Ballistics::Projectile.drag_number(ret[:drag_function])
+    end
+
+    # apply atmospheric correction to ballistic coefficient
+    if ret[:ballistic_coefficient] and @atmosphere
+      ret[:ballistic_coefficient] =
+        @atmosphere.translate(ret[:ballistic_coefficient])
+    end
+
+    ret
+  end
+
+  # Return a multiline string showing each component of the problem
+  #
+  def report
+    lines = []
+    lines << @gun.multiline if @gun
+    lines << @cartridge.multiline if @cartridge
+    lines << @projectile.multiline if @projectile
+    lines << @atmosphere.multiline if @atmosphere
+    lines.join("\n\n")
+  end
+
+  # Given a zero range and basic ballistics parameters
+  # Return the angle between sight axis and bore axis necessary to achieve zero
+  #
+  def zero_angle(opts = {})
+    Ballistics.zero_angle self.enrich opts
+  end
+
+  # Return a data structure with trajectory data at every interval for the
+  #   specified range
+  #
+  def trajectory(opts = {})
+    Ballistics.trajectory self.enrich opts
+  end
+
+  # Return a multiline string based on trajectory data
+  #
+  def table(trajectory: nil, fields: nil, opts: {})
+    Ballistics.table(trajectory: trajectory,
+                     fields: fields,
+                     opts: self.enrich(opts))
+  end
+end

data/lib/ballistics/projectile.rb

@@ -0,0 +1,165 @@
+require 'ballistics/yaml'
+
+class Ballistics::Projectile
+  MANDATORY = {
+    "name"   => :string,
+    "cal"    => :float,
+    "grains" => :count,
+  }
+  # one of these fields is mandatory
+  BALLISTIC_COEFFICIENT = {
+    "g1" => :float,
+    "g7" => :float,
+  }
+  OPTIONAL = {
+    "sd"       => :float,
+    "intended" => :string,
+    "base"     => :string,
+    "desc"     => :string,
+  }
+  DRAG_FUNCTION = {
+    "flat" => "g1",
+    "boat" => "g7",
+  }
+  DRAG_NUMBER = {
+    "g1" => 1,
+    "g7" => 7,
+  }
+
+  # Load a built-in YAML file and instantiate projectile objects
+  # Return a hash of projectile objects keyed by projectile id (per the YAML)
+  #
+  def self.find(short_name)
+    objects = {}
+    Ballistics::YAML.load_built_in('projectiles', short_name).each { |id, hsh|
+      obj = self.new(hsh)
+      if block_given?
+        objects[id] = obj if yield obj
+      else
+        objects[id] = obj
+      end
+    }
+    objects
+  end
+
+  # Normalize common flat-base and boat-tail terms to flat or boat
+  #
+  def self.base(candidate)
+    c = candidate.to_s.downcase.gsub(/[\-\_ ]/, '')
+    case c
+    when "boat", "boattail", "bt"
+      "boat"
+    when "flat", "flatbase", "fb"
+      "flat"
+    else
+      raise "unknown base: #{candidate}"
+    end
+  end
+
+  # Convert e.g. G1 to 1
+  #
+  def self.drag_number(drag_function)
+    DRAG_NUMBER.fetch(drag_function.to_s.downcase)
+  end
+
+  attr_reader(*MANDATORY.keys)
+  attr_reader(*BALLISTIC_COEFFICIENT.keys)
+  attr_reader(*OPTIONAL.keys)
+  attr_reader :ballistic_coefficient, :yaml_data, :extra
+
+  def initialize(hsh)
+    @yaml_data = hsh
+    MANDATORY.each { |field, type|
+      val = hsh.fetch(field)
+      Ballistics::YAML.check_type!(val, type)
+      self.instance_variable_set("@#{field}", val)
+    }
+
+    # Extract ballistic coefficients per drag model (e.g. G1)
+    # We need at least one
+    #
+    @ballistic_coefficient = {}
+    BALLISTIC_COEFFICIENT.each { |field, type|
+      if hsh.key?(field)
+        val = hsh[field]
+        Ballistics::YAML.check_type!(val, type)
+        self.instance_variable_set("@#{field}", val)
+        @ballistic_coefficient[field] = val
+      end
+    }
+    raise "no valid BC" if @ballistic_coefficient.empty?
+
+    OPTIONAL.each { |field, type|
+      if hsh.key?(field)
+        val = hsh[field]
+        Ballistics::YAML.check_type!(val, type)
+        if field == "base"
+          @base = self.class.base(val)
+        else
+          self.instance_variable_set("@#{field}", val)
+        end
+      end
+    }
+
+    # Keep track of fields that we don't expect
+    @extra = {}
+    (hsh.keys -
+     MANDATORY.keys -
+     BALLISTIC_COEFFICIENT.keys -
+     OPTIONAL.keys).each { |k|
+      @extra[k] = hsh[k]
+    }
+
+    # Make sure @base and @drag_function are initialized so that
+    # self.drag_function works without warnings
+    #
+    @base ||= nil
+    @drag_function = nil
+  end
+
+  # Return the preferred drag function if there is a BC available
+  #
+  def drag_function
+    return @drag_function if @drag_function
+    @drag_function = @ballistic_coefficient.keys.first
+    if @base
+      preferred = DRAG_FUNCTION.fetch(@base)
+      if @ballistic_coefficient.key?(preferred)
+        @drag_function = preferred
+      end
+    end
+    @drag_function
+  end
+
+  # Return the BC for the preferred drag function
+  #
+  def bc
+    @ballistic_coefficient.fetch(self.drag_function)
+  end
+
+  # Return params that can be used by Ballistics::Problem
+  #
+  def params
+    { drag_function: self.drag_function,
+      drag_number: self.class.drag_number(self.drag_function),
+      ballistic_coefficient: self.bc }
+  end
+
+  # Return lines of text separated by newlines
+  #
+  def multiline
+    lines = ["PROJECTILE: #{@name}", "=========="]
+    fields = {
+      "Caliber" => @cal,
+      "Grains" => @grains,
+    }
+    @ballistic_coefficient.each { |df, bc|
+      fields["BC (#{df.upcase})"] = bc
+    }
+    fields["Desc"] = @desc if @desc
+    fields.each { |name, val|
+      lines << [name.rjust(7, ' '), val].join(': ')
+    }
+    lines.join("\n")
+  end
+end

data/lib/ballistics/projectiles/300_blk.yaml

@@ -0,0 +1,321 @@
+# MANDATORY
+# $id:
+#   name:
+#   cal:
+#   grains:
+# AT LEAST ONE OF
+#   g1:
+#   g7:
+# OPTIONAL
+#   desc:
+#   intended: # e.g. 300 BLK
+#   base: flat|boat
+#   sd:
+
+# FLAT BASE INTENDED FOR 300 BLK
+
+barnes_90_otfb:
+  name: Barnes 90gr Zinc OTFB
+  cal: .308
+  grains: 90
+  g1: .246
+  intended: 300 BLK
+  base: flat
+  desc: Open tip, copper jacket, zinc core
+
+barnes_110_tac_tx_300_blk:
+  name: Barnes 110gr TAC-TX 300 BLK
+  cal: .308
+  grains: 110
+  g1: .289
+  sd: .166
+  intended: 300 BLK
+  base: flat
+  desc: Black polymer tip, copper bullet
+
+hornady_110_v_max_black:
+  name: Hornady 110gr V-MAX BLACK
+  cal: .308
+  grains: 110
+  g1: .290
+  sd: .166
+  intended: 300 BLK
+  base: flat
+  desc: Red polymer tip, copper jacket, lead core
+
+remington_120_umc_otfb:
+  name: Remington 120gr UMC OTFB
+  cal: .308
+  grains: 120
+  g1: .297
+  intended: 300 BLK
+  base: flat
+  desc: Copper jacket, lead core
+
+hornady_125_hp_match:
+  name: Hornady 125gr HP Match
+  cal: .308
+  grains: 125
+  g1: .320
+  sd: .128
+  intended: 300 BLK
+  base: flat
+  desc: Open tip, copper jacket, lead core
+
+sierra_125_mk:
+  name: Sierra 125gr MatchKing OTFB
+  cal: .308
+  grains: 125
+  g1: .330
+  sd: .188
+  intended: 300 BLK
+  base: flat
+  desc: Open tip, copper jacket, lead core
+
+sierra_125_tmk:
+  name: Sierra 125gr Tipped MatchKing
+  cal: .308
+  grains: 125
+  g1: .332
+  sd: .188
+  intended: 300 BLK
+  base: flat
+  desc: Green polymer tip, copper jacket, lead core
+
+hornady_135_ftx:
+  name: Hornady 135gr FTX
+  cal: .308
+  grains: 135
+  g1: .274
+  sd: .203
+  intended: 300 BLK
+  base: flat
+  desc: Red polymer tip, copper jacket, lead core with InterLock
+
+hornady_208_a_max_black:
+  name: Hornady 208gr A-MAX BLACK
+  cal: .308
+  grains: 208
+  g1: .648
+  sd: .313
+  intended: 300 BLK
+  base: flat
+  desc: Red polymer tip, copper jacket, lead core
+
+remington_220_umc_otfb:
+  name: Remington UMC 220gr OTFB
+  cal: .308
+  grains: 220
+  g1: 0.680 # best guess, based on Rem 220gr OTFB
+  sd: 0.331 # best guess, based on 220gr SMK
+  intended: 300 BLK
+  base: flat
+  desc: Open tip, copper jacket, lead core
+
+remington_220_otfb:
+  name: Remington 220gr Open Tip Flat Base
+  cal: .308
+  grains: 220
+  g1: .680
+  sd: 0.331 # best guess, based on 220gr SMK
+  intended: 300 BLK
+  base: flat
+  desc: Open tip, copper jacket, lead core
+
+# OTHER FLAT BASE
+
+# Note, Barnes TAC-TX is essentially identical to TTSX -- just a rebranding
+# with restricted choices appropriate to Mil/LE rifles
+barnes_110_tac_tx:
+  name: Barnes 110gr TAC-TX 30 CAL
+  cal: .308
+  grains: 110
+  g1: .295
+  sd: .166
+  base: flat
+  desc: Blue polymer tip, copper bullet, general 30 cal
+
+# Note, Barnes TAC-X is essentially identical to TSX -- just a rebranding
+# with restricted choices appropriate to Mil/LE rifles
+barnes_110_tac_x:
+  name: Barnes 110gr TAC X
+  cal: .308
+  grains: 110
+  g1: .264
+  sd: .166
+  base: flat
+  desc: All copper
+
+barnes_110_tsx:
+  name: Barnes 110gr TSX
+  cal: .308
+  grains: 110
+  g1: .264
+  sd: .166
+  base: flat
+  desc: All copper
+
+barnes_110_ttsx:
+  name: Barnes 110gr TTSX
+  cal: .308
+  grains: 110
+  g1: .295
+  sd: .166
+  base: flat
+  desc: Blue polymer tip, copper bullet
+
+sierra_110_fmj:
+  name: Sierra 110gr FMJ
+  cal: .308
+  grains: 110
+  g1: .170
+  sd: .166
+  intended: M1 Carbine
+  base: flat
+  desc: Copper jacket, lead core
+
+sierra_110_hp:
+  name: Sierra 110gr HP
+  cal: .308
+  grains: 110
+  g1: .204
+  sd: .166
+  base: flat
+  desc: Hollow point, copper jacket, lead core, high accuracy
+
+sierra_110_rn:
+  name: Sierra 110gr RN
+  cal: .308
+  grains: 110
+  g1: .170
+  sd: .166
+  intended: M1 Carbine
+  base: flat
+  desc: Round lead nose, copper jacket, lead core, expands at low velocity
+
+berger_115_fb:
+  name: Berger 115gr FB Target
+  cal: .308
+  grains: 115
+  g1: .289
+  base: flat
+  desc: Copper jacket, lead core, 1:19 twist
+
+sierra_125_spt:
+  name: Sierra 125gr SPT
+  cal: .308
+  grains: 125
+  g1: .264
+  sd: .188
+  base: flat
+  desc: Copper jacket, lead core, spitzer, intended for hunting
+
+sierra_135_hp:
+  name: Sierra 135gr HP Varminter
+  cal: .308
+  grains: 135
+  g1: .275
+  sd: .203
+  base: flat
+  desc: Hollow point, copper jacket, lead core, 300 BLK compatible
+
+barnes_150_tac_rrlp:
+  name: Barnes 150gr TAC RRLP
+  cal: .308
+  grains: 150
+  g1: .357
+  sd: .226
+  base: flat
+  desc: Frangible; Reduced Ricochet Limited Penetration
+
+sierra_150_spt:
+  name: Sierra 150gr SPT
+  cal: .308
+  grains: 150
+  g1: .360
+  sd: .226
+  base: flat
+  desc: Copper jacket, lead core, spitzer, intended for hunting
+
+sierra_150_rn:
+  name: Sierra 150gr RN
+  cal: .308
+  grains: 150
+  g1: .270
+  sd: .226
+  base: flat
+  desc: Round lead nose, copper jacket, lead core, accurate short range hunting
+
+#
+# BOAT TAILS
+#
+
+hornady_110_gmx:
+  name: Hornady 110gr GMX
+  intended: 300 BLK
+  cal: .308
+  grains: 110
+  g1: .305
+  sd: .166
+  base: boat
+  desc: Red polymer tip, copper alloy bullet, very short boat tail
+  # g7: TODO
+
+barnes_120_tac_tx:
+  name: Barnes 120gr TAC-TX
+  cal: .308
+  grains: 120
+  g1: .358
+  sd: .181
+  base: boat
+  desc: Black polymer tip, copper bullet
+  # g7: TODO
+
+barnes_130_tsx:
+  name: Barnes 130gr TSX
+  cal: .308
+  grains: 130
+  g1: .340
+  sd: .196
+  base: boat
+  desc: All copper
+  # g7: TODO
+
+barnes_130_ttsx:
+  name: Barnes 130gr TTSX
+  cal: .308
+  grains: 130
+  g1: .350
+  sd: .196
+  base: boat
+  desc: Blue polymer tip, copper bullet
+  # g7: TODO
+
+barnes_150_tsx:
+  name: Barnes 150gr TSX
+  cal: .308
+  grains: 150
+  g1: .369
+  sd: .226
+  base: boat
+  desc: All copper
+
+barnes_150_ttsx:
+  name: Barnes 150gr TTSX
+  cal: .308
+  grains: 150
+  g1: .420
+  sd: .226
+  base: boat
+  desc: Blue polymer tip, copper bullet
+  # g7: TODO
+
+sierra_220_hpbt_mk:
+  name: Sierra 220gr
+  cal: .308
+  grains: 220
+  g1: .608
+  sd: .331
+  base: boat
+  desc: Open tip, copper jacket, lead core
+  # g7: TODO