w3nmlprncmd.F90

Go to the documentation of this file.

#include "w3macros.h"
!/ ------------------------------------------------------------------- /
MODULE w3nmlprncmd
  !/
  !/                  +-----------------------------------+
  !/                  | WAVEWATCH III           NOAA/NCEP |
  !/                  |           M. Accensi              |
  !/                  |                                   |
  !/                  |                        FORTRAN 90 |
  !/                  | Last update :         22-Mar-2021 |
  !/                  +-----------------------------------+
  !/
  !/    For updates see subroutines.
  !/
  !  1. Purpose :
  !
  !     Manages namelists from configuration file ww3_prnc.nml for ww3_prnc program
  !
  !/ ------------------------------------------------------------------- /
 
  ! module defaults
  IMPLICIT NONE
 
  PUBLIC
 
  ! field structure
  TYPE nml_field_t
    LOGICAL                     :: ice_param1
    LOGICAL                     :: ice_param2
    LOGICAL                     :: ice_param3
    LOGICAL                     :: ice_param4
    LOGICAL                     :: ice_param5
    LOGICAL                     :: mud_density
    LOGICAL                     :: mud_thickness
    LOGICAL                     :: mud_viscosity
    LOGICAL                     :: water_levels
    LOGICAL                     :: currents
    LOGICAL                     :: winds
    LOGICAL                     :: winds_ast
    LOGICAL                     :: atm_momentum
    LOGICAL                     :: air_density
    LOGICAL                     :: ice_conc
    LOGICAL                     :: ice_berg
    LOGICAL                     :: data_assim
  END TYPE nml_field_t
 
  ! grid structure
  TYPE nml_grid_t
    LOGICAL                     :: asis
    LOGICAL                     :: latlon
  END TYPE nml_grid_t
 
  ! forcing structure
  TYPE nml_forcing_t
    CHARACTER(15)               :: timestart
    CHARACTER(15)               :: timestop
    TYPE(nml_field_t)           :: field
    TYPE(nml_grid_t)            :: grid
    CHARACTER(256)              :: tidal
  END TYPE nml_forcing_t
 
  ! file structure
  TYPE nml_file_t
    CHARACTER(256)              :: filename
    CHARACTER(100)              :: longitude
    CHARACTER(100)              :: latitude
    CHARACTER(100)              :: var(3)
    CHARACTER(15)               :: timeshift
  END TYPE nml_file_t
 
 
  ! miscellaneous
  CHARACTER(256)                :: msg
  INTEGER                       :: ndsn
 
 
 
 
CONTAINS
  !/ ------------------------------------------------------------------- /
  SUBROUTINE w3nmlprnc (NDSI, INFILE, NML_FORCING, NML_FILE, IERR)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                                   |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         04-Jan-2018 |
    !/                  +-----------------------------------+
    !/
    !
    !  1. Purpose :
    !
    !     Reads all the namelist to define the forcing field
    !
    !  2. Method :
    !
    !     See source term routines.
    !
    !  3. Parameters :
    !
    !     Parameter list
    !     ----------------------------------------------------------------
    !      NDSI        Int.
    !      INFILE      Char.
    !      NML_FORCING type.
    !      NML_FILE    type.
    !      IERR        Int.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !      READ_FORCING_NML
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      WW3_PRNC  Prog.   N/A    Preprocess forcing 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_forcing_t), INTENT(INOUT)          :: NML_FORCING
    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, 'W3NMLPRNC')
#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 forcing namelist
    CALL read_forcing_nml (ndsi, nml_forcing)
    CALL report_forcing_nml (nml_forcing)
 
    ! 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 w3nmlprnc
 
 
  !/ ------------------------------------------------------------------- /
 
 
 
 
 
 
  !/ ------------------------------------------------------------------- /
 
  SUBROUTINE read_forcing_nml (NDSI, NML_FORCING)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                                   |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         22-Mar-2021 |
    !/                  +-----------------------------------+
    !/
    !  1. Purpose :
    !
    !
    !  2. Method :
    !
    !     See source term routines.
    !
    !  3. Parameters :
    !
    !     Parameter list
    !     ----------------------------------------------------------------
    !      NDSI         Int.
    !      NML_FORCING  Type.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      W3NMLPRNC 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_forcing_t), INTENT(INOUT)  :: NML_FORCING
 
    ! locals
    INTEGER                                :: IERR
    TYPE(nml_forcing_t) :: FORCING
    namelist /forcing_nml/ forcing
#ifdef W3_S
    INTEGER, SAVE                           :: IENT = 0
#endif
 
    ierr = 0
#ifdef W3_S
    CALL strace (ient, 'READ_FORCING_NML')
