1 | MODULE 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 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 cpl_oasis3, ONLY:lk_cpl ! are we in coupled mode? |
---|
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 | USE agrif_nolim |
---|
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 (modipsl/doc/NEMO_CeCILL.txt) |
---|
55 | !!---------------------------------------------------------------------- |
---|
56 | |
---|
57 | CONTAINS |
---|
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 | !!gm here no overwrite, test all option via namelist change: require more incore memory |
---|
87 | !!gm IF( lk_sbc_cpl ) THEN ; ln_cpl = .TRUE. ; ELSE ; ln_cpl = .FALSE. ; ENDIF |
---|
88 | #if defined key_agrif |
---|
89 | IF ( Agrif_Root() ) THEN |
---|
90 | #endif |
---|
91 | IF( lk_lim2 ) nn_ice = 2 |
---|
92 | IF( lk_lim3 ) nn_ice = 3 |
---|
93 | #if defined key_agrif |
---|
94 | ENDIF |
---|
95 | #endif |
---|
96 | IF( cp_cfg == 'gyre' ) THEN |
---|
97 | ln_ana = .TRUE. |
---|
98 | nn_ice = 0 |
---|
99 | ENDIF |
---|
100 | |
---|
101 | #if defined key_agrif && defined key_agrif_nolim |
---|
102 | IF ( .NOT. Agrif_Root() ) THEN |
---|
103 | IF( nn_ice /= 0 ) CALL ctl_stop("sbcmod: non-zero nn_ice in nest model when interpolating") |
---|
104 | IF( ln_ssr ) CALL ctl_stop("sbcmod: surface relaxation not valid when interpolating") |
---|
105 | IF( nn_fwb /= 0) CALL ctl_stop("sbcmod: adjustment of freshwater budget not valid when interpolating") |
---|
106 | ENDIF |
---|
107 | ! |
---|
108 | CALL agrif_nolim_init() |
---|
109 | ! |
---|
110 | #endif |
---|
111 | |
---|
112 | ! Control print |
---|
113 | IF(lwp) THEN |
---|
114 | WRITE(numout,*) ' Namelist namsbc (partly overwritten with CPP key setting)' |
---|
115 | WRITE(numout,*) ' frequency update of sbc (and ice) nn_fsbc = ', nn_fsbc |
---|
116 | WRITE(numout,*) ' Type of sbc : ' |
---|
117 | WRITE(numout,*) ' analytical formulation ln_ana = ', ln_ana |
---|
118 | WRITE(numout,*) ' flux formulation ln_flx = ', ln_flx |
---|
119 | WRITE(numout,*) ' CLIO bulk formulation ln_blk_clio = ', ln_blk_clio |
---|
120 | WRITE(numout,*) ' CLIO bulk formulation ln_blk_core = ', ln_blk_core |
---|
121 | WRITE(numout,*) ' coupled formulation (T if key_sbc_cpl) ln_cpl = ', ln_cpl |
---|
122 | WRITE(numout,*) ' Misc. options of sbc : ' |
---|
123 | WRITE(numout,*) ' ice management in the sbc (=0/1/2/3) nn_ice = ', nn_ice |
---|
124 | WRITE(numout,*) ' ice-ocean stress computation (=0/1/2) nn_ico_cpl = ', nn_ico_cpl |
---|
125 | WRITE(numout,*) ' daily mean to diurnal cycle qsr ln_dm2dc = ', ln_dm2dc |
---|
126 | WRITE(numout,*) ' runoff / runoff mouths ln_rnf = ', ln_rnf |
---|
127 | WRITE(numout,*) ' Sea Surface Restoring on SST and/or SSS ln_ssr = ', ln_ssr |
---|
128 | WRITE(numout,*) ' FreshWater Budget control (=0/1/2) nn_fwb = ', nn_fwb |
---|
129 | WRITE(numout,*) ' closed sea (=0/1) (set in namdom) nn_closea = ', nn_closea |
---|
130 | ENDIF |
---|
131 | |
---|
132 | IF( .NOT. ln_rnf ) THEN ! no specific treatment in vicinity of river mouths |
---|
133 | ln_rnf_mouth = .false. |
---|
134 | nkrnf = 0 |
---|
135 | rnfmsk (:,:) = 0.e0 |
---|
136 | rnfmsk_z(:) = 0.e0 |
---|
137 | ENDIF |
---|
138 | IF( nn_ice == 0 ) fr_i(:,:) = 0.e0 ! no ice in the domain, ice fraction is always zero |
---|
139 | |
---|
140 | ! ! restartability |
---|
141 | IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 .OR. & |
---|
142 | MOD( nstock , nn_fsbc) /= 0 ) THEN |
---|
143 | WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') or nstock (', nstock, & |
---|
144 | & ' is NOT a multiple of nn_fsbc (', nn_fsbc, ')' |
---|
145 | CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' ) |
---|
146 | ENDIF |
---|
147 | ! |
---|
148 | IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 ) & |
---|
149 | & CALL ctl_warn( 'nn_fsbc is NOT a multiple of the number of time steps in a day' ) |
---|
150 | ! |
---|
151 | IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core .OR. lk_cpl ) ) & |
---|
152 | & CALL ctl_stop( 'sea-ice model requires a bulk formulation or coupled configuration' ) |
---|
153 | |
---|
154 | ! Choice of the Surface Boudary Condition (set nsbc) |
---|
155 | icpt = 0 |
---|
156 | IF( ln_ana ) THEN ; nsbc = 1 ; icpt = icpt + 1 ; ENDIF ! analytical formulation |
---|
157 | IF( ln_flx ) THEN ; nsbc = 2 ; icpt = icpt + 1 ; ENDIF ! flux formulation |
---|
158 | IF( ln_blk_clio ) THEN ; nsbc = 3 ; icpt = icpt + 1 ; ENDIF ! CLIO bulk formulation |
---|
159 | IF( ln_blk_core ) THEN ; nsbc = 4 ; icpt = icpt + 1 ; ENDIF ! CORE bulk formulation |
---|
160 | IF( ln_cpl ) THEN ; nsbc = 5 ; icpt = icpt + 1 ; ENDIF ! Coupled formulation |
---|
161 | IF( cp_cfg == 'gyre') THEN ; nsbc = 0 ; ENDIF ! GYRE analytical formulation |
---|
162 | IF( lk_esopa ) nsbc = -1 ! esopa test, ALL formulations |
---|
163 | |
---|
164 | IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN |
---|
165 | WRITE(numout,*) |
---|
166 | WRITE(numout,*) ' E R R O R in setting the sbc, one and only one namelist/CPP key option ' |
---|
167 | WRITE(numout,*) ' must be choosen. You choose ', icpt, ' option(s)' |
---|
168 | WRITE(numout,*) ' We stop' |
---|
169 | nstop = nstop + 1 |
---|
170 | ENDIF |
---|
171 | IF(lwp) THEN |
---|
172 | WRITE(numout,*) |
---|
173 | IF( nsbc == -1 ) WRITE(numout,*) ' ESOPA test All surface boundary conditions' |
---|
174 | IF( nsbc == 0 ) WRITE(numout,*) ' GYRE analytical formulation' |
---|
175 | IF( nsbc == 1 ) WRITE(numout,*) ' analytical formulation' |
---|
176 | IF( nsbc == 2 ) WRITE(numout,*) ' flux formulation' |
---|
177 | IF( nsbc == 3 ) WRITE(numout,*) ' CLIO bulk formulation' |
---|
178 | IF( nsbc == 4 ) WRITE(numout,*) ' CORE bulk formulation' |
---|
179 | IF( nsbc == 5 ) WRITE(numout,*) ' coupled formulation' |
---|
180 | ENDIF |
---|
181 | ! |
---|
182 | END SUBROUTINE sbc_init |
---|
183 | |
---|
184 | |
---|
185 | SUBROUTINE sbc( kt ) |
---|
186 | !!--------------------------------------------------------------------- |
---|
187 | !! *** ROUTINE sbc *** |
---|
188 | !! |
---|
189 | !! ** Purpose : provide at each time-step the ocean surface boundary |
---|
190 | !! condition (momentum, heat and freshwater fluxes) |
---|
191 | !! |
---|
192 | !! ** Method : blah blah to be written ????????? |
---|
193 | !! CAUTION : never mask the surface stress field (tke sbc) |
---|
194 | !! |
---|
195 | !! ** Action : - set the ocean surface boundary condition, i.e. |
---|
196 | !! utau, vtau, qns, qsr, emp, emps, qrp, erp |
---|
197 | !! - updte the ice fraction : fr_i |
---|
198 | !!---------------------------------------------------------------------- |
---|
199 | INTEGER, INTENT(in) :: kt ! ocean time step |
---|
200 | !!--------------------------------------------------------------------- |
---|
201 | |
---|
202 | CALL iom_setkt( kt + nn_fsbc - 1 ) ! in sbc, iom_put is called every nn_fsbc time step |
---|
203 | ! |
---|
204 | ! ocean to sbc mean sea surface variables (ss._m) |
---|
205 | ! --------------------------------------- |
---|
206 | CALL sbc_ssm( kt ) ! sea surface mean currents (at U- and V-points), |
---|
207 | ! ! temperature and salinity (at T-point) over nf_sbc time-step |
---|
208 | ! ! (i.e. sst_m, sss_m, ssu_m, ssv_m) |
---|
209 | |
---|
210 | ! sbc formulation |
---|
211 | ! --------------- |
---|
212 | |
---|
213 | #if key_agrif && defined key_agrif_nolim |
---|
214 | |
---|
215 | ! use nolim code only if both key_agrif_nolim is set and logical is true |
---|
216 | ! this way the logical can be false if there are no nests (ie AGRIF_FixedGrids.in has a zero) |
---|
217 | |
---|
218 | IF( lk_nolim_nst) THEN |
---|
219 | |
---|
220 | IF( Agrif_Root() ) THEN |
---|
221 | ! |
---|
222 | CALL agrif_nolim_extrap( kt ) |
---|
223 | ! |
---|
224 | ELSE |
---|
225 | ! |
---|
226 | CALL agrif_nolim_flx( kt ) |
---|
227 | ! |
---|
228 | ENDIF |
---|
229 | |
---|
230 | ENDIF |
---|
231 | #endif |
---|
232 | |
---|
233 | IF( .NOT. lk_nolim_nst ) THEN |
---|
234 | |
---|
235 | SELECT CASE( nsbc ) ! Compute ocean surface boundary condition |
---|
236 | ! ! (i.e. utau,vtau, qns, qsr, emp, emps) |
---|
237 | CASE( 0 ) ; CALL sbc_gyre ( kt ) ! analytical formulation : GYRE configuration |
---|
238 | CASE( 1 ) ; CALL sbc_ana ( kt ) ! analytical formulation : uniform sbc |
---|
239 | CASE( 2 ) ; CALL sbc_flx ( kt ) ! flux formulation |
---|
240 | CASE( 3 ) ; CALL sbc_blk_clio( kt ) ! bulk formulation : CLIO for the ocean |
---|
241 | CASE( 4 ) ; CALL sbc_blk_core( kt ) ! bulk formulation : CORE for the ocean |
---|
242 | CASE( 5 ) ; CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! coupled formulation |
---|
243 | CASE( -1 ) |
---|
244 | CALL sbc_ana ( kt ) ! ESOPA, test ALL the formulations |
---|
245 | CALL sbc_gyre ( kt ) ! |
---|
246 | CALL sbc_flx ( kt ) ! |
---|
247 | CALL sbc_blk_clio( kt ) ! |
---|
248 | CALL sbc_blk_core( kt ) ! |
---|
249 | CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! |
---|
250 | END SELECT |
---|
251 | |
---|
252 | ! Misc. Options |
---|
253 | ! ------------- |
---|
254 | |
---|
255 | !!gm IF( ln_dm2dc ) CALL sbc_dcy( kt ) ! Daily mean qsr distributed over the Diurnal Cycle |
---|
256 | |
---|
257 | SELECT CASE( nn_ice ) ! Update heat and freshwater fluxes over sea-ice areas |
---|
258 | CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model) |
---|
259 | ! |
---|
260 | CASE( 2 ) ; CALL sbc_ice_lim_2( kt, nsbc ) ! LIM 2.0 ice model |
---|
261 | ! |
---|
262 | CASE( 3 ) ; CALL sbc_ice_lim ( kt, nsbc, nn_ico_cpl) ! LIM 3.0 ice model |
---|
263 | END SELECT |
---|
264 | |
---|
265 | IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes |
---|
266 | |
---|
267 | IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term |
---|
268 | |
---|
269 | IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget |
---|
270 | |
---|
271 | IF( nclosea == 1 ) CALL sbc_clo( kt ) ! treatment of closed sea in the model domain |
---|
272 | ! ! (update freshwater fluxes) |
---|
273 | ENDIF |
---|
274 | ! |
---|
275 | IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN |
---|
276 | CALL iom_put( "emp" , emp ) ! upward water flux |
---|
277 | CALL iom_put( "emps" , emps ) ! c/d water flux |
---|
278 | CALL iom_put( "qns+qsr", qns + qsr ) ! total heat flux (caution if ln_dm2dc=true, to be |
---|
279 | CALL iom_put( "qns" , qns ) ! solar heat flux moved after the call to iom_setkt) |
---|
280 | CALL iom_put( "qsr" , qsr ) ! solar heat flux moved after the call to iom_setkt) |
---|
281 | IF( nn_ice > 0 ) CALL iom_put( "ice_cover", fr_i ) ! ice fraction |
---|
282 | ENDIF |
---|
283 | ! |
---|
284 | CALL iom_setkt( kt ) ! iom_put outside of sbc is called at every time step |
---|
285 | ! |
---|
286 | CALL iom_put( "utau", utau ) ! i-wind stress (stress can be updated at |
---|
287 | CALL iom_put( "vtau", vtau ) ! j-wind stress each time step in sea-ice) |
---|
288 | CALL iom_put( "taum", taum ) ! wind stress module |
---|
289 | CALL iom_put( "wspd", wndm ) ! wind speed module |
---|
290 | ! |
---|
291 | IF(ln_ctl) THEN ! print mean trends (used for debugging) |
---|
292 | CALL prt_ctl(tab2d_1=fr_i , clinfo1=' fr_i - : ', mask1=tmask, ovlap=1 ) |
---|
293 | CALL prt_ctl(tab2d_1=emp , clinfo1=' emp - : ', mask1=tmask, ovlap=1 ) |
---|
294 | CALL prt_ctl(tab2d_1=emps , clinfo1=' emps - : ', mask1=tmask, ovlap=1 ) |
---|
295 | CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask, ovlap=1 ) |
---|
296 | CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask, ovlap=1 ) |
---|
297 | CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask : ', mask1=tmask, ovlap=1, kdim=jpk ) |
---|
298 | CALL prt_ctl(tab3d_1=tn , clinfo1=' sst - : ', mask1=tmask, ovlap=1, kdim=1 ) |
---|
299 | CALL prt_ctl(tab3d_1=sn , clinfo1=' sss - : ', mask1=tmask, ovlap=1, kdim=1 ) |
---|
300 | CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', mask1=umask, & |
---|
301 | & tab2d_2=vtau , clinfo2=' vtau - : ', mask2=vmask, ovlap=1 ) |
---|
302 | ENDIF |
---|
303 | ! |
---|
304 | END SUBROUTINE sbc |
---|
305 | |
---|
306 | !!====================================================================== |
---|
307 | END MODULE sbcmod |
---|