def_tides.F

Go to the documentation of this file.

#include "cppdefs.h"
      MODULE def_tides_mod
#if defined AVERAGES  && defined AVERAGES_DETIDE && \
   (defined ssh_tides || defined uv_tides)
!
!git $Id$
!================================================== Hernan G. Arango ===
!  Copyright (c) 2002-2025 The ROMS Group                              !
!    Licensed under a MIT/X style license                              !
!    See License_ROMS.md                                               !
!=======================================================================
!                                                                      !
!  This routine creates creates least-squares harmomics variables      !
!  for detiding file using either the standard NetCDF library or the   !
!  Parallel-IO (PIO) library.                                          !
!                                                                      !
!=======================================================================
!
      USE mod_param
      USE mod_parallel
      USE mod_iounits
      USE mod_ncparam
      USE mod_scalars
      USE mod_stepping
      USE mod_tides
!
      USE def_dim_mod,  ONLY : def_dim
      USE def_info_mod, ONLY : def_info
      USE def_var_mod,  ONLY : def_var
      USE strings_mod,  ONLY : founderror
      USE wrt_info_mod, ONLY : wrt_info
!
      implicit none
!
      PUBLIC  :: def_tides
      PRIVATE :: def_tides_nf90
# if defined PIO_LIB && defined DISTRIBUTE
      PRIVATE :: def_tides_pio
# endif
!
      CONTAINS
!
!***********************************************************************
      SUBROUTINE def_tides (ng, ldef)
!***********************************************************************
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng
!
      logical, intent(in) :: ldef
!
!  Local variable declarations.
!
      character (len=*), parameter :: myfile =                          &
     &  __FILE__
!
!-----------------------------------------------------------------------
!  Create a new history file according to IO type.
!-----------------------------------------------------------------------
!
      SELECT CASE (har(ng)%IOtype)
        CASE (io_nf90)
          CALL def_tides_nf90 (ng, ldef)
 
# if defined PIO_LIB && defined DISTRIBUTE
        CASE (io_pio)
          CALL def_tides_pio (ng, ldef)
# endif
        CASE DEFAULT
          IF (master) WRITE (stdout,10) har(ng)%IOtype
          exit_flag=3
      END SELECT
      IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
  10  FORMAT (' DEF_TIDES - Illegal output file type, io_type = ',i0,   &
     &        /,13x,'Check KeyWord ''OUT_LIB'' in ''roms.in''.')
!
      RETURN
      END SUBROUTINE def_tides
!
!**********************************************************************
      SUBROUTINE def_tides_nf90 (ng, ldef)
!**********************************************************************
!
      USE mod_netcdf
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng
!
      logical, intent(in) :: ldef
!
!  Local variable declarations.
!
      logical :: got_var(nv)
 
      logical :: ldefine = .false.
!
      integer, parameter :: natt = 25
 
      integer :: i, itrc, j, nvd3, nvd4
      integer :: status, varid
 
      integer :: dimids(ndimid)
      integer :: tharm(2), t2dgrd(3), u2dgrd(3), v2dgrd(3)
# ifdef SOLVE3D
      integer :: t3dgrd(4), u3dgrd(4), v3dgrd(4)
# endif
!
      real(r8) :: aval(6)
!
      character (len=256)    :: ncname
      character (len=MaxLen) :: vinfo(natt)
 
      character (len=*), parameter :: myfile =                          &
     &  __FILE__//", def_tides_nf90"
!
      sourcefile=myfile
!
!-----------------------------------------------------------------------
!  Set and report file name.
!-----------------------------------------------------------------------
!
      IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ncname=har(ng)%name
!
      IF (master) THEN
        IF (ldef) THEN
          WRITE (stdout,10) ng, trim(ncname)
        ELSE
          WRITE (stdout,20) ng, trim(ncname)
        END IF
      END IF
!
!=======================================================================
!  Create a new least-squares detide harmonics file.
!=======================================================================
!
      define : IF (ldef) THEN
        CALL netcdf_create (ng, inlm, trim(ncname), har(ng)%ncid)
        IF (founderror(exit_flag, noerror, __line__, myfile)) THEN
          IF (master) WRITE (stdout,30) trim(ncname)
          RETURN
        END IF
!
!-----------------------------------------------------------------------
!  Define file dimensions.
!-----------------------------------------------------------------------
!
        dimids=0
!
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'xi_rho',        &
     &                 iobounds(ng)%xi_rho, dimids( 1))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'xi_u',          &
     &                 iobounds(ng)%xi_u, dimids( 2))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'xi_v',          &
     &                 iobounds(ng)%xi_v, dimids( 3))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'xi_psi',        &
     &                 iobounds(ng)%xi_psi, dimids( 4))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'eta_rho',       &
     &                 iobounds(ng)%eta_rho, dimids( 5))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'eta_u',         &
     &                 iobounds(ng)%eta_u, dimids( 6))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'eta_v',         &
     &                 iobounds(ng)%eta_v, dimids( 7))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'eta_psi',       &
     &                 iobounds(ng)%eta_psi, dimids( 8))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
# ifdef SOLVE3D
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 's_rho',         &
     &                 n(ng), dimids( 9))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 's_w',           &
     &                 n(ng)+1, dimids(10))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'tracer',        &
     &                 nt(ng), dimids(11))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
#  ifdef SEDIMENT
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'NST',           &
     &                 nst, dimids(32))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'Nbed',          &
     &                 nbed, dimids(16))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
