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/dev_002_LIM/NEMO/LIM_SRC_2 – NEMO

source: branches/dev_002_LIM/NEMO/LIM_SRC_2/limrst_2.F90 @ 823

Last change on this file since 823 was 823, checked in by rblod, 16 years ago

Final step to rename LIM_SRC in LIM_SRC_2
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 14.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   !!----------------------------------------------------------------------
9#if defined key_lim2
10   !!----------------------------------------------------------------------
11   !!   'key_lim2' :                                  LIM 2.0 sea-ice model
12   !!----------------------------------------------------------------------
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 ice_2
19   USE dom_oce
20   USE ice_oce         ! ice variables
21   USE daymod
22
23   USE in_out_manager
24   USE iom
25
26   IMPLICIT NONE
27   PRIVATE
28
29   PUBLIC   lim_rst_opn_2     ! routine called by ??? module
30   PUBLIC   lim_rst_write_2   ! routine called by ??? module
31   PUBLIC   lim_rst_read_2    ! routine called by ??? module
32
33   LOGICAL, PUBLIC ::   lrst_ice         !: logical to control the ice restart write
34   INTEGER, PUBLIC ::   numrir, numriw   !: logical unit for ice restart (read and write)
35
36   !!----------------------------------------------------------------------
37   !!   LIM 2.0,  UCL-LOCEAN-IPSL (2006)
38   !! $Header: /home/opalod/NEMOCVSROOT/NEMO/LIM_SRC/limrst.F90,v 1.15 2007/06/29 14:54:06 opalod Exp $
39   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
40   !!----------------------------------------------------------------------
41
42CONTAINS
43
44   SUBROUTINE lim_rst_opn_2( kt )
45      !!----------------------------------------------------------------------
46      !!                    ***  lim_rst_opn_2  ***
47      !!
48      !! ** purpose  :   output of sea-ice variable in a netcdf file
49      !!----------------------------------------------------------------------
50      INTEGER, INTENT(in) ::   kt       ! number of iteration
51      !
52      CHARACTER(LEN=20)   ::   clkt     ! ocean time-step deine as a character
53      CHARACTER(LEN=50)   ::   clname   ! ice output restart file name
54      !!----------------------------------------------------------------------
55      !
56      IF( kt == nit000 )   lrst_ice = .FALSE.   ! default definition
57     
58      ! to get better performances with NetCDF format:
59      ! we open and define the ice restart file one ice time step before writing the data (-> at nitrst - 2*nfice + 1)
60      ! except if we write ice restart files every ice time step or if an ice restart file was writen at nitend - 2*nfice + 1
61      IF( kt == nitrst - 2*nfice + 1 .OR. nstock == nfice .OR. ( kt == nitend - nfice + 1 .AND. .NOT. lrst_ice ) ) THEN
62         ! beware of the format used to write kt (default is i8.8, that should be large enough...)
63         IF( nitrst > 99999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
64         ELSE                           ;   WRITE(clkt, '(i8.8)') nitrst
65         ENDIF
66         ! create the file
67         clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_restart_ice"
68         IF(lwp) THEN
69            WRITE(numout,*)
70            SELECT CASE ( jprstlib )
71            CASE ( jprstdimg )   ;   WRITE(numout,*) '             open ice restart binary file: '//clname
72            CASE DEFAULT         ;   WRITE(numout,*) '             open ice restart NetCDF file: '//clname
73            END SELECT
74            IF( kt == nitrst - 2*nfice + 1 ) THEN   
75               WRITE(numout,*)         '             kt = nitrst - 2*nfice + 1 = ', kt,' date= ', ndastp
76            ELSE   ;   WRITE(numout,*) '             kt = '                       , kt,' date= ', ndastp
77            ENDIF
78         ENDIF
79
80         CALL iom_open( clname, numriw, ldwrt = .TRUE., kiolib = jprstlib )
81         lrst_ice = .TRUE.
82      ENDIF
83      !
84   END SUBROUTINE lim_rst_opn_2
85
86   SUBROUTINE lim_rst_write_2( kt )
87      !!----------------------------------------------------------------------
88      !!                    ***  lim_rst_write_2  ***
89      !!
90      !! ** purpose  :   output of sea-ice variable in a netcdf file
91      !!----------------------------------------------------------------------
92      INTEGER, INTENT(in) ::   kt     ! number of iteration
93      !!
94      INTEGER ::   iter     ! kt + nfice -1
95      !!----------------------------------------------------------------------
96
97      iter = kt + nfice - 1   ! ice restarts are written at kt == nitrst - nfice + 1
98
99      IF( iter == nitrst ) THEN
100         IF(lwp) WRITE(numout,*)
101         IF(lwp) WRITE(numout,*) 'lim_rst_write_2 : write ice restart file  kt =', kt
102         IF(lwp) WRITE(numout,*) '~~~~~~~'         
103      ENDIF
104
105      ! Write in numriw (if iter == nitrst)
106      ! ------------------
107      !                                                                     ! calendar control
108      CALL iom_rstput( iter, nitrst, numriw, 'nfice' , REAL( nfice, wp) )      ! time-step
109      CALL iom_rstput( iter, nitrst, numriw, 'kt_ice', REAL( iter , wp) )      ! date
110     
111      CALL iom_rstput( iter, nitrst, numriw, 'hicif' , hicif (:,:)   )      ! prognostic variables
112      CALL iom_rstput( iter, nitrst, numriw, 'hsnif' , hsnif (:,:)   )
113      CALL iom_rstput( iter, nitrst, numriw, 'frld'  , frld  (:,:)   )
114      CALL iom_rstput( iter, nitrst, numriw, 'sist'  , sist  (:,:)   )
115# if defined key_coupled
116      CALL iom_rstput( iter, nitrst, numriw, 'albege', albege(:,:) )
117# endif
118      CALL iom_rstput( iter, nitrst, numriw, 'tbif1' , tbif  (:,:,1) )
119      CALL iom_rstput( iter, nitrst, numriw, 'tbif2' , tbif  (:,:,2) )
120      CALL iom_rstput( iter, nitrst, numriw, 'tbif3' , tbif  (:,:,3) )
121      CALL iom_rstput( iter, nitrst, numriw, 'u_ice' , u_ice (:,:)   )
122      CALL iom_rstput( iter, nitrst, numriw, 'v_ice' , v_ice (:,:)   )
123      CALL iom_rstput( iter, nitrst, numriw, 'gtaux' , gtaux (:,:)   )
124      CALL iom_rstput( iter, nitrst, numriw, 'gtauy' , gtauy (:,:)   )
125      CALL iom_rstput( iter, nitrst, numriw, 'qstoif', qstoif(:,:)   )
126      CALL iom_rstput( iter, nitrst, numriw, 'fsbbq' , fsbbq (:,:)   )
127      CALL iom_rstput( iter, nitrst, numriw, 'sxice' , sxice (:,:)   )
128      CALL iom_rstput( iter, nitrst, numriw, 'syice' , syice (:,:)   )
129      CALL iom_rstput( iter, nitrst, numriw, 'sxxice', sxxice(:,:)   )
130      CALL iom_rstput( iter, nitrst, numriw, 'syyice', syyice(:,:)   )
131      CALL iom_rstput( iter, nitrst, numriw, 'sxyice', sxyice(:,:)   )
132      CALL iom_rstput( iter, nitrst, numriw, 'sxsn'  , sxsn  (:,:)   )
133      CALL iom_rstput( iter, nitrst, numriw, 'sysn'  , sysn  (:,:)   )
134      CALL iom_rstput( iter, nitrst, numriw, 'sxxsn' , sxxsn (:,:)   )
135      CALL iom_rstput( iter, nitrst, numriw, 'syysn' , syysn (:,:)   )
136      CALL iom_rstput( iter, nitrst, numriw, 'sxysn' , sxysn (:,:)   )
137      CALL iom_rstput( iter, nitrst, numriw, 'sxa'   , sxa   (:,:)   )
138      CALL iom_rstput( iter, nitrst, numriw, 'sya'   , sya   (:,:)   )
139      CALL iom_rstput( iter, nitrst, numriw, 'sxxa'  , sxxa  (:,:)   )
140      CALL iom_rstput( iter, nitrst, numriw, 'syya'  , syya  (:,:)   )
141      CALL iom_rstput( iter, nitrst, numriw, 'sxya'  , sxya  (:,:)   )
142      CALL iom_rstput( iter, nitrst, numriw, 'sxc0'  , sxc0  (:,:)   )
143      CALL iom_rstput( iter, nitrst, numriw, 'syc0'  , syc0  (:,:)   )
144      CALL iom_rstput( iter, nitrst, numriw, 'sxxc0' , sxxc0 (:,:)   )
145      CALL iom_rstput( iter, nitrst, numriw, 'syyc0' , syyc0 (:,:)   )
146      CALL iom_rstput( iter, nitrst, numriw, 'sxyc0' , sxyc0 (:,:)   )
147      CALL iom_rstput( iter, nitrst, numriw, 'sxc1'  , sxc1  (:,:)   )
148      CALL iom_rstput( iter, nitrst, numriw, 'syc1'  , syc1  (:,:)   )
149      CALL iom_rstput( iter, nitrst, numriw, 'sxxc1' , sxxc1 (:,:)   )
150      CALL iom_rstput( iter, nitrst, numriw, 'syyc1' , syyc1 (:,:)   )
151      CALL iom_rstput( iter, nitrst, numriw, 'sxyc1' , sxyc1 (:,:)   )
152      CALL iom_rstput( iter, nitrst, numriw, 'sxc2'  , sxc2  (:,:)   )
153      CALL iom_rstput( iter, nitrst, numriw, 'syc2'  , syc2  (:,:)   )
154      CALL iom_rstput( iter, nitrst, numriw, 'sxxc2' , sxxc2 (:,:)   )
155      CALL iom_rstput( iter, nitrst, numriw, 'syyc2' , syyc2 (:,:)   )
156      CALL iom_rstput( iter, nitrst, numriw, 'sxyc2' , sxyc2 (:,:)   )
157      CALL iom_rstput( iter, nitrst, numriw, 'sxst'  , sxst  (:,:)   )
158      CALL iom_rstput( iter, nitrst, numriw, 'syst'  , syst  (:,:)   )
159      CALL iom_rstput( iter, nitrst, numriw, 'sxxst' , sxxst (:,:)   )
160      CALL iom_rstput( iter, nitrst, numriw, 'syyst' , syyst (:,:)   )
161      CALL iom_rstput( iter, nitrst, numriw, 'sxyst' , sxyst (:,:)   )
162     
163      IF( iter == nitrst ) THEN
164         CALL iom_close( numriw )                         ! close the restart file
165         lrst_ice = .FALSE.
166      ENDIF
167      !
168   END SUBROUTINE lim_rst_write_2
169
170
171   SUBROUTINE lim_rst_read_2
172      !!----------------------------------------------------------------------
173      !!                    ***  lim_rst_read_2  ***
174      !!
175      !! ** purpose  :   read of sea-ice variable restart in a netcdf file
176      !!----------------------------------------------------------------------
177      !
178      REAL(wp) ::   zfice, ziter
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      CALL iom_open ( 'restart_ice_in', numrir, kiolib = jprstlib )
188
189      CALL iom_get( numrir, 'nfice' , zfice )
190      CALL iom_get( numrir, 'kt_ice', ziter )   
191      IF(lwp) WRITE(numout,*) '   read ice restart file at time step    : ', ziter
192      IF(lwp) WRITE(numout,*) '   in any case we force it to nit000 - 1 : ', nit000 - 1
193
194      !Control of date
195     
196      IF( ( nit000 - INT(ziter) ) /= 1 .AND. ABS( nrstdt ) == 1 )   &
197         &     CALL ctl_stop( 'lim_rst_read ===>>>> : problem with nit000 in ice restart',  &
198         &                   '   verify the file or rerun with the value 0 for the',        &
199         &                   '   control of time parameter  nrstdt' )
200      IF( INT(zfice) /= nfice          .AND. ABS( nrstdt ) == 1 )   &
201         &     CALL ctl_stop( 'lim_rst_read ===>>>> : problem with nfice in ice restart',  &
202         &                   '   verify the file or rerun with the value 0 for the',        &
203         &                   '   control of time parameter  nrstdt' )
204
205      CALL iom_get( numrir, jpdom_autoglo, 'hicif' , hicif  )   
206      CALL iom_get( numrir, jpdom_autoglo, 'hsnif' , hsnif  )   
207      CALL iom_get( numrir, jpdom_autoglo, 'frld'  , frld   )   
208      CALL iom_get( numrir, jpdom_autoglo, 'sist'  , sist   )   
209# if defined key_coupled 
210      CALL iom_get( numrir, jpdom_autoglo, 'albege', albege )   
211# endif
212      CALL iom_get( numrir, jpdom_autoglo, 'tbif1' , tbif(:,:,1) )   
213      CALL iom_get( numrir, jpdom_autoglo, 'tbif2' , tbif(:,:,2) )   
214      CALL iom_get( numrir, jpdom_autoglo, 'tbif3' , tbif(:,:,3) )   
215      CALL iom_get( numrir, jpdom_autoglo, 'u_ice' , u_ice  )   
216      CALL iom_get( numrir, jpdom_autoglo, 'v_ice' , v_ice  )   
217      CALL iom_get( numrir, jpdom_autoglo, 'gtaux' , gtaux  )   
218      CALL iom_get( numrir, jpdom_autoglo, 'gtauy' , gtauy  )   
219      CALL iom_get( numrir, jpdom_autoglo, 'qstoif', qstoif )   
220      CALL iom_get( numrir, jpdom_autoglo, 'fsbbq' , fsbbq  )   
221      CALL iom_get( numrir, jpdom_autoglo, 'sxice' , sxice  )
222      CALL iom_get( numrir, jpdom_autoglo, 'syice' , syice  )
223      CALL iom_get( numrir, jpdom_autoglo, 'sxxice', sxxice )
224      CALL iom_get( numrir, jpdom_autoglo, 'syyice', syyice )
225      CALL iom_get( numrir, jpdom_autoglo, 'sxyice', sxyice )
226      CALL iom_get( numrir, jpdom_autoglo, 'sxsn'  , sxsn   )
227      CALL iom_get( numrir, jpdom_autoglo, 'sysn'  , sysn   )
228      CALL iom_get( numrir, jpdom_autoglo, 'sxxsn' , sxxsn  )
229      CALL iom_get( numrir, jpdom_autoglo, 'syysn' , syysn  )
230      CALL iom_get( numrir, jpdom_autoglo, 'sxysn' , sxysn  )
231      CALL iom_get( numrir, jpdom_autoglo, 'sxa'   , sxa    )
232      CALL iom_get( numrir, jpdom_autoglo, 'sya'   , sya    )
233      CALL iom_get( numrir, jpdom_autoglo, 'sxxa'  , sxxa   )
234      CALL iom_get( numrir, jpdom_autoglo, 'syya'  , syya   )
235      CALL iom_get( numrir, jpdom_autoglo, 'sxya'  , sxya   )
236      CALL iom_get( numrir, jpdom_autoglo, 'sxc0'  , sxc0   )
237      CALL iom_get( numrir, jpdom_autoglo, 'syc0'  , syc0   )
238      CALL iom_get( numrir, jpdom_autoglo, 'sxxc0' , sxxc0  )
239      CALL iom_get( numrir, jpdom_autoglo, 'syyc0' , syyc0  )
240      CALL iom_get( numrir, jpdom_autoglo, 'sxyc0' , sxyc0  )
241      CALL iom_get( numrir, jpdom_autoglo, 'sxc1'  , sxc1   )
242      CALL iom_get( numrir, jpdom_autoglo, 'syc1'  , syc1   )
243      CALL iom_get( numrir, jpdom_autoglo, 'sxxc1' , sxxc1  )
244      CALL iom_get( numrir, jpdom_autoglo, 'syyc1' , syyc1  )
245      CALL iom_get( numrir, jpdom_autoglo, 'sxyc1' , sxyc1  )
246      CALL iom_get( numrir, jpdom_autoglo, 'sxc2'  , sxc2   )
247      CALL iom_get( numrir, jpdom_autoglo, 'syc2'  , syc2   )
248      CALL iom_get( numrir, jpdom_autoglo, 'sxxc2' , sxxc2  )
249      CALL iom_get( numrir, jpdom_autoglo, 'syyc2' , syyc2  )
250      CALL iom_get( numrir, jpdom_autoglo, 'sxyc2' , sxyc2  )
251      CALL iom_get( numrir, jpdom_autoglo, 'sxst'  , sxst   )
252      CALL iom_get( numrir, jpdom_autoglo, 'syst'  , syst   )
253      CALL iom_get( numrir, jpdom_autoglo, 'sxxst' , sxxst  )
254      CALL iom_get( numrir, jpdom_autoglo, 'syyst' , syyst  )
255      CALL iom_get( numrir, jpdom_autoglo, 'sxyst' , sxyst  )
256     
257      CALL iom_close( numrir )
258      !
259   END SUBROUTINE lim_rst_read_2
260
261#else
262   !!----------------------------------------------------------------------
263   !!   Default option :       Empty module        NO LIM 2.0 sea-ice model
264   !!----------------------------------------------------------------------
265#endif
266
267   !!======================================================================
268END MODULE limrst_2
Note: See TracBrowser for help on using the repository browser.