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

source: branches/dev_001_SBC/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 879

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

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