Changeset 2364 for branches/nemo_v3_3_beta/NEMOGCM/EXTERNAL/IOIPSL/src/histcom.f90

Timestamp:

2010-11-05T16:22:12+01:00 (13 years ago)

Author:

acc

Message:

Added basic NetCDF4 chunking and compression support (key_netcdf4). See ticket #754

File:

• branches/nemo_v3_3_beta/NEMOGCM/EXTERNAL/IOIPSL/src/histcom.f90 (modified) (18 diffs)

branches/nemo_v3_3_beta/NEMOGCM/EXTERNAL/IOIPSL/src/histcom.f90

@@ -7 +7 @@
 !-
   USE netcdf
+  USE nc4dummy ! needed to allow compilation with netcdf3 libraries
 !-
   USE stringop, ONLY : nocomma,cmpblank,findpos,find_str,strlowercase
@@ -35 +36 @@
 !- to describe the grid, just two vectors.
 !---------------------------------------------------------------------
+!-
+  TYPE, PUBLIC :: snc4_ctl    !: netcdf4 chunking control structure 
+                              !: (optional on histbeg and histend calls)
+     SEQUENCE
+     INTEGER :: ni
+     INTEGER :: nj
+     INTEGER :: nk
+     LOGICAL :: luse
+  END TYPE snc4_ctl
 !-
   INTERFACE histbeg
@@ -163 +173 @@
  & (pfilename,pim,plon,pjm,plat,       &
  &  par_orix,par_szx,par_oriy,par_szy, &
- &  pitau0,pdate0,pdeltat,phoriid,idf,domain_id,mode)
+ &  pitau0,pdate0,pdeltat,phoriid,idf,domain_id,mode,snc4chunks)
 !---------------------------------------------------------------------
 !- histbeg for 1D regular horizontal coordinates (see histb_all)
@@ -179 +189 @@
   INTEGER,INTENT(IN),OPTIONAL :: domain_id
   CHARACTER(LEN=*),OPTIONAL,INTENT(IN) :: mode
+  TYPE(snc4_ctl), OPTIONAL,INTENT(IN) :: snc4chunks
 !---------------------------------------------------------------------
   CALL histb_all &
@@ -184 +195 @@
  &  x_1d=plon,y_1d=plat, &
  &  k_orx=par_orix,k_szx=par_szx,k_ory=par_oriy,k_szy=par_szy, &
- &  domain_id=domain_id,mode=mode)
+ &  domain_id=domain_id,mode=mode,snc4chunks=snc4chunks)
 !-------------------------
 END SUBROUTINE histb_reg1d
@@ -191 +202 @@
  & (pfilename,pim,plon,pjm,plat,       &
  &  par_orix,par_szx,par_oriy,par_szy, &
- &  pitau0,pdate0,pdeltat,phoriid,idf,domain_id,mode)
+ &  pitau0,pdate0,pdeltat,phoriid,idf,domain_id,mode,snc4chunks)
 !---------------------------------------------------------------------
 !- histbeg for 2D regular horizontal coordinates (see histb_all)
@@ -206 +217 @@
   INTEGER,INTENT(IN),OPTIONAL :: domain_id
   CHARACTER(LEN=*),OPTIONAL,INTENT(IN) :: mode
+  TYPE(snc4_ctl), OPTIONAL,INTENT(IN) :: snc4chunks
 !---------------------------------------------------------------------
   CALL histb_all &
@@ -211 +223 @@
  &  x_2d=plon,y_2d=plat, &
  &  k_orx=par_orix,k_szx=par_szx,k_ory=par_oriy,k_szy=par_szy,    &
- &  domain_id=domain_id,mode=mode)
+ &  domain_id=domain_id,mode=mode,snc4chunks=snc4chunks)
 !-------------------------
 END SUBROUTINE histb_reg2d
@@ -217 +229 @@
 SUBROUTINE histb_irreg &
  &  (pfilename,pim,plon,plon_bounds,plat,plat_bounds, &
- &   pitau0,pdate0,pdeltat,phoriid,idf,domain_id,mode)
+ &   pitau0,pdate0,pdeltat,phoriid,idf,domain_id,mode,snc4chunks)
 !---------------------------------------------------------------------
 !- histbeg for irregular horizontal coordinates (see histb_all)
@@ -232 +244 @@
   INTEGER,INTENT(IN),OPTIONAL :: domain_id
   CHARACTER(LEN=*),OPTIONAL,INTENT(IN) :: mode
+  TYPE(snc4_ctl), OPTIONAL,INTENT(IN) :: snc4chunks
 !---------------------------------------------------------------------
   CALL histb_all &
  & (3,pfilename,pim,pim,pitau0,pdate0,pdeltat,phoriid,idf,  &
  &  x_1d=plon,y_1d=plat,x_bnds=plon_bounds,y_bnds=plat_bounds, &
- &  domain_id=domain_id,mode=mode)
+ &  domain_id=domain_id,mode=mode,snc4chunks=snc4chunks)
 !-------------------------
 END SUBROUTINE histb_irreg
