mod_ncparam.F

Go to the documentation of this file.

#include "cppdefs.h"
      MODULE mod_ncparam
!
!git $Id$
!================================================== Hernan G. Arango ===
!  Copyright (c) 2002-2025 The ROMS Group                              !
!    Licensed under a MIT/X style license                              !
!    See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  This MODULE contains all the variables associated with input and    !
!  output  NetCDF  files.  The IO model is very generic and easy to    !
!  change or expand.  The NetCDF files can be in any language.  All    !
!  the IO information is managed using the following variables:        !
!                                                                      !
!  Vname      Input/output variables names and attributes:             !
!               Vname(1,*)  => field variable name.                    !
!               Vname(2,*)  => long-name attribute.                    !
!               Vname(3,*)  => units attribute.                        !
!               Vname(4,*)  => field attribute.                        !
!               Vname(5,*)  => associated time variable name.          !
!               Vname(6,*)  => standard-name attribute.                !
!  Tname      Input/output associated time variables names.            !
!                                                                      !
!  Cinfo      Input/output file names associated with each field       !
!                                                                      !
#if defined PIO_LIB && defined DISTRIBUTE
!  Dinfo      Input/output fields descriptors information:             !
!               Dinfo(1,*)  => field variable descriptor.              !
!               Dinfo(2,*)  => associated time variable descriptor.    !
#endif
!  Linfo      Input/output fields logical information:                 !
!               Linfo(1,*)  => switch indicating grided data.          !
!               Linfo(2,*)  => switch indicating time cycling.         !
!               Linfo(3,*)  => switch indicating only one-time         !
!                              record available.                       !
!               Linfo(4,*)  => switch indicating special record        !
!                              processing (like tides)                 !
!               Linfo(5,*)  => switch to indicate processing the first !
!                              record of a file or multi-file.         !
!               Linfo(6,*)  => switch to indicate processing the last  !
!                              record of a file or multi-file.         !
!                                                                      !
!  Iinfo      Input/output fields integer information:                 !
!               Iinfo( 1,*) => variable grid type.                     !
!               Iinfo( 2,*) => field variable NetCDF ID.               !
!               Iinfo( 3,*) => associated time variable NetCDF ID.     !
!               Iinfo( 4,*) => number of time records.                 !
!               Iinfo( 5,*) => size of first  spatial dimension.       !
!               Iinfo( 6,*) => size of second spatial dimension.       !
!               Iinfo( 7,*) => size of third  spatial dimension.       !
!               Iinfo( 8,*) => rolling two-time levels index.          !
!               Iinfo( 9,*) => latest processed time record.           !
!               Iinfo(10,*) => number of field multi-files.            !
!               Iinfo(11,*) => number of variable dimensions in file.  !
!                                                                      !
!  Finfo      Input/output field floating-point information:           !
!               Finfo( 1,*) => Starting time (days) of data.           !
!               Finfo( 2,*) => Ending time (days) of data.             !
!               Finfo( 3,*) => Data time lower bound (days) enclosing  !
!                                model starting time.                  !
!               Finfo( 4,*) => Data time upper bound (days) enclosing  !
!                                model starting time.                  !
!               Finfo( 5,*) => length (days) of time cycling.          !
!               Finfo( 6,*) => Scale to convert time to day units.     !
!               Finfo( 7,*) => latest monotonic time (sec).            !
!               Finfo( 8,*) => minimum value for current data.         !
!               Finfo( 9,*) => maximum value for current data.         !
!               Finfo(10,*) => value of scale_factor attribute if any. !
!  Fscale     Scale to convert input data to model units.              !
!  Fpoint     Latest two-time records of input point data.             !
!  Tintrp     Time (sec) of latest field snapshots used for            !
!               interpolation.                                         !
!  Vtime      Latest two-time values of processed input data.          !
!                                                                      !
!=======================================================================
!
      USE mod_param
#if defined PIO_LIB && defined DISTRIBUTE
      USE mod_iounits
#endif
!
      implicit none
!
      PUBLIC :: allocate_ncparam
      PUBLIC :: deallocate_ncparam
      PUBLIC :: initialize_ncparam
!
!-----------------------------------------------------------------------
!  Define variables in module.
!-----------------------------------------------------------------------
!
!  Set type of IO NetCDF files interface library
!
      integer, parameter :: io_nf90 = 1   ! standard NetCDF-3, NetCDF-4
      integer, parameter :: io_pio  = 2   ! Parallel-IO, SCORPIO
!
      integer :: inp_lib                  ! input  NetCDF library
      integer :: out_lib                  ! output NetCDF library
!
!  Maximum number of variables in a generic NetCDF file (MV) and
!  maximum number of variables in information arrays (NV).
!
      integer, parameter :: mv = 1400
      integer, parameter :: nv = 1400
!
!  Maximum number of dimension IDs stored in local array DimIDs used to
!  defined variable dimensions in output NetCDF files.
!
      integer, parameter :: ndimid = 33
!
!  Number of horizontal interior and boundary water points.
!
      integer, allocatable :: nxyp(:)          ! PSI water points
      integer, allocatable :: nxyr(:)          ! RHO water points
      integer, allocatable :: nxyu(:)          ! U water points
      integer, allocatable :: nxyv(:)          ! V water points
!
!  Number of horizontal interior water points only.
!
      integer, allocatable :: nwaterr(:)       ! RHO water points
      integer, allocatable :: nwateru(:)       ! U water points
      integer, allocatable :: nwaterv(:)       ! V water points
!
!  Lower and upper bound ranges for RHO-type variables for processing
!  state vector and observations.
!
      integer, allocatable :: rilb(:)
      integer, allocatable :: riub(:)
      integer, allocatable :: rjlb(:)
      integer, allocatable :: rjub(:)
!
      real(r8), allocatable :: rxmin(:)
      real(r8), allocatable :: rxmax(:)
      real(r8), allocatable :: rymin(:)
      real(r8), allocatable :: rymax(:)
!
!  Lower and upper bound ranges for U-type variables for processing
!  state vector and observations.
!
      integer, allocatable :: uilb(:)
      integer, allocatable :: uiub(:)
      integer, allocatable :: ujlb(:)
      integer, allocatable :: ujub(:)
!
      real(r8), allocatable :: uxmin(:)
      real(r8), allocatable :: uxmax(:)
      real(r8), allocatable :: uymin(:)
      real(r8), allocatable :: uymax(:)
!
!  Lower and upper bound ranges for V-type variables for processing
!  state vector and observations.
!
      integer, allocatable :: vilb(:)
      integer, allocatable :: viub(:)
      integer, allocatable :: vjlb(:)
      integer, allocatable :: vjub(:)
!
      real(r8), allocatable :: vxmin(:)
      real(r8), allocatable :: vxmax(:)
      real(r8), allocatable :: vymin(:)
      real(r8), allocatable :: vymax(:)
!
!  Switches indicating which variables are written to output files.
!
      logical, allocatable :: aout(:,:)     ! average file switches
      logical, allocatable :: dout(:,:)     ! diagnostic file switches
      logical, allocatable :: hout(:,:)     ! history file switches
      logical, allocatable :: qout(:,:)     ! quicksave file switches
      logical, allocatable :: sout(:,:)     ! station file switches
!
!  Grid identification indices.
!
      integer  :: idxgrd = -1   ! XI-grid position
      integer  :: idygrd = -2   ! ETA-grid position
      integer  :: idzgrd = -3   ! S-grid position
      integer  :: iddpth = -4   ! depth
      integer  :: idglon = -5   ! longitude
      integer  :: idglat = -6   ! latitude
 
#ifdef FLOAT_OYSTER
!
!  Biological floats identification indices.
!
      integer  :: idsize = -7   ! biological float size (length)
      integer  :: idswim = -8   ! biological float swimming time
      integer  :: idwbio = -9   ! biological float w-velocity
      integer  :: idwsin = -10  ! biological float sinking velocity
