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.
sbcmod.F90 in branches/UKMO/dev_r8183_ICEMODEL_svn_removed/NEMOGCM/NEMO/OPA_SRC/SBC – NEMO

source: branches/UKMO/dev_r8183_ICEMODEL_svn_removed/NEMOGCM/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 8847

Last change on this file since 8847 was 8847, checked in by alexwestmohc, 6 years ago

Implementing new logicals to control coupling:

ln_meto_cpl - .TRUE. if Met Office style coupling is being used, i.e. if the
surface exchange is in the atmosphere. .FALSE. by default

nn_cats_cpl - the number of sea ice categories over which the coupling is being
carried out. 5 by default

In addition, the calculation of meltpond area, depth, top layer ice/snow temp
and sea surface freezing temperature has been corrected to be appropriate to LIM
variable names.

File size: 31.0 KB
Line 
1MODULE sbcmod
2   !!======================================================================
3   !!                       ***  MODULE  sbcmod  ***
4   !! Surface module :  provide to the ocean its surface boundary condition
5   !!======================================================================
6   !! History :  3.0  ! 2006-07  (G. Madec)  Original code
7   !!            3.1  ! 2008-08  (S. Masson, A. Caubel, E. Maisonnave, G. Madec) coupled interface
8   !!            3.3  ! 2010-04  (M. Leclair, G. Madec)  Forcing averaged over 2 time steps
9   !!            3.3  ! 2010-10  (S. Masson)  add diurnal cycle
10   !!            3.3  ! 2010-09  (D. Storkey) add ice boundary conditions (BDY)
11   !!             -   ! 2010-11  (G. Madec) ice-ocean stress always computed at each ocean time-step
12   !!             -   ! 2010-10  (J. Chanut, C. Bricaud, G. Madec)  add the surface pressure forcing
13   !!            3.4  ! 2011-11  (C. Harris) CICE added as an option
14   !!            3.5  ! 2012-11  (A. Coward, G. Madec) Rethink of heat, mass and salt surface fluxes
15   !!            3.6  ! 2014-11  (P. Mathiot, C. Harris) add ice shelves melting
16   !!            4.0  ! 2016-06  (L. Brodeau) new general bulk formulation
17   !!----------------------------------------------------------------------
18
19   !!----------------------------------------------------------------------
20   !!   sbc_init      : read namsbc namelist
21   !!   sbc           : surface ocean momentum, heat and freshwater boundary conditions
22   !!   sbc_final     : Finalize CICE ice model (if used)
23   !!----------------------------------------------------------------------
24   USE oce            ! ocean dynamics and tracers
25   USE dom_oce        ! ocean space and time domain
26   USE phycst         ! physical constants
27   USE sbc_oce        ! Surface boundary condition: ocean fields
28   USE trc_oce        ! shared ocean-passive tracers variables
29   USE sbc_ice        ! Surface boundary condition: ice fields
30   USE sbcdcy         ! surface boundary condition: diurnal cycle
31   USE sbcssm         ! surface boundary condition: sea-surface mean variables
32   USE sbcflx         ! surface boundary condition: flux formulation
33   USE sbcblk         ! surface boundary condition: bulk formulation
34   USE sbcice_if      ! surface boundary condition: ice-if sea-ice model
35#if defined key_lim3
36   USE icestp         ! surface boundary condition: LIM 3.0 sea-ice model
37#endif
38   USE sbcice_cice    ! surface boundary condition: CICE    sea-ice model
39   USE sbcisf         ! surface boundary condition: ice-shelf
40   USE sbccpl         ! surface boundary condition: coupled formulation
41   USE cpl_oasis3     ! OASIS routines for coupling
42   USE sbcssr         ! surface boundary condition: sea surface restoring
43   USE sbcrnf         ! surface boundary condition: runoffs
44   USE sbcisf         ! surface boundary condition: ice shelf
45   USE sbcfwb         ! surface boundary condition: freshwater budget
46   USE icbstp         ! Icebergs
47   USE traqsr         ! active tracers: light penetration
48   USE sbcwave        ! Wave module
49   USE bdy_oce   , ONLY: ln_bdy
50   USE usrdef_sbc     ! user defined: surface boundary condition
51   USE usrdef_closea  ! user defined: closed sea
52   !
53   USE prtctl         ! Print control                    (prt_ctl routine)
54   USE iom            ! IOM library
55   USE in_out_manager ! I/O manager
56   USE lib_mpp        ! MPP library
57   USE timing         ! Timing
58
59   USE diurnal_bulk, ONLY:   ln_diurnal_only   ! diurnal SST diagnostic
60
61   IMPLICIT NONE
62   PRIVATE
63
64   PUBLIC   sbc        ! routine called by step.F90
65   PUBLIC   sbc_init   ! routine called by opa.F90
66
67   INTEGER ::   nsbc   ! type of surface boundary condition (deduced from namsbc informations)
68
69   !!----------------------------------------------------------------------
70   !! NEMO/OPA 4.0 , NEMO-consortium (2016)
71   !! $Id$
72   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
73   !!----------------------------------------------------------------------
74CONTAINS
75
76   SUBROUTINE sbc_init
77      !!---------------------------------------------------------------------
78      !!                    ***  ROUTINE sbc_init ***
79      !!
80      !! ** Purpose :   Initialisation of the ocean surface boundary computation
81      !!
82      !! ** Method  :   Read the namsbc namelist and set derived parameters
83      !!                Call init routines for all other SBC modules that have one
84      !!
85      !! ** Action  : - read namsbc parameters
86      !!              - nsbc: type of sbc
87      !!----------------------------------------------------------------------
88      INTEGER ::   ios, icpt                         ! local integer
89      LOGICAL ::   ll_purecpl, ll_opa, ll_not_nemo   ! local logical
90      !!
91      NAMELIST/namsbc/ nn_fsbc  ,                                                    &
92         &             ln_usr   , ln_flx   , ln_blk       ,                          &
93         &             ln_cpl   , ln_mixcpl, ln_meto_cpl  , nn_components,           &
94         &             nn_ice   , ln_ice_embd,                                       &
95         &             ln_traqsr, ln_dm2dc ,                                         &
96         &             ln_rnf   , nn_fwb   , ln_ssr   , ln_isf    , ln_apr_dyn ,     &
97         &             ln_wave  , ln_cdgw  , ln_sdw   , ln_tauoc  , ln_stcor   ,     &
98         &             nn_lsm
99      !!----------------------------------------------------------------------
100      !
101      IF(lwp) THEN
102         WRITE(numout,*)
103         WRITE(numout,*) 'sbc_init : surface boundary condition setting'
104         WRITE(numout,*) '~~~~~~~~ '
105      ENDIF
106      !
107      !                       !**  read Surface Module namelist
108      REWIND( numnam_ref )          !* Namelist namsbc in reference namelist : Surface boundary
109      READ  ( numnam_ref, namsbc, IOSTAT = ios, ERR = 901)
110901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namsbc in reference namelist', lwp )
111      !
112      REWIND( numnam_cfg )          !* Namelist namsbc in configuration namelist : Parameters of the run
113      READ  ( numnam_cfg, namsbc, IOSTAT = ios, ERR = 902 )
114902   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namsbc in configuration namelist', lwp )
115      IF(lwm) WRITE( numond, namsbc )
116      !
117      !                             !* overwrite namelist parameter using CPP key information
118#if defined key_agrif
119      IF( Agrif_Root() ) THEN                ! AGRIF zoom (cf r1242: possibility to run without ice in fine grid)
120         IF( lk_lim3 )   nn_ice      = 2
121         IF( lk_cice )   nn_ice      = 3
122      ENDIF
123#else
124      IF( lk_lim3 )   nn_ice      = 2
125      IF( lk_cice )   nn_ice      = 3
126#endif
127      !
128      IF(lwp) THEN                  !* Control print
129         WRITE(numout,*) '   Namelist namsbc (partly overwritten with CPP key setting)'
130         WRITE(numout,*) '      frequency update of sbc (and ice)             nn_fsbc       = ', nn_fsbc
131         WRITE(numout,*) '      Type of air-sea fluxes : '
132         WRITE(numout,*) '         user defined formulation                   ln_usr        = ', ln_usr
133         WRITE(numout,*) '         flux         formulation                   ln_flx        = ', ln_flx
134         WRITE(numout,*) '         bulk         formulation                   ln_blk        = ', ln_blk
135         WRITE(numout,*) '      Type of coupling (Ocean/Ice/Atmosphere) : '
136         WRITE(numout,*) '         ocean-atmosphere coupled formulation       ln_cpl        = ', ln_cpl
137         WRITE(numout,*) '         mixed forced-coupled     formulation       ln_mixcpl     = ', ln_mixcpl
138!!gm  lk_oasis is controlled by key_oasis3  ===>>>  It shoud be removed from the namelist
139         WRITE(numout,*) '         Met Office coupling formulation            ln_mixcpl     = ', ln_meto_cpl
140         WRITE(numout,*) '         OASIS coupling (with atm or sas)           lk_oasis      = ', lk_oasis
141         WRITE(numout,*) '         components of your executable              nn_components = ', nn_components
142         WRITE(numout,*) '      Sea-ice : '
143         WRITE(numout,*) '         ice management in the sbc (=0/1/2/3)       nn_ice        = ', nn_ice
144         WRITE(numout,*) '         ice embedded into ocean                    ln_ice_embd   = ', ln_ice_embd
145         WRITE(numout,*) '      Misc. options of sbc : '
146         WRITE(numout,*) '         Light penetration in temperature Eq.       ln_traqsr     = ', ln_traqsr
147         WRITE(numout,*) '            daily mean to diurnal cycle qsr            ln_dm2dc   = ', ln_dm2dc
148         WRITE(numout,*) '         Sea Surface Restoring on SST and/or SSS    ln_ssr        = ', ln_ssr
149         WRITE(numout,*) '         FreshWater Budget control  (=0/1/2)        nn_fwb        = ', nn_fwb
150         WRITE(numout,*) '         Patm gradient added in ocean & ice Eqs.    ln_apr_dyn    = ', ln_apr_dyn
151         WRITE(numout,*) '         runoff / runoff mouths                     ln_rnf        = ', ln_rnf
152         WRITE(numout,*) '         iceshelf formulation                       ln_isf        = ', ln_isf
153         WRITE(numout,*) '         closed sea (=0/1) (set in namdom)          nn_closea     = ', nn_closea
154         WRITE(numout,*) '         nb of iterations if land-sea-mask applied  nn_lsm        = ', nn_lsm
155         WRITE(numout,*) '         surface wave                               ln_wave       = ', ln_wave
156         WRITE(numout,*) '               Stokes drift corr. to vert. velocity ln_sdw        = ', ln_sdw
157         WRITE(numout,*) '               wave modified ocean stress           ln_tauoc      = ', ln_tauoc
158         WRITE(numout,*) '               Stokes coriolis term                 ln_stcor      = ', ln_stcor
159         WRITE(numout,*) '               neutral drag coefficient (CORE, MFS) ln_cdgw       = ', ln_cdgw
160      ENDIF
161      !
162      IF( .NOT.ln_usr ) THEN     ! the model calendar needs some specificities (except in user defined case)
163         IF( MOD( rday , rdt ) /= 0. )   CALL ctl_stop( 'the time step must devide the number of second of in a day' )
164         IF( MOD( rday , 2.  ) /= 0. )   CALL ctl_stop( 'the number of second of in a day must be an even number'    )
165         IF( MOD( rdt  , 2.  ) /= 0. )   CALL ctl_stop( 'the time step (in second) must be an even number'           )
166      ENDIF
167      !                       !**  check option consistency
168      !
169      IF(lwp) WRITE(numout,*)       !* Single / Multi - executable (NEMO / OPA+SAS)
170      SELECT CASE( nn_components )
171      CASE( jp_iam_nemo )
172         IF(lwp) WRITE(numout,*) '   NEMO configured as a single executable (i.e. including both OPA and Surface module'
173      CASE( jp_iam_opa  )
174         IF(lwp) WRITE(numout,*) '   Multi executable configuration. Here, OPA component'
175         IF( .NOT.lk_oasis )   CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but key_oasis3 disabled' )
176         IF( ln_cpl        )   CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_cpl = T in OPA'   )
177         IF( ln_mixcpl     )   CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_mixcpl = T in OPA' )
178      CASE( jp_iam_sas  )
179         IF(lwp) WRITE(numout,*) '   Multi executable configuration. Here, SAS component'
180         IF( .NOT.lk_oasis )   CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but key_oasis3 disabled' )
181         IF( ln_mixcpl     )   CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_mixcpl = T in OPA' )
182      CASE DEFAULT
183         CALL ctl_stop( 'sbc_init : unsupported value for nn_components' )
184      END SELECT
185      !                             !* coupled options
186      IF( ln_cpl ) THEN
187         IF( .NOT. lk_oasis )   CALL ctl_stop( 'sbc_init : coupled mode with an atmosphere model (ln_cpl=T)',   &
188            &                                  '           required to defined key_oasis3' )
189      ENDIF
190      IF( ln_mixcpl ) THEN
191         IF( .NOT. lk_oasis )   CALL ctl_stop( 'sbc_init : mixed forced-coupled mode (ln_mixcpl=T) ',   &
192            &                                  '           required to defined key_oasis3' )
193         IF( .NOT.ln_cpl    )   CALL ctl_stop( 'sbc_init : mixed forced-coupled mode (ln_mixcpl=T) requires ln_cpl = T' )
194         IF( nn_components /= jp_iam_nemo )    &
195            &                   CALL ctl_stop( 'sbc_init : the mixed forced-coupled mode (ln_mixcpl=T) ',   &
196            &                                   '          not yet working with sas-opa coupling via oasis' )
197      ENDIF
198      !                             !* sea-ice
199      SELECT CASE( nn_ice )
200      CASE( 0 )                        !- no ice in the domain
201      CASE( 1 )                        !- Ice-cover climatology ("Ice-if" model) 
202      CASE( 2 )                        !- LIM3 ice model
203      CASE( 3 )                        !- CICE ice model
204         IF( .NOT.( ln_blk .OR. ln_cpl ) )   CALL ctl_stop( 'sbc_init : CICE sea-ice model requires ln_blk or ln_cpl = T' )
205         IF( lk_agrif                    )   CALL ctl_stop( 'sbc_init : CICE sea-ice model not currently available with AGRIF' ) 
206      CASE DEFAULT                     !- not supported
207      END SELECT
208      !
209      !                       !**  allocate and set required variables
210      !
211      !                             !* allocate sbc arrays
212      IF( sbc_oce_alloc() /= 0 )   CALL ctl_stop( 'sbc_init : unable to allocate sbc_oce arrays' )
213#if ! defined key_lim3 && ! defined key_cice
214      IF( sbc_ice_alloc() /= 0 )   CALL ctl_stop( 'sbc_init : unable to allocate sbc_ice arrays' )
215#endif
216      !
217      IF( .NOT.ln_isf ) THEN        !* No ice-shelf in the domain : allocate and set to zero
218         IF( sbc_isf_alloc() /= 0 )   CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_isf arrays' )
219         fwfisf  (:,:)   = 0._wp   ;   risf_tsc  (:,:,:) = 0._wp
220         fwfisf_b(:,:)   = 0._wp   ;   risf_tsc_b(:,:,:) = 0._wp
221      END IF
222      IF( nn_ice == 0 ) THEN        !* No sea-ice in the domain : ice fraction is always zero
223         IF( nn_components /= jp_iam_opa )   fr_i(:,:) = 0._wp    ! except for OPA in SAS-OPA coupled case
224      ENDIF
225      !
226      sfx   (:,:) = 0._wp           !* salt flux due to freezing/melting
227      fmmflx(:,:) = 0._wp           !* freezing minus melting flux
228
229      taum(:,:) = 0._wp             !* wind stress module (needed in GLS in case of reduced restart)
230
231      !                          ! Choice of the Surface Boudary Condition (set nsbc)
232      IF( ln_dm2dc ) THEN           !* daily mean to diurnal cycle
233         nday_qsr = -1   ! allow initialization at the 1st call
234         IF( .NOT.( ln_flx .OR. ln_blk ) .AND. nn_components /= jp_iam_opa )   &
235            &   CALL ctl_stop( 'qsr diurnal cycle from daily values requires a flux or bulk formulation' )
236      ENDIF
237      !                             !* Choice of the Surface Boudary Condition
238      !                             (set nsbc)
239      !
240      ll_purecpl  = ln_cpl .AND. .NOT.ln_mixcpl
241      ll_opa      = nn_components == jp_iam_opa
242      ll_not_nemo = nn_components /= jp_iam_nemo
243      icpt = 0
244      !
245      IF( ln_usr          ) THEN   ;   nsbc = jp_usr     ; icpt = icpt + 1   ;   ENDIF       ! user defined         formulation
246      IF( ln_flx          ) THEN   ;   nsbc = jp_flx     ; icpt = icpt + 1   ;   ENDIF       ! flux                 formulation
247      IF( ln_blk          ) THEN   ;   nsbc = jp_blk     ; icpt = icpt + 1   ;   ENDIF       ! bulk                 formulation
248      IF( ll_purecpl      ) THEN   ;   nsbc = jp_purecpl ; icpt = icpt + 1   ;   ENDIF       ! Pure Coupled         formulation
249      IF( ll_opa          ) THEN   ;   nsbc = jp_none    ; icpt = icpt + 1   ;   ENDIF       ! opa coupling via SAS module
250      !
251      IF( icpt /= 1 )    CALL ctl_stop( 'sbc_init : choose ONE and only ONE sbc option' )
252      !
253      IF(lwp) THEN                     !- print the choice of surface flux formulation
254         WRITE(numout,*)
255         SELECT CASE( nsbc )
256         CASE( jp_usr     )   ;   WRITE(numout,*) '   user defined formulation'
257         CASE( jp_flx     )   ;   WRITE(numout,*) '      ===>>   flux formulation'
258         CASE( jp_blk     )   ;   WRITE(numout,*) '      ===>>   bulk formulation'
259         CASE( jp_purecpl )   ;   WRITE(numout,*) '      ===>>   pure coupled formulation'
260!!gm abusive use of jp_none ??   ===>>> need to be check and changed by adding a jp_sas parameter
261         CASE( jp_none    )   ;   WRITE(numout,*) '      ===>>   OPA coupled to SAS via oasis'
262            IF( ln_mixcpl )       WRITE(numout,*) '                  + forced-coupled mixed formulation'
263         END SELECT
264         IF( ll_not_nemo  )       WRITE(numout,*) '                  + OASIS coupled SAS'
265      ENDIF
266      !
267      !                             !* OASIS initialization
268      !
269      IF( lk_oasis )   CALL sbc_cpl_init( nn_ice )   ! Must be done before: (1) first time step
270      !                                              !                      (2) the use of nn_fsbc
271      !     nn_fsbc initialization if OPA-SAS coupling via OASIS
272      !     SAS time-step has to be declared in OASIS (mandatory) -> nn_fsbc has to be modified accordingly
273      IF( nn_components /= jp_iam_nemo ) THEN
274         IF( nn_components == jp_iam_opa )   nn_fsbc = cpl_freq('O_SFLX') / NINT(rdt)
275         IF( nn_components == jp_iam_sas )   nn_fsbc = cpl_freq('I_SFLX') / NINT(rdt)
276         !
277         IF(lwp)THEN
278            WRITE(numout,*)
279            WRITE(numout,*)"   OPA-SAS coupled via OASIS : nn_fsbc re-defined from OASIS namcouple ", nn_fsbc
280            WRITE(numout,*)
281         ENDIF
282      ENDIF
283      !
284      !                             !* check consistency between model timeline and nn_fsbc
285      IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 .OR.   &
286          MOD( nstock             , nn_fsbc) /= 0 ) THEN
287         WRITE(ctmp1,*) 'sbc_init : experiment length (', nitend - nit000 + 1, ') or nstock (', nstock,   &
288            &           ' is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
289         CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
290      ENDIF
291      !
292      IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 )   &
293         &  CALL ctl_warn( 'sbc_init : nn_fsbc is NOT a multiple of the number of time steps in a day' )
294      !
295      IF( ln_dm2dc .AND. NINT(rday) / ( nn_fsbc * NINT(rdt) ) < 8  )   &
296         &   CALL ctl_warn( 'sbc_init : diurnal cycle for qsr: the sampling of the diurnal cycle is too small...' )
297      !
298   
299      !                       !**  associated modules : initialization
300      !
301                          CALL sbc_ssm_init            ! Sea-surface mean fields initialization
302      !
303      IF( ln_blk      )   CALL sbc_blk_init            ! bulk formulae initialization
304
305      IF( ln_ssr      )   CALL sbc_ssr_init            ! Sea-Surface Restoring initialization
306      !
307      IF( ln_isf      )   CALL sbc_isf_init            ! Compute iceshelves
308      !
309                          CALL sbc_rnf_init            ! Runof initialization
310      !
311#if defined key_lim3
312           IF    ( lk_agrif .AND. nn_ice == 0 ) THEN
313                          IF( sbc_ice_alloc() /= 0 )   CALL ctl_stop('STOP', 'sbc_ice_alloc : unable to allocate arrays' )  ! clem2017: allocate ice arrays in case agrif + lim + no-ice in child grid
314           ELSEIF( nn_ice == 2 ) THEN
315                          CALL ice_init                ! LIM3 initialization
316           ENDIF
317#endif
318      IF( nn_ice == 3 )   CALL cice_sbc_init( nsbc )   ! CICE initialization
319      !
320      IF( ln_wave     )   CALL sbc_wave_init           ! surface wave initialisation
321      !
322   END SUBROUTINE sbc_init
323
324
325   SUBROUTINE sbc( kt )
326      !!---------------------------------------------------------------------
327      !!                    ***  ROUTINE sbc  ***
328      !!
329      !! ** Purpose :   provide at each time-step the ocean surface boundary
330      !!                condition (momentum, heat and freshwater fluxes)
331      !!
332      !! ** Method  :   blah blah  to be written ?????????
333      !!                CAUTION : never mask the surface stress field (tke sbc)
334      !!
335      !! ** Action  : - set the ocean surface boundary condition at before and now
336      !!                time step, i.e.
337      !!                utau_b, vtau_b, qns_b, qsr_b, emp_n, sfx_b, qrp_b, erp_b
338      !!                utau  , vtau  , qns  , qsr  , emp  , sfx  , qrp  , erp
339      !!              - updte the ice fraction : fr_i
340      !!----------------------------------------------------------------------
341      INTEGER, INTENT(in) ::   kt   ! ocean time step
342      !
343      LOGICAL ::   ll_sas, ll_opa   ! local logical
344      !!---------------------------------------------------------------------
345      !
346      IF( nn_timing == 1 )  CALL timing_start('sbc')
347      !
348      !                                            ! ---------------------------------------- !
349      IF( kt /= nit000 ) THEN                      !          Swap of forcing fields          !
350         !                                         ! ---------------------------------------- !
351         utau_b(:,:) = utau(:,:)                         ! Swap the ocean forcing fields
352         vtau_b(:,:) = vtau(:,:)                         ! (except at nit000 where before fields
353         qns_b (:,:) = qns (:,:)                         !  are set at the end of the routine)
354         emp_b (:,:) = emp (:,:)
355         sfx_b (:,:) = sfx (:,:)
356         IF ( ln_rnf ) THEN
357            rnf_b    (:,:  ) = rnf    (:,:  )
358            rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
359         ENDIF
360         IF( ln_isf )  THEN
361            fwfisf_b  (:,:  ) = fwfisf  (:,:  )               
362            risf_tsc_b(:,:,:) = risf_tsc(:,:,:)             
363         ENDIF
364        !
365      ENDIF
366      !                                            ! ---------------------------------------- !
367      !                                            !        forcing field computation         !
368      !                                            ! ---------------------------------------- !
369      !
370      ll_sas = nn_components == jp_iam_sas               ! component flags
371      ll_opa = nn_components == jp_iam_opa
372      !
373      IF( .NOT.ll_sas )   CALL sbc_ssm ( kt )            ! mean ocean sea surface variables (sst_m, sss_m, ssu_m, ssv_m)
374      IF( ln_wave     )   CALL sbc_wave( kt )            ! surface waves
375
376      !
377      !                                            !==  sbc formulation  ==!
378      !                                                   
379      SELECT CASE( nsbc )                                ! Compute ocean surface boundary condition
380      !                                                  ! (i.e. utau,vtau, qns, qsr, emp, sfx)
381      CASE( jp_usr   )     ;   CALL usrdef_sbc_oce( kt )                    ! user defined formulation
382      CASE( jp_flx     )   ;   CALL sbc_flx       ( kt )                    ! flux formulation
383      CASE( jp_blk     )
384         IF( ll_sas    )       CALL sbc_cpl_rcv   ( kt, nn_fsbc, nn_ice )   ! OPA-SAS coupling: SAS receiving fields from OPA
385                               CALL sbc_blk       ( kt )                    ! bulk formulation for the ocean
386                               !
387      CASE( jp_purecpl )   ;   CALL sbc_cpl_rcv   ( kt, nn_fsbc, nn_ice )   ! pure coupled formulation
388      CASE( jp_none    )
389         IF( ll_opa    )       CALL sbc_cpl_rcv   ( kt, nn_fsbc, nn_ice )   ! OPA-SAS coupling: OPA receiving fields from SAS
390      END SELECT
391      IF ( ln_wave .AND. ln_tauoc) THEN                                 ! Wave stress subctracted
392            utau(:,:) = utau(:,:)*tauoc_wave(:,:)
393            vtau(:,:) = vtau(:,:)*tauoc_wave(:,:)
394            taum(:,:) = taum(:,:)*tauoc_wave(:,:)
395      !
396            SELECT CASE( nsbc )
397            CASE(  0,1,2,3,5,-1 )  ;
398                IF(lwp .AND. kt == nit000 ) WRITE(numout,*) 'WARNING: You are subtracting the wave stress to the ocean. &
399                        & If not requested select ln_tauoc=.false'
400            END SELECT
401      !
402      END IF
403      IF( ln_mixcpl )          CALL sbc_cpl_rcv   ( kt, nn_fsbc, nn_ice )   ! forced-coupled mixed formulation after forcing
404
405      !
406      !                                            !==  Misc. Options  ==!
407      !
408      SELECT CASE( nn_ice )                                       ! Update heat and freshwater fluxes over sea-ice areas
409      CASE(  1 )   ;         CALL sbc_ice_if   ( kt )             ! Ice-cover climatology ("Ice-if" model)
410#if defined key_lim3
411      CASE(  2 )   ;         CALL ice_stp  ( kt, nsbc )           ! LIM-3 ice model
412#endif
413      CASE(  3 )   ;         CALL sbc_ice_cice ( kt, nsbc )       ! CICE ice model
414      END SELECT
415
416      IF( ln_icebergs    )   CALL icb_stp( kt )                   ! compute icebergs
417
418      IF( ln_isf         )   CALL sbc_isf( kt )                   ! compute iceshelves
419
420      IF( ln_rnf         )   CALL sbc_rnf( kt )                   ! add runoffs to fresh water fluxes
421
422      IF( ln_ssr         )   CALL sbc_ssr( kt )                   ! add SST/SSS damping term
423
424      IF( nn_fwb    /= 0 )   CALL sbc_fwb( kt, nn_fwb, nn_fsbc )  ! control the freshwater budget
425
426      ! treatment of closed sea in the model domain   (update freshwater fluxes)
427      ! Should not be ran if ln_diurnal_only
428      IF( .NOT.ln_diurnal_only .AND. nn_closea == 1 )   CALL sbc_clo( kt, cn_cfg, nn_cfg )   
429
430!RBbug do not understand why see ticket 667
431!clem: it looks like it is necessary for the north fold (in certain circumstances). Don't know why.
432      CALL lbc_lnk( emp, 'T', 1. )
433      !
434      IF( kt == nit000 ) THEN                          !   set the forcing field at nit000 - 1    !
435         !                                             ! ---------------------------------------- !
436         IF( ln_rstart .AND.    &                               !* Restart: read in restart file
437            & iom_varid( numror, 'utau_b', ldstop = .FALSE. ) > 0 ) THEN
438            IF(lwp) WRITE(numout,*) '          nit000-1 surface forcing fields red in the restart file'
439            CALL iom_get( numror, jpdom_autoglo, 'utau_b', utau_b )   ! before i-stress  (U-point)
440            CALL iom_get( numror, jpdom_autoglo, 'vtau_b', vtau_b )   ! before j-stress  (V-point)
441            CALL iom_get( numror, jpdom_autoglo, 'qns_b' , qns_b  )   ! before non solar heat flux (T-point)
442            ! The 3D heat content due to qsr forcing is treated in traqsr
443            ! CALL iom_get( numror, jpdom_autoglo, 'qsr_b' , qsr_b  ) ! before     solar heat flux (T-point)
444            CALL iom_get( numror, jpdom_autoglo, 'emp_b', emp_b  )    ! before     freshwater flux (T-point)
445            ! To ensure restart capability with 3.3x/3.4 restart files    !! to be removed in v3.6
446            IF( iom_varid( numror, 'sfx_b', ldstop = .FALSE. ) > 0 ) THEN
447               CALL iom_get( numror, jpdom_autoglo, 'sfx_b', sfx_b )  ! before salt flux (T-point)
448            ELSE
449               sfx_b (:,:) = sfx(:,:)
450            ENDIF
451         ELSE                                                   !* no restart: set from nit000 values
452            IF(lwp) WRITE(numout,*) '          nit000-1 surface forcing fields set to nit000'
453            utau_b(:,:) = utau(:,:)
454            vtau_b(:,:) = vtau(:,:)
455            qns_b (:,:) = qns (:,:)
456            emp_b (:,:) = emp (:,:)
457            sfx_b (:,:) = sfx (:,:)
458         ENDIF
459      ENDIF
460      !                                                ! ---------------------------------------- !
461      IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
462         !                                             ! ---------------------------------------- !
463         IF(lwp) WRITE(numout,*)
464         IF(lwp) WRITE(numout,*) 'sbc : ocean surface forcing fields written in ocean restart file ',   &
465            &                    'at it= ', kt,' date= ', ndastp
466         IF(lwp) WRITE(numout,*) '~~~~'
467         CALL iom_rstput( kt, nitrst, numrow, 'utau_b' , utau )
468         CALL iom_rstput( kt, nitrst, numrow, 'vtau_b' , vtau )
469         CALL iom_rstput( kt, nitrst, numrow, 'qns_b'  , qns  )
470         ! The 3D heat content due to qsr forcing is treated in traqsr
471         ! CALL iom_rstput( kt, nitrst, numrow, 'qsr_b'  , qsr  )
472         CALL iom_rstput( kt, nitrst, numrow, 'emp_b'  , emp  )
473         CALL iom_rstput( kt, nitrst, numrow, 'sfx_b'  , sfx  )
474      ENDIF
475      !                                                ! ---------------------------------------- !
476      !                                                !        Outputs and control print         !
477      !                                                ! ---------------------------------------- !
478      IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN
479         CALL iom_put( "empmr"  , emp    - rnf )                ! upward water flux
480         CALL iom_put( "empbmr" , emp_b  - rnf )                ! before upward water flux ( needed to recalculate the time evolution of ssh in offline )
481         CALL iom_put( "saltflx", sfx  )                        ! downward salt flux (includes virtual salt flux beneath ice in linear free surface case)
482         CALL iom_put( "fmmflx", fmmflx  )                      ! Freezing-melting water flux
483         CALL iom_put( "qt"    , qns  + qsr )                   ! total heat flux
484         CALL iom_put( "qns"   , qns        )                   ! solar heat flux
485         CALL iom_put( "qsr"   ,       qsr  )                   ! solar heat flux
486         IF( nn_ice > 0 .OR. ll_opa )   CALL iom_put( "ice_cover", fr_i )   ! ice fraction
487         CALL iom_put( "taum"  , taum       )                   ! wind stress module
488         CALL iom_put( "wspd"  , wndm       )                   ! wind speed  module over free ocean or leads in presence of sea-ice
489      ENDIF
490      !
491      CALL iom_put( "utau", utau )   ! i-wind stress   (stress can be updated at each time step in sea-ice)
492      CALL iom_put( "vtau", vtau )   ! j-wind stress
493      !
494      IF(ln_ctl) THEN         ! print mean trends (used for debugging)
495         CALL prt_ctl(tab2d_1=fr_i              , clinfo1=' fr_i    - : ', mask1=tmask, ovlap=1 )
496         CALL prt_ctl(tab2d_1=(emp-rnf + fwfisf), clinfo1=' emp-rnf - : ', mask1=tmask, ovlap=1 )
497         CALL prt_ctl(tab2d_1=(sfx-rnf + fwfisf), clinfo1=' sfx-rnf - : ', mask1=tmask, ovlap=1 )
498         CALL prt_ctl(tab2d_1=qns              , clinfo1=' qns      - : ', mask1=tmask, ovlap=1 )
499         CALL prt_ctl(tab2d_1=qsr              , clinfo1=' qsr      - : ', mask1=tmask, ovlap=1 )
500         CALL prt_ctl(tab3d_1=tmask            , clinfo1=' tmask    - : ', mask1=tmask, ovlap=1, kdim=jpk )
501         CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_tem), clinfo1=' sst      - : ', mask1=tmask, ovlap=1, kdim=1   )
502         CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_sal), clinfo1=' sss      - : ', mask1=tmask, ovlap=1, kdim=1   )
503         CALL prt_ctl(tab2d_1=utau             , clinfo1=' utau     - : ', mask1=umask,                      &
504            &         tab2d_2=vtau             , clinfo2=' vtau     - : ', mask2=vmask, ovlap=1 )
505      ENDIF
506
507      IF( kt == nitend )   CALL sbc_final         ! Close down surface module if necessary
508      !
509      IF( nn_timing == 1 )  CALL timing_stop('sbc')
510      !
511   END SUBROUTINE sbc
512
513
514   SUBROUTINE sbc_final
515      !!---------------------------------------------------------------------
516      !!                    ***  ROUTINE sbc_final  ***
517      !!
518      !! ** Purpose :   Finalize CICE (if used)
519      !!---------------------------------------------------------------------
520      !
521      IF( nn_ice == 3 )   CALL cice_sbc_final
522      !
523   END SUBROUTINE sbc_final
524
525   !!======================================================================
526END MODULE sbcmod
Note: See TracBrowser for help on using the repository browser.