MODULE def_norm_mod ! !git $Id$ !svn $Id: def_norm.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 error covariance normalization factors file ! ! using either the standard NetCDF library or the Parallel-IO (PIO) ! ! library. It defines its dimensions, attributes, and variables. ! ! ! ! The NetCDF files are used for variational data assimilation. Four ! ! different files can be generates for initial, model, opem boundary, ! ! and surface forcing error covariances. ! ! ! !======================================================================= ! 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_norm PRIVATE :: def_norm_nf90 ! CONTAINS ! !*********************************************************************** SUBROUTINE def_norm (ng, model, ifile) !*********************************************************************** ! ! Imported variable declarations. ! integer, intent(in) :: ng, model, ifile ! ! Local variable declarations. ! character (len=*), parameter :: MyFile = & & "ROMS/Utility/def_norm.F" ! !----------------------------------------------------------------------- ! Create a new history file according to IO type. !----------------------------------------------------------------------- ! SELECT CASE (NRM(ifile,ng)%IOtype) CASE (io_nf90) CALL def_norm_nf90 (ng, model, ifile) CASE DEFAULT IF (Master) WRITE (stdout,10) NRM(ifile,ng)%IOtype exit_flag=3 END SELECT IF (FoundError(exit_flag, NoError, 81, MyFile)) RETURN ! 10 FORMAT (' DEF_NORM - Illegal output file type, io_type = ',i0, & & /,12x,'Check KeyWord ''OUT_LIB'' in ''roms.in''.') ! RETURN END SUBROUTINE def_norm ! !*********************************************************************** SUBROUTINE def_norm_nf90 (ng, model, ifile) !*********************************************************************** ! USE mod_netcdf ! ! Imported variable declarations. ! integer, intent(in) :: ng, model, ifile ! ! Local variable declarations. ! logical :: Ldefine, got_var(NV) ! integer, parameter :: Natt = 25 integer :: i, j, nvd3, nvd4 integer :: recdim, status, varid 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=60 ) :: Text character (len=256) :: ncname character (len=MaxLen) :: Vinfo(Natt) character (len=*), parameter :: MyFile = & & "ROMS/Utility/def_norm.F"//", def_norm_nf90" ! SourceFile=MyFile ! !======================================================================= ! Create a new background covariace normalization file. !======================================================================= ! IF (FoundError(exit_flag, NoError, 139, MyFile)) RETURN ncname=NRM(ifile,ng)%name ! DEFINE : IF (LdefNRM(ifile,ng)) THEN CALL netcdf_create (ng, iTLM, TRIM(ncname), NRM(ifile,ng)%ncid) IF (FoundError(exit_flag, NoError, 144, MyFile)) THEN IF (Master) WRITE (stdout,10) TRIM(ncname) RETURN END IF ! !----------------------------------------------------------------------- ! Define the dimensions of staggered fields. !----------------------------------------------------------------------- ! DimIDs=0 ! status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'xi_rho', & & IOBOUNDS(ng)%xi_rho, DimIDs( 1)) IF (FoundError(exit_flag, NoError, 157, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'xi_u', & & IOBOUNDS(ng)%xi_u, DimIDs( 2)) IF (FoundError(exit_flag, NoError, 161, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'xi_v', & & IOBOUNDS(ng)%xi_v, DimIDs( 3)) IF (FoundError(exit_flag, NoError, 165, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'xi_psi', & & IOBOUNDS(ng)%xi_psi, DimIDs( 4)) IF (FoundError(exit_flag, NoError, 169, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'eta_rho', & & IOBOUNDS(ng)%eta_rho, DimIDs( 5)) IF (FoundError(exit_flag, NoError, 173, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'eta_u', & & IOBOUNDS(ng)%eta_u, DimIDs( 6)) IF (FoundError(exit_flag, NoError, 177, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'eta_v', & & IOBOUNDS(ng)%eta_v, DimIDs( 7)) IF (FoundError(exit_flag, NoError, 181, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'eta_psi', & & IOBOUNDS(ng)%eta_psi, DimIDs( 8)) IF (FoundError(exit_flag, NoError, 185, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 's_rho', & & N(ng), DimIDs( 9)) IF (FoundError(exit_flag, NoError, 230, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 's_w', & & N(ng)+1, DimIDs(10)) IF (FoundError(exit_flag, NoError, 234, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'tracer', & & NT(ng), DimIDs(11)) IF (FoundError(exit_flag, NoError, 238, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'boundary',& & 4, DimIDs(14)) IF (FoundError(exit_flag, NoError, 281, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, 'Nstate', & & NstateVar(ng), DimIDs(29)) IF (FoundError(exit_flag, NoError, 286, MyFile)) RETURN status=def_dim(ng, iTLM, NRM(ifile,ng)%ncid, ncname, & & TRIM(ADJUSTL(Vname(5,idtime))), & & nf90_unlimited, DimIDs(12)) IF (FoundError(exit_flag, NoError, 292, 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. ! NRM(ifile,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, NRM(ifile,ng)%ncid, ncname, DimIDs) IF (FoundError(exit_flag, NoError, 402, MyFile)) RETURN ! !----------------------------------------------------------------------- ! Define background covariance normalization variables. !----------------------------------------------------------------------- ! ! 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, NRM(ifile,ng)%ncid, & & NRM(ifile,ng)%Vid(idtime), & & NF_TOUT, 1, (/recdim/), Aval, Vinfo, ncname, & & SetParAccess = .TRUE.) IF (FoundError(exit_flag, NoError, 420, MyFile)) RETURN ! !----------------------------------------------------------------------- ! Initial conditions or model error covariance normalization factors. !----------------------------------------------------------------------- ! IF ((ifile.eq.1).or.(ifile.eq.2)) THEN IF (ifile.eq.1) THEN Text='initial conditions error covariance normalization' ELSE IF (ifile.eq.2) THEN Text='model error covariance normalization' END IF ! ! Define free-surface normalization factor. ! Vinfo( 1)=Vname(1,idFsur) WRITE (Vinfo( 2),20) TRIM(Vname(2,idFsur)), TRIM(Text) Vinfo( 3)='nondimensional' Vinfo(14)=Vname(4,idFsur) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idFsur) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idFsur,ng),r8) status=def_var(ng, iTLM, NRM(ifile,ng)%ncid, & & NRM(ifile,ng)%Vid(idFsur), & & NF_FOUT, nvd3, t2dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 449, MyFile)) RETURN ! ! Define 2D U-momentum normalization factor. ! Vinfo( 1)=Vname(1,idUbar) WRITE (Vinfo( 2),20) TRIM(Vname(2,idUbar)), TRIM(Text) Vinfo( 3)='nondimensional' Vinfo(14)=Vname(4,idUbar) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idUbar) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idUbar,ng),r8) status=def_var(ng, iTLM, NRM(ifile,ng)%ncid, & & NRM(ifile,ng)%Vid(idUbar), & & NF_FOUT, nvd3, u2dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 467, MyFile)) RETURN ! ! Define 2D V-momentum normalization factor. ! Vinfo( 1)=Vname(1,idVbar) WRITE (Vinfo( 2),20) TRIM(Vname(2,idVbar)), TRIM(Text) Vinfo( 3)='nondimensional' Vinfo(14)=Vname(4,idVbar) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idVbar) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idVbar,ng),r8) status=def_var(ng, iTLM, NRM(ifile,ng)%ncid, & & NRM(ifile,ng)%Vid(idVbar), & & NF_FOUT, nvd3, v2dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 485, MyFile)) RETURN ! ! Define 3D U-momentum normalization factor. ! Vinfo( 1)=Vname(1,idUvel) WRITE (Vinfo( 2),20) TRIM(Vname(2,idUvel)), TRIM(Text) Vinfo( 3)='nondimensional' Vinfo(14)=Vname(4,idUvel) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idUvel) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idUvel,ng),r8) status=def_var(ng, iTLM, NRM(ifile,ng)%ncid, & & NRM(ifile,ng)%Vid(idUvel), & & NF_FOUT, nvd4, u3dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 505, MyFile)) RETURN ! ! Define 3D V-momentum normalization factor. ! Vinfo( 1)=Vname(1,idVvel) WRITE (Vinfo( 2),20) TRIM(Vname(2,idVvel)), TRIM(Text) Vinfo( 3)='nondimensional' Vinfo(14)=Vname(4,idVvel) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idVvel) Vinfo(22)='coordinates' Aval(5)=REAL(Iinfo(1,idVvel,ng),r8) status=def_var(ng, iTLM, NRM(ifile,ng)%ncid, & & NRM(ifile,ng)%Vid(idVvel), & & NF_FOUT, nvd4, v3dgrd, Aval, Vinfo, ncname) IF (FoundError(exit_flag, NoError, 523, MyFile)) RETURN ! ! Define tracer type normalization factors. ! DO itrc=1,NT(ng) Vinfo( 1)=Vname(1,idTvar(itrc)) WRITE (Vinfo( 2),20) TRIM(Vname(2,idTvar(itrc))), TRIM(Text) Vinfo( 3)='nondimensional' Vinfo(14)=Vname(4,idTvar(itrc)) Vinfo(16)=Vname(1,idtime) Vinfo(21)=Vname(6,idTvar(itrc)) Vinfo(22)='coordinates' Aval(5)=REAL(r3dvar,r8) status=def_var(ng, iTLM, NRM(ifile,ng)%ncid, & & NRM(ifile,ng)%Vid(idTvar(itrc)), & & NF_FOUT, nvd4, t3dgrd, Aval, Vinfo, ncname) END DO IF (FoundError(exit_flag, NoError, 550, MyFile)) RETURN END IF ! !----------------------------------------------------------------------- ! Leave definition mode. !----------------------------------------------------------------------- ! CALL netcdf_enddef (ng, model, ncname, NRM(ifile,ng)%ncid) IF (FoundError(exit_flag, NoError, 767, MyFile)) RETURN ! !----------------------------------------------------------------------- ! Write out time-recordless, information variables. Deactive file ! creation switch. !----------------------------------------------------------------------- ! CALL wrt_info (ng, model, NRM(ifile,ng)%ncid, ncname) IF (FoundError(exit_flag, NoError, 775, MyFile)) RETURN LdefNRM(ifile,ng)=.FALSE. END IF DEFINE ! !======================================================================= ! Open an existing normalization file, check its contents, and ! prepare for appending data. !======================================================================= ! QUERY : IF (.not.LdefNRM(ifile,ng)) THEN ncname=NRM(ifile,ng)%name ! ! Open normalization file for read/write. ! CALL netcdf_open (ng, model, ncname, 1, NRM(ifile,ng)%ncid) IF (FoundError(exit_flag, NoError, 790, MyFile)) THEN WRITE (stdout,40) TRIM(ncname) RETURN END IF ! ! Inquire about the dimensions and check for consistency. ! CALL netcdf_check_dim (ng, model, ncname, & & ncid = NRM(ifile,ng)%ncid) IF (FoundError(exit_flag, NoError, 799, MyFile)) RETURN ! ! Inquire about the variables. ! CALL netcdf_inq_var (ng, model, ncname, & & ncid = NRM(ifile,ng)%ncid) IF (FoundError(exit_flag, NoError, 805, 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 ! normalization variables. Get variable IDs. ! DO i=1,n_var IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idtime))) THEN got_var(idtime)=.TRUE. NRM(ifile,ng)%Vid(idtime)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idFsur))) THEN got_var(idFsur)=.TRUE. NRM(ifile,ng)%Vid(idFsur)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idUbar))) THEN got_var(idUbar)=.TRUE. NRM(ifile,ng)%Vid(idUbar)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idVbar))) THEN got_var(idVbar)=.TRUE. NRM(ifile,ng)%Vid(idVbar)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idUvel))) THEN got_var(idUvel)=.TRUE. NRM(ifile,ng)%Vid(idUvel)=var_id(i) ELSE IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idVvel))) THEN got_var(idVvel)=.TRUE. NRM(ifile,ng)%Vid(idVvel)=var_id(i) END IF DO itrc=1,NT(ng) IF (TRIM(var_name(i)).eq.TRIM(Vname(1,idTvar(itrc)))) THEN got_var(idTvar(itrc))=.TRUE. NRM(ifile,ng)%Vid(idTvar(itrc))=var_id(i) END IF END DO END DO ! ! Check if initialization 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(idFsur).and.(ifile.le.2)) THEN IF (Master) WRITE (stdout,50) TRIM(Vname(1,idFsur)), & & TRIM(ncname) exit_flag=3 RETURN END IF IF (.not.got_var(idUbar).and.(ifile.le.2)) THEN IF (Master) WRITE (stdout,50) TRIM(Vname(1,idUbar)), & & TRIM(ncname) exit_flag=3 RETURN END IF IF (.not.got_var(idVbar).and.(ifile.le.2)) THEN IF (Master) WRITE (stdout,50) TRIM(Vname(1,idVbar)), & & TRIM(ncname) exit_flag=3 RETURN END IF IF (.not.got_var(idUvel).and.(ifile.le.2)) THEN IF (Master) WRITE (stdout,50) TRIM(Vname(1,idUvel)), & & TRIM(ncname) exit_flag=3 RETURN END IF IF (.not.got_var(idVvel).and.(ifile.le.2)) THEN IF (Master) WRITE (stdout,50) TRIM(Vname(1,idVvel)), & & TRIM(ncname) exit_flag=3 RETURN END IF DO itrc=1,NT(ng) IF (.not.got_var(idTvar(itrc)).and.(ifile.le.2)) THEN IF (Master) WRITE (stdout,50) TRIM(Vname(1,idTvar(itrc))), & & TRIM(ncname) exit_flag=3 RETURN END IF END DO ! ! Set unlimited time record dimension to zero to allow other programs ! to process and write normalization factors for different variable. ! NRM(ifile,ng)%Rindex=0 END IF QUERY ! 10 FORMAT (/,' DEF_NORM_NF90 - unable to create norm NetCDF', & & ' file: ',a) 20 FORMAT (a,', ',a) 30 FORMAT (1pe11.4,1x,'millimeter') 40 FORMAT (/,' DEF_NORM_NF90 - unable to open norm NetCDF file: ',a) 50 FORMAT (/,' DEF_NORM_NF90 - unable to find variable: ',a,2x, & & ' in norm NetCDF file: ',a) ! RETURN END SUBROUTINE def_norm_nf90 END MODULE def_norm_mod