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.
restart.F90 in branches/UKMO/dev_r5107_restart_date/NEMOGCM/NEMO/OPA_SRC/IOM – NEMO

source: branches/UKMO/dev_r5107_restart_date/NEMOGCM/NEMO/OPA_SRC/IOM/restart.F90 @ 5494

Last change on this file since 5494 was 5494, checked in by dancopsey, 9 years ago

Upgraded NEMO3,5 branch dev/hadco/vn3.5_beta_restart_date to this revision.
File size: 13.8 KB
Line 
1MODULE restart
2   !!======================================================================
3   !!                     ***  MODULE  restart  ***
4   !! Ocean restart :  write the ocean restart file
5   !!======================================================================
6   !! History :  OPA  !  1999-11  (M. Imbard)  Original code
7   !!   NEMO     1.0  !  2002-08  (G. Madec)  F90: Free form
8   !!            2.0  !  2006-07  (S. Masson)  use IOM for restart
9   !!            3.3  !  2010-04  (M. Leclair, G. Madec)  modified LF-RA
10   !!            - -  !  2010-10  (C. Ethe, G. Madec) TRC-TRA merge (T-S in 4D)
11   !!----------------------------------------------------------------------
12
13   !!----------------------------------------------------------------------
14   !!   rst_opn    : open the ocean restart file
15   !!   rst_write  : write the ocean restart file
16   !!   rst_read   : read the ocean restart file
17   !!----------------------------------------------------------------------
18   USE oce             ! ocean dynamics and tracers
19   USE dom_oce         ! ocean space and time domain
20   USE phycst          ! physical constants
21   USE in_out_manager  ! I/O manager
22   USE iom             ! I/O module
23   USE ioipsl, ONLY : ju2ymds    ! for calendar
24   USE eosbn2          ! equation of state            (eos bn2 routine)
25   USE trdmxl_oce      ! ocean active mixed layer tracers trends variables
26   USE divcur          ! hor. divergence and curl      (div & cur routines)
27   USE sbc_ice, ONLY : lk_lim3
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   rst_opn         ! routine called by step module
33   PUBLIC   rst_write       ! routine called by step module
34   PUBLIC   rst_read        ! routine called by istate module
35   PUBLIC   rst_read_open   ! routine called in rst_read and (possibly) in dom_vvl_init
36
37   !! * Substitutions
38#  include "domzgr_substitute.h90"
39#  include "vectopt_loop_substitute.h90"
40   !!----------------------------------------------------------------------
41   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
42   !! $Id$
43   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
44   !!----------------------------------------------------------------------
45CONTAINS
46
47   SUBROUTINE rst_opn( kt )
48      !!---------------------------------------------------------------------
49      !!                   ***  ROUTINE rst_opn  ***
50      !!                     
51      !! ** Purpose : + initialization (should be read in the namelist) of nitrst
52      !!              + open the restart when we are one time step before nitrst
53      !!                   - restart header is defined when kt = nitrst-1
54      !!                   - restart data  are written when kt = nitrst
55      !!              + define lrst_oce to .TRUE. when we need to define or write the restart
56      !!----------------------------------------------------------------------
57      INTEGER, INTENT(in) ::   kt     ! ocean time-step
58      INTEGER             ::   iyear, imonth, iday
59      REAL (wp)           ::   zsec
60      !!
61      CHARACTER(LEN=20)   ::   clkt     ! ocean time-step deine as a character
62      CHARACTER(LEN=50)   ::   clname   ! ice output restart file name
63      !!----------------------------------------------------------------------
64      !
65      IF( kt == nit000 ) THEN   ! default definitions
66         lrst_oce = .FALSE.   
67         nitrst = nitend
68      ENDIF
69      IF( MOD( kt - 1, nstock ) == 0 ) THEN   
70         ! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
71         nitrst = kt + nstock - 1                  ! define the next value of nitrst for restart writing
72         IF( nitrst > nitend )   nitrst = nitend   ! make sure we write a restart at the end of the run
73      ENDIF
74      ! to get better performances with NetCDF format:
75      ! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
76      ! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
77      IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
78         ! beware of the format used to write kt (default is i8.8, that should be large enough...)
79         IF ( ln_rstdate ) THEN
80            CALL ju2ymds( fjulday + rdttra(1) / rday, iyear, imonth, iday, zsec )           
81            WRITE(clkt, '(i4.4,2i2.2)') iyear, imonth, iday
82         ELSE
83            IF( nitrst > 999999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
84            ELSE                            ;   WRITE(clkt, '(i8.8)') nitrst
85            ENDIF
86         ENDIF
87         ! create the file
88         clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_ocerst_out)
89         IF(lwp) THEN
90            WRITE(numout,*)
91            SELECT CASE ( jprstlib )
92            CASE ( jprstdimg )   ;   WRITE(numout,*) '             open ocean restart binary file: '//clname
93            CASE DEFAULT         ;   WRITE(numout,*) '             open ocean restart NetCDF file: '//clname
94            END SELECT
95            IF ( snc4set%luse )      WRITE(numout,*) '             opened for NetCDF4 chunking and compression'
96            IF( kt == nitrst - 1 ) THEN   ;   WRITE(numout,*) '             kt = nitrst - 1 = ', kt
97            ELSE                          ;   WRITE(numout,*) '             kt = '             , kt
98            ENDIF
99         ENDIF
100         !
101         CALL iom_open( clname, numrow, ldwrt = .TRUE., kiolib = jprstlib )
102         lrst_oce = .TRUE.
103      ENDIF
104      !
105   END SUBROUTINE rst_opn
106
107
108   SUBROUTINE rst_write( kt )
109      !!---------------------------------------------------------------------
110      !!                   ***  ROUTINE rstwrite  ***
111      !!                     
112      !! ** Purpose :   Write restart fields in the format corresponding to jprstlib
113      !!
114      !! ** Method  :   Write in numrow when kt == nitrst in NetCDF
115      !!              file, save fields which are necessary for restart
116      !!----------------------------------------------------------------------
117      INTEGER, INTENT(in) ::   kt   ! ocean time-step
118      !!----------------------------------------------------------------------
119
120                     CALL iom_rstput( kt, nitrst, numrow, 'rdt'    , rdt       )   ! dynamics time step
121                     CALL iom_rstput( kt, nitrst, numrow, 'rdttra1', rdttra(1) )   ! surface tracer time step
122
123                     CALL iom_rstput( kt, nitrst, numrow, 'ub'     , ub        )     ! before fields
124                     CALL iom_rstput( kt, nitrst, numrow, 'vb'     , vb        )
125                     CALL iom_rstput( kt, nitrst, numrow, 'tb'     , tsb(:,:,:,jp_tem) )
126                     CALL iom_rstput( kt, nitrst, numrow, 'sb'     , tsb(:,:,:,jp_sal) )
127                     CALL iom_rstput( kt, nitrst, numrow, 'rotb'   , rotb      )
128                     CALL iom_rstput( kt, nitrst, numrow, 'hdivb'  , hdivb     )
129                     CALL iom_rstput( kt, nitrst, numrow, 'sshb'   , sshb      )
130                     !
131      IF( lk_lim3 )  CALL iom_rstput( kt, nitrst, numrow, 'fse3t_b', fse3t_b(:,:,:) )
132                     !
133                     CALL iom_rstput( kt, nitrst, numrow, 'un'     , un        )     ! now fields
134                     CALL iom_rstput( kt, nitrst, numrow, 'vn'     , vn        )
135                     CALL iom_rstput( kt, nitrst, numrow, 'tn'     , tsn(:,:,:,jp_tem) )
136                     CALL iom_rstput( kt, nitrst, numrow, 'sn'     , tsn(:,:,:,jp_sal) )
137                     CALL iom_rstput( kt, nitrst, numrow, 'rotn'   , rotn      )
138                     CALL iom_rstput( kt, nitrst, numrow, 'hdivn'  , hdivn     )
139                     CALL iom_rstput( kt, nitrst, numrow, 'sshn'   , sshn      )
140                     CALL iom_rstput( kt, nitrst, numrow, 'rhop'   , rhop      )
141#if defined key_zdfkpp
142                     CALL iom_rstput( kt, nitrst, numrow, 'rhd'    , rhd       )
143#endif
144                  IF( lk_lim3 ) THEN
145                     CALL iom_rstput( kt, nitrst, numrow, 'fraqsr_1lev'  , fraqsr_1lev     ) !clem modif
146                  ENDIF
147      IF( kt == nitrst ) THEN
148         CALL iom_close( numrow )     ! close the restart file (only at last time step)
149!!gm         IF( .NOT. lk_trdmld )   lrst_oce = .FALSE.
150!!gm  not sure what to do here   ===>>>  ask to Sebastian
151         lrst_oce = .FALSE.
152      ENDIF
153      !
154   END SUBROUTINE rst_write
155
156
157   SUBROUTINE rst_read_open
158      !!----------------------------------------------------------------------
159      !!                   ***  ROUTINE rst_read_open  ***
160      !!
161      !! ** Purpose :   Open read files for restart (format fixed by jprstlib )
162      !!
163      !! ** Method  :   Use a non-zero, positive value of numror to assess whether or not
164      !!                the file has already been opened
165      !!----------------------------------------------------------------------
166      INTEGER  ::   jlibalt = jprstlib
167      LOGICAL  ::   llok
168      !!----------------------------------------------------------------------
169      !
170      IF( numror <= 0 ) THEN
171         IF(lwp) THEN                                             ! Contol prints
172            WRITE(numout,*)
173            SELECT CASE ( jprstlib )
174            CASE ( jpnf90    )   ;   WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
175            CASE ( jprstdimg )   ;   WRITE(numout,*) 'rst_read : read oce binary restart file'
176            END SELECT
177            IF ( snc4set%luse )      WRITE(numout,*) 'rst_read : configured with NetCDF4 support'
178            WRITE(numout,*) '~~~~~~~~'
179         ENDIF
180
181         IF ( jprstlib == jprstdimg ) THEN
182           ! eventually read netcdf file (monobloc)  for restarting on different number of processors
183           ! if {cn_ocerst_in}.nc exists, then set jlibalt to jpnf90
184           INQUIRE( FILE = TRIM(cn_ocerst_in)//'.nc', EXIST = llok )
185           IF ( llok ) THEN ; jlibalt = jpnf90  ; ELSE ; jlibalt = jprstlib ; ENDIF
186         ENDIF
187         CALL iom_open( cn_ocerst_in, numror, kiolib = jlibalt )
188      ENDIF
189   END SUBROUTINE rst_read_open
190
191   SUBROUTINE rst_read
192      !!----------------------------------------------------------------------
193      !!                   ***  ROUTINE rst_read  ***
194      !!
195      !! ** Purpose :   Read files for restart (format fixed by jprstlib )
196      !!
197      !! ** Method  :   Read in restart.nc file fields which are necessary for restart
198      !!----------------------------------------------------------------------
199      REAL(wp) ::   zrdt, zrdttra1
200      INTEGER  ::   jk
201      LOGICAL  ::   llok
202      !!----------------------------------------------------------------------
203
204      CALL rst_read_open           ! open restart for reading (if not already opened)
205
206      ! Check dynamics and tracer time-step consistency and force Euler restart if changed
207      IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 )   THEN
208         CALL iom_get( numror, 'rdt', zrdt )
209         IF( zrdt /= rdt )   neuler = 0
210      ENDIF
211      IF( iom_varid( numror, 'rdttra1', ldstop = .FALSE. ) > 0 )   THEN
212         CALL iom_get( numror, 'rdttra1', zrdttra1 )
213         IF( zrdttra1 /= rdttra(1) )   neuler = 0
214      ENDIF
215      !
216      IF( iom_varid( numror, 'ub', ldstop = .FALSE. ) > 0 ) THEN
217         CALL iom_get( numror, jpdom_autoglo, 'ub'     , ub      )   ! before fields
218         CALL iom_get( numror, jpdom_autoglo, 'vb'     , vb      )
219         CALL iom_get( numror, jpdom_autoglo, 'tb'     , tsb(:,:,:,jp_tem) )
220         CALL iom_get( numror, jpdom_autoglo, 'sb'     , tsb(:,:,:,jp_sal) )
221         CALL iom_get( numror, jpdom_autoglo, 'rotb'   , rotb    )
222         CALL iom_get( numror, jpdom_autoglo, 'hdivb'  , hdivb   )
223         CALL iom_get( numror, jpdom_autoglo, 'sshb'   , sshb    )
224         IF( lk_lim3 )   CALL iom_get( numror, jpdom_autoglo, 'fse3t_b', fse3t_b(:,:,:) )
225      ELSE
226         neuler = 0
227      ENDIF
228      !
229      CALL iom_get( numror, jpdom_autoglo, 'un'     , un      )   ! now    fields
230      CALL iom_get( numror, jpdom_autoglo, 'vn'     , vn      )
231      CALL iom_get( numror, jpdom_autoglo, 'tn'     , tsn(:,:,:,jp_tem) )
232      CALL iom_get( numror, jpdom_autoglo, 'sn'     , tsn(:,:,:,jp_sal) )
233      CALL iom_get( numror, jpdom_autoglo, 'sshn'   , sshn    )
234      IF( iom_varid( numror, 'rotn', ldstop = .FALSE. ) > 0 ) THEN
235         CALL iom_get( numror, jpdom_autoglo, 'rotn'   , rotn    )
236         CALL iom_get( numror, jpdom_autoglo, 'hdivn'  , hdivn   )
237      ELSE
238         CALL div_cur( 0 )                              ! Horizontal divergence & Relative vorticity
239      ENDIF
240      IF( iom_varid( numror, 'rhop', ldstop = .FALSE. ) > 0 ) THEN
241         CALL iom_get( numror, jpdom_autoglo, 'rhop'   , rhop    )   ! now    potential density
242      ELSE
243         CALL eos    ( tsn, rhd, rhop, fsdept_n(:,:,:) )   
244      ENDIF
245#if defined key_zdfkpp
246      IF( iom_varid( numror, 'rhd', ldstop = .FALSE. ) > 0 ) THEN
247         CALL iom_get( numror, jpdom_autoglo, 'rhd'    , rhd     )   ! now    in situ density anomaly
248      ELSE
249         CALL eos( tsn, rhd, fsdept_n(:,:,:) )   ! compute rhd
250      ENDIF
251#endif
252      !
253      IF( neuler == 0 ) THEN                                  ! Euler restart (neuler=0)
254         tsb  (:,:,:,:) = tsn  (:,:,:,:)                             ! all before fields set to now values
255         ub   (:,:,:)   = un   (:,:,:)
256         vb   (:,:,:)   = vn   (:,:,:)
257         rotb (:,:,:)   = rotn (:,:,:)
258         hdivb(:,:,:)   = hdivn(:,:,:)
259         sshb (:,:)     = sshn (:,:)
260
261         IF( lk_vvl ) THEN
262            DO jk = 1, jpk
263               fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
264            END DO
265         ENDIF
266
267         IF( lk_lim3 .AND. .NOT. lk_vvl ) THEN
268            DO jk = 1, jpk
269               fse3t_b(:,:,jk) = fse3t_n(:,:,jk)
270            END DO
271         ENDIF
272
273      ENDIF
274      !
275      IF( lk_lim3 ) THEN
276         CALL iom_get( numror, jpdom_autoglo, 'fraqsr_1lev' , fraqsr_1lev )
277      ENDIF
278      !
279   END SUBROUTINE rst_read
280
281   !!=====================================================================
282END MODULE restart
Note: See TracBrowser for help on using the repository browser.