@neaps/tide-predictor 0.0.4

package/src/node-corrections/__tests__/index.js

@@ -0,0 +1,114 @@
+import nodeCorrections from '../index'
+
+const testItems = {
+  i: {
+    value: 5
+  },
+  I: { value: 6 },
+  omega: { value: 3 },
+  nu: { value: 4 },
+  nup: { value: 4 },
+  nupp: { value: 2 },
+  P: { value: 14 },
+  xi: {
+    value: 4
+  }
+}
+
+describe('Node corrections', () => {
+  test('have correct unity', () => {
+    expect(nodeCorrections.fUnity()).toBe(1)
+  })
+
+  test('calculates Schureman equations 73, 65 (f_Mm)', () => {
+    expect(nodeCorrections.fMm(testItems)).toBeCloseTo(0.999051998091, 4)
+  })
+
+  test('calculates Schureman equations 74, 66 (f_Mf)', () => {
+    expect(nodeCorrections.fMf(testItems)).toBeCloseTo(4.00426673883, 4)
+  })
+
+  test('calculates Schureman equations 75, 67 (f_O1)', () => {
+    expect(nodeCorrections.fO1(testItems)).toBeCloseTo(2.00076050158, 4)
+  })
+
+  test('calculates Schureman equations 76, 68 (f_J1)', () => {
+    expect(nodeCorrections.fJ1(testItems)).toBeCloseTo(2.0119685329, 4)
+  })
+
+  test('calculates Schureman equations 77, 69 (f_OO1)', () => {
+    expect(nodeCorrections.fOO1(testItems)).toBeCloseTo(8.01402871709, 4)
+  })
+
+  test('calculates Schureman equations 78, 70 (f_M2)', () => {
+    expect(nodeCorrections.fM2(testItems)).toBeCloseTo(0.999694287563, 4)
+  })
+
+  test('calculates Schureman equations 227, 226, 68 (f_K1)', () => {
+    expect(nodeCorrections.fK1(testItems)).toBeCloseTo(1.23843964182, 4)
+  })
+
+  test('calculates Schureman equations 215, 213, 204 (f_L2)', () => {
+    expect(nodeCorrections.fL2(testItems)).toBeCloseTo(0.98517860327, 4)
+  })
+
+  test('calculates Schureman equations 235, 234, 71 (f_K2)', () => {
+    expect(nodeCorrections.fK2(testItems)).toBeCloseTo(1.09775430048, 4)
+  })
+
+  test('calculates Schureman equations 206, 207, 195 (f_M1)', () => {
+    expect(nodeCorrections.fM1(testItems)).toBeCloseTo(3.90313810168, 4)
+  })
+
+  test('calculates e.g. Schureman equation 149 (f_Modd)', () => {
+    expect(nodeCorrections.fModd(testItems, 3)).toBeCloseTo(0.999541466395, 4)
+  })
+
+  test('has a zero for u_zero', () => {
+    expect(nodeCorrections.uZero()).toBe(0.0)
+  })
+
+  test('calculates u_Mf', () => {
+    expect(nodeCorrections.uMf(testItems)).toBe(-8.0)
+  })
+
+  test('calculates u_O1', () => {
+    expect(nodeCorrections.uO1(testItems)).toBe(4.0)
+  })
+
+  test('calculates u_J1', () => {
+    expect(nodeCorrections.uJ1(testItems)).toBe(-4)
+  })
+
+  test('calculates u_OO1', () => {
+    expect(nodeCorrections.uOO1(testItems)).toBe(-12.0)
+  })
+
+  test('calculates u_M2', () => {
+    expect(nodeCorrections.uM2(testItems)).toBe(0.0)
+  })
+
+  test('calculates u_K1', () => {
+    expect(nodeCorrections.uK1(testItems)).toBe(-4)
+  })
+
+  test('calculates u_L2', () => {
+    expect(nodeCorrections.uL2(testItems)).toBeCloseTo(-0.449812364499, 4)
+  })
+
+  test('calculates u_K2', () => {
+    expect(nodeCorrections.uK2(testItems)).toBe(-4.0)
+  })
+
+  test('calculates u_K2', () => {
+    expect(nodeCorrections.uK2(testItems)).toBe(-4.0)
+  })
+
+  test('calculates u_M1', () => {
+    expect(nodeCorrections.uM1(testItems)).toBeCloseTo(7.09154172301, 4)
+  })
+
+  test('calculates u_Modd', () => {
+    expect(nodeCorrections.uModd(testItems, 3)).toBe(0)
+  })
+})

package/src/node-corrections/index.js

