Add mesh cap #641

DeniseWorthen · 2022-03-20T19:26:24Z

Pull Request Summary

Enables an alternate cap for use by UWM apps S2SW and HAFSW

Description

The alternate source code utilizes the switch file switch_meshcap . A new switch option (UWM) is added to control features required by UWM.

The cap has a run-time config variable which determines whether the wave model is run in shel vs multi mode in UWM. Only a single grid has been verified when run in multi.

The new source files are:

wav_comp_nuopc: This is the main cap code. It advertises and realizes connected fields on a provided ESMF mesh file.
wav_import_export: This fills import and export state fields.
wav_shel_inp: Enables reading ww3_shel.inp file when run as shel.
wav_shr_mod: A set of utility routines to reduce code duplication.
w3iogoncdmd.F90: Writes gridded output fields as netcdf. Only a sub-set of all possible gridded output is currently available. When netcdf output is desired, an additional option needs to be added to the switch file (UWMNCOUT). This feature was originally coded to allow control via configuration variables but the code changes were backed out in order to resolve issues seen on the CESM side. A refactoring of the w3iogoncdmd.F90 to allow all output variables is currently under development.
wav_kind_mod

Code specific to CESM is added within ifdef CESMCOUPLED. Code specific to UWM is added within ifdef W3_UWM.

Please also include the following information:

Add any suggestions for a reviewer
Mention any labels that should be added: bug, documentation, enhancement, new feature
Are answer changes expected from this PR? Please describe the changes and the reason why in addition to which of the following labels would apply: mod_def change, out_grd change, out_pnt change, restart file change, Regression test
-->

Issue(s) addressed

fixes Add mesh-based nuopc cap to the dev/ufs-weather-model branch #636

Commit Message

Adds source code to implement a mesh-based NUOPC cap in the dev/ufs-weather-model branch.

co-author: @mvertens

Check list

Branch is up to date with the authoritative repository (NOAA-EMC) develop branch.
Checked the checklist for a developer submitting to develop.
If a version number update is required, checked the updating version number checklist.
If a new feature was added, a regression test for testing the new feature is added.

Testing

How were these changes tested?
Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
Have the matrix regression tests been run (if yes, please note HPC and compiler)?
Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):
Please indicate the expected changes in the regression test output (Note the known list of non-identical tests).
Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):

This displays on GitHub in a nice way

Conflicts: model/bin/make_makefile.sh model/ftn/w3gdatmd.ftn model/ftn/w3gridmd.ftn model/ftn/w3iogrmd.ftn model/ftn/w3srcemd.ftn model/ftn/w3wavemd.ftn

…e/cleanbuild

…ally updated

…7.13

Squashed commit of the following: commit 444212d Author: Denise Worthen <denise.worthen@noaa.gov> Date: Thu Apr 7 09:28:31 2022 -0400 tidy up commit 0343503 Author: Denise Worthen <denise.worthen@noaa.gov> Date: Thu Apr 7 09:05:42 2022 -0400 more doxygen formatting added commit 61c10ac Author: denise.worthen <Denise.Worthen@noaa.gov> Date: Wed Apr 6 22:17:19 2022 +0000 updates more doxy commit c9d10e4 Author: denise.worthen <Denise.Worthen@noaa.gov> Date: Wed Apr 6 22:02:51 2022 +0000 fix doxy errors * still have warning that u_file_u is not documented ? commit d19652f Author: Denise Worthen <denise.worthen@noaa.gov> Date: Wed Apr 6 17:15:34 2022 -0400 more doxy commit f1049d0 Author: Denise Worthen <denise.worthen@noaa.gov> Date: Wed Apr 6 08:22:54 2022 -0400 minor text placement changes commit 24f9945 Author: Denise Worthen <denise.worthen@noaa.gov> Date: Tue Apr 5 15:51:47 2022 -0400 update 2 more files commit fe25b63 Author: Denise Worthen <denise.worthen@noaa.gov> Date: Tue Apr 5 12:58:03 2022 -0400 initial commit of added doxygen

JessicaMeixner-NOAA · 2022-04-15T12:38:26Z

@DeniseWorthen in the wmesmf cap, the inputs are either from "cpl" or you can use the original method of inputs. It looks like if we're using ww3_shel.inp that all inputs must come from the coupler? Or is there another way that is determined?

