w3nmlounfmd.F90

Go to the documentation of this file.

#include "w3macros.h"
!/ ------------------------------------------------------------------- /
MODULE w3nmlounfmd
  !/
  !/                  +-----------------------------------+
  !/                  | WAVEWATCH III           NOAA/NCEP |
  !/                  |           M. Accensi              |
  !/                  |                                   |
  !/                  |                        FORTRAN 90 |
  !/                  | Last update :         12-Jan-2021 |
  !/                  +-----------------------------------+
  !/
  !/    For updates see subroutines.
  !/
  !  1. Purpose :
  !
  !     Manages namelists from configuration file ww3_ounf.nml for ww3_ounf program
  !
  !/ ------------------------------------------------------------------- /
 
  ! module defaults
  IMPLICIT NONE
 
  PUBLIC
 
  ! field structure
  TYPE nml_field_t
    CHARACTER(15)               :: timestart
    CHARACTER(15)               :: timestride
    CHARACTER(15)               :: timecount
    INTEGER                     :: timesplit
    CHARACTER(1024)             :: list
    CHARACTER(15)               :: partition
    LOGICAL                     :: samefile
    LOGICAL                     :: vector
    INTEGER                     :: type
    CHARACTER(15)               :: timeref
    LOGICAL                     :: fcvars
    CHARACTER                   :: timevar
    CHARACTER                   :: timeunit
    CHARACTER(15)               :: timeepoch
    REAL                        :: noval
    LOGICAL                     :: mapsta
  END TYPE nml_field_t
 
  ! file structure
  TYPE nml_file_t
    CHARACTER(30)               :: prefix
    INTEGER                     :: netcdf
    INTEGER                     :: ix0
    INTEGER                     :: ixn
    INTEGER                     :: iy0
    INTEGER                     :: iyn
  END TYPE nml_file_t
 
  ! smc grid structure
  TYPE nml_smc_t
    INTEGER                     :: type
    REAL                        :: sxo
    REAL                        :: syo
    REAL                        :: exo
    REAL                        :: eyo
    INTEGER                     :: celfac
  END TYPE nml_smc_t
 
  ! miscellaneous
  CHARACTER(256)                :: msg
  INTEGER                       :: ndsn
 
 
 
 
CONTAINS
  !/ ------------------------------------------------------------------- /
  SUBROUTINE w3nmlounf (NDSI, INFILE, NML_FIELD, NML_FILE, NML_SMC, IERR)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                                   |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         12-Jan-2021 |
    !/                  +-----------------------------------+
    !/
    !
    !  1. Purpose :
    !
    !     Reads all the namelist to define the output field
    !
    !  2. Method :
    !
    !     See source term routines.
    !
    !  3. Parameters :
    !
    !     Parameter list
    !     ----------------------------------------------------------------
    !      NDSI        Int.
    !      INFILE      Char.
    !      NML_FIELD   type.
    !      NML_FILE    type.
    !      NML_SMC     type.
    !      IERR        Int.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !      READ_FIELD_NML
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      WW3_OUNF  Prog.   N/A    Postprocess output fields.
    !     ----------------------------------------------------------------
    !
    !  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_field_t), INTENT(INOUT)            :: NML_FIELD
    TYPE(nml_file_t), INTENT(INOUT)             :: NML_FILE
    TYPE(nml_smc_t), INTENT(INOUT)              :: NML_SMC
    INTEGER, INTENT(OUT)                        :: IERR
#ifdef W3_S
    INTEGER, SAVE                             :: IENT = 0
#endif
 
    ierr = 0
#ifdef W3_S
    CALL strace (ient, 'W3NMLOUNF')
