WW3/w3nmltrncmd_8F90_source.html

#include "w3macros.h"

!/ ------------------------------------------------------------------- /

MODULE w3nmltrncmd

  !/

  !/                  +-----------------------------------+

  !/                  | WAVEWATCH III           NOAA/NCEP |

  !/                  |           M. Accensi              |

  !/                  |                                   |

  !/                  |                        FORTRAN 90 |

  !/                  | Last update :         15-May-2018 |

  !/                  +-----------------------------------+

  !/

  !/    For updates see subroutines.

  !/

  !  1. Purpose :

  !

  !     Manages namelists from configuration file ww3_trnc.nml for ww3_trnc program

  !

  !/ ------------------------------------------------------------------- /


  ! module defaults

  IMPLICIT NONE


  PUBLIC


  ! track structure

  TYPE nml_track_t

    CHARACTER(15)               :: timestart

    CHARACTER(15)               :: timestride

    CHARACTER(15)               :: timecount

    INTEGER                     :: timesplit

  END TYPE nml_track_t


  ! file structure

  TYPE nml_file_t

    CHARACTER(30)               :: prefix

    INTEGER                     :: netcdf

  END TYPE nml_file_t


  ! miscellaneous

  CHARACTER(256)                :: msg

  INTEGER                       :: ndsn


CONTAINS

  !/ ------------------------------------------------------------------- /

  SUBROUTINE w3nmltrnc (NDSI, INFILE, NML_TRACK, NML_FILE, IERR)

    !/

    !/                  +-----------------------------------+

    !/                  | WAVEWATCH III           NOAA/NCEP |

    !/                  |           M. Accensi              |

    !/                  |                                   |

    !/                  |                        FORTRAN 90 |

    !/                  | Last update :         15-May-2018 |

    !/                  +-----------------------------------+

    !/

    !

    !  1. Purpose :

    !

    !     Reads all the namelist to define the output track

    !

    !  2. Method :

    !

    !     See source term routines.

    !

    !  3. Parameters :

    !

    !     Parameter list

    !     ----------------------------------------------------------------

    !      NDSI        Int.

    !      INFILE      Char.

    !      NML_TRACK   type.

    !      NML_FILE    type.

    !      IERR        Int.

    !     ----------------------------------------------------------------

    !

    !  4. Subroutines used :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.

    !      READ_TRACK_NML

    !     ----------------------------------------------------------------

    !

    !  5. Called by :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      WW3_TRNC  Prog.   N/A    Postprocess output tracks.

    !     ----------------------------------------------------------------

    !

    !  6. Error messages :

    !

    !     None.

    !

    !  7. Remarks :

    !

    !  8. Structure :

    !

    !     See source code.

    !

    !  9. Switches :

    !

    ! 10. Source code :

    !

    !/ ------------------------------------------------------------------- /


    USE w3odatmd, ONLY: ndse

#ifdef W3_S

    USE w3servmd, ONLY: strace

#endif


    IMPLICIT NONE


    INTEGER, INTENT(IN)                         :: NDSI

    CHARACTER*(*), INTENT(IN)                   :: INFILE

    TYPE(nml_track_t), INTENT(INOUT)            :: NML_TRACK

    TYPE(nml_file_t), INTENT(INOUT)             :: NML_FILE

    INTEGER, INTENT(OUT)                        :: IERR

#ifdef W3_S

    INTEGER, SAVE                             :: IENT = 0

#endif


    ierr = 0

#ifdef W3_S

    CALL strace (ient, 'W3NMLTRNC')

