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/dev_r8126_LIM3_couple/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/dev_r8126_LIM3_couple/NEMOGCM/NEMO/OPA_SRC/SBC/sbcssm.F90 @ 8892

Last change on this file since 8892 was 8892, checked in by frrh, 7 years ago

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