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

Context Navigation

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

Last change on this file since 918 was 918, checked in by rblod, 16 years ago
Change ice_ocean stress computation, step II, see ticket #128
File size: 14.9 KB

Line
1	MODULE 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	INTEGER :: nn_ico_cpl = 0 ! ice-ocean coupling indicator: !!gm ===>> to be put in namelist
58	! ! = 0 LIM-3 old case
59	! ! = 1 stresses computed using now ocean velocity
60	! ! = 2 combination of 0 and 1 cases
61
62	NAMELIST/namsbc/ nn_fsbc, ln_ana, ln_flx, ln_blk_clio, ln_blk_core, ln_cpl, &
63	& nn_ice , ln_dm2dc, ln_rnf, ln_ssr, nn_fwb, nn_ico_cpl
64
65	INTEGER :: nsbc ! type of surface boundary condition (deduced from namsbc informations)
66	INTEGER :: nice ! type of ice in the surface boundary condition (deduced from namsbc informations)
67
68	!! * Substitutions
69	# include "domzgr_substitute.h90"
70	!!----------------------------------------------------------------------
71	!! OPA 9.0 , LOCEAN-IPSL (2006)
72	!! $Id: $
73	!! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
74	!!----------------------------------------------------------------------
75
76	CONTAINS
77
78	SUBROUTINE sbc_init
79	!!---------------------------------------------------------------------
80	!! * ROUTINE sbc_init *
81	!!
82	!! ** Purpose : Initialisation of the ocean surface boundary computation
83	!!
84	!! ** Method : Read the namsbc namelist and set derived parameters
85	!!
86	!! ** Action : - read namsbc parameters
87	!! - nsbc: type of sbc
88	!!----------------------------------------------------------------------
89	INTEGER :: icpt ! temporary integer
90	!!----------------------------------------------------------------------
91
92	IF(lwp) THEN
93	WRITE(numout,*)
94	WRITE(numout,*) 'sbc_init : surface boundary condition setting'
95	WRITE(numout,*) '~~~~~~~~ '
96	ENDIF
97
98	REWIND ( numnam ) ! Read Namelist namsbc
99	READ ( numnam, namsbc )
100
101	! overwrite namelist parameter using CPP key information
102	!!gmhere no overwrite, test all option via namelist change: require more incore memory
103	!!gm IF( lk_sbc_cpl ) THEN ; ln_cpl = .TRUE. ; ELSE ; ln_cpl = .FALSE. ; ENDIF
104	IF( lk_lim2 ) nn_ice = 2
105	IF( lk_lim3 ) nn_ice = 3
106	IF( cp_cfg == 'gyre' ) THEN
107	ln_ana = .TRUE.
108	nn_ice = 0
109	ENDIF
110
111	! Control print
112	IF(lwp) THEN
113	WRITE(numout,*) ' Namelist namsbc (overwritten using CPP key defined)'
114	WRITE(numout,*) ' frequency update of sbc (and ice) nn_fsbc = ', nn_fsbc
115	WRITE(numout,*) ' Type of sbc : '
116	WRITE(numout,*) ' analytical formulation ln_ana = ', ln_ana
117	WRITE(numout,*) ' flux formulation ln_flx = ', ln_flx
118	WRITE(numout,*) ' CLIO bulk formulation ln_blk_clio = ', ln_blk_clio
119	WRITE(numout,*) ' CLIO bulk formulation ln_blk_core = ', ln_blk_core
120	WRITE(numout,*) ' coupled formulation (T if key_sbc_cpl) ln_cpl = ', ln_cpl
121	WRITE(numout,*) ' Misc. options of sbc : '
122	WRITE(numout,*) ' ice management in the sbc (=0/1/2) nn_ice = ', nn_ice
123	WRITE(numout,*) ' ice-ocean stress computation (=0/1/2) nn_ico_cpl = ', nn_ico_cpl
124	WRITE(numout,*) ' daily mean to diurnal cycle qsr ln_dm2dc = ', ln_dm2dc
125	WRITE(numout,*) ' runoff / runoff mouths ln_rnf = ', ln_rnf
126	WRITE(numout,*) ' Sea Surface Restoring on SST and/or SSS ln_ssr = ', ln_ssr
127	WRITE(numout,*) ' FreshWater Budget control (=0/1/2) nn_fwb = ', nn_fwb
128	WRITE(numout,*) ' closed sea (=0/1) (set in namdom) nclosea = ', nclosea
129	ENDIF
130
131	! Check consistancy !!gm mixture of real and integer : coding to be changed....
132
133	IF( .NOT. ln_rnf ) nn_runoff = 0 ! no runoff, or runoff mouths
134
135	IF( nn_ice == 2 ) THEN
136	IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 ) THEN
137	WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
138	CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' )
139	ENDIF
140	IF( MOD( nstock, nn_fsbc) /= 0 ) THEN
141	WRITE(ctmp1,*) 'nstock (' , nstock , ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
142	CALL ctl_stop( ctmp1, 'Impossible to do proper restart files' )
143	ENDIF
144	ENDIF
145
146	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' )
147
148	IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core ) ) &
149	& CALL ctl_stop( 'sbc_init: sea-ice model requires a bulk formulation' )
150
151	! Choice of the Surface Boudary Condition (set nsbc)
152	icpt = 0
153	IF( ln_ana ) THEN ; nsbc = 1 ; icpt = icpt + 1 ; ENDIF ! analytical formulation
154	IF( ln_flx ) THEN ; nsbc = 2 ; icpt = icpt + 1 ; ENDIF ! flux formulation
155	IF( ln_blk_clio ) THEN ; nsbc = 3 ; icpt = icpt + 1 ; ENDIF ! CLIO bulk formulation
156	IF( ln_blk_core ) THEN ; nsbc = 4 ; icpt = icpt + 1 ; ENDIF ! CORE bulk formulation
157	IF( ln_cpl ) THEN ; nsbc = 5 ; icpt = icpt + 1 ; ENDIF ! Coupled formulation
158	IF( cp_cfg == 'gyre') THEN ; nsbc = 0 ; ENDIF ! GYRE analytical formulation
159	IF( lk_esopa ) nsbc = -1 ! esopa test, ALL formulations
160
161	IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN
162	WRITE(numout,*)
163	WRITE(numout,*) ' E R R O R in setting the sbc, one and only one namelist/CPP key option '
164	WRITE(numout,*) ' must be choosen. You choose ', icpt, ' option(s)'
165	WRITE(numout,*) ' We stop'
166	nstop = nstop + 1
167	ENDIF
168	IF(lwp) THEN
169	WRITE(numout,*)
170	IF( nsbc == -1 ) WRITE(numout,*) ' ESOPA test All surface boundary conditions'
171	IF( nsbc == 0 ) WRITE(numout,*) ' GYRE analytical formulation'
172	IF( nsbc == 1 ) WRITE(numout,*) ' analytical formulation'
173	IF( nsbc == 2 ) WRITE(numout,*) ' flux formulation'
174	IF( nsbc == 3 ) WRITE(numout,*) ' CLIO bulk formulation'
175	IF( nsbc == 4 ) WRITE(numout,*) ' CORE bulk formulation'
176	IF( nsbc == 5 ) WRITE(numout,*) ' coupled formulation'
177	ENDIF
178	!
179	END SUBROUTINE sbc_init
180
181
182	SUBROUTINE sbc( kt )
183	!!---------------------------------------------------------------------
184	!! * ROUTINE sbc *
185	!!
186	!! ** Purpose : provide at each time-step the ocean surface boundary
187	!! condition (momentum, heat and freshwater fluxes)
188	!!
189	!! ** Method : blah blah to be written ?????????
190	!! CAUTION : never mask the surface stress field (tke sbc)
191	!!
192	!! ** Action : - set the ocean surface boundary condition, i.e.
193	!! utau, vtau, qns, qsr, emp, emps, qrp, erp
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	!!gm add a flag on nn_fsbc frequency ????? except the diurnal cycle!
207	!! IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
208
209
210	! sbc formulation
211	! ---------------
212
213	SELECT CASE( nsbc ) ! Compute ocean surface boundary condition
214	! ! (i.e. utau,vtau, qns, qsr, emp, emps)
215	CASE( 0 ) ; CALL sbc_gyre ( kt ) ! analytical formulation : GYRE configuration
216	CASE( 1 ) ; CALL sbc_ana ( kt ) ! analytical formulation : uniform sbc
217	CASE( 2 ) ; CALL sbc_flx ( kt ) ! flux formulation
218	CASE( 3 ) ; CALL sbc_blk_clio( kt ) ! bulk formulation : CLIO for the ocean
219	CASE( 4 ) ; CALL sbc_blk_core( kt ) ! bulk formulation : CORE for the ocean
220	CASE( 5 ) ; CALL sbc_cpl ( kt ) ! coupled formulation
221	CASE( -1 )
222	; CALL sbc_ana ( kt ) ! ESOPA, test ALL the formulations
223	; CALL sbc_gyre ( kt )
224	; CALL sbc_flx ( kt )
225	; CALL sbc_blk_clio( kt )
226	; CALL sbc_blk_core( kt )
227	; CALL sbc_cpl ( kt )
228	END SELECT
229
230	! Misc. Options
231	! -------------
232
233	!!gm IF( ln_dm2dc ) CALL sbc_dcy( kt ) ! Daily mean qsr distributed over the Diurnal Cycle
234
235	SELECT CASE( nn_ice ) ! Update sbc over ice-covered areas
236	CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model)
237	! ! (update heat and freshwater fluxes)
238	CASE( 2 ) ; CALL sbc_ice_lim_2( kt, nsbc ) ! LIM 2.0 ice model
239	! ! (update heat and freshwater fluxes)
240	CASE( 3 ) ; CALL sbc_ice_lim ( kt, nsbc, nn_ico_cpl) ! LIM 3.0 ice model
241	END SELECT ! (update all fluxes using bulk + LIM)
242
243	IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term
244
245	IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes
246
247	IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget
248
249	IF( nclosea == 1 ) CALL sbc_clo( kt ) ! treatment of closed sea in the model domain
250	! ! (update freshwater fluxes)
251	!
252	IF(ln_ctl) THEN ! print mean trends (used for debugging)
253	CALL prt_ctl(tab2d_1=emp , clinfo1=' emp - : ', mask1=tmask, ovlap=1)
254	CALL prt_ctl(tab2d_1=emps , clinfo1=' emps - : ', mask1=tmask, ovlap=1)
255	CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask, ovlap=1)
256	CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask, ovlap=1)
257	CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask : ', mask1=tmask, ovlap=1, kdim=jpk)
258	CALL prt_ctl(tab3d_1=tn , clinfo1=' sst - : ', mask1=tmask, ovlap=1, kdim=1)
259	CALL prt_ctl(tab3d_1=sn , clinfo1=' sss - : ', mask1=tmask, ovlap=1, kdim=1)
260	CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', mask1=umask, &
261	tab2d_2=vtau , clinfo2=' vtau - : ', mask2=vmask, ovlap=1)
262	ENDIF
263
264	!!gm
265	!! ENDIF
266	!!gm
267	!
268	END SUBROUTINE sbc
269
270	!!======================================================================
271	END MODULE sbcmod

Note: See TracBrowser for help on using the repository browser.

Download in other formats: