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.
icerst.F90 in branches/UKMO/dev_r8183_ICEMODEL_rstdate_test/NEMOGCM/NEMO/LIM_SRC_3 – NEMO

source: branches/UKMO/dev_r8183_ICEMODEL_rstdate_test/NEMOGCM/NEMO/LIM_SRC_3/icerst.F90 @ 8953

Last change on this file since 8953 was 8953, checked in by frrh, 4 years ago

First working version relative to NEMOv4.0+LIM3

File size: 12.8 KB
Line 
1MODULE icerst
2   !!======================================================================
3   !!                     ***  MODULE  icerst  ***
4   !!   sea-ice :  write/read the ice restart file
5   !!======================================================================
6   !! History:   3.0  ! 2005-04 (M. Vancoppenolle) Original code
7   !!             -   ! 2008-03 (C. Ethe) restart files in using IOM interface
8   !!            4.0  ! 2011-02 (G. Madec) dynamical allocation
9   !!----------------------------------------------------------------------
10#if defined key_lim3
11   !!----------------------------------------------------------------------
12   !!   'key_lim3'                                       ESIM sea-ice model
13   !!----------------------------------------------------------------------
14   !!   ice_rst_opn   : open  restart file
15   !!   ice_rst_write : write restart file
16   !!   ice_rst_read  : read  restart file
17   !!----------------------------------------------------------------------
18   USE ice            ! sea-ice variables
19   USE dom_oce        ! ocean domain
20   USE sbc_oce , ONLY : nn_fsbc
21   USE ioipsl, ONLY : ju2ymds    ! for calendar
22   USE icectl
23   !
24   USE in_out_manager ! I/O manager
25   USE iom            ! I/O manager library
26   USE lib_mpp        ! MPP library
27   USE lib_fortran    ! fortran utilities (glob_sum + no signed zero)
28
29   IMPLICIT NONE
30   PRIVATE
31
32   PUBLIC   ice_rst_opn     ! called by icestp
33   PUBLIC   ice_rst_write   ! called by icestp
34   PUBLIC   ice_rst_read    ! called by ice_init
35
36   !!----------------------------------------------------------------------
37   !! NEMO/ICE 4.0 , NEMO Consortium (2017)
38   !! $Id: icerst.F90 8411 2017-08-07 16:09:12Z clem $
39   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
40   !!----------------------------------------------------------------------
41CONTAINS
42
43   SUBROUTINE ice_rst_opn( kt )
44      !!----------------------------------------------------------------------
45      !!                    ***  ice_rst_opn  ***
46      !!
47      !! ** purpose  :   open restart file
48      !!----------------------------------------------------------------------
49      INTEGER             ::   iyear, imonth, iday
50      REAL (wp)           ::   zsec
51      REAL (wp)           ::   zfjulday      !!
52      INTEGER, INTENT(in) ::   kt       ! number of iteration
53      !
54      CHARACTER(len=20)   ::   clkt     ! ocean time-step define as a character
55      CHARACTER(len=50)   ::   clname   ! ice output restart file name
56      CHARACTER(len=256)  ::   clpath   ! full path to ice output restart file
57      !!----------------------------------------------------------------------
58      !
59      IF( kt == nit000 )   lrst_ice = .FALSE.   ! default definition
60
61      ! in order to get better performances with NetCDF format, we open and define the ice restart file
62      ! one ice time step before writing the data (-> at nitrst - 2*nn_fsbc + 1), except if we write ice
63      ! restart files every ice time step or if an ice restart file was writen at nitend - 2*nn_fsbc + 1
64      IF( kt == nitrst - 2*nn_fsbc + 1 .OR. nstock == nn_fsbc    &
65         &                             .OR. ( kt == nitend - nn_fsbc + 1 .AND. .NOT. lrst_ice ) ) THEN
66         IF( nitrst <= nitend .AND. nitrst > 0 ) THEN
67            ! beware of the format used to write kt (default is i8.8, that should be large enough...)
68
69            IF ( ln_rstdate ) THEN
70               zfjulday = fjulday + rdt / rday
71               IF( ABS(zfjulday - REAL(NINT(zfjulday),wp)) < 0.1 / rday )   zfjulday = REAL(NINT(zfjulday),wp)   ! avoid truncation error
72               CALL ju2ymds( zfjulday, iyear, imonth, iday, zsec )           
73               WRITE(clkt, '(i4.4,2i2.2)') iyear, imonth, iday 
74            ELSE
75          IF( nitrst > 999999999 ) THEN   
76                  WRITE(clkt, *       ) nitrst
77               ELSE             
78                  WRITE(clkt, '(i8.8)') nitrst
79               ENDIF     
80            ENDIF
81
82
83!            IF( nitrst > 99999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
84!            ELSE                           ;   WRITE(clkt, '(i8.8)') nitrst
85!            ENDIF
86            ! create the file
87            clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_icerst_out)
88            clpath = TRIM(cn_icerst_outdir) 
89            IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath)//'/'
90            IF(lwp) THEN
91               WRITE(numout,*)
92               SELECT CASE ( jprstlib )
93               CASE DEFAULT
94                  WRITE(numout,*) '             open ice restart NetCDF file: ',TRIM(clpath)//clname
95               END SELECT
96               IF( kt == nitrst - 2*nn_fsbc + 1 ) THEN
97                  WRITE(numout,*) '             kt = nitrst - 2*nn_fsbc + 1 = ', kt,' date= ', ndastp
98               ELSE
99                  WRITE(numout,*) '             kt = '                         , kt,' date= ', ndastp
100               ENDIF
101            ENDIF
102            !
103            CALL iom_open( TRIM(clpath)//TRIM(clname), numriw, ldwrt = .TRUE., kiolib = jprstlib )
104            lrst_ice = .TRUE.
105         ENDIF
106      ENDIF
107      !
108      IF( ln_icectl )   CALL ice_prt( kt, iiceprt, jiceprt, 1, ' - Beginning the time step - ' )   ! control print
109   END SUBROUTINE ice_rst_opn
110
111
112   SUBROUTINE ice_rst_write( kt )
113      !!----------------------------------------------------------------------
114      !!                    ***  ice_rst_write  ***
115      !!
116      !! ** purpose  :   write restart file
117      !!----------------------------------------------------------------------
118      INTEGER, INTENT(in) ::   kt     ! number of iteration
119      !!
120      INTEGER ::   jk ,jl   ! dummy loop indices
121      INTEGER ::   iter
122      CHARACTER(len=25) ::   znam
123      CHARACTER(len=2)  ::   zchar, zchar1
124      REAL(wp), DIMENSION(jpi,jpj) :: z2d
125      !!----------------------------------------------------------------------
126
127      iter = kt + nn_fsbc - 1   ! ice restarts are written at kt == nitrst - nn_fsbc + 1
128
129      IF( iter == nitrst ) THEN
130         IF(lwp) WRITE(numout,*)
131         IF(lwp) WRITE(numout,*) 'ice_rst_write : write ice restart file  kt =', kt
132         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~'         
133      ENDIF
134
135      ! Write in numriw (if iter == nitrst)
136      ! ------------------
137      !                                                                        ! calendar control
138      CALL iom_rstput( iter, nitrst, numriw, 'nn_fsbc', REAL( nn_fsbc, wp ) )      ! time-step
139      CALL iom_rstput( iter, nitrst, numriw, 'kt_ice' , REAL( iter   , wp ) )      ! date
140
141!!gm   It is possible and easy to define a 3D domain size (jpi,jpj,jpl) or use a SIZE( tab, DIM=3) in iom_rtput )
142!!gm         ===>>> just a simple   iom_rstput( iter, nitrst, numriw, 'v_i', v_i )  etc...
143!!gm   "just" ask Sebatien
144
145      ! Prognostic variables
146      DO jl = 1, jpl 
147         WRITE(zchar,'(I2.2)') jl
148         znam = 'v_i'//'_htc'//zchar
149         z2d(:,:) = v_i(:,:,jl)
150         CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! v_i
151         znam = 'v_s'//'_htc'//zchar
152         z2d(:,:) = v_s(:,:,jl)
153         CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! v_s
154         znam = 'sv_i'//'_htc'//zchar
155         z2d(:,:) = sv_i(:,:,jl)
156         CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! sv_i
157         znam = 'oa_i'//'_htc'//zchar
158         z2d(:,:) = oa_i(:,:,jl)
159         CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! oa_i
160         znam = 'a_i'//'_htc'//zchar
161         z2d(:,:) = a_i(:,:,jl)
162         CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! a_i
163         znam = 't_su'//'_htc'//zchar
164         z2d(:,:) = t_su(:,:,jl)
165         CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! t_su
166      END DO
167
168      ! MV MP 2016
169      IF ( nn_pnd_scheme > 0 ) THEN
170         DO jl = 1, jpl 
171            WRITE(zchar,'(I2.2)') jl
172            znam = 'a_ip'//'_htc'//zchar
173            z2d(:,:) = a_ip(:,:,jl)
174            CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! a_ip
175            znam = 'v_ip'//'_htc'//zchar
176            z2d(:,:) = v_ip(:,:,jl)
177            CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! v_ip
178         END DO
179      ENDIF
180      ! END MV MP 2016
181
182      DO jl = 1, jpl 
183         WRITE(zchar,'(I2.2)') jl
184         znam = 'tempt_sl1'//'_htc'//zchar
185         z2d(:,:) = e_s(:,:,1,jl)
186         CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! e_s
187         DO jk = 1, nlay_i 
188            WRITE(zchar1,'(I2.2)') jk
189            znam = 'tempt'//'_il'//zchar1//'_htc'//zchar
190            z2d(:,:) = e_i(:,:,jk,jl)
191            CALL iom_rstput( iter, nitrst, numriw, znam , z2d ) ! e_i
192         END DO
193      END DO
194
195      CALL iom_rstput( iter, nitrst, numriw, 'u_ice', u_ice ) ! u_ice
196      CALL iom_rstput( iter, nitrst, numriw, 'v_ice', v_ice ) ! v_ice
197     
198      ! close restart file
199      ! ------------------
200      IF( iter == nitrst ) THEN
201         CALL iom_close( numriw )
202         lrst_ice = .FALSE.
203      ENDIF
204      !
205   END SUBROUTINE ice_rst_write
206
207
208   SUBROUTINE ice_rst_read
209      !!----------------------------------------------------------------------
210      !!                    ***  ice_rst_read  ***
211      !!
212      !! ** purpose  :   read restart file
213      !!----------------------------------------------------------------------
214      INTEGER  :: jk, jl
215      REAL(wp) :: zfice, ziter
216      REAL(wp), DIMENSION(jpi,jpj) ::   z2d
217      CHARACTER(len=25) ::   znam
218      CHARACTER(len=2)  ::   zchar, zchar1
219      INTEGER           ::   jlibalt = jprstlib
220      LOGICAL           ::   llok
221      !!----------------------------------------------------------------------
222
223      IF(lwp) THEN
224         WRITE(numout,*)
225         WRITE(numout,*) 'ice_rst_read: read ice NetCDF restart file'
226         WRITE(numout,*) '~~~~~~~~~~~~'
227      ENDIF
228
229      CALL iom_open ( TRIM(cn_icerst_indir)//'/'//cn_icerst_in, numrir, kiolib = jprstlib )
230
231      CALL iom_get( numrir, 'nn_fsbc', zfice )
232      CALL iom_get( numrir, 'kt_ice' , ziter )   
233      IF(lwp) WRITE(numout,*) '   read ice restart file at time step    : ', ziter
234      IF(lwp) WRITE(numout,*) '   in any case we force it to nit000 - 1 : ', nit000 - 1
235
236      ! Control of date
237      IF( ( nit000 - NINT(ziter) ) /= 1 .AND. ABS( nrstdt ) == 1 )   &
238         &     CALL ctl_stop( 'ice_rst_read ===>>>> : problem with nit000 in ice restart',  &
239         &                   '   verify the file or rerun with the value 0 for the',        &
240         &                   '   control of time parameter  nrstdt' )
241      IF( NINT(zfice) /= nn_fsbc          .AND. ABS( nrstdt ) == 1 )   &
242         &     CALL ctl_stop( 'ice_rst_read ===>>>> : problem with nn_fsbc in ice restart',  &
243         &                   '   verify the file or rerun with the value 0 for the',         &
244         &                   '   control of time parameter  nrstdt' )
245
246      ! Prognostic variables
247      DO jl = 1, jpl 
248         WRITE(zchar,'(I2.2)') jl
249         znam = 'v_i'//'_htc'//zchar
250         CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
251         v_i(:,:,jl) = z2d(:,:)
252         znam = 'v_s'//'_htc'//zchar
253         CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
254         v_s(:,:,jl) = z2d(:,:) 
255         znam = 'sv_i'//'_htc'//zchar
256         CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
257         sv_i(:,:,jl) = z2d(:,:)
258         znam = 'oa_i'//'_htc'//zchar
259         CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
260         oa_i(:,:,jl) = z2d(:,:)
261         znam = 'a_i'//'_htc'//zchar
262         CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
263         a_i(:,:,jl) = z2d(:,:)
264         znam = 't_su'//'_htc'//zchar
265         CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
266         t_su(:,:,jl) = z2d(:,:)
267      END DO
268
269      ! MV MP 2016
270      IF ( nn_pnd_scheme > 0 ) THEN
271         DO jl = 1, jpl 
272            WRITE(zchar,'(I2.2)') jl
273            znam = 'a_ip'//'_htc'//zchar
274            CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
275            a_ip(:,:,jl) = z2d(:,:)
276            znam = 'v_ip'//'_htc'//zchar
277            CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
278            v_ip(:,:,jl) = z2d(:,:)
279         END DO
280      ENDIF
281      ! END MV MP 2016
282
283      DO jl = 1, jpl 
284         WRITE(zchar,'(I2.2)') jl
285         znam = 'tempt_sl1'//'_htc'//zchar
286         CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
287         e_s(:,:,1,jl) = z2d(:,:)
288         DO jk = 1, nlay_i 
289            WRITE(zchar1,'(I2.2)') jk
290            znam = 'tempt'//'_il'//zchar1//'_htc'//zchar
291            CALL iom_get( numrir, jpdom_autoglo, znam , z2d )
292            e_i(:,:,jk,jl) = z2d(:,:)
293         END DO
294      END DO
295
296      CALL iom_get( numrir, jpdom_autoglo, 'u_ice', u_ice )
297      CALL iom_get( numrir, jpdom_autoglo, 'v_ice', v_ice )
298
299   END SUBROUTINE ice_rst_read
300
301#else
302   !!----------------------------------------------------------------------
303   !!   Default option :       Empty module           NO ESIM sea-ice model
304   !!----------------------------------------------------------------------
305#endif
306
307   !!======================================================================
308END MODULE icerst
Note: See TracBrowser for help on using the repository browser.