#endif
!
!  Input/output identification indices.
!
      integer  :: idangr        ! angle between XI-axis and EAST
      integer  :: idbath        ! time-dependent bathymetry
      integer  :: idbger        ! background error at observations
      integer  :: idbgth        ! threshold for BQC check
      integer  :: idcfra        ! cloud fraction
      integer  :: idcosw        ! COS(omega(k)*t)
      integer  :: idcos2        ! COS(omega(k)*t)*COS(omega(l)*t)
      integer  :: iddano        ! density anomaly
      integer  :: iddiff(2)     ! temperature and salinity diffusion
      integer  :: iddqdt        ! heat flux sensitivity to SST
      integer  :: idempf        ! E-P from bulk_flux.F
      integer  :: idevap        ! evaporation rate
      integer  :: idfcor        ! Coriolis parameter
      integer  :: idfsur        ! free-surface
      integer  :: idfsud        ! detided free-surface
      integer  :: idfsuh        ! free-surface tide harmonics
      integer  :: idghat(2)     ! KPP nonlocal transport
      integer  :: idgtnc        ! generic tracer nudging coefficients
      integer  :: idjwty        ! Jerlov water type
      integer  :: idhbbl        ! depth of bottom boundary layer
      integer  :: idhsbl        ! depth of surface boundary layer
      integer  :: idhzdz        ! level thickness
      integer  :: idincr        ! 4D-Var analysis increment
      integer  :: idinno        ! 4D-Var innovation vector
      integer  :: idkhor        ! convolution horizontal diffusion
      integer  :: idkver        ! convolution vertical diffusion
      integer  :: idlatp        ! latitude of PSI-points
      integer  :: idlatr        ! latitude of RHO-points
      integer  :: idlatu        ! latitude of U-points
      integer  :: idlatv        ! latitude of V-points
      integer  :: idldwn        ! downwelling longwave radiation flux
      integer  :: idlonp        ! longitude of PSI-points
      integer  :: idlonr        ! longitude of RHO-points
      integer  :: idlonu        ! longitude of U-points
      integer  :: idlonv        ! longitude of V-points
      integer  :: idlhea        ! net latent heat flux
      integer  :: idlrad        ! net longwave radiation flux
      integer  :: idmadh        ! ADM interpolation weights
      integer  :: idmomi        ! Initial model-observation misfit
      integer  :: idmomf        ! final model-observation misfit
      integer  :: idmskp        ! land/mask on PSI-points
      integer  :: idmskr        ! land/mask on RHO-points
      integer  :: idmsku        ! land/mask on U-points
      integer  :: idmskv        ! land/mask on V-points
      integer  :: idmtke        ! turbulent kinetic energy
      integer  :: idmtls        ! turbulent length scale
      integer  :: idm2nc        ! 2D momentum nudging coefficients
      integer  :: idm3nc        ! 2D momentum nudging coefficients
      integer  :: idnlmf        ! final NLM at observation locations
      integer  :: idnlmi        ! initial NLM at observation locations
      integer  :: idnlmo        ! NLM at observations locations
      integer  :: idnlmp        ! unvetted prior NLM at obs locations
      integer  :: idnlmu        ! unvetted NLM at obs locations
      integer  :: idnobs        ! number of observations
      integer  :: idobsd        ! observations depth
      integer  :: idobss        ! observations screening scale
      integer  :: idobst        ! observations time
      integer  :: idobsx        ! observations X-grid location
      integer  :: idobsy        ! observations Y-grid location
      integer  :: idobsz        ! observations Z-grid location
      integer  :: idoday        ! observations survey time
      integer  :: idoerr        ! observations error
      integer  :: idolat        ! observations latitude
      integer  :: idolon        ! observations longitude
      integer  :: idomet        ! observations meta value
      integer  :: idopro        ! observations provenance
      integer  :: idotyp        ! observations type
      integer  :: idoval        ! observations value
      integer  :: idovel        ! omega vertical velocity
      integer  :: idovil        ! omega vertical velocity implicit
      integer  :: idpair        ! surface air pressure
      integer  :: idpbar        ! streamfunction
      integer  :: idpwet        ! wet/dry mask on PSI-points
      integer  :: idpmdx        ! inverse grid x-spacing
      integer  :: idpndy        ! inverse grid y-spacing
      integer  :: idpthr        ! depths of RHO-points
      integer  :: idpthu        ! depths of U-points
      integer  :: idpthv        ! depths of V-points
      integer  :: idpthw        ! depths of W-points
      integer  :: idqair        ! surface air humidity
      integer  :: idrdir        ! river runoff direction
      integer  :: idrepo        ! river runoff ETA-positions
      integer  :: idrflg        ! river runoff flag
      integer  :: idrtra        ! river runoff mass transport
      integer  :: idruct        ! RHS of U-momentum coupling term
      integer  :: idru2d        ! RHS of 2D U-momentum
      integer  :: idru3d        ! RHS of total U-momentum
      integer  :: idrvct        ! RHS of V-momentum coupling term
      integer  :: idrv2d        ! RHS of 2D V-momentum
      integer  :: idrv3d        ! RHS of total V-momentum
      integer  :: idrxpo        ! river runoff XI-positions
      integer  :: idrvsh        ! river runoff transport profile
      integer  :: idrwet        ! wet/dry mask on RHO-points
      integer  :: idrzet        ! RHS of free-surface
      integer  :: idrain        ! rainfall rate
      integer  :: idragl        ! bottom linear drag coefficient
      integer  :: idragq        ! bottom quadratic drag coefficient
      integer  :: idsdif        ! vertical S-diffusion coefficient
      integer  :: idsinw        ! SIN(omega(k)*t)
      integer  :: idsin2        ! SIN(omega(k)*t)*SIN(omega(l)*t)
      integer  :: idsrad        ! net shortwave radiation flux
      integer  :: idsshc        ! SSH climatology
      integer  :: idsssc        ! SSS climatology
      integer  :: idsstc        ! SST climatology
      integer  :: idshea        ! net sensible heat flux
      integer  :: idswcw        ! SIN(omega(k)*t)*COS(omega(l)*t)
      integer  :: idresi        ! 4D-Var residual vector
      integer  :: idsfwf        ! surface freswater flux
      integer  :: idscor        ! ADM sensitivity scope RHO-mask
      integer  :: idscou        ! ADM sensitivity scope U-mask
      integer  :: idscov        ! ADM sensitivity scope V-mask
      integer  :: idtlmo        ! TLM at observation locations
      integer  :: idtair        ! surface air temperature
      integer  :: idtdif        ! vertical T-diffusion coefficient
      integer  :: idtime        ! ocean time
      integer  :: idtopo        ! time-independent bathymetry
      integer  :: idtref        ! tidal reference date for zero phase
      integer  :: idtper        ! tidal period
      integer  :: idtvan        ! tidal current angle
      integer  :: idtvma        ! maximum tidal current
      integer  :: idtvmi        ! minimum tidal current
      integer  :: idtvph        ! tidal current phase
      integer  :: idtzam        ! tidal elevation amplitude
      integer  :: idtzph        ! tidal elevation phase
      integer  :: idu2da        ! accumulated 2D U-velocity
      integer  :: idu2rs        ! 2D total U-radiation stress
      integer  :: idu3rs        ! 3D total U-radiation stress
      integer  :: idu2sd        ! 2D U-Stokes velocity
      integer  :: idu3sd        ! 3D U-Stokes velocity
      integer  :: iduads        ! 3D U-velocity adjoint sensitivity
      integer  :: iduair        ! surface U-wind
      integer  :: iduaie        ! Eastward surface U-wind
      integer  :: idubar        ! 2D U-velocity
      integer  :: idubas        ! 2D U-velocity adjoint sensitivity
      integer  :: idubcl        ! 2D U-velocity climatology
      integer  :: idubcs        ! bottom max U-momentum-wave stress
      integer  :: idubed        ! bed load U-direction
      integer  :: idubms        ! bottom U-momentum stress
      integer  :: idubot        ! bed wave orbital U-velocity
      integer  :: idubrs        ! bottom U-current stress
      integer  :: idubtf        ! 2D U-velocity impulse forcing
      integer  :: idubur        ! bottom U-velocity above bed
      integer  :: idubws        ! bottom U-wave stress
      integer  :: iduclm        ! 3D U-velocity climatology
      integer  :: idufx1        ! time averaged U-flux for 2D
      integer  :: idufx2        ! time averaged U-flux for 3D
      integer  :: idusms        ! surface U-momentum stress
      integer  :: idusue        ! model surface eastward velocity
      integer  :: idusur        ! surface U-velocity
      integer  :: idutlf        ! 3D U-velocity impulse forcing
      integer  :: iduvel        ! 3D U-velocity
      integer  :: iduvwc        ! bottom wave-current stress magnitude
      integer  :: iduwav        ! 2D U-velocity Kirby and Chen
      integer  :: iduwet        ! wet/dry mask on U-points
      integer  :: idu2dd        ! detided 2D U-velocity
      integer  :: idu2dh        ! 2D U-velocity tide harmonics
      integer  :: idu2de        ! 2D eastward velocity at RHO-points
      integer  :: idu3dd        ! detided 3D U-velocity
      integer  :: idu3dh        ! 3D U-velocity tide harmonics
      integer  :: idu3de        ! 3D eastward velocity at RHO-points
      integer  :: idv2rs        ! 2D total V-radiation stress
      integer  :: idv3rs        ! 3D total V-radiation stress
      integer  :: idv2sd        ! 2D U-Stokes velocity
      integer  :: idv3sd        ! 3D U-Stokes velocity
      integer  :: idvads        ! 3D V-velocity adjoint sensitivity
      integer  :: idvair        ! surface V-wind
      integer  :: idvain        ! Northward surface V-wind
      integer  :: idvbar        ! 2D V-velocity
      integer  :: idvbas        ! 2D V-velocity adjoint sensitivity
      integer  :: idvbcl        ! 2D V-velocity climatology
      integer  :: idvbcs        ! bottom max V-current-wave stress
      integer  :: idvbed        ! bed load V-direction
      integer  :: idvbms        ! bottom V-momentum stress
      integer  :: idvbot        ! bed wave orbital V-velocity
      integer  :: idvbrs        ! bottom V-current stress
      integer  :: idvbtf        ! 2D V-velocity impulse forcing
      integer  :: idvbvr        ! bottom V-velocity above bed
      integer  :: idvbws        ! bottom V-wave stress
      integer  :: idvclm        ! 3D V-velocity climatology
      integer  :: idvfx1        ! 2D momentum time-averaged V-flux
      integer  :: idvfx2        ! 3D momentum time-averaged V-flux
      integer  :: idvmls        ! vertical mixing length scale
      integer  :: idvmkk        ! Kinetic energy vertical mixing
      integer  :: idvmkp        ! Length scale vertical mixing
      integer  :: idvsms        ! surface V-momentum stress
      integer  :: idvsun        ! model surface northward velocity
      integer  :: idvsur        ! surface V-velocity
      integer  :: idvtlf        ! 3D V-velocity impulse forcing
      integer  :: idvvel        ! 3D V-velocity
      integer  :: idvvis        ! vertical viscosity coefficient
      integer  :: idvwav        ! 2D V-velocity Kirby and Chen
      integer  :: idvwet        ! wet/dry mask on V-points
      integer  :: idv2dd        ! detided 2D U-velocity
      integer  :: idv2dh        ! 2D U-velocity tide harmonics
      integer  :: idv2dn        ! 2D northward velocity at RHO-points
      integer  :: idv3dd        ! detided 3D U-velocity
      integer  :: idv3dh        ! 3D U-velocity tide harmonics
      integer  :: idv3dn        ! 3D northward velocity at RHO-points
      integer  :: idw3sd        ! 3D W-Stokes omega drift velocity
      integer  :: idw3st        ! 3D W-Stokes vertical drift velocity
      integer  :: idw2xx        ! 2D radiation stress, Sxx-component
      integer  :: idw2xy        ! 2D radiation stress, Sxy-component
      integer  :: idw2yy        ! 2D radiation stress, Syy-component
      integer  :: idw3xx        ! 3D radiation stress, Sxx-component
      integer  :: idw3xy        ! 3D radiation stress, Sxy-component
      integer  :: idw3yy        ! 3D radiation stress, Syy-component
      integer  :: idw3zx        ! 3D radiation stress, Szx-component
      integer  :: idw3zy        ! 3D radiation stress, Szy-component
      integer  :: idwads        ! 3D W-velocity adjoint sensitivity
      integer  :: idwamp        ! wind-induced wave amplitude
      integer  :: idwam2        ! wind-induced wave amplitude squared
      integer  :: idwbeh        ! wec Bernoulli head
      integer  :: idwbrk        ! wind-induced wave breaking
      integer  :: idwdib        ! wave dissipation from surface breaking
      integer  :: idwdif        ! wave dissipation from bottom friction
      integer  :: idwdip        ! wind-induced peak wave direction
      integer  :: idwdir        ! wind-induced mean wave direction
      integer  :: idwdis        ! wind-induced wave roller dissipation
      integer  :: idwdiw        ! wave dissipation from whitecapping
      integer  :: idwlen        ! wind-induced mean wave length
      integer  :: idwlep        ! wind-induced peak wave length
      integer  :: idwmsk        ! wet-dry mask
      integer  :: idworb        ! wind-induced wave orbital velocity
      integer  :: idwptp        ! wind-induced surface wave period
      integer  :: idwpbt        ! wind-induced bottom wave period
      integer  :: idwqsp        ! wec quasi-static pressure
      integer  :: idwrol        ! wave roller action density
      integer  :: idwvds        ! wave directional spread
      integer  :: idwvel        ! true vertical velocity
      integer  :: idwvqp        ! wave spectrum peakedness
      integer  :: idwztw        ! wec quasi-static sea level adjustment
      integer  :: idxgrp        ! x-locations of PSI-points
      integer  :: idxgrr        ! x-locations of RHO-points
      integer  :: idxgru        ! x-locations of U-points
      integer  :: idxgrv        ! x-locations of V-points
      integer  :: idygrp        ! y-locations of PSI-points
      integer  :: idygrr        ! y-locations of RHO-points
      integer  :: idygru        ! y-locations of U-points
      integer  :: idygrv        ! y-locations of V-points
      integer  :: idzobl        ! bottom roughness length
      integer  :: idzads        ! Free-surface adjoint sensitivity
      integer  :: idztlf        ! Free-surface impulse forcing
      integer  :: id2dpv        ! 2D potential vorticity
      integer  :: id2drv        ! 2D relative vorticity
      integer  :: id3dpv        ! 3D potential vorticity
      integer  :: id3drv        ! 3D relative vorticity
!
!  Last used variable ID counter.
!
      integer  :: last_varid
!
!  Input/output identification tracer indices.
!
      integer, allocatable :: idrtrc(:)    ! river runoff for tracers
      integer, allocatable :: idsurt(:)    ! model surface tracers
      integer, allocatable :: idtads(:)    ! tracers adjoint sentivity
      integer, allocatable :: idtbot(:)    ! bottom flux for tracers
      integer, allocatable :: idtbry(:,:)  ! tracers boundary
      integer, allocatable :: idtclm(:)    ! tracers climatology
      integer, allocatable :: idtnud(:)    ! tracers nudge coefficient
      integer, allocatable :: idtsur(:)    ! surface flux for tracers
      integer, allocatable :: idttlf(:)    ! tracers impulse forcing
!
!  Boundary conditions identification indices.
!
      integer  :: idu2bc(4)      ! 2D U-velocity boundary conditions
      integer  :: idu3bc(4)      ! 3D U-velocity boundary conditions
      integer  :: idv2bc(4)      ! 2D V-velocity boundary conditions
      integer  :: idv3bc(4)      ! 3D V-velocity boundary conditions
      integer  :: idzbry(4)      ! free-surface boundary conditions
!
!  Time-averaged quadratic terms IDs.
!
      integer  :: idu2av                    ! <ubar*ubar>
      integer  :: idv2av                    ! <vbar*vbar>
      integer  :: idzzav                    ! <zeta*zeta>
 
      integer  :: idhuav                    ! <Huon>
      integer  :: idhvav                    ! <Hvom>
      integer  :: iduuav                    ! <u*u>
      integer  :: iduvav                    ! <u*v>
      integer  :: idvvav                    ! <v*v>
 
      integer, allocatable :: ihutav(:)     ! <Huon*t> for active tracers
      integer, allocatable :: ihvtav(:)     ! <Hvom*t> for active tracers
      integer, allocatable :: idttav(:)     ! <t*t> for active tracers
      integer, allocatable :: idutav(:)     ! <u*t> for active tracers
      integer, allocatable :: idvtav(:)     ! <v*t> for active tracers
 
#ifdef DIAGNOSTICS
!
!  Tracer/Momentum Diagnostic variable IDs.
!
      integer, allocatable :: iddtrc(:,:)   ! tracers terms
      integer, allocatable :: iddu2d(:)     ! 2D u-momentum terms
      integer, allocatable :: iddv2d(:)     ! 2D v-momentum terms
      integer, allocatable :: iddu3d(:)     ! 3D u-momentum terms
      integer, allocatable :: iddv3d(:)     ! 3D v-momentum terms
#endif
!
!  State variables indices (order is important). Notice that current
!  extra-observations index (isRadial) needs to be initialized to zero
!  here and reset elsewhere to the value provided by the user.
!  Currently, the maximum number of state variables in 3D applications
!  is 9+2*MT. If MT=2 (temperature and salinity), the state variables
!  have the following order:
!
!     1,   2,   3,4,5,      6,      7,  8,9,  10,  11,     12,     13
!  zeta,ubar,vbar,u,v,Tvar(1),Tvar(2),TKE,W,Ustr,Vstr,Tsur(1),Tsur(2)
!
      integer  :: isfsur = 1                ! free-surface
      integer  :: isubar = 2                ! 2D U-velocity
      integer  :: isvbar = 3                ! 2D V-velocity
      integer  :: isuvel = 4                ! 3D U-velocity
      integer  :: isvvel = 5                ! 3D V-velocity
      integer  :: iswvel                    ! 3D W-velocity
      integer  :: isradial = 0              ! HF radial-velocity
      integer  :: isustr                    ! surface u-stress
      integer  :: isvstr                    ! surface v-stress
      integer  :: ismtke                    ! turbulent kinetic energy
