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

Last change on this file since 702 was 702, checked in by smasson, 17 years ago
add first set of new surface module, see ticket:3
Property svn:executable set to ``*
File size: 13.8 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 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	!!gm defined in sbc_oce INTEGER , PUBLIC :: nn_fsbc !: frequency of surface boundary condition computation
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_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	!! $Header: $
68	!! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
69	!!----------------------------------------------------------------------
70
71	CONTAINS
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_ice_lim ) nn_ice = 2
100	IF( cp_cfg == 'gyre' ) THEN
101	ln_ana = .TRUE.
102	nn_ice = 0
103	ENDIF
104
105	! Control print
106	IF(lwp) THEN
107	WRITE(numout,*) ' Namelist namsbc (overwritten using CPP key defined)'
108	WRITE(numout,*) ' frequency update of sbc (and ice) nn_fsbc = ', nn_fsbc
109	WRITE(numout,*) ' Type of sbc : '
110	WRITE(numout,*) ' analytical formulation ln_ana = ', ln_ana
111	WRITE(numout,*) ' flux formulation ln_flx = ', ln_flx
112	WRITE(numout,*) ' CLIO bulk formulation ln_blk_clio = ', ln_blk_clio
113	WRITE(numout,*) ' CLIO bulk formulation ln_blk_core = ', ln_blk_core
114	WRITE(numout,*) ' coupled formulation (T if key_sbc_cpl) ln_cpl = ', ln_cpl
115	WRITE(numout,*) ' Misc. options of sbc : '
116	WRITE(numout,*) ' ice management in the sbc (=0/1/2) nn_ice = ', nn_ice
117	WRITE(numout,*) ' daily mean to diurnal cycle qsr ln_dm2dc = ', ln_dm2dc
118	WRITE(numout,*) ' runoff / runoff mouths ln_rnf = ', ln_rnf
119	WRITE(numout,*) ' Sea Surface Restoring on SST and/or SSS ln_ssr = ', ln_ssr
120	WRITE(numout,*) ' FreshWater Budget control (=0/1/2) nn_fwb = ', nn_fwb
121	WRITE(numout,*) ' closed sea (=0/1) (set in namdom) nclosea = ', nclosea
122	ENDIF
123
124	! Check consistancy !!gm mixture of real and integer : coding to be changed....
125
126	IF( .NOT. ln_rnf ) nn_runoff = 0 ! no runoff, or runoff mouths
127
128	IF( MOD( rday, nn_fsbc*rdt ) /= 0 ) THEN
129	IF(lwp) WRITE(numout,*)
130	IF(lwp) WRITE(numout,*) 'W A R N I N G : nn_fsbc is NOT a multiple of the number of time steps in a day'
131	IF(lwp) WRITE(numout,*) ' '
132	nwarn = nwarn + 1
133	ENDIF
134
135	IF( nn_ice == 2 .AND. .NOT.( ln_blk_clio .OR. ln_blk_core ) ) &
136	& CALL ctl_stop( 'sbc_init: sea-ice model requires a bulk formulation' )
137
138	! Choice of the Surface Boudary Condition (set nsbc)
139	icpt = 0
140	IF( ln_ana ) THEN ; nsbc = 1 ; icpt = icpt + 1 ; ENDIF ! analytical formulation
141	IF( ln_flx ) THEN ; nsbc = 2 ; icpt = icpt + 1 ; ENDIF ! flux formulation
142	IF( ln_blk_clio ) THEN ; nsbc = 3 ; icpt = icpt + 1 ; ENDIF ! CLIO bulk formulation
143	IF( ln_blk_core ) THEN ; nsbc = 4 ; icpt = icpt + 1 ; ENDIF ! CORE bulk formulation
144	IF( ln_cpl ) THEN ; nsbc = 5 ; icpt = icpt + 1 ; ENDIF ! Coupled formulation
145	IF( cp_cfg == 'gyre') THEN ; nsbc = 0 ; ENDIF ! GYRE analytical formulation
146	IF( lk_esopa ) nsbc = -1 ! esopa test, ALL formulations
147
148	IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN
149	WRITE(numout,*)
150	WRITE(numout,*) ' E R R O R in setting the sbc, one and only one namelist/CPP key option '
151	WRITE(numout,*) ' must be choosen. You choose ', icpt, ' option(s)'
152	WRITE(numout,*) ' We stop'
153	nstop = nstop + 1
154	ENDIF
155	IF(lwp) THEN
156	WRITE(numout,*)
157	IF( nsbc == -1 ) WRITE(numout,*) ' ESOPA test All surface boundary conditions'
158	IF( nsbc == 0 ) WRITE(numout,*) ' GYRE analytical formulation'
159	IF( nsbc == 1 ) WRITE(numout,*) ' analytical formulation'
160	IF( nsbc == 2 ) WRITE(numout,*) ' flux formulation'
161	IF( nsbc == 3 ) WRITE(numout,*) ' CLIO bulk formulation'
162	IF( nsbc == 4 ) WRITE(numout,*) ' CORE bulk formulation'
163	IF( nsbc == 5 ) WRITE(numout,*) ' coupled formulation'
164	ENDIF
165	!
166	END SUBROUTINE sbc_init
167
168
169	SUBROUTINE sbc( kt )
170	!!---------------------------------------------------------------------
171	!! * ROUTINE sbc *
172	!!
173	!! ** Purpose : provide at each time-step the ocean surface boundary
174	!! condition (momentum, heat and freshwater fluxes)
175	!!
176	!! ** Method : blah blah to be written ?????????
177	!! CAUTION : never mask the surface stress field (tke sbc)
178	!!
179	!! ** Action : - set the ocean surface boundary condition, i.e.
180	!! utau, vtau, qns, qsr, emp, emps, qrp, erp
181	!!----------------------------------------------------------------------
182	INTEGER, INTENT(in) :: kt ! ocean time step
183	!!---------------------------------------------------------------------
184
185	IF( kt == nit000 ) CALL sbc_init ! Read namsbc namelist : surface module
186
187	! ocean to sbc mean sea surface variables (ss._m)
188	! ---------------------------------------
189	CALL sbc_ssm( kt ) ! sea surface mean currents (at U- and V-points),
190	! ! temperature and salinity (at T-point) over nf_sbc time-step
191	! ! (i.e. sst_m, sss_m, ssu_m, ssv_m)
192
193	!!gm add a flag on nn_fsbc frequency ????? except the diurnal cycle!
194	!! IF( MOD( kt - 1, nn_fsbc ) == 0 ) THEN
195
196
197	! sbc formulation
198	! ---------------
199
200	SELECT CASE( nsbc ) ! Compute ocean surface boundary condition
201	! ! (i.e. utau,vtau, qns, qsr, emp, emps)
202	CASE( 0 ) ; CALL sbc_gyre ( kt ) ! analytical formulation : GYRE configuration
203	CASE( 1 ) ; CALL sbc_ana ( kt ) ! analytical formulation : uniform sbc
204	CASE( 2 ) ; CALL sbc_flx ( kt ) ! flux formulation
205	CASE( 3 ) ; CALL sbc_blk_clio( kt ) ! bulk formulation : CLIO for the ocean
206	CASE( 4 ) ; CALL sbc_blk_core( kt ) ! bulk formulation : CORE for the ocean
207	CASE( 5 ) ; CALL sbc_cpl ( kt ) ! coupled formulation
208	CASE( -1 )
209	; CALL sbc_ana ( kt ) ! ESOPA, test ALL the formulations
210	; CALL sbc_gyre ( kt )
211	; CALL sbc_flx ( kt )
212	; CALL sbc_blk_clio( kt )
213	; CALL sbc_blk_core( kt )
214	; CALL sbc_cpl ( kt )
215	END SELECT
216
217	! Misc. Options
218	! -------------
219
220	!!gm IF( ln_dm2dc ) CALL sbc_dcy( kt ) ! Daily mean qsr distributed over the Diurnal Cycle
221
222	SELECT CASE( nn_ice ) ! Update sbc over ice-covered areas
223	CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model)
224	! ! (update heat and freshwater fluxes)
225	CASE( 2 ) ; CALL sbc_ice_lim( kt, nsbc ) ! LIM ice model
226	END SELECT ! (update all fluxes using bulk + LIM)
227
228	IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term
229
230	IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes
231
232	IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget
233
234	IF( nclosea == 1 ) CALL sbc_clo( kt ) ! treatment of closed sea in the model domain
235	! ! (update freshwater fluxes)
236	!
237	IF(ln_ctl) THEN ! print mean trends (used for debugging)
238	CALL prt_ctl(tab2d_1=emp , clinfo1=' emp - : ', mask1=tmask, ovlap=1)
239	CALL prt_ctl(tab2d_1=emps , clinfo1=' emps - : ', mask1=tmask, ovlap=1)
240	CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask, ovlap=1)
241	CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask, ovlap=1)
242	CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask : ', mask1=tmask, ovlap=1, kdim=jpk)
243	CALL prt_ctl(tab3d_1=tn , clinfo1=' sst - : ', mask1=tmask, ovlap=1, kdim=1)
244	CALL prt_ctl(tab3d_1=sn , clinfo1=' sss - : ', mask1=tmask, ovlap=1, kdim=1)
245	CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', tab2d_2=vtau, clinfo2=' vtau - : ', ovlap=1)
246	ENDIF
247
248	!!gm
249	!! ENDIF
250	!!gm
251	!
252	END SUBROUTINE sbc
253
254	!!======================================================================
255	END MODULE sbcmod

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

Download in other formats: