mod_iounits.F

Go to the documentation of this file.

#include "cppdefs.h"
      MODULE mod_iounits
!
!git $Id$
!================================================== Hernan G. Arango ===
!  Copyright (c) 2002-2025 The ROMS Group                              !
!    Licensed under a MIT/X style license                              !
!    See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  The input and output files information is stored in compact derived !
!  type structure, TYPE(T_IO):                                         !
!                                                                      !
!    ADM       Output adjoint model history data                       !
!    ADS       Input adjoint sensitivity functional                    !
!    AVG       Output time-averaged data                               !
!    BLK       Input bulk fluxes data in adjoint-based applications    !
!    BRY       Input open boundary conditions data                     !
!    CLM       Input climatology data                                  !
!    DAI       Output data assimilation next cycle initial conditions  !
!                (4D-Var analysis) or restart (Ensemble Kalman Filter) !
!    DAV       Output 4D-Var data assimilation variables               !
!    DIA       Output diagnostics fields                               !
!    ERR       Output 4DVar posterior error estimate                   !
#ifdef RBL4DVAR_FCT_SENSITIVITY
!    FCTA      Input basic state forecast solution                     !
!    FCTB      Input basic state forecast solution                     !
#endif
!    FLT       Output Lagrangian trajectories data                     !
#if defined RBL4DVAR_FCT_SENSITIVITY && !defined OBS_SPACE
!    FOIA      Input Forecast Observation Impacts forcing data when    !
!                initialized from the 4D-Var Analysis (red curve)      !
!    FOIB      Input Forecast Observation Impacts forcing data when    !
!                initialized from the 4D-Var Background (blue curve)   !
#endif
!    FRC       Input forcing data                                      !
!    FWD       Input basic state forward solution                      !
!    GRD       Input grid data                                         !
!    GRX       Input grid for extracted history data                   !
!    GST       Input/output GST analysis check pointing data           !
!    HAR       Output detiding least-squares harmonics coefficients    !
!    HIS       Output nonlinear model history data                     !
!    HSS       Input/output Hessian eigenvectors                       !
!    IAD       Input adjoint model initial conditions                  !
!    INI       Input nonlinear model initial conditions                !
!    IPR       Input representer model initial conditions              !
!    ITL       Input tangent linear model initial conditions           !
!    LCZ       Input/output Lanczos vectors                            !
!    LZE       Input/output time-evolved Lanczos vectors               !
!    NRM       Input/output error covariance normalization data        !
!                NRM(1,ng)  initial conditions                         !
!                NRM(2,ng)  model error                                !
!                NRM(3,ng)  lateral open boundary conditions           !
!                NRM(4,ng)  surface forcing                            !
!    NUD       Input climatology nudging coefficients                  !
!    OBS       Input/output 4D-Var observations                        !
#if defined RBL4DVAR_FCT_SENSITIVITY && defined OBS_SPACE
!    OIFA      Input Observations Impact Forcing at datum locations if !
!                initialized from the 4D-Var Analysis (red curve)      !
!    OIFB      Input Observations Impact Forcing at datum locations if !
!                initialized from the 4D-Var Background (blue curve)   !
#endif
!    QCK       Output nonlinear model brief snpashots data             !
!    RST       Output restart data                                     !
!    TIDE      Input tide forcing                                      !
!    TLF       Input/output tangent linear model impulse forcing       !
!    TLM       Output tangent linear model history                     !
#ifdef SP4DVAR
!    SCA       Output adjoint scratch state vector file                !
!    SCT       Output tangent scratch state vector file                !
!    SPA       Output adjoint Arnoldi state vector file                !
!    SPT       Output tangent Arnoldi state vector file                !
#endif
!    SSF       Input Sources/Sinks forcing (river runoff)              !
!    STA       Output station data                                     !
!    STD       Error covariance standard deviations                    !
!                STD(1,ng)  initial conditions                         !
!                STD(2,ng)  model error                                !
!                STD(3,ng)  lateral open boundary conditions           !
!                STD(4,ng)  surface forcing                            !
!                STD(5,ng)  computed from background (output)          !
!    XTR       Output extracted history fields                         !
!                                                                      !
!  Input/output information files:                                     !
!                                                                      !
!  Iname       Physical parameters standard input script filename.     !
!  NGCname     Nested grids contact point information filename.        !
!  USRname     USER input/output generic filename.                     !
!  Wname       Wave model stadard input filename.                      !
!  aparnam     Input assimilation parameters filename.                 !
!  bparnam     Input biology parameters filename.                      !
!  fbionam     Input floats biological behavior parameters filename.   !
!  fposnam     Input initial floats positions filename.                !
!  iparnam     Input ice parameters file name.                         !
!  sparnam     Input sediment transport parameters filename.           !
!  sposnam     Input station positions file name.                      !
!  varname     Input IO variables information file name.               !
!                                                                      !
!  stdinp      Unit number for standard input (often 5).               !
!  stdout      Unit number for standard output (often 6).              !
!  usrout      Unit number for generic USER output.                    !
!                                                                      !
!  Standard NetCDF library input files ID per each field:              !
!                                                                      !
!  BRYids      File ID associated with each boundary field.            !
!  CLMids      File ID associated with each climatology field.         !
!  FRCids      File ID associated with each forcing field.             !
!                                                                      !
#if defined PIO_LIB && defined DISTRIBUTE
!  Parallel-IO (PIO) library input files descriptors per each field:   !
!                                                                      !
!  BRYdesc     File descriptor associated with each boundary field.    !
!  CLMdesc     File descriptor associated with each climatology field. !
!  FRCdesc     file descriptor associated with each forcing field.     !
!                                                                      !
#endif
!  Miscellaneous variables:                                            !
!                                                                      !
!  CalledFrom  Calling routine in IO operations.                       !
!  Rerror      Running error messages.                                 !
!  SourceFile  Current executed file name. It is used for IO error     !
!                purposes.                                             !
!  ioerror     IO error flag.                                          !
!  ncfile      Current NetCDF file name being processed.               !
!  nFfiles     Number of forcing files.                                !
!                                                                      !
!=======================================================================
!
      USE mod_kinds
