source: NEMO/branches/UKMO/NEMO_4.0.1_mirror/src/ICE/icerst.F90 @ 11715

Last change on this file since 11715 was 11715, checked in by davestorkey, 14 months ago

UKMO/NEMO_4.0.1_mirror : Remove SVN keywords.

File size: 13.0 KB
Line 
1MODULE icerst
2   !!======================================================================
3   !!                     ***  MODULE  icerst  ***
4   !!   sea-ice :  write/read the ice restart file
5   !!======================================================================
6   !! History:   4.0  !  2018     (many people)      SI3 [aka Sea Ice cube]
7   !!----------------------------------------------------------------------
8#if defined key_si3
9   !!----------------------------------------------------------------------
10   !!   'key_si3'                                       SI3 sea-ice model
11   !!----------------------------------------------------------------------
12   !!   ice_rst_opn   : open  restart file
13   !!   ice_rst_write : write restart file
14   !!   ice_rst_read  : read  restart file
15   !!----------------------------------------------------------------------
16   USE ice            ! sea-ice: variables
17   USE dom_oce        ! ocean domain
18   USE phycst  , ONLY : rt0
19   USE sbc_oce , ONLY : nn_fsbc, ln_cpl
20   USE iceistate      ! sea-ice: initial state
21   USE icectl         ! sea-ice: control
22   !
23   USE in_out_manager ! I/O manager
24   USE iom            ! I/O manager library
25   USE lib_mpp        ! MPP library
26   USE lib_fortran    ! fortran utilities (glob_sum + no signed zero)
27
28   IMPLICIT NONE
29   PRIVATE
30
31   PUBLIC   ice_rst_opn     ! called by icestp
32   PUBLIC   ice_rst_write   ! called by icestp
33   PUBLIC   ice_rst_read    ! called by ice_init
34
35   !!----------------------------------------------------------------------
36   !! NEMO/ICE 4.0 , NEMO Consortium (2018)
37   !! $Id$
38   !! Software governed by the CeCILL license (see ./LICENSE)
39   !!----------------------------------------------------------------------
40CONTAINS
41
42   SUBROUTINE ice_rst_opn( kt )
43      !!----------------------------------------------------------------------
44      !!                    ***  ice_rst_opn  ***
45      !!
46      !! ** purpose  :   open restart file
47      !!----------------------------------------------------------------------
48      INTEGER, INTENT(in) ::   kt       ! number of iteration
49      !
50      CHARACTER(len=20)   ::   clkt     ! ocean time-step define as a character
51      CHARACTER(len=50)   ::   clname   ! ice output restart file name
52      CHARACTER(len=256)  ::   clpath   ! full path to ice output restart file
53      !!----------------------------------------------------------------------
54      !
55      IF( kt == nit000 )   lrst_ice = .FALSE.   ! default definition
56
57      IF( ln_rst_list .OR. nn_stock /= -1 ) THEN
58      ! in order to get better performances with NetCDF format, we open and define the ice restart file
59      ! one ice time step before writing the data (-> at nitrst - 2*nn_fsbc + 1), except if we write ice
60      ! restart files every ice time step or if an ice restart file was writen at nitend - 2*nn_fsbc + 1
61      IF( kt == nitrst - 2*nn_fsbc + 1 .OR. nn_stock == nn_fsbc    &
62         &                             .OR. ( kt == nitend - nn_fsbc + 1 .AND. .NOT. lrst_ice ) ) THEN
63         IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
64            ! beware of the format used to write kt (default is i8.8, that should be large enough...)
65            IF( nitrst > 99999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
66            ELSE                           ;   WRITE(clkt, '(i8.8)') nitrst
67            ENDIF
68            ! create the file
69            clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_icerst_out)
70            clpath = TRIM(cn_icerst_outdir) 
71            IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath)//'/'
72            IF(lwp) THEN
73               WRITE(numout,*)
74               WRITE(numout,*) '             open ice restart NetCDF file: ',TRIM(clpath)//clname
75               IF( kt == nitrst - 2*nn_fsbc + 1 ) THEN
76                  WRITE(numout,*) '             kt = nitrst - 2*nn_fsbc + 1 = ', kt,' date= ', ndastp
77               ELSE
78                  WRITE(numout,*) '             kt = '                         , kt,' date= ', ndastp
79               ENDIF
80            ENDIF
81            !
82            CALL iom_open( TRIM(clpath)//TRIM(clname), numriw, ldwrt = .TRUE., kdlev = jpl )
83            lrst_ice = .TRUE.
84         ENDIF
85      ENDIF
86      ENDIF
87      !
88      IF( ln_icectl )   CALL ice_prt( kt, iiceprt, jiceprt, 1, ' - Beginning the time step - ' )   ! control print
89      !
90   END SUBROUTINE ice_rst_opn
91
92
93   SUBROUTINE ice_rst_write( kt )
94      !!----------------------------------------------------------------------
95      !!                    ***  ice_rst_write  ***
96      !!
97      !! ** purpose  :   write restart file
98      !!----------------------------------------------------------------------
99      INTEGER, INTENT(in) ::   kt     ! number of iteration
100      !!
101      INTEGER ::   jk    ! dummy loop indices
102      INTEGER ::   iter
103      CHARACTER(len=25) ::   znam
104      CHARACTER(len=2)  ::   zchar, zchar1
105      REAL(wp), DIMENSION(jpi,jpj,jpl) ::   z3d   ! 3D workspace
106      !!----------------------------------------------------------------------
107
108      iter = kt + nn_fsbc - 1   ! ice restarts are written at kt == nitrst - nn_fsbc + 1
109
110      IF( iter == nitrst ) THEN
111         IF(lwp) WRITE(numout,*)
112         IF(lwp) WRITE(numout,*) 'ice_rst_write : write ice restart file  kt =', kt
113         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~'         
114      ENDIF
115
116      ! Write in numriw (if iter == nitrst)
117      ! ------------------
118      !                                                                        ! calendar control
119      CALL iom_rstput( iter, nitrst, numriw, 'nn_fsbc', REAL( nn_fsbc, wp ) )      ! time-step
120      CALL iom_rstput( iter, nitrst, numriw, 'kt_ice' , REAL( iter   , wp ) )      ! date
121      CALL iom_delay_rst( 'WRITE', 'ICE', numriw )   ! save only ice delayed global communication variables
122
123      ! Prognostic variables
124      CALL iom_rstput( iter, nitrst, numriw, 'v_i'  , v_i   )
125      CALL iom_rstput( iter, nitrst, numriw, 'v_s'  , v_s   )
126      CALL iom_rstput( iter, nitrst, numriw, 'sv_i' , sv_i  )
127      CALL iom_rstput( iter, nitrst, numriw, 'a_i'  , a_i   )
128      CALL iom_rstput( iter, nitrst, numriw, 't_su' , t_su  )
129      CALL iom_rstput( iter, nitrst, numriw, 'u_ice', u_ice )
130      CALL iom_rstput( iter, nitrst, numriw, 'v_ice', v_ice )
131      CALL iom_rstput( iter, nitrst, numriw, 'oa_i' , oa_i  )
132      CALL iom_rstput( iter, nitrst, numriw, 'a_ip' , a_ip  )
133      CALL iom_rstput( iter, nitrst, numriw, 'v_ip' , v_ip  )
134      ! Snow enthalpy
135      DO jk = 1, nlay_s 
136         WRITE(zchar1,'(I2.2)') jk
137         znam = 'e_s'//'_l'//zchar1
138         z3d(:,:,:) = e_s(:,:,jk,:)
139         CALL iom_rstput( iter, nitrst, numriw, znam , z3d )
140      END DO
141      ! Ice enthalpy
142      DO jk = 1, nlay_i 
143         WRITE(zchar1,'(I2.2)') jk
144         znam = 'e_i'//'_l'//zchar1
145         z3d(:,:,:) = e_i(:,:,jk,:)
146         CALL iom_rstput( iter, nitrst, numriw, znam , z3d )
147      END DO
148      ! fields needed for Met Office (Jules) coupling
149      IF( ln_cpl ) THEN
150         CALL iom_rstput( iter, nitrst, numriw, 'cnd_ice', cnd_ice )
151         CALL iom_rstput( iter, nitrst, numriw, 't1_ice' , t1_ice  )
152      ENDIF
153      !
154
155      ! close restart file
156      ! ------------------
157      IF( iter == nitrst ) THEN
158         CALL iom_close( numriw )
159         lrst_ice = .FALSE.
160      ENDIF
161      !
162   END SUBROUTINE ice_rst_write
163
164
165   SUBROUTINE ice_rst_read
166      !!----------------------------------------------------------------------
167      !!                    ***  ice_rst_read  ***
168      !!
169      !! ** purpose  :   read restart file
170      !!----------------------------------------------------------------------
171      INTEGER           ::   jk
172      LOGICAL           ::   llok
173      INTEGER           ::   id0, id1, id2, id3, id4   ! local integer
174      CHARACTER(len=25) ::   znam
175      CHARACTER(len=2)  ::   zchar, zchar1
176      REAL(wp)          ::   zfice, ziter
177      REAL(wp), DIMENSION(jpi,jpj,jpl) ::   z3d   ! 3D workspace
178      !!----------------------------------------------------------------------
179
180      IF(lwp) THEN
181         WRITE(numout,*)
182         WRITE(numout,*) 'ice_rst_read: read ice NetCDF restart file'
183         WRITE(numout,*) '~~~~~~~~~~~~'
184      ENDIF
185
186      CALL iom_open ( TRIM(cn_icerst_indir)//'/'//cn_icerst_in, numrir, kdlev = jpl )
187
188      ! test if v_i exists
189      id0 = iom_varid( numrir, 'v_i' , ldstop = .FALSE. )
190
191      !                    ! ------------------------------ !
192      IF( id0 > 0 ) THEN   ! == case of a normal restart == !
193         !                 ! ------------------------------ !
194         
195         ! Time info
196         CALL iom_get( numrir, 'nn_fsbc', zfice )
197         CALL iom_get( numrir, 'kt_ice' , ziter )   
198         IF(lwp) WRITE(numout,*) '   read ice restart file at time step    : ', ziter
199         IF(lwp) WRITE(numout,*) '   in any case we force it to nit000 - 1 : ', nit000 - 1
200
201         ! Control of date
202         IF( ( nit000 - NINT(ziter) ) /= 1 .AND. ABS( nrstdt ) == 1 )   &
203            &     CALL ctl_stop( 'ice_rst_read ===>>>> : problem with nit000 in ice restart',  &
204            &                   '   verify the file or rerun with the value 0 for the',        &
205            &                   '   control of time parameter  nrstdt' )
206         IF( NINT(zfice) /= nn_fsbc          .AND. ABS( nrstdt ) == 1 )   &
207            &     CALL ctl_stop( 'ice_rst_read ===>>>> : problem with nn_fsbc in ice restart',  &
208            &                   '   verify the file or rerun with the value 0 for the',         &
209            &                   '   control of time parameter  nrstdt' )
210
211         ! --- mandatory fields --- !
212         CALL iom_get( numrir, jpdom_autoglo, 'v_i'  , v_i   )
213         CALL iom_get( numrir, jpdom_autoglo, 'v_s'  , v_s   )
214         CALL iom_get( numrir, jpdom_autoglo, 'sv_i' , sv_i  )
215         CALL iom_get( numrir, jpdom_autoglo, 'a_i'  , a_i   )
216         CALL iom_get( numrir, jpdom_autoglo, 't_su' , t_su  )
217         CALL iom_get( numrir, jpdom_autoglo, 'u_ice', u_ice )
218         CALL iom_get( numrir, jpdom_autoglo, 'v_ice', v_ice )
219         ! Snow enthalpy
220         DO jk = 1, nlay_s
221            WRITE(zchar1,'(I2.2)') jk
222            znam = 'e_s'//'_l'//zchar1
223            CALL iom_get( numrir, jpdom_autoglo, znam , z3d )
224            e_s(:,:,jk,:) = z3d(:,:,:)
225         END DO
226         ! Ice enthalpy
227         DO jk = 1, nlay_i
228            WRITE(zchar1,'(I2.2)') jk
229            znam = 'e_i'//'_l'//zchar1
230            CALL iom_get( numrir, jpdom_autoglo, znam , z3d )
231            e_i(:,:,jk,:) = z3d(:,:,:)
232         END DO
233         ! -- optional fields -- !
234         ! ice age
235         id1 = iom_varid( numrir, 'oa_i' , ldstop = .FALSE. )
236         IF( id1 > 0 ) THEN                       ! fields exist
237            CALL iom_get( numrir, jpdom_autoglo, 'oa_i', oa_i )
238         ELSE                                     ! start from rest
239            IF(lwp) WRITE(numout,*) '   ==>>   previous run without ice age output then set it to zero'
240            oa_i(:,:,:) = 0._wp
241         ENDIF
242         ! melt ponds
243         id2 = iom_varid( numrir, 'a_ip' , ldstop = .FALSE. )
244         IF( id2 > 0 ) THEN                       ! fields exist
245            CALL iom_get( numrir, jpdom_autoglo, 'a_ip' , a_ip )
246            CALL iom_get( numrir, jpdom_autoglo, 'v_ip' , v_ip )
247         ELSE                                     ! start from rest
248            IF(lwp) WRITE(numout,*) '   ==>>   previous run without melt ponds output then set it to zero'
249            a_ip(:,:,:) = 0._wp
250            v_ip(:,:,:) = 0._wp
251         ENDIF
252         ! fields needed for Met Office (Jules) coupling
253         IF( ln_cpl ) THEN
254            id3 = iom_varid( numrir, 'cnd_ice' , ldstop = .FALSE. )
255            id4 = iom_varid( numrir, 't1_ice'  , ldstop = .FALSE. )
256            IF( id3 > 0 .AND. id4 > 0 ) THEN         ! fields exist
257               CALL iom_get( numrir, jpdom_autoglo, 'cnd_ice', cnd_ice )
258               CALL iom_get( numrir, jpdom_autoglo, 't1_ice' , t1_ice  )
259            ELSE                                     ! start from rest
260               IF(lwp) WRITE(numout,*) '   ==>>   previous run without conductivity output then set it to zero'
261               cnd_ice(:,:,:) = 0._wp
262               t1_ice (:,:,:) = rt0
263            ENDIF
264         ENDIF
265
266         CALL iom_delay_rst( 'READ', 'ICE', numrir )   ! read only ice delayed global communication variables
267
268         !                 ! ---------------------------------- !
269      ELSE                 ! == case of a simplified restart == !
270         !                 ! ---------------------------------- !
271         CALL ctl_warn('ice_rst_read: you are using a simplified ice restart')
272         !
273         CALL ice_istate_init
274         CALL ice_istate( nit000 )
275         !
276         IF( .NOT.ln_iceini .OR. .NOT.ln_iceini_file ) &
277            &   CALL ctl_stop('STOP', 'ice_rst_read: you need ln_ice_ini=T and ln_iceini_file=T')
278         !
279      ENDIF
280
281   END SUBROUTINE ice_rst_read
282
283#else
284   !!----------------------------------------------------------------------
285   !!   Default option :       Empty module           NO SI3 sea-ice model
286   !!----------------------------------------------------------------------
287#endif
288
289   !!======================================================================
290END MODULE icerst
Note: See TracBrowser for help on using the repository browser.