Merge pull request #186 from neaps/ticon-constituents

Add constituents to support TICON data

Author: bkeepers

packages/tide-predictor/src/constituents/2MK3.ts

@@ -0,0 +1,13 @@
+import { defineCompoundConstituent } from "./definition.js";
+import M2 from "./M2.js";
+import O1 from "./O1.js";
+
+/**
+ * Shallow-water terdiurnal (2MK3 = M2 + O1).
+ * Lunar-lunar interaction from M2 semi-diurnal and O1 diurnal components.
+ * Generated in shallow-water environments; typical amplitude <1 cm.
+ */
+export default defineCompoundConstituent("2MK3", [
+  { constituent: M2, factor: 1 },
+  { constituent: O1, factor: 1 },
+]);

packages/tide-predictor/src/constituents/2MK5.ts

@@ -0,0 +1,17 @@
+import { defineCompoundConstituent } from "./definition.js";
+import M2 from "./M2.js";
+import K1 from "./K1.js";
+
+/**
+ * Shallow-water fifth-diurnal from M2-K1 interaction.
+ *
+ * Note: Found in coastal tide predictions, especially in enclosed bays and harbors.
+ * Amplitude typically 0.1-0.5 cm depending on location and water depth.
+ * Shallow-water constituent only; not present in deep ocean.
+ *
+ * @see NOAA CO-OPS
+ */
+export default defineCompoundConstituent("2MK5", [
+  { constituent: M2, factor: 2 },
+  { constituent: K1, factor: 1 },
+]);

packages/tide-predictor/src/constituents/2MO5.ts

@@ -0,0 +1,17 @@
+import { defineCompoundConstituent } from "./definition.js";
+import M2 from "./M2.js";
+import O1 from "./O1.js";
+
+/**
+ * Shallow-water fifth-diurnal from M2-O1 interaction.
+ *
+ * Note: Primarily shallow-water coastal phenomenon, not present in deep ocean.
+ * Amplitude typically <0.5 cm except in extreme shallow-water or enclosed basins.
+ * Found in coastal tide predictions alongside other shallow-water constituents.
+ *
+ * @see NOAA CO-OPS
+ */
+export default defineCompoundConstituent("2MO5", [
+  { constituent: M2, factor: 2 },
+  { constituent: O1, factor: 1 },
+]);

packages/tide-predictor/src/constituents/2MS6.ts

@@ -0,0 +1,14 @@
+import { defineCompoundConstituent } from "./definition.js";
+import M2 from "./M2.js";
+import S2 from "./S2.js";
+
+/**
+ * Sixth-diurnal shallow-water interaction: 2×M2 + S2.
+ *
+ * Generated only in shallow water; typical amplitude 0.01-0.2 meters depending on depth.
+ * Included in IHO shallow-water constituent tables and NOAA analysis (order #37).
+ */
+export default defineCompoundConstituent("2MS6", [
+  { constituent: M2, factor: 2 },
+  { constituent: S2, factor: 1 },
+]);

packages/tide-predictor/src/constituents/2N2.ts

@@ -0,0 +1,9 @@
+import { defineConstituent } from "./definition.js";
+import nc from "../node-corrections/index.js";
+
+/**
+ * Lunar semi-diurnal (2N2).
+ * Second-order lunar semi-diurnal from Moon's orbital ellipticity.
+ * Amplitude typically 5-10% of M2; significant in semi-diurnal analysis.
+ */
+export default defineConstituent("2N2", [2, -2, 0, 2, 0, 0, 0], nc.uM2, nc.fM2);

packages/tide-predictor/src/constituents/2Q1.ts

@@ -0,0 +1,14 @@
+import { defineCompoundConstituent } from "./definition.js";
+import N2 from "./N2.js";
+import J1 from "./J1.js";
+
+/**
+ * Shallow-water diurnal (2Q1 = N2-J1).
+ * Derived from interaction of semi-diurnal N2 and diurnal J1 constituents.
+ * Amplitude typically very small; rarely significant.
+ * Found only in shallow-water regions with strong tidal distortion.
+ */
+export default defineCompoundConstituent("2Q1", [
+  { constituent: N2, factor: 1 },
+  { constituent: J1, factor: -1 },
+]);

packages/tide-predictor/src/constituents/2SM2.ts

@@ -0,0 +1,14 @@
+import { defineCompoundConstituent } from "./definition.js";
+import S2 from "./S2.js";
+import M2 from "./M2.js";
+
+/**
+ * Shallow-water semi-diurnal (2SM2).
+ * Compound constituent: 2×S2 - M2
+ * Solar-lunar interaction constituent generated in shallow-water environments.
+ * Amplitude typically <2% of M2; complementary to MU2.
+ */
+export default defineCompoundConstituent("2SM2", [
+  { constituent: S2, factor: 2 },
+  { constituent: M2, factor: -1 },
+]);

packages/tide-predictor/src/constituents/3L2.ts

@@ -0,0 +1,13 @@
+import { defineCompoundConstituent } from "./definition.js";
+import L2 from "./L2.js";
+
+/**
+ * Triple lunar elliptic; 3 times L2 interaction.
+ *
+ * Warning: Not in standard IHO constituent bank. Mainly historical/theoretical interest.
+ * Very small amplitude (<0.1 cm); found only in extreme shallow water or enclosed basins.
+ * Often ignored in routine tide predictions.
+ *
+ * @see Schureman, P. (1958). Manual of Harmonic Analysis and Prediction of Tides
+ */
+export default defineCompoundConstituent("3L2", [{ constituent: L2, factor: 3 }]);

packages/tide-predictor/src/constituents/3N2.ts

@@ -0,0 +1,13 @@
+import { defineCompoundConstituent } from "./definition.js";
+import N2 from "./N2.js";
+
+/**
+ * Triple N2 shallow-water harmonic (3 × N2).
+ *
+ * Note: Shallow-water constituent with definition based on compound frequency estimates.
+ * Typical amplitude <0.5 cm; often <0.1 cm except in extreme shallow-water or enclosed basins.
+ * Rarely significant in routine tide predictions.
+ *
+ * @see NOAA CO-OPS shallow-water constituents
+ */
+export default defineCompoundConstituent("3N2", [{ constituent: N2, factor: 3 }]);

packages/tide-predictor/src/constituents/EP2.ts

@@ -0,0 +1,7 @@
+import { defineConstituent } from "./definition.js";
+import nc from "../node-corrections/index.js";
+
+/**
+ * Lunar elliptic semi-diurnal constituent (ε2).
+ */
+export default defineConstituent("EP2", [2, -3, 2, 1, 0, 0, 0], nc.uM2, nc.fM2);