#if defined PIO_LIB && defined DISTRIBUTE
      USE pio
#endif
!
      implicit none
!
      PUBLIC :: allocate_iounits
      PUBLIC :: deallocate_iounits
!
!-----------------------------------------------------------------------
!  Define derived type structure, T_IO, used to store information about
!  the input and output files.
!-----------------------------------------------------------------------
 
#if defined PIO_LIB && defined DISTRIBUTE
!
!  Define derived type structure for ROMS variable descriptors. It is
!  done to include additional information not available in the PIO
!  library TYPE (Var_desc_t) variable descriptor. It includes external
!  data representation "dkind" and C-grid type "gtype".
!
      TYPE my_vardesc
        TYPE (var_desc_t) :: vd              ! PIO variable descriptor
        integer :: dkind                     ! PIO data kind
        integer :: gtype                     ! ROMS C-grid variable type
      END TYPE my_vardesc
#endif
!
!  This structure is used to declare the variables associated with
!  input and output files, like TYPE(IO) :: HIS(Ngrids). It is a
!  compact way to store a lot of information.  The "Fcount" variable
!  is used during data processing in "check_multifile" and "inquiry"
!  whereas "load" is used storing information in the structure.
!
      TYPE t_io
        integer :: iotype                        ! file IO type
        integer :: nfiles                        ! number of multi-files
        integer :: fcount                        ! multi-file counter
        integer :: load                          ! filename load counter
        integer :: rindex                        ! NetCDF record index
        integer :: ncid                          ! NetCDF file ID
        integer,  pointer :: nrec(:)             ! NetCDF record size
        integer,  pointer :: vid(:)              ! NetCDF variables IDs
        integer,  pointer :: tid(:)              ! NetCDF tracers IDs
        real(dp), pointer :: time_min(:)         ! starting time
        real(dp), pointer :: time_max(:)         ! ending time
        character (len=50 ) :: label             ! structure label
        character (len=256) :: head              ! head filename
        character (len=256) :: base              ! base filename
        character (len=256) :: name              ! current name
        character (len=256), pointer :: files(:) ! multi-file names
#if defined PIO_LIB && defined DISTRIBUTE
        TYPE (file_desc_t) :: piofile            ! file descriptor
        TYPE (my_vardesc), pointer :: piovar(:)  ! variable descriptor
        TYPE (my_vardesc), pointer :: piotrc(:)  ! tracer descriptor
#endif
      END TYPE t_io