#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 field namelist
    CALL read_field_nml (ndsi, nml_field)
    CALL report_field_nml (nml_field)
 
    ! read file namelist
    CALL read_file_nml (ndsi, nml_file)
    CALL report_file_nml (nml_file)
 
    ! read smc namelist
    CALL read_smc_nml (ndsi, nml_smc)
    CALL report_smc_nml (nml_smc)
 
    ! close namelist files
    CLOSE (ndsi)
    CLOSE (ndsn)
 
  END SUBROUTINE w3nmlounf
 
 
  !/ ------------------------------------------------------------------- /
 
 
 
 
 
 
  !/ ------------------------------------------------------------------- /
 
  SUBROUTINE read_field_nml (NDSI, NML_FIELD)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                                   |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         12-Jan-2021 |
    !/                  +-----------------------------------+
    !/
    !  1. Purpose :
    !
    !
    !  2. Method :
    !
    !     See source term routines.
    !
    !  3. Parameters :
    !
    !     Parameter list
    !     ----------------------------------------------------------------
    !      NDSI         Int.
    !      NML_FIELD    Type.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      W3NMLOUNF 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
    USE constants, ONLY: undef
 
    IMPLICIT NONE
 
    INTEGER, INTENT(IN)                 :: NDSI
    TYPE(nml_field_t), INTENT(INOUT)    :: NML_FIELD
 
    ! locals
    INTEGER                                :: IERR
    TYPE(nml_field_t) :: FIELD
    namelist /field_nml/ field
#ifdef W3_S
    INTEGER, SAVE                           :: IENT = 0
#endif
 
    ierr = 0
#ifdef W3_S
    CALL strace (ient, 'READ_FIELD_NML')
#endif
 
    ! set default values for field structure
    field%TIMESTART  = '19000101 000000'
    field%TIMESTRIDE = '0'
    field%TIMECOUNT  = '1000000000'
    field%TIMESPLIT  = 6
    field%LIST       = 'unset'
    field%PARTITION  = '0 1 2 3'
    field%SAMEFILE   = .true.
    field%VECTOR     = .true.
    field%TYPE       = 3
    field%TIMEREF    = 'unset'
    field%FCVARS     = .false.
    field%TIMEVAR    = 'D'
    field%TIMEUNIT   = 'D'
    field%TIMEEPOCH  = '19900101 000000'
    field%NOVAL      = undef
    field%MAPSTA     = .true.
 
    ! read field namelist
    rewind(ndsi)
    READ (ndsi, nml=field_nml, iostat=ierr, iomsg=msg)
    IF (ierr.NE.0) THEN
      WRITE (ndse,'(A,/A)') &
           'ERROR: READ_FIELD_NML: namelist read error', &
           'ERROR: '//trim(msg)
      CALL extcde (1)
    END IF
 
    ! Default forecast reference time to start time
    IF(field%TIMEREF == 'unset') field%TIMEREF = field%TIMESTART
 
    ! save namelist
    nml_field = field
 
  END SUBROUTINE read_field_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
    !     ----------------------------------------------------------------
    !      W3NMLOUNF 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
 
    ! locals
    INTEGER                                :: IERR
    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
    file%IX0       = 1
    file%IXN       = 1000000000
    file%IY0       = 1
    file%IYN       = 1000000000
 
    ! 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 read_smc_nml (NDSI, NML_SMC)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                                   |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         19-Sep-2018 |
    !/                  +-----------------------------------+
    !/
    !  1. Purpose :
    !
    !
    !  2. Method :
    !
    !     See source term routines.
    !
    !  3. Parameters :
    !
    !     Parameter list
    !     ----------------------------------------------------------------
    !      NDSI         Int.
    !      NML_SMC      Type.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      W3NMLOUNF 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_smc_t), INTENT(INOUT)      :: NML_SMC
 
    ! locals
    INTEGER                                :: IERR
    TYPE(nml_smc_t) :: SMC
    namelist /smc_nml/ smc
#ifdef W3_S
    INTEGER, SAVE                           :: IENT = 0
#endif
 
    ierr = 0
#ifdef W3_S
    CALL strace (ient, 'READ_SMC_NML')
#endif
 
    ! set default values for smc structure
    smc%SXO       = -999.9
    smc%SYO       = -999.9
    smc%EXO       = -999.9
    smc%EYO       = -999.9
    smc%CELFAC    = 1
    smc%TYPE      = 1
 
    ! read smc namelist
    rewind(ndsi)
    READ (ndsi, nml=smc_nml, iostat=ierr, iomsg=msg)
    IF (ierr.GT.0) THEN
      WRITE (ndse,'(A,/A)') &
           'ERROR: READ_SMC_NML: namelist read error', &
           'ERROR: '//trim(msg)
      CALL extcde (3)
    END IF
 
    ! save namelist
    nml_smc = smc
 
  END SUBROUTINE read_smc_nml
 
  !/ ------------------------------------------------------------------- /
 
 
 
 
 
  !/ ------------------------------------------------------------------- /
 
  SUBROUTINE report_field_nml (NML_FIELD)
    !/
    !/                  +-----------------------------------+
    !/                  | 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_FIELD  Type.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      W3NMLOUNF 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_field_t), INTENT(IN) :: NML_FIELD
