Conditionally Couple Wave Fields based on COMPSET

[erinethomas]

There is a issue in E3SM where the coupler history files contain wave variables even in compsets with NO active wave component. This PR fixes the issue by making all coupled wave fields "conditional" on the existence of an active wave component.
This PR produces BFB results in standard B cases with no active waves apart from the differing field list.

This PR adds a drv_in namelist variable called "wav_ocn_coup". This variable controls the coupling between the wave and ocean components. "wav_ocn_coup" is automatically defined (no user input is required) with one of the following: "none", "one" or "two" - based on the active components in the selected COMPSET.

For example, a B case with active WW3 automatically sets the wav_ocn_coup to "two" (full two-way coupling enabled between waves and ocean). However, a standard B case with no WW3 sets "wav_ocn_coup to "none" where no wave-ocean coupling is defined in the model.

Note: This framework is flexible enough to allow future capabilities of wave coupling. For example, in compsets where a data model is used, wav_ocn_coup could be set to "one", to enable one way coupling (passing information from a data model to active wave component). Furthermore, this framework will be expanded upon in the future to allow one and two way coupling between wave-atmosphere, as well as wave-sea ice components.

[liho745]

@erinethomas <https://github.com/erinethomas> not sure whether there has been some confusion -- I work on the river component and don't know much about wave or ocean.

…

On Thu, Jan 9, 2025 at 5:06 PM Erin E Thomas ***@***.***> wrote: @erinethomas <https://github.com/erinethomas> requested your review on: #6885 <#6885> Wave Fields are CONDITIONALLY coupled based on COMPSET. — Reply to this email directly, view it on GitHub <#6885 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AC5QWBWDCXRWZZEUAFZJN7D2J36JBAVCNFSM6AAAAABU5GA3SKVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJVHA3TINRYGA2TMMI> . You are receiving this because your review was requested.Message ID: ***@***.***>