!
!-----------------------------------------------------------------------
!  Define variables in module.
!-----------------------------------------------------------------------
!
!  I/O units.
!
      integer :: stdinp = 5                 ! standard input
      integer :: stdout                     ! standard output, usually 6
      integer :: usrout = 10                ! generic user unit
!
!  I/O files management, derived type structures.
!
      TYPE(t_io), allocatable :: adm(:)     ! ADM history fields
      TYPE(t_io), allocatable :: ads(:)     ! sensitivity functional
      TYPE(t_io), allocatable :: avg(:)     ! time-averaged fields
      TYPE(t_io), allocatable :: blk(:)     ! bulk fluxes fields
      TYPE(t_io), allocatable :: dai(:)     ! Data assilation IC/restart
      TYPE(t_io), allocatable :: dav(:)     ! 4D-Var variables
      TYPE(t_io), allocatable :: dia(:)     ! diagnostics fields
      TYPE(t_io), allocatable :: err(:)     ! 4D-Var posterior error
      TYPE(t_io), allocatable :: flt(:)     ! Lagrangian trajectories
#ifdef RBL4DVAR_FCT_SENSITIVITY
      TYPE(t_io), allocatable :: fcta(:)    ! forecast for impacts, A
      TYPE(t_io), allocatable :: fctb(:)    ! forecast for impacts, B
#endif
#if defined RBL4DVAR_FCT_SENSITIVITY && !defined OBS_SPACE
      TYPE(t_io), allocatable :: foia(:)    ! observation impacts, A
      TYPE(t_io), allocatable :: foib(:)    ! observation impacts, B
#endif
      TYPE(t_io), allocatable :: fwd(:)     ! forward solution
      TYPE(t_io), allocatable :: grd(:)     ! grid geometry data
      TYPE(t_io), allocatable :: grx(:)     ! grid for extrated fields
      TYPE(t_io), allocatable :: gst(:)     ! generalized stability
      TYPE(t_io), allocatable :: har(:)     ! detiding harmonics
      TYPE(t_io), allocatable :: his(:)     ! NLM history fields
      TYPE(t_io), allocatable :: hss(:)     ! Hessian eigenvectors
      TYPE(t_io), allocatable :: iad(:)     ! ADM initial conditions
      TYPE(t_io), allocatable :: ini(:)     ! NLM initial conditions
      TYPE(t_io), allocatable :: irp(:)     ! RPM initial conditions
      TYPE(t_io), allocatable :: itl(:)     ! TLM initial conditions
      TYPE(t_io), allocatable :: lcz(:)     ! Lanczos vectors
      TYPE(t_io), allocatable :: lze(:)     ! evolved Lanczos vectors
      TYPE(t_io), allocatable :: nrm(:,:)   ! normalization
      TYPE(t_io), allocatable :: nud(:)     ! nudging coefficients
      TYPE(t_io), allocatable :: obs(:)     ! observations
#if defined RBL4DVAR_FCT_SENSITIVITY && defined OBS_SPACE
      TYPE(t_io), allocatable :: oifa(:)    ! observation impacts, A
      TYPE(t_io), allocatable :: oifb(:)    ! observation impacts, B
#endif
      TYPE(t_io), allocatable :: qck(:)     ! quicksave fields
      TYPE(t_io), allocatable :: rst(:)     ! restart fields
#ifdef SP4DVAR
      TYPE(t_io), allocatable :: sca(:)     ! ADM scratch state vector
      TYPE(t_io), allocatable :: sct(:)     ! TLM scratch state vector
      TYPE(t_io), allocatable :: spa(:)     ! ADM Arnoldi state vector
      TYPE(t_io), allocatable :: spt(:)     ! TLM Arnoldi state vector
#endif
      TYPE(t_io), allocatable :: ssf(:)     ! Sources/Sinks forcing
      TYPE(t_io), allocatable :: sta(:)     ! stations data
      TYPE(t_io), allocatable :: std(:,:)   ! standard deviation
      TYPE(t_io), allocatable :: tide(:)    ! tidal forcing
      TYPE(t_io), allocatable :: tlf(:)     ! TLM impulse fields
      TYPE(t_io), allocatable :: tlm(:)     ! TLM history fields
      TYPE(t_io), allocatable :: xtr(:)     ! extracted history fields
!
!  Input boundary condition data.
!
      integer, allocatable :: nbcfiles(:)
      integer, allocatable :: bryids(:,:)