#  endif
 
#  ifdef ECOSIM
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'Nbands',        &
     &                 nbands, dimids(33))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'Nphy',          &
     &                 nphy, dimids(25))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'Nbac',          &
     &                 nbac, dimids(26))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'Ndom',          &
     &                 ndom, dimids(27))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'Nfec',          &
     &                 nfec, dimids(28))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
#  endif
# endif
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'boundary',      &
     &                 4, dimids(14))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'tide_period',   &
     &                 ntc(ng), dimids(13))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%ncid, ncname, 'harmonics',     &
     &                 2*ntc(ng)+1, dimids(12))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
!
!  Set number of dimensions for output variables.
!
        nvd3=3
        nvd4=4
!
!  Define dimension vectors for tide harmonics variables.
!
        tharm(1)=dimids(13)
        tharm(2)=dimids(13)
!
!  Define dimension vectors for staggered tracer type variables.
!
        t2dgrd(1)=dimids( 1)
        t2dgrd(2)=dimids( 5)
        t2dgrd(3)=dimids(12)
# ifdef SOLVE3D
        t3dgrd(1)=dimids( 1)
        t3dgrd(2)=dimids( 5)
        t3dgrd(3)=dimids( 9)
        t3dgrd(4)=dimids(12)
# endif
!
!  Define dimension vectors for staggered u-momentum type variables.
!
        u2dgrd(1)=dimids( 2)
        u2dgrd(2)=dimids( 6)
        u2dgrd(3)=dimids(12)
# ifdef SOLVE3D
        u3dgrd(1)=dimids( 2)
        u3dgrd(2)=dimids( 6)
        u3dgrd(3)=dimids( 9)
        u3dgrd(4)=dimids(12)
# endif
!
!  Define dimension vectors for staggered v-momentum type variables.
!
        v2dgrd(1)=dimids( 3)
        v2dgrd(2)=dimids( 7)
        v2dgrd(3)=dimids(12)
# ifdef SOLVE3D
        v3dgrd(1)=dimids( 3)
        v3dgrd(2)=dimids( 7)
        v3dgrd(3)=dimids( 9)
        v3dgrd(4)=dimids(12)
# endif
!
!  Initialize local information variable arrays.
!
        DO i=1,natt
          DO j=1,len(vinfo(1))
            vinfo(i)(j:j)=' '
          END DO
        END DO
        DO i=1,6
          aval(i)=0.0_r8
        END DO
!
!-----------------------------------------------------------------------
!  Define time-recordless information variables.
!-----------------------------------------------------------------------
!
        CALL def_info (ng, inlm, har(ng)%ncid, ncname, dimids)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!-----------------------------------------------------------------------
!  Define least-squares detide harmonic variables.
!-----------------------------------------------------------------------
!
!  Define number of time-accumulated harmonics.
!
        vinfo( 1)='Hcount'
        vinfo( 2)='number of time-accumulated tide harmonics'
        status=def_var(ng, inlm, har(ng)%ncid, varid, nf90_int,         &
     &                 1, (/0/), aval, vinfo, ncname,                   &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define model time for accumulated tide harmonic fields.
!
        vinfo( 1)=vname(1,idtime)
        WRITE (vinfo( 2),'(a,a)') 'accumulated harmonics ',             &
     &                            trim(vname(2,idtime))
        WRITE (vinfo( 3),'(a,a)') 'seconds since ', trim(rclock%string)
        vinfo( 4)=trim(rclock%calendar)
        status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idtime),     &
     &                 nf_tout, 1, (/0/), aval, vinfo, ncname,          &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define tidal period.
!
        vinfo( 1)=vname(1,idtper)
        vinfo( 2)=vname(2,idtper)
        vinfo( 3)=vname(3,idtper)
        vinfo(21)=vname(6,idtper)
        status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idtper),     &
     &                 nf_tout, 1, (/tharm(1)/), aval, vinfo, ncname,   &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated COS(omega(k)*t) harmonics.
!
        vinfo( 1)=vname(1,idcosw)
        vinfo( 2)=vname(2,idcosw)
        vinfo( 3)=vname(3,idcosw)
        vinfo(21)=vname(6,idcosw)
        status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idcosw),     &
     &                 nf_tout, 1, (/tharm(1)/), aval, vinfo, ncname,   &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated SIN(omega(k)*t) harmonics.
!
        vinfo( 1)=vname(1,idsinw)
        vinfo( 2)=vname(2,idsinw)
        vinfo( 3)=vname(3,idsinw)
        vinfo(21)=vname(6,idsinw)
        status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idsinw),     &
     &                 nf_tout, 1, (/tharm(1)/), aval, vinfo, ncname,   &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated COS(omega(k)*t)*COS(omega(l)*t) harmonics.
!
        vinfo( 1)=vname(1,idcos2)
        vinfo( 2)=vname(2,idcos2)
        vinfo( 3)=vname(3,idcos2)
        vinfo(21)=vname(6,idcos2)
        status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idcos2),     &
     &                 nf_tout, 2, tharm, aval, vinfo, ncname,          &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated SIN(omega(k)*t)*SIN(omega(l)*t) harmonics.
!
        vinfo( 1)=vname(1,idsin2)
        vinfo( 2)=vname(2,idsin2)
        vinfo( 3)=vname(3,idsin2)
        vinfo(21)=vname(6,idsin2)
        status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idsin2),     &
     &                 nf_tout, 2, tharm, aval, vinfo, ncname,          &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated SIN(omega(k)*t)*COS(omega(l)*t) harmonics.
