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.
limrst_2.F90 in branches/UKMO/DEV_r5107_dynvor_updates/NEMOGCM/NEMO/LIM_SRC_2 – NEMO

source: branches/UKMO/DEV_r5107_dynvor_updates/NEMOGCM/NEMO/LIM_SRC_2/limrst_2.F90 @ 5256

Last change on this file since 5256 was 5256, checked in by mikebell, 9 years ago

Clean up key words

File size: 15.0 KB
Line 
1MODULE limrst_2
2   !!======================================================================
3   !!                     ***  MODULE  limrst_2  ***
4   !! Ice restart :  write the ice restart file
5   !!======================================================================
6   !! History :  2.0  !  01-04  (C. Ethe, G. Madec)  Original code
7   !!                 !  06-07  (S. Masson)  use IOM for restart read/write
8   !!            3.3  !  09-05  (G.Garric) addition of the lim2_evp case
9   !!----------------------------------------------------------------------
10#if defined key_lim2
11   !!----------------------------------------------------------------------
12   !!   'key_lim2' :                                  LIM 2.0 sea-ice model
13   !!----------------------------------------------------------------------
14   !!   lim_rst_opn_2   : open ice restart file
15   !!   lim_rst_write_2 : write of the ice restart file
16   !!   lim_rst_read_2  : read  the ice restart file
17   !!----------------------------------------------------------------------
18   USE dom_oce          ! ocean domain
19   USE ice_2            ! LIM-2: sea-ice variables
20   USE sbc_oce          ! Surface Boundary Condition: ocean
21   USE sbc_ice          ! Surface Boundary Condition: sea-ice
22   USE in_out_manager   ! I/O manager
23   USE iom              ! I/O library
24
25   IMPLICIT NONE
26   PRIVATE
27
28   PUBLIC   lim_rst_opn_2     ! routine called by sbcice_lim_2.F90
29   PUBLIC   lim_rst_write_2   ! routine called by sbcice_lim_2.F90
30   PUBLIC   lim_rst_read_2    ! routine called by iceini_2.F90
31
32   LOGICAL, PUBLIC ::   lrst_ice         !: logical to control the ice restart write
33   INTEGER, PUBLIC ::   numrir, numriw   !: logical unit for ice restart (read and write)
34
35   !!----------------------------------------------------------------------
36   !! NEMO/LIM2 3.3 , UCL - NEMO Consortium (2010)
37   !! $Id$
38   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
39   !!----------------------------------------------------------------------
40CONTAINS
41
42   SUBROUTINE lim_rst_opn_2( kt )
43      !!----------------------------------------------------------------------
44      !!                    ***  lim_rst_opn_2  ***
45      !!
46      !! ** purpose  :   output of sea-ice variable in a netcdf file
47      !!----------------------------------------------------------------------
48      INTEGER, INTENT(in) ::   kt       ! number of iteration
49      !
50      CHARACTER(LEN=20)   ::   clkt     ! ocean time-step deine as a character
51      CHARACTER(LEN=50)   ::   clname   ! ice output restart file name
52      !!----------------------------------------------------------------------
53      !
54      IF( kt == nit000 )   lrst_ice = .FALSE.   ! default definition
55     
56      ! to get better performances with NetCDF format:
57      ! we open and define the ice restart file one ice time step before writing the data (-> at nitrst - 2*nn_fsbc + 1)
58      ! except if we write ice restart files every ice time step or if an ice restart file was writen at nitend - 2*nn_fsbc + 1
59      IF( kt == nitrst - 2*nn_fsbc + 1 .OR. nstock == nn_fsbc .OR. ( kt == nitend - nn_fsbc + 1 .AND. .NOT. lrst_ice ) ) THEN
60         ! beware of the format used to write kt (default is i8.8, that should be large enough...)
61         IF( nitrst > 99999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
62         ELSE                           ;   WRITE(clkt, '(i8.8)') nitrst
63         ENDIF
64         ! create the file
65         clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_icerst_out)
66         IF(lwp) THEN
67            WRITE(numout,*)
68            SELECT CASE ( jprstlib )
69            CASE ( jprstdimg )   ;   WRITE(numout,*) '             open ice restart binary file: '//clname
70            CASE DEFAULT         ;   WRITE(numout,*) '             open ice restart NetCDF file: '//clname
71            END SELECT
72            IF( kt == nitrst - 2*nn_fsbc + 1 ) THEN   
73               WRITE(numout,*)         '             kt = nitrst - 2*nn_fsbc + 1 = ', kt,' date= ', ndastp
74            ELSE   ;   WRITE(numout,*) '             kt = '                         , kt,' date= ', ndastp
75            ENDIF
76         ENDIF
77
78         CALL iom_open( clname, numriw, ldwrt = .TRUE., kiolib = jprstlib )
79         lrst_ice = .TRUE.
80      ENDIF
81      !
82   END SUBROUTINE lim_rst_opn_2
83
84
85   SUBROUTINE lim_rst_write_2( kt )
86      !!----------------------------------------------------------------------
87      !!                    ***  lim_rst_write_2  ***
88      !!
89      !! ** purpose  :   output of sea-ice variable in a netcdf file
90      !!----------------------------------------------------------------------
91      INTEGER, INTENT(in) ::   kt   ! number of iteration
92      !
93      INTEGER ::   iter   ! kt + nn_fsbc -1
94      !!----------------------------------------------------------------------
95
96      iter = kt + nn_fsbc - 1   ! ice restarts are written at kt == nitrst - nn_fsbc + 1
97
98      IF( iter == nitrst ) THEN
99         IF(lwp) WRITE(numout,*)
100         IF(lwp) WRITE(numout,*) 'lim_rst_write_2 : write ice restart file  kt =', kt
101         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~~'
102      ENDIF
103
104      ! Write in numriw (if iter == nitrst)
105      ! ------------------
106      !                                                                     ! calendar control
107      CALL iom_rstput( iter, nitrst, numriw, 'kt_ice', REAL( iter, wp) ) 
108     
109      CALL iom_rstput( iter, nitrst, numriw, 'hicif'      , hicif (:,:)   )      ! prognostic variables
110      CALL iom_rstput( iter, nitrst, numriw, 'hsnif'      , hsnif (:,:)   )
111      CALL iom_rstput( iter, nitrst, numriw, 'frld'       , frld  (:,:)   )
112      CALL iom_rstput( iter, nitrst, numriw, 'sist'       , sist  (:,:)   )
113      CALL iom_rstput( iter, nitrst, numriw, 'tbif1'      , tbif  (:,:,1) )
114      CALL iom_rstput( iter, nitrst, numriw, 'tbif2'      , tbif  (:,:,2) )
115      CALL iom_rstput( iter, nitrst, numriw, 'tbif3'      , tbif  (:,:,3) )
116      CALL iom_rstput( iter, nitrst, numriw, 'u_ice'      , u_ice (:,:)   )
117      CALL iom_rstput( iter, nitrst, numriw, 'v_ice'      , v_ice (:,:)   )
118      CALL iom_rstput( iter, nitrst, numriw, 'qstoif'     , qstoif(:,:)   )
119      CALL iom_rstput( iter, nitrst, numriw, 'fsbbq'      , fsbbq (:,:)   )
120#if ! defined key_lim2_vp
121      CALL iom_rstput( iter, nitrst, numriw, 'stress1_i'  , stress1_i (:,:) )    ! EVP rheology
122      CALL iom_rstput( iter, nitrst, numriw, 'stress2_i'  , stress2_i (:,:) )
123      CALL iom_rstput( iter, nitrst, numriw, 'stress12_i' , stress12_i(:,:) )
124#endif
125      CALL iom_rstput( iter, nitrst, numriw, 'sxice'      , sxice (:,:)   )
126      CALL iom_rstput( iter, nitrst, numriw, 'syice'      , syice (:,:)   )
127      CALL iom_rstput( iter, nitrst, numriw, 'sxxice'     , sxxice(:,:)   )
128      CALL iom_rstput( iter, nitrst, numriw, 'syyice'     , syyice(:,:)   )
129      CALL iom_rstput( iter, nitrst, numriw, 'sxyice'     , sxyice(:,:)   )
130      CALL iom_rstput( iter, nitrst, numriw, 'sxsn'       , sxsn  (:,:)   )
131      CALL iom_rstput( iter, nitrst, numriw, 'sysn'       , sysn  (:,:)   )
132      CALL iom_rstput( iter, nitrst, numriw, 'sxxsn'      , sxxsn (:,:)   )
133      CALL iom_rstput( iter, nitrst, numriw, 'syysn'      , syysn (:,:)   )
134      CALL iom_rstput( iter, nitrst, numriw, 'sxysn'      , sxysn (:,:)   )
135      CALL iom_rstput( iter, nitrst, numriw, 'sxa'        , sxa   (:,:)   )
136      CALL iom_rstput( iter, nitrst, numriw, 'sya'        , sya   (:,:)   )
137      CALL iom_rstput( iter, nitrst, numriw, 'sxxa'       , sxxa  (:,:)   )
138      CALL iom_rstput( iter, nitrst, numriw, 'syya'       , syya  (:,:)   )
139      CALL iom_rstput( iter, nitrst, numriw, 'sxya'       , sxya  (:,:)   )
140      CALL iom_rstput( iter, nitrst, numriw, 'sxc0'       , sxc0  (:,:)   )
141      CALL iom_rstput( iter, nitrst, numriw, 'syc0'       , syc0  (:,:)   )
142      CALL iom_rstput( iter, nitrst, numriw, 'sxxc0'      , sxxc0 (:,:)   )
143      CALL iom_rstput( iter, nitrst, numriw, 'syyc0'      , syyc0 (:,:)   )
144      CALL iom_rstput( iter, nitrst, numriw, 'sxyc0'      , sxyc0 (:,:)   )
145      CALL iom_rstput( iter, nitrst, numriw, 'sxc1'       , sxc1  (:,:)   )
146      CALL iom_rstput( iter, nitrst, numriw, 'syc1'       , syc1  (:,:)   )
147      CALL iom_rstput( iter, nitrst, numriw, 'sxxc1'      , sxxc1 (:,:)   )
148      CALL iom_rstput( iter, nitrst, numriw, 'syyc1'      , syyc1 (:,:)   )
149      CALL iom_rstput( iter, nitrst, numriw, 'sxyc1'      , sxyc1 (:,:)   )
150      CALL iom_rstput( iter, nitrst, numriw, 'sxc2'       , sxc2  (:,:)   )
151      CALL iom_rstput( iter, nitrst, numriw, 'syc2'       , syc2  (:,:)   )
152      CALL iom_rstput( iter, nitrst, numriw, 'sxxc2'      , sxxc2 (:,:)   )
153      CALL iom_rstput( iter, nitrst, numriw, 'syyc2'      , syyc2 (:,:)   )
154      CALL iom_rstput( iter, nitrst, numriw, 'sxyc2'      , sxyc2 (:,:)   )
155      CALL iom_rstput( iter, nitrst, numriw, 'sxst'       , sxst  (:,:)   )
156      CALL iom_rstput( iter, nitrst, numriw, 'syst'       , syst  (:,:)   )
157      CALL iom_rstput( iter, nitrst, numriw, 'sxxst'      , sxxst (:,:)   )
158      CALL iom_rstput( iter, nitrst, numriw, 'syyst'      , syyst (:,:)   )
159      CALL iom_rstput( iter, nitrst, numriw, 'sxyst'      , sxyst (:,:)   )
160     
161      IF( iter == nitrst ) THEN
162         CALL iom_close( numriw )                         ! close the restart file
163         lrst_ice = .FALSE.
164      ENDIF
165      !
166   END SUBROUTINE lim_rst_write_2
167
168
169   SUBROUTINE lim_rst_read_2
170      !!----------------------------------------------------------------------
171      !!                    ***  lim_rst_read_2  ***
172      !!
173      !! ** purpose  :   read of sea-ice variable restart in a netcdf file
174      !!----------------------------------------------------------------------
175      REAL(wp) ::   ziter
176      INTEGER  ::   jlibalt = jprstlib
177      LOGICAL  ::   llok
178      INTEGER  ::   itest
179      !!----------------------------------------------------------------------
180
181      IF(lwp) THEN
182         WRITE(numout,*)
183         WRITE(numout,*) 'lim_rst_read_2 : read ice NetCDF restart file'
184         WRITE(numout,*) '~~~~~~~~~~~~~~'
185      ENDIF
186
187      IF ( jprstlib == jprstdimg ) THEN
188        ! eventually read netcdf file (monobloc)  for restarting on different number of processors
189        ! if {cn_icerst_in}.nc exists, then set jlibalt to jpnf90
190        INQUIRE( FILE = TRIM(cn_icerst_in)//'.nc', EXIST = llok )
191        IF ( llok ) THEN ; jlibalt = jpnf90  ; ELSE ; jlibalt = jprstlib ; ENDIF
192      ENDIF
193
194      CALL iom_open ( cn_icerst_in, numrir, kiolib = jlibalt )
195
196      CALL iom_get( numrir, 'kt_ice' , ziter )
197      IF(lwp) WRITE(numout,*) '   read ice restart file at time step    : ', INT( ziter )
198      IF(lwp) WRITE(numout,*) '   in any case we force it to nit000 - 1 : ', nit000 - 1
199
200      !Control of date
201     
202      IF( ( nit000 - INT(ziter) ) /= 1 .AND. ABS( nrstdt ) == 1 )   &
203         &     CALL ctl_stop( 'lim_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
207      CALL iom_get( numrir, jpdom_autoglo, 'hicif' , hicif  )   
208      CALL iom_get( numrir, jpdom_autoglo, 'hsnif' , hsnif  )   
209      CALL iom_get( numrir, jpdom_autoglo, 'frld'  , frld   )   
210      CALL iom_get( numrir, jpdom_autoglo, 'sist'  , sist   )   
211      CALL iom_get( numrir, jpdom_autoglo, 'tbif1' , tbif(:,:,1) )   
212      CALL iom_get( numrir, jpdom_autoglo, 'tbif2' , tbif(:,:,2) )   
213      CALL iom_get( numrir, jpdom_autoglo, 'tbif3' , tbif(:,:,3) )   
214
215      itest = iom_varid( numrir, 'u_ice', ldstop = .FALSE. )   ! test if the variable u_ice is included in the file
216      IF( itest > 0 ) THEN   ! yes -> new restart files (from NEMO 3.2)
217         CALL iom_get( numrir, jpdom_autoglo, 'u_ice', u_ice ) 
218         CALL iom_get( numrir, jpdom_autoglo, 'v_ice', v_ice )   
219      ELSE                   ! no  -> old restart file with variable called [uv]i_ice (inroduced in NEMO 3.0)
220         CALL iom_get( numrir, jpdom_autoglo, 'ui_ice', u_ice ) 
221         CALL iom_get( numrir, jpdom_autoglo, 'vi_ice', v_ice )   
222      ENDIF
223
224      CALL iom_get( numrir, jpdom_autoglo, 'qstoif'     , qstoif )   
225      CALL iom_get( numrir, jpdom_autoglo, 'fsbbq'      , fsbbq  )   
226#if ! defined key_lim2_vp
227      CALL iom_get( numrir, jpdom_autoglo, 'stress1_i'  , stress1_i  )
228      CALL iom_get( numrir, jpdom_autoglo, 'stress2_i'  , stress2_i  )
229      CALL iom_get( numrir, jpdom_autoglo, 'stress12_i' , stress12_i )
230#endif
231      CALL iom_get( numrir, jpdom_autoglo, 'sxice'      , sxice  )
232      CALL iom_get( numrir, jpdom_autoglo, 'syice'      , syice  )
233      CALL iom_get( numrir, jpdom_autoglo, 'sxxice'     , sxxice )
234      CALL iom_get( numrir, jpdom_autoglo, 'syyice'     , syyice )
235      CALL iom_get( numrir, jpdom_autoglo, 'sxyice'     , sxyice )
236      CALL iom_get( numrir, jpdom_autoglo, 'sxsn'       , sxsn   )
237      CALL iom_get( numrir, jpdom_autoglo, 'sysn'       , sysn   )
238      CALL iom_get( numrir, jpdom_autoglo, 'sxxsn'      , sxxsn  )
239      CALL iom_get( numrir, jpdom_autoglo, 'syysn'      , syysn  )
240      CALL iom_get( numrir, jpdom_autoglo, 'sxysn'      , sxysn  )
241      CALL iom_get( numrir, jpdom_autoglo, 'sxa'        , sxa    )
242      CALL iom_get( numrir, jpdom_autoglo, 'sya'        , sya    )
243      CALL iom_get( numrir, jpdom_autoglo, 'sxxa'       , sxxa   )
244      CALL iom_get( numrir, jpdom_autoglo, 'syya'       , syya   )
245      CALL iom_get( numrir, jpdom_autoglo, 'sxya'       , sxya   )
246      CALL iom_get( numrir, jpdom_autoglo, 'sxc0'       , sxc0   )
247      CALL iom_get( numrir, jpdom_autoglo, 'syc0'       , syc0   )
248      CALL iom_get( numrir, jpdom_autoglo, 'sxxc0'      , sxxc0  )
249      CALL iom_get( numrir, jpdom_autoglo, 'syyc0'      , syyc0  )
250      CALL iom_get( numrir, jpdom_autoglo, 'sxyc0'      , sxyc0  )
251      CALL iom_get( numrir, jpdom_autoglo, 'sxc1'       , sxc1   )
252      CALL iom_get( numrir, jpdom_autoglo, 'syc1'       , syc1   )
253      CALL iom_get( numrir, jpdom_autoglo, 'sxxc1'      , sxxc1  )
254      CALL iom_get( numrir, jpdom_autoglo, 'syyc1'      , syyc1  )
255      CALL iom_get( numrir, jpdom_autoglo, 'sxyc1'      , sxyc1  )
256      CALL iom_get( numrir, jpdom_autoglo, 'sxc2'       , sxc2   )
257      CALL iom_get( numrir, jpdom_autoglo, 'syc2'       , syc2   )
258      CALL iom_get( numrir, jpdom_autoglo, 'sxxc2'      , sxxc2  )
259      CALL iom_get( numrir, jpdom_autoglo, 'syyc2'      , syyc2  )
260      CALL iom_get( numrir, jpdom_autoglo, 'sxyc2'      , sxyc2  )
261      CALL iom_get( numrir, jpdom_autoglo, 'sxst'       , sxst   )
262      CALL iom_get( numrir, jpdom_autoglo, 'syst'       , syst   )
263      CALL iom_get( numrir, jpdom_autoglo, 'sxxst'      , sxxst  )
264      CALL iom_get( numrir, jpdom_autoglo, 'syyst'      , syyst  )
265      CALL iom_get( numrir, jpdom_autoglo, 'sxyst'      , sxyst  )
266     
267      CALL iom_close( numrir )
268      !
269   END SUBROUTINE lim_rst_read_2
270
271#else
272   !!----------------------------------------------------------------------
273   !!   Default option :       Empty module        NO LIM 2.0 sea-ice model
274   !!----------------------------------------------------------------------
275#endif
276
277   !!======================================================================
278END MODULE limrst_2
Note: See TracBrowser for help on using the repository browser.