@@ -0,0 +1,208 @@
+import { d2r, r2d } from '../astronomy/constants'
+
+const corrections = {
+  fUnity() {
+    return 1
+  },
+
+  // Schureman equations 73, 65
+  fMm(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const mean =
+      (2 / 3.0 - Math.pow(Math.sin(omega), 2)) *
+      (1 - (3 / 2.0) * Math.pow(Math.sin(i), 2))
+    return (2 / 3.0 - Math.pow(Math.sin(I), 2)) / mean
+  },
+
+  // Schureman equations 74, 66
+  fMf(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const mean = Math.pow(Math.sin(omega), 2) * Math.pow(Math.cos(0.5 * i), 4)
+    return Math.pow(Math.sin(I), 2) / mean
+  },
+
+  // Schureman equations 75, 67
+  fO1(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const mean =
+      Math.sin(omega) *
+      Math.pow(Math.cos(0.5 * omega), 2) *
+      Math.pow(Math.cos(0.5 * i), 4)
+    return (Math.sin(I) * Math.pow(Math.cos(0.5 * I), 2)) / mean
+  },
+
+  // Schureman equations 76, 68
+  fJ1(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const mean =
+      Math.sin(2 * omega) * (1 - (3 / 2.0) * Math.pow(Math.sin(i), 2))
+    return Math.sin(2 * I) / mean
+  },
+
+  // Schureman equations 77, 69
+  fOO1(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const mean =
+      Math.sin(omega) *
+      Math.pow(Math.sin(0.5 * omega), 2) *
+      Math.pow(Math.cos(0.5 * i), 4)
+    return (Math.sin(I) * Math.pow(Math.sin(0.5 * I), 2)) / mean
+  },
+
+  // Schureman equations 78, 70
+  fM2(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const mean =
+      Math.pow(Math.cos(0.5 * omega), 4) * Math.pow(Math.cos(0.5 * i), 4)
+    return Math.pow(Math.cos(0.5 * I), 4) / mean
+  },
+
+  // Schureman equations 227, 226, 68
+  // Should probably eventually include the derivations of the magic numbers (0.5023 etc).
+  fK1(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const nu = d2r * a.nu.value
+    const sin2IcosnuMean =
+      Math.sin(2 * omega) * (1 - (3 / 2.0) * Math.pow(Math.sin(i), 2))
+    const mean = 0.5023 * sin2IcosnuMean + 0.1681
+    return (
+      Math.pow(
+        0.2523 * Math.pow(Math.sin(2 * I), 2) +
+          0.1689 * Math.sin(2 * I) * Math.cos(nu) +
+          0.0283,
+        0.5
+      ) / mean
+    )
+  },
+
+  // Schureman equations 215, 213, 204
+  // It can be (and has been) confirmed that the exponent for R_a reads 1/2 via Schureman Table 7
+  fL2(a) {
+    const P = d2r * a.P.value
+    const I = d2r * a.I.value
+    const rAInv = Math.pow(
+      1 -
+        12 * Math.pow(Math.tan(0.5 * I), 2) * Math.cos(2 * P) +
+        36 * Math.pow(Math.tan(0.5 * I), 4),
+      0.5
+    )
+    return corrections.fM2(a) * rAInv
+  },
+
+  // Schureman equations 235, 234, 71
+  // Again, magic numbers
+  fK2(a) {
+    const omega = d2r * a.omega.value
+    const i = d2r * a.i.value
+    const I = d2r * a.I.value
+    const nu = d2r * a.nu.value
+    const sinsqIcos2nuMean =
+      Math.sin(omega) ** 2 * (1 - (3 / 2.0) * Math.sin(i) ** 2)
+    const mean = 0.5023 * sinsqIcos2nuMean + 0.0365
+    return (
+      Math.pow(
+        0.2523 * Math.pow(Math.sin(I), 4) +
+          0.0367 * Math.pow(Math.sin(I), 2) * Math.cos(2 * nu) +
+          0.0013,
+        0.5
+      ) / mean
+    )
+  },
+  // Schureman equations 206, 207, 195
+  fM1(a) {
+    const P = d2r * a.P.value
+    const I = d2r * a.I.value
+    const qAInv = Math.pow(
+      0.25 +
+        1.5 *
+          Math.cos(I) *
+          Math.cos(2 * P) *
+          Math.pow(Math.cos(0.5 * I), -0.5) +
+        2.25 * Math.pow(Math.cos(I), 2) * Math.pow(Math.cos(0.5 * I), -4),
+      0.5
+    )
+    return corrections.fO1(a) * qAInv
+  },
+
+  // See e.g. Schureman equation 149
+  fModd(a, n) {
+    return Math.pow(corrections.fM2(a), n / 2.0)
+  },
+
+  // Node factors u, see Table 2 of Schureman.
+
+  uZero(a) {
+    return 0.0
+  },
+
+  uMf(a) {
+    return -2.0 * a.xi.value
+  },
+
+  uO1(a) {
+    return 2.0 * a.xi.value - a.nu.value
+  },
+
+  uJ1(a) {
+    return -a.nu.value
+  },
+
+  uOO1(a) {
+    return -2.0 * a.xi.value - a.nu.value
+  },
+
+  uM2(a) {
+    return 2.0 * a.xi.value - 2.0 * a.nu.value
+  },
+
+  uK1(a) {
+    return -a.nup.value
+  },
+
+  // Schureman 214
+  uL2(a) {
+    const I = d2r * a.I.value
+    const P = d2r * a.P.value
+    const R =
+      r2d *
+      Math.atan(
+        Math.sin(2 * P) /
+          ((1 / 6.0) * Math.pow(Math.tan(0.5 * I), -2) - Math.cos(2 * P))
+      )
+    return 2.0 * a.xi.value - 2.0 * a.nu.value - R
+  },
+
+  uK2(a) {
+    return -2.0 * a.nupp.value
+  },
+
+  // Schureman 202
+  uM1(a) {
+    const I = d2r * a.I.value
+    const P = d2r * a.P.value
+    const Q =
+      r2d *
+      Math.atan(((5 * Math.cos(I) - 1) / (7 * Math.cos(I) + 1)) * Math.tan(P))
+    return a.xi.value - a.nu.value + Q
+  },
+
+  uModd(a, n) {
+    return (n / 2.0) * corrections.uM2(a)
+  }
+}
+
+export default corrections