!
        vinfo( 1)=vname(1,idswcw)
        vinfo( 2)=vname(2,idswcw)
        vinfo( 3)=vname(3,idswcw)
        vinfo(21)=vname(6,idswcw)
        status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idswcw),     &
     &                 nf_tout, 2, tharm, aval, vinfo, ncname,          &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define free-surface time-accumulated tide harmonics.
!
        IF (aout(idfsud,ng)) THEN
          vinfo( 1)=vname(1,idfsuh)
          vinfo( 2)=vname(2,idfsuh)
          vinfo( 3)=vname(3,idfsuh)
          vinfo(14)=vname(4,idfsuh)
# if defined WRITE_WATER && defined MASKING
          vinfo(20)='mask_rho'
# endif
          vinfo(21)=vname(6,idfsuh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idfsuh,ng),r8)
          status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idfsuh),   &
     &                   nf_frst, nvd3, t2dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define 2D u-momentum time-accumulated tide harmonics.
!
        IF (aout(idu2dd,ng)) THEN
          vinfo( 1)=vname(1,idu2dh)
          vinfo( 2)=vname(2,idu2dh)
          vinfo( 3)=vname(3,idu2dh)
          vinfo(14)=vname(4,idu2dh)
          vinfo(21)=vname(6,idu2dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idu2dh,ng),r8)
          status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idu2dh),   &
     &                   nf_frst, nvd3, u2dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define 2D v-momentum time-accumulated tide harmonics.
!
        IF (aout(idv2dd,ng)) THEN
          vinfo( 1)=vname(1,idv2dh)
          vinfo( 2)=vname(2,idv2dh)
          vinfo( 3)=vname(3,idv2dh)
          vinfo(14)=vname(4,idv2dh)
          vinfo(21)=vname(6,idv2dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idv2dh,ng),r8)
          status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idv2dh),   &
     &                   nf_frst, nvd3, v2dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
 
# ifdef SOLVE3D
!
!  Define 3D u-momentum time-accumulated tide harmonics.
!
        IF (aout(idu3dd,ng)) THEN
          vinfo( 1)=vname(1,idu3dh)
          vinfo( 2)=vname(2,idu3dh)
          vinfo( 3)=vname(3,idu3dh)
          vinfo(14)=vname(4,idu3dh)
          vinfo(21)=vname(6,idu3dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idu3dh,ng),r8)
          status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idu3dh),   &
     &                   nf_frst, nvd4, u3dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define 3D v-momentum time-accumulated tide harmonics.
!
        IF (aout(idv3dd,ng)) THEN
          vinfo( 1)=vname(1,idv3dh)
          vinfo( 2)=vname(2,idv3dh)
          vinfo( 3)=vname(3,idv3dh)
          vinfo(14)=vname(4,idv3dh)
          vinfo(21)=vname(6,idv3dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idv3dh,ng),r8)
          status=def_var(ng, inlm, har(ng)%ncid, har(ng)%Vid(idv3dh),   &
     &                   nf_frst, nvd4, v3dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define temperaturea and salinity time-accumulated tide harmonics.
!
        DO itrc=1,nat
          IF (aout(idtrcd(itrc),ng)) THEN
            vinfo( 1)=vname(1,idtrch(itrc))
            vinfo( 2)=vname(2,idtrch(itrc))
            vinfo( 3)=vname(3,idtrch(itrc))
            vinfo(14)=vname(4,idtrch(itrc))
            vinfo(21)=vname(6,idtrch(itrc))
            vinfo(22)='coordinates'
            aval(5)=real(iinfo(1,idv3dh,ng),r8)
            status=def_var(ng, inlm, har(ng)%ncid,                      &
     &                     har(ng)%Vid(idtrch(itrc)),                   &
     &                     nf_frst, nvd4, t3dgrd, aval, vinfo, ncname)
            IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
          END IF
        END DO
# endif
!
!-----------------------------------------------------------------------
!  Leave definition mode.
!-----------------------------------------------------------------------
!
        CALL netcdf_enddef (ng, inlm, ncname, har(ng)%ncid)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!-----------------------------------------------------------------------
!  Write out time-recordless, information variables.
!-----------------------------------------------------------------------
!
        CALL wrt_info (ng, inlm, har(ng)%ncid, ncname)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      END IF define
!
!=======================================================================
!  Open an existing detide harmonics file, check its contents, and
!  prepare for updating data.
!=======================================================================
!
      query : IF (.not.ldef) THEN
        ncname=har(ng)%name
!
!  Open detide harmonics file for read/write.
!
        CALL netcdf_open (ng, inlm, ncname, 1, har(ng)%ncid)
        IF (founderror(exit_flag, noerror, __line__, myfile)) THEN
          WRITE (stdout,40) trim(ncname)
          RETURN
        END IF
!
!  Inquire about the dimensions and check for consistency.
!
        CALL netcdf_check_dim (ng, inlm, ncname,                        &
     &                         ncid = har(ng)%ncid)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Inquire about the variables.
!
        CALL netcdf_inq_var (ng, inlm, ncname,                          &
     &                       ncid = har(ng)%ncid)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Initialize logical switches.
!
        DO i=1,nv
          got_var(i)=.false.
        END DO
!
!  Scan variable list from input NetCDF and activate switches for
!  detide harmomics variables. Get variable IDs.
!
        DO i=1,n_var
          IF (trim(var_name(i)).eq.trim(vname(1,idtime))) THEN
            got_var(idtime)=.true.
            har(ng)%Vid(idtime)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idtper))) THEN
            got_var(idtper)=.true.
            har(ng)%Vid(idtper)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idcosw))) THEN
            got_var(idcosw)=.true.
            har(ng)%Vid(idcosw)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idsinw))) THEN
            got_var(idsinw)=.true.
            har(ng)%Vid(idsinw)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idcos2))) THEN
            got_var(idcos2)=.true.
            har(ng)%Vid(idcos2)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idsin2))) THEN
            got_var(idsin2)=.true.
            har(ng)%Vid(idsin2)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idswcw))) THEN
            got_var(idswcw)=.true.
            har(ng)%Vid(idswcw)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idfsuh))) THEN
            got_var(idfsuh)=.true.
            har(ng)%Vid(idfsuh)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idu2dh))) THEN
            got_var(idu2dh)=.true.
            har(ng)%Vid(idu2dh)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idv2dh))) THEN
            got_var(idv2dh)=.true.
            har(ng)%Vid(idv2dh)=var_id(i)