#ifdef W3_S
    INTEGER, SAVE                           :: IENT = 0
#endif
 
#ifdef W3_S
    CALL strace (ient, 'REPORT_FIELD_NML')
#endif
 
    WRITE (msg,'(A)') 'FIELD % '
    WRITE (ndsn,'(A)')
    WRITE (ndsn,10) trim(msg),'TIMESTART  = ', trim(nml_field%TIMESTART)
    WRITE (ndsn,10) trim(msg),'TIMESTRIDE = ', trim(nml_field%TIMESTRIDE)
    WRITE (ndsn,10) trim(msg),'TIMECOUNT  = ', trim(nml_field%TIMECOUNT)
 
    WRITE (ndsn,11) trim(msg),'TIMESPLIT  = ', nml_field%TIMESPLIT
    WRITE (ndsn,10) trim(msg),'LIST       = ', trim(nml_field%LIST)
    WRITE (ndsn,10) trim(msg),'PARTITION  = ', trim(nml_field%PARTITION)
    WRITE (ndsn,13) trim(msg),'SAMEFILE   = ', nml_field%SAMEFILE
    WRITE (ndsn,11) trim(msg),'TYPE       = ', nml_field%TYPE
    WRITE (ndsn,10) trim(msg),'FCVARS     = ', nml_field%FCVARS
    WRITE (ndsn,10) trim(msg),'TIMEREF    = ', nml_field%TIMEREF
    WRITE (ndsn,14) trim(msg),'NOVAL      = ', nml_field%NOVAL
    WRITE (ndsn,13) trim(msg),'MAPSTA     = ', nml_field%MAPSTA
 
 
10  FORMAT (a,2x,a,a)
11  FORMAT (a,2x,a,i8)
13  FORMAT (a,2x,a,l1)
14  FORMAT (a,2x,a,f8.2)
 
  END SUBROUTINE report_field_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
    !     ----------------------------------------------------------------
    !      W3NMLOUNF 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
    WRITE (ndsn,11) trim(msg),'IX0       = ', nml_file%IX0
    WRITE (ndsn,11) trim(msg),'IXN       = ', nml_file%IXN
    WRITE (ndsn,11) trim(msg),'IY0       = ', nml_file%IY0
    WRITE (ndsn,11) trim(msg),'IYN       = ', nml_file%IYN
 
10  FORMAT (a,2x,a,a)
11  FORMAT (a,2x,a,i12)
 
  END SUBROUTINE report_file_nml
 
  !/ ------------------------------------------------------------------- /
 
 
  !/ ------------------------------------------------------------------- /
 
  SUBROUTINE report_smc_nml (NML_SMC)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         19-Sep-2018 |
    !/                  +-----------------------------------+
    !/
    !/
    !  1. Purpose :
    !
    !
    !  2. Method :
    !
    !     See source term routines.
    !
    !  3. Parameters :
    !
    !     Parameter list
    !     ----------------------------------------------------------------
    !      NML_SMC   Type.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      W3NMLOUNF 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_smc_t), INTENT(IN) :: NML_SMC
#ifdef W3_S
    INTEGER, SAVE                           :: IENT = 0
#endif
 
#ifdef W3_S
    CALL strace (ient, 'REPORT_SMC_NML')
#endif
 
    WRITE (msg,'(A)') 'SMC % '
    WRITE (ndsn,'(A)')
    WRITE (ndsn,11) trim(msg),'TYPE      = ', nml_smc%TYPE
    WRITE (ndsn,14) trim(msg),'SXO       = ', nml_smc%SXO
    WRITE (ndsn,14) trim(msg),'SYO       = ', nml_smc%SYO
    WRITE (ndsn,14) trim(msg),'EXO       = ', nml_smc%EXO
    WRITE (ndsn,14) trim(msg),'EYO       = ', nml_smc%EYO
    WRITE (ndsn,11) trim(msg),'CELFAC    = ', nml_smc%CELFAC
 
11  FORMAT (a,2x,a,i12)
14  FORMAT (a,2x,a,f8.2)
 
  END SUBROUTINE report_smc_nml
 
  !/ ------------------------------------------------------------------- /
 
 
 
 
END MODULE w3nmlounfmd
 
!/ ------------------------------------------------------------------- /