+Add particle code option to advect with uhtr

[cspencerjones]

The particle code has so far used the same velocity has was used in the dynamics step. I would like to add the option for the particle code to use uhtr/h and vhtr/h, so that the velocities used to advect particles may include the effects of parameterized eddies.

To make this work, I have added a flag that controls which velocity to use and moved the particles_run step to take place after uhtr and vhtr are defined. The interfaces in the code and in config_src/external are updated to pass this information to the drifters package.

[codecov]

Codecov Report

Merging #492 (fe1916e) into dev/gfdl (95d6e93) will increase coverage by 0.00%.
The diff coverage is 33.33%.

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

@@            Coverage Diff            @@
##           dev/gfdl     #492   +/-   ##
=========================================
  Coverage     37.78%   37.79%           
=========================================
  Files           270      270           
  Lines         78431    78434    +3     
  Branches      14525    14525           
=========================================
+ Hits          29636    29641    +5     
+ Misses        43391    43389    -2     
  Partials       5404     5404           

Files	Coverage Δ
config_src/external/drifters/MOM_particles.F90	0.00% <0.00%> (ø)
src/core/MOM.F90	50.82% <40.00%> (+0.02%)	⬆️

... 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]

This is a clever idea for parsimoniously expanding the options for the particles_run() code. Overall, I like where this is going, but given that the uo and vo arguments to particles run might be either velocities or thickness transports, with different units, I think that the comments describing these arguments also need to be modified accordingly.

[cspencerjones]

Thanks for this suggestion @Hallberg-NOAA . I had missed this, and I have made an update. Are the units ok like this? I looked at some other MOM6 code and it seemed like this style would be ok, but I'm happy to change it.

[Hallberg-NOAA]

There are still a couple of typos (e.g., "us_uh" instead of "use_uh") in the comments, but the documentation of the units with the various options is correct now.

[cspencerjones]

Thanks! I fixed the typos you pointed out, so we should be good to go.

[marshallward]

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