# ifdef SOLVE3D
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idu3dh))) THEN
            got_var(idu3dh)=.true.
            har(ng)%Vid(idu3dh)=var_id(i)
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idv3dh))) THEN
            got_var(idv3dh)=.true.
            har(ng)%Vid(idv3dh)=var_id(i)
# endif
          END IF
# ifdef SOLVE3D
          DO itrc=1,nat
            IF (trim(var_name(i)).eq.trim(vname(1,idtrch(itrc)))) THEN
              got_var(idtrch(itrc))=.true.
              har(ng)%Vid(idtrch(itrc))=var_id(i)
            END IF
          END DO
# endif
 
        END DO
!
!  Check if detide harmonics variables are available in input NetCDF
!  file.
!
        IF (.not.got_var(idtime)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idtime)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idtper)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idtper)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idcosw)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idcosw)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idsinw)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idsinw)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idcos2)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idcos2)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idsin2)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idsin2)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idswcw)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idswcw)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idfsuh).and.aout(idfsud,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idfsuh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idu2dh).and.aout(idu2dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idu2dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idv2dh).and.aout(idv2dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idv2dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
# ifdef SOLVE3D
        IF (.not.got_var(idu3dh).and.aout(idu3dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idu3dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idv3dh).and.aout(idv3dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idv3dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        DO itrc=1,nat
          IF (.not.got_var(idtrch(itrc)).and.aout(idtrcd(itrc),ng)) THEN
            IF (master) WRITE (stdout,50) trim(vname(1,idtrch(itrc))),  &
     &                                    trim(ncname)
            exit_flag=3
            RETURN
          END IF
        END DO
# endif
      END IF query
!
  10  FORMAT (2x,'DEF_TIDES_NF90   - creating harmonics file,',t56,     &
     &        'Grid ',i2.2,': ',a)
  20  FORMAT (4x,'DEF_TIDES_NF90   - inquiring harmonics file,',t56,    &
     &        'Grid ',i2.2,': ',a)
  30  FORMAT (/,' DEF_TIDES_NF90 - unable to create harmonics NetCDF',  &
     &        ' file: ',a)
  40  FORMAT (/,' DEF_TIDES_NF90 - unable to open harmonics NetCDF',    &
     &        ' file: ',a)
  50  FORMAT (/,' DEF_TIDES_NF90 - unable to find variable: ',a,2x,     &
     &        ' in detide harmonics NetCDF file: ',a)
!
      RETURN
      END SUBROUTINE def_tides_nf90
 
# if defined PIO_LIB && defined DISTRIBUTE
!
!**********************************************************************
      SUBROUTINE def_tides_pio (ng, ldef)
!**********************************************************************
!
      USE mod_pio_netcdf
!
!  Imported variable declarations.
!
      integer, intent(in) :: ng
!
      logical, intent(in) :: ldef
!
!  Local variable declarations.
!
      logical :: got_var(nv)
 
      logical :: ldefine = .false.
!
      integer, parameter :: natt = 25
 
      integer :: i, itrc, j, nvd3, nvd4
      integer :: status
 
      integer :: dimids(ndimid)
      integer :: tharm(2), t2dgrd(3), u2dgrd(3), v2dgrd(3)
#  ifdef SOLVE3D
      integer :: t3dgrd(4), u3dgrd(4), v3dgrd(4)
#  endif
!
      real(r8) :: aval(6)
!
      character (len=256)    :: ncname
      character (len=MaxLen) :: vinfo(natt)
 
      character (len=*), parameter :: myfile =                          &
     &  __FILE__//", def_tides_pio"
!
      TYPE (var_desc_t) :: vardesc
!
      sourcefile=myfile
!
!-----------------------------------------------------------------------
!  Set and report file name.
!-----------------------------------------------------------------------
!
      IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      ncname=har(ng)%name
!
      IF (master) THEN
        IF (ldef) THEN
          WRITE (stdout,10) ng, trim(ncname)
        ELSE
          WRITE (stdout,20) ng, trim(ncname)
        END IF
      END IF
!
!=======================================================================
!  Create a new least-squares detide harmonics file.
!=======================================================================
!
      define : IF (ldef) THEN
        CALL pio_netcdf_create (ng, inlm, trim(ncname), har(ng)%pioFile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) THEN
          IF (master) WRITE (stdout,30) trim(ncname)
          RETURN
        END IF
!
!-----------------------------------------------------------------------
!  Define file dimensions.
!-----------------------------------------------------------------------
!
        dimids=0
!
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'xi_rho',     &
     &                 iobounds(ng)%xi_rho, dimids( 1))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'xi_u',       &
     &                 iobounds(ng)%xi_u, dimids( 2))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'xi_v',       &
     &                 iobounds(ng)%xi_v, dimids( 3))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'xi_psi',     &
     &                 iobounds(ng)%xi_psi, dimids( 4))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'eta_rho',    &
     &                 iobounds(ng)%eta_rho, dimids( 5))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'eta_u',      &
     &                 iobounds(ng)%eta_u, dimids( 6))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'eta_v',      &
     &                 iobounds(ng)%eta_v, dimids( 7))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'eta_psi',    &
     &                 iobounds(ng)%eta_psi, dimids( 8))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
