From cc13238eab852b84d0ab16e3ccbc5a8da636961a Mon Sep 17 00:00:00 2001 From: Matthew Masarik Date: Mon, 6 Nov 2023 17:26:03 +0000 Subject: [PATCH 1/4] start adding doxygen variable descriptions --- model/src/w3iopomd.F90 | 26 +++++++++++++------------- 1 file changed, 13 insertions(+), 13 deletions(-) diff --git a/model/src/w3iopomd.F90 b/model/src/w3iopomd.F90 index ace363528..ed5bdb0cb 100644 --- a/model/src/w3iopomd.F90 +++ b/model/src/w3iopomd.F90 @@ -1035,8 +1035,8 @@ END SUBROUTINE W3IOPE !> SUBROUTINE W3IOPON_READ (NDSOP, IOTST, IMOD) IMPLICIT NONE - - INTEGER, INTENT(IN) :: NDSOP + + INTEGER, INTENT(IN) :: NDSOP INTEGER, INTENT(OUT) :: IOTST INTEGER, INTENT(IN), OPTIONAL :: IMOD @@ -1063,8 +1063,8 @@ SUBROUTINE W3IOPON_WRITE (NDSOP, IMOD, filename, ncerr) ASO, CAO, CDO, SPCO, PTNME, O2INIT, FNMPRE, & GRDID, ICEO, ICEHO, ICEFO IMPLICIT NONE - - INTEGER, INTENT(IN) :: NDSOP + + INTEGER, INTENT(IN) :: NDSOP INTEGER, INTENT(IN) :: IMOD character(*), intent(in) :: filename integer, intent(inout) :: ncerr @@ -1185,9 +1185,9 @@ SUBROUTINE W3IOPON ( INXOUT, NDSOP, IOTST, IMOD & USE W3SERVMD, ONLY: STRACE #endif IMPLICIT NONE - + CHARACTER, INTENT(IN) :: INXOUT*(*) - INTEGER, INTENT(IN) :: NDSOP + INTEGER, INTENT(IN) :: NDSOP INTEGER, INTENT(OUT) :: IOTST INTEGER, INTENT(IN), OPTIONAL :: IMOD #ifdef W3_ASCII @@ -1199,7 +1199,7 @@ SUBROUTINE W3IOPON ( INXOUT, NDSOP, IOTST, IMOD & ! Optimistically assume success. IOTST = 0 - + ! Has a model number been specified? IF (PRESENT(IMOD)) THEN IGRD = IMOD @@ -1221,13 +1221,13 @@ SUBROUTINE W3IOPON ( INXOUT, NDSOP, IOTST, IMOD & IF (INXOUT .EQ. 'READ') THEN CALL W3IOPON_READ(NDSOP, IOTST, IMOD) ELSE - CALL W3IOPON_WRITE(NDSOP, IMOD, 'ww3_out_pnt.nc', ncerr) + CALL W3IOPON_WRITE(NDSOP, IMOD, 'ww3_out_pnt.nc', ncerr) ENDIF - + !/ !/ End of W3IOPON ----------------------------------------------------- / !/ - + 900 FORMAT (/' *** WAVEWATCH III ERROR IN W3IOPO :'/ & ' ILEGAL INXOUT VALUE: ',A/) END SUBROUTINE W3IOPON @@ -1251,8 +1251,8 @@ END SUBROUTINE W3IOPON !> Each record contains: !> Size (bytes) | Type | Variable | Meaning !> -------------|------|----------|-------- - !> 4 | integer | IW | ??? - !> 4 | integer | II | ??? + !> 4 | integer | IW | Id. water + !> 4 | integer | II | Id. iceP !> 4 | integer | IL | ??? !> 4 | integer | DPO | ??? !> 4 | integer | WAO | ??? @@ -1691,7 +1691,7 @@ SUBROUTINE W3IOPO ( INXOUT, NDSOP, IOTST, IMOD & #endif 'ASO(I), CAO(I), CDO(I), ICEO(I), ICEHO(I):', & ASO(I), CAO(I), CDO(I), ICEO(I), ICEHO(I), & - 'ICEFO(I), GRDID(I), (SPCO(J,I),J=1,NSPEC):', & + 'ICEFO(I), GRDID(I), (SPCO(J,I),J=1,NSPEC):', & ICEFO(I), GRDID(I), (SPCO(J,I),J=1,NSPEC) #endif ELSE From ed034480f99a041a4d10fec42636e854463408c3 Mon Sep 17 00:00:00 2001 From: Matthew Masarik Date: Mon, 6 Nov 2023 18:19:21 +0000 Subject: [PATCH 2/4] w3iopomd.F90: documentation update --- model/src/w3iopomd.F90 | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/model/src/w3iopomd.F90 b/model/src/w3iopomd.F90 index ed5bdb0cb..239ec637a 100644 --- a/model/src/w3iopomd.F90 +++ b/model/src/w3iopomd.F90 @@ -1251,9 +1251,9 @@ END SUBROUTINE W3IOPON !> Each record contains: !> Size (bytes) | Type | Variable | Meaning !> -------------|------|----------|-------- - !> 4 | integer | IW | Id. water - !> 4 | integer | II | Id. iceP - !> 4 | integer | IL | ??? + !> 4 | integer | IW | Number of water points in interpolation box for output point. + !> 4 | integer | II | Number of ice points in interpolation box for output point. + !> 4 | integer | IL | Number of land points in interpolation box for output point. !> 4 | integer | DPO | ??? !> 4 | integer | WAO | ??? !> 4 | integer | WDO | ??? From 12d44c6f6c38f7bf43744590804305abcff7e449 Mon Sep 17 00:00:00 2001 From: Matthew Masarik Date: Mon, 6 Nov 2023 18:43:58 +0000 Subject: [PATCH 3/4] w3iopomd.F90: updates to w3iopomd.F90 for documentation. --- model/src/w3iopomd.F90 | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/model/src/w3iopomd.F90 b/model/src/w3iopomd.F90 index 239ec637a..67b0f0807 100644 --- a/model/src/w3iopomd.F90 +++ b/model/src/w3iopomd.F90 @@ -1254,21 +1254,21 @@ END SUBROUTINE W3IOPON !> 4 | integer | IW | Number of water points in interpolation box for output point. !> 4 | integer | II | Number of ice points in interpolation box for output point. !> 4 | integer | IL | Number of land points in interpolation box for output point. - !> 4 | integer | DPO | ??? - !> 4 | integer | WAO | ??? - !> 4 | integer | WDO | ??? - !> 4 | integer | TAUAO | (W3_FLX5 only) ??? - !> 4 | integer | TAIDO | (W3_FLX5 only) ??? - !> 4 | integer | DAIRO | (W3_FLX5 only) ??? - !> 4 | integer | ZET_SETO | (W3_SETUP only) ??? - !> 4 | integer | ASO | ??? - !> 4 | integer | CAO | ??? - !> 4 | integer | CDO | ??? - !> 4 | integer | ICEO | ??? - !> 4 | integer | ICEHO | ??? - !> 4 | integer | ICEFO | ??? - !> 4 | integer | GRDID | ??? - !> 4 | integer | SPCO(J,I),J=1,NSPEC | ??? + !> 4 | real | DPO | Interpolated depths. + !> 4 | real | WAO | Interpolated wind speeds. + !> 4 | real | WDO | Interpolated wind directions. + !> 4 | real | TAUAO | (W3_FLX5 only) Interpolated atmospheric stresses. + !> 4 | real | TAUDO | (W3_FLX5 only) Interpolated atmospheric stress directions. + !> 4 | real | DAIRO | (W3_FLX5 only) Interpolated rho atmosphere. + !> 4 | real | ZET_SETO | (W3_SETUP only) ??? + !> 4 | real | ASO | Interpolated air-sea temperature difference + !> 4 | real | CAO | Interpolated current speeds. + !> 4 | real | CDO | Interpolated current directions. + !> 4 | real | ICEO | Interpolated ice concentration. + !> 4 | real | ICEHO | Interpolated ice thickness. + !> 4 | real | ICEFO | Interpolated ice floe. + !> 13 | char | GRDID | Originating grid ID + !> 4 | real | SPCO(J,I),J=1,NSPEC | Output spectra !> !> In the event of error, EXTCDE() will be called with the following exit codes: !> - 1 INXOUT must be 'READ' or 'WRITE'. From 8359f15d0050bf6077130aa7f4db4656067dd118 Mon Sep 17 00:00:00 2001 From: Matthew Masarik Date: Mon, 6 Nov 2023 19:57:01 +0000 Subject: [PATCH 4/4] w3iopomd.F90: a couple more definitions --- model/src/w3iopomd.F90 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/model/src/w3iopomd.F90 b/model/src/w3iopomd.F90 index 67b0f0807..d4f3d6003 100644 --- a/model/src/w3iopomd.F90 +++ b/model/src/w3iopomd.F90 @@ -1239,10 +1239,10 @@ END SUBROUTINE W3IOPON !> Size (bytes) | Type | Variable | Meaning !> -------------|------|----------|-------- !> 40 | character*40 | IDTST | ID string - !> 4 | integer | VERTST | version of test? - !> 4 | integer | NK | ??? - !> 4 | integer | MTH | ??? - !> 4 | integer | NOPTS | ??? + !> 10 | character*10 | VERTST | version of test?? + !> 4 | integer | NK | Number of discrete wavenumbers. + !> 4 | integer | NTH | Number of discrete directions. + !> 4 | integer | NOPTS | Number of output points. !> 8*NOPTS | integer(2,NOPTS) | PTLOC | Point locations !> 7*NOPTS | character*7 | PTNME | Point names !> 8 | integer(2) | TIME | Time