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

source: branches/DEV_r2106_LOCEAN2010/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 2198

Last change on this file since 2198 was 2198, checked in by smasson, 14 years ago

merge dev_r2174_DCY into DEV_r2106_LOCEAN2010
  • Property svn:keywords set to Id
File size: 19.4 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   !!----------------------------------------------------------------------
11
12   !!----------------------------------------------------------------------
13   !!   sbc_init       : read namsbc namelist
14   !!   sbc            : surface ocean momentum, heat and freshwater boundary conditions
15   !!----------------------------------------------------------------------
16   USE oce              ! ocean dynamics and tracers
17   USE dom_oce          ! ocean space and time domain
18   USE phycst           ! physical constants
19   USE sbc_oce          ! Surface boundary condition: ocean fields
20   USE sbc_ice          ! Surface boundary condition: ice fields
21   USE sbcssm           ! surface boundary condition: sea-surface mean variables
22   USE sbcana           ! surface boundary condition: analytical formulation
23   USE sbcflx           ! surface boundary condition: flux formulation
24   USE sbcblk_clio      ! surface boundary condition: bulk formulation : CLIO
25   USE sbcblk_core      ! surface boundary condition: bulk formulation : CORE
26   USE sbcice_if        ! surface boundary condition: ice-if sea-ice model
27   USE sbcice_lim       ! surface boundary condition: LIM 3.0 sea-ice model
28   USE sbcice_lim_2     ! surface boundary condition: LIM 2.0 sea-ice model
29   USE sbccpl           ! surface boundary condition: coupled florulation
30   USE cpl_oasis3, ONLY:lk_cpl      ! are we in coupled mode?
31   USE sbcssr           ! surface boundary condition: sea surface restoring
32   USE sbcrnf           ! surface boundary condition: runoffs
33   USE sbcfwb           ! surface boundary condition: freshwater budget
34   USE closea           ! closed sea
35
36   USE prtctl           ! Print control                    (prt_ctl routine)
37   USE restart          ! ocean restart
38   USE iom              ! IOM library
39   USE in_out_manager   ! I/O manager
40
41   IMPLICIT NONE
42   PRIVATE
43
44   PUBLIC   sbc        ! routine called by step.F90
45   PUBLIC   sbc_init   ! routine called by opa.F90
46   
47   INTEGER ::   nsbc   ! type of surface boundary condition (deduced from namsbc informations)
48     
49   !! * Substitutions
50#  include "domzgr_substitute.h90"
51   !!----------------------------------------------------------------------
52   !! NEMO/OPA 3.3 , NEMO-consortium (2010)
53   !! $Id$
54   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
55   !!----------------------------------------------------------------------
56CONTAINS
57
58   SUBROUTINE sbc_init
59      !!---------------------------------------------------------------------
60      !!                    ***  ROUTINE sbc_init ***
61      !!
62      !! ** Purpose :   Initialisation of the ocean surface boundary computation
63      !!
64      !! ** Method  :   Read the namsbc namelist and set derived parameters
65      !!
66      !! ** Action  : - read namsbc parameters
67      !!              - nsbc: type of sbc
68      !!----------------------------------------------------------------------
69      INTEGER ::   icpt      ! temporary integer
70      !!
71      NAMELIST/namsbc/ nn_fsbc, ln_ana  , ln_flx, ln_blk_clio, ln_blk_core, ln_cpl    ,   &
72         &             nn_ice , ln_dm2dc, ln_rnf, ln_ssr     , nn_fwb     , nn_ico_cpl
73      !!----------------------------------------------------------------------
74
75      IF(lwp) THEN
76         WRITE(numout,*)
77         WRITE(numout,*) 'sbc_init : surface boundary condition setting'
78         WRITE(numout,*) '~~~~~~~~ '
79      ENDIF
80
81      REWIND( numnam )           ! Read Namelist namsbc
82      READ  ( numnam, namsbc )
83
84      !                          ! overwrite namelist parameter using CPP key information
85      IF( Agrif_Root() ) THEN                ! AGRIF zoom
86        IF( lk_lim2 )   nn_ice      = 2
87        IF( lk_lim3 )   nn_ice      = 3
88      ENDIF
89      IF( cp_cfg == 'gyre' ) THEN            ! GYRE configuration
90          ln_ana      = .TRUE.   
91          nn_ice      =   0
92      ENDIF
93     
94      IF(lwp) THEN               ! Control print
95         WRITE(numout,*) '        Namelist namsbc (partly overwritten with CPP key setting)'
96         WRITE(numout,*) '           frequency update of sbc (and ice)             nn_fsbc     = ', nn_fsbc
97         WRITE(numout,*) '           Type of sbc : '
98         WRITE(numout,*) '              analytical formulation                     ln_ana      = ', ln_ana
99         WRITE(numout,*) '              flux       formulation                     ln_flx      = ', ln_flx
100         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_clio = ', ln_blk_clio
101         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_core = ', ln_blk_core
102         WRITE(numout,*) '              coupled    formulation (T if key_sbc_cpl)  ln_cpl      = ', ln_cpl
103         WRITE(numout,*) '           Misc. options of sbc : '
104         WRITE(numout,*) '              ice management in the sbc (=0/1/2/3)       nn_ice      = ', nn_ice 
105         WRITE(numout,*) '              ice-ocean stress computation (=0/1/2)      nn_ico_cpl  = ', nn_ico_cpl
106         WRITE(numout,*) '              daily mean to diurnal cycle qsr            ln_dm2dc    = ', ln_dm2dc 
107         WRITE(numout,*) '              runoff / runoff mouths                     ln_rnf      = ', ln_rnf
108         WRITE(numout,*) '              Sea Surface Restoring on SST and/or SSS    ln_ssr      = ', ln_ssr
109         WRITE(numout,*) '              FreshWater Budget control  (=0/1/2)        nn_fwb      = ', nn_fwb
110         WRITE(numout,*) '              closed sea (=0/1) (set in namdom)          nn_closea   = ', nn_closea
111      ENDIF
112
113      !                          ! Checks:
114      IF( .NOT. ln_rnf ) THEN                      ! no specific treatment in vicinity of river mouths
115         ln_rnf_mouth  = .false.                     
116         nkrnf         = 0
117         rnfmsk  (:,:) = 0.e0
118         rnfmsk_z(:)   = 0.e0
119      ENDIF
120      IF( nn_ice == 0  )   fr_i(:,:) = 0.e0        ! no ice in the domain, ice fraction is always zero
121
122      !                                            ! restartability   
123      IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 .OR.   &
124          MOD( nstock             , nn_fsbc) /= 0 ) THEN
125         WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') or nstock (', nstock,   &
126            &           ' is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
127         CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
128      ENDIF
129      !
130      IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 )   &
131         &  CALL ctl_warn( 'nn_fsbc is NOT a multiple of the number of time steps in a day' )
132      !
133      IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core .OR. lk_cpl ) )   &
134         &   CALL ctl_stop( 'sea-ice model requires a bulk formulation or coupled configuration' )
135     
136      IF( ln_dm2dc .AND. .NOT.( ln_flx .OR. ln_blk_core ) )   &
137         &   CALL ctl_stop( 'diurnal cycle into qsr field from daily values requires a flux or core-bulk formulation' )
138     
139      IF( ln_dm2dc .AND. ( ( NINT(rday) / ( nn_fsbc * NINT(rdt) ) )  < 8 ) )   &
140         &   CALL ctl_warn( 'diurnal cycle for qsr: the sampling of the diurnal cycle is too small...' )
141     
142      !                          ! Choice of the Surface Boudary Condition (set nsbc)
143      icpt = 0
144      IF( ln_ana          ) THEN   ;   nsbc =  1   ; icpt = icpt + 1   ;   ENDIF       ! analytical      formulation
145      IF( ln_flx          ) THEN   ;   nsbc =  2   ; icpt = icpt + 1   ;   ENDIF       ! flux            formulation
146      IF( ln_blk_clio     ) THEN   ;   nsbc =  3   ; icpt = icpt + 1   ;   ENDIF       ! CLIO bulk       formulation
147      IF( ln_blk_core     ) THEN   ;   nsbc =  4   ; icpt = icpt + 1   ;   ENDIF       ! CORE bulk       formulation
148      IF( ln_cpl          ) THEN   ;   nsbc =  5   ; icpt = icpt + 1   ;   ENDIF       ! Coupled         formulation
149      IF( cp_cfg == 'gyre') THEN   ;   nsbc =  0                       ;   ENDIF       ! GYRE analytical formulation
150      IF( lk_esopa        )            nsbc = -1                                       ! esopa test, ALL formulations
151      !
152      IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN
153         WRITE(numout,*)
154         WRITE(numout,*) '           E R R O R in setting the sbc, one and only one namelist/CPP key option '
155         WRITE(numout,*) '                     must be choosen. You choose ', icpt, ' option(s)'
156         WRITE(numout,*) '                     We stop'
157         nstop = nstop + 1
158      ENDIF
159      IF(lwp) THEN
160         WRITE(numout,*)
161         IF( nsbc == -1 )   WRITE(numout,*) '              ESOPA test All surface boundary conditions'
162         IF( nsbc ==  0 )   WRITE(numout,*) '              GYRE analytical formulation'
163         IF( nsbc ==  1 )   WRITE(numout,*) '              analytical formulation'
164         IF( nsbc ==  2 )   WRITE(numout,*) '              flux formulation'
165         IF( nsbc ==  3 )   WRITE(numout,*) '              CLIO bulk formulation'
166         IF( nsbc ==  4 )   WRITE(numout,*) '              CORE bulk formulation'
167         IF( nsbc ==  5 )   WRITE(numout,*) '              coupled formulation'
168      ENDIF
169      !
170   END SUBROUTINE sbc_init
171
172
173   SUBROUTINE sbc( kt )
174      !!---------------------------------------------------------------------
175      !!                    ***  ROUTINE sbc  ***
176      !!             
177      !! ** Purpose :   provide at each time-step the ocean surface boundary
178      !!                condition (momentum, heat and freshwater fluxes)
179      !!
180      !! ** Method  :   blah blah  to be written ?????????
181      !!                CAUTION : never mask the surface stress field (tke sbc)
182      !!
183      !! ** Action  : - set the ocean surface boundary condition at before and now
184      !!                time step, i.e. 
185      !!                utau_b, vtau_b, qns_b, qsr_b, emp_n, emps_b, qrp_b, erp_b
186      !!                utau  , vtau  , qns  , qsr  , emp  , emps  , qrp  , erp
187      !!              - updte the ice fraction : fr_i
188      !!----------------------------------------------------------------------
189      INTEGER, INTENT(in) ::   kt       ! ocean time step
190      !!---------------------------------------------------------------------
191
192      !                                            ! ---------------------------------------- !
193      IF( kt /= nit000 ) THEN                      !          Swap of forcing fields          !
194         !                                         ! ---------------------------------------- !
195         utau_b(:,:) = utau(:,:)                         ! Swap the ocean forcing fields
196         vtau_b(:,:) = vtau(:,:)                         ! (except at nit000 where before fields
197         qns_b (:,:) = qns (:,:)                         !  are set at the end of the routine)
198         ! The 3D heat content due to qsr forcing is treated in traqsr
199         ! qsr_b (:,:) = qsr (:,:)
200         emp_b (:,:) = emp (:,:)
201         emps_b(:,:) = emps(:,:)
202      ENDIF
203      !                                            ! ---------------------------------------- !
204      !                                            !        forcing field computation         !
205      !                                            ! ---------------------------------------- !
206
207      CALL iom_setkt( kt + nn_fsbc - 1 )                 ! in sbc, iom_put is called every nn_fsbc time step
208      !
209      CALL sbc_ssm( kt )                                 ! ocean sea surface variables (sst_m, sss_m, ssu_m, ssv_m)
210      !                                                  ! averaged over nf_sbc time-step
211
212                                                   !==  sbc formulation  ==!
213                                                           
214      SELECT CASE( nsbc )                                ! Compute ocean surface boundary condition
215      !                                                  ! (i.e. utau,vtau, qns, qsr, emp, emps)
216      CASE(  0 )   ;   CALL sbc_gyre    ( kt )                    ! analytical formulation : GYRE configuration
217      CASE(  1 )   ;   CALL sbc_ana     ( kt )                    ! analytical formulation : uniform sbc
218      CASE(  2 )   ;   CALL sbc_flx     ( kt )                    ! flux formulation
219      CASE(  3 )   ;   CALL sbc_blk_clio( kt )                    ! bulk formulation : CLIO for the ocean
220      CASE(  4 )   ;   CALL sbc_blk_core( kt )                    ! bulk formulation : CORE for the ocean
221      CASE(  5 )   ;   CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice )   ! coupled formulation
222      CASE( -1 )                               
223                       CALL sbc_ana     ( kt )                    ! ESOPA, test ALL the formulations
224                       CALL sbc_gyre    ( kt )                    !
225                       CALL sbc_flx     ( kt )                    !
226                       CALL sbc_blk_clio( kt )                    !
227                       CALL sbc_blk_core( kt )                    !
228                       CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice )   !
229      END SELECT
230
231      !                                            !==  Misc. Options  ==!
232     
233      SELECT CASE( nn_ice )                                     ! Update heat and freshwater fluxes over sea-ice areas
234      CASE(  1 )   ;       CALL sbc_ice_if   ( kt )                   ! Ice-cover climatology ("Ice-if" model)
235         !                                                     
236      CASE(  2 )   ;       CALL sbc_ice_lim_2( kt, nsbc )             ! LIM 2.0 ice model
237         !                                                     
238      CASE(  3 )   ;       CALL sbc_ice_lim  ( kt, nsbc, nn_ico_cpl)  ! LIM 3.0 ice model
239      END SELECT                                             
240
241      IF( ln_rnf       )   CALL sbc_rnf( kt )                   ! add runoffs to fresh water fluxes
242 
243      IF( ln_ssr       )   CALL sbc_ssr( kt )                   ! add SST/SSS damping term
244
245      IF( nn_fwb  /= 0 )   CALL sbc_fwb( kt, nn_fwb, nn_fsbc )  ! control the freshwater budget
246
247      IF( nclosea == 1 )   CALL sbc_clo( kt )                   ! treatment of closed sea in the model domain
248      !                                                         ! (update freshwater fluxes)
249      !
250      IF( kt == nit000 ) THEN                          !   set the forcing field at nit000 - 1    !
251         !                                             ! ---------------------------------------- !
252         IF( ln_rstart .AND.    &                               !* Restart: read in restart file
253            & iom_varid( numror, 'utau_b', ldstop = .FALSE. ) > 0 ) THEN
254            IF(lwp) WRITE(numout,*) '          nit000-1 surface forcing fields red in the restart file'
255            CALL iom_get( numror, jpdom_autoglo, 'utau_b', utau_b )   ! before i-stress  (U-point)
256            CALL iom_get( numror, jpdom_autoglo, 'vtau_b', vtau_b )   ! before j-stress  (V-point)
257            CALL iom_get( numror, jpdom_autoglo, 'qns_b' , qns_b  )   ! before non solar heat flux (T-point)
258            ! The 3D heat content due to qsr forcing is treated in traqsr
259            ! CALL iom_get( numror, jpdom_autoglo, 'qsr_b' , qsr_b  )   ! before     solar heat flux (T-point)
260            CALL iom_get( numror, jpdom_autoglo, 'emp_b' , emp_b  )   ! before     freshwater flux (T-point)
261            CALL iom_get( numror, jpdom_autoglo, 'emps_b', emps_b )   ! before C/D freshwater flux (T-point)
262         ELSE                                                   !* no restart: set from nit000 values
263            IF(lwp) WRITE(numout,*) '          nit000-1 surface forcing fields set to nit000'
264            utau_b(:,:) = utau(:,:) 
265            vtau_b(:,:) = vtau(:,:)
266            qns_b (:,:) = qns (:,:)
267            ! qsr_b (:,:) = qsr (:,:)
268            emp_b (:,:) = emp (:,:)
269            emps_b(:,:) = emps(:,:)
270         ENDIF
271      ENDIF
272      !                                                ! ---------------------------------------- !
273      IF( lrst_oce ) THEN                              !      Write in the ocean restart file     !
274         !                                             ! ---------------------------------------- !
275         IF(lwp) WRITE(numout,*)
276         IF(lwp) WRITE(numout,*) 'sbc : ocean surface forcing fields written in ocean restart file ',   &
277            &                    'at it= ', kt,' date= ', ndastp
278         IF(lwp) WRITE(numout,*) '~~~~'
279         CALL iom_rstput( kt, nitrst, numrow, 'utau_b' , utau )
280         CALL iom_rstput( kt, nitrst, numrow, 'vtau_b' , vtau )
281         CALL iom_rstput( kt, nitrst, numrow, 'qns_b'  , qns  )
282         ! The 3D heat content due to qsr forcing is treated in traqsr
283         ! CALL iom_rstput( kt, nitrst, numrow, 'qsr_b'  , qsr  )
284         CALL iom_rstput( kt, nitrst, numrow, 'emp_b'  , emp  )
285         CALL iom_rstput( kt, nitrst, numrow, 'emps_b' , emps )
286      ENDIF
287
288      !                                                ! ---------------------------------------- !
289      !                                                !        Outputs and control print         !
290      !                                                ! ---------------------------------------- !
291      IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN
292         CALL iom_put( "emp-rnf" , emp  - rnf )                   ! upward water flux
293         CALL iom_put( "emps-rnf", emps - rnf )                   ! c/d water flux
294         CALL iom_put( "qns+qsr" , qns  + qsr )                   ! total heat flux
295         CALL iom_put( "qns"     , qns        )                   ! solar heat flux
296         CALL iom_put( "qsr"     ,       qsr  )                   ! solar heat flux
297         IF( nn_ice > 0 )   CALL iom_put( "ice_cover", fr_i )   ! ice fraction
298      ENDIF
299      !
300      CALL iom_setkt( kt )           ! iom_put outside of sbc is called at every time step
301      !
302      CALL iom_put( "utau", utau )   ! i-wind stress   (stress can be updated at
303      CALL iom_put( "vtau", vtau )   ! j-wind stress    each time step in sea-ice)
304      CALL iom_put( "taum", taum )   ! wind stress module
305      CALL iom_put( "wspd", wndm )   ! wind speed  module
306      !
307      IF(ln_ctl) THEN         ! print mean trends (used for debugging)
308         CALL prt_ctl(tab2d_1=fr_i      , clinfo1=' fr_i     - : ', mask1=tmask, ovlap=1 )
309         CALL prt_ctl(tab2d_1=(emp-rnf) , clinfo1=' emp-rnf  - : ', mask1=tmask, ovlap=1 )
310         CALL prt_ctl(tab2d_1=(emps-rnf), clinfo1=' emps-rnf - : ', mask1=tmask, ovlap=1 )
311         CALL prt_ctl(tab2d_1=qns       , clinfo1=' qns      - : ', mask1=tmask, ovlap=1 )
312         CALL prt_ctl(tab2d_1=qsr       , clinfo1=' qsr      - : ', mask1=tmask, ovlap=1 )
313         CALL prt_ctl(tab3d_1=tmask     , clinfo1=' tmask    - : ', mask1=tmask, ovlap=1, kdim=jpk )
314         CALL prt_ctl(tab3d_1=tn        , clinfo1=' sst      - : ', mask1=tmask, ovlap=1, kdim=1   )
315         CALL prt_ctl(tab3d_1=sn        , clinfo1=' sss      - : ', mask1=tmask, ovlap=1, kdim=1   )
316         CALL prt_ctl(tab2d_1=utau      , clinfo1=' utau     - : ', mask1=umask,                      &
317            &         tab2d_2=vtau      , clinfo2=' vtau     - : ', mask2=vmask, ovlap=1 )
318      ENDIF
319      !
320   END SUBROUTINE sbc
321
322   !!======================================================================
323END MODULE sbcmod
Note: See TracBrowser for help on using the repository browser.