#  ifdef SOLVE3D
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 's_rho',      &
     &                 n(ng), dimids( 9))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 's_w',        &
     &                 n(ng)+1, dimids(10))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'tracer',     &
     &                 nt(ng), dimids(11))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
#   ifdef SEDIMENT
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'NST',        &
     &                 nst, dimids(32))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'Nbed',       &
     &                 nbed, dimids(16))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
#   endif
 
#   ifdef ECOSIM
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'Nbands',     &
     &                 nbands, dimids(33))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'Nphy',       &
     &                 nphy, dimids(25))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'Nbac',       &
     &                 nbac, dimids(26))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'Ndom',       &
     &                 ndom, dimids(27))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'Nfec',       &
     &                 nfec, dimids(28))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
#   endif
#  endif
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'boundary',   &
     &                 4, dimids(14))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'tide_period',&
     &                 ntc(ng), dimids(13))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
 
        status=def_dim(ng, inlm, har(ng)%pioFile, ncname, 'harmonics',  &
     &                 2*ntc(ng)+1, dimids(12))
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Set number of dimensions for output variables.
!
        nvd3=3
        nvd4=4
!
!  Define dimension vectors for tide harmonics variables.
!
        tharm(1)=dimids(13)
        tharm(2)=dimids(13)
!
!  Define dimension vectors for staggered tracer type variables.
!
        t2dgrd(1)=dimids( 1)
        t2dgrd(2)=dimids( 5)
        t2dgrd(3)=dimids(12)
#  ifdef SOLVE3D
        t3dgrd(1)=dimids( 1)
        t3dgrd(2)=dimids( 5)
        t3dgrd(3)=dimids( 9)
        t3dgrd(4)=dimids(12)
#  endif
!
!  Define dimension vectors for staggered u-momentum type variables.
!
        u2dgrd(1)=dimids( 2)
        u2dgrd(2)=dimids( 6)
        u2dgrd(3)=dimids(12)
#  ifdef SOLVE3D
        u3dgrd(1)=dimids( 2)
        u3dgrd(2)=dimids( 6)
        u3dgrd(3)=dimids( 9)
        u3dgrd(4)=dimids(12)
#  endif
!
!  Define dimension vectors for staggered v-momentum type variables.
!
        v2dgrd(1)=dimids( 3)
        v2dgrd(2)=dimids( 7)
        v2dgrd(3)=dimids(12)
#  ifdef SOLVE3D
        v3dgrd(1)=dimids( 3)
        v3dgrd(2)=dimids( 7)
        v3dgrd(3)=dimids( 9)
        v3dgrd(4)=dimids(12)
#  endif
!
!  Initialize local information variable arrays.
!
        DO i=1,natt
          DO j=1,len(vinfo(1))
            vinfo(i)(j:j)=' '
          END DO
        END DO
        DO i=1,6
          aval(i)=0.0_r8
        END DO
!
!-----------------------------------------------------------------------
!  Define time-recordless information variables.
!-----------------------------------------------------------------------
!
        CALL def_info (ng, inlm, har(ng)%pioFile, ncname, dimids)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!-----------------------------------------------------------------------