!
#if defined PIO_LIB && defined DISTRIBUTE
      TYPE (file_desc_t), allocatable :: brydesc(:,:)
#endif
      TYPE(t_io), allocatable :: bry(:,:)
!
!  Input climatology data.
!
      integer, allocatable :: nclmfiles(:)
      integer, allocatable :: clmids(:,:)
!
#if defined PIO_LIB && defined DISTRIBUTE
      TYPE (file_desc_t), allocatable :: clmdesc(:,:)
#endif
      TYPE(t_io), allocatable :: clm(:,:)
!
!  Input forcing data.
!
      integer, allocatable :: nffiles(:)
      integer, allocatable :: frcids(:,:)
!
#if defined PIO_LIB && defined DISTRIBUTE
      TYPE (file_desc_t), allocatable :: frcdesc(:,:)
#endif
      TYPE(t_io), allocatable :: frc(:,:)
!
!  Error messages.
!
      character (len=50), dimension(9) :: rerror =                      &
     &       (/ ' ROMS - Blows up ................ exit_flag: ',        &
     &          ' ROMS - Input error ............. exit_flag: ',        &
     &          ' ROMS - Output error ............ exit_flag: ',        &
     &          ' ROMS - I/O error ............... exit_flag: ',        &
     &          ' ROMS - Configuration error ..... exit_flag: ',        &
     &          ' ROMS - Partition error ......... exit_flag: ',        &
     &          ' ROMS - Illegal input parameter . exit_flag: ',        &
     &          ' ROMS - Fatal algorithm result .. exit_flag: ',        &
     &          ' ROMS - Coupling error .......... exit_flag: ' /)
!
!  Standard input scripts file names.
!
      character (len=256) :: iname          ! ROMS physical parameters
      character (len=256) :: wname          ! wave model standard input
      character (len=256) :: ngcname        ! contact points filename
      character (len=256) :: usrname        ! use generic filename
      character (len=256) :: aparnam        ! assimilation parameters
      character (len=256) :: bparnam        ! biology model parameters
      character (len=256) :: fbionam        ! floats behavior parameters
      character (len=256) :: fposnam        ! floats positions
      character (len=256) :: iparnam        ! ice model parameters
      character (len=256) :: sparnam        ! sediment model parameters
      character (len=256) :: sposnam        ! station positions
      character (len=256) :: varname        ! I/O metadata
!
!  Miscelaneous variables.
!
      integer :: ioerror = 0                ! I/O error flag
 
      character (len=256) :: calledfrom     ! routine calling IO
      character (len=256) :: myappcpp       ! application CPP flag
      character (len=256) :: sourcefile     ! current executed ROMS file
      character (len=256) :: ncfile         ! current NetCDF file
!
      CONTAINS
!
      SUBROUTINE allocate_iounits (Ngrids)
!
!=======================================================================
!                                                                      !
!  This routine allocates several variables in the module that depend  !
!  on the number of nested grids.                                      !
!                                                                      !
!=======================================================================
!
!  Imported variable declarations.
!
      integer, intent(in) :: ngrids
!
!  Local variable declarations.
!
      integer :: i, lstr, ng
 
      character (len=1), parameter :: blank = ' '
!
!-----------------------------------------------------------------------
!  Allocate I/O files management, derived type structures.
!-----------------------------------------------------------------------
!
      IF (.not.allocated(adm)) THEN
        allocate ( adm(ngrids) )
      END IF
      IF (.not.allocated(ads)) THEN
        allocate ( ads(ngrids) )
      END IF
      IF (.not.allocated(avg)) THEN
        allocate ( avg(ngrids) )
      END IF
      IF (.not.allocated(blk)) THEN
        allocate ( blk(ngrids) )
      END IF
      IF (.not.allocated(dai)) THEN
        allocate ( dai(ngrids) )
      END IF
      IF (.not.allocated(dav)) THEN
        allocate ( dav(ngrids) )
      END IF
      IF (.not.allocated(dia)) THEN
        allocate ( dia(ngrids) )
      END IF
      IF (.not.allocated(err)) THEN
        allocate ( err(ngrids) )
      END IF
      IF (.not.allocated(flt)) THEN
        allocate ( flt(ngrids) )
      END IF
#ifdef RBL4DVAR_FCT_SENSITIVITY
      IF (.not.allocated(fcta)) THEN
        allocate ( fcta(ngrids) )
      END IF
      IF (.not.allocated(fctb)) THEN
        allocate ( fctb(ngrids) )
      END IF
#endif
#if defined RBL4DVAR_FCT_SENSITIVITY && !defined OBS_SPACE
      IF (.not.allocated(foia)) THEN
        allocate ( foia(ngrids) )
      END IF
      IF (.not.allocated(foib)) THEN
        allocate ( foib(ngrids) )
      END IF
#endif
      IF (.not.allocated(fwd)) THEN
        allocate ( fwd(ngrids) )
      END IF
      IF (.not.allocated(grd)) THEN
        allocate ( grd(ngrids) )
      END IF
      IF (.not.allocated(grx)) THEN
        allocate ( grx(ngrids) )
      END IF
      IF (.not.allocated(gst)) THEN
        allocate ( gst(ngrids) )
      END IF
      IF (.not.allocated(har)) THEN
        allocate ( har(ngrids) )
      END IF
      IF (.not.allocated(his)) THEN
        allocate ( his(ngrids) )
      END IF
      IF (.not.allocated(hss)) THEN
        allocate ( hss(ngrids) )
      END IF
      IF (.not.allocated(iad)) THEN
        allocate ( iad(ngrids) )
      END IF
      IF (.not.allocated(ini)) THEN
        allocate ( ini(ngrids) )
      END IF
      IF (.not.allocated(irp)) THEN
        allocate ( irp(ngrids) )
      END IF
      IF (.not.allocated(itl)) THEN
        allocate ( itl(ngrids) )
      END IF
      IF (.not.allocated(lcz)) THEN
        allocate ( lcz(ngrids) )
      END IF
      IF (.not.allocated(lze)) THEN
        allocate ( lze(ngrids) )
      END IF
      IF (.not.allocated(nud)) THEN
        allocate ( nud(ngrids) )
      END IF
      IF (.not.allocated(obs)) THEN
        allocate ( obs(ngrids) )
      END IF
#if defined RBL4DVAR_FCT_SENSITIVITY && defined OBS_SPACE
      IF (.not.allocated(oifa)) THEN
        allocate ( oifa(ngrids) )
      END IF
      IF (.not.allocated(oifb)) THEN
        allocate ( oifb(ngrids) )
      END IF
#endif
      IF (.not.allocated(qck)) THEN
        allocate ( qck(ngrids) )
      END IF
      IF (.not.allocated(rst)) THEN
        allocate ( rst(ngrids) )
      END IF
#ifdef SP4DVAR
      IF (.not.allocated(sca)) THEN
        allocate ( sca(ngrids) )
      END IF
      IF (.not.allocated(sct)) THEN
        allocate ( sct(ngrids) )
      END IF
      IF (.not.allocated(spa)) THEN
        allocate ( spa(ngrids) )
      END IF
      IF (.not.allocated(spt)) THEN
        allocate ( spt(ngrids) )
      END IF
#endif
      IF (.not.allocated(ssf)) THEN
        allocate ( ssf(ngrids) )
      END IF
      IF (.not.allocated(sta)) THEN
        allocate ( sta(ngrids) )
      END IF
      IF (.not.allocated(tide)) THEN
        allocate ( tide(ngrids) )
      END IF
      IF (.not.allocated(tlf)) THEN
        allocate ( tlf(ngrids) )
      END IF
      IF (.not.allocated(tlm)) THEN
        allocate ( tlm(ngrids) )
      END IF
      IF (.not.allocated(xtr)) THEN
        allocate ( xtr(ngrids) )
      END IF
 
      IF (.not.allocated(nrm)) THEN
        allocate ( nrm(4,ngrids) )
      END IF
      IF (.not.allocated(std)) THEN
        allocate ( std(5,ngrids) )
      END IF
!
!-----------------------------------------------------------------------
!  Allocate variables.
!-----------------------------------------------------------------------
!
      IF (.not.allocated(nbcfiles)) THEN
        allocate ( nbcfiles(ngrids) )
      END IF
      IF (.not.allocated(nclmfiles)) THEN
        allocate ( nclmfiles(ngrids) )
      END IF
      IF (.not.allocated(nffiles)) THEN
        allocate ( nffiles(ngrids) )
      END IF
