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

source: branches/DEV_r1879_FCM/NEMOGCM/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 2292

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

update DEV_r1879_FCM for additional tests...
  • Property svn:keywords set to Id
File size: 15.2 KB
Line 
1MODULE sbcmod
2   !!======================================================================
3   !!                       ***  MODULE  sbcmod  ***
4   !! Surface module :  provide to the ocean its surface boundary condition
5   !!======================================================================
6   !! History :  3.0   !  07-2006  (G. Madec)  Original code
7   !!             -    !  08-2008  (S. Masson, E. .... ) coupled interface
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   sbc_init       : read namsbc namelist
12   !!   sbc            : surface ocean momentum, heat and freshwater boundary conditions
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and tracers
15   USE dom_oce         ! ocean space and time domain
16   USE phycst          ! physical constants
17
18   USE sbc_oce         ! Surface boundary condition: ocean fields
19   USE sbc_ice         ! Surface boundary condition: ice fields
20   USE sbcdcy          ! surface boundary condition: diurnal cycle
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
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.0 , LOCEAN-IPSL (2008)
53   !! $Id$
54   !! Software governed by the CeCILL licence  (NEMOGCM/License_CeCILL.txt)
55   !!----------------------------------------------------------------------
56
57CONTAINS
58
59   SUBROUTINE sbc_init
60      !!---------------------------------------------------------------------
61      !!                    ***  ROUTINE sbc_init ***
62      !!
63      !! ** Purpose :   Initialisation of the ocean surface boundary computation
64      !!
65      !! ** Method  :   Read the namsbc namelist and set derived parameters
66      !!
67      !! ** Action  : - read namsbc parameters
68      !!              - nsbc: type of sbc
69      !!----------------------------------------------------------------------
70      INTEGER ::   icpt      ! temporary integer
71      !!
72      NAMELIST/namsbc/ nn_fsbc, ln_ana, ln_flx, ln_blk_clio, ln_blk_core, ln_cpl,   &
73         &             nn_ice , ln_dm2dc, ln_rnf, ln_ssr, nn_fwb, nn_ico_cpl
74      !!----------------------------------------------------------------------
75
76      IF(lwp) THEN
77         WRITE(numout,*)
78         WRITE(numout,*) 'sbc_init : surface boundary condition setting'
79         WRITE(numout,*) '~~~~~~~~ '
80      ENDIF
81
82      REWIND( numnam )                   ! Read Namelist namsbc
83      READ  ( numnam, namsbc )
84
85      !                          ! overwrite namelist parameter using CPP key information
86      IF( Agrif_Root() ) THEN                ! AGRIF zoom
87        IF( lk_lim2 )   nn_ice      = 2
88        IF( lk_lim3 )   nn_ice      = 3
89      ENDIF
90      IF( cp_cfg == 'gyre' ) THEN            ! GYRE configuration
91          ln_ana      = .TRUE.   
92          nn_ice      =   0
93      ENDIF
94     
95      IF(lwp) THEN               ! Control print
96         WRITE(numout,*) '        Namelist namsbc (partly overwritten with CPP key setting)'
97         WRITE(numout,*) '           frequency update of sbc (and ice)             nn_fsbc     = ', nn_fsbc
98         WRITE(numout,*) '           Type of sbc : '
99         WRITE(numout,*) '              analytical formulation                     ln_ana      = ', ln_ana
100         WRITE(numout,*) '              flux       formulation                     ln_flx      = ', ln_flx
101         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_clio = ', ln_blk_clio
102         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_core = ', ln_blk_core
103         WRITE(numout,*) '              coupled    formulation (T if key_sbc_cpl)  ln_cpl      = ', ln_cpl
104         WRITE(numout,*) '           Misc. options of sbc : '
105         WRITE(numout,*) '              ice management in the sbc (=0/1/2/3)       nn_ice      = ', nn_ice 
106         WRITE(numout,*) '              ice-ocean stress computation (=0/1/2)      nn_ico_cpl  = ', nn_ico_cpl
107         WRITE(numout,*) '              daily mean to diurnal cycle qsr            ln_dm2dc    = ', ln_dm2dc 
108         WRITE(numout,*) '              runoff / runoff mouths                     ln_rnf      = ', ln_rnf
109         WRITE(numout,*) '              Sea Surface Restoring on SST and/or SSS    ln_ssr      = ', ln_ssr
110         WRITE(numout,*) '              FreshWater Budget control  (=0/1/2)        nn_fwb      = ', nn_fwb
111         WRITE(numout,*) '              closed sea (=0/1) (set in namdom)          nn_closea   = ', nn_closea
112      ENDIF
113
114      !                          ! Checks:
115      IF( .NOT. ln_rnf ) THEN                      ! no specific treatment in vicinity of river mouths
116         ln_rnf_mouth  = .false.                     
117         nkrnf         = 0
118         rnfmsk  (:,:) = 0.e0
119         rnfmsk_z(:)   = 0.e0
120      ENDIF
121      IF( nn_ice == 0  )   fr_i(:,:) = 0.e0        ! no ice in the domain, ice fraction is always zero
122
123      !                                            ! restartability   
124      IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 .OR.   &
125          MOD( nstock             , nn_fsbc) /= 0 ) THEN
126         WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') or nstock (', nstock,   &
127            &           ' is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
128         CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
129      ENDIF
130      !
131      IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 )   &
132         &  CALL ctl_warn( 'nn_fsbc is NOT a multiple of the number of time steps in a day' )
133      !
134      IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core .OR. lk_cpl ) )   &
135         &   CALL ctl_stop( 'sea-ice model requires a bulk formulation or coupled configuration' )
136     
137      IF( ln_dm2dc )   nday_qsr = -1   ! initialisation flag
138
139      IF( ln_dm2dc .AND. .NOT.( ln_flx .OR. ln_blk_core ) )   &
140         &   CALL ctl_stop( 'diurnal cycle into qsr field from daily values requires a flux or core-bulk formulation' )
141     
142      IF( ln_dm2dc .AND. ( ( NINT(rday) / ( nn_fsbc * NINT(rdt) ) )  < 8 ) )   &
143         &   CALL ctl_warn( 'diurnal cycle for qsr: the sampling of the diurnal cycle is too small...' )
144     
145      !                          ! Choice of the Surface Boudary Condition (set nsbc)
146      icpt = 0
147      IF( ln_ana          ) THEN   ;   nsbc =  1   ; icpt = icpt + 1   ;   ENDIF       ! analytical      formulation
148      IF( ln_flx          ) THEN   ;   nsbc =  2   ; icpt = icpt + 1   ;   ENDIF       ! flux            formulation
149      IF( ln_blk_clio     ) THEN   ;   nsbc =  3   ; icpt = icpt + 1   ;   ENDIF       ! CLIO bulk       formulation
150      IF( ln_blk_core     ) THEN   ;   nsbc =  4   ; icpt = icpt + 1   ;   ENDIF       ! CORE bulk       formulation
151      IF( ln_cpl          ) THEN   ;   nsbc =  5   ; icpt = icpt + 1   ;   ENDIF       ! Coupled         formulation
152      IF( cp_cfg == 'gyre') THEN   ;   nsbc =  0                       ;   ENDIF       ! GYRE analytical formulation
153      IF( lk_esopa        )            nsbc = -1                                       ! esopa test, ALL formulations
154      !
155      IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN
156         WRITE(numout,*)
157         WRITE(numout,*) '           E R R O R in setting the sbc, one and only one namelist/CPP key option '
158         WRITE(numout,*) '                     must be choosen. You choose ', icpt, ' option(s)'
159         WRITE(numout,*) '                     We stop'
160         nstop = nstop + 1
161      ENDIF
162      IF(lwp) THEN
163         WRITE(numout,*)
164         IF( nsbc == -1 )   WRITE(numout,*) '              ESOPA test All surface boundary conditions'
165         IF( nsbc ==  0 )   WRITE(numout,*) '              GYRE analytical formulation'
166         IF( nsbc ==  1 )   WRITE(numout,*) '              analytical formulation'
167         IF( nsbc ==  2 )   WRITE(numout,*) '              flux formulation'
168         IF( nsbc ==  3 )   WRITE(numout,*) '              CLIO bulk formulation'
169         IF( nsbc ==  4 )   WRITE(numout,*) '              CORE bulk formulation'
170         IF( nsbc ==  5 )   WRITE(numout,*) '              coupled formulation'
171      ENDIF
172      !
173   END SUBROUTINE sbc_init
174
175
176   SUBROUTINE sbc( kt )
177      !!---------------------------------------------------------------------
178      !!                    ***  ROUTINE sbc  ***
179      !!             
180      !! ** Purpose :   provide at each time-step the ocean surface boundary
181      !!                condition (momentum, heat and freshwater fluxes)
182      !!
183      !! ** Method  :   blah blah  to be written ?????????
184      !!                CAUTION : never mask the surface stress field (tke sbc)
185      !!
186      !! ** Action  : - set the ocean surface boundary condition, i.e. 
187      !!                utau, vtau, qns, qsr, emp, emps, qrp, erp
188      !!              - updte the ice fraction : fr_i
189      !!----------------------------------------------------------------------
190      INTEGER, INTENT(in) ::   kt       ! ocean time step
191      !!---------------------------------------------------------------------
192
193      CALL iom_setkt( kt + nn_fsbc - 1 )         !  in sbc, iom_put is called every nn_fsbc time step
194      !
195      ! ocean to sbc mean sea surface variables (ss._m)
196      ! ---------------------------------------
197      CALL sbc_ssm( kt )                         ! sea surface mean currents (at U- and V-points),
198      !                                          ! temperature and salinity (at T-point) over nf_sbc time-step
199      !                                          ! (i.e. sst_m, sss_m, ssu_m, ssv_m)
200
201      ! sbc formulation
202      ! ---------------
203         
204      SELECT CASE( nsbc )                        ! Compute ocean surface boundary condition
205      !                                          ! (i.e. utau,vtau, qns, qsr, emp, emps)
206      CASE(  0 )   ;   CALL sbc_gyre    ( kt )                    ! analytical formulation : GYRE configuration
207      CASE(  1 )   ;   CALL sbc_ana     ( kt )                    ! analytical formulation : uniform sbc
208      CASE(  2 )   ;   CALL sbc_flx     ( kt )                    ! flux formulation
209      CASE(  3 )   ;   CALL sbc_blk_clio( kt )                    ! bulk formulation : CLIO for the ocean
210      CASE(  4 )   ;   CALL sbc_blk_core( kt )                    ! bulk formulation : CORE for the ocean
211      CASE(  5 )   ;   CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice )   ! coupled formulation
212      CASE( -1 )                               
213                       CALL sbc_ana     ( kt )                    ! ESOPA, test ALL the formulations
214                       CALL sbc_gyre    ( kt )                    !
215                       CALL sbc_flx     ( kt )                    !
216                       CALL sbc_blk_clio( kt )                    !
217                       CALL sbc_blk_core( kt )                    !
218                       CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice )   !
219      END SELECT
220
221      ! Misc. Options
222      ! -------------
223     
224      SELECT CASE( nn_ice )                                     ! Update heat and freshwater fluxes over sea-ice areas
225      CASE(  1 )   ;       CALL sbc_ice_if   ( kt )                   ! Ice-cover climatology ("Ice-if" model)
226         !                                                     
227      CASE(  2 )   ;       CALL sbc_ice_lim_2( kt, nsbc )             ! LIM 2.0 ice model
228         !                                                     
229      CASE(  3 )   ;       CALL sbc_ice_lim  ( kt, nsbc, nn_ico_cpl)  ! LIM 3.0 ice model
230      END SELECT                                             
231
232      IF( ln_rnf       )   CALL sbc_rnf( kt )                   ! add runoffs to fresh water fluxes
233 
234      IF( ln_ssr       )   CALL sbc_ssr( kt )                   ! add SST/SSS damping term
235
236      IF( nn_fwb  /= 0 )   CALL sbc_fwb( kt, nn_fwb, nn_fsbc )  ! control the freshwater budget
237
238      IF( nclosea == 1 )   CALL sbc_clo( kt )                   ! treatment of closed sea in the model domain
239      !                                                         ! (update freshwater fluxes)
240      !
241      IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN
242         CALL iom_put( "emp"    , emp       )                   ! upward water flux
243         CALL iom_put( "emps"   , emps      )                   ! c/d water flux
244         CALL iom_put( "qns+qsr", qns + qsr )                   ! total heat flux
245         CALL iom_put( "qns"    , qns       )                   ! solar heat flux
246         CALL iom_put( "qsr"    ,       qsr )                   ! solar heat flux
247         IF(  nn_ice > 0 )   CALL iom_put( "ice_cover", fr_i )  ! ice fraction
248      ENDIF
249      !
250      CALL iom_setkt( kt )           ! iom_put outside of sbc is called at every time step
251      !
252      CALL iom_put( "utau", utau )   ! i-wind stress   (stress can be updated at
253      CALL iom_put( "vtau", vtau )   ! j-wind stress    each time step in sea-ice)
254      CALL iom_put( "taum", taum )   ! wind stress module
255      CALL iom_put( "wspd", wndm )   ! wind speed  module
256      !
257      IF(ln_ctl) THEN         ! print mean trends (used for debugging)
258         CALL prt_ctl(tab2d_1=fr_i   , clinfo1=' fr_i - : ', mask1=tmask, ovlap=1 )
259         CALL prt_ctl(tab2d_1=emp    , clinfo1=' emp  - : ', mask1=tmask, ovlap=1 )
260         CALL prt_ctl(tab2d_1=emps   , clinfo1=' emps - : ', mask1=tmask, ovlap=1 )
261         CALL prt_ctl(tab2d_1=qns    , clinfo1=' qns  - : ', mask1=tmask, ovlap=1 )
262         CALL prt_ctl(tab2d_1=qsr    , clinfo1=' qsr  - : ', mask1=tmask, ovlap=1 )
263         CALL prt_ctl(tab3d_1=tmask  , clinfo1=' tmask  : ', mask1=tmask, ovlap=1, kdim=jpk )
264         CALL prt_ctl(tab3d_1=tn     , clinfo1=' sst  - : ', mask1=tmask, ovlap=1, kdim=1   )
265         CALL prt_ctl(tab3d_1=sn     , clinfo1=' sss  - : ', mask1=tmask, ovlap=1, kdim=1   )
266         CALL prt_ctl(tab2d_1=utau   , clinfo1=' utau - : ', mask1=umask,                      &
267            &         tab2d_2=vtau   , clinfo2=' vtau - : ', mask2=vmask, ovlap=1 )
268      ENDIF
269      !
270   END SUBROUTINE sbc
271
272   !!======================================================================
273END MODULE sbcmod
Note: See TracBrowser for help on using the repository browser.