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

source: trunk/NEMOGCM/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 7740

Last change on this file since 7740 was 7698, checked in by mocavero, 7 years ago

update trunk with OpenMP parallelization

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