@@ -243 +256 @@
  & (k_typ,nc_name,pim,pjm,pitau0,pdate0,pdeltat,phoriid,idf, &
  &  x_1d,y_1d,x_2d,y_2d,k_orx,k_szx,k_ory,k_szy, &
- &  x_bnds,y_bnds,domain_id,mode)
+ &  x_bnds,y_bnds,domain_id,mode,snc4chunks)
 !---------------------------------------------------------------------
 !- General interface for horizontal grids.
@@ -305 +318 @@
 !-              Keywords "NETCDF4" and "CLASSIC" are reserved
 !-              for future use.
+!-
+!- snc4chunks    : Structure containing chunk partitioning parameters
+!-              for 4-D variables and a logical switch to toggle
+!-              between netcdf3 o/p (false) and netcdf4 chunked
+!-              and compressed o/p (true)
 !---------------------------------------------------------------------
   IMPLICIT NONE
@@ -320 +338 @@
   INTEGER,INTENT(IN),OPTIONAL :: domain_id
   CHARACTER(LEN=*),OPTIONAL,INTENT(IN) :: mode
+  TYPE(snc4_ctl), OPTIONAL,INTENT(IN) :: snc4chunks
 !-
   INTEGER :: nfid,iret,m_c
@@ -406 +425 @@
   ELSE
     m_c = IOR(NF90_CLOBBER,NF90_64BIT_OFFSET)
+  ENDIF
+!-
+  IF (PRESENT(snc4chunks)) THEN
+    IF (snc4chunks%luse) m_c = NF90_HDF5  ! will conflict if compiling with netcdf4 libraries without "key_netcdf4"
   ENDIF
 !-
@@ -1347 +1370 @@
 END SUBROUTINE histdef
 !===
-SUBROUTINE histend (idf)
+SUBROUTINE histend (idf, snc4chunks)
 !---------------------------------------------------------------------
 !- This subroutine end the decalaration of variables and sets the
@@ -1362 +1385 @@
 !-
   INTEGER,INTENT(IN) :: idf
+  TYPE(snc4_ctl), OPTIONAL,INTENT(IN) :: snc4chunks
 !-
   INTEGER :: nfid,nvid,iret,ndim,iv,itx,ziv,itax,dim_cnt
@@ -1378 +1402 @@
   LOGICAL :: l_b
   LOGICAL :: l_dbg
+  INTEGER, DIMENSION(4) :: ichunksz    ! NETCDF4 chunk sizes
+  INTEGER :: ichunkalg, ishuffle,&
+             ideflate, ideflate_level
+  LOGICAL :: lchunk = .FALSE.   ! logical switch to activate chunking when appropriate
+!-
+  ! NetCDF4 chunking and compression parameters
+  ichunkalg = 0
+  ishuffle = 1
+  ideflate = 1
+  ideflate_level = 1
+  !
 !---------------------------------------------------------------------
   CALL ipsldbg (old_status=l_dbg)
@@ -1517 +1552 @@
  &             W_F(idf)%W_V(iv)%v_typ,dims(1:ABS(ndim)),nvid)
 !-
+      IF( ndim == 4 ) THEN
+        IF( PRESENT( snc4chunks ) ) THEN
+          IF( snc4chunks%luse ) THEN
+           ichunksz = 1
+           iret = NF90_INQUIRE_DIMENSION( nfid, W_F(idf)%xid, len = ichunksz(1) )
+           iret = NF90_INQUIRE_DIMENSION( nfid, W_F(idf)%yid, len = ichunksz(2) )
+           IF ( ziv .NE. -99 ) &
+              iret = NF90_INQUIRE_DIMENSION( nfid, W_F(idf)%zax_ids(ziv), len = ichunksz(3) )
+           ichunksz(1) = MIN(ichunksz(1), MAX((ichunksz(1)-1)/snc4chunks%ni + 1,16))
+           ichunksz(2) = MIN(ichunksz(2), MAX((ichunksz(2)-1)/snc4chunks%nj + 1,16))
+           ichunksz(3) = MIN(ichunksz(3), MAX((ichunksz(3)-1)/snc4chunks%nk + 1, 1))
+           ! Always use a chunk size of 1 for the unlimited dimension
+           iret = NF90_DEF_VAR_CHUNKING(nfid, nvid, ichunkalg, ichunksz) ! will conflict if compiling with netcdf4 libraries without "key_netcdf4"
+
+           iret = NF90_DEF_VAR_DEFLATE(nfid, nvid, ishuffle, ideflate, ideflate_level) ! will conflict if compiling with netcdf4 libraries without "key_netcdf4"
+
+          ENDIF
+        ENDIF
+      ENDIF
       W_F(idf)%W_V(iv)%ncvid = nvid
 !-