!
!-----------------------------------------------------------------------
!  Initialize I/O NetCDF files ID to close state.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
        adm(ng)%ncid=-1
        ads(ng)%ncid=-1
        avg(ng)%ncid=-1
        blk(ng)%ncid=-1
        dai(ng)%ncid=-1
        dav(ng)%ncid=-1
        dia(ng)%ncid=-1
        err(ng)%ncid=-1
        flt(ng)%ncid=-1
#ifdef RBL4DVAR_FCT_SENSITIVITY
        fcta(ng)%ncid=-1
        fctb(ng)%ncid=-1
#endif
#if defined RBL4DVAR_FCT_SENSITIVITY && !defined OBS_SPACE
        foia(ng)%ncid=-1
        foib(ng)%ncid=-1
#endif
        fwd(ng)%ncid=-1
        grd(ng)%ncid=-1
        grx(ng)%ncid=-1
        gst(ng)%ncid=-1
        har(ng)%ncid=-1
        his(ng)%ncid=-1
        hss(ng)%ncid=-1
        iad(ng)%ncid=-1
        ini(ng)%ncid=-1
        irp(ng)%ncid=-1
        itl(ng)%ncid=-1
        lcz(ng)%ncid=-1
        lze(ng)%ncid=-1
        nud(ng)%ncid=-1
        obs(ng)%ncid=-1
#if defined RBL4DVAR_FCT_SENSITIVITY && defined OBS_SPACE
        oifa(ng)%ncid=-1
        oifb(ng)%ncid=-1
#endif
        qck(ng)%ncid=-1
        rst(ng)%ncid=-1
        ssf(ng)%ncid=-1
        sta(ng)%ncid=-1
        tlf(ng)%ncid=-1
        tlm(ng)%ncid=-1
        tide(ng)%ncid=-1
        xtr(ng)%ncid=-1
        nrm(1:4,ng)%ncid=-1
        std(1:5,ng)%ncid=-1
        nbcfiles(ng)=-1
        nclmfiles(ng)=-1
        nffiles(ng)=-1
      END DO
!
!-----------------------------------------------------------------------
!  Initialize file names to blanks.
!-----------------------------------------------------------------------
!
      DO ng=1,ngrids
        lstr=len(his(ng)%name)
        DO i=1,lstr
          adm(ng)%head(i:i)=blank
          adm(ng)%base(i:i)=blank
          adm(ng)%name(i:i)=blank
 
          ads(ng)%head(i:i)=blank
          ads(ng)%base(i:i)=blank
          ads(ng)%name(i:i)=blank
 
          avg(ng)%head(i:i)=blank
          avg(ng)%base(i:i)=blank
          avg(ng)%name(i:i)=blank
 
          blk(ng)%head(i:i)=blank
          blk(ng)%base(i:i)=blank
          blk(ng)%name(i:i)=blank
 
          dai(ng)%head(i:i)=blank
          dai(ng)%base(i:i)=blank
          dai(ng)%name(i:i)=blank
 
          dav(ng)%head(i:i)=blank
          dav(ng)%base(i:i)=blank
          dav(ng)%name(i:i)=blank
 
          dia(ng)%head(i:i)=blank
          dia(ng)%base(i:i)=blank
          dia(ng)%name(i:i)=blank
 
          err(ng)%head(i:i)=blank
          err(ng)%base(i:i)=blank
          err(ng)%name(i:i)=blank
 
          flt(ng)%head(i:i)=blank
          flt(ng)%base(i:i)=blank
          flt(ng)%name(i:i)=blank
 
#ifdef RBL4DVAR_FCT_SENSITIVITY
          fcta(ng)%head(i:i)=blank
          fcta(ng)%base(i:i)=blank
          fcta(ng)%name(i:i)=blank
 
          fctb(ng)%head(i:i)=blank
          fctb(ng)%base(i:i)=blank
          fctb(ng)%name(i:i)=blank
#endif
 
#if defined RBL4DVAR_FCT_SENSITIVITY && !defined OBS_SPACE
          foia(ng)%head(i:i)=blank
          foia(ng)%base(i:i)=blank
          foia(ng)%name(i:i)=blank
 
          foib(ng)%head(i:i)=blank
          foib(ng)%base(i:i)=blank
          foib(ng)%name(i:i)=blank
