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

source: trunk/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 1061

Last change on this file since 1061 was 1061, checked in by ctlod, 16 years ago

trunk: make the CALL sbc_rnf() before the CALL sbc_ssr() since rnfmsk(:,:) array is used in sbcssr.F90, so it must be filled, see ticket: #189
File size: 14.9 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   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   sbc_init       : read namsbc namelist
11   !!   sbc            : surface ocean momentum, heat and freshwater boundary conditions
12   !!----------------------------------------------------------------------
13   USE oce             ! ocean dynamics and tracers
14   USE dom_oce         ! ocean space and time domain
15   USE daymod          ! calendar
16   USE phycst          ! physical constants
17
18   USE ice_oce         ! sea-ice model : LIM
19   USE sbc_oce         ! Surface boundary condition: ocean fields
20   USE sbcssm          ! surface boundary condition: sea-surface mean variables
21   USE sbcana          ! surface boundary condition: analytical formulation
22   USE sbcflx          ! surface boundary condition: flux formulation
23   USE sbcblk_clio     ! surface boundary condition: bulk formulation : CLIO
24   USE sbcblk_core     ! surface boundary condition: bulk formulation : CORE
25   USE sbcice_if       ! surface boundary condition: ice-if sea-ice model
26   USE sbcice_lim      ! surface boundary condition: LIM 3.0 sea-ice model
27   USE sbcice_lim_2    ! surface boundary condition: LIM 2.0 sea-ice model
28   USE sbccpl          ! surface boundary condition: coupled florulation
29   USE sbcssr          ! surface boundary condition: sea surface restoring
30   USE sbcrnf          ! surface boundary condition: runoffs
31   USE sbcfwb          ! surface boundary condition: freshwater budget
32   USE closea          ! closed sea
33
34   USE prtctl          ! Print control                    (prt_ctl routine)
35   USE restart         ! ocean restart
36   USE iom
37   USE in_out_manager  ! I/O manager
38
39   IMPLICIT NONE
40   PRIVATE
41
42   PUBLIC   sbc        ! routine called by step.F90
43   
44   !! * namsbc namelist (public variables)
45   LOGICAL , PUBLIC ::   ln_ana      = .FALSE.   !: analytical boundary condition flag
46   LOGICAL , PUBLIC ::   ln_flx      = .FALSE.   !: flux      formulation
47   LOGICAL , PUBLIC ::   ln_blk_clio = .FALSE.   !: CLIO bulk formulation
48   LOGICAL , PUBLIC ::   ln_blk_core = .FALSE.   !: CORE bulk formulation
49   LOGICAL , PUBLIC ::   ln_cpl      = .FALSE.   !: coupled   formulation (overwritten by key_sbc_coupled )
50   LOGICAL , PUBLIC ::   ln_dm2dc    = .FALSE.   !: Daily mean to Diurnal Cycle short wave (qsr)
51   LOGICAL , PUBLIC ::   ln_rnf      = .FALSE.   !: runoffs / runoff mouths
52   LOGICAL , PUBLIC ::   ln_ssr      = .FALSE.   !: Sea Surface restoring on SST and/or SSS     
53   INTEGER , PUBLIC ::   nn_ice      = 0         !: flag on ice in the surface boundary condition (=0/1/2)
54   INTEGER , PUBLIC ::   nn_fwb      = 0         !: type of FreshWater Budget control (=0/1/2)
55   INTEGER          ::   nn_ico_cpl  = 0         !: ice-ocean coupling indicator
56   !                                             !  = 0   LIM-3 old case
57   !                                             !  = 1   stresses computed using now ocean velocity
58   !                                             !  = 2   combination of 0 and 1 cases
59
60   INTEGER ::   nsbc   ! type of surface boundary condition (deduced from namsbc informations)
61   INTEGER ::   nice   ! type of ice in the surface boundary condition (deduced from namsbc informations)
62     
63   !! * Substitutions
64#  include "domzgr_substitute.h90"
65   !!----------------------------------------------------------------------
66   !! NEMO/OPA 3.0 , LOCEAN-IPSL (2008)
67   !! $Id: $
68   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
69   !!----------------------------------------------------------------------
70
71CONTAINS
72
73   SUBROUTINE sbc_init
74      !!---------------------------------------------------------------------
75      !!                    ***  ROUTINE sbc_init ***
76      !!
77      !! ** Purpose :   Initialisation of the ocean surface boundary computation
78      !!
79      !! ** Method  :   Read the namsbc namelist and set derived parameters
80      !!
81      !! ** Action  : - read namsbc parameters
82      !!              - nsbc: type of sbc
83      !!----------------------------------------------------------------------
84      INTEGER ::   icpt      ! temporary integer
85      !!
86      NAMELIST/namsbc/ nn_fsbc, ln_ana, ln_flx, ln_blk_clio, ln_blk_core, ln_cpl,   &
87         &             nn_ice , ln_dm2dc, ln_rnf, ln_ssr, nn_fwb, nn_ico_cpl
88      !!----------------------------------------------------------------------
89
90      IF(lwp) THEN
91         WRITE(numout,*)
92         WRITE(numout,*) 'sbc_init : surface boundary condition setting'
93         WRITE(numout,*) '~~~~~~~~ '
94      ENDIF
95
96      REWIND ( numnam )                   ! Read Namelist namsbc
97      READ   ( numnam, namsbc )
98
99      ! overwrite namelist parameter using CPP key information
100!!gmhere no overwrite, test all option via namelist change: require more incore memory
101!!gm  IF( lk_sbc_cpl       ) THEN   ;   ln_cpl      = .TRUE.   ;   ELSE   ;   ln_cpl      = .FALSE.   ;   ENDIF
102      IF( lk_lim2 )            nn_ice      = 2
103      IF( lk_lim3 )            nn_ice      = 3
104      IF( cp_cfg == 'gyre' ) THEN
105          ln_ana      = .TRUE.   
106          nn_ice      =   0
107      ENDIF
108     
109      ! Control print
110      IF(lwp) THEN
111         WRITE(numout,*) '        Namelist namsbc (overwritten using CPP key defined)'
112         WRITE(numout,*) '           frequency update of sbc (and ice)             nn_fsbc     = ', nn_fsbc
113         WRITE(numout,*) '           Type of sbc : '
114         WRITE(numout,*) '              analytical formulation                     ln_ana      = ', ln_ana
115         WRITE(numout,*) '              flux       formulation                     ln_flx      = ', ln_flx
116         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_clio = ', ln_blk_clio
117         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_core = ', ln_blk_core
118         WRITE(numout,*) '              coupled    formulation (T if key_sbc_cpl)  ln_cpl      = ', ln_cpl
119         WRITE(numout,*) '           Misc. options of sbc : '
120         WRITE(numout,*) '              ice management in the sbc (=0/1/2/3)       nn_ice      = ', nn_ice 
121         WRITE(numout,*) '              ice-ocean stress computation (=0/1/2)      nn_ico_cpl  = ', nn_ico_cpl
122         WRITE(numout,*) '              daily mean to diurnal cycle qsr            ln_dm2dc    = ', ln_dm2dc 
123         WRITE(numout,*) '              runoff / runoff mouths                     ln_rnf      = ', ln_rnf
124         WRITE(numout,*) '              Sea Surface Restoring on SST and/or SSS    ln_ssr      = ', ln_ssr
125         WRITE(numout,*) '              FreshWater Budget control  (=0/1/2)        nn_fwb      = ', nn_fwb
126         WRITE(numout,*) '              closed sea (=0/1) (set in namdom)          nclosea     = ', nclosea
127      ENDIF
128
129      IF( .NOT. ln_rnf )   nn_runoff = 0      ! no runoff, or runoff mouths
130      IF( nn_ice == 0  )   fr_i(:,:) = 0.e0   ! no ice in the domain, ice fraction is always zero
131
132      ! Check consistancy   !!gm mixture of real and integer : coding to be changed....
133
134      IF( nn_ice == 2 )   THEN
135         IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 ) THEN
136            WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
137            CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' )
138         ENDIF
139         IF( MOD( nstock, nn_fsbc) /= 0 ) THEN
140            WRITE(ctmp1,*) 'nstock ('           , nstock             , ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
141            CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' )
142         ENDIF
143      ENDIF
144
145      IF( MOD( rday, nn_fsbc*rdt ) /= 0 )   CALL ctl_warn( 'nn_fsbc is NOT a multiple of the number of time steps in a day' )
146
147      IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core ) )   &
148         &   CALL ctl_stop( 'sbc_init: sea-ice model requires a bulk formulation' )
149     
150      ! Choice of the Surface Boudary Condition (set nsbc)
151      icpt = 0
152      IF( ln_ana          ) THEN   ;   nsbc =  1   ; icpt = icpt + 1   ;   ENDIF       ! analytical      formulation
153      IF( ln_flx          ) THEN   ;   nsbc =  2   ; icpt = icpt + 1   ;   ENDIF       ! flux            formulation
154      IF( ln_blk_clio     ) THEN   ;   nsbc =  3   ; icpt = icpt + 1   ;   ENDIF       ! CLIO bulk       formulation
155      IF( ln_blk_core     ) THEN   ;   nsbc =  4   ; icpt = icpt + 1   ;   ENDIF       ! CORE bulk       formulation
156      IF( ln_cpl          ) THEN   ;   nsbc =  5   ; icpt = icpt + 1   ;   ENDIF       ! Coupled         formulation
157      IF( cp_cfg == 'gyre') THEN   ;   nsbc =  0                       ;   ENDIF       ! GYRE analytical formulation
158      IF( lk_esopa        )            nsbc = -1                                       ! esopa test, ALL formulations
159
160      IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN
161         WRITE(numout,*)
162         WRITE(numout,*) '           E R R O R in setting the sbc, one and only one namelist/CPP key option '
163         WRITE(numout,*) '                     must be choosen. You choose ', icpt, ' option(s)'
164         WRITE(numout,*) '                     We stop'
165         nstop = nstop + 1
166      ENDIF
167      IF(lwp) THEN
168         WRITE(numout,*)
169         IF( nsbc == -1 )   WRITE(numout,*) '              ESOPA test All surface boundary conditions'
170         IF( nsbc ==  0 )   WRITE(numout,*) '              GYRE analytical formulation'
171         IF( nsbc ==  1 )   WRITE(numout,*) '              analytical formulation'
172         IF( nsbc ==  2 )   WRITE(numout,*) '              flux formulation'
173         IF( nsbc ==  3 )   WRITE(numout,*) '              CLIO bulk formulation'
174         IF( nsbc ==  4 )   WRITE(numout,*) '              CORE bulk formulation'
175         IF( nsbc ==  5 )   WRITE(numout,*) '              coupled formulation'
176      ENDIF
177      !
178   END SUBROUTINE sbc_init
179
180
181   SUBROUTINE sbc( kt )
182      !!---------------------------------------------------------------------
183      !!                    ***  ROUTINE sbc  ***
184      !!             
185      !! ** Purpose :   provide at each time-step the ocean surface boundary
186      !!                condition (momentum, heat and freshwater fluxes)
187      !!
188      !! ** Method  :   blah blah  to be written ?????????
189      !!                CAUTION : never mask the surface stress field (tke sbc)
190      !!
191      !! ** Action  : - set the ocean surface boundary condition, i.e. 
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      IF( kt == nit000 )   CALL sbc_init         ! Read namsbc namelist : surface module
199
200      ! ocean to sbc mean sea surface variables (ss._m)
201      ! ---------------------------------------
202      CALL sbc_ssm( kt )                         ! sea surface mean currents (at U- and V-points),
203      !                                          ! temperature and salinity (at T-point) over nf_sbc time-step
204      !                                          ! (i.e. sst_m, sss_m, ssu_m, ssv_m)
205
206      ! sbc formulation
207      ! ---------------
208         
209      SELECT CASE( nsbc )                        ! Compute ocean surface boundary condition
210      !                                          ! (i.e. utau,vtau, qns, qsr, emp, emps)
211      CASE(  0 )   ;   CALL sbc_gyre    ( kt )      ! analytical formulation : GYRE configuration
212      CASE(  1 )   ;   CALL sbc_ana     ( kt )      ! analytical formulation : uniform sbc
213      CASE(  2 )   ;   CALL sbc_flx     ( kt )      ! flux formulation
214      CASE(  3 )   ;   CALL sbc_blk_clio( kt )      ! bulk formulation : CLIO for the ocean
215      CASE(  4 )   ;   CALL sbc_blk_core( kt )      ! bulk formulation : CORE for the ocean
216      CASE(  5 )   ;   CALL sbc_cpl     ( kt )      ! coupled formulation
217      CASE( -1 )                               
218                       CALL sbc_ana     ( kt )      ! ESOPA, test ALL the formulations
219                       CALL sbc_gyre    ( kt )
220                       CALL sbc_flx     ( kt )
221                       CALL sbc_blk_clio( kt )
222                       CALL sbc_blk_core( kt )
223                       CALL sbc_cpl     ( kt )
224      END SELECT
225
226      ! Misc. Options
227      ! -------------
228
229!!gm  IF( ln_dm2dc       )   CALL sbc_dcy( kt )                 ! Daily mean qsr distributed over the Diurnal Cycle
230     
231      SELECT CASE( nn_ice )                                     ! Update heat and freshwater fluxes over ice-covered areas
232      CASE(  1 )   ;       CALL sbc_ice_if ( kt )                     ! Ice-cover climatology ("Ice-if" model)
233         !                                                     
234      CASE(  2 )   ;       CALL sbc_ice_lim_2( kt, nsbc )             ! LIM 2.0 ice model
235         !                                                     
236      CASE(  3 )   ;       CALL sbc_ice_lim  ( kt, nsbc, nn_ico_cpl)  ! LIM 3.0 ice model
237      END SELECT                                             
238
239      IF( ln_rnf       )   CALL sbc_rnf( kt )                   ! add runoffs to fresh water fluxes
240 
241      IF( ln_ssr       )   CALL sbc_ssr( kt )                   ! add SST/SSS damping term
242
243      IF( nn_fwb  /= 0 )   CALL sbc_fwb( kt, nn_fwb, nn_fsbc )  ! control the freshwater budget
244
245      IF( nclosea == 1 )   CALL sbc_clo( kt )                   ! treatment of closed sea in the model domain
246      !                                                         ! (update freshwater fluxes)
247      !
248      IF(ln_ctl) THEN         ! print mean trends (used for debugging)
249         CALL prt_ctl(tab2d_1=fr_i   , clinfo1=' fr_i - : ', mask1=tmask, ovlap=1 )
250         CALL prt_ctl(tab2d_1=emp    , clinfo1=' emp  - : ', mask1=tmask, ovlap=1 )
251         CALL prt_ctl(tab2d_1=emps   , clinfo1=' emps - : ', mask1=tmask, ovlap=1 )
252         CALL prt_ctl(tab2d_1=qns    , clinfo1=' qns  - : ', mask1=tmask, ovlap=1 )
253         CALL prt_ctl(tab2d_1=qsr    , clinfo1=' qsr  - : ', mask1=tmask, ovlap=1 )
254         CALL prt_ctl(tab3d_1=tmask  , clinfo1=' tmask  : ', mask1=tmask, ovlap=1, kdim=jpk )
255         CALL prt_ctl(tab3d_1=tn     , clinfo1=' sst  - : ', mask1=tmask, ovlap=1, kdim=1   )
256         CALL prt_ctl(tab3d_1=sn     , clinfo1=' sss  - : ', mask1=tmask, ovlap=1, kdim=1   )
257         CALL prt_ctl(tab2d_1=utau   , clinfo1=' utau - : ', mask1=umask,                      &
258            &         tab2d_2=vtau   , clinfo2=' vtau - : ', mask2=vmask, ovlap=1 )
259      ENDIF
260      !
261   END SUBROUTINE sbc
262
263   !!======================================================================
264END MODULE sbcmod
Note: See TracBrowser for help on using the repository browser.