#ifdef WEC
      integer  :: isu2sd                    ! 2D U-stokes velocity
      integer  :: isv2sd                    ! 2D V-stokes velocity
      integer  :: isu3sd                    ! 3D U-stokes velocity
      integer  :: isv3sd                    ! 3D V-stokes velocity
#endif
      integer, allocatable :: istsur(:)     ! surface tracer flux
      integer, allocatable :: istvar(:)     ! tracers
      integer, allocatable :: idbvar(:)     ! LBC variables indices
      integer, allocatable :: idsvar(:)     ! state vector indices
      integer, allocatable :: idsbry(:)     ! state boundaries indices
!
!  Generic state variables lateral boundary indices.
!
      integer  :: isbp2d                    ! 2D PSI-variables
      integer  :: isbr2d                    ! 2D RHO-variables
      integer  :: isbu2d                    ! 2D U-variables
      integer  :: isbv2d                    ! 2D V-variables
      integer  :: isbp3d                    ! 3D PSI-variables
      integer  :: isbr3d                    ! 3D RHO-variables
      integer  :: isbu3d                    ! 3D U-variables
      integer  :: isbv3d                    ! 3D V-variables
      integer  :: isbw3d                    ! 3D W-variables
!
!  Input lateral boundary, climatology, and forcing NetCDF files IDs
!  for each processing field. It facilitates the multi-file option:
!  each field can be in its own file.
!
      integer, allocatable :: bryncid(:,:)
      integer, allocatable :: clmncid(:,:)
      integer, allocatable :: frcncid(:,:)
 
#if defined PIO_LIB && defined DISTRIBUTE
!
!  Input lateral boundary, climatology, and forcing NetCDF files
!  descriptors for each processing field. It facilitates the
!  multi-file option: each field can be in its own file.
!
      TYPE (file_desc_t), pointer :: brypiofile(:,:)
      TYPE (file_desc_t), pointer :: clmpiofile(:,:)
      TYPE (file_desc_t), pointer :: frcpiofile(:,:)
#endif
!
!  Flags to create output files.
!
      integer, allocatable :: idefadj(:)    ! adjoint file
      integer, allocatable :: idefavg(:)    ! averages file
      integer, allocatable :: idefdia(:)    ! diagnostics file
      integer, allocatable :: idefhis(:)    ! history file
      integer, allocatable :: idefqck(:)    ! quicksave file
      integer, allocatable :: ideftlm(:)    ! tangent file
      integer, allocatable :: idefxtr(:)    ! extraction file
!
!  Output NetCDF variables IDs.
!
      integer, allocatable :: idtvar(:)     ! tracers variables
      integer, allocatable :: idtrcd(:)     ! detided tracer variables
      integer, allocatable :: idtrch(:)     ! tracer variables hamonics
!
!  Input/Output information variables.
!
      logical, allocatable :: linfo(:,:,:)
!
      integer, parameter :: maxlen = 160    ! information string length
 
      integer, allocatable :: iinfo(:,:,:)
!
      real(dp), allocatable :: finfo(:,:,:)
      real(dp), allocatable :: fpoint(:,:,:)
      real(dp), allocatable :: fscale(:,:)
      real(dp), allocatable :: tintrp(:,:,:)
      real(dp), allocatable :: vtime(:,:,:)
!
      character (len=5  )    :: version = '4.3  '
      character (len=40 )    :: varnam(mv)
      character (len=44 )    :: date_str
      character (len=46 )    :: tname(0:nv)
      character (len=MaxLen) :: history
      character (len=MaxLen) :: vname(6,0:nv)
 
      character (len=256), allocatable :: cinfo(:,:)
 
#if defined PIO_LIB && defined DISTRIBUTE
!
      TYPE (my_vardesc), pointer :: dinfo(:,:,:)
#endif
!
!  Analyical header file logical and names.
!
      logical :: lanafile
!
      character (len=256), dimension(39) :: ananame
 
#ifdef BIOLOGY
!
!  Biology models file logical and names.
!
      logical, dimension(4) :: lbiofile
!
      character (len=256), dimension(4) :: bioname
#endif
!
!  GIT and SVN revision and repository root URL.
!
      character (len=80 ) :: git_rev, svn_rev
      character (len=256) :: git_url, svn_url
!
      CONTAINS
!
      SUBROUTINE allocate_ncparam
!
!=======================================================================
!                                                                      !
!  This routine allocates several variables in the module that depend  !
!  on the number of nested grids.                                      !
!                                                                      !
!=======================================================================
!
      USE mod_param
!
!  Local variable declarations.
!
      integer :: ng
