Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Doxygen documentation 8th subset #1046

Merged

Conversation

MatthewMasarik-NOAA
Copy link
Collaborator

@MatthewMasarik-NOAA MatthewMasarik-NOAA commented Jul 26, 2023

Pull Request Summary

Doxygen documentation has been added for a subset of source files.

Description

The following 13 files have been marked up with doxygen tags:

  • w3sdb1md.F90
  • w3sbt9md.F90
  • w3sbt8md.F90
  • w3sbt4md.F90
  • w3sbt1md.F90
  • w3ref1md.F90
  • w3pro3md.F90
  • w3pro2md.F90
  • w3pro1md.F90
  • gx_outf.F90
  • gx_outp.F90
  • w3canomd.F90
  • w3parall.F90

Please also include the following information:

  • Add any suggestions for a reviewer
    • No rush on reviewing this PR. This had been 90% done for awhile and I just wanted it off my hands.
  • Mention any labels that should be added:
    • documentation.
  • Are answer changes expected from this PR?
    • No.

Issue(s) addressed

Commit Message

Doxygen documentation added, 8th subset.

Check list

Testing

  • How were these changes tested?
  • Are the changes covered by regression tests? (If not, why? Do new tests need to be added?)
    • No. Documentation is not tested.
  • Have the matrix regression tests been run (if yes, please note HPC and compiler)?
    • Yes, hera intel.
  • Please indicate the expected changes in the regression test output, (Note the list of known non-identical tests.)
    • Only the known non-b4b changes are expected.
  • 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_e                     (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_PR2_UNO_MPI_e                     (1 files differ)      
mww3_test_03/./work_PR2_UNO_MPI_d2                     (18 files differ)    
mww3_test_03/./work_PR1_MPI_d2                     (9 files differ)         
mww3_test_03/./work_PR3_UNO_MPI_d2_c                     (17 files differ)  
mww3_test_03/./work_PR3_UQ_MPI_d2_c                     (15 files differ)   
mww3_test_03/./work_PR3_UNO_MPI_d2                     (9 files differ)     
mww3_test_03/./work_PR2_UQ_MPI_d2                     (14 files differ)     
mww3_test_03/./work_PR3_UQ_MPI_d2                     (15 files differ)     
ww3_tp2.10/./work_MPI_OMPH                     (7 files differ)             
ww3_tp2.16/./work_MPI_OMPH                     (4 files differ)             
ww3_ufs1.3/./work_a                     (3 files differ)                    
                                                                            
**********************************************************************      
************************ identical cases *****************************      
**********************************************************************

Copy link
Collaborator

@JessicaMeixner-NOAA JessicaMeixner-NOAA left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

matrixCompFull.txt
matrixCompSummary.txt
matrixDiff.txt

results as expected:

**********************************************************************
********************* non-identical cases ****************************
**********************************************************************
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_PR2_UNO_MPI_d2                     (15 files differ)
mww3_test_03/./work_PR1_MPI_d2                     (9 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2_c                     (10 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2_c                     (14 files differ)
mww3_test_03/./work_PR3_UNO_MPI_d2                     (17 files differ)
mww3_test_03/./work_PR2_UQ_MPI_d2                     (16 files differ)
mww3_test_03/./work_PR3_UQ_MPI_e                     (1 files differ)
mww3_test_03/./work_PR3_UQ_MPI_d2                     (15 files differ)
ww3_tp2.10/./work_MPI_OMPH                     (7 files differ)
ww3_tp2.16/./work_MPI_OMPH                     (4 files differ)
ww3_ufs1.3/./work_a                     (3 files differ)

@JessicaMeixner-NOAA JessicaMeixner-NOAA merged commit 2715a9e into NOAA-EMC:develop Aug 7, 2023
@MatthewMasarik-NOAA MatthewMasarik-NOAA deleted the doc/doxygen8 branch September 14, 2023 14:02
miguelsolanocordoba added a commit to wavespotter/WW3 that referenced this pull request Apr 19, 2024
* Bugfix - initialised VD and VS to zero in w3srcemd. (NOAA-EMC#1037)

* More efficient test for binary files in matrix.comp (NOAA-EMC#1035)

* Tidy up of pre-processor directives and unused variables in w3srcemd.F90 (NOAA-EMC#1010)

* Correct typo in w3srcemd.F90 pre-processor directive. (NOAA-EMC#1039)

* minor bugfix for matrix grepping on keywords (NOAA-EMC#1049)

* Stop masking group 1 output where icec > icen (NOAA-EMC#1019)

* Doxygen documentation added, 8th subset.(NOAA-EMC#1046)

* NC4 ,F90 ,XX0 switches removed from ww3_tp2.19 regtest (NOAA-EMC#1054)

* CI:  Fix for Intel scripts. GNU scripts updated. (NOAA-EMC#1064)

* correct the computation of QP parameter, add QKK output parameter, change UST scale factor (NOAA-EMC#1050)

* correct issue with ww3_multi when requesting restart2 and using nml file instead of inp file (NOAA-EMC#1070)

* correct calendar for track netcdf output (NOAA-EMC#1079)

* Fix missing mod_def.ww3 file in multigrid regression tests for track output (NOAA-EMC#1091)

* STAB3: fix cmake build for ST4 or ST3 (NOAA-EMC#1086)

* new feature to output out_grd.ww3, out_pnt.ww3 and mod_def.ww3 both in binary and ascii format using switch ASCII. (NOAA-EMC#1089)

* Update local unit number arrays (NDS, MDS) to be same size of array defined in w3odatmd (size=15). Also, defined unit numbers for NDS(14) and NDS(15). (NOAA-EMC#1098)

* Removed code referencing PHIOC in output section for PHICE in ww3_ounf (NOAA-EMC#1093)

* implementation of the GQM (Gaussian Quadrature Method) to replace the DIA in NL1 or NL2. (NOAA-EMC#1083)

* update logic to ensure you are not accessing uninitialized dates (NOAA-EMC#1114)

* Initialised S and D arrays in W3SDB1 before potential early return if zero energy. (NOAA-EMC#1115)

* ww3_ounp.F90:  x/y units attribute corrected from 'm' to 'km' (NOAA-EMC#1088)

* Bugfix: Assign unit numbers to ASCII gridded/point output in multi-grid mode. (NOAA-EMC#1118)

* correct bugs to run correctly GQM implementation (NOAA-EMC#1127)

* Adding documentation to w3iopo() in preparation for code for NOAA-EMC#682. (NOAA-EMC#1131)

* NCEP regtest module updates: uses spack-stack/1.5.0, includes scotch/7.0.4 (NOAA-EMC#1137)

* Minor update to ncep regtests (NOAA-EMC#1138)

* Updated intel workflow to install oneapi compilers from new location. (NOAA-EMC#1157)

* Add unit test for points I/O code. (NOAA-EMC#1158)

* Update Intel CI (relocate /usr/local; ensure intel-oneapi-mpi; use ubuntu-latest) (NOAA-EMC#1161)

* remove lookup table for ST4 to speed up computation and clean up the ST4 code (NOAA-EMC#1124)

Co-authored-by: Fabrice Ardhuin <fabrice.ardhuin@ifremer.fr>

* initialize USSP_WN for mod_def (NOAA-EMC#1165)

* Introduce IC4M8 and IC4M9 to WW3 (NOAA-EMC#1176)

* clean up and add ST4 variables (NOAA-EMC#1181)

* w3fld1md.F90: fix divide by zero in CRIT2 parameter (NOAA-EMC#1184)

* ww3_prnc.F90: fix out-of-scope grid index write statement (NOAA-EMC#1185)

* Bugfix: address potential divide-by-zero in APPENDTAIL (NOAA-EMC#1188)

Co-authored-by: Denise Worthen <denise.worthen@noaa.gov>

* Provide initial drying of cells with depth < ZLIM for SMC grid. (NOAA-EMC#1192)

* Output OMP threading info to screen when running ww3_shel/ww3_multi compiled with the OMPG switch. Also fixes truncation of build.log when running run_cmake_build. (NOAA-EMC#1191)

* Added screen output showing number of threads when OMP enabled.

* update build to get more info in logs (NOAA-EMC#46)

---------

Co-authored-by: Jessica Meixner <jessica.meixner@noaa.gov>

* update run_cmake_test to catch build errors and exit (NOAA-EMC#1194)

* fix merge conflicts

* Fix gustiness bug, as suggst by Pieter

* Change USTARsigma to WAM implementation

---------

Co-authored-by: Chris Bunney <48915820+ukmo-ccbunney@users.noreply.github.com>
Co-authored-by: Mickael Accensi <49198861+mickaelaccensi@users.noreply.github.com>
Co-authored-by: Benoit Pouliot <51411504+benoitp-cmc@users.noreply.github.com>
Co-authored-by: Matthew Masarik <86749872+MatthewMasarik-NOAA@users.noreply.github.com>
Co-authored-by: Ghazal-Mohammadpour <124626872+Ghazal-Mohammadpour@users.noreply.github.com>
Co-authored-by: Jessica Meixner <jessica.meixner@noaa.gov>
Co-authored-by: Biao Zhao <zhaobiaodeyouxiang@163.com>
Co-authored-by: Edward Hartnett <38856240+edwardhartnett@users.noreply.github.com>
Co-authored-by: Alex Richert <82525672+AlexanderRichert-NOAA@users.noreply.github.com>
Co-authored-by: Fabrice Ardhuin <fabrice.ardhuin@ifremer.fr>
Co-authored-by: W. Erick Rogers <156342000+ErickRogers@users.noreply.github.com>
Co-authored-by: Denise Worthen <denise.worthen@noaa.gov>
Co-authored-by: Camille Teicheira <cteicheira@gmail.com>
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants