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 @ 888

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

merge dev_001_SBC branche with the trunk to include the New Surface Module package, see ticket: #113
File size: 14.4 KB
Line 
1MODULE sbcmod
2   !!======================================================================
3   !!                       ***  MODULE  sbcmod  ***
4   !! Surface module :  provide to the ocean its surface boundary condition
5   !!======================================================================
6   !! History :  9.0   !  06-07  (G. Madec)  Original code
7   !!----------------------------------------------------------------------
8
9   !!----------------------------------------------------------------------
10   !!   sbc_init       : read namsbc namelist
11   !!   sbc            : surface ocean momentum, heat and freshwater
12   !!                    boundary conditions
13   !!----------------------------------------------------------------------
14   USE oce             ! ocean dynamics and tracers
15   USE dom_oce         ! ocean space and time domain
16   USE daymod          ! calendar
17   USE phycst          ! physical constants
18   USE ocfzpt          ! ocean freezing point
19
20   USE ice_oce         ! sea-ice model : LIM
21   USE sbc_oce         ! Surface boundary condition: ocean fields
22   USE sbcssm          ! surface boundary condition: sea-surface mean variables
23   USE sbcana          ! surface boundary condition: analytical formulation
24   USE sbcflx          ! surface boundary condition: flux formulation
25   USE sbcblk_clio     ! surface boundary condition: bulk formulation : CLIO
26   USE sbcblk_core     ! surface boundary condition: bulk formulation : CORE
27   USE sbcice_if       ! surface boundary condition: ice-if sea-ice model
28   USE sbcice_lim      ! surface boundary condition: LIM 3.0 sea-ice model
29   USE sbcice_lim_2    ! surface boundary condition: LIM 2.0 sea-ice model
30   USE sbccpl          ! surface boundary condition: coupled florulation
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   
46   !! * namsbc namelist (public variables)
47   LOGICAL , PUBLIC ::   ln_ana      = .FALSE.   !: analytical boundary condition flag
48   LOGICAL , PUBLIC ::   ln_flx      = .FALSE.   !: flux      formulation
49   LOGICAL , PUBLIC ::   ln_blk_clio = .FALSE.   !: CLIO bulk formulation
50   LOGICAL , PUBLIC ::   ln_blk_core = .FALSE.   !: CORE bulk formulation
51   LOGICAL , PUBLIC ::   ln_cpl      = .FALSE.   !: coupled   formulation (overwritten by key_sbc_coupled )
52   LOGICAL , PUBLIC ::   ln_dm2dc    = .FALSE.   !: Daily mean to Diurnal Cycle short wave (qsr)
53   LOGICAL , PUBLIC ::   ln_rnf      = .FALSE.   !: runoffs / runoff mouths
54   LOGICAL , PUBLIC ::   ln_ssr      = .FALSE.   !: Sea Surface restoring on SST and/or SSS     
55   INTEGER , PUBLIC ::   nn_ice      = 0         !: flag on ice in the surface boundary condition (=0/1/2)
56   INTEGER , PUBLIC ::   nn_fwb      = 0         !: type of FreshWater Budget control (=0/1/2)
57   NAMELIST/namsbc/ nn_fsbc, ln_ana, ln_flx, ln_blk_clio, ln_blk_core, ln_cpl,   &
58      &             nn_ice , ln_dm2dc, ln_rnf, ln_ssr, nn_fwb
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   !!   OPA 9.0 , LOCEAN-IPSL (2006)
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
87      IF(lwp) THEN
88         WRITE(numout,*)
89         WRITE(numout,*) 'sbc_init : surface boundary condition setting'
90         WRITE(numout,*) '~~~~~~~~ '
91      ENDIF
92
93      REWIND ( numnam )                   ! Read Namelist namsbc
94      READ   ( numnam, namsbc )
95
96      ! overwrite namelist parameter using CPP key information
97!!gmhere no overwrite, test all option via namelist change: require more incore memory
98!!gm  IF( lk_sbc_cpl       ) THEN   ;   ln_cpl      = .TRUE.   ;   ELSE   ;   ln_cpl      = .FALSE.   ;   ENDIF
99      IF( lk_lim2 )            nn_ice      = 2
100      IF( lk_lim3 )            nn_ice      = 3
101      IF( cp_cfg == 'gyre' ) THEN
102          ln_ana      = .TRUE.   
103          nn_ice      =   0
104      ENDIF
105     
106      ! Control print
107      IF(lwp) THEN
108         WRITE(numout,*) '        Namelist namsbc (overwritten using CPP key defined)'
109         WRITE(numout,*) '           frequency update of sbc (and ice)             nn_fsbc     = ', nn_fsbc
110         WRITE(numout,*) '           Type of sbc : '
111         WRITE(numout,*) '              analytical formulation                     ln_ana      = ', ln_ana
112         WRITE(numout,*) '              flux       formulation                     ln_flx      = ', ln_flx
113         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_clio = ', ln_blk_clio
114         WRITE(numout,*) '              CLIO bulk  formulation                     ln_blk_core = ', ln_blk_core
115         WRITE(numout,*) '              coupled    formulation (T if key_sbc_cpl)  ln_cpl      = ', ln_cpl
116         WRITE(numout,*) '           Misc. options of sbc : '
117         WRITE(numout,*) '              ice management in the sbc (=0/1/2)         nn_ice      = ', nn_ice 
118         WRITE(numout,*) '              daily mean to diurnal cycle qsr            ln_dm2dc    = ', ln_dm2dc 
119         WRITE(numout,*) '              runoff / runoff mouths                     ln_rnf      = ', ln_rnf
120         WRITE(numout,*) '              Sea Surface Restoring on SST and/or SSS    ln_ssr      = ', ln_ssr
121         WRITE(numout,*) '              FreshWater Budget control  (=0/1/2)        nn_fwb      = ', nn_fwb
122         WRITE(numout,*) '              closed sea (=0/1) (set in namdom)          nclosea     = ', nclosea
123      ENDIF
124
125      ! Check consistancy   !!gm mixture of real and integer : coding to be changed....
126
127      IF( .NOT. ln_rnf )   nn_runoff = 0      ! no runoff, or runoff mouths
128
129      IF( nn_ice == 2 )   THEN
130         IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 ) THEN
131            WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
132            CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' )
133         ENDIF
134         IF( MOD( nstock, nn_fsbc) /= 0 ) THEN
135            WRITE(ctmp1,*) 'nstock ('           , nstock             , ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
136            CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' )
137         ENDIF
138      ENDIF
139
140      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' )
141
142      IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core ) )   &
143         &   CALL ctl_stop( 'sbc_init: sea-ice model requires a bulk formulation' )
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      !!----------------------------------------------------------------------
189      INTEGER, INTENT(in) ::   kt       ! ocean time step
190      !!---------------------------------------------------------------------
191
192      IF( kt == nit000 )   CALL sbc_init         ! Read namsbc namelist : surface module
193
194      ! ocean to sbc mean sea surface variables (ss._m)
195      ! ---------------------------------------
196      CALL sbc_ssm( kt )                         ! sea surface mean currents (at U- and V-points),
197      !                                          ! temperature and salinity (at T-point) over nf_sbc time-step
198      !                                          ! (i.e. sst_m, sss_m, ssu_m, ssv_m)
199
200!!gm  add a flag on nn_fsbc frequency ?????  except the diurnal cycle!
201!!    IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
202
203
204      ! sbc formulation
205      ! ---------------
206         
207      SELECT CASE( nsbc )                        ! Compute ocean surface boundary condition
208      !                                          ! (i.e. utau,vtau, qns, qsr, emp, emps)
209      CASE(  0 )   ;   CALL sbc_gyre    ( kt )      ! analytical formulation : GYRE configuration
210      CASE(  1 )   ;   CALL sbc_ana     ( kt )      ! analytical formulation : uniform sbc
211      CASE(  2 )   ;   CALL sbc_flx     ( kt )      ! flux formulation
212      CASE(  3 )   ;   CALL sbc_blk_clio( kt )      ! bulk formulation : CLIO for the ocean
213      CASE(  4 )   ;   CALL sbc_blk_core( kt )      ! bulk formulation : CORE for the ocean
214      CASE(  5 )   ;   CALL sbc_cpl     ( kt )      ! coupled formulation
215      CASE( -1 )                               
216         ;             CALL sbc_ana     ( kt )      ! ESOPA, test ALL the formulations
217         ;             CALL sbc_gyre    ( kt )
218         ;             CALL sbc_flx     ( kt )
219         ;             CALL sbc_blk_clio( kt )
220         ;             CALL sbc_blk_core( kt )
221         ;             CALL sbc_cpl     ( kt )
222      END SELECT
223
224      ! Misc. Options
225      ! -------------
226
227!!gm  IF( ln_dm2dc       )   CALL sbc_dcy( kt )                 ! Daily mean qsr distributed over the Diurnal Cycle
228     
229      SELECT CASE( nn_ice )                                     ! Update sbc over ice-covered areas
230      CASE(  1 )   ;         CALL sbc_ice_if ( kt )                  ! Ice-cover climatology ("Ice-if" model)
231         !                                                           ! (update heat and freshwater fluxes)
232      CASE(  2 )   ;         CALL sbc_ice_lim_2( kt, nsbc )          ! LIM 2.0 ice model
233         !                                                           ! (update heat and freshwater fluxes)
234      CASE(  3 )   ;         CALL sbc_ice_lim  ( kt, nsbc )          ! LIM 3.0 ice model
235      END SELECT                                                     ! (update all fluxes using bulk + LIM)
236
237      IF( ln_ssr         )   CALL sbc_ssr( kt )                 ! add SST/SSS damping term
238
239      IF( ln_rnf         )   CALL sbc_rnf( kt )                 ! add runoffs to fresh water fluxes
240 
241      IF( nn_fwb    /= 0 )   CALL sbc_fwb( kt, nn_fwb, nn_fsbc )         ! control the freshwater budget
242
243      IF( nclosea == 1 )   CALL sbc_clo( kt )                   ! treatment of closed sea in the model domain
244      !                                                         ! (update freshwater fluxes)
245      !
246      IF(ln_ctl) THEN         ! print mean trends (used for debugging)
247         CALL prt_ctl(tab2d_1=emp    , clinfo1=' emp  - : ', mask1=tmask, ovlap=1)
248         CALL prt_ctl(tab2d_1=emps   , clinfo1=' emps - : ', mask1=tmask, ovlap=1)
249         CALL prt_ctl(tab2d_1=qns    , clinfo1=' qns  - : ', mask1=tmask, ovlap=1)
250         CALL prt_ctl(tab2d_1=qsr    , clinfo1=' qsr  - : ', mask1=tmask, ovlap=1)
251         CALL prt_ctl(tab3d_1=tmask  , clinfo1=' tmask  : ', mask1=tmask, ovlap=1, kdim=jpk)
252         CALL prt_ctl(tab3d_1=tn     , clinfo1=' sst  - : ', mask1=tmask, ovlap=1, kdim=1)
253         CALL prt_ctl(tab3d_1=sn     , clinfo1=' sss  - : ', mask1=tmask, ovlap=1, kdim=1)
254         CALL prt_ctl(tab2d_1=utau   , clinfo1=' utau - : ', mask1=umask, &
255                      tab2d_2=vtau   , clinfo2=' vtau - : ', mask2=vmask, ovlap=1)
256      ENDIF
257
258!!gm
259!!    ENDIF
260!!gm
261      !
262   END SUBROUTINE sbc
263
264   !!======================================================================
265END MODULE sbcmod
Note: See TracBrowser for help on using the repository browser.