#endif
 
          fwd(ng)%head(i:i)=blank
          fwd(ng)%base(i:i)=blank
          fwd(ng)%name(i:i)=blank
 
          grd(ng)%head(i:i)=blank
          grd(ng)%base(i:i)=blank
          grd(ng)%name(i:i)=blank
 
          grx(ng)%head(i:i)=blank
          grx(ng)%base(i:i)=blank
          grx(ng)%name(i:i)=blank
 
          gst(ng)%head(i:i)=blank
          gst(ng)%base(i:i)=blank
          gst(ng)%name(i:i)=blank
 
          har(ng)%head(i:i)=blank
          har(ng)%base(i:i)=blank
          har(ng)%name(i:i)=blank
 
          his(ng)%head(i:i)=blank
          his(ng)%base(i:i)=blank
          his(ng)%name(i:i)=blank
 
          hss(ng)%head(i:i)=blank
          hss(ng)%base(i:i)=blank
          hss(ng)%name(i:i)=blank
 
          iad(ng)%head(i:i)=blank
          iad(ng)%base(i:i)=blank
          iad(ng)%name(i:i)=blank
 
          ini(ng)%head(i:i)=blank
          ini(ng)%base(i:i)=blank
          ini(ng)%name(i:i)=blank
 
          irp(ng)%head(i:i)=blank
          irp(ng)%base(i:i)=blank
          irp(ng)%name(i:i)=blank
 
          itl(ng)%head(i:i)=blank
          itl(ng)%base(i:i)=blank
          itl(ng)%name(i:i)=blank
 
          lcz(ng)%head(i:i)=blank
          lcz(ng)%base(i:i)=blank
          lcz(ng)%name(i:i)=blank
 
          lze(ng)%head(i:i)=blank
          lze(ng)%base(i:i)=blank
          lze(ng)%name(i:i)=blank
 
          nud(ng)%head(i:i)=blank
          nud(ng)%base(i:i)=blank
          nud(ng)%name(i:i)=blank
 
          obs(ng)%head(i:i)=blank
          obs(ng)%base(i:i)=blank
          obs(ng)%name(i:i)=blank
 
#if defined RBL4DVAR_FCT_SENSITIVITY && defined OBS_SPACE
          oifa(ng)%head(i:i)=blank
          oifa(ng)%base(i:i)=blank
          oifa(ng)%name(i:i)=blank
 
          oifb(ng)%head(i:i)=blank
          oifb(ng)%base(i:i)=blank
          oifb(ng)%name(i:i)=blank
#endif
 
          qck(ng)%head(i:i)=blank
          qck(ng)%base(i:i)=blank
          qck(ng)%name(i:i)=blank
 
          rst(ng)%head(i:i)=blank
          rst(ng)%base(i:i)=blank
          rst(ng)%name(i:i)=blank
 
          ssf(ng)%head(i:i)=blank
          ssf(ng)%base(i:i)=blank
          ssf(ng)%name(i:i)=blank
 
          sta(ng)%head(i:i)=blank
          sta(ng)%base(i:i)=blank
          sta(ng)%name(i:i)=blank
 
          tlf(ng)%head(i:i)=blank
          tlf(ng)%base(i:i)=blank
          tlf(ng)%name(i:i)=blank
 
          tlm(ng)%head(i:i)=blank
          tlm(ng)%base(i:i)=blank
          tlm(ng)%name(i:i)=blank
 
          tide(ng)%head(i:i)=blank
          tide(ng)%base(i:i)=blank
          tide(ng)%name(i:i)=blank
 
          xtr(ng)%head(i:i)=blank
          xtr(ng)%base(i:i)=blank
          xtr(ng)%name(i:i)=blank
 
          nrm(1:4,ng)%head(i:i)=blank
          nrm(1:4,ng)%base(i:i)=blank
          nrm(1:4,ng)%name(i:i)=blank
 
          std(1:5,ng)%head(i:i)=blank
          std(1:5,ng)%base(i:i)=blank
          std(1:5,ng)%name(i:i)=blank
        END DO
      END DO
!
      DO i=1,len(iname)
        wname(i:i)=blank
        ngcname(i:i)=blank
        usrname(i:i)=blank
        aparnam(i:i)=blank
        bparnam(i:i)=blank
        fbionam(i:i)=blank
        fposnam(i:i)=blank
        sparnam(i:i)=blank
        sposnam(i:i)=blank
      END DO
!
      RETURN
      END SUBROUTINE allocate_iounits