!
!-----------------------------------------------------------------------
!  Allocate variables.
!-----------------------------------------------------------------------
!
      IF (.not.allocated(nxyp)) THEN
        allocate ( nxyp(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(nxyr)) THEN
        allocate ( nxyr(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(nxyu)) THEN
        allocate ( nxyu(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(nxyv)) THEN
        allocate ( nxyv(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(nwaterr)) THEN
        allocate ( nwaterr(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(nwateru)) THEN
        allocate ( nwateru(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(nwaterv)) THEN
        allocate ( nwaterv(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(rilb)) THEN
        allocate ( rilb(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(riub)) THEN
        allocate ( riub(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(rjlb)) THEN
        allocate ( rjlb(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(rjub)) THEN
        allocate ( rjub(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(rxmin)) THEN
        allocate ( rxmin(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(rxmax)) THEN
        allocate ( rxmax(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(rymin)) THEN
        allocate ( rymin(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(rymax)) THEN
        allocate ( rymax(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(uilb)) THEN
        allocate ( uilb(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(uiub)) THEN
        allocate ( uiub(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(ujlb)) THEN
        allocate ( ujlb(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(ujub)) THEN
        allocate ( ujub(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(uxmin)) THEN
        allocate ( uxmin(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(uxmax)) THEN
        allocate ( uxmax(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(uymin)) THEN
        allocate ( uymin(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(uymax)) THEN
        allocate ( uymax(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(vilb)) THEN
        allocate ( vilb(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(viub)) THEN
        allocate ( viub(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(vjlb)) THEN
        allocate ( vjlb(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(vjub)) THEN
        allocate ( vjub(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(vxmin)) THEN
        allocate ( vxmin(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(vxmax)) THEN
        allocate ( vxmax(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(vymin)) THEN
        allocate ( vymin(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(vymax)) THEN
        allocate ( vymax(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(aout)) THEN
        allocate ( aout(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(dout)) THEN
        allocate ( dout(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(hout)) THEN
        allocate ( hout(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(qout)) THEN
        allocate ( qout(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(sout)) THEN
        allocate ( sout(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
 
      IF (.not.allocated(idrtrc)) THEN
        allocate ( idrtrc(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idsurt)) THEN
        allocate ( idsurt(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idtads)) THEN
        allocate ( idtads(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idtbot)) THEN
        allocate ( idtbot(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idtbry)) THEN
        allocate ( idtbry(4,mt) )
        dmem(1)=dmem(1)+4.0_r8*real(mt,r8)
      END IF
      IF (.not.allocated(idtclm)) THEN
        allocate ( idtclm(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idtnud)) THEN
        allocate ( idtnud(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idtsur)) THEN
        allocate ( idtsur(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idttlf)) THEN
        allocate ( idttlf(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
 
      IF (.not.allocated(ihutav)) THEN
        allocate ( ihutav(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(ihvtav)) THEN
        allocate ( ihvtav(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idttav)) THEN
        allocate ( idttav(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idutav)) THEN
        allocate ( idutav(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idvtav)) THEN
        allocate ( idvtav(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
 
#ifdef DIAGNOSTICS
      IF (.not.allocated(iddtrc)) THEN
        allocate ( iddtrc(mt,ndt) )
        dmem(1)=dmem(1)+real(mt*ndt,r8)
      END IF
      IF (.not.allocated(iddu2d)) THEN
        allocate ( iddu2d(ndm2d) )
        dmem(1)=dmem(1)+real(ndm2d,r8)
      END IF
      IF (.not.allocated(iddv2d)) THEN
        allocate ( iddv2d(ndm2d) )
        dmem(1)=dmem(1)+real(ndm2d,r8)
      END IF
      IF (.not.allocated(iddu3d)) THEN
        allocate ( iddu3d(ndm3d) )
        dmem(1)=dmem(1)+real(ndm3d,r8)
      END IF
      IF (.not.allocated(iddv3d)) THEN
        allocate ( iddv3d(ndm3d) )
        dmem(1)=dmem(1)+real(ndm3d,r8)
      END IF
#endif
 
      IF (.not.allocated(istsur)) THEN
        allocate ( istsur(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(istvar)) THEN
        allocate ( istvar(mt) )
        istvar=0
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idbvar)) THEN
        allocate ( idbvar(nlbcvar) )
        idbvar=0
        dmem(1)=dmem(1)+real(nlbcvar,r8)
      END IF
      IF (.not.allocated(idsvar)) THEN
        allocate ( idsvar(maxval(nsv)) )
        idsvar=0
        dmem(1)=dmem(1)+real(maxval(nsv),r8)
      END IF
      IF (.not.allocated(idsbry)) THEN
        allocate ( idsbry(maxval(nsv)) )
        idsbry=0
        dmem(1)=dmem(1)+real(maxval(nsv),r8)
      END IF
 
      IF (.not.allocated(bryncid)) THEN
        allocate ( bryncid(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(clmncid)) THEN
        allocate ( clmncid(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(frcncid)) THEN
        allocate ( frcncid(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
 
#if defined PIO_LIB && defined DISTRIBUTE
      IF (.not.associated(brypiofile)) THEN
        allocate ( brypiofile(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.associated(clmpiofile)) THEN
        allocate ( clmpiofile(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.associated(frcpiofile)) THEN
        allocate ( frcpiofile(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
#endif
 
      IF (.not.allocated(idefadj)) THEN
        allocate ( idefadj(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(idefavg)) THEN
        allocate ( idefavg(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(idefdia)) THEN
        allocate ( idefdia(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(idefhis)) THEN
        allocate ( idefhis(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(idefqck)) THEN
        allocate ( idefqck(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(ideftlm)) THEN
        allocate ( ideftlm(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
      IF (.not.allocated(idefxtr)) THEN
        allocate ( idefxtr(ngrids) )
        dmem(1)=dmem(1)+real(ngrids,r8)
      END IF
 
      IF (.not.allocated(idtvar)) THEN
        allocate ( idtvar(mt) )
        dmem(1)=dmem(1)+real(mt,r8)
      END IF
      IF (.not.allocated(idtrcd)) THEN
        allocate ( idtrcd(nat) )
        dmem(1)=dmem(1)+real(nat,r8)
      END IF
      IF (.not.allocated(idtrch)) THEN
        allocate ( idtrch(nat) )
        dmem(1)=dmem(1)+real(nat,r8)
      END IF
 
      IF (.not.allocated(linfo)) THEN
        allocate ( linfo(6,nv,ngrids) )
        dmem(1)=dmem(1)+6.0_r8*real(nv*ngrids,r8)
      END IF
 
      IF (.not.allocated(iinfo)) THEN
        allocate ( iinfo(11,nv,ngrids) )
        dmem(1)=dmem(1)+10.0_r8*real(nv*ngrids,r8)
      END IF
 
      IF (.not.allocated(finfo)) THEN
        allocate ( finfo(10,nv,ngrids) )
        dmem(1)=dmem(1)+10.0_r8*real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(fpoint)) THEN
        allocate ( fpoint(2,nv,ngrids) )
        dmem(1)=dmem(1)+2.0_r8*real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(fscale)) THEN
        allocate ( fscale(nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
      IF (.not.allocated(tintrp)) THEN
        allocate ( tintrp(2,nv,ngrids) )
        dmem(1)=dmem(1)+2.0_r8*real(nv*ngrids,r8)
      END IF
 
#if defined SSH_TIDES || defined UV_TIDES
      IF (.not.allocated(vtime)) THEN
        allocate ( vtime(max(2,mtc),nv,ngrids) )
        dmem(1)=dmem(1)+real(max(2,mtc)*nv*ngrids,r8)
      END IF
#else
      IF (.not.allocated(vtime)) THEN
        allocate ( vtime(2,nv,ngrids) )
        dmem(1)=dmem(1)+real(nv*ngrids,r8)
      END IF
#endif
 
      IF (.not.allocated(cinfo)) THEN
        allocate ( cinfo(nv,ngrids) )
        dmem(1)=dmem(1)+0.125_r8*256.0_r8*real(nv*ngrids,r8)
      END IF
 
#if defined PIO_LIB && defined DISTRIBUTE
      IF (.not.associated(dinfo)) THEN
        allocate ( dinfo(2,nv,ngrids) )
        dmem(1)=dmem(1)+2.0_r8*real(nv*ngrids,r8)
      END IF
#endif
!
      RETURN
      END SUBROUTINE allocate_ncparam
!
      SUBROUTINE deallocate_ncparam
!
!=======================================================================
!                                                                      !
!  This routine deallocates variables in the module.                   !
!  on the number of nested grids.                                      !
!                                                                      !
!=======================================================================
!
!-----------------------------------------------------------------------
!  Deallocate variables in module.
!-----------------------------------------------------------------------
!
      IF (allocated(nxyp))        deallocate ( nxyp )
      IF (allocated(nxyr))        deallocate ( nxyr )
      IF (allocated(nxyu))        deallocate ( nxyu )
      IF (allocated(nxyv))        deallocate ( nxyv )
      IF (allocated(nwaterr))     deallocate ( nwaterr )
      IF (allocated(nwateru))     deallocate ( nwateru )
      IF (allocated(nwaterv))     deallocate ( nwaterv )
      IF (allocated(rilb))        deallocate ( rilb )
      IF (allocated(riub))        deallocate ( riub )
      IF (allocated(rjlb))        deallocate ( rjlb )
      IF (allocated(rjub))        deallocate ( rjub )
      IF (allocated(rxmin))       deallocate ( rxmin )
      IF (allocated(rxmax))       deallocate ( rxmax )
      IF (allocated(rymin))       deallocate ( rymin )
      IF (allocated(rymax))       deallocate ( rymax )
      IF (allocated(uilb))        deallocate ( uilb )
      IF (allocated(uiub))        deallocate ( uiub )
      IF (allocated(ujlb))        deallocate ( ujlb )
      IF (allocated(ujub))        deallocate ( ujub )
      IF (allocated(uxmin))       deallocate ( uxmin )
      IF (allocated(uxmax))       deallocate ( uxmax )
      IF (allocated(uymin))       deallocate ( uymin )
      IF (allocated(uymax))       deallocate ( uymax )
      IF (allocated(vilb))        deallocate ( vilb )
      IF (allocated(viub))        deallocate ( viub )
      IF (allocated(vjlb))        deallocate ( vjlb )
      IF (allocated(vjub))        deallocate ( vjub )
      IF (allocated(vxmin))       deallocate ( vxmin )
      IF (allocated(vxmax))       deallocate ( vxmax )
      IF (allocated(vymin))       deallocate ( vymin )
      IF (allocated(vymax))       deallocate ( vymax )
!
      IF (allocated(aout))        deallocate ( aout )
      IF (allocated(dout))        deallocate ( dout )
      IF (allocated(hout))        deallocate ( hout )
      IF (allocated(qout))        deallocate ( qout )
      IF (allocated(sout))        deallocate ( sout )
!
      IF (allocated(idrtrc))      deallocate ( idrtrc )
      IF (allocated(idsurt))      deallocate ( idsurt )
      IF (allocated(idtads))      deallocate ( idtads )
      IF (allocated(idtbot))      deallocate ( idtbot )
      IF (allocated(idtbry))      deallocate ( idtbry )
      IF (allocated(idtclm))      deallocate ( idtclm )
      IF (allocated(idtnud))      deallocate ( idtnud )
      IF (allocated(idtsur))      deallocate ( idtsur )
      IF (allocated(idttlf))      deallocate ( idttlf )
!
      IF (allocated(ihutav))      deallocate ( ihutav )
      IF (allocated(ihvtav))      deallocate ( ihvtav )
      IF (allocated(idttav))      deallocate ( idttav )
      IF (allocated(idutav))      deallocate ( idutav )
      IF (allocated(idvtav))      deallocate ( idvtav )
 
#ifdef DIAGNOSTICS
!
      IF (allocated(iddtrc))      deallocate ( iddtrc )
      IF (allocated(iddu2d))      deallocate ( iddu2d )
      IF (allocated(iddv2d))      deallocate ( iddv2d )
      IF (allocated(iddu3d))      deallocate ( iddu3d )
      IF (allocated(iddv3d))      deallocate ( iddv3d )
#endif
!
      IF (allocated(istsur))      deallocate ( istsur )
      IF (allocated(istvar))      deallocate ( istvar )
      IF (allocated(idbvar))      deallocate ( idbvar )
      IF (allocated(idsvar))      deallocate ( idsvar )
      IF (allocated(idsbry))      deallocate ( idsbry )
!
      IF (allocated(bryncid))     deallocate ( bryncid )
      IF (allocated(clmncid))     deallocate ( clmncid )
      IF (allocated(frcncid))     deallocate ( frcncid )
 
#if defined PIO_LIB && defined DISTRIBUTE
!
      IF (associated(brypiofile)) deallocate ( brypiofile )
      IF (associated(clmpiofile)) deallocate ( clmpiofile )
      IF (associated(frcpiofile)) deallocate ( frcpiofile )
#endif
!
      IF (allocated(idefadj))     deallocate ( idefadj )
      IF (allocated(idefavg))     deallocate ( idefavg )
      IF (allocated(idefdia))     deallocate ( idefdia )
      IF (allocated(idefhis))     deallocate ( idefhis )
      IF (allocated(idefqck))     deallocate ( idefqck )
      IF (allocated(ideftlm))     deallocate ( ideftlm )
      IF (allocated(idefxtr))     deallocate ( idefxtr )
!
      IF (allocated(idtvar))      deallocate ( idtvar )
      IF (allocated(idtrcd))      deallocate ( idtrcd )
      IF (allocated(idtrch))      deallocate ( idtrch )
!
      IF (allocated(linfo))       deallocate ( linfo )
      IF (allocated(iinfo))       deallocate ( iinfo )
      IF (allocated(finfo))       deallocate ( finfo )
      IF (allocated(fpoint))      deallocate ( fpoint )
      IF (allocated(fscale))      deallocate ( fscale )
      IF (allocated(tintrp))      deallocate ( tintrp )
      IF (allocated(vtime))       deallocate ( vtime )
      IF (allocated(cinfo))       deallocate ( cinfo )
 
#if defined PIO_LIB && defined DISTRIBUTE
      IF (associated(dinfo))      deallocate ( dinfo )
#endif
!
      RETURN
      END SUBROUTINE deallocate_ncparam
!
      SUBROUTINE initialize_ncparam
!
!=======================================================================
!                                                                      !
!  This routine initializes all variables in module "mod_ncparam" for  !
!  all nested grids.                                                   !
!                                                                      !
!=======================================================================
!
      USE mod_parallel
#ifdef BIOLOGY
      USE mod_biology
#endif
#ifdef SEAICE
      USE mod_ice
#endif
      USE mod_iounits
      USE mod_scalars
#if defined SEDIMENT || defined BBL_MODEL
      USE mod_sediment
#endif
!
      USE get_metadata_mod, ONLY : io_metadata
      USE strings_mod,      ONLY : founderror, standardname
!
!  Local variable declarations.
!
      logical :: firstpass, ldone, load
!
#ifdef DISTRIBUTE
      integer :: itile, jtile
#endif
      integer :: lvar, ntiles, i, ic, ic_brylast, j, ng
      integer :: gtype, tile, varid
!
      real(dp), parameter :: spv = 0.0_dp
      real(dp) :: add_offset, scale
!
      character (len=MaxLen) :: string
      character (len=MaxLen), dimension(8) :: vinfo
 
      character (len=*), parameter :: myfile =                          &
     &  __FILE__//"initialize_ncparam"
!
!-----------------------------------------------------------------------
!  Initialize several variables.
!-----------------------------------------------------------------------
!
!  Initialize DOMAIN structure.
!
      DO ng=1,ngrids
        domain(ng) % Eastern_Edge  = .false.
        domain(ng) % Western_Edge  = .false.
        domain(ng) % Northern_Edge = .false.
        domain(ng) % Southern_Edge = .false.
 
        domain(ng) % NorthEast_Corner = .false.
        domain(ng) % NorthWest_Corner = .false.
        domain(ng) % SouthEast_Corner = .false.
        domain(ng) % SouthWest_Corner = .false.
 
        domain(ng) % NorthEast_Test = .false.
        domain(ng) % NorthWest_Test = .false.
        domain(ng) % SouthEast_Test = .false.
        domain(ng) % SouthWest_Test = .false.
 
        domain(ng) % Xmin_psi = spv
        domain(ng) % Xmax_psi = spv
        domain(ng) % Ymin_psi = spv
        domain(ng) % Ymax_psi = spv
 
        domain(ng) % Xmin_rho = spv
        domain(ng) % Xmax_rho = spv
        domain(ng) % Ymin_rho = spv
        domain(ng) % Ymax_rho = spv
 
        domain(ng) % Xmin_u   = spv
        domain(ng) % Xmax_u   = spv
        domain(ng) % Ymin_u   = spv
        domain(ng) % Ymax_u   = spv
 
        domain(ng) % Xmin_v   = spv
        domain(ng) % Xmax_v   = spv
        domain(ng) % Ymin_v   = spv
        domain(ng) % Ymax_v   = spv
      END DO
!
!  Initialize NetCDF files creation flags.
!
      DO ng=1,ngrids
        idefadj(ng)=-1
        idefavg(ng)=-1
        idefdia(ng)=-1
        idefhis(ng)=-1
        idefqck(ng)=-1
        ideftlm(ng)=-1
        idefxtr(ng)=-1
      END DO
!
!  Analytical files switch and names.
!
      lanafile=.true.
      DO i=1,SIZE(ananame)
        DO j=1,len(ananame(1))
          ananame(i)(j:j)=' '
        END DO
      END DO
 
#ifdef BIOLOGY
!
!  Biology model header names.
!
      DO i=1,4
        lbiofile(i)=.true.
        DO j=1,len(bioname(1))
          bioname(i)(j:j)=' '
        END DO
      END DO
#endif
!
!  Set indices for state some state variables.
!
      ic=5
#ifdef SOLVE3D
      DO i=1,mt
        ic=ic+1
        istvar(i)=ic
      END DO
#endif
#if defined ADJUST_WSTRESS || defined FORCING_SV     || \
    defined hessian_fsv    || defined so_semi        || \
    defined stochastic_opt
      ic=ic+1
      isustr=ic
      ic=ic+1
      isvstr=ic
#endif
#ifdef SOLVE3D
# if defined ADJUST_STFLUX  || defined FORCING_SV     || \
     defined hessian_fsv    || defined so_semi        || \
     defined stochastic_opt
      DO i=1,mt
        ic=ic+1
        istsur(i)=ic
      END DO
# endif
#endif
#ifdef WEC
      ic=ic+1
      isu2sd=ic
      ic=ic+1
      isv2sd=ic
# if defined SOLVE3D
      ic=ic+1
      isu3sd=ic
      ic=ic+1
      isv3sd=ic
# endif
#endif
#ifdef SOLVE3D
# if defined GLS_MIXING || defined MY25_MIXING
      ic=ic+1
      ismtke=ic
# endif
#endif
      ic_brylast=ic
#ifdef SOLVE3D
      ic=ic+1
      iswvel=ic                               ! no LBC index
#endif
!
!  Set generic lateral boundary indices for LBC structure.  Use the same
!  values of the state variables at the same C-grid location.  Generic
!  indices are used for testing periodicity.  The PSI-variables and
!  W-variables are assigned the same value as the RHO-variables.
!
      isbp2d=isfsur                           ! 2D PSI-variables
      isbr2d=isfsur                           ! 2D RHO-variables
      isbu2d=isubar                           ! 2D U-variables
      isbv2d=isvbar                           ! 2D V-variables
#if defined SOLVE3D
      isbp3d=istvar(1)                        ! 3D PSI-variables
      isbr3d=istvar(1)                        ! 3D RHO-variables
      isbu3d=isuvel                           ! 3D U-variables
      isbv3d=isvvel                           ! 3D V-variables
      isbw3d=istvar(1)                        ! 3D W-variables
#endif
!
!  Initialize IO information variables.
!
      DO ng=1,ngrids
        DO i=1,nv
          linfo(1,i,ng)=.false.
          linfo(2,i,ng)=.false.
          linfo(3,i,ng)=.false.
          linfo(4,i,ng)=.false.
          linfo(5,i,ng)=.false.
          linfo(6,i,ng)=.false.
          aout(i,ng)=.false.
          dout(i,ng)=.false.
          hout(i,ng)=.false.
          qout(i,ng)=.false.
          sout(i,ng)=.false.
          iinfo(1,i,ng)=0
          iinfo(2,i,ng)=-1
          iinfo(3,i,ng)=-1
          iinfo(4,i,ng)=0
          iinfo(5,i,ng)=0
          iinfo(6,i,ng)=0
          iinfo(7,i,ng)=0
          iinfo(8,i,ng)=2
          iinfo(9,i,ng)=0
          iinfo(10,i,ng)=0
          iinfo(11,i,ng)=0
          finfo(1,i,ng)=0.0_r8
          finfo(2,i,ng)=0.0_r8
          finfo(3,i,ng)=0.0_r8
          finfo(5,i,ng)=0.0_r8
          finfo(6,i,ng)=0.0_r8
          finfo(7,i,ng)=0.0_r8
          finfo(10,i,ng)=1.0_r8
#if defined PIO_LIB && defined DISTRIBUTE
          dinfo(1,i,ng)%vd%varID=-1
          dinfo(1,i,ng)%dkind=-1
          dinfo(1,i,ng)%gtype=0
          dinfo(2,i,ng)%vd%varID=-1
          dinfo(2,i,ng)%dkind=-1
          dinfo(2,i,ng)%gtype=0
#endif
          fscale(i,ng)=1.0_r8
          fpoint(1,i,ng)=0.0_r8
          fpoint(2,i,ng)=0.0_r8
          tintrp(1,i,ng)=0.0_dp
          tintrp(2,i,ng)=0.0_dp
          vtime(1,i,ng)=0.0_dp
          vtime(2,i,ng)=0.0_dp
          bryncid(i,ng)=-1
          clmncid(i,ng)=-1
          frcncid(i,ng)=-1
#if defined PIO_LIB && defined DISTRIBUTE
          brypiofile(i,ng)%fh=-1
          clmpiofile(i,ng)%fh=-1
          frcpiofile(i,ng)%fh=-1
#endif
        END DO
      END DO
!
!  Set GIT and SVN Repository Root URL and revision.  Their values are
!  assigned in the 'makefile' to the CPPFLAGS macro.
!
#ifdef GIT_URL
      git_url=git_url
#else
      git_url='https://github.com/myroms/roms'
#endif
#ifdef GIT_REV
      git_rev=git_rev
#else
      git_rev=' '
#endif
!
#ifdef SVN_URL
      svn_url=svn_url
#else
      svn_url='https://myroms.org/svn/trunk'
#endif
#ifdef SVN_REV
      svn_rev=svn_rev
#else
      svn_rev=' '
#endif
!
!-----------------------------------------------------------------------
!  Process ROMS Input/Output metadata file and define variables
!  information arrays.
!-----------------------------------------------------------------------
!
      varid=0
      ldone=.false.
      firstpass=.true.                  ! initialize metadata processing
!
      metadata_loop : DO WHILE (.not.ldone)
!
!  Load I/O metadata information.
!
        ldone = io_metadata(firstpass, vinfo, scale, add_offset)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        IF (ldone) EXIT
!
!  Determine staggered C-grid variable.
!
        SELECT CASE (trim(adjustl(vinfo(7))))
          CASE ('p2dvar')
            gtype=p2dvar
          CASE ('r2dvar')
            gtype=r2dvar
          CASE ('u2dvar')
            gtype=u2dvar
          CASE ('v2dvar')
            gtype=v2dvar
          CASE ('p3dvar')
            gtype=p3dvar
          CASE ('r3dvar')
            gtype=r3dvar
          CASE ('u3dvar')
            gtype=u3dvar
          CASE ('v3dvar')
            gtype=v3dvar
          CASE ('w3dvar')
            gtype=w3dvar
          CASE ('b3dvar')
            gtype=b3dvar
#if defined ECOSIM && defined DIAGNOSTICS_BIO
          CASE ('l3dvar')
            gtype=l3dvar
          CASE ('l4dvar')
            gtype=l4dvar
#endif
#ifdef SPECTRAL_LIGHT
         CASE ('s3dvar')
           gtype=s3dvar
#endif
          CASE DEFAULT
            gtype=0
        END SELECT
!
!  Assign identification indices.
!
        load=.true.
        varid=varid+1
        SELECT CASE (trim(adjustl(vinfo(8))))
          CASE ('idangR')
            idangr=varid
          CASE ('idbath')
            idbath=varid
          CASE ('idfcor')
            idfcor=varid
          CASE ('idtopo')
            idtopo=varid
          CASE ('idpmdx')
            idpmdx=varid
          CASE ('idpndy')
            idpndy=varid
          CASE ('idLonP')
            idlonp=varid
          CASE ('idLatP')
            idlatp=varid
          CASE ('idLonR')
            idlonr=varid
          CASE ('idLatR')
            idlatr=varid
          CASE ('idLonU')
            idlonu=varid
          CASE ('idLatU')
            idlatu=varid
          CASE ('idLonV')
            idlonv=varid
          CASE ('idLatV')
            idlatv=varid
          CASE ('idmskP')
            idmskp=varid
          CASE ('idmskR')
            idmskr=varid
          CASE ('idmskU')
            idmsku=varid
          CASE ('idmskV')
            idmskv=varid
          CASE ('idscoR')
            idscor=varid
          CASE ('idscoU')
            idscou=varid
          CASE ('idscoV')
            idscov=varid
          CASE ('idXgrP')
            idxgrp=varid
          CASE ('idYgrP')
            idygrp=varid
          CASE ('idXgrR')
            idxgrr=varid
          CASE ('idYgrR')
            idygrr=varid
          CASE ('idXgrU')
            idxgru=varid
          CASE ('idYgrU')
            idygru=varid
          CASE ('idXgrV')
            idxgrv=varid
          CASE ('idYgrV')
            idygrv=varid
          CASE ('idpthR')
            idpthr=varid
          CASE ('idpthU')
            idpthu=varid
          CASE ('idpthV')
            idpthv=varid
          CASE ('idpthW')
            idpthw=varid
          CASE ('idtime')
            idtime=varid
          CASE ('idFsur')
            idfsur=varid
          CASE ('idRzet')
            idrzet=varid
          CASE ('idUbar')
            idubar=varid
          CASE ('idu2dE')
            idu2de=varid
          CASE ('idRu2d')
            idru2d=varid
          CASE ('idVbar')
            idvbar=varid
          CASE ('idv2dN')
            idv2dn=varid
          CASE ('idRv2d')
            idrv2d=varid
          CASE ('idUsur')
            idusur=varid
          CASE ('idUsuE')
            idusue=varid
          CASE ('idUvel')
            iduvel=varid
          CASE ('idu3dE')
            idu3de=varid
          CASE ('idRu3d')
            idru3d=varid
          CASE ('idVsur')
            idvsur=varid
          CASE ('idVsuN')
            idvsun=varid
          CASE ('idVvel')
            idvvel=varid
          CASE ('idv3dN')
            idv3dn=varid
          CASE ('idRv3d')
            idrv3d=varid
          CASE ('idWvel')
            idwvel=varid
          CASE ('idOvil')
            idovil=varid
          CASE ('idOvel')
            idovel=varid
          CASE ('idDano')
            iddano=varid
          CASE ('idsurT(itemp)')
            idsurt(itemp)=varid
#ifdef SALINITY
          CASE ('idsurT(isalt)')
            idsurt(isalt)=varid
#endif
          CASE ('idTvar(itemp)')
            idtvar(itemp)=varid
#ifdef SALINITY
          CASE ('idTvar(isalt)')
            idtvar(isalt)=varid
#endif
          CASE ('idUsms')
            idusms=varid
          CASE ('idVsms')
            idvsms=varid
          CASE ('idUbms')
            idubms=varid
          CASE ('idVbms')
            idvbms=varid
          CASE ('idUbws')
            idubws=varid
          CASE ('idUbcs')
            idubcs=varid
          CASE ('idVbws')
            idvbws=varid
          CASE ('idVbcs')
            idvbcs=varid
          CASE ('idUVwc')
            iduvwc=varid
          CASE ('idTsur(itemp)')
            idtsur(itemp)=varid
          CASE ('iddQdT')
            iddqdt=varid
          CASE ('idsfwf')
            idsfwf=varid
#ifdef SALINITY
          CASE ('idTsur(isalt)')
            idtsur(isalt)=varid
#endif
          CASE ('idTbot(itemp)')
            idtbot(itemp)=varid
#ifdef SALINITY
          CASE ('idTbot(isalt)')
            idtbot(isalt)=varid
#endif
          CASE ('idGhat(itemp)')
            idghat(itemp)=varid
#ifdef SALINITY
          CASE ('idGhat(isalt)')
            idghat(isalt)=varid
#endif
          CASE ('idMtke')
            idmtke=varid
          CASE ('idMtls')
            idmtls=varid
          CASE ('idVvis')
            idvvis=varid
          CASE ('idTdif')
            idtdif=varid
            iddiff(itemp)=idtdif
#ifdef SALINITY
          CASE ('idSdif')
            idsdif=varid
            iddiff(isalt)=idsdif
#endif
          CASE ('idVmLS')
            idvmls=varid
          CASE ('idVmKK')
            idvmkk=varid
          CASE ('idVmKP')
            idvmkp=varid
          CASE ('idZbry(iwest)')
            idzbry(iwest)=varid
          CASE ('idZbry(ieast)')
            idzbry(ieast)=varid
          CASE ('idZbry(isouth)')
            idzbry(isouth)=varid
          CASE ('idZbry(inorth)')
            idzbry(inorth)=varid
          CASE ('idU2bc(iwest)')
            idu2bc(iwest)=varid
          CASE ('idU2bc(ieast)')
            idu2bc(ieast)=varid
          CASE ('idU2bc(isouth)')
            idu2bc(isouth)=varid
          CASE ('idU2bc(inorth)')
            idu2bc(inorth)=varid
          CASE ('idV2bc(iwest)')
            idv2bc(iwest)=varid
          CASE ('idV2bc(ieast)')
            idv2bc(ieast)=varid
          CASE ('idV2bc(isouth)')
            idv2bc(isouth)=varid
          CASE ('idV2bc(inorth)')
            idv2bc(inorth)=varid
          CASE ('idU3bc(iwest)')
            idu3bc(iwest)=varid
          CASE ('idU3bc(ieast)')
            idu3bc(ieast)=varid
          CASE ('idU3bc(isouth)')
            idu3bc(isouth)=varid
          CASE ('idU3bc(inorth)')
            idu3bc(inorth)=varid
          CASE ('idV3bc(iwest)')
            idv3bc(iwest)=varid
          CASE ('idV3bc(ieast)')
            idv3bc(ieast)=varid
          CASE ('idV3bc(isouth)')
            idv3bc(isouth)=varid
          CASE ('idV3bc(inorth)')
            idv3bc(inorth)=varid
          CASE ('idTbry(iwest,itemp)')
            idtbry(iwest,itemp)=varid
          CASE ('idTbry(ieast,itemp)')
            idtbry(ieast,itemp)=varid
          CASE ('idTbry(isouth,itemp)')
            idtbry(isouth,itemp)=varid
          CASE ('idTbry(inorth,itemp)')
            idtbry(inorth,itemp)=varid
#ifdef SALINITY
          CASE ('idTbry(iwest,isalt)')
            idtbry(iwest,isalt)=varid
          CASE ('idTbry(ieast,isalt)')
            idtbry(ieast,isalt)=varid
          CASE ('idTbry(isouth,isalt)')
            idtbry(isouth,isalt)=varid
          CASE ('idTbry(inorth,isalt)')
            idtbry(inorth,isalt)=varid
#endif
          CASE ('idPwet')
            idpwet=varid
          CASE ('idRwet')
            idrwet=varid
          CASE ('idUwet')
            iduwet=varid
          CASE ('idVwet')
            idvwet=varid
          CASE ('idPair')
            idpair=varid
          CASE ('idTair')
            idtair=varid
          CASE ('idQair')
            idqair=varid
          CASE ('idCfra')
            idcfra=varid
          CASE ('idSrad')
            idsrad=varid
          CASE ('idLdwn')
            idldwn=varid
          CASE ('idLrad')
            idlrad=varid
          CASE ('idLhea')
            idlhea=varid
          CASE ('idShea')
            idshea=varid
          CASE ('idrain')
            idrain=varid
          CASE ('idEmPf')
            idempf=varid
          CASE ('idevap')
            idevap=varid
          CASE ('idUair')
            iduair=varid
          CASE ('idVair')
            idvair=varid
          CASE ('idUaiE')
            iduaie=varid
          CASE ('idVaiN')
            idvain=varid
          CASE ('idWvds')
            idwvds=varid
          CASE ('idWvqp')
            idwvqp=varid
          CASE ('idUwav')
            iduwav=varid
          CASE ('idVwav')
            idvwav=varid
          CASE ('idWamp')
            idwamp=varid
          CASE ('idWam2')
            idwam2=varid
          CASE ('idWbrk')
            idwbrk=varid
          CASE ('idWdib')
            idwdib=varid
          CASE ('idWdif')
            idwdif=varid
          CASE ('idWdis')
            idwdis=varid
          CASE ('idWdir')
            idwdir=varid
          CASE ('idWdip')
            idwdip=varid
          CASE ('idWdiw')
            idwdiw=varid
          CASE ('idWztw')
            idwztw=varid
          CASE ('idWqsp')
            idwqsp=varid
          CASE ('idWbeh')
            idwbeh=varid
          CASE ('idWlen')
            idwlen=varid
          CASE ('idWlep')
            idwlep=varid
          CASE ('idWptp')
            idwptp=varid
          CASE ('idWpbt')
            idwpbt=varid
          CASE ('idWorb')
            idworb=varid
          CASE ('idWrol')
            idwrol=varid
          CASE ('idW2xx')
            idw2xx=varid
          CASE ('idW2xy')
            idw2xy=varid
          CASE ('idW2yy')
            idw2yy=varid
          CASE ('idW3xx')
            idw3xx=varid
          CASE ('idW3xy')
            idw3xy=varid
          CASE ('idW3yy')
            idw3yy=varid
          CASE ('idW3zx')
            idw3zx=varid
          CASE ('idW3zy')
            idw3zy=varid
          CASE ('idU2rs')
            idu2rs=varid
          CASE ('idV2rs')
            idv2rs=varid
          CASE ('idU2Sd')
            idu2sd=varid
          CASE ('idV2Sd')
            idv2sd=varid
          CASE ('idU3rs')
            idu3rs=varid
          CASE ('idV3rs')
            idv3rs=varid
          CASE ('idU3Sd')
            idu3sd=varid
          CASE ('idV3Sd')
            idv3sd=varid
          CASE ('idW3Sd')
            idw3sd=varid
          CASE ('idW3St')
            idw3st=varid
          CASE ('idTref')
            idtref=varid
          CASE ('idTper')
            idtper=varid
          CASE ('idTzam')
            idtzam=varid
          CASE ('idTzph')
            idtzph=varid
          CASE ('idTvph')
            idtvph=varid
          CASE ('idTvan')
            idtvan=varid
          CASE ('idTvma')
            idtvma=varid
          CASE ('idTvmi')
            idtvmi=varid
          CASE ('idRxpo')
            idrxpo=varid
          CASE ('idRepo')
            idrepo=varid
          CASE ('idRdir')
            idrdir=varid
          CASE ('idRvsh')
            idrvsh=varid
          CASE ('idRtra')
            idrtra=varid
          CASE ('idRflg')
            idrflg=varid
          CASE ('idRtrc(itemp)')
            idrtrc(itemp)=varid
#ifdef SALINITY
          CASE ('idRtrc(isalt)')
            idrtrc(isalt)=varid
#endif
          CASE ('idHsbl')
            idhsbl=varid
          CASE ('idHbbl')
            idhbbl=varid
          CASE ('idHzdz')
            idhzdz=varid
#ifdef UV_DRAG_GRID
          CASE ('idragL')
            idragl=varid
          CASE ('idragQ')
            idragq=varid
          CASE ('idZoBL')
            idzobl=varid
#endif
          CASE ('idUbot')
            idubot=varid
          CASE ('idVbot')
            idvbot=varid
          CASE ('idUbur')
            idubur=varid
          CASE ('idVbvr')
            idvbvr=varid
          CASE ('idUbrs')
            idubrs=varid
          CASE ('idVbrs')
            idvbrs=varid
          CASE ('idSSHc')
            idsshc=varid
          CASE ('idUbcl')
            idubcl=varid
          CASE ('idVbcl')
            idvbcl=varid
          CASE ('idUclm')
            iduclm=varid
          CASE ('idVclm')
            idvclm=varid
          CASE ('idSSSc')
            idsssc=varid
          CASE ('idSSTc')
            idsstc=varid
#if defined AD_SENSITIVITY   || defined I4DVAR_ANA_SENSITIVITY || \
    defined opt_observations || defined sensitivity_4dvar      || \
    defined so_semi
          CASE ('idZads')
            idzads=varid
          CASE ('idUbas')
            idubas=varid
          CASE ('idVbas')
            idvbas=varid
          CASE ('idUads')
            iduads=varid
          CASE ('idVads')
            idvads=varid
          CASE ('idTads(itemp)')
            idtads(itemp)=varid
# ifdef T_PASSIVE
          CASE ('idTads(inert(i))')
            load=.true.
# endif
# ifdef SALINITY
          CASE ('idTads(isalt)')
            idtads(isalt)=varid
# endif
          CASE ('idWads')
            idwads=varid
#endif
#ifdef WEAK_CONSTRAINT
          CASE ('idZtlf')
            idztlf=varid
          CASE ('idUbtf')
            idubtf=varid
          CASE ('idVbtf')
            idvbtf=varid
          CASE ('idUtlf')
            idutlf=varid
          CASE ('idVtlf')
            idvtlf=varid
          CASE ('idTtlf(itemp)')
            idttlf(itemp)=varid
# ifdef SALINITY
          CASE ('idTtlf(isalt)')
            idttlf(isalt)=varid
# endif
#endif
          CASE ('idM2nc')
            idm2nc=varid
          CASE ('idM3nc')
            idm3nc=varid
          CASE ('idgTnc')
            idgtnc=varid
#ifdef AVERAGES_DETIDE
          CASE ('idCosW')
            idcosw=varid
          CASE ('idCos2')
            idcos2=varid
          CASE ('idSinW')
            idsinw=varid
          CASE ('idSin2')
            idsin2=varid
          CASE ('idSWCW')
            idswcw=varid
          CASE ('idFsuD')
            idfsud=varid
          CASE ('idFsuH')
            idfsuh=varid
          CASE ('idu2dD')
            idu2dd=varid
          CASE ('idu2dH')
            idu2dh=varid
          CASE ('idv2dD')
            idv2dd=varid
          CASE ('idv2dH')
              idv2dh=varid
# ifdef SOLVE3D
          CASE ('idu3dD')
            idu3dd=varid
          CASE ('idu3dH')
            idu3dh=varid
          CASE ('idv3dD')
            idv3dd=varid
          CASE ('idv3dH')
            idv3dh=varid
          CASE ('idTrcD(itemp)')
            idtrcd(itemp)=varid
          CASE ('idTrcH(itemp)')
            idtrch(itemp)=varid
#  ifdef SALINITY
          CASE ('idTrcD(isalt)')
            idtrcd(isalt)=varid
          CASE ('idTrcH(isalt)')
            idtrch(isalt)=varid
#  endif
# endif
#endif
          CASE ('idU2av')
            idu2av=varid
          CASE ('idV2av')
            idv2av=varid
          CASE ('idZZav')
            idzzav=varid
#ifdef SOLVE3D
          CASE ('idTTav(itrc)')
            load=.true.
          CASE ('iHUTav(itrc)')
            load=.true.
          CASE ('iHVTav(itrc)')
            load=.true.
          CASE ('idUTav(itrc)')
            load=.true.
          CASE ('idVTav(itrc)')
            load=.true.
          CASE ('idHUav')
            idhuav=varid
          CASE ('idHVav')
            idhvav=varid
          CASE ('idUUav')
            iduuav=varid
          CASE ('idUVav')
            iduvav=varid
          CASE ('idVVav')
            idvvav=varid
#endif
#ifdef T_PASSIVE
          CASE ('idTvar(inert(i))')
            load=.true.
          CASE ('idTbry(iwest,inert(i))')
            load=.true.
          CASE ('idTbry(ieast,inert(i))')
            load=.true.
          CASE ('idTbry(isouth,inert(i))')
            load=.true.
          CASE ('idTbry(inorth,inert(i))')
            load=.true.
          CASE ('idRtrc(inert(i))')
            load=.true.
#endif
          CASE ('id2dPV')
            id2dpv=varid
          CASE ('id2dRV')
            id2drv=varid
          CASE ('id3dPV')
            id3dpv=varid
          CASE ('id3dRV')
            id3drv=varid
#ifdef DIAGNOSTICS_UV
          CASE ('idDu2d(M2pgrd)')
            iddu2d(m2pgrd)=varid
          CASE ('idDv2d(M2pgrd)')
            iddv2d(m2pgrd)=varid
          CASE ('idDu2d(M2sstr)')
            iddu2d(m2sstr)=varid
          CASE ('idDu2d(M2bstr)')
            iddu2d(m2bstr)=varid
          CASE ('idDv2d(M2sstr)')
            iddv2d(m2sstr)=varid
          CASE ('idDv2d(M2bstr)')
            iddv2d(m2bstr)=varid
          CASE ('idDu2d(M2rate)')
            iddu2d(m2rate)=varid
          CASE ('idDv2d(M2rate)')
            iddv2d(m2rate)=varid
# ifdef UV_ADV
          CASE ('idDu2d(M2xadv)')
            iddu2d(m2xadv)=varid
          CASE ('idDu2d(M2yadv)')
            iddu2d(m2yadv)=varid
          CASE ('idDu2d(M2hadv)')
            iddu2d(m2hadv)=varid
          CASE ('idDv2d(M2xadv)')
            iddv2d(m2xadv)=varid
          CASE ('idDv2d(M2yadv)')
            iddv2d(m2yadv)=varid
          CASE ('idDv2d(M2hadv)')
            iddv2d(m2hadv)=varid
# endif
# ifdef WEC_VF
            CASE ('idDu2d(M2hjvf)')
              iddu2d(m2hjvf)=varid
            CASE ('idDv2d(M2hjvf)')
              iddv2d(m2hjvf)=varid
            CASE ('idDu2d(M2kvrf)')
              iddu2d(m2kvrf)=varid
            CASE ('idDv2d(M2kvrf)')
              iddv2d(m2kvrf)=varid
#  ifdef UV_COR
            CASE ('idDu2d(M2fsco)')
             iddu2d(m2fsco)=varid
            CASE ('idDv2d(M2fsco)')
              iddv2d(m2fsco)=varid
#  endif
#  ifdef BOTTOM_STREAMING
            CASE ('idDu2d(M2bstm)')
              iddu2d(m2bstm)=varid
            CASE ('idDv2d(M2bstm)')
              iddv2d(m2bstm)=varid
#  endif
#  ifdef SURFACE_STREAMING
            CASE ('idDu2d(M2sstm)')
              iddu2d(m2sstm)=varid
            CASE ('idDv2d(M2sstm)')
              iddv2d(m2sstm)=varid
#  endif
            CASE ('idDu2d(M2wrol)')
              iddu2d(m2wrol)=varid
            CASE ('idDv2d(M2wrol)')
              iddv2d(m2wrol)=varid
            CASE ('idDu2d(M2wbrk)')
              iddu2d(m2wbrk)=varid
            CASE ('idDv2d(M2wbrk)')
              iddv2d(m2wbrk)=varid
            CASE ('idDu2d(M2zeta)')
              iddu2d(m2zeta)=varid
            CASE ('idDv2d(M2zeta)')
              iddv2d(m2zeta)=varid
            CASE ('idDu2d(M2zetw)')
              iddu2d(m2zetw)=varid
            CASE ('idDv2d(M2zetw)')
              iddv2d(m2zetw)=varid
            CASE ('idDu2d(M2zqsp)')
              iddu2d(m2zqsp)=varid
            CASE ('idDv2d(M2zqsp)')
              iddv2d(m2zqsp)=varid
            CASE ('idDu2d(M2zbeh)')
              iddu2d(m2zbeh)=varid
            CASE ('idDv2d(M2zbeh)')
              iddv2d(m2zbeh)=varid
# endif
# ifdef UV_COR
          CASE ('idDu2d(M2fcor)')
            iddu2d(m2fcor)=varid
          CASE ('idDv2d(M2fcor)')
            iddv2d(m2fcor)=varid
# endif
# if defined UV_VIS2 || defined UV_VIS4
          CASE ('idDu2d(M2hvis)')
            iddu2d(m2hvis)=varid
          CASE ('idDu2d(M2xvis)')
            iddu2d(m2xvis)=varid
          CASE ('idDu2d(M2yvis)')
            iddu2d(m2yvis)=varid
          CASE ('idDv2d(M2hvis)')
            iddv2d(m2hvis)=varid
          CASE ('idDv2d(M2xvis)')
            iddv2d(m2xvis)=varid
          CASE ('idDv2d(M2yvis)')
            iddv2d(m2yvis)=varid
# endif
# ifdef SOLVE3D
          CASE ('idDu3d(M3pgrd)')
            iddu3d(m3pgrd)=varid
          CASE ('idDv3d(M3pgrd)')
            iddv3d(m3pgrd)=varid
          CASE ('idDu3d(M3vvis)')
            iddu3d(m3vvis)=varid
          CASE ('idDv3d(M3vvis)')
            iddv3d(m3vvis)=varid
          CASE ('idDu3d(M3rate)')
            iddu3d(m3rate)=varid
          CASE ('idDv3d(M3rate)')
            iddv3d(m3rate)=varid
#  ifdef UV_ADV
          CASE ('idDu3d(M3xadv)')
            iddu3d(m3xadv)=varid
          CASE ('idDu3d(M3yadv)')
            iddu3d(m3yadv)=varid
          CASE ('idDu3d(M3hadv)')
            iddu3d(m3hadv)=varid
          CASE ('idDv3d(M3xadv)')
            iddv3d(m3xadv)=varid
          CASE ('idDv3d(M3yadv)')
            iddv3d(m3yadv)=varid
          CASE ('idDv3d(M3hadv)')
            iddv3d(m3hadv)=varid
          CASE ('idDu3d(M3vadv)')
            iddu3d(m3vadv)=varid
          CASE ('idDv3d(M3vadv)')
            iddv3d(m3vadv)=varid
#  endif
#  ifdef WEC_VF
            CASE ('idDu3d(M3vjvf)')
              iddu3d(m3vjvf)=varid
            CASE ('idDv3d(M3vjvf)')
              iddv3d(m3vjvf)=varid
            CASE ('idDu3d(M3hjvf)')
              iddu3d(m3hjvf)=varid
            CASE ('idDv3d(M3hjvf)')
              iddv3d(m3hjvf)=varid
            CASE ('idDu3d(M3kvrf)')
              iddu3d(m3kvrf)=varid
            CASE ('idDv3d(M3kvrf)')
              iddv3d(m3kvrf)=varid
#   ifdef UV_COR
            CASE ('idDu3d(M3fsco)')
              iddu3d(m3fsco)=varid
            CASE ('idDv3d(M3fsco)')
              iddv3d(m3fsco)=varid
#   endif
#   ifdef BOTTOM_STREAMING
            CASE ('idDu3d(M3bstm)')
              iddu3d(m3bstm)=varid
            CASE ('idDv3d(M3bstm)')
              iddv3d(m3bstm)=varid
#   endif
#   ifdef SURFACE_STREAMING
            CASE ('idDu3d(M3sstm)')
              iddu3d(m3sstm)=varid
            CASE ('idDv3d(M3sstm)')
              iddv3d(m3sstm)=varid
#  endif
            CASE ('idDu3d(M3wrol)')
              iddu3d(m3wrol)=varid
            CASE ('idDv3d(M3wrol)')
              iddv3d(m3wrol)=varid
            CASE ('idDu3d(M3wbrk)')
              iddu3d(m3wbrk)=varid
            CASE ('idDv3d(M3wbrk)')
              iddv3d(m3wbrk)=varid
#  endif
#  ifdef UV_COR
          CASE ('idDu3d(M3fcor)')
            iddu3d(m3fcor)=varid
          CASE ('idDv3d(M3fcor)')
            iddv3d(m3fcor)=varid
#  endif
#  if defined UV_VIS2 || defined UV_VIS4
          CASE ('idDu3d(M3hvis)')
            iddu3d(m3hvis)=varid
          CASE ('idDu3d(M3xvis)')
            iddu3d(m3xvis)=varid
          CASE ('idDu3d(M3yvis)')
            iddu3d(m3yvis)=varid
          CASE ('idDv3d(M3hvis)')
            iddv3d(m3hvis)=varid
          CASE ('idDv3d(M3xvis)')
            iddv3d(m3xvis)=varid
          CASE ('idDv3d(M3yvis)')
            iddv3d(m3yvis)=varid
#  endif
# endif
#endif
#ifdef DIAGNOSTICS_TS
          CASE ('idDtrc(iTrate)')
            load=.true.
          CASE ('idDtrc(iThadv)')
            load=.true.
          CASE ('idDtrc(iTxadv)')
            load=.true.
          CASE ('idDtrc(iTyadv)')
            load=.true.
          CASE ('idDtrc(iTvadv)')
            load=.true.
# if defined TS_DIF2 || defined TS_DIF4
          CASE ('idDtrc(iThdif)')
            load=.true.
          CASE ('idDtrc(iTxdif)')
            load=.true.
          CASE ('idDtrc(iTydif)')
            load=.true.
#  if defined MIX_GEO_TS || defined MIX_ISO_TS
          CASE ('idDtrc(iTsdif)')
            load=.true.
#  endif
# endif
          CASE ('idDtrc(iTvdif)')
            load=.true.
#endif
#if defined FORWARD_READ || defined FORWARD_WRITE
          CASE ('idRuct')
            idruct=varid
          CASE ('idRvct')
            idrvct=varid
          CASE ('idUfx1')
            idufx1=varid
          CASE ('idUfx2')
            idufx2=varid
          CASE ('idVfx1')
            idvfx1=varid
          CASE ('idVfx2')
            idvfx2=varid
#endif
#if defined FOUR_DVAR || defined VERIFICATION
          CASE ('idBgEr')
            idbger=varid
          CASE ('idBgTh')
            idbgth=varid
          CASE ('idIncr')
            idincr=varid
          CASE ('idInno')
            idinno=varid
          CASE ('idNLmf')
            idnlmf=varid
          CASE ('idNLmi')
            idnlmi=varid
          CASE ('idNLmo')
            idnlmo=varid
          CASE ('idNLmp')
            idnlmp=varid
          CASE ('idNLmu')
            idnlmu=varid
          CASE ('idNobs')
            idnobs=varid
          CASE ('idObsD')
            idobsd=varid
          CASE ('idObsS')
            idobss=varid
          CASE ('idObsT')
            idobst=varid
          CASE ('idObsX')
            idobsx=varid
          CASE ('idObsY')
            idobsy=varid
          CASE ('idObsZ')
            idobsz=varid
          CASE ('idOday')
            idoday=varid
          CASE ('idOerr')
            idoerr=varid
          CASE ('idOlat')
            idolat=varid
          CASE ('idOlon')
            idolon=varid
          CASE ('idOmet')
            idomet=varid
          CASE ('idOpro')
            idopro=varid
          CASE ('idOtyp')
            idotyp=varid
          CASE ('idOval')
            idoval=varid
          CASE ('idResi')
            idresi=varid
          CASE ('idKhor')
            idkhor=varid
          CASE ('idKver')
            idkver=varid
          CASE ('idTLmo')
            idtlmo=varid
          CASE ('idMOMi')
            idmomi=varid
          CASE ('idMOMf')
            idmomf=varid
#endif
 
#ifdef SEAICE
# include <ice_var.h>
#endif
 
#ifdef BIOLOGY
# if defined BIO_FENNEL
#  include <fennel_var.h>
# elif defined ECOSIM
#  include <ecosim_var.h>
# elif defined HYPOXIA_SRM
#  include <hypoxia_srm_var.h>
# elif defined NEMURO
#  include <nemuro_var.h>
# elif defined NPZD_FRANKS
#  include <npzd_Franks_var.h>
# elif defined NPZD_POWELL
#  include <npzd_Powell_var.h>
# elif defined NPZD_IRON
#  include <npzd_iron_var.h>
# elif defined RED_TIDE
#  include <red_tide_var.h>
# endif
#endif
 
#if defined SEDIMENT || defined BBL_MODEL
#  include <sediment_var.h>
#endif
 
          CASE DEFAULT
            load=.false.
        END SELECT
!
!  Load variable data into information arrays.
!
        IF (load) THEN
          load=.false.
          IF (varid.gt.mv) THEN
            WRITE (stdout,10) mv, varid
            stop
          END IF
          DO i=1,6
            vname(i,varid)=trim(adjustl(vinfo(i)))
          END DO
          DO ng=1,ngrids
            iinfo(1,varid,ng)=gtype
            fscale(varid,ng)=scale
          END DO
 
#ifdef T_PASSIVE
!
!  Adjust information for all inert passive tracers.
!
          SELECT CASE (trim(adjustl(vinfo(8))))
            CASE ('idTvar(inert(i))')
              IF (npt.gt.0) THEN
                varid=varid-1
# ifdef AGE_MEAN
                ic=0
                DO i=1,npt,2
                  varid=varid+1
                  ic=ic+1
                  idtvar(inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), ic
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', ic
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(4))), ic
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), ic
                END DO
!
                ic=0
                DO i=2,npt,2
                  varid=varid+1
                  ic=ic+1
                  idtvar(inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2,a)')                   &
     &                  trim(adjustl(vinfo(1))), ic, '_age'
                  WRITE (vname(2,varid),'(a,i2.2)')                     &
     &                  'age concentration, type ', ic
                  WRITE (vname(3,varid),'(a)')                          &
     &                  'second kilogram meter-3'
                  WRITE (vname(4,varid),'(a,i2.2,a)')                   &
     &                  trim(adjustl(vinfo(4))), ic, '_age'
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2,a)')                   &
     &                  trim(adjustl(vinfo(6))), ic, '_age'
                END DO
# else
                DO i=1,npt
                  varid=varid+1
                  idtvar(inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), i
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', i
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(4))), i
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), i
                END DO
# endif
              END IF
 
# if defined AD_SENSITIVITY   || defined I4DVAR_ANA_SENSITIVITY || \
     defined opt_observations || defined sensitivity_4dvar      || \
     defined so_semi
            CASE ('idTads(inert(i))')
              IF (npt.gt.0) THEN
                varid=varid-1
                DO i=1,npt
                  varid=varid+1
                  idtads(inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), i
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', i
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(4))), i
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), i
                END DO
              END IF
# endif
            CASE ('idTbry(iwest,inert(i))')
              IF (npt.gt.0) THEN
                varid=varid-1
                DO i=1,npt
                  varid=varid+1
                  idtbry(iwest,inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), i
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', i
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2,a)')                   &
     &                  trim(adjustl(vinfo(1))), i, ' western_boundary'
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), i
                END DO
              END IF
            CASE ('idTbry(ieast,inert(i))')
              IF (npt.gt.0) THEN
                varid=varid-1
                DO i=1,npt
                  varid=varid+1
                  idtbry(ieast,inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), i
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', i
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2,a)')                   &
     &                  trim(adjustl(vinfo(1))), i, ' eastern_boundary'
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), i
                END DO
              END IF
            CASE ('idTbry(isouth,inert(i))')
              IF (npt.gt.0) THEN
                varid=varid-1
                DO i=1,npt
                  varid=varid+1
                  idtbry(isouth,inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), i
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', i
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2,a)')                   &
     &                  trim(adjustl(vinfo(1))), i, ' southern_boundary'
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), i
               END DO
              END IF
            CASE ('idTbry(inorth,inert(i))')
              IF (npt.gt.0) THEN
                varid=varid-1
                DO i=1,npt
                  varid=varid+1
                  idtbry(inorth,inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), i
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', i
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2,a)')                   &
     &                  trim(adjustl(vinfo(1))), i, ' northern_boundary'
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), i
                END DO
              END IF
            CASE ('idRtrc(inert(i))')
              IF (npt.gt.0) THEN
                varid=varid-1
                DO i=1,npt
                  varid=varid+1
                  idrtrc(inert(i))=varid
                  DO ng=1,ngrids
                    fscale(varid,ng)=scale
                    iinfo(1,varid,ng)=gtype
                  END DO
                  WRITE (vname(1,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(1))), i
                  WRITE (vname(2,varid),'(a,a,i2.2)')                   &
     &                  trim(adjustl(vinfo(2))), ', type ', i
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(3)))
                  WRITE (vname(4,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(4))), i
                  WRITE (vname(5,varid),'(a)')                          &
     &                  trim(adjustl(vinfo(5)))
                  WRITE (vname(6,varid),'(a,i2.2)')                     &
     &                  trim(adjustl(vinfo(6))), i
                END DO
              END IF
          END SELECT
#endif
#ifdef DIAGNOSTICS_TS
!
!  Adjust information for tracer diagnostic variables.  This needs to be
!  done last because it needs all the tracers variable names.
!
          SELECT CASE (vinfo(1))
            CASE ('_rate')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,itrate)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
            CASE ('_hadv')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,ithadv)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
             END DO
            CASE ('_xadv')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,itxadv)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
            CASE ('_yadv')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,ityadv)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
            CASE ('_vadv')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,itvadv)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
# if defined TS_DIF2 || defined TS_DIF4
            CASE ('_hdiff')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,ithdif)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
            CASE ('_xdiff')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,itxdif)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
            CASE ('_ydiff')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,itydif)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
             END DO
#  if defined MIX_GEO_TS || defined MIX_ISO_TS
            CASE ('_sdiff')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,itsdif)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
#  endif
# endif
            CASE ('_vdiff')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                iddtrc(i,itvdif)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(1)))
                WRITE (vname(2,varid),'(a,", ",a)')                     &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(2)))
                WRITE (vname(3,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(3,idtvar(i)))),                &
     &                trim(adjustl(vinfo(3)))
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(1,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix='sea_water_',                 &
     &                             suffix=vinfo(6))
              END DO
          END SELECT
#endif
#if defined SOLVE3D && (defined AVERAGES || defined AD_AVERAGES)
!
!  Determine metadata for quadratic tracer averages.
!
          SELECT CASE (vinfo(1))
            CASE ('tracer2')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                idttav(i)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                trim(adjustl(vname(1,idtvar(i)))), '_2'
                WRITE (vname(2,varid),'(a,1x,a)')                       &
     &                'squared',                                        &
     &                trim(adjustl(vname(2,idtvar(i))))
                IF (trim(adjustl(vname(3,idtvar(i)))).eq.               &
     &              'nondimensional') THEN
                  WRITE (vname(3,varid),'(a)')                          &
     &                  trim(adjustl(vname(3,idtvar(i))))
                ELSE
                  WRITE (vname(3,varid),'(a,a)')                        &
     &                  trim(adjustl(vname(3,idtvar(i)))), '2'
                END IF
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix=vinfo(6),                     &
     &                             suffix='_in_sea_water')
              END DO
            CASE ('Huontracer')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                ihutav(i)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                'Huon_', trim(adjustl(vname(1,idtvar(i))))
                WRITE (vname(2,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                'u-volume flux'
                IF (trim(adjustl(vname(3,idtvar(i)))).eq.               &
     &              'nondimensional') THEN
                  WRITE (vname(3,varid),'(a)')                          &
     &                  'meter3 second-1'
                ELSE
                  WRITE (vname(3,varid),'(a,1x,a)')                     &
     &                  'meter3 second-1',                              &
     &                  trim(adjustl(vname(3,idtvar(i))))
                END IF
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix=vinfo(6))
              END DO
            CASE ('utracer')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                idutav(i)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                'u_', trim(adjustl(vname(1,idtvar(i))))
                WRITE (vname(2,varid),'(a,1x,a)')                       &
     &                'u-momentum times',                               &
     &                trim(adjustl(vname(2,idtvar(i))))
                IF (trim(adjustl(vname(3,idtvar(i)))).eq.               &
     &              'nondimensional') THEN
                  WRITE (vname(3,varid),'(a)')                          &
     &                  'meter second-1'
                ELSE
                  WRITE (vname(3,varid),'(a,1x,a)')                     &
     &                  'meter second-1',                               &
     &                  trim(adjustl(vname(3,idtvar(i))))
                END IF
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                 trim(adjustl(vinfo(4))),                         &
     &                 trim(adjustl(vname(2,idtvar(i))))
                vname(5,varid)='ocean_time'
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix=vinfo(6),                     &
     &                             suffix='_in_sea_water')
              END DO
            CASE ('Hvomtracer')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                ihvtav(i)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                'Hvom_', trim(adjustl(vname(1,idtvar(i))))
                WRITE (vname(2,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                'v-volume flux'
                IF (trim(adjustl(vname(3,idtvar(i)))).eq.               &
     &              'nondimensional') THEN
                  WRITE (vname(3,varid),'(a)')                          &
     &                  'meter3 second-1'
                ELSE
                  WRITE (vname(3,varid),'(a,1x,a)')                     &
     &                  'meter3 second-1',                              &
     &                  trim(adjustl(vname(3,idtvar(i))))
                END IF
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                trim(adjustl(vname(2,idtvar(i)))),                &
     &                trim(adjustl(vinfo(4)))
                WRITE (vname(5,varid),'(a)')                            &
     &                trim(adjustl(vinfo(5)))
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix=vinfo(6))
              END DO
            CASE ('vtracer')
              varid=varid-1
              DO i=1,mt
                varid=varid+1
                idvtav(i)=varid
                DO ng=1,ngrids
                  fscale(varid,ng)=scale
                  iinfo(1,varid,ng)=gtype
                END DO
                WRITE (vname(1,varid),'(a,a)')                          &
     &                'v_', trim(adjustl(vname(1,idtvar(i))))
                WRITE (vname(2,varid),'(a,1x,a)')                       &
     &                'v-momentum times',                               &
     &                trim(adjustl(vname(2,idtvar(i))))
                IF (trim(adjustl(vname(3,idtvar(i)))).eq.               &
     &              'nondimensional') THEN
                  WRITE (vname(3,varid),'(a)')                          &
     &                  'meter second-1'
                ELSE
                  WRITE (vname(3,varid),'(a,1x,a)')                     &
     &                  'meter second-1',                               &
     &                  trim(adjustl(vname(3,idtvar(i))))
                END IF
                WRITE (vname(4,varid),'(a,1x,a)')                       &
     &                 trim(adjustl(vinfo(4))),                         &
     &                 trim(adjustl(vname(2,idtvar(i))))
                vname(5,varid)='ocean_time'
                CALL standardname (vname(6,varid), vname(2,idtvar(i)),  &
     &                             prefix=vinfo(6),                     &
     &                             suffix='_in_sea_water')
              END DO
          END SELECT
#endif
        ELSE
          varid=varid-1
        END IF
      END DO metadata_loop
 
#ifdef SOLVE3D
!
!-----------------------------------------------------------------------
!  Set passive tracers surface flux metadata. The variable name is the
!  same as the basic tracer but with the _sflux suffix.
!-----------------------------------------------------------------------
!
      DO i=nat+1,mt
        varid=varid+1
        IF (varid.gt.mv) THEN
          WRITE (stdout,10) mv, varid
          stop
        END IF
        idtsur(i)=varid
        DO ng=1,ngrids
          fscale(varid,ng)=1.0_r8
          iinfo(1,varid,ng)=r2dvar
        END DO
        WRITE (vname(1,varid),'(a,a)')                                  &
     &        trim(adjustl(vname(1,idtvar(i)))), '_sflux'
        WRITE (vname(2,varid),'(a,a)')                                  &
     &        trim(adjustl(vname(2,idtvar(i)))), ', surface flux'
        WRITE (vname(3,varid),'(a,1x,a)')                               &
     &        trim(adjustl(vname(3,idtvar(i)))), 'meter second-1'
        WRITE (vname(4,varid),'(3a)') 'surface ',                       &
     &        trim(adjustl(vname(2,idtvar(i)))), ' flux'
        WRITE (vname(5,varid),'(a)')                                    &
     &        trim(adjustl(vname(1,idtvar(i))))
        CALL standardname (vname(6,varid), vname(2,idtvar(i)),          &
     &                     prefix='sea_surface_',                       &
     &                     suffix='_flux')
      END DO
!
!-----------------------------------------------------------------------
!  Set passive model surface tracers metadata. The variable name is the
!  same as the basic tracer but with the _sur suffix.
!-----------------------------------------------------------------------
!
      DO i=nat+1,mt
        varid=varid+1
        IF (varid.gt.mv) THEN
          WRITE (stdout,10) mv, varid
          stop
        END IF
        idsurt(i)=varid
        DO ng=1,ngrids
          fscale(varid,ng)=1.0_r8
          iinfo(1,varid,ng)=r2dvar
        END DO
        WRITE (vname(1,varid),'(a,a)')                                  &
     &        trim(adjustl(vname(1,idtvar(i)))), '_sur'
        WRITE (vname(2,varid),'(2a)') 'surface ',                       &
     &        trim(adjustl(vname(2,idtvar(i))))
        WRITE (vname(3,varid),'(a)')                                    &
     &        trim(adjustl(vname(3,idtvar(i))))
        WRITE (vname(4,varid),'(a)')                                    &
     &        trim(vname(2,varid))
        WRITE (vname(5,varid),'(a)')                                    &
     &        trim(adjustl(vname(5,idtvar(i))))
        CALL standardname (vname(6,varid), vname(2,idtvar(i)),          &
     &                     prefix='sea_surface_')
      END DO
#endif
#ifdef WEAK_CONSTRAINT
!
!-----------------------------------------------------------------------
!  Set passive tracers impulse forcing. The metadata values are the
!  same as the basic tracer but with different indices sinc they are
!  used at the same time. This allows flexibility in the time
!  interpolation.
!-----------------------------------------------------------------------
!
      DO i=nat+1,mt
        varid=varid+1
        IF (varid.gt.mv) THEN
          WRITE (stdout,10) mv, varid
          stop
        END IF
        idttlf(i)=varid
        DO ng=1,ngrids
          fscale(varid,ng)=1.0_r8
          iinfo(1,varid,ng)=r3dvar
        END DO
        WRITE (vname(1,varid),'(a)')                                    &
     &        trim(adjustl(vname(1,idtvar(i))))
        WRITE (vname(2,varid),'(a,a)')                                  &
     &        trim(adjustl(vname(2,idtvar(i)))), ' impulse forcing'
        WRITE (vname(3,varid),'(a)')                                    &
     &        trim(adjustl(vname(3,idtvar(i))))
        WRITE (vname(4,varid),'(a,a)')                                  &
     &        trim(adjustl(vname(2,idtvar(i)))), ' impulse'
        WRITE (vname(5,varid),'(a)')                                    &
     &          trim(adjustl(vname(5,idtvar(i))))
        CALL standardname (vname(6,varid), vname(2,idtvar(i)),          &
     &                     prefix='sea_water_',                         &
     &                     suffix='_impulse')
      END DO
#endif
!
!-----------------------------------------------------------------------
!  Set model state variables metadata indices.
!-----------------------------------------------------------------------
!
      idsvar(isfsur)=idfsur
      idsvar(isubar)=idubar
      idsvar(isvbar)=idvbar
#ifdef SOLVE3D
      idsvar(isuvel)=iduvel
      idsvar(isvvel)=idvvel
      DO i=1,mt
        idsvar(istvar(i))=idtvar(i)
      END DO
#endif
#if defined ADJUST_WSTRESS || defined FORCING_SV     || \
    defined hessian_fsv    || defined so_semi        || \
    defined stochastic_opt
      idsvar(isustr)=idusms
      idsvar(isvstr)=idvsms
#endif
#ifdef SOLVE3D
# if defined ADJUST_STFLUX  || defined FORCING_SV     || \
     defined hessian_fsv    || defined so_semi        || \
     defined stochastic_opt
      DO i=1,mt
        idsvar(istsur(i))=idtsur(i)
      END DO
# endif
#endif
#ifdef WEC
      idsvar(isu2sd)=idu2sd
      idsvar(isv2sd)=idv2sd
# if defined SOLVE3D
      idsvar(isu3sd)=idu3sd
      idsvar(isv3sd)=idv3sd
# endif
#endif
#ifdef SOLVE3D
# if defined GLS_MIXING || defined MY25_MIXING
      idsvar(ismtke)=idmtke
# endif
      idsvar(iswvel)=idwvel
#endif
!
!-----------------------------------------------------------------------
!  Set model lateral boundary variables index.
!-----------------------------------------------------------------------
!
      idbvar(isfsur)=idfsur
      idbvar(isubar)=idubar
      idbvar(isvbar)=idvbar
#ifdef SOLVE3D
      idbvar(isuvel)=iduvel
      idbvar(isvvel)=idvvel
      DO i=1,mt
        idbvar(istvar(i))=idtvar(i)
      END DO
# if defined GLS_MIXING || defined MY25_MIXING
      idbvar(ismtke)=idmtke
# endif
#endif
#ifdef WEC
      idbvar(isu2sd)=idu2sd
      idbvar(isv2sd)=idv2sd
# if defined SOLVE3D
      idbvar(isu3sd)=idu3sd
      idbvar(isv3sd)=idv3sd
# endif
#endif
#ifdef ICE_MODEL
!
!  Set ice model state boundary indices.  Currently, the last ice model
!  LBC state variable is isVice=11.
!
      DO i=1,nices
        ibice(i)=i
      END DO
      ic=ic_brylast
      DO i=1,isvice
        ic=ic+1
        idbvar(ic)=isice(i)
      END DO
#endif
#ifdef ADJUST_BOUNDARY
!
!-----------------------------------------------------------------------
!  If adjusting open boundaries, set metadata variables.  The variable
!  name is the same as the state variable but with the _obc suffix.
!-----------------------------------------------------------------------
!
      DO i=1,nlbcvar
        IF (idbvar(i).gt.0 ) THEN
          varid=varid+1
          IF (varid.gt.mv) THEN
            WRITE (stdout,10) mv, varid
            stop
          END IF
          idsbry(i)=varid
          DO ng=1,ngrids
            fscale(varid,ng)=1.0_r8
            iinfo(1,varid,ng)=0
          END DO
          WRITE (vname(1,varid),'(a,a)')                                &
     &          trim(adjustl(vname(1,idsvar(i)))), '_obc'
          WRITE (vname(2,varid),'(a,a)')                                &
     &          trim(adjustl(vname(2,idsvar(i)))), ', open boundaries'
          WRITE (vname(3,varid),'(a)')                                  &
     &          trim(adjustl(vname(3,idsvar(i))))
          WRITE (vname(4,varid),'(a,a)')                                &
     &          trim(vname(1,varid)), ', scalar, series'
          WRITE (vname(5,varid),'(a)')                                  &
     &          trim(adjustl(vname(5,idsvar(i))))
        END IF
      END DO
#endif
!
!  Save last variable ID counter used.
!
      last_varid=varid
      dmem(1)=dmem(1)+real(varid,r8)
!
  10  FORMAT (/,' MOD_NCPARAM - too small dimension ',                  &
     &        'parameter, MV = ',2i5,/,15x,                             &
     &        'change file  mod_ncparam.F  and recompile.')
!
      RETURN
      END SUBROUTINE initialize_ncparam
!
      END MODULE mod_ncparam