[544] | 1 | MODULE iom_nf90 |
---|
[9019] | 2 | !!====================================================================== |
---|
[544] | 3 | !! *** MODULE iom_nf90 *** |
---|
| 4 | !! Input/Output manager : Library to read input files with NF90 (only fliocom module) |
---|
[9019] | 5 | !!====================================================================== |
---|
[544] | 6 | !! History : 9.0 ! 05 12 (J. Belier) Original code |
---|
| 7 | !! 9.0 ! 06 02 (S. Masson) Adaptation to NEMO |
---|
[911] | 8 | !! " ! 07 07 (D. Storkey) Changes to iom_nf90_gettime |
---|
[7646] | 9 | !! 3.6 ! 2015-15 (J. Harle) Added procedure to read REAL attributes |
---|
[9019] | 10 | !! 4.0 ! 2017-11 (M. Andrejczuk) Extend IOM interface to write any 3D fields |
---|
| 11 | !!---------------------------------------------------------------------- |
---|
[544] | 12 | |
---|
[9019] | 13 | !!---------------------------------------------------------------------- |
---|
[544] | 14 | !! iom_open : open a file read only |
---|
| 15 | !! iom_close : close a file or all files opened by iom |
---|
| 16 | !! iom_get : read a field (interfaced to several routines) |
---|
| 17 | !! iom_varid : get the id of a variable in a file |
---|
| 18 | !! iom_rstput : write a field in a restart file (interfaced to several routines) |
---|
[9019] | 19 | !!---------------------------------------------------------------------- |
---|
[544] | 20 | USE dom_oce ! ocean space and time domain |
---|
[12649] | 21 | USE sbc_oce, ONLY: ght_abl ! abl vertical level number and height |
---|
[544] | 22 | USE lbclnk ! lateal boundary condition / mpp exchanges |
---|
[556] | 23 | USE iom_def ! iom variables definitions |
---|
[544] | 24 | USE netcdf ! NetCDF library |
---|
[2715] | 25 | USE in_out_manager ! I/O manager |
---|
| 26 | USE lib_mpp ! MPP library |
---|
[544] | 27 | |
---|
| 28 | IMPLICIT NONE |
---|
| 29 | PRIVATE |
---|
| 30 | |
---|
[10522] | 31 | PUBLIC iom_nf90_open , iom_nf90_close, iom_nf90_varid, iom_nf90_get, iom_nf90_rstput |
---|
[10425] | 32 | PUBLIC iom_nf90_chkatt, iom_nf90_getatt, iom_nf90_putatt |
---|
[13970] | 33 | PUBLIC iom_nf90_check |
---|
[544] | 34 | |
---|
| 35 | INTERFACE iom_nf90_get |
---|
[14072] | 36 | MODULE PROCEDURE iom_nf90_g0d_sp |
---|
[13226] | 37 | MODULE PROCEDURE iom_nf90_g0d_dp, iom_nf90_g123d_dp |
---|
[544] | 38 | END INTERFACE |
---|
| 39 | INTERFACE iom_nf90_rstput |
---|
[13226] | 40 | MODULE PROCEDURE iom_nf90_rp0123d_dp |
---|
[544] | 41 | END INTERFACE |
---|
[2528] | 42 | |
---|
[544] | 43 | !!---------------------------------------------------------------------- |
---|
[9598] | 44 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[1152] | 45 | !! $Id$ |
---|
[10068] | 46 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[544] | 47 | !!---------------------------------------------------------------------- |
---|
| 48 | CONTAINS |
---|
| 49 | |
---|
[13286] | 50 | SUBROUTINE iom_nf90_open( cdname, kiomid, ldwrt, ldok, kdlev, cdcomp ) |
---|
[544] | 51 | !!--------------------------------------------------------------------- |
---|
| 52 | !! *** SUBROUTINE iom_open *** |
---|
| 53 | !! |
---|
| 54 | !! ** Purpose : open an input file with NF90 |
---|
| 55 | !!--------------------------------------------------------------------- |
---|
[1488] | 56 | CHARACTER(len=*) , INTENT(inout) :: cdname ! File name |
---|
| 57 | INTEGER , INTENT( out) :: kiomid ! nf90 identifier of the opened file |
---|
| 58 | LOGICAL , INTENT(in ) :: ldwrt ! read or write the file? |
---|
[14072] | 59 | LOGICAL , INTENT(in ) :: ldok ! check the existence |
---|
[12377] | 60 | INTEGER , INTENT(in ), OPTIONAL :: kdlev ! size of the ice/abl third dimension |
---|
[12649] | 61 | CHARACTER(len=3) , INTENT(in ), OPTIONAL :: cdcomp ! name of component calling iom_nf90_open |
---|
[544] | 62 | |
---|
[5341] | 63 | CHARACTER(LEN=256) :: clinfo ! info character |
---|
| 64 | CHARACTER(LEN=256) :: cltmp ! temporary character |
---|
[12933] | 65 | CHARACTER(LEN=12 ) :: clfmt ! writing format |
---|
[12649] | 66 | CHARACTER(LEN=3 ) :: clcomp ! name of component calling iom_nf90_open |
---|
[12933] | 67 | INTEGER :: idg ! number of digits |
---|
[1488] | 68 | INTEGER :: iln ! lengths of character |
---|
| 69 | INTEGER :: istop ! temporary storage of nstop |
---|
| 70 | INTEGER :: if90id ! nf90 identifier of the opened file |
---|
| 71 | INTEGER :: idmy ! dummy variable |
---|
| 72 | INTEGER :: jl ! loop variable |
---|
| 73 | INTEGER :: ichunk ! temporary storage of nn_chunksz |
---|
[2528] | 74 | INTEGER :: imode ! creation mode flag: NF90_CLOBBER or NF90_NOCLOBBER or NF90_HDF5 |
---|
| 75 | INTEGER :: ihdf5 ! local variable for retrieval of value for NF90_HDF5 |
---|
[1488] | 76 | LOGICAL :: llclobber ! local definition of ln_clobber |
---|
[544] | 77 | !--------------------------------------------------------------------- |
---|
[9019] | 78 | ! |
---|
[544] | 79 | clinfo = ' iom_nf90_open ~~~ ' |
---|
[9019] | 80 | istop = nstop ! store the actual value of nstop |
---|
| 81 | ! |
---|
| 82 | ! !number of vertical levels |
---|
[12649] | 83 | IF( PRESENT(cdcomp) ) THEN |
---|
| 84 | IF( .NOT. PRESENT(kdlev) ) CALL ctl_stop( 'iom_nf90_open: cdcomp and kdlev must both be present' ) |
---|
| 85 | clcomp = cdcomp ! use input value |
---|
| 86 | ELSE |
---|
[14072] | 87 | clcomp = 'OCE' ! by default |
---|
[9019] | 88 | ENDIF |
---|
| 89 | ! |
---|
[1488] | 90 | IF( nn_chunksz > 0 ) THEN ; ichunk = nn_chunksz |
---|
| 91 | ELSE ; ichunk = NF90_SIZEHINT_DEFAULT |
---|
| 92 | ENDIF |
---|
[544] | 93 | ! |
---|
[1488] | 94 | llclobber = ldwrt .AND. ln_clobber |
---|
[9019] | 95 | IF( ldok .AND. .NOT. llclobber ) THEN !== Open existing file ==! |
---|
| 96 | ! !=========================! |
---|
[544] | 97 | IF( ldwrt ) THEN ! ... in write mode |
---|
| 98 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' open existing file: '//TRIM(cdname)//' in WRITE mode' |
---|
[2528] | 99 | IF( snc4set%luse ) THEN |
---|
| 100 | CALL iom_nf90_check(NF90_OPEN( TRIM(cdname), NF90_WRITE , if90id ), clinfo) |
---|
| 101 | ELSE |
---|
| 102 | CALL iom_nf90_check(NF90_OPEN( TRIM(cdname), NF90_WRITE , if90id, chunksize = ichunk ), clinfo) |
---|
| 103 | ENDIF |
---|
[1488] | 104 | CALL iom_nf90_check(NF90_SET_FILL( if90id, NF90_NOFILL, idmy ), clinfo) |
---|
[544] | 105 | ELSE ! ... in read mode |
---|
| 106 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' open existing file: '//TRIM(cdname)//' in READ mode' |
---|
[1488] | 107 | CALL iom_nf90_check(NF90_OPEN( TRIM(cdname), NF90_NOWRITE, if90id, chunksize = ichunk ), clinfo) |
---|
[544] | 108 | ENDIF |
---|
[9019] | 109 | ELSE !== the file doesn't exist ==! (or we overwrite it) |
---|
| 110 | ! !============================! |
---|
[544] | 111 | iln = INDEX( cdname, '.nc' ) |
---|
[9019] | 112 | IF( ldwrt ) THEN !* the file should be open in write mode so we create it... |
---|
[550] | 113 | IF( jpnij > 1 ) THEN |
---|
[13009] | 114 | idg = MAX( INT(LOG10(REAL(MAX(1,jpnij-1),wp))) + 1, 4 ) ! how many digits to we need to write? min=4, max=9 |
---|
| 115 | WRITE(clfmt, "('(a,a,i', i1, '.', i1, ',a)')") idg, idg ! '(a,a,ix.x,a)' |
---|
[12933] | 116 | WRITE(cltmp,clfmt) cdname(1:iln-1), '_', narea-1, '.nc' |
---|
[550] | 117 | cdname = TRIM(cltmp) |
---|
| 118 | ENDIF |
---|
[544] | 119 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' create new file: '//TRIM(cdname)//' in WRITE mode' |
---|
[1488] | 120 | |
---|
[2172] | 121 | IF( llclobber ) THEN ; imode = IOR( NF90_64BIT_OFFSET, NF90_CLOBBER ) |
---|
[14072] | 122 | ELSE ; imode = IOR( NF90_64BIT_OFFSET, NF90_NOCLOBBER ) |
---|
[1488] | 123 | ENDIF |
---|
[2528] | 124 | IF( snc4set%luse ) THEN |
---|
| 125 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' creating file: '//TRIM(cdname)//' in hdf5 (netcdf4) mode' |
---|
| 126 | CALL GET_NF90_SYMBOL("NF90_HDF5", ihdf5) |
---|
| 127 | IF( llclobber ) THEN ; imode = IOR(ihdf5, NF90_CLOBBER) |
---|
| 128 | ELSE ; imode = IOR(ihdf5, NF90_NOCLOBBER) |
---|
| 129 | ENDIF |
---|
| 130 | CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), imode, if90id ), clinfo) |
---|
| 131 | ELSE |
---|
| 132 | CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), imode, if90id, chunksize = ichunk ), clinfo) |
---|
| 133 | ENDIF |
---|
[10425] | 134 | CALL iom_nf90_check(NF90_SET_FILL( if90id, NF90_NOFILL, idmy ), clinfo) |
---|
[544] | 135 | ! define dimensions |
---|
[13286] | 136 | CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'x', Ni_0, idmy ), clinfo) |
---|
| 137 | CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'y', Nj_0, idmy ), clinfo) |
---|
[12649] | 138 | SELECT CASE (clcomp) |
---|
[13286] | 139 | CASE ('OCE') ; CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'nav_lev', jpk, idmy ), clinfo) |
---|
| 140 | CASE ('ICE') ; CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'numcat', kdlev, idmy ), clinfo) |
---|
| 141 | CASE ('ABL') ; CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'nav_lev', kdlev, idmy ), clinfo) |
---|
| 142 | CASE ('SED') ; CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'numsed', kdlev, idmy ), clinfo) |
---|
[12649] | 143 | CASE DEFAULT ; CALL ctl_stop( 'iom_nf90_open unknown component type' ) |
---|
| 144 | END SELECT |
---|
| 145 | CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'time_counter', NF90_UNLIMITED, idmy ), clinfo) |
---|
[544] | 146 | ! global attributes |
---|
[13286] | 147 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_number_total' , jpnij ), clinfo) |
---|
| 148 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_number' , narea-1 ), clinfo) |
---|
| 149 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_dimensions_ids' , (/ 1 , 2 /) ), clinfo) |
---|
| 150 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_size_global' , (/ Ni0glo , Nj0glo /) ), clinfo) |
---|
| 151 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_size_local' , (/ Ni_0 , Nj_0 /) ), clinfo) |
---|
| 152 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_position_first' , (/ mig0(Nis0), mjg0(Njs0) /) ), clinfo) |
---|
| 153 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_position_last' , (/ mig0(Nie0), mjg0(Nje0) /) ), clinfo) |
---|
| 154 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_halo_size_start', (/ 0 , 0 /) ), clinfo) |
---|
| 155 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_halo_size_end' , (/ 0 , 0 /) ), clinfo) |
---|
| 156 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_type' , 'BOX' ), clinfo) |
---|
[9019] | 157 | ELSE !* the file should be open for read mode so it must exist... |
---|
[679] | 158 | CALL ctl_stop( TRIM(clinfo), ' should be impossible case...' ) |
---|
[544] | 159 | ENDIF |
---|
| 160 | ENDIF |
---|
[9019] | 161 | ! |
---|
[544] | 162 | ! start to fill file informations |
---|
| 163 | ! ============= |
---|
| 164 | IF( istop == nstop ) THEN ! no error within this routine |
---|
[588] | 165 | !does not work with some compilers kiomid = MINLOC(iom_file(:)%nfid, dim = 1) |
---|
| 166 | kiomid = 0 |
---|
| 167 | DO jl = jpmax_files, 1, -1 |
---|
| 168 | IF( iom_file(jl)%nfid == 0 ) kiomid = jl |
---|
| 169 | ENDDO |
---|
[544] | 170 | iom_file(kiomid)%name = TRIM(cdname) |
---|
[12649] | 171 | iom_file(kiomid)%comp = clcomp |
---|
[544] | 172 | iom_file(kiomid)%nfid = if90id |
---|
| 173 | iom_file(kiomid)%nvars = 0 |
---|
[14072] | 174 | iom_file(kiomid)%irec = -1 ! useless for NetCDF files, used to know if the file is in define mode |
---|
[544] | 175 | CALL iom_nf90_check(NF90_Inquire(if90id, unlimitedDimId = iom_file(kiomid)%iduld), clinfo) |
---|
[9019] | 176 | IF( iom_file(kiomid)%iduld .GE. 0 ) THEN |
---|
[14072] | 177 | CALL iom_nf90_check(NF90_Inquire_Dimension(if90id, iom_file(kiomid)%iduld, & |
---|
[9019] | 178 | & name = iom_file(kiomid)%uldname, & |
---|
| 179 | & len = iom_file(kiomid)%lenuld ), clinfo ) |
---|
[911] | 180 | ENDIF |
---|
[544] | 181 | IF(lwp) WRITE(numout,*) ' ---> '//TRIM(cdname)//' OK' |
---|
| 182 | ELSE |
---|
| 183 | kiomid = 0 ! return error flag |
---|
| 184 | ENDIF |
---|
| 185 | ! |
---|
| 186 | END SUBROUTINE iom_nf90_open |
---|
| 187 | |
---|
| 188 | |
---|
| 189 | SUBROUTINE iom_nf90_close( kiomid ) |
---|
| 190 | !!-------------------------------------------------------------------- |
---|
| 191 | !! *** SUBROUTINE iom_nf90_close *** |
---|
| 192 | !! |
---|
| 193 | !! ** Purpose : close an input file with NF90 |
---|
| 194 | !!-------------------------------------------------------------------- |
---|
| 195 | INTEGER, INTENT(in) :: kiomid ! iom identifier of the file to be closed |
---|
| 196 | CHARACTER(LEN=100) :: clinfo ! info character |
---|
| 197 | !--------------------------------------------------------------------- |
---|
| 198 | clinfo = ' iom_nf90_close , file: '//TRIM(iom_file(kiomid)%name) |
---|
| 199 | CALL iom_nf90_check(NF90_CLOSE(iom_file(kiomid)%nfid), clinfo) |
---|
| 200 | END SUBROUTINE iom_nf90_close |
---|
| 201 | |
---|
| 202 | |
---|
[14072] | 203 | FUNCTION iom_nf90_varid ( kiomid, cdvar, kiv, kdimsz, kndims, lduld ) |
---|
[544] | 204 | !!----------------------------------------------------------------------- |
---|
| 205 | !! *** FUNCTION iom_varid *** |
---|
| 206 | !! |
---|
| 207 | !! ** Purpose : get the id of a variable in a file with NF90 |
---|
| 208 | !!----------------------------------------------------------------------- |
---|
| 209 | INTEGER , INTENT(in ) :: kiomid ! file Identifier |
---|
| 210 | CHARACTER(len=*) , INTENT(in ) :: cdvar ! name of the variable |
---|
[14072] | 211 | INTEGER , INTENT(in ) :: kiv ! |
---|
[12377] | 212 | INTEGER, DIMENSION(:), INTENT( out), OPTIONAL :: kdimsz ! size of each dimension |
---|
| 213 | INTEGER , INTENT( out), OPTIONAL :: kndims ! number of dimensions |
---|
[11536] | 214 | LOGICAL , INTENT( out), OPTIONAL :: lduld ! true if the last dimension is unlimited (time) |
---|
[544] | 215 | ! |
---|
| 216 | INTEGER :: iom_nf90_varid ! iom variable Id |
---|
| 217 | INTEGER :: if90id ! nf90 file identifier |
---|
| 218 | INTEGER :: ji ! dummy loop index |
---|
| 219 | INTEGER :: ivarid ! NetCDF variable Id |
---|
| 220 | INTEGER :: i_nvd ! number of dimension of the variable |
---|
| 221 | INTEGER, DIMENSION(jpmax_dims) :: idimid ! dimension ids of the variable |
---|
| 222 | LOGICAL :: llok ! ok test |
---|
| 223 | CHARACTER(LEN=100) :: clinfo ! info character |
---|
| 224 | !!----------------------------------------------------------------------- |
---|
| 225 | clinfo = ' iom_nf90_varid, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(cdvar) |
---|
| 226 | iom_nf90_varid = 0 ! default definition |
---|
| 227 | IF( PRESENT(kdimsz) ) kdimsz(:) = 0 ! default definition |
---|
| 228 | if90id = iom_file(kiomid)%nfid ! get back NetCDF file id |
---|
| 229 | ! |
---|
| 230 | llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr ! does the variable exist in the file |
---|
| 231 | IF( llok ) THEN |
---|
| 232 | iom_nf90_varid = kiv |
---|
| 233 | iom_file(kiomid)%nvars = kiv |
---|
| 234 | iom_file(kiomid)%nvid(kiv) = ivarid |
---|
| 235 | iom_file(kiomid)%cn_var(kiv) = TRIM(cdvar) |
---|
| 236 | CALL iom_nf90_check(NF90_Inquire_Variable(if90id, ivarid, ndims = i_nvd), clinfo) ! number of dimensions |
---|
| 237 | iom_file(kiomid)%ndims(kiv) = i_nvd |
---|
| 238 | CALL iom_nf90_check(NF90_Inquire_Variable(if90id, ivarid, dimids = idimid(1:i_nvd)), clinfo) ! dimensions ids |
---|
[588] | 239 | iom_file(kiomid)%luld(kiv) = .FALSE. ! default value |
---|
[4689] | 240 | iom_file(kiomid)%dimsz(:,kiv) = 0 ! reset dimsz in case previously used |
---|
[588] | 241 | DO ji = 1, i_nvd ! dimensions size |
---|
[14072] | 242 | CALL iom_nf90_check(NF90_Inquire_Dimension(if90id, idimid(ji), len = iom_file(kiomid)%dimsz(ji,kiv)), clinfo) |
---|
| 243 | IF( idimid(ji) == iom_file(kiomid)%iduld ) iom_file(kiomid)%luld(kiv) = .TRUE. ! unlimited dimension? |
---|
[544] | 244 | END DO |
---|
[588] | 245 | !---------- Deal with scale_factor and add_offset |
---|
[544] | 246 | llok = NF90_Inquire_attribute(if90id, ivarid, 'scale_factor') == nf90_noerr |
---|
| 247 | IF( llok) THEN |
---|
| 248 | CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, 'scale_factor', iom_file(kiomid)%scf(kiv)), clinfo) |
---|
| 249 | ELSE |
---|
| 250 | iom_file(kiomid)%scf(kiv) = 1. |
---|
| 251 | END IF |
---|
[588] | 252 | llok = NF90_Inquire_attribute(if90id, ivarid, 'add_offset') == nf90_noerr |
---|
[544] | 253 | IF( llok ) THEN |
---|
[588] | 254 | CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, 'add_offset', iom_file(kiomid)%ofs(kiv)), clinfo) |
---|
[544] | 255 | ELSE |
---|
| 256 | iom_file(kiomid)%ofs(kiv) = 0. |
---|
| 257 | END IF |
---|
| 258 | ! return the simension size |
---|
[14072] | 259 | IF( PRESENT(kdimsz) ) THEN |
---|
[9540] | 260 | IF( i_nvd <= SIZE(kdimsz) ) THEN |
---|
| 261 | kdimsz(1:i_nvd) = iom_file(kiomid)%dimsz(1:i_nvd,kiv) |
---|
[544] | 262 | ELSE |
---|
| 263 | WRITE(ctmp1,*) i_nvd, SIZE(kdimsz) |
---|
| 264 | CALL ctl_stop( TRIM(clinfo), 'error in kdimsz size'//TRIM(ctmp1) ) |
---|
| 265 | ENDIF |
---|
| 266 | ENDIF |
---|
[4161] | 267 | IF( PRESENT(kndims) ) kndims = iom_file(kiomid)%ndims(kiv) |
---|
[11536] | 268 | IF( PRESENT( lduld) ) lduld = iom_file(kiomid)%luld(kiv) |
---|
[14072] | 269 | ELSE |
---|
[745] | 270 | iom_nf90_varid = -1 ! variable not found, return error code: -1 |
---|
[544] | 271 | ENDIF |
---|
| 272 | ! |
---|
| 273 | END FUNCTION iom_nf90_varid |
---|
| 274 | |
---|
[7646] | 275 | !!---------------------------------------------------------------------- |
---|
| 276 | !! INTERFACE iom_nf90_get |
---|
| 277 | !!---------------------------------------------------------------------- |
---|
[544] | 278 | |
---|
[13226] | 279 | SUBROUTINE iom_nf90_g0d_sp( kiomid, kvid, pvar, kstart ) |
---|
[544] | 280 | !!----------------------------------------------------------------------- |
---|
[550] | 281 | !! *** ROUTINE iom_nf90_g0d *** |
---|
[544] | 282 | !! |
---|
| 283 | !! ** Purpose : read a scalar with NF90 |
---|
| 284 | !!----------------------------------------------------------------------- |
---|
[4245] | 285 | INTEGER , INTENT(in ) :: kiomid ! Identifier of the file |
---|
| 286 | INTEGER , INTENT(in ) :: kvid ! variable id |
---|
[13226] | 287 | REAL(sp), INTENT( out) :: pvar ! read field |
---|
[4245] | 288 | INTEGER , DIMENSION(1), INTENT(in ), OPTIONAL :: kstart ! start position of the reading in each axis |
---|
[544] | 289 | ! |
---|
| 290 | CHARACTER(LEN=100) :: clinfo ! info character |
---|
| 291 | !--------------------------------------------------------------------- |
---|
[550] | 292 | clinfo = 'iom_nf90_g0d , file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid)) |
---|
[4245] | 293 | CALL iom_nf90_check(NF90_GET_VAR(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), pvar, start = kstart), clinfo ) |
---|
[13226] | 294 | END SUBROUTINE iom_nf90_g0d_sp |
---|
[544] | 295 | |
---|
[13226] | 296 | SUBROUTINE iom_nf90_g0d_dp( kiomid, kvid, pvar, kstart ) |
---|
| 297 | !!----------------------------------------------------------------------- |
---|
| 298 | !! *** ROUTINE iom_nf90_g0d *** |
---|
| 299 | !! |
---|
| 300 | !! ** Purpose : read a scalar with NF90 |
---|
| 301 | !!----------------------------------------------------------------------- |
---|
| 302 | INTEGER , INTENT(in ) :: kiomid ! Identifier of the file |
---|
| 303 | INTEGER , INTENT(in ) :: kvid ! variable id |
---|
| 304 | REAL(dp), INTENT( out) :: pvar ! read field |
---|
| 305 | INTEGER , DIMENSION(1), INTENT(in ), OPTIONAL :: kstart ! start position of the reading in each axis |
---|
| 306 | ! |
---|
| 307 | CHARACTER(LEN=100) :: clinfo ! info character |
---|
| 308 | !--------------------------------------------------------------------- |
---|
| 309 | clinfo = 'iom_nf90_g0d , file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid)) |
---|
| 310 | CALL iom_nf90_check(NF90_GET_VAR(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), pvar, start = kstart), clinfo ) |
---|
| 311 | END SUBROUTINE iom_nf90_g0d_dp |
---|
[544] | 312 | |
---|
[13226] | 313 | SUBROUTINE iom_nf90_g123d_dp( kiomid, kvid, knbdim, kstart, kcount, kx1, kx2, ky1, ky2, & |
---|
[679] | 314 | & pv_r1d, pv_r2d, pv_r3d ) |
---|
[544] | 315 | !!----------------------------------------------------------------------- |
---|
[550] | 316 | !! *** ROUTINE iom_nf90_g123d *** |
---|
[544] | 317 | !! |
---|
| 318 | !! ** Purpose : read a 1D/2D/3D variable with NF90 |
---|
| 319 | !! |
---|
| 320 | !! ** Method : read ONE record at each CALL |
---|
| 321 | !!----------------------------------------------------------------------- |
---|
| 322 | INTEGER , INTENT(in ) :: kiomid ! iom identifier of the file |
---|
| 323 | INTEGER , INTENT(in ) :: kvid ! Name of the variable |
---|
| 324 | INTEGER , INTENT(in ) :: knbdim ! number of dimensions of the variable |
---|
[14072] | 325 | INTEGER , DIMENSION(:) , INTENT(in ) :: kstart ! start position of the reading in each axis |
---|
[544] | 326 | INTEGER , DIMENSION(:) , INTENT(in ) :: kcount ! number of points to be read in each axis |
---|
[679] | 327 | INTEGER , INTENT(in ) :: kx1, kx2, ky1, ky2 ! subdomain indexes |
---|
[13226] | 328 | REAL(dp), DIMENSION(:) , INTENT( out), OPTIONAL :: pv_r1d ! read field (1D case) |
---|
| 329 | REAL(dp), DIMENSION(:,:) , INTENT( out), OPTIONAL :: pv_r2d ! read field (2D case) |
---|
| 330 | REAL(dp), DIMENSION(:,:,:) , INTENT( out), OPTIONAL :: pv_r3d ! read field (3D case) |
---|
[544] | 331 | ! |
---|
[679] | 332 | CHARACTER(LEN=100) :: clinfo ! info character |
---|
| 333 | INTEGER :: if90id ! nf90 identifier of the opened file |
---|
| 334 | INTEGER :: ivid ! nf90 variable id |
---|
[544] | 335 | !--------------------------------------------------------------------- |
---|
[550] | 336 | clinfo = 'iom_nf90_g123d , file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid)) |
---|
[544] | 337 | if90id = iom_file(kiomid)%nfid ! get back NetCDF file id |
---|
| 338 | ivid = iom_file(kiomid)%nvid(kvid) ! get back NetCDF var id |
---|
[679] | 339 | ! |
---|
| 340 | IF( PRESENT(pv_r1d) ) THEN |
---|
| 341 | CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r1d(: ), start = kstart(1:knbdim), & |
---|
| 342 | & count = kcount(1:knbdim)), clinfo ) |
---|
[544] | 343 | ELSEIF( PRESENT(pv_r2d) ) THEN |
---|
[679] | 344 | CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r2d(kx1:kx2,ky1:ky2 ), start = kstart(1:knbdim), & |
---|
| 345 | & count = kcount(1:knbdim)), clinfo ) |
---|
[544] | 346 | ELSEIF( PRESENT(pv_r3d) ) THEN |
---|
[679] | 347 | CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r3d(kx1:kx2,ky1:ky2,:), start = kstart(1:knbdim), & |
---|
| 348 | & count = kcount(1:knbdim)), clinfo ) |
---|
[544] | 349 | ENDIF |
---|
| 350 | ! |
---|
[13226] | 351 | END SUBROUTINE iom_nf90_g123d_dp |
---|
[544] | 352 | |
---|
| 353 | |
---|
[13226] | 354 | |
---|
[10425] | 355 | SUBROUTINE iom_nf90_chkatt( kiomid, cdatt, llok, ksize, cdvar ) |
---|
[2528] | 356 | !!----------------------------------------------------------------------- |
---|
[10425] | 357 | !! *** ROUTINE iom_nf90_chkatt *** |
---|
[2528] | 358 | !! |
---|
[10425] | 359 | !! ** Purpose : check existence of attribute with NF90 |
---|
[7646] | 360 | !! (either a global attribute (default) or a variable |
---|
| 361 | !! attribute if optional variable name is supplied (cdvar)) |
---|
[2528] | 362 | !!----------------------------------------------------------------------- |
---|
| 363 | INTEGER , INTENT(in ) :: kiomid ! Identifier of the file |
---|
| 364 | CHARACTER(len=*), INTENT(in ) :: cdatt ! attribute name |
---|
[10425] | 365 | LOGICAL , INTENT( out) :: llok ! error code |
---|
| 366 | INTEGER , INTENT( out), OPTIONAL & |
---|
| 367 | & :: ksize ! attribute size |
---|
[7646] | 368 | CHARACTER(len=*), INTENT(in ), OPTIONAL & |
---|
| 369 | & :: cdvar ! name of the variable |
---|
[2528] | 370 | ! |
---|
| 371 | INTEGER :: if90id ! temporary integer |
---|
[10425] | 372 | INTEGER :: isize ! temporary integer |
---|
[7646] | 373 | INTEGER :: ivarid ! NetCDF variable Id |
---|
[2528] | 374 | !--------------------------------------------------------------------- |
---|
[7646] | 375 | ! |
---|
[2528] | 376 | if90id = iom_file(kiomid)%nfid |
---|
[7646] | 377 | IF( PRESENT(cdvar) ) THEN |
---|
| 378 | ! check the variable exists in the file |
---|
| 379 | llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr |
---|
[10425] | 380 | IF( llok ) & |
---|
[7646] | 381 | ! check the variable has the attribute required |
---|
[10425] | 382 | llok = NF90_Inquire_attribute(if90id, ivarid, cdatt, len=isize ) == nf90_noerr |
---|
[7646] | 383 | ELSE |
---|
[10425] | 384 | llok = NF90_Inquire_attribute(if90id, NF90_GLOBAL, cdatt, len=isize ) == nf90_noerr |
---|
[7646] | 385 | ENDIF |
---|
[9019] | 386 | ! |
---|
[10425] | 387 | IF( PRESENT(ksize) ) ksize = isize |
---|
[7646] | 388 | ! |
---|
[10425] | 389 | IF( .not. llok) & |
---|
| 390 | CALL ctl_warn('iom_nf90_chkatt: no attribute '//cdatt//' found') |
---|
| 391 | ! |
---|
| 392 | END SUBROUTINE iom_nf90_chkatt |
---|
[2528] | 393 | |
---|
[9019] | 394 | |
---|
[10425] | 395 | !!---------------------------------------------------------------------- |
---|
| 396 | !! INTERFACE iom_nf90_getatt |
---|
| 397 | !!---------------------------------------------------------------------- |
---|
| 398 | |
---|
| 399 | SUBROUTINE iom_nf90_getatt( kiomid, cdatt, katt0d, katt1d, patt0d, patt1d, cdatt0d, cdvar) |
---|
[7646] | 400 | !!----------------------------------------------------------------------- |
---|
[10425] | 401 | !! *** ROUTINE iom_nf90_getatt *** |
---|
[7646] | 402 | !! |
---|
[10425] | 403 | !! ** Purpose : read an attribute with NF90 |
---|
[7646] | 404 | !! (either a global attribute (default) or a variable |
---|
| 405 | !! attribute if optional variable name is supplied (cdvar)) |
---|
| 406 | !!----------------------------------------------------------------------- |
---|
[10425] | 407 | INTEGER , INTENT(in ) :: kiomid ! Identifier of the file |
---|
| 408 | CHARACTER(len=*) , INTENT(in ) :: cdatt ! attribute name |
---|
| 409 | INTEGER , INTENT( out), OPTIONAL :: katt0d ! read scalar integer |
---|
| 410 | INTEGER, DIMENSION(:) , INTENT( out), OPTIONAL :: katt1d ! read 1d array integer |
---|
| 411 | REAL(wp) , INTENT( out), OPTIONAL :: patt0d ! read scalar real |
---|
| 412 | REAL(wp), DIMENSION(:), INTENT( out), OPTIONAL :: patt1d ! read 1d array real |
---|
| 413 | CHARACTER(len=*) , INTENT( out), OPTIONAL :: cdatt0d ! read character |
---|
| 414 | CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! name of the variable |
---|
[7646] | 415 | ! |
---|
[10425] | 416 | INTEGER :: if90id ! temporary integer |
---|
| 417 | INTEGER :: ivarid ! NetCDF variable Id |
---|
| 418 | LOGICAL :: llok ! temporary logical |
---|
| 419 | CHARACTER(LEN=100) :: clinfo ! info character |
---|
[7646] | 420 | !--------------------------------------------------------------------- |
---|
| 421 | ! |
---|
| 422 | if90id = iom_file(kiomid)%nfid |
---|
| 423 | IF( PRESENT(cdvar) ) THEN |
---|
| 424 | ! check the variable exists in the file |
---|
| 425 | llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr |
---|
| 426 | IF( llok ) THEN |
---|
| 427 | ! check the variable has the attribute required |
---|
| 428 | llok = NF90_Inquire_attribute(if90id, ivarid, cdatt) == nf90_noerr |
---|
| 429 | ELSE |
---|
[10425] | 430 | CALL ctl_warn('iom_nf90_getatt: no variable '//TRIM(cdvar)//' found') |
---|
[7646] | 431 | ENDIF |
---|
| 432 | ELSE |
---|
| 433 | llok = NF90_Inquire_attribute(if90id, NF90_GLOBAL, cdatt) == nf90_noerr |
---|
| 434 | ivarid = NF90_GLOBAL |
---|
| 435 | ENDIF |
---|
[9019] | 436 | ! |
---|
[7646] | 437 | IF( llok) THEN |
---|
[10425] | 438 | clinfo = 'iom_nf90_getatt, file: '//TRIM(iom_file(kiomid)%name)//', att: '//TRIM(cdatt) |
---|
| 439 | IF(PRESENT( katt0d)) CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values = katt0d), clinfo) |
---|
| 440 | IF(PRESENT( katt1d)) CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values = katt1d), clinfo) |
---|
| 441 | IF(PRESENT( patt0d)) CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values = patt0d), clinfo) |
---|
| 442 | IF(PRESENT( patt1d)) CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values = patt1d), clinfo) |
---|
| 443 | IF(PRESENT(cdatt0d)) CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, cdatt, values = cdatt0d), clinfo) |
---|
[7646] | 444 | ELSE |
---|
[10425] | 445 | IF(PRESENT( katt0d)) katt0d = -999 |
---|
| 446 | IF(PRESENT( katt1d)) katt1d(:) = -999 |
---|
| 447 | IF(PRESENT( patt0d)) patt0d = -999._wp |
---|
| 448 | IF(PRESENT( patt1d)) patt1d(:) = -999._wp |
---|
[14433] | 449 | IF(PRESENT(cdatt0d)) cdatt0d = 'UNKNOWN' |
---|
[7646] | 450 | ENDIF |
---|
| 451 | ! |
---|
[10425] | 452 | END SUBROUTINE iom_nf90_getatt |
---|
[2528] | 453 | |
---|
[9019] | 454 | |
---|
[10425] | 455 | SUBROUTINE iom_nf90_putatt( kiomid, cdatt, katt0d, katt1d, patt0d, patt1d, cdatt0d, cdvar) |
---|
[7646] | 456 | !!----------------------------------------------------------------------- |
---|
[10425] | 457 | !! *** ROUTINE iom_nf90_putatt *** |
---|
[7646] | 458 | !! |
---|
[10425] | 459 | !! ** Purpose : write an attribute with NF90 |
---|
[7646] | 460 | !! (either a global attribute (default) or a variable |
---|
| 461 | !! attribute if optional variable name is supplied (cdvar)) |
---|
| 462 | !!----------------------------------------------------------------------- |
---|
[10425] | 463 | INTEGER , INTENT(in ) :: kiomid ! Identifier of the file |
---|
| 464 | CHARACTER(len=*) , INTENT(in ) :: cdatt ! attribute name |
---|
| 465 | INTEGER , INTENT(in ), OPTIONAL :: katt0d ! read scalar integer |
---|
| 466 | INTEGER, DIMENSION(:) , INTENT(in ), OPTIONAL :: katt1d ! read 1d array integer |
---|
| 467 | REAL(wp) , INTENT(in ), OPTIONAL :: patt0d ! read scalar real |
---|
| 468 | REAL(wp), DIMENSION(:), INTENT(in ), OPTIONAL :: patt1d ! read 1d array real |
---|
| 469 | CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdatt0d ! read character |
---|
| 470 | CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! name of the variable |
---|
[7646] | 471 | ! |
---|
| 472 | INTEGER :: if90id ! temporary integer |
---|
| 473 | INTEGER :: ivarid ! NetCDF variable Id |
---|
[10425] | 474 | INTEGER :: isize ! Attribute size |
---|
| 475 | INTEGER :: itype ! Attribute type |
---|
[7646] | 476 | LOGICAL :: llok ! temporary logical |
---|
[10425] | 477 | LOGICAL :: llatt ! temporary logical |
---|
| 478 | LOGICAL :: lldata ! temporary logical |
---|
[7646] | 479 | CHARACTER(LEN=100) :: clinfo ! info character |
---|
| 480 | !--------------------------------------------------------------------- |
---|
| 481 | ! |
---|
| 482 | if90id = iom_file(kiomid)%nfid |
---|
| 483 | IF( PRESENT(cdvar) ) THEN |
---|
[10425] | 484 | llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr ! is the variable in the file? |
---|
[7646] | 485 | IF( .NOT. llok ) THEN |
---|
[10425] | 486 | CALL ctl_warn('iom_nf90_putatt: no variable '//TRIM(cdvar)//' found' & |
---|
| 487 | & , ' no attribute '//cdatt//' written' ) |
---|
| 488 | RETURN |
---|
[7646] | 489 | ENDIF |
---|
| 490 | ELSE |
---|
| 491 | ivarid = NF90_GLOBAL |
---|
| 492 | ENDIF |
---|
[10425] | 493 | llatt = NF90_Inquire_attribute(if90id, ivarid, cdatt, len = isize, xtype = itype ) == nf90_noerr |
---|
[9019] | 494 | ! |
---|
[10425] | 495 | ! trick: irec used to know if the file is in define mode or not |
---|
| 496 | lldata = iom_file(kiomid)%irec /= -1 ! default: go back in define mode if in data mode |
---|
| 497 | IF( lldata .AND. llatt ) THEN ! attribute already there. Do we really need to go back in define mode? |
---|
| 498 | ! do we have the appropriate type? |
---|
| 499 | IF(PRESENT( katt0d) .OR. PRESENT( katt1d)) llok = itype == NF90_INT |
---|
| 500 | IF(PRESENT( patt0d) .OR. PRESENT( patt1d)) llok = itype == NF90_DOUBLE |
---|
| 501 | IF(PRESENT(cdatt0d) ) llok = itype == NF90_CHAR |
---|
| 502 | ! and do we have the appropriate size? |
---|
| 503 | IF(PRESENT( katt0d)) llok = llok .AND. isize == 1 |
---|
| 504 | IF(PRESENT( katt1d)) llok = llok .AND. isize == SIZE(katt1d) |
---|
| 505 | IF(PRESENT( patt0d)) llok = llok .AND. isize == 1 |
---|
| 506 | IF(PRESENT( patt1d)) llok = llok .AND. isize == SIZE(patt1d) |
---|
| 507 | IF(PRESENT(cdatt0d)) llok = llok .AND. isize == LEN_TRIM(cdatt0d) |
---|
[7646] | 508 | ! |
---|
[10425] | 509 | lldata = .NOT. llok |
---|
[7646] | 510 | ENDIF |
---|
| 511 | ! |
---|
[10425] | 512 | clinfo = 'iom_nf90_putatt, file: '//TRIM(iom_file(kiomid)%name)//', att: '//TRIM(cdatt) |
---|
| 513 | IF(lldata) CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo) ! leave data mode to define mode |
---|
[7646] | 514 | ! |
---|
[10425] | 515 | IF(PRESENT( katt0d)) CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values = katt0d) , clinfo) |
---|
| 516 | IF(PRESENT( katt1d)) CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values = katt1d) , clinfo) |
---|
| 517 | IF(PRESENT( patt0d)) CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values = patt0d) , clinfo) |
---|
| 518 | IF(PRESENT( patt1d)) CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values = patt1d) , clinfo) |
---|
| 519 | IF(PRESENT(cdatt0d)) CALL iom_nf90_check(NF90_PUT_ATT(if90id, ivarid, cdatt, values = trim(cdatt0d)), clinfo) |
---|
[7646] | 520 | ! |
---|
[10425] | 521 | IF(lldata) CALL iom_nf90_check(NF90_ENDDEF( if90id ), clinfo) ! leave define mode to data mode |
---|
[9019] | 522 | ! |
---|
[10425] | 523 | END SUBROUTINE iom_nf90_putatt |
---|
[7646] | 524 | |
---|
[13226] | 525 | SUBROUTINE iom_nf90_rp0123d_dp( kt, kwrite, kiomid, cdvar , kvid , ktype, & |
---|
[9019] | 526 | & pv_r0d, pv_r1d, pv_r2d, pv_r3d ) |
---|
[544] | 527 | !!-------------------------------------------------------------------- |
---|
| 528 | !! *** SUBROUTINE iom_nf90_rstput *** |
---|
| 529 | !! |
---|
[14072] | 530 | !! ** Purpose : read the time axis cdvar in the file |
---|
[544] | 531 | !!-------------------------------------------------------------------- |
---|
[1271] | 532 | INTEGER , INTENT(in) :: kt ! ocean time-step |
---|
| 533 | INTEGER , INTENT(in) :: kwrite ! writing time-step |
---|
[14072] | 534 | INTEGER , INTENT(in) :: kiomid ! Identifier of the file |
---|
[1271] | 535 | CHARACTER(len=*) , INTENT(in) :: cdvar ! variable name |
---|
| 536 | INTEGER , INTENT(in) :: kvid ! variable id |
---|
| 537 | INTEGER , INTENT(in), OPTIONAL :: ktype ! variable type (default R8) |
---|
[13226] | 538 | REAL(dp) , INTENT(in), OPTIONAL :: pv_r0d ! written Od field |
---|
| 539 | REAL(dp), DIMENSION( :), INTENT(in), OPTIONAL :: pv_r1d ! written 1d field |
---|
| 540 | REAL(dp), DIMENSION(:, : ), INTENT(in), OPTIONAL :: pv_r2d ! written 2d field |
---|
| 541 | REAL(dp), DIMENSION(:, :, :), INTENT(in), OPTIONAL :: pv_r3d ! written 3d field |
---|
[544] | 542 | ! |
---|
| 543 | INTEGER :: idims ! number of dimension |
---|
| 544 | INTEGER :: idvar ! variable id |
---|
[14072] | 545 | INTEGER :: jd ! dimension loop counter |
---|
| 546 | INTEGER :: ix1, ix2, iy1, iy2 ! subdomain indexes |
---|
| 547 | INTEGER, DIMENSION(4) :: idimsz ! dimensions size |
---|
[544] | 548 | INTEGER, DIMENSION(4) :: idimid ! dimensions id |
---|
[5341] | 549 | CHARACTER(LEN=256) :: clinfo ! info character |
---|
[544] | 550 | INTEGER :: if90id ! nf90 file identifier |
---|
| 551 | INTEGER :: itype ! variable type |
---|
[2528] | 552 | INTEGER, DIMENSION(4) :: ichunksz ! NetCDF4 chunk sizes. Will be computed using |
---|
[9019] | 553 | ! ! nn_nchunks_[i,j,k,t] namelist parameters |
---|
| 554 | INTEGER :: ichunkalg, ishuffle, ideflate, ideflate_level |
---|
| 555 | ! ! NetCDF4 internally fixed parameters |
---|
[2528] | 556 | LOGICAL :: lchunk ! logical switch to activate chunking and compression |
---|
[9019] | 557 | ! ! when appropriate (currently chunking is applied to 4d fields only) |
---|
| 558 | INTEGER :: idlv ! local variable |
---|
[544] | 559 | !--------------------------------------------------------------------- |
---|
| 560 | ! |
---|
[550] | 561 | clinfo = ' iom_nf90_rp0123d, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(cdvar) |
---|
[544] | 562 | if90id = iom_file(kiomid)%nfid |
---|
| 563 | ! |
---|
| 564 | ! define dimension variables if it is not already done |
---|
| 565 | ! ========================== |
---|
| 566 | IF( iom_file(kiomid)%nvars == 0 ) THEN |
---|
| 567 | ! are we in define mode? |
---|
| 568 | IF( iom_file(kiomid)%irec /= -1 ) THEN ! trick: irec used to know if the file is in define mode or not |
---|
| 569 | CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo) ; iom_file(kiomid)%irec = -1 |
---|
| 570 | ENDIF |
---|
| 571 | ! define the dimension variables if it is not already done |
---|
[12649] | 572 | DO jd = 1, 2 |
---|
| 573 | CALL iom_nf90_check(NF90_INQUIRE_DIMENSION(if90id,jd,iom_file(kiomid)%cn_var(jd),iom_file(kiomid)%dimsz(jd,jd)),clinfo) |
---|
| 574 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(iom_file(kiomid)%cn_var(jd)), NF90_FLOAT , (/ 1, 2 /), & |
---|
| 575 | & iom_file(kiomid)%nvid(jd) ), clinfo) |
---|
| 576 | END DO |
---|
| 577 | iom_file(kiomid)%dimsz(2,1) = iom_file(kiomid)%dimsz(2,2) ! second dim of first variable |
---|
| 578 | iom_file(kiomid)%dimsz(1,2) = iom_file(kiomid)%dimsz(1,1) ! first dim of second variable |
---|
| 579 | DO jd = 3, 4 |
---|
| 580 | CALL iom_nf90_check(NF90_INQUIRE_DIMENSION(if90id,jd,iom_file(kiomid)%cn_var(jd),iom_file(kiomid)%dimsz(1,jd)), clinfo) |
---|
| 581 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(iom_file(kiomid)%cn_var(jd)), NF90_FLOAT , (/ jd /), & |
---|
| 582 | & iom_file(kiomid)%nvid(jd) ), clinfo) |
---|
| 583 | END DO |
---|
[544] | 584 | ! update informations structure related the dimension variable we just added... |
---|
| 585 | iom_file(kiomid)%nvars = 4 |
---|
| 586 | iom_file(kiomid)%luld(1:4) = (/ .FALSE., .FALSE., .FALSE., .TRUE. /) |
---|
[10425] | 587 | iom_file(kiomid)%ndims(1:4) = (/ 2, 2, 1, 1 /) |
---|
[544] | 588 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' define dimension variables done' |
---|
| 589 | ENDIF |
---|
| 590 | ! define the data if it is not already done |
---|
| 591 | ! =============== |
---|
| 592 | IF( kvid <= 0 ) THEN |
---|
[2528] | 593 | ! |
---|
| 594 | ! NetCDF4 chunking and compression fixed settings |
---|
| 595 | ichunkalg = 0 |
---|
| 596 | ishuffle = 1 |
---|
| 597 | ideflate = 1 |
---|
| 598 | ideflate_level = 1 |
---|
| 599 | ! |
---|
[544] | 600 | idvar = iom_file(kiomid)%nvars + 1 |
---|
| 601 | ! are we in define mode? |
---|
| 602 | IF( iom_file(kiomid)%irec /= -1 ) THEN ! trick: irec used to know if the file is in define mode or not |
---|
| 603 | CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo) ; iom_file(kiomid)%irec = -1 |
---|
| 604 | ENDIF |
---|
| 605 | ! variable definition |
---|
| 606 | IF( PRESENT(pv_r0d) ) THEN ; idims = 0 |
---|
[10425] | 607 | ELSEIF( PRESENT(pv_r1d) ) THEN |
---|
[12649] | 608 | idims = 2 ; idimid(1:idims) = (/3,4/) |
---|
| 609 | ELSEIF( PRESENT(pv_r2d) ) THEN ; idims = 3 ; idimid(1:idims) = (/1,2,4/) |
---|
[10425] | 610 | ELSEIF( PRESENT(pv_r3d) ) THEN |
---|
[12649] | 611 | idims = 4 ; idimid(1:idims) = (/1,2,3,4/) |
---|
[544] | 612 | ENDIF |
---|
| 613 | IF( PRESENT(ktype) ) THEN ! variable external type |
---|
| 614 | SELECT CASE (ktype) |
---|
[10425] | 615 | CASE (jp_r8) ; itype = NF90_DOUBLE |
---|
| 616 | CASE (jp_r4) ; itype = NF90_FLOAT |
---|
| 617 | CASE (jp_i4) ; itype = NF90_INT |
---|
| 618 | CASE (jp_i2) ; itype = NF90_SHORT |
---|
| 619 | CASE (jp_i1) ; itype = NF90_BYTE |
---|
[544] | 620 | CASE DEFAULT ; CALL ctl_stop( TRIM(clinfo)//' unknown variable type' ) |
---|
| 621 | END SELECT |
---|
| 622 | ELSE |
---|
| 623 | itype = NF90_DOUBLE |
---|
| 624 | ENDIF |
---|
| 625 | IF( PRESENT(pv_r0d) ) THEN |
---|
| 626 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cdvar), itype, & |
---|
[9019] | 627 | & iom_file(kiomid)%nvid(idvar) ), clinfo ) |
---|
[544] | 628 | ELSE |
---|
| 629 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cdvar), itype, idimid(1:idims), & |
---|
[9019] | 630 | & iom_file(kiomid)%nvid(idvar) ), clinfo ) |
---|
[544] | 631 | ENDIF |
---|
[2528] | 632 | lchunk = .false. |
---|
[9019] | 633 | IF( snc4set%luse .AND. idims == 4 ) lchunk = .true. |
---|
[544] | 634 | ! update informations structure related the new variable we want to add... |
---|
| 635 | iom_file(kiomid)%nvars = idvar |
---|
| 636 | iom_file(kiomid)%cn_var(idvar) = TRIM(cdvar) |
---|
| 637 | iom_file(kiomid)%scf(idvar) = 1. |
---|
| 638 | iom_file(kiomid)%ofs(idvar) = 0. |
---|
| 639 | iom_file(kiomid)%ndims(idvar) = idims |
---|
| 640 | IF( .NOT. PRESENT(pv_r0d) ) THEN ; iom_file(kiomid)%luld(idvar) = .TRUE. |
---|
| 641 | ELSE ; iom_file(kiomid)%luld(idvar) = .FALSE. |
---|
| 642 | ENDIF |
---|
| 643 | DO jd = 1, idims |
---|
| 644 | CALL iom_nf90_check(NF90_INQUIRE_DIMENSION( if90id, idimid(jd), len = iom_file(kiomid)%dimsz(jd,idvar) ), clinfo) |
---|
[2528] | 645 | IF ( lchunk ) ichunksz(jd) = iom_file(kiomid)%dimsz(jd,idvar) |
---|
[544] | 646 | END DO |
---|
[2528] | 647 | IF ( lchunk ) THEN |
---|
| 648 | ! Calculate chunk sizes by partitioning each dimension as requested in namnc4 namelist |
---|
| 649 | ! Disallow very small chunk sizes and prevent chunk sizes larger than each individual dimension |
---|
| 650 | ichunksz(1) = MIN( ichunksz(1),MAX( (ichunksz(1)-1)/snc4set%ni + 1 ,16 ) ) ! Suggested default nc4set%ni=4 |
---|
| 651 | ichunksz(2) = MIN( ichunksz(2),MAX( (ichunksz(2)-1)/snc4set%nj + 1 ,16 ) ) ! Suggested default nc4set%nj=2 |
---|
| 652 | ichunksz(3) = MIN( ichunksz(3),MAX( (ichunksz(3)-1)/snc4set%nk + 1 , 1 ) ) ! Suggested default nc4set%nk=6 |
---|
| 653 | ichunksz(4) = 1 ! Do not allow chunks to span the |
---|
[9019] | 654 | ! ! unlimited dimension |
---|
[2528] | 655 | CALL iom_nf90_check(SET_NF90_DEF_VAR_CHUNKING(if90id, idvar, ichunkalg, ichunksz), clinfo) |
---|
| 656 | CALL iom_nf90_check(SET_NF90_DEF_VAR_DEFLATE(if90id, idvar, ishuffle, ideflate, ideflate_level), clinfo) |
---|
| 657 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' chunked ok. Chunks sizes: ', ichunksz |
---|
| 658 | ENDIF |
---|
[544] | 659 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' defined ok' |
---|
| 660 | ELSE |
---|
| 661 | idvar = kvid |
---|
| 662 | ENDIF |
---|
[9019] | 663 | ! |
---|
[544] | 664 | ! time step kwrite : write the variable |
---|
| 665 | IF( kt == kwrite ) THEN |
---|
| 666 | ! are we in write mode? |
---|
| 667 | IF( iom_file(kiomid)%irec == -1 ) THEN ! trick: irec used to know if the file is in define mode or not |
---|
| 668 | CALL iom_nf90_check(NF90_ENDDEF( if90id ), clinfo) ; iom_file(kiomid)%irec = 0 |
---|
| 669 | ENDIF |
---|
| 670 | ! on what kind of domain must the data be written? |
---|
| 671 | IF( PRESENT(pv_r2d) .OR. PRESENT(pv_r3d) ) THEN |
---|
| 672 | idimsz(1:2) = iom_file(kiomid)%dimsz(1:2,idvar) |
---|
[13286] | 673 | IF( idimsz(1) == Ni_0 .AND. idimsz(2) == Nj_0 ) THEN |
---|
| 674 | ix1 = Nis0 ; ix2 = Nie0 ; iy1 = Njs0 ; iy2 = Nje0 |
---|
| 675 | ELSEIF( idimsz(1) == jpi .AND. idimsz(2) == jpj ) THEN |
---|
[544] | 676 | ix1 = 1 ; ix2 = jpi ; iy1 = 1 ; iy2 = jpj |
---|
[13286] | 677 | ELSEIF( idimsz(1) == jpi .AND. idimsz(2) == jpj ) THEN |
---|
| 678 | ix1 = 1 ; ix2 = jpi ; iy1 = 1 ; iy2 = jpj |
---|
[14072] | 679 | ELSE |
---|
[550] | 680 | CALL ctl_stop( 'iom_nf90_rp0123d: should have been an impossible case...' ) |
---|
[544] | 681 | ENDIF |
---|
| 682 | |
---|
| 683 | ! write dimension variables if it is not already done |
---|
| 684 | ! ============= |
---|
[559] | 685 | ! trick: is defined to 0 => dimension variable are defined but not yet written |
---|
[12649] | 686 | IF( iom_file(kiomid)%dimsz(1, 4) == 0 ) THEN ! time_counter = 0 |
---|
| 687 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, 1, glamt(ix1:ix2, iy1:iy2) ), clinfo ) |
---|
| 688 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, 2, gphit(ix1:ix2, iy1:iy2) ), clinfo ) |
---|
| 689 | SELECT CASE (iom_file(kiomid)%comp) |
---|
[14072] | 690 | CASE ('OCE') |
---|
[12649] | 691 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, 3, gdept_1d ), clinfo ) |
---|
| 692 | CASE ('ABL') |
---|
| 693 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, 3, ght_abl ), clinfo ) |
---|
| 694 | CASE DEFAULT |
---|
| 695 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, 3, (/ (idlv, idlv = 1,iom_file(kiomid)%dimsz(1,3)) /) ), clinfo ) |
---|
| 696 | END SELECT |
---|
| 697 | ! "wrong" value: to be improved but not really useful... |
---|
[14072] | 698 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, 4, kt ), clinfo ) |
---|
[12649] | 699 | ! update the size of the variable corresponding to the unlimited dimension |
---|
| 700 | iom_file(kiomid)%dimsz(1, 4) = 1 ! so we don't enter this IF case any more... |
---|
[544] | 701 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' write dimension variables done' |
---|
| 702 | ENDIF |
---|
| 703 | ENDIF |
---|
| 704 | |
---|
| 705 | ! write the data |
---|
| 706 | ! ============= |
---|
| 707 | IF( PRESENT(pv_r0d) ) THEN |
---|
[9019] | 708 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r0d ), clinfo ) |
---|
[544] | 709 | ELSEIF( PRESENT(pv_r1d) ) THEN |
---|
[9019] | 710 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r1d(:) ), clinfo ) |
---|
[544] | 711 | ELSEIF( PRESENT(pv_r2d) ) THEN |
---|
[9019] | 712 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r2d(ix1:ix2,iy1:iy2) ), clinfo ) |
---|
[544] | 713 | ELSEIF( PRESENT(pv_r3d) ) THEN |
---|
[9019] | 714 | CALL iom_nf90_check( NF90_PUT_VAR( if90id, idvar, pv_r3d(ix1:ix2,iy1:iy2,:) ), clinfo ) |
---|
[544] | 715 | ENDIF |
---|
| 716 | ! add 1 to the size of the temporal dimension (not really useful...) |
---|
| 717 | IF( iom_file(kiomid)%luld(idvar) ) iom_file(kiomid)%dimsz(iom_file(kiomid)%ndims(idvar), idvar) & |
---|
| 718 | & = iom_file(kiomid)%dimsz(iom_file(kiomid)%ndims(idvar), idvar) + 1 |
---|
| 719 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' written ok' |
---|
| 720 | ENDIF |
---|
[14072] | 721 | ! |
---|
[13226] | 722 | END SUBROUTINE iom_nf90_rp0123d_dp |
---|
[544] | 723 | |
---|
| 724 | |
---|
| 725 | SUBROUTINE iom_nf90_check( kstatus, cdinfo ) |
---|
| 726 | !!-------------------------------------------------------------------- |
---|
| 727 | !! *** SUBROUTINE iom_nf90_check *** |
---|
| 728 | !! |
---|
| 729 | !! ** Purpose : check nf90 errors |
---|
| 730 | !!-------------------------------------------------------------------- |
---|
| 731 | INTEGER, INTENT(in) :: kstatus |
---|
| 732 | CHARACTER(LEN=*), INTENT(in) :: cdinfo |
---|
| 733 | !--------------------------------------------------------------------- |
---|
| 734 | IF(kstatus /= nf90_noerr) CALL ctl_stop( 'iom_nf90_check : '//TRIM(nf90_strerror(kstatus)), TRIM(cdinfo) ) |
---|
| 735 | END SUBROUTINE iom_nf90_check |
---|
| 736 | |
---|
| 737 | !!====================================================================== |
---|
| 738 | END MODULE iom_nf90 |
---|