source: NEMO/branches/UKMO/NEMO_4.0_add_pond_lids_prints/src/OCE/SBC/sbcssm.F90 @ 12475

Last change on this file since 12475 was 12475, checked in by dancopsey, 12 months ago
  • Add more print statements.
  • Move away from using snow to ice diagnostics and use a new snow to pond one instead.
File size: 15.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   !!            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   USE traqsr, ONLY: ln_traqsr
21   !
22   USE in_out_manager ! I/O manager
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/OCE 4.0 , NEMO Consortium (2018)
36   !! $Id$
37   !! Software governed by the CeCILL license (see ./LICENSE)
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      write(numout,*)'sbcssm 1: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
62      !                                        !* surface T-, U-, V- ocean level variables (T, S, depth, velocity)
63      DO jj = 1, jpj
64         DO ji = 1, jpi
65            zts(ji,jj,jp_tem) = tsn(ji,jj,mikt(ji,jj),jp_tem)
66            zts(ji,jj,jp_sal) = tsn(ji,jj,mikt(ji,jj),jp_sal)
67         END DO
68      END DO
69      !
70      IF( nn_fsbc == 1 ) THEN                             !   Instantaneous surface fields        !
71         !                                                ! ---------------------------------------- !
72         ssu_m(:,:) = ub(:,:,1)
73         ssv_m(:,:) = vb(:,:,1)
74         IF( l_useCT )  THEN    ;   sst_m(:,:) = eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
75         ELSE                    ;   sst_m(:,:) = zts(:,:,jp_tem)
76         ENDIF
77         sss_m(:,:) = zts(:,:,jp_sal)
78         !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
79         IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
80         ELSE                    ;   ssh_m(:,:) = sshn(:,:)
81         ENDIF
82         !
83         e3t_m(:,:) = e3t_n(:,:,1)
84         !
85         frq_m(:,:) = fraqsr_1lev(:,:)
86         write(numout,*)'sbcssm 2: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
87         !
88      ELSE
89         !                                                ! ----------------------------------------------- !
90         IF( kt == nit000 .AND. .NOT. l_ssm_mean ) THEN   !   Initialisation: 1st time-step, no input means !
91            !                                             ! ----------------------------------------------- !
92            IF(lwp) WRITE(numout,*)
93            IF(lwp) WRITE(numout,*) 'sbc_ssm : mean fields initialised to instantaneous values'
94            IF(lwp) WRITE(numout,*) '~~~~~~~   '
95            zcoef = REAL( nn_fsbc - 1, wp )
96            ssu_m(:,:) = zcoef * ub(:,:,1)
97            ssv_m(:,:) = zcoef * vb(:,:,1)
98            IF( l_useCT )  THEN    ;   sst_m(:,:) = zcoef * eos_pt_from_ct( zts(:,:,jp_tem), zts(:,:,jp_sal) )
99            ELSE                    ;   sst_m(:,:) = zcoef * zts(:,:,jp_tem)
100            ENDIF
101            sss_m(:,:) = zcoef * zts(:,:,jp_sal)
102            !                          ! removed inverse barometer ssh when Patm forcing is used (for sea-ice dynamics)
103            IF( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = zcoef * ( sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) ) )
104            ELSE                    ;   ssh_m(:,:) = zcoef * sshn(:,:)
105            ENDIF
106            !
107            e3t_m(:,:) = zcoef * e3t_n(:,:,1)
108            !
109            frq_m(:,:) = zcoef * fraqsr_1lev(:,:)
110            write(numout,*)'sbcssm 3: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
111            !                                             ! ---------------------------------------- !
112         ELSEIF( MOD( kt - 2 , nn_fsbc ) == 0 ) THEN      !   Initialisation: New mean computation   !
113            !                                             ! ---------------------------------------- !
114            ssu_m(:,:) = 0._wp     ! reset to zero ocean mean sbc fields
115            ssv_m(:,:) = 0._wp
116            sst_m(:,:) = 0._wp
117            sss_m(:,:) = 0._wp
118            ssh_m(:,:) = 0._wp
119            e3t_m(:,:) = 0._wp
120            frq_m(:,:) = 0._wp
121            write(numout,*)'sbcssm 4: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
122         ENDIF
123         !                                                ! ---------------------------------------- !
124         !                                                !        Cumulate at each time step        !
125         !                                                ! ---------------------------------------- !
126         ssu_m(:,:) = ssu_m(:,:) + ub(:,:,1)
127         write(numout,*)'sbcssm 5: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
128         ssv_m(:,:) = ssv_m(:,:) + vb(:,:,1)
129         IF( l_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( ln_apr_dyn ) THEN   ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:) - 0.5 * ( ssh_ib(:,:) + ssh_ibb(:,:) )
135         ELSE                    ;   ssh_m(:,:) = ssh_m(:,:) + sshn(:,:)
136         ENDIF
137         !
138         e3t_m(:,:) = e3t_m(:,:) + e3t_n(:,:,1)
139         !
140         frq_m(:,:) = frq_m(:,:) + fraqsr_1lev(:,:)
141
142         !                                                ! ---------------------------------------- !
143         IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
144            !                                             ! ---------------------------------------- !
145            zcoef = 1. / REAL( nn_fsbc, wp )
146            sst_m(:,:) = sst_m(:,:) * zcoef     ! mean SST             [Celsius]
147            sss_m(:,:) = sss_m(:,:) * zcoef     ! mean SSS             [psu]
148            ssu_m(:,:) = ssu_m(:,:) * zcoef     ! mean suface current  [m/s]
149            ssv_m(:,:) = ssv_m(:,:) * zcoef     !
150            ssh_m(:,:) = ssh_m(:,:) * zcoef     ! mean SSH             [m]
151            e3t_m(:,:) = e3t_m(:,:) * zcoef     ! mean vertical scale factor [m]
152            frq_m(:,:) = frq_m(:,:) * zcoef     ! mean fraction of solar net radiation absorbed in the 1st T level [-]
153            write(numout,*)'sbcssm 6: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
154            !
155         ENDIF
156         !                                                ! ---------------------------------------- !
157         IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
158            !                                             ! ---------------------------------------- !
159            IF(lwp) WRITE(numout,*)
160            IF(lwp) WRITE(numout,*) 'sbc_ssm : sea surface mean fields written in ocean restart file ',   &
161               &                    'at it= ', kt,' date= ', ndastp
162            IF(lwp) WRITE(numout,*) '~~~~~~~'
163            zf_sbc = REAL( nn_fsbc, wp )
164            IF( lwxios ) CALL iom_swap(      cwxios_context          )
165            CALL iom_rstput( kt, nitrst, numrow, 'nn_fsbc', zf_sbc, ldxios = lwxios )    ! sbc frequency
166            CALL iom_rstput( kt, nitrst, numrow, 'ssu_m'  , ssu_m, ldxios = lwxios  )    ! sea surface mean fields
167            CALL iom_rstput( kt, nitrst, numrow, 'ssv_m'  , ssv_m, ldxios = lwxios  )
168            CALL iom_rstput( kt, nitrst, numrow, 'sst_m'  , sst_m, ldxios = lwxios  )
169            CALL iom_rstput( kt, nitrst, numrow, 'sss_m'  , sss_m, ldxios = lwxios  )
170            CALL iom_rstput( kt, nitrst, numrow, 'ssh_m'  , ssh_m, ldxios = lwxios  )
171            CALL iom_rstput( kt, nitrst, numrow, 'e3t_m'  , e3t_m, ldxios = lwxios  )
172            CALL iom_rstput( kt, nitrst, numrow, 'frq_m'  , frq_m, ldxios = lwxios  )
173            !
174            IF( lwxios ) CALL iom_swap(      cxios_context          )
175            write(numout,*)'sbcssm 7: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
176         ENDIF
177         !
178      ENDIF
179      !
180      IF( MOD( kt - 1 , nn_fsbc ) == 0 ) THEN          !   Mean value at each nn_fsbc time-step   !
181         CALL iom_put( 'ssu_m', ssu_m )
182         CALL iom_put( 'ssv_m', ssv_m )
183         CALL iom_put( 'sst_m', sst_m )
184         CALL iom_put( 'sss_m', sss_m )
185         CALL iom_put( 'ssh_m', ssh_m )
186         CALL iom_put( 'e3t_m', e3t_m )
187         CALL iom_put( 'frq_m', frq_m )
188      ENDIF
189
190      write(numout,*)'sbcssm 8: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
191
192      !
193   END SUBROUTINE sbc_ssm
194
195
196   SUBROUTINE sbc_ssm_init
197      !!----------------------------------------------------------------------
198      !!                  ***  ROUTINE sbc_ssm_init  ***
199      !!
200      !! ** Purpose :   Initialisation of the sbc data
201      !!
202      !! ** Action  : - read parameters
203      !!----------------------------------------------------------------------
204      REAL(wp) ::   zcoef, zf_sbc   ! local scalar
205      !!----------------------------------------------------------------------
206      !
207
208      write(numout,*)'sbcssm 1: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
209
210      IF( nn_fsbc == 1 ) THEN
211         !
212         IF(lwp) WRITE(numout,*)
213         IF(lwp) WRITE(numout,*) 'sbc_ssm_init : sea surface mean fields, nn_fsbc=1 : instantaneous values'
214         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~ '
215         !
216      ELSE
217         !               
218         IF(lwp) WRITE(numout,*)
219         IF(lwp) WRITE(numout,*) 'sbc_ssm_init : sea surface mean fields'
220         IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~ '
221         !
222         IF( ln_rstart .AND. iom_varid( numror, 'nn_fsbc', ldstop = .FALSE. ) > 0 ) THEN
223            l_ssm_mean = .TRUE.
224            CALL iom_get( numror               , 'nn_fsbc', zf_sbc, ldxios = lrxios )    ! sbc frequency of previous run
225            CALL iom_get( numror, jpdom_autoglo, 'ssu_m'  , ssu_m, ldxios = lrxios  )    ! sea surface mean velocity    (U-point)
226            CALL iom_get( numror, jpdom_autoglo, 'ssv_m'  , ssv_m, ldxios = lrxios  )    !   "         "    velocity    (V-point)
227            CALL iom_get( numror, jpdom_autoglo, 'sst_m'  , sst_m, ldxios = lrxios  )    !   "         "    temperature (T-point)
228            CALL iom_get( numror, jpdom_autoglo, 'sss_m'  , sss_m, ldxios = lrxios  )    !   "         "    salinity    (T-point)
229            CALL iom_get( numror, jpdom_autoglo, 'ssh_m'  , ssh_m, ldxios = lrxios  )    !   "         "    height      (T-point)
230            CALL iom_get( numror, jpdom_autoglo, 'e3t_m'  , e3t_m, ldxios = lrxios  )    ! 1st level thickness          (T-point)
231
232            write(numout,*)'sbcssm 2: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
233
234            ! fraction of solar net radiation absorbed in 1st T level
235            IF( iom_varid( numror, 'frq_m', ldstop = .FALSE. ) > 0 ) THEN
236               CALL iom_get( numror, jpdom_autoglo, 'frq_m'  , frq_m, ldxios = lrxios  )
237            ELSE
238               frq_m(:,:) = 1._wp   ! default definition
239            ENDIF
240            !
241            IF( zf_sbc /= REAL( nn_fsbc, wp ) ) THEN      ! nn_fsbc has changed between 2 runs
242               IF(lwp) WRITE(numout,*) '   restart with a change in the frequency of mean from ', zf_sbc, ' to ', nn_fsbc 
243               zcoef = REAL( nn_fsbc - 1, wp ) / zf_sbc 
244               ssu_m(:,:) = zcoef * ssu_m(:,:) 
245               ssv_m(:,:) = zcoef * ssv_m(:,:)
246               sst_m(:,:) = zcoef * sst_m(:,:)
247               sss_m(:,:) = zcoef * sss_m(:,:)
248               ssh_m(:,:) = zcoef * ssh_m(:,:)
249               e3t_m(:,:) = zcoef * e3t_m(:,:)
250               frq_m(:,:) = zcoef * frq_m(:,:)
251               write(numout,*)'sbcssm 3: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
252            ELSE
253               IF(lwp) WRITE(numout,*) '   mean fields read in the ocean restart file'
254            ENDIF
255         ENDIF
256      ENDIF
257
258      write(numout,*)'sbcssm 4: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
259
260      !
261      IF( .NOT.l_ssm_mean ) THEN   ! default initialisation. needed by iceistate
262         !
263         IF(lwp) WRITE(numout,*) '   default initialisation of ss._m arrays'
264         ssu_m(:,:) = ub(:,:,1)
265         ssv_m(:,:) = vb(:,:,1)
266         IF( l_useCT )  THEN    ;   sst_m(:,:) = eos_pt_from_ct( tsn(:,:,1,jp_tem), tsn(:,:,1,jp_sal) )
267         ELSE                   ;   sst_m(:,:) = tsn(:,:,1,jp_tem)
268         ENDIF
269         sss_m(:,:) = tsn  (:,:,1,jp_sal)
270         ssh_m(:,:) = sshn (:,:)
271         e3t_m(:,:) = e3t_n(:,:,1)
272         frq_m(:,:) = 1._wp
273         !
274      ENDIF
275
276      write(numout,*)'sbcssm 5: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
277
278      !
279      IF( .NOT. ln_traqsr )   fraqsr_1lev(:,:) = 1._wp   ! default definition: qsr 100% in the fisrt level
280      !
281      IF( lwxios.AND.nn_fsbc > 1 ) THEN
282         CALL iom_set_rstw_var_active('nn_fsbc')
283         CALL iom_set_rstw_var_active('ssu_m')
284         CALL iom_set_rstw_var_active('ssv_m')
285         CALL iom_set_rstw_var_active('sst_m')
286         CALL iom_set_rstw_var_active('sss_m')
287         CALL iom_set_rstw_var_active('ssh_m')
288         CALL iom_set_rstw_var_active('e3t_m')
289         CALL iom_set_rstw_var_active('frq_m')
290      ENDIF
291
292      write(numout,*)'sbcssm 6: ssu_m(3,4), ub(3,4,1) = ', ssu_m(3,4), ' ', ub(3,4,1)
293
294   END SUBROUTINE sbc_ssm_init
295
296   !!======================================================================
297END MODULE sbcssm
Note: See TracBrowser for help on using the repository browser.