DeniseWorthen · 2022-04-15T14:10:17Z

@JessicaMeixner-NOAA I'm not clear on your question. Are you asking if the mesh cap can be run standalone or when the forcing fields come from files?

JessicaMeixner-NOAA · 2022-04-15T16:10:36Z

@JessicaMeixner-NOAA I'm not clear on your question. Are you asking if the mesh cap can be run standalone or when the forcing fields come from files?

So let's say we wanted to coupled atm-wav, so that winds are coming from the coupler, but we'd like to have an input field of ice that comes from a file and we are using ww3_shel.inp. How would that get specified? Would that even be possible?

mvertens · 2022-04-15T16:14:58Z

@JessicaMeixner-NOAA - with CDEPS inline functionality (so that a prognostic component can ingest forcing fields like you want and easily from its cap) - this could be easily done today. I'm happy to show how this can be implemented. I can go over this briefly at our upcoming call next week.

JessicaMeixner-NOAA · 2022-04-15T16:19:02Z

@JessicaMeixner-NOAA - with CDEPS inline functionality (so that a prognostic component can ingest forcing fields like you want and easily from its cap) - this could be easily done today. I'm happy to show how this can be implemented. I can go over this briefly at our upcoming call next week.

This is a capability we have with wmesmf when using ww3_multi.inp without using a separate data model.

mvertens · 2022-04-15T16:22:04Z

@JessicaMeixner-NOAA - you are not using a separate data model - just share code functionality. I'm not suggesting this is the only way - but a powerful way to have different spatial and time interpolations (including 3d mapping) for forcing fields that it would be helpful for everyone to be aware of.

JessicaMeixner-NOAA

Issues to address review comments have been made and linked in the appropriate places. In addition items that I believe will be taken care of in this PR were also noted. If these items will not be addressed in this PR please let me know so an issue for that item can be created.

JessicaMeixner-NOAA · 2022-04-20T18:18:30Z

model/src/w3initmd.F90

