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

source: branches/nemo_v3_3_beta/NEMOGCM/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 2287

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

update licence of all NEMO files...

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