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/devmercator2010_1/NEMO/OPA_SRC/IOM – NEMO

source: branches/devmercator2010_1/NEMO/OPA_SRC/IOM/restart.F90 @ 2132

Last change on this file since 2132 was 2132, checked in by cbricaud, 14 years ago

add change from DEV_r1784_GLS

  • Property svn:eol-style set to native
  • Property svn:keywords set to Id
File size: 11.0 KB
Line 
1MODULE restart
2   !!======================================================================
3   !!                     ***  MODULE  restart  ***
4   !! Ocean restart :  write the ocean restart file
5   !!======================================================================
6   !! History :        !  99-11  (M. Imbard)  Original code
7   !!             8.5  !  02-08  (G. Madec)  F90: Free form
8   !!             9.0  !  05-11  (V. Garnier) Surface pressure gradient organization
9   !!             9.0  !  06-07  (S. Masson)  use IOM for restart
10   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   rst_opn    : open the ocean restart file
14   !!   rst_write  : write the ocean restart file
15   !!   rst_read   : read the ocean restart file
16   !!----------------------------------------------------------------------
17   USE dom_oce         ! ocean space and time domain
18   USE oce             ! ocean dynamics and tracers
19   USE phycst          ! physical constants
20   USE in_out_manager  ! I/O manager
21   USE iom             ! I/O module
22   USE c1d             ! re-initialization of u-v mask for the 1D configuration
23   USE zpshde          ! partial step: hor. derivative (zps_hde routine)
24   USE eosbn2          ! equation of state            (eos bn2 routine)
25   USE zdfddm          ! double diffusion mixing
26   USE zdfmxl          ! mixed layer depth
27   USE trdmld_oce      ! ocean active mixed layer tracers trends variables
28#if defined key_zdfgls
29   USE zdfbfr, ONLY : wbotu, wbotv ! bottom stresses
30   USE zdf_oce
31#endif
32
33   IMPLICIT NONE
34   PRIVATE
35
36   PUBLIC   rst_opn    ! routine called by step module
37   PUBLIC   rst_write  ! routine called by step module
38   PUBLIC   rst_read   ! routine called by opa  module
39
40   LOGICAL, PUBLIC ::   lrst_oce =  .FALSE.       !: logical to control the oce restart write
41   INTEGER, PUBLIC ::   numror, numrow            !: logical unit for cean restart (read and write)
42
43   !! * Substitutions
44#  include "vectopt_loop_substitute.h90"
45   !!----------------------------------------------------------------------
46   !!  OPA 9.0 , LOCEAN-IPSL (2006)
47   !! $Id$
48   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
49   !!----------------------------------------------------------------------
50
51CONTAINS
52
53   SUBROUTINE rst_opn( kt )
54      !!---------------------------------------------------------------------
55      !!                   ***  ROUTINE rst_opn  ***
56      !!                     
57      !! ** Purpose : + initialization (should be read in the namelist) of nitrst
58      !!              + open the restart when we are one time step before nitrst
59      !!                   - restart header is defined when kt = nitrst-1
60      !!                   - restart data  are written when kt = nitrst
61      !!              + define lrst_oce to .TRUE. when we need to define or write the restart
62      !!----------------------------------------------------------------------
63      INTEGER, INTENT(in) ::   kt     ! ocean time-step
64      !!
65      CHARACTER(LEN=20)   ::   clkt     ! ocean time-step deine as a character
66      CHARACTER(LEN=50)   ::   clname   ! ice output restart file name
67      !!----------------------------------------------------------------------
68      !
69      IF( kt == nit000 ) THEN   ! default definitions
70         lrst_oce = .FALSE.   
71         nitrst = nitend
72      ENDIF
73      IF( MOD( kt - 1, nstock ) == 0 ) THEN   
74         ! we use kt - 1 and not kt - nit000 to keep the same periodicity from the beginning of the experiment
75         nitrst = kt + nstock - 1                  ! define the next value of nitrst for restart writing
76         IF( nitrst > nitend )   nitrst = nitend   ! make sure we write a restart at the end of the run
77      ENDIF
78      ! to get better performances with NetCDF format:
79      ! we open and define the ocean restart file one time step before writing the data (-> at nitrst - 1)
80      ! except if we write ocean restart files every time step or if an ocean restart file was writen at nitend - 1
81      IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. .NOT. lrst_oce ) ) THEN
82         ! beware of the format used to write kt (default is i8.8, that should be large enough...)
83         IF( nitrst > 999999999 ) 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_ocerst_out)
88         IF(lwp) THEN
89            WRITE(numout,*)
90            SELECT CASE ( jprstlib )
91            CASE ( jprstdimg )   ;   WRITE(numout,*) '             open ocean restart binary file: '//clname
92            CASE DEFAULT         ;   WRITE(numout,*) '             open ocean restart NetCDF file: '//clname
93            END SELECT
94            IF( kt == nitrst - 1 ) THEN   ;   WRITE(numout,*) '             kt = nitrst - 1 = ', kt
95            ELSE                          ;   WRITE(numout,*) '             kt = '             , kt
96            ENDIF
97         ENDIF
98
99         CALL iom_open( clname, numrow, ldwrt = .TRUE., kiolib = jprstlib )
100         lrst_oce = .TRUE.
101      ENDIF
102      !
103   END SUBROUTINE rst_opn
104
105
106   SUBROUTINE rst_write( kt )
107      !!---------------------------------------------------------------------
108      !!                   ***  ROUTINE rstwrite  ***
109      !!                     
110      !! ** Purpose :   Write restart fields in the format corresponding to jprstlib
111      !!
112      !! ** Method  :   Write in numrow when kt == nitrst in NetCDF
113      !!      file, save fields which are necessary for restart
114      !!----------------------------------------------------------------------
115      INTEGER, INTENT(in) ::   kt   ! ocean time-step
116      !!----------------------------------------------------------------------
117
118      CALL iom_rstput( kt, nitrst, numrow, 'rdt'    , rdt       )   ! dynamics time step
119      CALL iom_rstput( kt, nitrst, numrow, 'rdttra1', rdttra(1) )   ! surface tracer time step
120
121      CALL iom_rstput( kt, nitrst, numrow, 'ub'     , ub      )     ! before fields
122      CALL iom_rstput( kt, nitrst, numrow, 'vb'     , vb      )
123      CALL iom_rstput( kt, nitrst, numrow, 'tb'     , tb      )
124      CALL iom_rstput( kt, nitrst, numrow, 'sb'     , sb      )
125      CALL iom_rstput( kt, nitrst, numrow, 'rotb'   , rotb    )
126      CALL iom_rstput( kt, nitrst, numrow, 'hdivb'  , hdivb   )
127      CALL iom_rstput( kt, nitrst, numrow, 'sshb'   , sshb    )
128      !
129      CALL iom_rstput( kt, nitrst, numrow, 'un'     , un      )     ! now fields
130      CALL iom_rstput( kt, nitrst, numrow, 'vn'     , vn      )
131      CALL iom_rstput( kt, nitrst, numrow, 'tn'     , tn      )
132      CALL iom_rstput( kt, nitrst, numrow, 'sn'     , sn      )
133      CALL iom_rstput( kt, nitrst, numrow, 'rotn'   , rotn    )
134      CALL iom_rstput( kt, nitrst, numrow, 'hdivn'  , hdivn   )
135      CALL iom_rstput( kt, nitrst, numrow, 'sshn'   , sshn    )
136
137      CALL iom_rstput( kt, nitrst, numrow, 'rhop'   , rhop    )
138#if defined key_zdfkpp
139      CALL iom_rstput( kt, nitrst, numrow, 'rhd'  , rhd   )
140#endif
141
142#if defined key_zdfgls
143      ! Save bottom stresses
144      CALL iom_rstput( kt, nitrst, numrow, 'wbotu' , wbotu )
145      CALL iom_rstput( kt, nitrst, numrow, 'wbotv' , wbotv )
146#endif
147
148      IF( kt == nitrst ) THEN
149         CALL iom_close( numrow )     ! close the restart file (only at last time step)
150         IF( .NOT. lk_trdmld )   lrst_oce = .FALSE.
151      ENDIF
152      !
153   END SUBROUTINE rst_write
154
155
156   SUBROUTINE rst_read
157      !!----------------------------------------------------------------------
158      !!                   ***  ROUTINE rst_read  ***
159      !!
160      !! ** Purpose :   Read files for restart (format fixed by jprstlib )
161      !!
162      !! ** Method  :   Read in restart.nc file fields which are necessary for restart
163      !!----------------------------------------------------------------------
164      REAL(wp) ::   zrdt, zrdttra1
165      INTEGER  ::   jlibalt = jprstlib
166      LOGICAL  ::   llok
167      !!----------------------------------------------------------------------
168
169      IF(lwp) THEN                                             ! Contol prints
170         WRITE(numout,*)
171         SELECT CASE ( jprstlib )
172         CASE ( jpnf90    )   ;   WRITE(numout,*) 'rst_read : read oce NetCDF restart file'
173         CASE ( jprstdimg )   ;   WRITE(numout,*) 'rst_read : read oce binary restart file'
174         END SELECT
175         WRITE(numout,*) '~~~~~~~~'
176      ENDIF
177
178      IF ( jprstlib == jprstdimg ) THEN
179        ! eventually read netcdf file (monobloc)  for restarting on different number of processors
180        ! if {cn_ocerst_in}.nc exists, then set jlibalt to jpnf90
181        INQUIRE( FILE = TRIM(cn_ocerst_in)//'.nc', EXIST = llok )
182        IF ( llok ) THEN ; jlibalt = jpnf90  ; ELSE ; jlibalt = jprstlib ; ENDIF
183      ENDIF
184      CALL iom_open( cn_ocerst_in, numror, kiolib = jlibalt )
185
186      ! Check dynamics and tracer time-step consistency and force Euler restart if changed
187      IF( iom_varid( numror, 'rdt', ldstop = .FALSE. ) > 0 )   THEN
188         CALL iom_get( numror, 'rdt', zrdt )
189         IF( zrdt /= rdt )   neuler = 0
190      ENDIF
191      IF( iom_varid( numror, 'rdttra1', ldstop = .FALSE. ) > 0 )   THEN
192         CALL iom_get( numror, 'rdttra1', zrdttra1 )
193         IF( zrdttra1 /= rdttra(1) )   neuler = 0
194      ENDIF
195      !
196      CALL iom_get( numror, jpdom_autoglo, 'ub'   , ub    )        ! before fields
197      CALL iom_get( numror, jpdom_autoglo, 'vb'   , vb    )
198      CALL iom_get( numror, jpdom_autoglo, 'tb'   , tb    )
199      CALL iom_get( numror, jpdom_autoglo, 'sb'   , sb    )
200      CALL iom_get( numror, jpdom_autoglo, 'rotb' , rotb  )
201      CALL iom_get( numror, jpdom_autoglo, 'hdivb', hdivb )
202      CALL iom_get( numror, jpdom_autoglo, 'sshb' , sshb  )
203      !
204      CALL iom_get( numror, jpdom_autoglo, 'un'   , un    )        ! now    fields
205      CALL iom_get( numror, jpdom_autoglo, 'vn'   , vn    )
206      CALL iom_get( numror, jpdom_autoglo, 'tn'   , tn    )
207      CALL iom_get( numror, jpdom_autoglo, 'sn'   , sn    )
208      CALL iom_get( numror, jpdom_autoglo, 'rotn' , rotn  )
209      CALL iom_get( numror, jpdom_autoglo, 'hdivn', hdivn )
210      CALL iom_get( numror, jpdom_autoglo, 'sshn' , sshn  )
211
212      CALL iom_get( numror, jpdom_autoglo, 'rhop' , rhop  )        ! now    potential density
213#if defined key_zdfkpp
214      IF( iom_varid( numror, 'rhd', ldstop = .FALSE. ) > 0 ) THEN
215         CALL iom_get( numror, jpdom_autoglo, 'rhd' , rhd  )       ! now    in situ density anomaly
216      ELSE
217         CALL eos( tn, sn, rhd )   ! compute rhd
218      ENDIF
219#endif
220
221      IF( neuler == 0 ) THEN                                  ! Euler restart (neuler=0)
222         tb   (:,:,:) = tn   (:,:,:)                             ! all before fields set to now values
223         sb   (:,:,:) = sn   (:,:,:)
224         ub   (:,:,:) = un   (:,:,:)
225         vb   (:,:,:) = vn   (:,:,:)
226         rotb (:,:,:) = rotn (:,:,:)
227         hdivb(:,:,:) = hdivn(:,:,:)
228         sshb (:,:)   = sshn (:,:)
229      ENDIF
230      !
231   END SUBROUTINE rst_read
232
233   !!=====================================================================
234END MODULE restart
Note: See TracBrowser for help on using the repository browser.