extension to the internal tides module

[raphaeldussin]

the module in now able to read in tidal velocities for different tidal harmonics and distribute the energy and distribute TKE input over the different vertical modes. This involves upsizing dimensions of several arrays and mofiying some API. internal_tide_input_CS is promoted to public to facilitate the passing of energy input to MOM_internal_tides

[codecov]

Codecov Report

Merging #481 (cefe39f) into dev/gfdl (ddb88f8) will decrease coverage by 0.04%.
The diff coverage is 0.00%.

❗ Current head cefe39f differs from pull request most recent head 8878535. Consider uploading reports for the commit 8878535 to get more accurate results

@@             Coverage Diff              @@
##           dev/gfdl     #481      +/-   ##
============================================
- Coverage     37.54%   37.50%   -0.04%     
============================================
  Files           270      270              
  Lines         79030    79111      +81     
  Branches      14635    14636       +1     
============================================
- Hits          29671    29670       -1     
- Misses        43892    43975      +83     
+ Partials       5467     5466       -1     

Files	Coverage Δ
...parameterizations/vertical/MOM_diabatic_driver.F90	46.86% <0.00%> (ø)
...meterizations/vertical/MOM_internal_tide_input.F90	0.00% <0.00%> (ø)
...c/parameterizations/lateral/MOM_internal_tides.F90	0.00% <0.00%> (ø)

... and 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

[Hallberg-NOAA]

Thank you for this contribution. I appreciate the direction that this PR is going, but there are two significant issues that I think need to be discussed.

1. The magnitude of the velocity in the quadratic bottom drag term should include all of the velocities added in quadrature, not just a single tidal component, as is the case with the modified code.

2. If at all possible, we should explore other code constructs that avoid making any of our control structures transparent. Opaque structures avoid most of the issues related to efficiency and readability that arise from passing around what are effectively common blocks.

[Hallberg-NOAA]

With these change, the concerns that I had with the previous version have been addressed. The only other change I would suggest is that the allocate call for vel_btTide should be moved outside of get_barotropic_tidal_vel() so that its pairing with the call to deallocate(vel_btTide) is more readily evident, and similarly the allocate call for TKE_tidal_input should be moved out of get_input_TKE().

[marshallward]

Gaea regression: https://gitlab.gfdl.noaa.gov/ogrp/MOM6/-/pipelines/2113 ✔️

Squash-merging.