@@ -1236,6 +1246,9 @@ SUBROUTINE W3INIT ( IMOD, IsMulti, FEXT, MDS, MTRACE, ODAT      &
 !
      FLOUT(2) = NPT .GT. 0
 !
+#ifdef CESMCOUPLED


Not creating issue for this, assuming it will be taken care of in this PR.

model/src/w3initmd.F90

JessicaMeixner-NOAA · 2022-04-20T18:35:30Z

model/src/w3iogomd.F90

@@ -1562,8 +1616,39 @@ SUBROUTINE W3OUTG ( A, FLPART, FLOUTG, FLOUTG2 )
            USSCO=FKD*SIG(IK)*WN(IK,ISEA)*COSH(2.*KD)
            BHD(JSEA) = BHD(JSEA) +                             &
                GRAV*WN(IK,ISEA) * EBD(IK,JSEA) / (SINH(2.*KD))
+#ifdef CESMCOUPLED


The proposed subsequent updates are covered in these issues:

Add tail to USSX/USSY and do not add extra variable: Add optional high frequency tail to USSX, USSY #669

Add "depth" input field. Add new depth input field #670

Move any relevant variable calculations to the cap code that do not need output: Move calculations to cap-code that should not be output #671

Remove the ifdefs for any other remaining variables so that all users can access new output variables Expand use of variable output #672

JessicaMeixner-NOAA · 2022-04-20T18:43:41Z

model/src/w3iogoncdmd.F90

@@ -0,0 +1,759 @@
+#include "w3macros.h"


An issue was created for this: #673 where we can continue this discussion

JessicaMeixner-NOAA · 2022-04-20T18:52:19Z

model/src/w3iorsmd.F90

@@ -430,18 +438,32 @@ SUBROUTINE W3IORS ( INXOUT, NDSR, DUMFPI, IMOD, FLRSTRT )
 !
 ! open file ---------------------------------------------------------- *
 !
+#ifdef CESMCOUPLED


Issue to address this is here: #674

model/src/w3timemd.F90

JessicaMeixner-NOAA · 2022-04-20T21:37:36Z

model/src/w3updtmd.F90

@@ -1803,6 +1807,9 @@ SUBROUTINE W3UICE ( VA )
                                  ICEI(IX,IY), 'ICE (NEW)'
 #endif
                VA(:,JSEA) = 0.
+#if defined(W3_UWM) || defined(CESMCOUPLED)
+               charn(jsea) = aalpha


The follow up for this issue is here: #677

JessicaMeixner-NOAA · 2022-04-20T21:38:10Z

model/src/w3wavemd.F90

@@ -1540,11 +1545,9 @@ SUBROUTINE W3WAVE ( IMOD, ODAT, TEND, STAMP, NO_OUT &
 !
 ! 3.3.3 Update ice floe diameter
 !
-#ifdef W3_IS2
+#if defined(W3_IS2) || defined(CESMCOUPLED)


Assuming this will be updated in this PR and so no issues is made.

JessicaMeixner-NOAA · 2022-04-20T21:41:29Z

model/src/wav_shel_inp.F90

+
+  end subroutine set_shel_io
+
+  subroutine set_shel_inp(dtime_sync)


Follow up issue: #678

JessicaMeixner-NOAA · 2022-04-20T21:44:57Z

model/src/wav_shel_inp.F90

+  end subroutine set_shel_inp
+
+  !===============================================================================
+  subroutine read_shel_inp(mpi_comm)


Issue for this is here: #679

* change cesmcoupled to w3_cesmcoupled * removed commented out line in w3init * mark sections which require fixes and testing for cesm

* remove marked sections for pr review

JessicaMeixner-NOAA

All issues that were going to be taken care of before the PR was merged have been addressed.

Merge mesh cap changes from (PR NOAA-EMC#641)

JessicaMeixner-NOAA

The regression tests are as expected:

**********************************************************************
********************* non-identical cases ****************************
**********************************************************************
mww3_test_03/./work_PR2_UNO_MPI_d2                     (15 files differ)
mww3_test_03/./work_PR1_MPI_d2                     (16 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2_c                     (14 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2_c                     (15 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2                     (12 files differ)
mww3_test_03/./work_PR2_UQ_MPI_d2                     (15 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2                     (16 files differ)
ww3_ta1/./work_UPD0F_U                     (0 files differ)
ww3_tp2.10/./work_MPI_OMPH                     (7 files differ)
ww3_tp2.16/./work_MPI_OMPH                     (4 files differ)
ww3_tp2.17/./work_ma                     (1 files differ)
ww3_tp2.17/./work_a                     (1 files differ)
ww3_tp2.17/./work_mb                     (1 files differ)
ww3_tp2.17/./work_mc                     (1 files differ)
ww3_tp2.17/./work_c                     (1 files differ)
ww3_tp2.17/./work_b                     (1 files differ)
ww3_tp2.6/./work_ST0                     (1 files differ)
ww3_tp2.6/./work_ST4                     (1 files differ)
ww3_tp2.6/./work_pdlib                     (1 files differ)
ww3_ufs1.3/./work_a                     (1 files differ)

There are the known b4b cases + the unstructured mod_def files which have at times been not b4b lately.

JessicaMeixner-NOAA and others added 30 commits June 24, 2021 16:21

more updating and clean up of make_makefile

12dad7e

continue to make build script more modular

932d6aa

fix typo

078374f

Merge remote-tracking branch 'EMC/develop' into feature/expswitches

a07eae0

update README in bin directory to be formatted

683049e

This displays on GitHub in a nice way

Merge remote-tracking branch 'EMC/develop' into feature/cleanbuild

0a40d44

add to bin/README

38f615d

update readme for formatting

ca482a3

check in tools for ftn2src

bb74a1e

Merge remote-tracking branch 'EMC/develop' into feature/expswitches

b895120

Conflicts: model/bin/make_makefile.sh model/ftn/w3gdatmd.ftn model/ftn/w3gridmd.ftn model/ftn/w3iogrmd.ftn model/ftn/w3srcemd.ftn model/ftn/w3wavemd.ftn

Merge remote-tracking branch 'EMC/develop' into feature/expswitches

4e8383e

Merge remote-tracking branch 'EMC/develop' into feature/expswitches

c3a1012

Merge remote-tracking branch 'EMC/develop' into feature/expswitches

6a89c5d

remove variables and update mod_def date for xxx removal

ce92245

update w3gridmd for smc-- line should not be there

4d9769a

remove two FLXX calls

6c807c0

Merge remote-tracking branch 'EMC/develop' into feature/cleanbuild

7d400f8

Merge remote-tracking branch 'origin/feature/expswitches' into featur…

113ec02

…e/cleanbuild

Merge remote-tracking branch 'EMC/develop' into feature/cleanbuild

d5b0118

updates for build for recent commits

ad814d6

Merge remote-tracking branch 'EMC/develop' into feature/cleanbuild

402e287

update build with latest updates from develop which needed to be manu…

8d49d44

…ally updated

updating git ignore list

1e98e16

fix for build for NL5 and updating gitignore

26b2d79

Updated version number to 7.13

98c6b62

fix typo

34a9fe5

updates to sort_switch which allows w3_automake to work correctly

473134a

updating reg and netcdf program list in w3_automake

47c77ae

Merge remote-tracking branch 'origin/feature/cleanbuild' into version…

7a2ba5b

…7.13

committing testing build updates

6fa21d6

DeniseWorthen added 2 commits April 7, 2022 10:18

Merge branch 'dev/ufs-weather-model' into feature/cmake_meshcapbuild

8e2bad9

JessicaMeixner-NOAA requested changes Apr 20, 2022

View reviewed changes

DeniseWorthen added 3 commits April 21, 2022 17:47

address pr review comments

ab5f25f

* change cesmcoupled to w3_cesmcoupled * removed commented out line in w3init * mark sections which require fixes and testing for cesm

address pr comments

dd5e8e8

* remove marked sections for pr review

remove debugging statements for CESMCOUPLED

4eee787

JessicaMeixner-NOAA reviewed Apr 26, 2022

View reviewed changes

JessicaMeixner-NOAA self-requested a review May 4, 2022 16:49

alperaltuntas mentioned this pull request May 5, 2022

Merge mesh cap changes from (PR #641) ESCOMP/WW3#3

Merged

alperaltuntas added a commit to ESCOMP/WW3 that referenced this pull request May 5, 2022

Merge pull request #3 from ESCOMP/merge_cmake_meshcapbuild

20174e1

Merge mesh cap changes from (PR NOAA-EMC#641)

Merge branch 'dev/ufs-weather-model' into feature/cmake_meshcapbuild

097faf1

JessicaMeixner-NOAA approved these changes May 31, 2022

View reviewed changes

JessicaMeixner-NOAA merged commit ec5077a into NOAA-EMC:dev/ufs-weather-model May 31, 2022

DeniseWorthen deleted the feature/cmake_meshcapbuild branch November 3, 2022 15:07

DeniseWorthen restored the feature/cmake_meshcapbuild branch November 3, 2022 15:08

DeniseWorthen deleted the feature/cmake_meshcapbuild branch November 3, 2022 15:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add mesh cap #641

Add mesh cap #641

DeniseWorthen commented Mar 20, 2022 •

edited

Loading

JessicaMeixner-NOAA commented Apr 15, 2022

DeniseWorthen commented Apr 15, 2022

JessicaMeixner-NOAA commented Apr 15, 2022

mvertens commented Apr 15, 2022

JessicaMeixner-NOAA commented Apr 15, 2022

mvertens commented Apr 15, 2022

JessicaMeixner-NOAA left a comment

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA Apr 20, 2022

JessicaMeixner-NOAA left a comment

JessicaMeixner-NOAA left a comment


		end subroutine set_shel_io

		subroutine set_shel_inp(dtime_sync)

Add mesh cap #641

Add mesh cap #641

Conversation

DeniseWorthen commented Mar 20, 2022 • edited Loading

Pull Request Summary

Description

Issue(s) addressed

Commit Message

Check list

Testing

JessicaMeixner-NOAA commented Apr 15, 2022

DeniseWorthen commented Apr 15, 2022

JessicaMeixner-NOAA commented Apr 15, 2022

mvertens commented Apr 15, 2022

JessicaMeixner-NOAA commented Apr 15, 2022

mvertens commented Apr 15, 2022

JessicaMeixner-NOAA left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JessicaMeixner-NOAA left a comment

Choose a reason for hiding this comment

JessicaMeixner-NOAA left a comment

Choose a reason for hiding this comment

DeniseWorthen commented Mar 20, 2022 •

edited

Loading