Inline harmonic analysis

[c2xu]

Set default HAready = False

Also made additional adjustment to ensure harmonic analysis is not activated if tide is not used in the model.

[c2xu]

This PR should fix issue #708

[kshedstrom]

Yes, thank you, that fixes my Supercritical case (and makes the Arctic hycom troubles something else entirely).

[marshallward]

Thank you @c2xu, I'll merge this once it passes testing.

[marshallward]

I'm looking over this module, and I'm a bit uncomfortable with the use of return in so many functions, particularly with respect to the various parameter tests. In most cases, one could have moved the logic outside the function and avoided the function call altogether.

I was also a bit surprised that HA_CSp is not only a pointer but also a local variable that conditionally points to CS%HA_CSp. That is, the null state is being used to control the logical flow.

I don't want to block this PR over those concerns, but it might be a good idea to review this design later when we have a chance.

[c2xu]

I'm looking over this module, and I'm a bit uncomfortable with the use of return in so many functions, particularly with respect to the various parameter tests. In most cases, one could have moved the logic outside the function and avoided the function call altogether.

I was also a bit surprised that HA_CSp is not only a pointer but also a local variable that conditionally points to CS%HA_CSp. That is, the null state is being used to control the logical flow.

I don't want to block this PR over those concerns, but it might be a good idea to review this design later when we have a chance.

Thanks for the comments. In addition, this module does not have the restart capability. I tried to add the restart capability but then it requires significant modification to the structure of the module. I guess it would be better to take care of all these issues altogether in a major revision of this module in the future. For now, I'm going to create an open issue to remind myself the points we discussed here.

[marshallward]

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