!
      SUBROUTINE deallocate_iounits
!
!=======================================================================
!                                                                      !
!  This routine deallocates variables in module.                       !
!                                                                      !
!=======================================================================
!
!-----------------------------------------------------------------------
!  Deallocate I/O derived type structures.
!-----------------------------------------------------------------------
!
      IF (allocated(adm))       deallocate ( adm )
      IF (allocated(ads))       deallocate ( ads )
      IF (allocated(avg))       deallocate ( avg )
      IF (allocated(blk))       deallocate ( blk )
      IF (allocated(bry))       deallocate ( bry )
      IF (allocated(clm))       deallocate ( clm )
      IF (allocated(dai))       deallocate ( dai )
      IF (allocated(dav))       deallocate ( dav )
      IF (allocated(dia))       deallocate ( dia )
      IF (allocated(err))       deallocate ( err )
      IF (allocated(flt))       deallocate ( flt )
      IF (allocated(frc))       deallocate ( frc )
 
#ifdef RBL4DVAR_FCT_SENSITIVITY
      IF (allocated(fcta))      deallocate ( fcta )
      IF (allocated(fctb))      deallocate ( fctb )
#endif
 
#if defined RBL4DVAR_FCT_SENSITIVITY && !defined OBS_SPACE
      IF (allocated(foia))      deallocate ( foia )
      IF (allocated(foib))      deallocate ( foib )
#endif
 
      IF (allocated(fwd))       deallocate ( fwd )
      IF (allocated(grd))       deallocate ( grd )
      IF (allocated(grx))       deallocate ( grx )
      IF (allocated(gst))       deallocate ( gst )
      IF (allocated(har))       deallocate ( har )
      IF (allocated(his))       deallocate ( his )
      IF (allocated(hss))       deallocate ( hss )
      IF (allocated(iad))       deallocate ( iad )
      IF (allocated(ini))       deallocate ( ini )
      IF (allocated(irp))       deallocate ( irp )
      IF (allocated(itl))       deallocate ( itl )
      IF (allocated(lcz))       deallocate ( lcz )
      IF (allocated(lze))       deallocate ( lze )
      IF (allocated(nud))       deallocate ( nud )
      IF (allocated(obs))       deallocate ( obs )
 
#if defined RBL4DVAR_FCT_SENSITIVITY && defined OBS_SPACE
      IF (allocated(oifa))      deallocate ( oifa )
      IF (allocated(oifb))      deallocate ( oifb )
#endif
 
      IF (allocated(qck))       deallocate ( qck )
      IF (allocated(rst))       deallocate ( rst )
 
#ifdef SP4DVAR
      IF (allocated(sca))       deallocate ( sca )
      IF (allocated(sct))       deallocate ( sct )
      IF (allocated(spa))       deallocate ( spa )
      IF (allocated(spt))       deallocate ( spt )
#endif
 
      IF (allocated(ssf))       deallocate ( ssf )
      IF (allocated(sta))       deallocate ( sta )
      IF (allocated(tide))      deallocate ( tide )
      IF (allocated(tlf))       deallocate ( tlf )
      IF (allocated(tlm))       deallocate ( tlm )
      IF (allocated(xtr))       deallocate ( xtr )
 
      IF (allocated(nrm))       deallocate ( nrm )
      IF (allocated(std))       deallocate ( std )
!
!-----------------------------------------------------------------------
!  Deallocate other variables in module.
!-----------------------------------------------------------------------
!
      IF (allocated(bryids))    deallocate ( bryids )
#if defined PIO_LIB && defined DISTRIBUTE
      IF (allocated(brydesc))   deallocate ( brydesc )
#endif
      IF (allocated(clmids))    deallocate ( clmids )
#if defined PIO_LIB && defined DISTRIBUTE
      IF (allocated(clmdesc))   deallocate ( clmdesc )
#endif
      IF (allocated(frcids))    deallocate ( frcids )
#if defined PIO_LIB && defined DISTRIBUTE
      IF (allocated(frcdesc))   deallocate ( frcdesc )
#endif
 
      IF (allocated(nbcfiles))  deallocate ( nbcfiles )
      IF (allocated(nclmfiles)) deallocate ( nclmfiles )
      IF (allocated(nffiles))   deallocate ( nffiles )
!
      RETURN
      END SUBROUTINE deallocate_iounits
 
      END MODULE mod_iounits