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.
sbcssm.F90 in branches/UKMO/r6232_HZG_WAVE-coupling/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/r6232_HZG_WAVE-coupling/NEMOGCM/NEMO/OPA_SRC/SBC/sbcssm.F90 @ 9259

Last change on this file since 9259 was 9259, checked in by jcastill, 6 years ago

Changes to stop reading and using the pressure forcing file when coupling to the atmospheric mean sea level pressure
File size: 17.4 KB
Line 
1MODULE sbcssm
2   !!======================================================================
3   !!                       ***  MODULE  sbcssm  ***
4   !! Surface module :  provide time-mean ocean surface variables
5   !!======================================================================
6   !! History :  9.0  ! 2006-07  (G. Madec)  Original code
7   !!            3.3  ! 2010-10  (C. Bricaud, G. Madec)  add the Patm forcing for sea-ice
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   sbc_ssm        : calculate sea surface mean currents, temperature, 
12   !!                    and salinity over nn_fsbc time-step
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and tracers
15   USE dom_oce         ! ocean space and time domain
16   USE sbc_oce         ! surface boundary condition: ocean fields
17   USE sbcapr          ! surface boundary condition: atmospheric pressure
18   USE eosbn2          ! equation of state and related derivatives
19   !
20   USE in_out_manager  ! I/O manager
21   USE prtctl          ! Print control
22   USE iom             ! IOM library
23
24   IMPLICIT NONE
25   PRIVATE
26
27   PUBLIC   sbc_ssm         ! routine called by step.F90
28   PUBLIC   sbc_ssm_cpl     ! routine called by sbccpl.F90
29   PUBLIC   sbc_ssm_init    ! routine called by sbcmod.F90
30
31   LOGICAL, SAVE  ::   l_ssm_mean = .FALSE.       ! keep track of whether means have been read
32                                                  ! from restart file
33   
34   !! * Substitutions
35#  include "domzgr_substitute.h90"
36   !!----------------------------------------------------------------------
37   !! NEMO/OPA 3.3 , NEMO Consortium (2010)
38   !! $Id$
39   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
40   !!----------------------------------------------------------------------
41CONTAINS
42
43   SUBROUTINE sbc_ssm( kt )
44      !!---------------------------------------------------------------------
45      !!                     ***  ROUTINE sbc_oce  ***
46      !!                     
47      !! ** Purpose :   provide ocean surface variable to sea-surface boundary
48      !!                condition computation
49      !!               
50      !! ** Method  :   compute mean surface velocity (2 components at U and
51      !!      V-points) [m/s], temperature [Celcius] and salinity [psu] over
52      !!      the periode (kt - nn_fsbc) to kt
53      !!         Note that the inverse barometer ssh (i.e. ssh associated with Patm)
54      !!      is add to ssh_m when ln_apr_dyn = T. Required for sea-ice dynamics.
55      !!---------------------------------------------------------------------
56      INTEGER, INTENT(in) ::   kt   ! ocean time step
57      !
58      INTEGER  ::   ji, jj               ! loop index
59      REAL(wp) ::   zcoef, zf_sbc       ! local scalar
60      REAL(wp), DIMENSION(jpi,jpj,jpts) :: zts
61      !!---------------------------------------------------------------------
62
63      !                                        !* surface T-, U-, V- ocean level variables (T, S, depth, velocity)
64      DO jj = 1, jpj
65         DO ji = 1, jpi
66            zts(ji,jj,jp_tem) = tsn(ji,jj,mikt(ji,jj),jp_tem)
67            zts(ji,jj,jp_sal) = tsn(ji,jj,mikt(ji,jj),jp_sal)
68         END DO
69      END DO
70      !
71      IF( nn_fsbc == 1 ) THEN                             !   Instantaneous surface fields        !
72         !                                                ! ---------------------------------------- !
73         ssu_m(:,:) = ub(:,:,1)
74         ssv_m(:,:) = vb(:,:,1)
75         IF( ln_useCT )  THEN    ;   sst_m(:,:) = eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
76         ELSE                    ;   sst_m(:,:) = zts(:,:,jp_tem)
77         ENDIF
78         sss_m(:,:) = zts(:,:,jp_sal)
79         !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
80         IF( .NOT. cpl_mslp ) THEN
81            IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
82            ELSE                    ;   ssh_m(:,:) = sshn(:,:)
83            ENDIF
84         ENDIF
85         !
86         IF( lk_vvl )   e3t_m(:,:) = fse3t_n(:,:,1)
87         !
88         frq_m(:,:) = fraqsr_1lev(:,:)
89         !
90      ELSE
91         !                                                ! ----------------------------------------------- !
92         IF( kt == nit000 .AND. .NOT. l_ssm_mean ) THEN   !   Initialisation: 1st time-step, no input means !
93            !                                             ! ----------------------------------------------- !
94            IF(lwp) WRITE(numout,*)
95            IF(lwp) WRITE(numout,*) '~~~~~~~   mean fields initialised to instantaneous values'
96            zcoef = REAL( nn_fsbc - 1, wp )
97            ssu_m(:,:) = zcoef * ub(:,:,1)
98            ssv_m(:,:) = zcoef * vb(:,:,1)
99            IF( ln_useCT )  THEN    ;   sst_m(:,:) = zcoef * eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
100            ELSE                    ;   sst_m(:,:) = zcoef * zts(:,:,jp_tem)
101            ENDIF
102            sss_m(:,:) = zcoef * zts(:,:,jp_sal)
103            !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
104            IF( .NOT. cpl_mslp ) THEN
105               IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = zcoef * ( sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) )
106               ELSE                    ;   ssh_m(:,:) = zcoef * sshn(:,:)
107               ENDIF
108            ENDIF
109            !
110            IF( lk_vvl )   e3t_m(:,:) = zcoef * fse3t_n(:,:,1)
111            !
112            frq_m(:,:) = zcoef * fraqsr_1lev(:,:)
113            !                                             ! ---------------------------------------- !
114         ELSEIF( MOD( kt - 2 , nn_fsbc ) == 0 ) THEN      !   Initialisation: New mean computation   !
115            !                                             ! ---------------------------------------- !
116            ssu_m(:,:) = 0.e0      ! reset to zero ocean mean sbc fields
117            ssv_m(:,:) = 0.e0
118            sst_m(:,:) = 0.e0
119            sss_m(:,:) = 0.e0
120            IF( .NOT. cpl_mslp ) ssh_m(:,:) = 0.e0
121            IF( lk_vvl )   e3t_m(:,:) = 0.e0
122            frq_m(:,:) = 0.e0
123         ENDIF
124         !                                                ! ---------------------------------------- !
125         !                                                !        Cumulate at each time step        !
126         !                                                ! ---------------------------------------- !
127         ssu_m(:,:) = ssu_m(:,:) + ub(:,:,1)
128         ssv_m(:,:) = ssv_m(:,:) + vb(:,:,1)
129         IF( ln_useCT )  THEN    ;   sst_m(:,:) = sst_m(:,:) + eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
130         ELSE                    ;   sst_m(:,:) = sst_m(:,:) + zts(:,:,jp_tem)
131         ENDIF
132         sss_m(:,:) = sss_m(:,:) + zts(:,:,jp_sal)
133         !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
134         IF( .NOT. cpl_mslp ) THEN
135            IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
136            ELSE                    ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:)
137            ENDIF
138         ENDIF
139         !
140         IF( lk_vvl )   e3t_m(:,:) = fse3t_m(:,:) + fse3t_n(:,:,1)
141         !
142         frq_m(:,:) =   frq_m(:,:) + fraqsr_1lev(:,:)
143
144         !                                                ! ---------------------------------------- !
145         IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
146            !                                             ! ---------------------------------------- !
147            zcoef = 1. / REAL( nn_fsbc, wp )
148            sst_m(:,:) = sst_m(:,:) * zcoef           ! mean SST             [Celcius]
149            sss_m(:,:) = sss_m(:,:) * zcoef           ! mean SSS             [psu]
150            ssu_m(:,:) = ssu_m(:,:) * zcoef           ! mean suface current  [m/s]
151            ssv_m(:,:) = ssv_m(:,:) * zcoef           !
152            IF( .NOT. cpl_mslp ) ssh_m(:,:) = ssh_m(:,:) * zcoef           ! mean SSH             [m]
153            IF( lk_vvl )   e3t_m(:,:) = fse3t_m(:,:) * zcoef   ! mean vertical scale factor [m]
154            frq_m(:,:) = frq_m(:,:) * zcoef   ! mean fraction of solar net radiation absorbed in the 1st T level [-]
155            !
156         ENDIF
157         !                                                ! ---------------------------------------- !
158         IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
159            !                                             ! ---------------------------------------- !
160            IF(lwp) WRITE(numout,*)
161            IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields written in ocean restart file ',   &
162               &                    'at it= ', kt,' date= ', ndastp
163            IF(lwp) WRITE(numout,*) '~~~~~~~'
164            zf_sbc = REAL( nn_fsbc, wp )
165            CALL iom_rstput( kt, nitrst, numrow, 'nn_fsbc', zf_sbc )    ! sbc frequency
166            CALL iom_rstput( kt, nitrst, numrow, 'ssu_m'  , ssu_m  )    ! sea surface mean fields
167            CALL iom_rstput( kt, nitrst, numrow, 'ssv_m'  , ssv_m  )
168            CALL iom_rstput( kt, nitrst, numrow, 'sst_m'  , sst_m  )
169            CALL iom_rstput( kt, nitrst, numrow, 'sss_m'  , sss_m  )
170            IF( .NOT. cpl_mslp ) CALL iom_rstput( kt, nitrst, numrow, 'ssh_m'  , ssh_m  )
171            IF( lk_vvl )   CALL iom_rstput( kt, nitrst, numrow, 'e3t_m'  , e3t_m  )
172            CALL iom_rstput( kt, nitrst, numrow, 'frq_m'  , frq_m  )
173            !
174         ENDIF
175         !
176      ENDIF
177      !
178      IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
179         CALL iom_put( 'ssu_m', ssu_m )
180         CALL iom_put( 'ssv_m', ssv_m )
181         CALL iom_put( 'sst_m', sst_m )
182         CALL iom_put( 'sss_m', sss_m )
183         IF( .NOT. cpl_mslp ) CALL iom_put( 'ssh_m', ssh_m )
184         IF( lk_vvl )   CALL iom_put( 'e3t_m', e3t_m )
185         CALL iom_put( 'frq_m', frq_m )
186      ENDIF
187      !
188   END SUBROUTINE sbc_ssm
189
190   SUBROUTINE sbc_ssm_cpl( kt )
191      !!---------------------------------------------------------------------
192      !!                   ***  ROUTINE sbc_ssm_cpl  ***
193      !!                     
194      !! ** Purpose :   provide ocean surface variable to sea-surface boundary
195      !!                condition computation when pressure is read from coupling
196      !!               
197      !! ** Method  :   The inverse barometer ssh (i.e. ssh associated with Patm)
198      !!                is added to ssh_m when ln_apr_dyn = T. Required for sea-ice dynamics.
199      !!---------------------------------------------------------------------
200      INTEGER, INTENT(in) ::   kt   ! ocean time step
201      !
202      REAL(wp) ::   zcoef       ! local scalar
203      !!---------------------------------------------------------------------
204      !
205      IF( nn_fsbc == 1 ) THEN                             !   Instantaneous surface fields        !
206         !                                                ! ---------------------------------------- !
207         IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
208         ELSE                    ;   ssh_m(:,:) = sshn(:,:)
209         ENDIF
210      ELSE
211         !                                                ! ----------------------------------------------- !
212         IF( kt == nit000 .AND. .NOT. l_ssm_mean ) THEN   !   Initialisation: 1st time-step, no input means !
213            !                                             ! ----------------------------------------------- !
214            IF(lwp) WRITE(numout,*)
215            IF(lwp) WRITE(numout,*) '~~~~~~~   mean ssh field initialised to instantaneous values'
216            zcoef = REAL( nn_fsbc - 1, wp )
217            zcoef = REAL( nn_fsbc - 1, wp )
218            IF( ln_apr_dyn ) THEN    ;  ssh_m(:,:) = zcoef * ( sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) )
219            ELSE                     ;  ssh_m(:,:) = zcoef * sshn(:,:)
220            ENDIF
221            !                                             ! ---------------------------------------- !
222         ELSEIF( MOD( kt - 2 , nn_fsbc ) == 0 ) THEN      !   Initialisation: New mean computation   !
223            !                                             ! ---------------------------------------- !
224            ssh_m(:,:) = 0.e0
225         ENDIF
226
227         IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
228         ELSE                    ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:)
229         ENDIF
230         !                                                ! ---------------------------------------- !
231         IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
232            !                                             ! ---------------------------------------- !
233            zcoef = 1. / REAL( nn_fsbc, wp )
234            ssh_m(:,:) = ssh_m(:,:) * zcoef           ! mean SSH             [m]
235         ENDIF
236         !                                                ! ---------------------------------------- !
237         IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
238            !                                             ! ---------------------------------------- !
239            IF(lwp) WRITE(numout,*)
240            IF(lwp) WRITE(numout,*) 'sbc_ssm_cpl : ssh mean field written in ocean restart file ',   &
241               &                    'at it= ', kt,' date= ', ndastp
242            IF(lwp) WRITE(numout,*) '~~~~~~~'
243            CALL iom_rstput( kt, nitrst, numrow, 'ssh_m'  , ssh_m  )
244         ENDIF
245      ENDIF
246      !
247      IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
248         CALL iom_put( 'ssh_m', ssh_m )
249      ENDIF
250      !
251   END SUBROUTINE sbc_ssm_cpl
252
253   SUBROUTINE sbc_ssm_init
254      !!----------------------------------------------------------------------
255      !!                  ***  ROUTINE sbc_ssm_init  ***
256      !!
257      !! ** Purpose :   Initialisation of the sbc data
258      !!
259      !! ** Action  : - read parameters
260      !!----------------------------------------------------------------------
261      REAL(wp) ::   zcoef, zf_sbc       ! local scalar
262      !!----------------------------------------------------------------------
263
264      IF( nn_fsbc == 1 ) THEN
265         !
266         IF(lwp) WRITE(numout,*)
267         IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields, nn_fsbc=1 : instantaneous values'
268         IF(lwp) WRITE(numout,*) '~~~~~~~ '
269         !
270      ELSE
271         !               
272         IF(lwp) WRITE(numout,*)
273         IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields'
274         IF(lwp) WRITE(numout,*) '~~~~~~~ '
275         !
276         IF( ln_rstart .AND. iom_varid( numror, 'nn_fsbc', ldstop = .FALSE. ) > 0 ) THEN
277            l_ssm_mean = .TRUE.
278            CALL iom_get( numror               , 'nn_fsbc', zf_sbc )   ! sbc frequency of previous run
279            CALL iom_get( numror, jpdom_autoglo, 'ssu_m'  , ssu_m  )   ! sea surface mean velocity    (T-point)
280            CALL iom_get( numror, jpdom_autoglo, 'ssv_m'  , ssv_m  )   !   "         "    velocity    (V-point)
281            CALL iom_get( numror, jpdom_autoglo, 'sst_m'  , sst_m  )   !   "         "    temperature (T-point)
282            CALL iom_get( numror, jpdom_autoglo, 'sss_m'  , sss_m  )   !   "         "    salinity    (T-point)
283            CALL iom_get( numror, jpdom_autoglo, 'ssh_m'  , ssh_m  )   !   "         "    height      (T-point)
284            IF( lk_vvl ) CALL iom_get( numror, jpdom_autoglo, 'e3t_m', e3t_m )
285            ! fraction of solar net radiation absorbed in 1st T level
286            IF( iom_varid( numror, 'frq_m', ldstop = .FALSE. ) > 0 ) THEN
287               CALL iom_get( numror, jpdom_autoglo, 'frq_m'  , frq_m  )
288            ELSE
289               frq_m(:,:) = 1._wp   ! default definition
290            ENDIF
291            !
292            IF( zf_sbc /= REAL( nn_fsbc, wp ) ) THEN      ! nn_fsbc has changed between 2 runs
293               IF(lwp) WRITE(numout,*) '~~~~~~~   restart with a change in the frequency of mean ',   &
294                  &                    'from ', zf_sbc, ' to ', nn_fsbc 
295               zcoef = REAL( nn_fsbc - 1, wp ) / zf_sbc 
296               ssu_m(:,:) = zcoef * ssu_m(:,:) 
297               ssv_m(:,:) = zcoef * ssv_m(:,:)
298               sst_m(:,:) = zcoef * sst_m(:,:)
299               sss_m(:,:) = zcoef * sss_m(:,:)
300               ssh_m(:,:) = zcoef * ssh_m(:,:)
301               IF( lk_vvl )   e3t_m(:,:) = zcoef * fse3t_m(:,:)
302               frq_m(:,:) = zcoef * frq_m(:,:)
303            ELSE
304               IF(lwp) WRITE(numout,*) '~~~~~~~   mean fields read in the ocean restart file'
305            ENDIF
306         ENDIF
307      ENDIF
308      !
309      IF( .NOT. l_ssm_mean ) THEN   ! default initialisation. needed by lim_istate
310         !
311         IF(lwp) WRITE(numout,*) '          default initialisation of ss?_m arrays'
312         ssu_m(:,:) = ub(:,:,1)
313         ssv_m(:,:) = vb(:,:,1)
314         IF( ln_useCT )  THEN    ;   sst_m(:,:) = eos_pt_from_ct( tsn(:,:,1,jp_tem), tsn(:,:,1,jp_sal) )
315         ELSE                    ;   sst_m(:,:) = tsn(:,:,1,jp_tem)
316         ENDIF
317         sss_m(:,:) = tsn(:,:,1,jp_sal)
318         ssh_m(:,:) = sshn(:,:)
319         IF( lk_vvl )   e3t_m(:,:) = fse3t_n(:,:,1)
320         frq_m(:,:) = 1._wp
321         !
322      ENDIF
323      !
324   END SUBROUTINE sbc_ssm_init
325
326   !!======================================================================
327END MODULE sbcssm
Note: See TracBrowser for help on using the repository browser.