| 1 | MODULE iom_nf90 |
|---|
| 2 | !!===================================================================== |
|---|
| 3 | !! *** MODULE iom_nf90 *** |
|---|
| 4 | !! Input/Output manager : Library to read input files with NF90 (only fliocom module) |
|---|
| 5 | !!==================================================================== |
|---|
| 6 | !! History : 9.0 ! 05 12 (J. Belier) Original code |
|---|
| 7 | !! 9.0 ! 06 02 (S. Masson) Adaptation to NEMO |
|---|
| 8 | !! " ! 07 07 (D. Storkey) Changes to iom_nf90_gettime |
|---|
| 9 | !!-------------------------------------------------------------------- |
|---|
| 10 | !!gm caution add !DIR nec: improved performance to be checked as well as no result changes |
|---|
| 11 | |
|---|
| 12 | !!-------------------------------------------------------------------- |
|---|
| 13 | !! iom_open : open a file read only |
|---|
| 14 | !! iom_close : close a file or all files opened by iom |
|---|
| 15 | !! iom_get : read a field (interfaced to several routines) |
|---|
| 16 | !! iom_gettime : read the time axis kvid in the file |
|---|
| 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) |
|---|
| 19 | !!-------------------------------------------------------------------- |
|---|
| 20 | USE in_out_manager ! I/O manager |
|---|
| 21 | USE dom_oce ! ocean space and time domain |
|---|
| 22 | USE lbclnk ! lateal boundary condition / mpp exchanges |
|---|
| 23 | USE iom_def ! iom variables definitions |
|---|
| 24 | USE netcdf ! NetCDF library |
|---|
| 25 | |
|---|
| 26 | IMPLICIT NONE |
|---|
| 27 | PRIVATE |
|---|
| 28 | |
|---|
| 29 | PUBLIC iom_nf90_open, iom_nf90_close, iom_nf90_varid, iom_nf90_get, iom_nf90_gettime, iom_nf90_rstput |
|---|
| 30 | |
|---|
| 31 | INTERFACE iom_nf90_get |
|---|
| 32 | MODULE PROCEDURE iom_nf90_g0d, iom_nf90_g123d |
|---|
| 33 | END INTERFACE |
|---|
| 34 | INTERFACE iom_nf90_rstput |
|---|
| 35 | MODULE PROCEDURE iom_nf90_rp0123d |
|---|
| 36 | END INTERFACE |
|---|
| 37 | !!---------------------------------------------------------------------- |
|---|
| 38 | !! OPA 9.0 , LOCEAN-IPSL (2006) |
|---|
| 39 | !! $Id: iom_nf90.F90 1271 2009-01-15 08:12:00Z rblod $ |
|---|
| 40 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
|---|
| 41 | !!---------------------------------------------------------------------- |
|---|
| 42 | |
|---|
| 43 | CONTAINS |
|---|
| 44 | |
|---|
| 45 | SUBROUTINE iom_nf90_open( cdname, kiomid, ldwrt, ldok, kdompar, ldclobber ) |
|---|
| 46 | !!--------------------------------------------------------------------- |
|---|
| 47 | !! *** SUBROUTINE iom_open *** |
|---|
| 48 | !! |
|---|
| 49 | !! ** Purpose : open an input file with NF90 |
|---|
| 50 | !!--------------------------------------------------------------------- |
|---|
| 51 | CHARACTER(len=*) , INTENT(inout) :: cdname ! File name |
|---|
| 52 | INTEGER , INTENT( out) :: kiomid ! nf90 identifier of the opened file |
|---|
| 53 | LOGICAL , INTENT(in ) :: ldwrt ! read or write the file? |
|---|
| 54 | LOGICAL , INTENT(in ) :: ldok ! check the existence |
|---|
| 55 | INTEGER, DIMENSION(2,5), INTENT(in ), OPTIONAL :: kdompar ! domain parameters: |
|---|
| 56 | LOGICAL , INTENT(in ), OPTIONAL :: ldclobber ! clobber an existing file |
|---|
| 57 | |
|---|
| 58 | CHARACTER(LEN=100) :: clinfo ! info character |
|---|
| 59 | CHARACTER(LEN=100) :: cltmp ! temporary character |
|---|
| 60 | INTEGER :: iln ! lengths of character |
|---|
| 61 | INTEGER :: istop ! temporary storage of nstop |
|---|
| 62 | INTEGER :: if90id ! nf90 identifier of the opened file |
|---|
| 63 | INTEGER :: idmy ! dummy variable |
|---|
| 64 | INTEGER :: jl ! loop variable |
|---|
| 65 | INTEGER :: zchunk ! temporary storage of iom_nf90_chunk |
|---|
| 66 | LOGICAL :: llchunk ! chunking logical flag |
|---|
| 67 | LOGICAL :: llclobber ! clobber logical flag |
|---|
| 68 | !--------------------------------------------------------------------- |
|---|
| 69 | |
|---|
| 70 | clinfo = ' iom_nf90_open ~~~ ' |
|---|
| 71 | istop = nstop ! store the actual value of nstop |
|---|
| 72 | llclobber=.FALSE. |
|---|
| 73 | IF( PRESENT(ldclobber) ) llclobber=ldclobber |
|---|
| 74 | IF(.NOT. ldwrt) llclobber=.FALSE. |
|---|
| 75 | IF( iom_nf90_chunk > 0 ) THEN |
|---|
| 76 | llchunk=.TRUE. |
|---|
| 77 | ELSE |
|---|
| 78 | llchunk=.FALSE. |
|---|
| 79 | ENDIF |
|---|
| 80 | ! |
|---|
| 81 | IF( ldok .AND. .NOT. llclobber ) THEN ! Open existing file... |
|---|
| 82 | ! ! ============= |
|---|
| 83 | IF( ldwrt ) THEN ! ... in write mode |
|---|
| 84 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' open existing file: '//TRIM(cdname)//' in WRITE mode' |
|---|
| 85 | IF (llchunk) THEN |
|---|
| 86 | zchunk=iom_nf90_chunk |
|---|
| 87 | CALL iom_nf90_check(NF90_OPEN(TRIM(cdname), NF90_WRITE , if90id, chunksize=zchunk), clinfo) |
|---|
| 88 | ELSE |
|---|
| 89 | CALL iom_nf90_check(NF90_OPEN(TRIM(cdname), NF90_WRITE , if90id), clinfo) |
|---|
| 90 | ENDIF |
|---|
| 91 | CALL iom_nf90_check(NF90_SET_FILL( if90id, NF90_NOFILL, idmy ), clinfo) |
|---|
| 92 | ELSE ! ... in read mode |
|---|
| 93 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' open existing file: '//TRIM(cdname)//' in READ mode' |
|---|
| 94 | IF (llchunk) THEN |
|---|
| 95 | zchunk=iom_nf90_chunk |
|---|
| 96 | CALL iom_nf90_check(NF90_OPEN(TRIM(cdname), NF90_NOWRITE, if90id, chunksize=zchunk), clinfo) |
|---|
| 97 | ELSE |
|---|
| 98 | CALL iom_nf90_check(NF90_OPEN(TRIM(cdname), NF90_NOWRITE, if90id), clinfo) |
|---|
| 99 | ENDIF |
|---|
| 100 | ENDIF |
|---|
| 101 | ELSE ! the file does not exist |
|---|
| 102 | ! ! ============= |
|---|
| 103 | iln = INDEX( cdname, '.nc' ) |
|---|
| 104 | IF( ldwrt ) THEN ! the file should be open in write mode so we create it... |
|---|
| 105 | IF( jpnij > 1 ) THEN |
|---|
| 106 | WRITE(cltmp,'(a,a,i4.4,a)') cdname(1:iln-1), '_', narea-1, '.nc' |
|---|
| 107 | cdname = TRIM(cltmp) |
|---|
| 108 | ENDIF |
|---|
| 109 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' create new file: '//TRIM(cdname)//' in WRITE mode' |
|---|
| 110 | |
|---|
| 111 | IF (llchunk) THEN |
|---|
| 112 | zchunk=iom_nf90_chunk |
|---|
| 113 | IF (llclobber) THEN |
|---|
| 114 | CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), NF90_CLOBBER, if90id, chunksize=zchunk), clinfo) |
|---|
| 115 | ELSE |
|---|
| 116 | CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), NF90_NOCLOBBER, if90id, chunksize=zchunk), clinfo) |
|---|
| 117 | ENDIF |
|---|
| 118 | ELSE |
|---|
| 119 | IF (llclobber) THEN |
|---|
| 120 | CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), NF90_CLOBBER, if90id), clinfo) |
|---|
| 121 | ELSE |
|---|
| 122 | CALL iom_nf90_check(NF90_CREATE( TRIM(cdname), NF90_NOCLOBBER, if90id), clinfo) |
|---|
| 123 | ENDIF |
|---|
| 124 | ENDIF |
|---|
| 125 | |
|---|
| 126 | CALL iom_nf90_check(NF90_SET_FILL( if90id, NF90_NOFILL, idmy ), clinfo) |
|---|
| 127 | ! define dimensions |
|---|
| 128 | CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'x', kdompar(1,1) , idmy ), clinfo) |
|---|
| 129 | CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'y', kdompar(2,1) , idmy ), clinfo) |
|---|
| 130 | CALL iom_nf90_check(NF90_DEF_DIM( if90id, 'z', jpk , idmy ), clinfo) |
|---|
| 131 | CALL iom_nf90_check(NF90_DEF_DIM( if90id, 't', NF90_UNLIMITED, idmy ), clinfo) |
|---|
| 132 | ! global attributes |
|---|
| 133 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_number_total' , jpnij ), clinfo) |
|---|
| 134 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_number' , narea-1 ), clinfo) |
|---|
| 135 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_dimensions_ids' , (/1 , 2 /) ), clinfo) |
|---|
| 136 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_size_global' , (/jpiglo, jpjglo/) ), clinfo) |
|---|
| 137 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_size_local' , kdompar(:,1) ), clinfo) |
|---|
| 138 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_position_first' , kdompar(:,2) ), clinfo) |
|---|
| 139 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_position_last' , kdompar(:,3) ), clinfo) |
|---|
| 140 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_halo_size_start', kdompar(:,4) ), clinfo) |
|---|
| 141 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_halo_size_end' , kdompar(:,5) ), clinfo) |
|---|
| 142 | CALL iom_nf90_check(NF90_PUT_ATT( if90id, NF90_GLOBAL, 'DOMAIN_type' , 'BOX' ), clinfo) |
|---|
| 143 | ELSE ! the file should be open for read mode so it must exist... |
|---|
| 144 | CALL ctl_stop( TRIM(clinfo), ' should be impossible case...' ) |
|---|
| 145 | ENDIF |
|---|
| 146 | ENDIF |
|---|
| 147 | ! start to fill file informations |
|---|
| 148 | ! ============= |
|---|
| 149 | IF( istop == nstop ) THEN ! no error within this routine |
|---|
| 150 | !does not work with some compilers kiomid = MINLOC(iom_file(:)%nfid, dim = 1) |
|---|
| 151 | kiomid = 0 |
|---|
| 152 | DO jl = jpmax_files, 1, -1 |
|---|
| 153 | IF( iom_file(jl)%nfid == 0 ) kiomid = jl |
|---|
| 154 | ENDDO |
|---|
| 155 | iom_file(kiomid)%name = TRIM(cdname) |
|---|
| 156 | iom_file(kiomid)%nfid = if90id |
|---|
| 157 | iom_file(kiomid)%iolib = jpnf90 |
|---|
| 158 | iom_file(kiomid)%nvars = 0 |
|---|
| 159 | iom_file(kiomid)%irec = -1 ! useless for NetCDF files, used to know if the file is in define mode |
|---|
| 160 | CALL iom_nf90_check(NF90_Inquire(if90id, unlimitedDimId = iom_file(kiomid)%iduld), clinfo) |
|---|
| 161 | IF ( iom_file(kiomid)%iduld .GE. 0 ) THEN |
|---|
| 162 | CALL iom_nf90_check(NF90_Inquire_Dimension(if90id, iom_file(kiomid)%iduld, & |
|---|
| 163 | & name = iom_file(kiomid)%uldname), clinfo) |
|---|
| 164 | ENDIF |
|---|
| 165 | IF(lwp) WRITE(numout,*) ' ---> '//TRIM(cdname)//' OK' |
|---|
| 166 | ELSE |
|---|
| 167 | kiomid = 0 ! return error flag |
|---|
| 168 | ENDIF |
|---|
| 169 | ! |
|---|
| 170 | END SUBROUTINE iom_nf90_open |
|---|
| 171 | |
|---|
| 172 | |
|---|
| 173 | SUBROUTINE iom_nf90_close( kiomid ) |
|---|
| 174 | !!-------------------------------------------------------------------- |
|---|
| 175 | !! *** SUBROUTINE iom_nf90_close *** |
|---|
| 176 | !! |
|---|
| 177 | !! ** Purpose : close an input file with NF90 |
|---|
| 178 | !!-------------------------------------------------------------------- |
|---|
| 179 | INTEGER, INTENT(in) :: kiomid ! iom identifier of the file to be closed |
|---|
| 180 | CHARACTER(LEN=100) :: clinfo ! info character |
|---|
| 181 | !--------------------------------------------------------------------- |
|---|
| 182 | ! |
|---|
| 183 | clinfo = ' iom_nf90_close , file: '//TRIM(iom_file(kiomid)%name) |
|---|
| 184 | CALL iom_nf90_check(NF90_CLOSE(iom_file(kiomid)%nfid), clinfo) |
|---|
| 185 | ! |
|---|
| 186 | END SUBROUTINE iom_nf90_close |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | FUNCTION iom_nf90_varid ( kiomid, cdvar, kiv, kdimsz ) |
|---|
| 190 | !!----------------------------------------------------------------------- |
|---|
| 191 | !! *** FUNCTION iom_varid *** |
|---|
| 192 | !! |
|---|
| 193 | !! ** Purpose : get the id of a variable in a file with NF90 |
|---|
| 194 | !!----------------------------------------------------------------------- |
|---|
| 195 | INTEGER , INTENT(in ) :: kiomid ! file Identifier |
|---|
| 196 | CHARACTER(len=*) , INTENT(in ) :: cdvar ! name of the variable |
|---|
| 197 | INTEGER , INTENT(in ) :: kiv ! |
|---|
| 198 | INTEGER, DIMENSION(:), INTENT( out), OPTIONAL :: kdimsz ! size of the dimensions |
|---|
| 199 | ! |
|---|
| 200 | INTEGER :: iom_nf90_varid ! iom variable Id |
|---|
| 201 | INTEGER :: if90id ! nf90 file identifier |
|---|
| 202 | INTEGER :: ji ! dummy loop index |
|---|
| 203 | INTEGER :: ivarid ! NetCDF variable Id |
|---|
| 204 | INTEGER :: i_nvd ! number of dimension of the variable |
|---|
| 205 | INTEGER, DIMENSION(jpmax_dims) :: idimid ! dimension ids of the variable |
|---|
| 206 | LOGICAL :: llok ! ok test |
|---|
| 207 | CHARACTER(LEN=100) :: clinfo ! info character |
|---|
| 208 | !!----------------------------------------------------------------------- |
|---|
| 209 | clinfo = ' iom_nf90_varid, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(cdvar) |
|---|
| 210 | iom_nf90_varid = 0 ! default definition |
|---|
| 211 | IF( PRESENT(kdimsz) ) kdimsz(:) = 0 ! default definition |
|---|
| 212 | if90id = iom_file(kiomid)%nfid ! get back NetCDF file id |
|---|
| 213 | ! |
|---|
| 214 | llok = NF90_INQ_VARID( if90id, TRIM(cdvar), ivarid ) == nf90_noerr ! does the variable exist in the file |
|---|
| 215 | IF( llok ) THEN |
|---|
| 216 | iom_nf90_varid = kiv |
|---|
| 217 | iom_file(kiomid)%nvars = kiv |
|---|
| 218 | iom_file(kiomid)%nvid(kiv) = ivarid |
|---|
| 219 | iom_file(kiomid)%cn_var(kiv) = TRIM(cdvar) |
|---|
| 220 | CALL iom_nf90_check(NF90_Inquire_Variable(if90id, ivarid, ndims = i_nvd), clinfo) ! number of dimensions |
|---|
| 221 | iom_file(kiomid)%ndims(kiv) = i_nvd |
|---|
| 222 | CALL iom_nf90_check(NF90_Inquire_Variable(if90id, ivarid, dimids = idimid(1:i_nvd)), clinfo) ! dimensions ids |
|---|
| 223 | iom_file(kiomid)%luld(kiv) = .FALSE. ! default value |
|---|
| 224 | DO ji = 1, i_nvd ! dimensions size |
|---|
| 225 | CALL iom_nf90_check(NF90_Inquire_Dimension(if90id, idimid(ji), len = iom_file(kiomid)%dimsz(ji,kiv)), clinfo) |
|---|
| 226 | IF( idimid(ji) == iom_file(kiomid)%iduld ) iom_file(kiomid)%luld(kiv) = .TRUE. ! unlimited dimension? |
|---|
| 227 | END DO |
|---|
| 228 | !---------- Deal with scale_factor and add_offset |
|---|
| 229 | llok = NF90_Inquire_attribute(if90id, ivarid, 'scale_factor') == nf90_noerr |
|---|
| 230 | IF( llok) THEN |
|---|
| 231 | CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, 'scale_factor', iom_file(kiomid)%scf(kiv)), clinfo) |
|---|
| 232 | ELSE |
|---|
| 233 | iom_file(kiomid)%scf(kiv) = 1. |
|---|
| 234 | END IF |
|---|
| 235 | llok = NF90_Inquire_attribute(if90id, ivarid, 'add_offset') == nf90_noerr |
|---|
| 236 | IF( llok ) THEN |
|---|
| 237 | CALL iom_nf90_check(NF90_GET_ATT(if90id, ivarid, 'add_offset', iom_file(kiomid)%ofs(kiv)), clinfo) |
|---|
| 238 | ELSE |
|---|
| 239 | iom_file(kiomid)%ofs(kiv) = 0. |
|---|
| 240 | END IF |
|---|
| 241 | ! return the simension size |
|---|
| 242 | IF( PRESENT(kdimsz) ) THEN |
|---|
| 243 | IF( i_nvd == SIZE(kdimsz) ) THEN |
|---|
| 244 | kdimsz(:) = iom_file(kiomid)%dimsz(1:i_nvd,kiv) |
|---|
| 245 | ELSE |
|---|
| 246 | WRITE(ctmp1,*) i_nvd, SIZE(kdimsz) |
|---|
| 247 | CALL ctl_stop( TRIM(clinfo), 'error in kdimsz size'//TRIM(ctmp1) ) |
|---|
| 248 | ENDIF |
|---|
| 249 | ENDIF |
|---|
| 250 | ELSE |
|---|
| 251 | iom_nf90_varid = -1 ! variable not found, return error code: -1 |
|---|
| 252 | ENDIF |
|---|
| 253 | ! |
|---|
| 254 | END FUNCTION iom_nf90_varid |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | SUBROUTINE iom_nf90_g0d( kiomid, kvid, pvar ) |
|---|
| 258 | !!----------------------------------------------------------------------- |
|---|
| 259 | !! *** ROUTINE iom_nf90_g0d *** |
|---|
| 260 | !! |
|---|
| 261 | !! ** Purpose : read a scalar with NF90 |
|---|
| 262 | !!----------------------------------------------------------------------- |
|---|
| 263 | INTEGER , INTENT(in ) :: kiomid ! Identifier of the file |
|---|
| 264 | INTEGER , INTENT(in ) :: kvid ! variable id |
|---|
| 265 | REAL(wp), INTENT( out) :: pvar ! read field |
|---|
| 266 | ! |
|---|
| 267 | CHARACTER(LEN=100) :: clinfo ! info character |
|---|
| 268 | !--------------------------------------------------------------------- |
|---|
| 269 | clinfo = 'iom_nf90_g0d , file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid)) |
|---|
| 270 | CALL iom_nf90_check(NF90_GET_VAR(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), pvar), clinfo ) |
|---|
| 271 | ! |
|---|
| 272 | END SUBROUTINE iom_nf90_g0d |
|---|
| 273 | |
|---|
| 274 | |
|---|
| 275 | SUBROUTINE iom_nf90_g123d( kiomid, kvid, knbdim, kstart, kcount, kx1, kx2, ky1, ky2, & |
|---|
| 276 | & pv_r1d, pv_r2d, pv_r3d ) |
|---|
| 277 | !!----------------------------------------------------------------------- |
|---|
| 278 | !! *** ROUTINE iom_nf90_g123d *** |
|---|
| 279 | !! |
|---|
| 280 | !! ** Purpose : read a 1D/2D/3D variable with NF90 |
|---|
| 281 | !! |
|---|
| 282 | !! ** Method : read ONE record at each CALL |
|---|
| 283 | !!----------------------------------------------------------------------- |
|---|
| 284 | INTEGER , INTENT(in ) :: kiomid ! iom identifier of the file |
|---|
| 285 | INTEGER , INTENT(in ) :: kvid ! Name of the variable |
|---|
| 286 | INTEGER , INTENT(in ) :: knbdim ! number of dimensions of the variable |
|---|
| 287 | INTEGER , DIMENSION(:) , INTENT(in ) :: kstart ! start position of the reading in each axis |
|---|
| 288 | INTEGER , DIMENSION(:) , INTENT(in ) :: kcount ! number of points to be read in each axis |
|---|
| 289 | INTEGER , INTENT(in ) :: kx1, kx2, ky1, ky2 ! subdomain indexes |
|---|
| 290 | REAL(wp), DIMENSION(:) , INTENT( out), OPTIONAL :: pv_r1d ! read field (1D case) |
|---|
| 291 | REAL(wp), DIMENSION(:,:) , INTENT( out), OPTIONAL :: pv_r2d ! read field (2D case) |
|---|
| 292 | REAL(wp), DIMENSION(:,:,:) , INTENT( out), OPTIONAL :: pv_r3d ! read field (3D case) |
|---|
| 293 | ! |
|---|
| 294 | CHARACTER(LEN=100) :: clinfo ! info character |
|---|
| 295 | INTEGER :: if90id ! nf90 identifier of the opened file |
|---|
| 296 | INTEGER :: ivid ! nf90 variable id |
|---|
| 297 | !--------------------------------------------------------------------- |
|---|
| 298 | clinfo = 'iom_nf90_g123d , file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid)) |
|---|
| 299 | if90id = iom_file(kiomid)%nfid ! get back NetCDF file id |
|---|
| 300 | ivid = iom_file(kiomid)%nvid(kvid) ! get back NetCDF var id |
|---|
| 301 | ! |
|---|
| 302 | IF( PRESENT(pv_r1d) ) THEN |
|---|
| 303 | CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r1d(: ), start = kstart(1:knbdim), & |
|---|
| 304 | & count = kcount(1:knbdim)), clinfo ) |
|---|
| 305 | ELSEIF( PRESENT(pv_r2d) ) THEN |
|---|
| 306 | CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r2d(kx1:kx2,ky1:ky2 ), start = kstart(1:knbdim), & |
|---|
| 307 | & count = kcount(1:knbdim)), clinfo ) |
|---|
| 308 | ELSEIF( PRESENT(pv_r3d) ) THEN |
|---|
| 309 | CALL iom_nf90_check( NF90_GET_VAR(if90id, ivid, pv_r3d(kx1:kx2,ky1:ky2,:), start = kstart(1:knbdim), & |
|---|
| 310 | & count = kcount(1:knbdim)), clinfo ) |
|---|
| 311 | ENDIF |
|---|
| 312 | ! |
|---|
| 313 | END SUBROUTINE iom_nf90_g123d |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | SUBROUTINE iom_nf90_gettime( kiomid, kvid, ptime, cdunits, cdcalendar ) |
|---|
| 317 | !!-------------------------------------------------------------------- |
|---|
| 318 | !! *** SUBROUTINE iom_gettime *** |
|---|
| 319 | !! |
|---|
| 320 | !! ** Purpose : read the time axis kvid in the file with NF90 |
|---|
| 321 | !!-------------------------------------------------------------------- |
|---|
| 322 | INTEGER , INTENT(in ) :: kiomid ! file Identifier |
|---|
| 323 | INTEGER , INTENT(in ) :: kvid ! variable id |
|---|
| 324 | REAL(wp), DIMENSION(:) , INTENT( out) :: ptime ! the time axis |
|---|
| 325 | CHARACTER(len=*), OPTIONAL, INTENT( out) :: cdunits ! units attribute |
|---|
| 326 | CHARACTER(len=*), OPTIONAL, INTENT( out) :: cdcalendar ! calendar attribute |
|---|
| 327 | ! |
|---|
| 328 | CHARACTER(LEN=100) :: clinfo ! info character |
|---|
| 329 | !--------------------------------------------------------------------- |
|---|
| 330 | clinfo = 'iom_nf90_gettime, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(iom_file(kiomid)%cn_var(kvid)) |
|---|
| 331 | CALL iom_nf90_check(NF90_GET_VAR(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), ptime(:), & |
|---|
| 332 | & start=(/ 1 /), count=(/ iom_file(kiomid)%dimsz(1, kvid) /)), clinfo) |
|---|
| 333 | IF ( PRESENT(cdunits) ) THEN |
|---|
| 334 | CALL iom_nf90_check(NF90_GET_ATT(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), "units", & |
|---|
| 335 | & values=cdunits), clinfo) |
|---|
| 336 | ENDIF |
|---|
| 337 | IF ( PRESENT(cdcalendar) ) THEN |
|---|
| 338 | CALL iom_nf90_check(NF90_GET_ATT(iom_file(kiomid)%nfid, iom_file(kiomid)%nvid(kvid), "calendar", & |
|---|
| 339 | & values=cdcalendar), clinfo) |
|---|
| 340 | ENDIF |
|---|
| 341 | ! |
|---|
| 342 | END SUBROUTINE iom_nf90_gettime |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | SUBROUTINE iom_nf90_rp0123d( kt, kwrite, kiomid, cdvar , kvid , ktype, & |
|---|
| 346 | & pv_r0d, pv_r1d, pv_r2d, pv_r3d ) |
|---|
| 347 | !!-------------------------------------------------------------------- |
|---|
| 348 | !! *** SUBROUTINE iom_nf90_rstput *** |
|---|
| 349 | !! |
|---|
| 350 | !! ** Purpose : read the time axis cdvar in the file |
|---|
| 351 | !!-------------------------------------------------------------------- |
|---|
| 352 | INTEGER , INTENT(in) :: kt ! ocean time-step |
|---|
| 353 | INTEGER , INTENT(in) :: kwrite ! writing time-step |
|---|
| 354 | INTEGER , INTENT(in) :: kiomid ! Identifier of the file |
|---|
| 355 | CHARACTER(len=*) , INTENT(in) :: cdvar ! variable name |
|---|
| 356 | INTEGER , INTENT(in) :: kvid ! variable id |
|---|
| 357 | INTEGER , INTENT(in), OPTIONAL :: ktype ! variable type (default R8) |
|---|
| 358 | REAL(wp) , INTENT(in), OPTIONAL :: pv_r0d ! written Od field |
|---|
| 359 | REAL(wp), DIMENSION( :), INTENT(in), OPTIONAL :: pv_r1d ! written 1d field |
|---|
| 360 | REAL(wp), DIMENSION(:, : ), INTENT(in), OPTIONAL :: pv_r2d ! written 2d field |
|---|
| 361 | REAL(wp), DIMENSION(:, :, :), INTENT(in), OPTIONAL :: pv_r3d ! written 3d field |
|---|
| 362 | ! |
|---|
| 363 | INTEGER :: idims ! number of dimension |
|---|
| 364 | INTEGER :: idvar ! variable id |
|---|
| 365 | INTEGER :: jd ! dimension loop counter |
|---|
| 366 | INTEGER :: ix1, ix2, iy1, iy2 ! subdomain indexes |
|---|
| 367 | INTEGER, DIMENSION(4) :: idimsz ! dimensions size |
|---|
| 368 | INTEGER, DIMENSION(4) :: idimid ! dimensions id |
|---|
| 369 | CHARACTER(LEN=100) :: clinfo ! info character |
|---|
| 370 | CHARACTER(LEN= 12), DIMENSION(4) :: cltmp ! temporary character |
|---|
| 371 | INTEGER :: if90id ! nf90 file identifier |
|---|
| 372 | INTEGER :: idmy ! dummy variable |
|---|
| 373 | INTEGER :: itype ! variable type |
|---|
| 374 | !--------------------------------------------------------------------- |
|---|
| 375 | ! |
|---|
| 376 | clinfo = ' iom_nf90_rp0123d, file: '//TRIM(iom_file(kiomid)%name)//', var: '//TRIM(cdvar) |
|---|
| 377 | if90id = iom_file(kiomid)%nfid |
|---|
| 378 | ! |
|---|
| 379 | ! define dimension variables if it is not already done |
|---|
| 380 | ! ========================== |
|---|
| 381 | IF( iom_file(kiomid)%nvars == 0 ) THEN |
|---|
| 382 | ! are we in define mode? |
|---|
| 383 | IF( iom_file(kiomid)%irec /= -1 ) THEN ! trick: irec used to know if the file is in define mode or not |
|---|
| 384 | CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo) ; iom_file(kiomid)%irec = -1 |
|---|
| 385 | ENDIF |
|---|
| 386 | ! define the dimension variables if it is not already done |
|---|
| 387 | cltmp = (/ 'nav_lon ', 'nav_lat ', 'nav_lev ', 'time_counter' /) |
|---|
| 388 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(1)), NF90_FLOAT , (/ 1, 2 /), iom_file(kiomid)%nvid(1) ), clinfo) |
|---|
| 389 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(2)), NF90_FLOAT , (/ 1, 2 /), iom_file(kiomid)%nvid(2) ), clinfo) |
|---|
| 390 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(3)), NF90_FLOAT , (/ 3 /), iom_file(kiomid)%nvid(3) ), clinfo) |
|---|
| 391 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cltmp(4)), NF90_DOUBLE, (/ 4 /), iom_file(kiomid)%nvid(4) ), clinfo) |
|---|
| 392 | ! update informations structure related the dimension variable we just added... |
|---|
| 393 | iom_file(kiomid)%nvars = 4 |
|---|
| 394 | iom_file(kiomid)%luld(1:4) = (/ .FALSE., .FALSE., .FALSE., .TRUE. /) |
|---|
| 395 | iom_file(kiomid)%cn_var(1:4) = cltmp |
|---|
| 396 | iom_file(kiomid)%ndims(1:4) = (/ 2, 2, 1, 1 /) |
|---|
| 397 | ! trick: defined to 0 to say that dimension variables are defined but not yet written |
|---|
| 398 | iom_file(kiomid)%dimsz(1, 1) = 0 |
|---|
| 399 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' define dimension variables done' |
|---|
| 400 | ENDIF |
|---|
| 401 | ! define the data if it is not already done |
|---|
| 402 | ! =============== |
|---|
| 403 | IF( kvid <= 0 ) THEN |
|---|
| 404 | idvar = iom_file(kiomid)%nvars + 1 |
|---|
| 405 | ! are we in define mode? |
|---|
| 406 | IF( iom_file(kiomid)%irec /= -1 ) THEN ! trick: irec used to know if the file is in define mode or not |
|---|
| 407 | CALL iom_nf90_check(NF90_REDEF( if90id ), clinfo) ; iom_file(kiomid)%irec = -1 |
|---|
| 408 | ENDIF |
|---|
| 409 | ! variable definition |
|---|
| 410 | IF( PRESENT(pv_r0d) ) THEN ; idims = 0 |
|---|
| 411 | ELSEIF( PRESENT(pv_r1d) ) THEN ; idims = 2 ; idimid(1:idims) = (/ 3,4/) |
|---|
| 412 | ELSEIF( PRESENT(pv_r2d) ) THEN ; idims = 3 ; idimid(1:idims) = (/1,2 ,4/) |
|---|
| 413 | ELSEIF( PRESENT(pv_r3d) ) THEN ; idims = 4 ; idimid(1:idims) = (/1,2,3,4/) |
|---|
| 414 | ENDIF |
|---|
| 415 | IF( PRESENT(ktype) ) THEN ! variable external type |
|---|
| 416 | SELECT CASE (ktype) |
|---|
| 417 | CASE (jp_r8) ; itype = NF90_DOUBLE |
|---|
| 418 | CASE (jp_r4) ; itype = NF90_FLOAT |
|---|
| 419 | CASE (jp_i4) ; itype = NF90_INT |
|---|
| 420 | CASE (jp_i2) ; itype = NF90_SHORT |
|---|
| 421 | CASE (jp_i1) ; itype = NF90_BYTE |
|---|
| 422 | CASE DEFAULT ; CALL ctl_stop( TRIM(clinfo)//' unknown variable type' ) |
|---|
| 423 | END SELECT |
|---|
| 424 | ELSE |
|---|
| 425 | itype = NF90_DOUBLE |
|---|
| 426 | ENDIF |
|---|
| 427 | IF( PRESENT(pv_r0d) ) THEN |
|---|
| 428 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cdvar), itype, & |
|---|
| 429 | & iom_file(kiomid)%nvid(idvar) ), clinfo) |
|---|
| 430 | ELSE |
|---|
| 431 | CALL iom_nf90_check(NF90_DEF_VAR( if90id, TRIM(cdvar), itype, idimid(1:idims), & |
|---|
| 432 | & iom_file(kiomid)%nvid(idvar) ), clinfo) |
|---|
| 433 | ENDIF |
|---|
| 434 | ! update informations structure related the new variable we want to add... |
|---|
| 435 | iom_file(kiomid)%nvars = idvar |
|---|
| 436 | iom_file(kiomid)%cn_var(idvar) = TRIM(cdvar) |
|---|
| 437 | iom_file(kiomid)%scf(idvar) = 1. |
|---|
| 438 | iom_file(kiomid)%ofs(idvar) = 0. |
|---|
| 439 | iom_file(kiomid)%ndims(idvar) = idims |
|---|
| 440 | IF( .NOT. PRESENT(pv_r0d) ) THEN ; iom_file(kiomid)%luld(idvar) = .TRUE. |
|---|
| 441 | ELSE ; iom_file(kiomid)%luld(idvar) = .FALSE. |
|---|
| 442 | ENDIF |
|---|
| 443 | DO jd = 1, idims |
|---|
| 444 | CALL iom_nf90_check(NF90_INQUIRE_DIMENSION( if90id, idimid(jd), len = iom_file(kiomid)%dimsz(jd,idvar) ), clinfo) |
|---|
| 445 | END DO |
|---|
| 446 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' defined ok' |
|---|
| 447 | ELSE |
|---|
| 448 | idvar = kvid |
|---|
| 449 | ENDIF |
|---|
| 450 | |
|---|
| 451 | ! time step kwrite : write the variable |
|---|
| 452 | IF( kt == kwrite ) THEN |
|---|
| 453 | ! are we in write mode? |
|---|
| 454 | IF( iom_file(kiomid)%irec == -1 ) THEN ! trick: irec used to know if the file is in define mode or not |
|---|
| 455 | CALL iom_nf90_check(NF90_ENDDEF( if90id ), clinfo) ; iom_file(kiomid)%irec = 0 |
|---|
| 456 | ENDIF |
|---|
| 457 | ! on what kind of domain must the data be written? |
|---|
| 458 | IF( PRESENT(pv_r2d) .OR. PRESENT(pv_r3d) ) THEN |
|---|
| 459 | idimsz(1:2) = iom_file(kiomid)%dimsz(1:2,idvar) |
|---|
| 460 | IF( idimsz(1) == (nlei - nldi + 1) .AND. idimsz(2) == (nlej - nldj + 1) ) THEN |
|---|
| 461 | ix1 = nldi ; ix2 = nlei ; iy1 = nldj ; iy2 = nlej |
|---|
| 462 | ELSEIF( idimsz(1) == nlci .AND. idimsz(2) == nlcj ) THEN |
|---|
| 463 | ix1 = 1 ; ix2 = nlci ; iy1 = 1 ; iy2 = nlcj |
|---|
| 464 | ELSEIF( idimsz(1) == jpi .AND. idimsz(2) == jpj ) THEN |
|---|
| 465 | ix1 = 1 ; ix2 = jpi ; iy1 = 1 ; iy2 = jpj |
|---|
| 466 | ELSE |
|---|
| 467 | CALL ctl_stop( 'iom_nf90_rp0123d: should have been an impossible case...' ) |
|---|
| 468 | ENDIF |
|---|
| 469 | |
|---|
| 470 | ! write dimension variables if it is not already done |
|---|
| 471 | ! ============= |
|---|
| 472 | ! trick: is defined to 0 => dimension variable are defined but not yet written |
|---|
| 473 | IF( iom_file(kiomid)%dimsz(1, 1) == 0 ) THEN |
|---|
| 474 | CALL iom_nf90_check(NF90_INQ_VARID( if90id, 'nav_lon' , idmy ), clinfo) |
|---|
| 475 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idmy, glamt(ix1:ix2, iy1:iy2) ), clinfo) |
|---|
| 476 | CALL iom_nf90_check(NF90_INQ_VARID( if90id, 'nav_lat' , idmy ), clinfo) |
|---|
| 477 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idmy, gphit(ix1:ix2, iy1:iy2) ), clinfo) |
|---|
| 478 | CALL iom_nf90_check(NF90_INQ_VARID( if90id, 'nav_lev' , idmy ), clinfo) |
|---|
| 479 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idmy, gdept_0 ), clinfo) |
|---|
| 480 | ! +++ WRONG VALUE: to be improved but not really useful... |
|---|
| 481 | CALL iom_nf90_check(NF90_INQ_VARID( if90id, 'time_counter', idmy ), clinfo) |
|---|
| 482 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idmy, kt ), clinfo) |
|---|
| 483 | ! update the values of the variables dimensions size |
|---|
| 484 | CALL iom_nf90_check(NF90_INQUIRE_DIMENSION( if90id, 1, len = iom_file(kiomid)%dimsz(1,1) ), clinfo) |
|---|
| 485 | CALL iom_nf90_check(NF90_INQUIRE_DIMENSION( if90id, 2, len = iom_file(kiomid)%dimsz(2,1) ), clinfo) |
|---|
| 486 | iom_file(kiomid)%dimsz(1:2, 2) = iom_file(kiomid)%dimsz(1:2, 1) |
|---|
| 487 | CALL iom_nf90_check(NF90_INQUIRE_DIMENSION( if90id, 3, len = iom_file(kiomid)%dimsz(1,3) ), clinfo) |
|---|
| 488 | iom_file(kiomid)%dimsz(1 , 4) = 1 ! unlimited dimension |
|---|
| 489 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' write dimension variables done' |
|---|
| 490 | ENDIF |
|---|
| 491 | ENDIF |
|---|
| 492 | |
|---|
| 493 | ! write the data |
|---|
| 494 | ! ============= |
|---|
| 495 | IF( PRESENT(pv_r0d) ) THEN |
|---|
| 496 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idvar, pv_r0d ), clinfo) |
|---|
| 497 | ELSEIF( PRESENT(pv_r1d) ) THEN |
|---|
| 498 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idvar, pv_r1d( :) ), clinfo) |
|---|
| 499 | ELSEIF( PRESENT(pv_r2d) ) THEN |
|---|
| 500 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idvar, pv_r2d(ix1:ix2, iy1:iy2 ) ), clinfo) |
|---|
| 501 | ELSEIF( PRESENT(pv_r3d) ) THEN |
|---|
| 502 | CALL iom_nf90_check(NF90_PUT_VAR( if90id, idvar, pv_r3d(ix1:ix2, iy1:iy2, :) ), clinfo) |
|---|
| 503 | ENDIF |
|---|
| 504 | ! add 1 to the size of the temporal dimension (not really useful...) |
|---|
| 505 | IF( iom_file(kiomid)%luld(idvar) ) iom_file(kiomid)%dimsz(iom_file(kiomid)%ndims(idvar), idvar) & |
|---|
| 506 | & = iom_file(kiomid)%dimsz(iom_file(kiomid)%ndims(idvar), idvar) + 1 |
|---|
| 507 | IF(lwp) WRITE(numout,*) TRIM(clinfo)//' written ok' |
|---|
| 508 | ENDIF |
|---|
| 509 | ! |
|---|
| 510 | END SUBROUTINE iom_nf90_rp0123d |
|---|
| 511 | |
|---|
| 512 | |
|---|
| 513 | SUBROUTINE iom_nf90_check( kstatus, cdinfo ) |
|---|
| 514 | !!-------------------------------------------------------------------- |
|---|
| 515 | !! *** SUBROUTINE iom_nf90_check *** |
|---|
| 516 | !! |
|---|
| 517 | !! ** Purpose : check nf90 errors |
|---|
| 518 | !!-------------------------------------------------------------------- |
|---|
| 519 | INTEGER, INTENT(in) :: kstatus |
|---|
| 520 | CHARACTER(LEN=*), INTENT(in) :: cdinfo |
|---|
| 521 | !--------------------------------------------------------------------- |
|---|
| 522 | IF(kstatus /= nf90_noerr) CALL ctl_stop( 'iom_nf90_check : '//TRIM(nf90_strerror(kstatus)), TRIM(cdinfo) ) |
|---|
| 523 | END SUBROUTINE iom_nf90_check |
|---|
| 524 | |
|---|
| 525 | |
|---|
| 526 | !!====================================================================== |
|---|
| 527 | END MODULE iom_nf90 |
|---|
