New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
diadimg.F90 on Ticket #651 – Attachment – NEMO

Ticket #651: diadimg.F90

File diadimg.F90, 7.9 KB (added by molines, 14 years ago)

diadimg with bug fix and improvements

Line 
1MODULE diadimg
2   !!======================================================================
3   !!                     ***  MODULE  diadimg  ***
4   !! Ocean diagnostics :  write ocean output files in dimg direct access format (mpp)
5   !!=====================================================================
6# if defined key_dimgout
7   !!----------------------------------------------------------------------
8   !! * Modules used
9   USE oce             ! ocean dynamics and tracers
10   USE dom_oce         ! ocean space and time domain
11   USE in_out_manager  ! I/O manager
12   USE daymod          ! calendar
13
14   IMPLICIT NONE
15   PRIVATE
16
17   !! * Accessibility
18   PUBLIC dia_wri_dimg            ! called by trd_mld (eg)
19
20   !! * Substitutions
21#  include "domzgr_substitute.h90"
22   !!----------------------------------------------------------------------
23   !!   OPA 9.0 , LOCEAN-IPSL (2005)
24   !! $Header$
25   !! This software is governed by the CeCILL licence see modipsl/doc/NEMO_CeCILL.txt
26   !!----------------------------------------------------------------------
27
28CONTAINS
29
30  SUBROUTINE dia_wri_dimg(cd_name, cd_text, ptab, klev, cd_type , ksubi )
31    !!-------------------------------------------------------------------------
32    !!        *** ROUTINE dia_wri_dimg ***
33    !!
34    !! ** Purpose : write ptab in the dimg file cd_name, with comment cd_text.
35    !!       ptab has klev x 2D fields
36    !!
37    !! ** Action :
38    !!       Define header variables from the config parameters
39    !!       Open the dimg file on unit inum = 14 ( IEEE I4R4 file )
40    !!       Write header on record 1
41    !!       Write ptab on the following klev records
42    !!
43    !! History :
44    !!   03-12 (J.M. Molines ) : Original. Replace ctl_opn, writn2d
45    !!---------------------------------------------------------------------------
46    !! * Arguments
47    CHARACTER(len=*),INTENT(in) ::   &
48         &                            cd_name,  &  ! dimg file name
49         &                            cd_text      ! comment to write on record #1
50    INTEGER, INTENT(in) ::            klev         ! number of level in ptab to write
51    REAL(wp),INTENT(in), DIMENSION(:,:,:) :: ptab  ! 3D array to write
52    CHARACTER(LEN=1),INTENT(in) ::    cd_type      ! either 'T', 'W' or '2' , depending on the vertical
53    !                                              ! grid for ptab. 2 stands for 2D file
54    INTEGER, INTENT(in), OPTIONAL, DIMENSION(klev) :: ksubi 
55
56    !! * Local declarations
57    INTEGER :: jk, jn           ! dummy loop indices
58    INTEGER :: irecl4,             &    ! record length in bytes
59         &       inum,             &    ! logical unit (set to 14)
60         &       irec,             &    ! current record to be written
61         &       irecend                ! record number where nclit... are stored
62    REAL(sp)                    :: zdx,zdy,zspval,zwest,ztimm
63    REAL(sp)                    :: zsouth
64    REAL(sp),DIMENSION(jpi,jpj) :: z42d        ! 2d temporary workspace (sp)
65    REAL(sp),DIMENSION(jpk)     :: z4dep       ! vertical level (sp)
66
67    CHARACTER(LEN=80) :: clname                ! name of file in case of dimgnnn
68    CHARACTER(LEN=4) :: clver='@!01'           ! dimg string identifier
69    !!---------------------------------------------------------------------------
70
71    !! * Initialisations
72
73!    irecl4 = MAX(jpi*jpj*sp , 84+(18+jpk)*sp + 8*jpnij*sp  )
74     irecl4 = MAX(jpi*jpj*sp , 84+(18+1+jpk)*sp )
75    inum = 14
76
77    zspval=0.0_sp    ! special values on land
78    !  the 'numerical' grid is described. The geographical one is in a grid file
79    zdx=1._sp
80    zdy=1._sp
81    zsouth=njmpp * 1._sp
82    zwest=nimpp * 1._sp
83    !  time in days since the historical begining of the run (nit000 = 0 )
84    ztimm=adatrj
85
86    SELECT CASE ( cd_type )
87
88    CASE ( 'T')
89       z4dep(:)=gdept_0(:)
90
91    CASE ( 'W' )
92       z4dep(:)=gdepw_0(:)
93
94    CASE ( '2' )
95       z4dep(1:klev) =(/(jk, jk=1,klev)/)
96
97    CASE ( 'I' )
98       z4dep(1:klev) = ksubi(1:klev)
99
100    CASE DEFAULT
101       IF(lwp) WRITE(numout,*) ' E R R O R : bad cd_type in dia_wri_dimg '
102       STOP 'dia_wri_dimg'
103
104    END SELECT
105
106    IF ( ln_dimgnnn  ) THEN
107     irecl4 = MAX(jpi*jpj*sp , 84+(18+jpk)*sp + 8*jpnij*sp  )
108       WRITE(clname,'(a,a,i3.3)') TRIM(cd_name),'.',narea
109       CALL ctl_opn(inum, clname,'UNKNOWN','UNFORMATTED','DIRECT',irecl4,numout,lwp)
110       WRITE(inum,REC=1 ) clver, cd_text, irecl4, &
111            &     jpi,jpj, klev, 1 , 1 ,            &
112            &     zwest, zsouth, zdx, zdy, zspval,  &
113            &     z4dep(1:klev),                    &
114            &     ztimm,                            &
115            &     narea, jpnij,jpiglo,jpjglo,jpizoom, jpjzoom,    &    ! extension to dimg for mpp output
116            &     nlcit,nlcjt, nldit, nldjt, nleit, nlejt, nimppt, njmppt  !
117
118       !! * Write klev levels
119       IF ( cd_type == 'I' ) THEN
120
121          DO jk = 1, klev
122             irec =1 + jk
123             z42d(:,:) = ptab(:,:,ksubi(jk))
124             WRITE(inum,REC=irec)  z42d(:,:)
125          END DO
126       ELSE
127          DO jk = 1, klev
128             irec =1 + jk
129             z42d(:,:) = ptab(:,:,jk)
130             WRITE(inum,REC=irec)  z42d(:,:)
131          END DO
132       ENDIF
133    ELSE
134       clver='@!03'           ! dimg string identifier
135       ! note that version @!02 is optimized with respect to record length.
136       ! The vertical dep variable is reduced to klev instead of klev*jpnij :
137       !   this is OK for jpnij < 181 (jpk=46)
138       ! for more processors, irecl4 get huge and that's why we switch to '@!03':
139       !  In this case we just add an extra integer to the standard dimg structure,
140       !  which is a record number where the arrays nlci etc... starts (1 per record)
141       
142       !! Standard dimgproc (1 file per variable, all procs. write to this file )
143       !! * Open file
144       CALL ctl_opn(inum, cd_name,'UNKNOWN','UNFORMATTED','DIRECT',irecl4,numout,lwp)
145
146       !! * Write header on record #1
147       irecend=1 + klev*jpnij 
148       IF(lwp) WRITE(inum,REC=1 ) clver, cd_text, irecl4, &
149            &     jpi,jpj, klev, 1 , 1 ,            &
150            &     zwest, zsouth, zdx, zdy, zspval,  &
151            &     z4dep(1:klev),       &
152            &     ztimm,                            &
153            &     narea, jpnij,jpiglo,jpjglo,jpizoom, jpjzoom, irecend 
154       IF (lwp ) THEN
155         WRITE(inum,REC=irecend + 1 ) nlcit
156         WRITE(inum,REC=irecend + 2 ) nlcjt
157         WRITE(inum,REC=irecend + 3 ) nldit
158         WRITE(inum,REC=irecend + 4 ) nldjt
159         WRITE(inum,REC=irecend + 5 ) nleit
160         WRITE(inum,REC=irecend + 6 ) nlejt
161         WRITE(inum,REC=irecend + 7 ) nimppt
162         WRITE(inum,REC=irecend + 8 ) njmppt
163       ENDIF
164      !   &    ! extension to dimg for mpp output
165      !   &     nlcit,nlcjt, nldit, nldjt, nleit, nlejt, nimppt, njmppt  !
166
167       !! * Write klev levels
168       IF ( cd_type == 'I' ) THEN
169
170          DO jk = 1, klev
171             irec =1 + klev * (narea -1) + jk
172             z42d(:,:) = ptab(:,:,ksubi(jk))
173             WRITE(inum,REC=irec)  z42d(:,:)
174          END DO
175       ELSE
176          DO jk = 1, klev
177             irec =1 + klev * (narea -1) + jk
178             z42d(:,:) = ptab(:,:,jk)
179             WRITE(inum,REC=irec)  z42d(:,:)
180          END DO
181       ENDIF
182    ENDIF
183
184    !! * Close the file
185    CLOSE(inum)
186
187  END SUBROUTINE dia_wri_dimg
188
189#  else
190   !!----------------------------------------------------------------------
191   !!   Default option :                                       Empty module
192   !!----------------------------------------------------------------------
193CONTAINS
194
195   SUBROUTINE dia_wri_dimg( cd_name, cd_exper, ptab, klev, cd_type )
196      REAL, DIMENSION(:,:,:) :: ptab
197      INTEGER :: klev
198      CHARACTER(LEN=80) :: cd_name, cd_exper,cd_type
199      WRITE(*,*) ' This print must never occur ', cd_name, cd_exper,ptab, klev, cd_type
200      WRITE(*,*) ' this routine is here just for compilation '
201   END SUBROUTINE dia_wri_dimg
202# endif
203   !!======================================================================
204END MODULE diadimg