#endif


    ! open namelist log file

    ndsn = 3

    OPEN (ndsn, file=trim(infile)//'.log', form='formatted', iostat=ierr)

    IF (ierr.NE.0) THEN

      WRITE (ndse,'(A)') 'ERROR: open full nml file '//trim(infile)//'.log failed'

      RETURN

    END IF


    ! open input file

    OPEN (ndsi, file=trim(infile), form='formatted', status='old', iostat=ierr)

    IF (ierr.NE.0) THEN

      WRITE (ndse,'(A)') 'ERROR: open input file '//trim(infile)//' failed'

      RETURN

    END IF


    ! read track namelist

    CALL read_track_nml (ndsi, nml_track)

    CALL report_track_nml (nml_track)


    ! read file namelist

    CALL read_file_nml (ndsi, nml_file)

    CALL report_file_nml (nml_file)


    ! close namelist files

    CLOSE (ndsi)

    CLOSE (ndsn)


  END SUBROUTINE w3nmltrnc


  !/ ------------------------------------------------------------------- /


  !/ ------------------------------------------------------------------- /


  SUBROUTINE read_track_nml (NDSI, NML_TRACK)

    !/

    !/                  +-----------------------------------+

    !/                  | WAVEWATCH III           NOAA/NCEP |

    !/                  |           M. Accensi              |

    !/                  |                                   |

    !/                  |                        FORTRAN 90 |

    !/                  | Last update :         15-May-2018 |

    !/                  +-----------------------------------+

    !/

    !  1. Purpose :

    !

    !

    !  2. Method :

    !

    !     See source term routines.

    !

    !  3. Parameters :

    !

    !     Parameter list

    !     ----------------------------------------------------------------

    !      NDSI         Int.

    !      NML_TRACK    Type.

    !     ----------------------------------------------------------------

    !

    !  4. Subroutines used :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.

    !     ----------------------------------------------------------------

    !

    !  5. Called by :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      W3NMLTRNC Subr.   N/A    Namelist configuration routine.

    !     ----------------------------------------------------------------

    !

    !  6. Error messages :

    !

    !     None.

    !

    !  7. Remarks :

    !

    !  8. Structure :

    !

    !     See source code.

    !

    !  9. Switches :

    !

    ! 10. Source code :

    !

    !/ ------------------------------------------------------------------- /


    USE w3odatmd, ONLY: ndse

    USE w3servmd, ONLY: extcde

#ifdef W3_S

    USE w3servmd, ONLY: strace

#endif


    IMPLICIT NONE


    INTEGER, INTENT(IN)                 :: NDSI

    TYPE(nml_track_t), INTENT(INOUT)    :: NML_TRACK

    INTEGER                             :: IERR


    ! locals

    TYPE(nml_track_t) :: TRACK

    namelist /track_nml/ track

#ifdef W3_S

    INTEGER, SAVE                           :: IENT = 0

#endif


    ierr = 0

#ifdef W3_S

    CALL strace (ient, 'READ_TRACK_NML')

#endif


    ! set default values for track structure

    track%TIMESTART  = '19000101 000000'

    track%TIMESTRIDE = '0'

    track%TIMECOUNT  = '1000000000'

    track%TIMESPLIT  = 6


    ! read track namelist

    rewind(ndsi)

    READ (ndsi, nml=track_nml, iostat=ierr, iomsg=msg)

    IF (ierr.NE.0) THEN

      WRITE (ndse,'(A,/A)') &

           'ERROR: READ_TRACK_NML: namelist read error', &

           'ERROR: '//trim(msg)

      CALL extcde (1)

    END IF


    ! save namelist

    nml_track = track


  END SUBROUTINE read_track_nml


  !/ ------------------------------------------------------------------- /


  !/ ------------------------------------------------------------------- /


  SUBROUTINE read_file_nml (NDSI, NML_FILE)

    !/

    !/                  +-----------------------------------+

    !/                  | WAVEWATCH III           NOAA/NCEP |

    !/                  |           M. Accensi              |

    !/                  |                                   |

    !/                  |                        FORTRAN 90 |

    !/                  | Last update :         15-May-2018 |

    !/                  +-----------------------------------+

    !/

    !  1. Purpose :

    !

    !

    !  2. Method :

    !

    !     See source term routines.

    !

    !  3. Parameters :

    !

    !     Parameter list

    !     ----------------------------------------------------------------

    !      NDSI         Int.

    !      NML_FILE     Type.

    !     ----------------------------------------------------------------

    !

    !  4. Subroutines used :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.

    !     ----------------------------------------------------------------

    !

    !  5. Called by :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      W3NMLTRNC Subr.   N/A    Namelist configuration routine.

    !     ----------------------------------------------------------------

    !

    !  6. Error messages :

    !

    !     None.

    !

    !  7. Remarks :

    !

    !  8. Structure :

    !

    !     See source code.

    !

    !  9. Switches :

    !

    ! 10. Source code :

    !

    !/ ------------------------------------------------------------------- /


    USE w3odatmd, ONLY: ndse

    USE w3servmd, ONLY: extcde

#ifdef W3_S

    USE w3servmd, ONLY: strace

#endif


    IMPLICIT NONE


    INTEGER, INTENT(IN)                 :: NDSI

    TYPE(nml_file_t), INTENT(INOUT)     :: NML_FILE

    INTEGER                             :: IERR


    ! locals

    TYPE(nml_file_t) :: FILE

    namelist /file_nml/ file

#ifdef W3_S

    INTEGER, SAVE                           :: IENT = 0

#endif


    ierr = 0

#ifdef W3_S

    CALL strace (ient, 'READ_FILE_NML')

#endif


    ! set default values for file structure

    file%PREFIX    = 'ww3.'

    file%NETCDF    = 3


    ! read file namelist

    rewind(ndsi)

    READ (ndsi, nml=file_nml, iostat=ierr, iomsg=msg)

    IF (ierr.GT.0) THEN

      WRITE (ndse,'(A,/A)') &

           'ERROR: READ_FILE_NML: namelist read error', &

           'ERROR: '//trim(msg)

      CALL extcde (2)

    END IF


    ! save namelist

    nml_file = file


  END SUBROUTINE read_file_nml


  !/ ------------------------------------------------------------------- /


  !/ ------------------------------------------------------------------- /


  SUBROUTINE report_track_nml (NML_TRACK)

    !/

    !/                  +-----------------------------------+

    !/                  | WAVEWATCH III           NOAA/NCEP |

    !/                  |           M. Accensi              |

    !/                  |                        FORTRAN 90 |

    !/                  | Last update :         15-May-2018 |

    !/                  +-----------------------------------+

    !/

    !/

    !  1. Purpose :

    !

    !

    !  2. Method :

    !

    !     See source term routines.

    !

    !  3. Parameters :

    !

    !     Parameter list

    !     ----------------------------------------------------------------

    !      NML_TRACK  Type.

    !     ----------------------------------------------------------------

    !

    !  4. Subroutines used :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.

    !     ----------------------------------------------------------------

    !

    !  5. Called by :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      W3NMLTRNC Subr.   N/A    Namelist configuration routine.

    !     ----------------------------------------------------------------

    !

    !  6. Error messages :

    !

    !     None.

    !

    !  7. Remarks :

    !

    !  8. Structure :

    !

    !     See source code.

    !

    !  9. Switches :

    !

    ! 10. Source code :

    !

    !/ ------------------------------------------------------------------- /


#ifdef W3_S

    USE w3servmd, ONLY: strace

#endif


    IMPLICIT NONE


    TYPE(nml_track_t), INTENT(IN) :: NML_TRACK

#ifdef W3_S

    INTEGER, SAVE                           :: IENT = 0

#endif


#ifdef W3_S

    CALL strace (ient, 'REPORT_TRACK_NML')

#endif


    WRITE (msg,'(A)') 'TRACK % '

    WRITE (ndsn,'(A)')

    WRITE (ndsn,10) trim(msg),'TIMESTART  = ', trim(nml_track%TIMESTART)

    WRITE (ndsn,10) trim(msg),'TIMESTRIDE = ', trim(nml_track%TIMESTRIDE)

    WRITE (ndsn,10) trim(msg),'TIMECOUNT  = ', trim(nml_track%TIMECOUNT)


    WRITE (ndsn,11) trim(msg),'TIMESPLIT  = ', nml_track%TIMESPLIT


10  FORMAT (a,2x,a,a)

11  FORMAT (a,2x,a,i8)


  END SUBROUTINE report_track_nml


  !/ ------------------------------------------------------------------- /


  !/ ------------------------------------------------------------------- /


  SUBROUTINE report_file_nml (NML_FILE)

    !/

    !/                  +-----------------------------------+

    !/                  | WAVEWATCH III           NOAA/NCEP |

    !/                  |           M. Accensi              |

    !/                  |                        FORTRAN 90 |

    !/                  | Last update :         15-May-2018 |

    !/                  +-----------------------------------+

    !/

    !/

    !  1. Purpose :

    !

    !

    !  2. Method :

    !

    !     See source term routines.

    !

    !  3. Parameters :

    !

    !     Parameter list

    !     ----------------------------------------------------------------

    !      NML_FILE  Type.

    !     ----------------------------------------------------------------

    !

    !  4. Subroutines used :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.

    !     ----------------------------------------------------------------

    !

    !  5. Called by :

    !

    !      Name      TYPE  Module   Description

    !     ----------------------------------------------------------------

    !      W3NMLTRNC Subr.   N/A    Namelist configuration routine.

    !     ----------------------------------------------------------------

    !

    !  6. Error messages :

    !

    !     None.

    !

    !  7. Remarks :

    !

    !  8. Structure :

    !

    !     See source code.

    !

    !  9. Switches :

    !

    ! 10. Source code :

    !

    !/ ------------------------------------------------------------------- /


#ifdef W3_S

    USE w3servmd, ONLY: strace

#endif


    IMPLICIT NONE


    TYPE(nml_file_t), INTENT(IN) :: NML_FILE

#ifdef W3_S

    INTEGER, SAVE                           :: IENT = 0

#endif


#ifdef W3_S

    CALL strace (ient, 'REPORT_FILE_NML')

#endif


    WRITE (msg,'(A)') 'FILE % '

    WRITE (ndsn,'(A)')

    WRITE (ndsn,10) trim(msg),'PREFIX    = ', trim(nml_file%PREFIX)

    WRITE (ndsn,11) trim(msg),'NETCDF    = ', nml_file%NETCDF


10  FORMAT (a,2x,a,a)

11  FORMAT (a,2x,a,i8)


  END SUBROUTINE report_file_nml


  !/ ------------------------------------------------------------------- /


END MODULE w3nmltrncmd


!/ ------------------------------------------------------------------- /