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.
trdmxl_rst.F90 in branches/UKMO/r5936_hadgem3_cplseq/NEMOGCM/NEMO/OPA_SRC/TRD – NEMO

source: branches/UKMO/r5936_hadgem3_cplseq/NEMOGCM/NEMO/OPA_SRC/TRD/trdmxl_rst.F90 @ 7131

Last change on this file since 7131 was 7131, checked in by jcastill, 7 years ago

Remove svn keywords

File size: 9.8 KB
Line 
1MODULE trdmxl_rst
2   !!=================================================================================
3   !!                       ***  MODULE  trdmxl_rst  ***
4   !! Ocean dynamic :  Input/Output files for restart on mixed-layer diagnostics
5   !!=================================================================================
6   !! History :  1.0  ! 2005-05 (C. Deltel)  Original code
7   !!---------------------------------------------------------------------------------
8
9   !!---------------------------------------------------------------------------------
10   !!  trd_mxl_rst_write : write mixed layer trend restart
11   !!  trd_mxl_rst_read  : read  mixed layer trend restart
12   !!---------------------------------------------------------------------------------
13   USE dom_oce         ! ocean space and time domain
14   USE trd_oce         ! trends: ocean variables
15   USE in_out_manager  ! I/O manager
16   USE iom             ! I/O module
17   USE restart         ! only for lrst_oce
18
19   IMPLICIT NONE
20   PRIVATE
21 
22   PUBLIC   trd_mxl_rst_read    ! routine called by trd_mxl_init
23   PUBLIC   trd_mxl_rst_write   ! routine called by step.F90
24 
25   INTEGER ::   nummxlw         ! logical unit for mxl restart
26
27   !!---------------------------------------------------------------------------------
28   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
29   !! $Id$
30   !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
31   !!---------------------------------------------------------------------------------
32CONTAINS
33 
34   SUBROUTINE trd_mxl_rst_write( kt )
35      !!--------------------------------------------------------------------------------
36      !!                  ***  SUBROUTINE trd_mxl_rst_wri  ***
37      !!               
38      !! ** Purpose :   Write mixed-layer diagnostics restart fields.
39      !!--------------------------------------------------------------------------------
40      INTEGER, INTENT( in ) ::   kt   ! ocean time-step index
41      !
42      CHARACTER (len=35) :: charout
43      INTEGER ::   jk                 ! loop indice
44      CHARACTER(LEN=20)   ::   clkt     ! ocean time-step deine as a character
45      CHARACTER(LEN=50)   ::   clname   ! output restart file name
46      CHARACTER(LEN=256)  ::   clpath   ! full path to restart file
47      !!--------------------------------------------------------------------------------
48
49      ! to get better performances with NetCDF format:
50      ! we open and define the ocean restart_mxl file one time step before writing the data (-> at nitrst - 1)
51      ! except if we write ocean restart_mxl files every time step or if an ocean restart_mxl file was writen at nitend - 1
52      IF( kt == nitrst - 1 .OR. nstock == 1 .OR. ( kt == nitend .AND. MOD( nitend - 1, nstock ) == 0 ) ) THEN
53         ! beware of the format used to write kt (default is i8.8, that should be large enough...)
54         IF( nitrst > 999999999 ) THEN   ;   WRITE(clkt, *       ) nitrst
55         ELSE                            ;   WRITE(clkt, '(i8.8)') nitrst
56         ENDIF
57         ! create the file
58         clname = TRIM(cexper)//"_"//TRIM(ADJUSTL(clkt))//"_"//TRIM(cn_trdrst_out)
59         clpath = TRIM(cn_ocerst_outdir)
60         IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
61         IF(lwp) THEN
62            WRITE(numout,*)
63            SELECT CASE ( jprstlib )
64            CASE ( jprstdimg )   ;   WRITE(numout,*) '             open ocean restart_mxl binary file: '//clname
65            CASE DEFAULT         ;   WRITE(numout,*) '             open ocean restart_mxl NetCDF file: '//clname
66            END SELECT
67            IF( kt == nitrst - 1 ) THEN   ;   WRITE(numout,*) '             kt = nitrst - 1 = ', kt,' date= ', ndastp
68            ELSE                          ;   WRITE(numout,*) '             kt = '             , kt,' date= ', ndastp
69            ENDIF
70         ENDIF
71
72         CALL iom_open( TRIM(clpath)//TRIM(clname), nummxlw, ldwrt = .TRUE., kiolib = jprstlib )
73      ENDIF
74
75      IF( kt == nitrst .AND. lwp ) THEN
76         WRITE(numout,*)
77         WRITE(numout,*) 'trdmxl_rst: output for ML diags. restart, with trd_mxl_rst_write routine kt =', kt
78         WRITE(numout,*) '~~~~~~~~~~'
79         WRITE(numout,*)
80      ENDIF
81
82      IF( ln_trdmxl_instant ) THEN 
83         !-- Temperature
84         CALL iom_rstput( kt, nitrst, nummxlw, 'tmlbb'           , tmlbb           )
85         CALL iom_rstput( kt, nitrst, nummxlw, 'tmlbn'           , tmlbn           )
86         CALL iom_rstput( kt, nitrst, nummxlw, 'tmlatfb'         , tmlatfb         )
87
88         !-- Salinity
89         CALL iom_rstput( kt, nitrst, nummxlw, 'smlbb'           , smlbb           )
90         CALL iom_rstput( kt, nitrst, nummxlw, 'smlbn'           , smlbn           )
91         CALL iom_rstput( kt, nitrst, nummxlw, 'smlatfb'         , smlatfb         )
92      ELSE
93         CALL iom_rstput( kt, nitrst, nummxlw, 'hmxlbn'          , hmxlbn          )
94
95         !-- Temperature
96         CALL iom_rstput( kt, nitrst, nummxlw, 'tmlbn'           , tmlbn           )
97         CALL iom_rstput( kt, nitrst, nummxlw, 'tml_sumb'        , tml_sumb        )
98         DO jk = 1, jpltrd
99            IF( jk < 10 ) THEN   ;   WRITE(charout,FMT="('tmltrd_csum_ub_', I1)")   jk
100            ELSE                 ;   WRITE(charout,FMT="('tmltrd_csum_ub_', I2)")   jk
101            ENDIF
102            CALL iom_rstput( kt, nitrst, nummxlw, charout,  tmltrd_csum_ub(:,:,jk) )
103         ENDDO
104         CALL iom_rstput( kt, nitrst, nummxlw, 'tmltrd_atf_sumb' , tmltrd_atf_sumb )
105
106         !-- Salinity
107         CALL iom_rstput( kt, nitrst, nummxlw, 'smlbn'           , smlbn           )
108         CALL iom_rstput( kt, nitrst, nummxlw, 'sml_sumb'        , sml_sumb        )
109         DO jk = 1, jpltrd
110            IF( jk < 10 ) THEN   ;   WRITE(charout,FMT="('smltrd_csum_ub_', I1)")   jk
111            ELSE                 ;   WRITE(charout,FMT="('smltrd_csum_ub_', I2)")   jk
112            ENDIF
113            CALL iom_rstput( kt, nitrst, nummxlw, charout , smltrd_csum_ub(:,:,jk) )
114         ENDDO
115         CALL iom_rstput( kt, nitrst, nummxlw, 'smltrd_atf_sumb' , smltrd_atf_sumb )
116      ENDIF
117      !
118      IF( kt == nitrst ) THEN
119         CALL iom_close( nummxlw )     ! close the restart file (only at last time step)
120         lrst_oce = .FALSE.
121      ENDIF
122      !
123   END SUBROUTINE trd_mxl_rst_write
124
125
126   SUBROUTINE trd_mxl_rst_read
127      !!----------------------------------------------------------------------------
128      !!                   ***  SUBROUTINE trd_mxl_rst_lec  ***
129      !!                   
130      !! ** Purpose :   Read file for mixed-layer diagnostics restart.
131      !!----------------------------------------------------------------------------
132      INTEGER  ::  inum       ! temporary logical unit
133      !
134      CHARACTER (len=35) :: charout
135      INTEGER ::   jk         ! loop indice
136      INTEGER ::   jlibalt = jprstlib
137      LOGICAL ::   llok
138      CHARACTER(LEN=256)  ::   clpath   ! full path to restart file
139      !!-----------------------------------------------------------------------------
140
141      IF(lwp)  THEN
142         WRITE(numout,*)
143         WRITE(numout,*) ' trd_mxl_rst_read : read the NetCDF mixed layer trend restart file'
144         WRITE(numout,*) ' ~~~~~~~~~~~~~~~~'
145      ENDIF
146
147      clpath = TRIM(cn_ocerst_indir)
148      IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
149
150      IF ( jprstlib == jprstdimg ) THEN
151         ! eventually read netcdf file (monobloc)  for restarting on different number of processors
152         ! if {cn_trdrst_in}.nc exists, then set jlibalt to jpnf90
153         INQUIRE( FILE = TRIM(clpath)//TRIM(cn_trdrst_in)//'.nc', EXIST = llok )
154         IF ( llok ) THEN   ;   jlibalt = jpnf90   
155         ELSE               ;   jlibalt = jprstlib   
156         ENDIF
157      ENDIF
158
159      CALL iom_open( TRIM(clpath)//TRIM(cn_trdrst_in), inum, kiolib = jlibalt ) 
160
161      IF( ln_trdmxl_instant ) THEN 
162         !-- Temperature
163         CALL iom_get( inum, jpdom_autoglo, 'tmlbb'           , tmlbb          )
164         CALL iom_get( inum, jpdom_autoglo, 'tmlbn'           , tmlbn          )
165         CALL iom_get( inum, jpdom_autoglo, 'tmlatfb'         , tmlatfb        )
166         !
167         !-- Salinity
168         CALL iom_get( inum, jpdom_autoglo, 'smlbb'           , smlbb          )
169         CALL iom_get( inum, jpdom_autoglo, 'smlbn'           , smlbn          )
170         CALL iom_get( inum, jpdom_autoglo, 'smlatfb'         , smlatfb        )
171      ELSE
172         CALL iom_get( inum, jpdom_autoglo, 'hmxlbn'          , hmxlbn         ) ! needed for hmxl_sum
173         !
174         !-- Temperature
175         CALL iom_get( inum, jpdom_autoglo, 'tmlbn'           , tmlbn          ) ! needed for tml_sum
176         CALL iom_get( inum, jpdom_autoglo, 'tml_sumb'        , tml_sumb       )
177         DO jk = 1, jpltrd
178            IF( jk < 10 ) THEN   ;   WRITE(charout,FMT="('tmltrd_csum_ub_', I1)")   jk
179            ELSE                 ;   WRITE(charout,FMT="('tmltrd_csum_ub_', I2)")   jk
180            ENDIF
181            CALL iom_get( inum, jpdom_autoglo, charout, tmltrd_csum_ub(:,:,jk) )
182         END DO
183         CALL iom_get( inum, jpdom_autoglo, 'tmltrd_atf_sumb' , tmltrd_atf_sumb)
184         !
185         !-- Salinity
186         CALL iom_get( inum, jpdom_autoglo, 'smlbn'           , smlbn          ) ! needed for sml_sum
187         CALL iom_get( inum, jpdom_autoglo, 'sml_sumb'        , sml_sumb       )
188         DO jk = 1, jpltrd
189            IF( jk < 10 ) THEN   ;   WRITE(charout,FMT="('smltrd_csum_ub_', I1)")   jk
190            ELSE                 ;   WRITE(charout,FMT="('smltrd_csum_ub_', I2)")   jk
191            ENDIF
192            CALL iom_get( inum, jpdom_autoglo, charout, smltrd_csum_ub(:,:,jk) )
193         END DO
194         CALL iom_get( inum, jpdom_autoglo, 'smltrd_atf_sumb' , smltrd_atf_sumb)
195         !
196         CALL iom_close( inum )
197      ENDIF
198      !
199   END SUBROUTINE trd_mxl_rst_read
200 
201  !!=================================================================================
202END MODULE trdmxl_rst
Note: See TracBrowser for help on using the repository browser.