!  Define least-squares detide harmonic variables.
!-----------------------------------------------------------------------
!
!  Define number of time-accumulated harmonics.
!
        vinfo( 1)='Hcount'
        vinfo( 2)='number of time-accumulated tide harmonics'
        status=def_var(ng, inlm, har(ng)%pioFile, vardesc, pio_int,     &
     &                 1, (/0/), aval, vinfo, ncname,                   &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define model time for accumulated tide harmonic fields.
!
        vinfo( 1)=vname(1,idtime)
        WRITE (vinfo( 2),'(a,a)') 'accumulated harmonics ',             &
     &                            trim(vname(2,idtime))
        WRITE (vinfo( 3),'(a,a)') 'seconds since ', trim(rclock%string)
        vinfo( 4)=trim(rclock%calendar)
        har(ng)%pioVar(idtime)%dkind=pio_tout
        har(ng)%pioVar(idtime)%gtype=0
!
        status=def_var(ng, inlm, har(ng)%pioFile,                       &
     &                 har(ng)%pioVar(idtime)%vd,                       &
     &                 pio_tout, 1, (/0/), aval, vinfo, ncname,         &
     &                 setparaccess = .false.)
 
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define tidal period.
!
        vinfo( 1)=vname(1,idtper)
        vinfo( 2)=vname(2,idtper)
        vinfo( 3)=vname(3,idtper)
        vinfo(21)=vname(6,idtper)
        har(ng)%pioVar(idtper)%dkind=pio_tout
        har(ng)%pioVar(idtper)%gtype=0
!
        status=def_var(ng, inlm, har(ng)%pioFile,                       &
     &                 har(ng)%pioVar(idtper)%vd,                       &
     &                 pio_tout, 1, (/tharm(1)/), aval, vinfo, ncname,  &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated COS(omega(k)*t) harmonics.
!
        vinfo( 1)=vname(1,idcosw)
        vinfo( 2)=vname(2,idcosw)
        vinfo( 3)=vname(3,idcosw)
        vinfo(21)=vname(6,idcosw)
        har(ng)%pioVar(idcosw)%dkind=pio_tout
        har(ng)%pioVar(idcosw)%gtype=0
!
        status=def_var(ng, inlm, har(ng)%pioFile,                       &
     &                 har(ng)%pioVar(idcosw)%vd,                       &
     &                 pio_tout, 1, (/tharm(1)/), aval, vinfo, ncname,  &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated SIN(omega(k)*t) harmonics.
!
        vinfo( 1)=vname(1,idsinw)
        vinfo( 2)=vname(2,idsinw)
        vinfo( 3)=vname(3,idsinw)
        vinfo(21)=vname(6,idsinw)
        har(ng)%pioVar(idsinw)%dkind=pio_tout
        har(ng)%pioVar(idsinw)%gtype=0
!
        status=def_var(ng, inlm, har(ng)%pioFile,                       &
     &                 har(ng)%pioVar(idsinw)%vd,                       &
     &                 pio_tout, 1, (/tharm(1)/), aval, vinfo, ncname,  &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated COS(omega(k)*t)*COS(omega(l)*t) harmonics.
!
        vinfo( 1)=vname(1,idcos2)
        vinfo( 2)=vname(2,idcos2)
        vinfo( 3)=vname(3,idcos2)
        vinfo(21)=vname(6,idcos2)
        har(ng)%pioVar(idcos2)%dkind=pio_tout
        har(ng)%pioVar(idcos2)%gtype=0
!
        status=def_var(ng, inlm, har(ng)%pioFile,                       &
     &                 har(ng)%pioVar(idcos2)%vd,                       &
     &                 pio_tout, 2, tharm, aval, vinfo, ncname,         &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated SIN(omega(k)*t)*SIN(omega(l)*t) harmonics.
!
        vinfo( 1)=vname(1,idsin2)
        vinfo( 2)=vname(2,idsin2)
        vinfo( 3)=vname(3,idsin2)
        vinfo(21)=vname(6,idsin2)
        har(ng)%pioVar(idsin2)%dkind=pio_tout
        har(ng)%pioVar(idsin2)%gtype=0
!
        status=def_var(ng, inlm, har(ng)%pioFile,                       &
     &                 har(ng)%pioVar(idsin2)%vd,                       &
     &                 pio_tout, 2, tharm, aval, vinfo, ncname,         &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define time-accumulated SIN(omega(k)*t)*COS(omega(l)*t) harmonics.
!
        vinfo( 1)=vname(1,idswcw)
        vinfo( 2)=vname(2,idswcw)
        vinfo( 3)=vname(3,idswcw)
        vinfo(21)=vname(6,idswcw)
        har(ng)%pioVar(idswcw)%dkind=pio_tout
        har(ng)%pioVar(idswcw)%gtype=0
!
        status=def_var(ng, inlm, har(ng)%pioFile,                       &
     &                 har(ng)%pioVar(idswcw)%vd,                       &
     &                 pio_tout, 2, tharm, aval, vinfo, ncname,         &
     &                 setparaccess = .false.)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Define free-surface time-accumulated tide harmonics.
!
        IF (aout(idfsud,ng)) THEN
          vinfo( 1)=vname(1,idfsuh)
          vinfo( 2)=vname(2,idfsuh)
          vinfo( 3)=vname(3,idfsuh)
          vinfo(14)=vname(4,idfsuh)
#  if defined WRITE_WATER && defined MASKING
          vinfo(20)='mask_rho'
#  endif
          vinfo(21)=vname(6,idfsuh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idfsuh,ng),r8)
          har(ng)%pioVar(idfsuh)%dkind=pio_frst
          har(ng)%pioVar(idfsuh)%gtype=r2dvar
!
          status=def_var(ng, inlm, har(ng)%pioFile,                     &
     &                   har(ng)%pioVar(idfsuh)%vd,                     &
     &                   pio_frst, nvd3, t2dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define 2D u-momentum time-accumulated tide harmonics.
!
        IF (aout(idu2dd,ng)) THEN
          vinfo( 1)=vname(1,idu2dh)
          vinfo( 2)=vname(2,idu2dh)
          vinfo( 3)=vname(3,idu2dh)
          vinfo(14)=vname(4,idu2dh)
          vinfo(21)=vname(6,idu2dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idu2dh,ng),r8)
          har(ng)%pioVar(idu2dh)%dkind=pio_frst
          har(ng)%pioVar(idu2dh)%gtype=u2dvar
!
          status=def_var(ng, inlm, har(ng)%pioFile,                     &
     &                   har(ng)%pioVar(idu2dh)%vd,                     &
     &                   pio_frst, nvd3, u2dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define 2D v-momentum time-accumulated tide harmonics.
!
        IF (aout(idv2dd,ng)) THEN
          vinfo( 1)=vname(1,idv2dh)
          vinfo( 2)=vname(2,idv2dh)
          vinfo( 3)=vname(3,idv2dh)
          vinfo(14)=vname(4,idv2dh)
          vinfo(21)=vname(6,idv2dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idv2dh,ng),r8)
          har(ng)%pioVar(idv2dh)%dkind=pio_frst
          har(ng)%pioVar(idv2dh)%gtype=v2dvar
!
          status=def_var(ng, inlm, har(ng)%pioFile,                     &
     &                   har(ng)%pioVar(idv2dh)%vd,                     &
     &                   pio_frst, nvd3, v2dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
 
#  ifdef SOLVE3D
!
!  Define 3D u-momentum time-accumulated tide harmonics.
!
        IF (aout(idu3dd,ng)) THEN
          vinfo( 1)=vname(1,idu3dh)
          vinfo( 2)=vname(2,idu3dh)
          vinfo( 3)=vname(3,idu3dh)
          vinfo(14)=vname(4,idu3dh)
          vinfo(21)=vname(6,idu3dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idu3dh,ng),r8)
          har(ng)%pioVar(idu3dh)%dkind=pio_frst
          har(ng)%pioVar(idu3dh)%gtype=u3dvar
!
          status=def_var(ng, inlm, har(ng)%pioFile,                     &
     &                   har(ng)%pioVar(idu3dh)%vd,                     &
     &                   pio_frst, nvd4, u3dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define 3D v-momentum time-accumulated tide harmonics.
!
        IF (aout(idv3dd,ng)) THEN
          vinfo( 1)=vname(1,idv3dh)
          vinfo( 2)=vname(2,idv3dh)
          vinfo( 3)=vname(3,idv3dh)
          vinfo(14)=vname(4,idv3dh)
          vinfo(21)=vname(6,idv3dh)
          vinfo(22)='coordinates'
          aval(5)=real(iinfo(1,idv3dh,ng),r8)
          har(ng)%pioVar(idv3dh)%dkind=pio_frst
          har(ng)%pioVar(idv3dh)%gtype=v3dvar
!
          status=def_var(ng, inlm, har(ng)%pioFile,                     &
     &                   har(ng)%pioVar(idv3dh)%vd,                     &
     &                   pio_frst, nvd4, v3dgrd, aval, vinfo, ncname)
          IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
        END IF
!
!  Define temperaturea and salinity time-accumulated tide harmonics.
!
        DO itrc=1,nat
          IF (aout(idtrcd(itrc),ng)) THEN
            vinfo( 1)=vname(1,idtrch(itrc))
            vinfo( 2)=vname(2,idtrch(itrc))
            vinfo( 3)=vname(3,idtrch(itrc))
            vinfo(14)=vname(4,idtrch(itrc))
            vinfo(21)=vname(6,idtrch(itrc))
            vinfo(22)='coordinates'
            aval(5)=real(iinfo(1,idv3dh,ng),r8)
            har(ng)%pioVar(idtrch)%dkind=pio_frst
            har(ng)%pioVar(idtrch)%gtype=r3dvar
!
            status=def_var(ng, inlm, har(ng)%pioFile,                   &
     &                     har(ng)%pioVar(idtrch(itrc))%vd,             &
     &                     pio_frst, nvd4, t3dgrd, aval, vinfo, ncname)
            IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
          END IF
        END DO
#  endif
!
!-----------------------------------------------------------------------
!  Leave definition mode.
!-----------------------------------------------------------------------
!
        CALL pio_netcdf_enddef (ng, inlm, ncname, har(ng)%pioFile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!-----------------------------------------------------------------------
!  Write out time-recordless, information variables.
!-----------------------------------------------------------------------
!
        CALL wrt_info (ng, inlm, har(ng)%pioFile, ncname)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
      END IF define
!
!=======================================================================
!  Open an existing detide harmonics file, check its contents, and
!  prepare for updating data.
!=======================================================================
!
      query : IF (.not.ldef) THEN
        ncname=har(ng)%name
!
!  Open detide harmonics file for read/write.
!
        CALL pio_netcdf_open (ng, inlm, ncname, 1, har(ng)%pioFile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) THEN
          WRITE (stdout,40) trim(ncname)
          RETURN
        END IF
!
!  Inquire about the dimensions and check for consistency.
!
        CALL pio_netcdf_check_dim (ng, inlm, ncname,                    &
     &                             piofile = har(ng)%pioFile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Inquire about the variables.
!
        CALL pio_netcdf_inq_var (ng, inlm, ncname,                      &
     &                           piofile = har(ng)%pioFile)
        IF (founderror(exit_flag, noerror, __line__, myfile)) RETURN
!
!  Initialize logical switches.
!
        DO i=1,nv
          got_var(i)=.false.
        END DO
!
!  Scan variable list from input NetCDF and activate switches for
!  detide harmomics variables. Get variable IDs.
!
        DO i=1,n_var
          IF (trim(var_name(i)).eq.trim(vname(1,idtime))) THEN
            got_var(idtime)=.true.
            har(ng)%pioVar(idtime)%vd=var_desc(i)
            har(ng)%pioVar(idtime)%dkind=pio_tout
            har(ng)%pioVar(idtime)%gtype=0
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idtper))) THEN
            got_var(idtper)=.true.
            har(ng)%pioVar(idtper)%vd=var_desc(i)
            har(ng)%pioVar(idtper)%dkind=pio_tout
            har(ng)%pioVar(idtper)%gtype=0
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idcosw))) THEN
            got_var(idcosw)=.true.
            har(ng)%pioVar(idcosw)%vd=var_desc(i)
            har(ng)%pioVar(idcosw)%dkind=pio_tout
            har(ng)%pioVar(idcosw)%gtype=0
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idsinw))) THEN
            got_var(idsinw)=.true.
            har(ng)%pioVar(idsinw)%vd=var_desc(i)
            har(ng)%pioVar(idsinw)%dkind=pio_tout
            har(ng)%pioVar(idsinw)%gtype=0
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idcos2))) THEN
            got_var(idcos2)=.true.
            har(ng)%pioVar(idcos2)%vd=var_desc(i)
            har(ng)%pioVar(idcos2)%dkind=pio_tout
            har(ng)%pioVar(idcos2)%gtype=0
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idsin2))) THEN
            got_var(idsin2)=.true.
            har(ng)%pioVar(idsin2)%vd=var_desc(i)
            har(ng)%pioVar(idsin2)%dkind=pio_tout
            har(ng)%pioVar(idsin2)%gtype=0
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idswcw))) THEN
            got_var(idswcw)=.true.
            har(ng)%pioVar(idswcw)%vd=var_desc(i)
            har(ng)%pioVar(idswcw)%dkind=pio_tout
            har(ng)%pioVar(idswcw)%gtype=0
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idfsuh))) THEN
            got_var(idfsuh)=.true.
            har(ng)%pioVar(idfsuh)%vd=var_desc(i)
            har(ng)%pioVar(idfsuh)%dkind=pio_frst
            har(ng)%pioVar(idfsuh)%gtype=r2dvar
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idu2dh))) THEN
            got_var(idu2dh)=.true.
            har(ng)%pioVar(idu2dh)%vd=var_desc(i)
            har(ng)%pioVar(idu2dh)%dkind=pio_frst
            har(ng)%pioVar(idu2dh)%gtype=u2dvar
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idv2dh))) THEN
            got_var(idv2dh)=.true.
            har(ng)%pioVar(idv2dh)%vd=var_desc(i)
            har(ng)%pioVar(idv2dh)%dkind=pio_frst
            har(ng)%pioVar(idv2dh)%gtype=v2dvar
