Write log files for all output to indicate it's finished

[mingchen-NOAA]

Pull Request Summary

This pull request introduces a new feature that generates log files for all time-tagged gridded and point NetCDF outputs to indicate successful completion. The source code in w3iogomd.F90 and w3iopomd.F90 has been modified to implement this functionality. When a time-tagged gridded or point NetCDF output is successfully written, a corresponding log file will be created with the naming conventions YYYYMMDD.HHMMSS.out_pnt.ww3.nc.log.txt for point or YYYYMMDD.HHMMSS.out_grd.ww3.log.txt for gridded outputs. The log files will be stored with the output files in a user-defined directory (./ for default).

Description

Issue(s) addressed

Addressing issue #921

Commit Message

write log files to indicate output files have been fully written

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?
  In matrix

• Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
  No, regression tests did not have time-tagged outputs. The point NetCDF log feature has been tested using a modified regression test ww3_ufs1.1 (PR Optimized ww3_outp for the netcdf point output #1365) which is under review

• Have the matrix regression tests been run (if yes, please note HPC and compiler)?
  Yes, Orion

• Please indicate the expected changes in the regression test output, (Note the list of known non-identical tests.)

• Please provide the summary output of matrix.comp (matrix.Diff.txt, matrixCompFull.txt and matrixCompSummary.txt):

---

********************* non-identical cases ****************************

---

mww3_test_03/./work_PR1_MPI_d2 (16 files differ)
mww3_test_03/./work_PR3_UNO_MPI_e_c (1 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2 (16 files differ)
mww3_test_03/./work_PR2_UNO_MPI_d2 (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_c (15 files differ)
mww3_test_03/./work_PR2_UNO_MPI_e (1 files differ)
mww3_test_03/./work_PR3_UQ_MPI_e_c (1 files differ)
mww3_test_03/./work_PR3_UNO_MPI_e (1 files differ)
mww3_test_03/./work_PR2_UQ_MPI_e (1 files differ)
mww3_test_03/./work_PR1_MPI_e (1 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2_c (15 files differ)
mww3_test_09/./work_MPI_ASCII (0 files differ)
ww3_tp2.10/./work_MPI_OMPH (7 files differ)
ww3_tp2.16/./work_MPI_OMPH (4 files differ)
ww3_tp2.6/./work_ST4_ASCII (0 files differ)
ww3_ufs1.3/./work_a (3 files differ)

matrixCompFull.txt
matrixCompSummary.txt
matrixDiff.txt

[JessicaMeixner-NOAA]

@aerorahul and @WalterKolczynski-NOAA - Before this PR is merged, we wanted to confirm with you that the naming for the logs are okay for GFSv17/GEFSv13. The log file names are in bold for gridded and point output in the description. If other names are preferred, please let us know.

Note, this will then need to be merged into the dev/ufs-waether-model branch which is used in the ufs-weather-model, so this will not be immediately available for the workflow, but we are working to get this done as soon as possible.

If you have any comments/questions/etc please don't hesitate to ask.

[aerorahul]

@aerorahul and @WalterKolczynski-NOAA - Before this PR is merged, we wanted to confirm with you that the naming for the logs are okay for GFSv17/GEFSv13. The log file names are in bold for gridded and point output in the description. If other names are preferred, please let us know.

Note, this will then need to be merged into the dev/ufs-waether-model branch which is used in the ufs-weather-model, so this will not be immediately available for the workflow, but we are working to get this done as soon as possible.

If you have any comments/questions/etc please don't hesitate to ask.

@JessicaMeixner-NOAA
Thanks for asking.
I guess my suggestion would be to stay consistent between the point and grid output log filenames.
YYYYMMDD.HHMMSS.out_pnt.ww3.log.txt for point and YYYYMMDD.HHMMSS.out_grd.ww3.log.txt
The point log file has a .nc in its name.
Another suggestion if we wish to see consistency with the ufs-weather-model write grid component generated log files for the atmosphere component, is to prefix the file with log. instead of it being in the middle of the filename. E.g.
log.YYYYMMDD.HHMMSS.out_pnt.ww3.txt and log.YYYYMMDD.HHMMSS.out_grd.ww3.txt

[JessicaMeixner-NOAA]

Thanks for the feedback @aerorahul

@mingchen-NOAA -Can you make these suggested changes so that we're more consistent with the other ufs components?

[mingchen-NOAA]

Will do. Thank you for the suggestions.

[mingchen-NOAA]

Done. Now the log name should be
log.yyyymmdd.hhmmss.out_pnt.ww3.txt and log.yyyymmdd.hhmmss.out_grd.ww3.txt