#endif
 
    ! set default values for forcing structure
    forcing%TIMESTART  = '19000101 000000'
    forcing%TIMESTOP   = '29001231 000000'
    !
    forcing%FIELD%ICE_PARAM1     = .false.
    forcing%FIELD%ICE_PARAM2     = .false.
    forcing%FIELD%ICE_PARAM3     = .false.
    forcing%FIELD%ICE_PARAM4     = .false.
    forcing%FIELD%ICE_PARAM5     = .false.
    forcing%FIELD%MUD_DENSITY    = .false.
    forcing%FIELD%MUD_THICKNESS  = .false.
    forcing%FIELD%MUD_VISCOSITY  = .false.
    forcing%FIELD%WATER_LEVELS   = .false.
    forcing%FIELD%CURRENTS       = .false.
    forcing%FIELD%WINDS          = .false.
    forcing%FIELD%WINDS_AST      = .false.
    forcing%FIELD%ATM_MOMENTUM   = .false.
    forcing%FIELD%AIR_DENSITY    = .false.
    forcing%FIELD%ICE_CONC       = .false.
    forcing%FIELD%ICE_BERG       = .false.
    forcing%FIELD%DATA_ASSIM     = .false.
    !
    forcing%GRID%LATLON  = .false.
    forcing%GRID%ASIS    = .false.
    !
    forcing%TIDAL  = 'unset'
 
 
    ! read forcing namelist
    rewind(ndsi)
    READ (ndsi, nml=forcing_nml, iostat=ierr, iomsg=msg)
    IF (ierr.NE.0) THEN
      WRITE (ndse,'(A,/A)') &
           'ERROR: READ_FORCING_NML: namelist read error', &
           'ERROR: '//trim(msg)
      CALL extcde (1)
    END IF
 
    ! set/check RETURN values
    IF (forcing%TIDAL.NE.'unset') THEN
      IF (.NOT. forcing%FIELD%WATER_LEVELS .AND. .NOT. forcing%FIELD%CURRENTS) THEN
        WRITE (ndse,'(A,I3)') 'ERROR: TIDAL must only be used on FIELD%WATER_LEVELS or FIELD%CURRENTS'
        CALL extcde (2)
      ELSE IF (.NOT. forcing%GRID%ASIS) THEN
        WRITE (ndse,'(A,I3)') 'ERROR: TIDAL must only be used on GRID%ASIS'
        CALL extcde (3)
      END IF
    END IF
 
    ! save namelist
    nml_forcing = forcing
 
  END SUBROUTINE read_forcing_nml
 
  !/ ------------------------------------------------------------------- /
 
 
 
  !/ ------------------------------------------------------------------- /
 
  SUBROUTINE read_file_nml (NDSI, NML_FILE)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                                   |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         04-Jan-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
    !     ----------------------------------------------------------------
    !      W3NMLPRNC 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%FILENAME  = 'unset'
    file%LONGITUDE = 'unset'
    file%LATITUDE  = 'unset'
    file%VAR(1)    = 'unset'
    file%VAR(2)    = 'unset'
    file%VAR(3)    = 'unset'
    file%TIMESHIFT = '00000000 000000'
 
    ! read file namelist
    rewind(ndsi)
    READ (ndsi, nml=file_nml, iostat=ierr, iomsg=msg)
    IF (ierr.NE.0) THEN
      WRITE (ndse,'(A,/A)') &
           'ERROR: READ_FILE_NML: namelist read error', &
           'ERROR: '//trim(msg)
      CALL extcde (4)
    END IF
 
    ! save namelist
    nml_file = file
 
  END SUBROUTINE read_file_nml
 
  !/ ------------------------------------------------------------------- /
 
 
 
 
 
 
 
  !/ ------------------------------------------------------------------- /
 
  SUBROUTINE report_forcing_nml (NML_FORCING)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         22-Mar-2021 |
    !/                  +-----------------------------------+
    !/
    !/
    !  1. Purpose :
    !
    !
    !  2. Method :
    !
    !     See source term routines.
    !
    !  3. Parameters :
    !
    !     Parameter list
    !     ----------------------------------------------------------------
    !      NML_FORCING  Type.
    !     ----------------------------------------------------------------
    !
    !  4. Subroutines used :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      STRACE    Subr. W3SERVMD SUBROUTINE tracing.
    !     ----------------------------------------------------------------
    !
    !  5. Called by :
    !
    !      Name      TYPE  Module   Description
    !     ----------------------------------------------------------------
    !      W3NMLPRNC 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_forcing_t), INTENT(IN) :: NML_FORCING
#ifdef W3_S
    INTEGER, SAVE                           :: IENT = 0
#endif
 
#ifdef W3_S
    CALL strace (ient, 'REPORT_FORCING_NML')