#  ifdef SOLVE3D
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idu3dh))) THEN
            got_var(idu3dh)=.true.
            har(ng)%pioVar(idu3dh)%vd=var_desc(i)
            har(ng)%pioVar(idu3dh)%dkind=pio_frst
            har(ng)%pioVar(idu3dh)%gtype=u3dvar
          ELSE IF (trim(var_name(i)).eq.trim(vname(1,idv3dh))) THEN
            got_var(idv3dh)=.true.
            har(ng)%pioVar(idv3dh)%vd=var_desc(i)
            har(ng)%pioVar(idv3dh)%dkind=pio_frst
            har(ng)%pioVar(idv3dh)%gtype=v3dvar
#  endif
          END IF
#  ifdef SOLVE3D
          DO itrc=1,nat
            IF (trim(var_name(i)).eq.trim(vname(1,idtrch(itrc)))) THEN
              got_var(idtrch(itrc))=.true.
              har(ng)%pioVar(idtrch(itrc))%vd=var_desc(i)
              har(ng)%pioVar(idtrch)%dkind=pio_frst
              har(ng)%pioVar(idtrch)%gtype=r3dvar
            END IF
          END DO
#  endif
        END DO
!
!  Check if detide harmonics variables are available in input NetCDF
!  file.
!
        IF (.not.got_var(idtime)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idtime)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idtper)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idtper)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idcosw)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idcosw)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idsinw)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idsinw)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idcos2)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idcos2)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idsin2)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idsin2)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idswcw)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idswcw)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idfsuh).and.aout(idfsud,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idfsuh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idu2dh).and.aout(idu2dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idu2dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idv2dh).and.aout(idv2dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idv2dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
#  ifdef SOLVE3D
        IF (.not.got_var(idu3dh).and.aout(idu3dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idu3dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        IF (.not.got_var(idv3dh).and.aout(idv3dd,ng)) THEN
          IF (master) WRITE (stdout,50) trim(vname(1,idv3dh)),          &
     &                                  trim(ncname)
          exit_flag=3
          RETURN
        END IF
        DO itrc=1,nat
          IF (.not.got_var(idtrch(itrc)).and.aout(idtrcd(itrc),ng)) THEN
            IF (master) WRITE (stdout,50) trim(vname(1,idtrch(itrc))),  &
     &                                    trim(ncname)
            exit_flag=3
            RETURN
          END IF
        END DO
#  endif
      END IF query
!
  10  FORMAT (2x,'DEF_TIDES_PIO    - creating harmonics file,',t56,     &
     &        'Grid ',i2.2,': ',a)
  20  FORMAT (4x,'DEF_TIDES_PIO    - inquiring harmonics file,',t56,    &
     &        'Grid ',i2.2,': ',a)
  30  FORMAT (/,' DEF_TIDES_PIO - unable to create harmonics NetCDF',   &
     &        ' file: ',a)
  40  FORMAT (/,' DEF_TIDES_PIO - unable to open harmonics NetCDF',     &
     &        ' file: ',a)
  50  FORMAT (/,' DEF_TIDES_PIO - unable to find variable: ',a,2x,      &
     &        ' in detide harmonics NetCDF file: ',a)
!
      RETURN
      END SUBROUTINE def_tides_pio
# endif
#endif
      END MODULE def_tides_mod