MODULE def_impulse_mod ! !git $Id$ !svn $Id: def_impulse.F 1151 2023-02-09 03:08:53Z arango $ !================================================== Hernan G. Arango === ! Copyright (c) 2002-2023 The ROMS/TOMS Group ! ! Licensed under a MIT/X style license ! ! See License_ROMS.md ! !======================================================================= ! ! ! This routine creates tangent linear and representer models impulse ! ! forcing NetCDF file used for weak constraint 4DVAR. It defines its ! ! dimensions, attributes, and variables. ! ! ! !======================================================================= ! USE mod_param USE mod_parallel USE mod_fourdvar USE mod_iounits USE mod_ncparam USE mod_scalars ! 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_impulse PRIVATE :: def_impulse_nf90 ! CONTAINS ! !*********************************************************************** SUBROUTINE def_impulse (ng) !*********************************************************************** ! ! Imported variable declarations. ! integer, intent(in) :: ng ! ! Local variable declarations. ! character (len=*), parameter :: MyFile = & & "ROMS/Utility/def_impulse.F" ! !----------------------------------------------------------------------- ! Create a new history file according to IO type. !----------------------------------------------------------------------- ! SELECT CASE (TLF(ng)%IOtype) CASE (io_nf90) CALL def_impulse_nf90 (ng) CASE DEFAULT IF (Master) WRITE (stdout,10) TLF(ng)%IOtype exit_flag=3 END SELECT IF (FoundError(exit_flag, NoError, 77, MyFile)) RETURN ! 10 FORMAT (' DEF_IMPULSE - Illegal output file type, io_type = ',i0, & & /,15x,'Check KeyWord ''OUT_LIB'' in ''roms.in''.') ! RETURN END SUBROUTINE def_impulse ! !*********************************************************************** SUBROUTINE def_impulse_nf90 (ng) !*********************************************************************** ! USE mod_netcdf ! ! Imported variable declarations. ! integer, intent(in) :: ng ! ! Local variable declarations. ! logical :: Ldefine, got_var(NV) ! integer, parameter :: Natt = 25 integer :: i, j, nvd3, nvd4 integer :: recdim, status, varid integer :: Fcount integer :: DimIDs(nDimID) integer :: t2dgrd(3), u2dgrd(3), v2dgrd(3) integer :: itrc integer :: t3dgrd(4), u3dgrd(4), v3dgrd(4) ! real(r8) :: Aval(6) ! character (len=256) :: ncname character (len=MaxLen) :: Vinfo(Natt) character (len=*), parameter :: MyFile = & & "ROMS/Utility/def_impulse.F"//", def_impulse_nf90" ! SourceFile=MyFile ! !======================================================================= ! Create a new impulse forcing file. !======================================================================= ! IF (FoundError(exit_flag, NoError, 128, MyFile)) RETURN ncname=TLF(ng)%name ! IF (Master) THEN IF (LdefTLF(ng)) THEN WRITE (stdout,10) ng, TRIM(ncname) ELSE WRITE (stdout,20) ng, TRIM(ncname) END IF END IF ! DEFINE : IF (LdefTLF(ng)) THEN CALL netcdf_create (ng, iTLM, TRIM(ncname), TLF(ng)%ncid) IF (FoundError(exit_flag, NoError, 141, MyFile)) THEN IF (Master) WRITE (stdout,30) TRIM(ncname) RETURN END IF ! !----------------------------------------------------------------------- ! Define file dimensions. !----------------------------------------------------------------------- ! DimIDs=0 ! status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'xi_rho', & & IOBOUNDS(ng)%xi_rho, DimIDs( 1)) IF (FoundError(exit_flag, NoError, 154, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'xi_u', & & IOBOUNDS(ng)%xi_u, DimIDs( 2)) IF (FoundError(exit_flag, NoError, 158, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'xi_v', & & IOBOUNDS(ng)%xi_v, DimIDs( 3)) IF (FoundError(exit_flag, NoError, 162, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'xi_psi', & & IOBOUNDS(ng)%xi_psi, DimIDs( 4)) IF (FoundError(exit_flag, NoError, 166, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'eta_rho', & & IOBOUNDS(ng)%eta_rho, DimIDs( 5)) IF (FoundError(exit_flag, NoError, 170, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'eta_u', & & IOBOUNDS(ng)%eta_u, DimIDs( 6)) IF (FoundError(exit_flag, NoError, 174, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'eta_v', & & IOBOUNDS(ng)%eta_v, DimIDs( 7)) IF (FoundError(exit_flag, NoError, 178, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'eta_psi', & & IOBOUNDS(ng)%eta_psi, DimIDs( 8)) IF (FoundError(exit_flag, NoError, 182, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 's_rho', & & N(ng), DimIDs( 9)) IF (FoundError(exit_flag, NoError, 219, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 's_w', & & N(ng)+1, DimIDs(10)) IF (FoundError(exit_flag, NoError, 223, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'tracer', & & NT(ng), DimIDs(11)) IF (FoundError(exit_flag, NoError, 227, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'boundary', & & 4, DimIDs(14)) IF (FoundError(exit_flag, NoError, 270, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, 'Nstate', & & NstateVar(ng), DimIDs(29)) IF (FoundError(exit_flag, NoError, 275, MyFile)) RETURN status=def_dim(ng, iTLM, TLF(ng)%ncid, ncname, & & TRIM(ADJUSTL(Vname(5,idtime))), & & nf90_unlimited, DimIDs(12)) IF (FoundError(exit_flag, NoError, 281, MyFile)) RETURN recdim=DimIDs(12) ! ! Set number of dimensions for output variables. ! nvd3=3 nvd4=4 ! ! Define dimension vectors for staggered tracer type variables. ! t2dgrd(1)=DimIDs( 1) t2dgrd(2)=DimIDs( 5) t2dgrd(3)=DimIDs(12) t3dgrd(1)=DimIDs( 1) t3dgrd(2)=DimIDs( 5) t3dgrd(3)=DimIDs( 9) t3dgrd(4)=DimIDs(12) ! ! Define dimension vectors for staggered u-momentum type variables. ! u2dgrd(1)=DimIDs( 2) u2dgrd(2)=DimIDs( 6) u2dgrd(3)=DimIDs(12) u3dgrd(1)=DimIDs( 2) u3dgrd(2)=DimIDs( 6) u3dgrd(3)=DimIDs( 9) u3dgrd(4)=DimIDs(12) ! ! Define dimension vectors for staggered v-momentum type variables. ! v2dgrd(1)=DimIDs( 3) v2dgrd(2)=DimIDs( 7) v2dgrd(3)=DimIDs(12) v3dgrd(1)=DimIDs( 3) v3dgrd(2)=DimIDs( 7) v3dgrd(3)=DimIDs( 9) v3dgrd(4)=DimIDs(12) ! ! Initialize unlimited time record dimension. ! TLF(ng)%Rindex=0 ! ! 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, iTLM, TLF(ng)%ncid, ncname, DimIDs) IF (FoundError(exit_flag, NoError, 378, MyFile)) RETURN ! !----------------------------------------------------------------------- ! Define TLM/RPM impulse forcing. !----------------------------------------------------------------------- ! ! Define model time. ! Vinfo( 1)=Vname(1,idtime) Vinfo( 2)=Vname(2,idtime) WRITE (Vinfo( 3),'(a,a)') 'seconds since ', TRIM(Rclock%string) Vinfo( 4)=TRIM(Rclock%calendar) Vinfo(14)=Vname(4,idtime) Vinfo(21)=Vname(6,idtime) status=def_var(ng, iTLM, TLF(ng)%ncid, TLF(ng)%Vid(idtime), & & NF_TOUT, 1, (/recdim/), Aval, Vinfo, ncname, & & SetParAccess = .TRUE.) IF (FoundError(exit_flag, NoError, 395, MyFile)) RETURN ! ! Define free-surface impulse forcing. ! Vinfo( 1)=Vname(1,idZtlf) Vinfo( 2)=Vname(2,idZtlf) Vinfo( 3)=Vname(3,idZtlf) Vinfo(14)=Vname(4,idZtlf) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idZtlf) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idZtlf,ng),r8) status=def_var(ng, iTLM, TLF(ng)%ncid, TLF(ng)%Vid(idZtlf), & & NF_FOUT, nvd3, t2dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 412, MyFile)) RETURN ! ! Define 3D U-momentum component impulse forcing. ! Vinfo( 1)=Vname(1,idUtlf) Vinfo( 2)=Vname(2,idUtlf) Vinfo( 3)=Vname(3,idUtlf) Vinfo(14)=Vname(4,idUtlf) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idUtlf) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idUtlf,ng),r8) status=def_var(ng, iTLM, TLF(ng)%ncid, TLF(ng)%Vid(idUtlf), & & NF_FOUT, nvd4, u3dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 467, MyFile)) RETURN ! ! Define 3D V-momentum component impulse forcing. ! Vinfo( 1)=Vname(1,idVtlf) Vinfo( 2)=Vname(2,idVtlf) Vinfo( 3)=Vname(3,idVtlf) Vinfo(14)=Vname(4,idVtlf) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idVtlf) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idVtlf,ng),r8) status=def_var(ng, iTLM, TLF(ng)%ncid, TLF(ng)%Vid(idVtlf), & & NF_FOUT, nvd4, v3dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 484, MyFile)) RETURN ! ! Define tracer type impulse forcing variables. ! DO itrc=1,NT(ng) Vinfo( 1)=Vname(1,idTtlf(itrc)) Vinfo( 2)=Vname(2,idTtlf(itrc)) Vinfo( 3)=Vname(3,idTtlf(itrc)) Vinfo(14)=Vname(4,idTtlf(itrc)) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idTtlf(itrc)) Vinfo(22)='coordinates' Aval(5)=REAL(r3dvar,r8) status=def_var(ng, iTLM, TLF(ng)%ncid, TLF(ng)%Tid(itrc), & & NF_FOUT, nvd4, t3dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 509, MyFile)) RETURN END DO ! !----------------------------------------------------------------------- ! Leave definition mode. !----------------------------------------------------------------------- ! CALL netcdf_enddef (ng, iTLM, ncname, TLF(ng)%ncid) IF (FoundError(exit_flag, NoError, 518, MyFile)) RETURN ! !----------------------------------------------------------------------- ! Write out time-recordless, information variables. Deactive file ! creation switch. !----------------------------------------------------------------------- ! CALL wrt_info (ng, iTLM, TLF(ng)%ncid, ncname) IF (FoundError(exit_flag, NoError, 526, MyFile)) RETURN LdefTLF(ng)=.FALSE. END IF DEFINE ! !======================================================================= ! Open an existing impulse forcing file, check its contents, and ! prepare for appending data. !======================================================================= ! QUERY : IF (.not.LdefTLF(ng)) THEN ncname=TLF(ng)%name ! ! Open impulse forcing file for read/write. ! IF (TLF(ng)%ncid.eq.-1) THEN CALL netcdf_open (ng, iTLM, ncname, 1, TLF(ng)%ncid) IF (FoundError(exit_flag, NoError, 542, MyFile)) THEN WRITE (stdout,50) TRIM(ncname) RETURN END IF END IF ! ! Inquire about the dimensions and check for consistency. ! CALL netcdf_check_dim (ng, iTLM, ncname, & & ncid = TLF(ng)%ncid) IF (FoundError(exit_flag, NoError, 552, MyFile)) RETURN ! ! Inquire about the variables. ! CALL netcdf_inq_var (ng, iTLM, ncname, & & ncid = TLF(ng)%ncid) IF (FoundError(exit_flag, NoError, 558, 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 ! impulse forcing variables. Get variable IDs. ! DO i=1,n_var IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idtime))) THEN got_var(idtime)=.TRUE. TLF(ng)%Vid(idtime)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idZtlf))) THEN got_var(idZtlf)=.TRUE. TLF(ng)%Vid(idZtlf)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idUtlf))) THEN got_var(idUtlf)=.TRUE. TLF(ng)%Vid(idUtlf)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idVtlf))) THEN got_var(idVtlf)=.TRUE. TLF(ng)%Vid(idVtlf)=var_id(i) END IF DO itrc=1,NT(ng) IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idTtlf(itrc)))) THEN got_var(idTtlf(itrc))=.TRUE. TLF(ng)%Tid(itrc)=var_id(i) END IF END DO END DO ! ! Check if impulse forcing variables are available in input NetCDF ! file. ! IF (.not.got_var(idtime)) THEN IF (Master) WRITE (stdout,60) TRIM(Vname(1,idtime)), & & TRIM(ncname) exit_flag=3 RETURN END IF IF (.not.got_var(idZtlf)) THEN IF (Master) WRITE (stdout,60) TRIM(Vname(1,idZtlf)), & & TRIM(ncname) exit_flag=3 RETURN END IF IF (.not.got_var(idUtlf)) THEN IF (Master) WRITE (stdout,60) TRIM(Vname(1,idUtlf)), & & TRIM(ncname) exit_flag=3 RETURN END IF IF (.not.got_var(idVtlf)) THEN IF (Master) WRITE (stdout,60) TRIM(Vname(1,idVtlf)), & & TRIM(ncname) exit_flag=3 RETURN END IF DO itrc=1,NT(ng) IF (.not.got_var(idTtlf(itrc))) THEN IF (Master) WRITE (stdout,60) TRIM(Vname(1,idTtlf(itrc))), & & TRIM(ncname) exit_flag=3 RETURN END IF END DO ! ! Set unlimited time record dimension to the appropriate value. ! TLF(ng)%Rindex=rec_size Fcount=TLF(ng)%Fcount TLF(ng)%Nrec(Fcount)=rec_size END IF QUERY ! 10 FORMAT (2x,'DEF_IMPULSE_NF90 - creating impulse forcing file,', & & t56,'Grid ',i2.2,': ',a) 20 FORMAT (2x,'DEF_IMPULSE_NF90 - inquiring impulse forcing file,', & & t56,'Grid ',i2.2,': ',a) 30 FORMAT (/,' DEF_IMPULSE_NF90 - unable to create impulse forcing', & & ' NetCDF file: ',a) 40 FORMAT (1pe11.4,1x,'millimeter') 50 FORMAT (/,' DEF_IMPULSE_NF90 - unable to open norm NetCDF', & & ' file: ',a) 60 FORMAT (/,' DEF_IMPULSE_NF90 - unable to find variable: ',a,2x, & & ' in impulse forcing NetCDF file: ',a) ! RETURN END SUBROUTINE def_impulse_nf90 END MODULE def_impulse_mod