#endif
 
    WRITE (msg,'(A)') 'FORCING % '
    WRITE (ndsn,'(A)')
    WRITE (ndsn,10) trim(msg),'TIMESTART  = ', trim(nml_forcing%TIMESTART)
    WRITE (ndsn,10) trim(msg),'TIMESTOP   = ', trim(nml_forcing%TIMESTOP)
 
    WRITE (ndsn,13) trim(msg),'FIELD % ICE_PARAM1     = ', nml_forcing%FIELD%ICE_PARAM1
    WRITE (ndsn,13) trim(msg),'FIELD % ICE_PARAM2     = ', nml_forcing%FIELD%ICE_PARAM2
    WRITE (ndsn,13) trim(msg),'FIELD % ICE_PARAM3     = ', nml_forcing%FIELD%ICE_PARAM3
    WRITE (ndsn,13) trim(msg),'FIELD % ICE_PARAM4     = ', nml_forcing%FIELD%ICE_PARAM4
    WRITE (ndsn,13) trim(msg),'FIELD % ICE_PARAM5     = ', nml_forcing%FIELD%ICE_PARAM5
    WRITE (ndsn,13) trim(msg),'FIELD % MUD_DENSITY    = ', nml_forcing%FIELD%MUD_DENSITY
    WRITE (ndsn,13) trim(msg),'FIELD % MUD_THICKNESS  = ', nml_forcing%FIELD%MUD_THICKNESS
    WRITE (ndsn,13) trim(msg),'FIELD % MUD_VISCOSITY  = ', nml_forcing%FIELD%MUD_VISCOSITY
    WRITE (ndsn,13) trim(msg),'FIELD % WATER_LEVELS   = ', nml_forcing%FIELD%WATER_LEVELS
    WRITE (ndsn,13) trim(msg),'FIELD % CURRENTS       = ', nml_forcing%FIELD%CURRENTS
    WRITE (ndsn,13) trim(msg),'FIELD % WINDS          = ', nml_forcing%FIELD%WINDS
    WRITE (ndsn,13) trim(msg),'FIELD % WINDS_AST      = ', nml_forcing%FIELD%WINDS_AST
    WRITE (ndsn,13) trim(msg),'FIELD % ATM_MOMENTUM   = ', nml_forcing%FIELD%ATM_MOMENTUM
    WRITE (ndsn,13) trim(msg),'FIELD % AIR_DENSITY    = ', nml_forcing%FIELD%AIR_DENSITY
    WRITE (ndsn,13) trim(msg),'FIELD % ICE_CONC       = ', nml_forcing%FIELD%ICE_CONC
    WRITE (ndsn,13) trim(msg),'FIELD % ICE_BERG       = ', nml_forcing%FIELD%ICE_BERG
    WRITE (ndsn,13) trim(msg),'FIELD % DATA_ASSIM     = ', nml_forcing%FIELD%DATA_ASSIM
 
    WRITE (ndsn,13) trim(msg),'GRID % ASIS   = ', nml_forcing%GRID%ASIS
    WRITE (ndsn,13) trim(msg),'GRID % LATLON = ', nml_forcing%GRID%LATLON
 
    WRITE (ndsn,10) trim(msg),'TIDAL = ', trim(nml_forcing%TIDAL)
 
 
10  FORMAT (a,2x,a,a)
13  FORMAT (a,2x,a,l1)
 
  END SUBROUTINE report_forcing_nml
 
  !/ ------------------------------------------------------------------- /
 
 
 
 
 
 
  !/ ------------------------------------------------------------------- /
 
  SUBROUTINE report_file_nml (NML_FILE)
    !/
    !/                  +-----------------------------------+
    !/                  | WAVEWATCH III           NOAA/NCEP |
    !/                  |           M. Accensi              |
    !/                  |                        FORTRAN 90 |
    !/                  | Last update :         04-Jan-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
    !     ----------------------------------------------------------------
    !      W3NMLPRNC 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),'FILENAME    = ', trim(nml_file%FILENAME)
    WRITE (ndsn,10) trim(msg),'LONGITUDE   = ', trim(nml_file%LONGITUDE)
    WRITE (ndsn,10) trim(msg),'LATITUDE    = ', trim(nml_file%LATITUDE)
    WRITE (ndsn,10) trim(msg),'VAR(1)      = ', trim(nml_file%VAR(1))
    WRITE (ndsn,10) trim(msg),'VAR(2)      = ', trim(nml_file%VAR(2))
    WRITE (ndsn,10) trim(msg),'VAR(3)      = ', trim(nml_file%VAR(3))
    WRITE (ndsn,10) trim(msg),'TIMESHIFT   = ', trim(nml_file%TIMESHIFT)
 
10  FORMAT (a,2x,a,a)
 
 
  END SUBROUTINE report_file_nml
 
  !/ ------------------------------------------------------------------- /
 
 
 
 
 
END MODULE w3nmlprncmd
 
!/ ------------------------------------------------------------------- /