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 NEMO/branches/2019/dev_r12072_MERGE_OPTION2_2019/src/OCE/SBC – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r12072_MERGE_OPTION2_2019/src/OCE/SBC/sbcmod.F90 @ 12172

Last change on this file since 12172 was 12172, checked in by cetlod, 4 years ago
dev_merge_option2 : merge in ENHANCE-03_closea branch
Property svn:keywords set to `Id`
File size: 35.5 KB

Rev	Line
[888]	1	MODULE sbcmod
	2	!!======================================================================
	3	!! * MODULE sbcmod *
	4	!! Surface module : provide to the ocean its surface boundary condition
	5	!!======================================================================
[2528]	6	!! History : 3.0 ! 2006-07 (G. Madec) Original code
	7	!! 3.1 ! 2008-08 (S. Masson, A. Caubel, E. Maisonnave, G. Madec) coupled interface
	8	!! 3.3 ! 2010-04 (M. Leclair, G. Madec) Forcing averaged over 2 time steps
	9	!! 3.3 ! 2010-10 (S. Masson) add diurnal cycle
	10	!! 3.3 ! 2010-09 (D. Storkey) add ice boundary conditions (BDY)
	11	!! - ! 2010-11 (G. Madec) ice-ocean stress always computed at each ocean time-step
	12	!! - ! 2010-10 (J. Chanut, C. Bricaud, G. Madec) add the surface pressure forcing
[3294]	13	!! 3.4 ! 2011-11 (C. Harris) CICE added as an option
[3625]	14	!! 3.5 ! 2012-11 (A. Coward, G. Madec) Rethink of heat, mass and salt surface fluxes
[7646]	15	!! 3.6 ! 2014-11 (P. Mathiot, C. Harris) add ice shelves melting
	16	!! 4.0 ! 2016-06 (L. Brodeau) new general bulk formulation
[12154]	17	!! 4.0 ! 2019-03 (F. Lemarié & G. Samson) add ABL compatibility (ln_abl=TRUE)
[888]	18	!!----------------------------------------------------------------------
	19
	20	!!----------------------------------------------------------------------
[6140]	21	!! sbc_init : read namsbc namelist
	22	!! sbc : surface ocean momentum, heat and freshwater boundary conditions
[7646]	23	!! sbc_final : Finalize CICE ice model (if used)
[888]	24	!!----------------------------------------------------------------------
[6140]	25	USE oce ! ocean dynamics and tracers
	26	USE dom_oce ! ocean space and time domain
[12172]	27	USE closea ! closed seas
[6140]	28	USE phycst ! physical constants
	29	USE sbc_oce ! Surface boundary condition: ocean fields
	30	USE trc_oce ! shared ocean-passive tracers variables
	31	USE sbc_ice ! Surface boundary condition: ice fields
	32	USE sbcdcy ! surface boundary condition: diurnal cycle
	33	USE sbcssm ! surface boundary condition: sea-surface mean variables
	34	USE sbcflx ! surface boundary condition: flux formulation
[7646]	35	USE sbcblk ! surface boundary condition: bulk formulation
[12154]	36	USE sbcabl ! atmospheric boundary layer
[6140]	37	USE sbcice_if ! surface boundary condition: ice-if sea-ice model
[9570]	38	#if defined key_si3
[9656]	39	USE icestp ! surface boundary condition: SI3 sea-ice model
[9019]	40	#endif
[9656]	41	USE sbcice_cice ! surface boundary condition: CICE sea-ice model
[7646]	42	USE sbccpl ! surface boundary condition: coupled formulation
[6140]	43	USE cpl_oasis3 ! OASIS routines for coupling
[12172]	44	USE sbcclo ! surface boundary condition: closed sea correction
[6140]	45	USE sbcssr ! surface boundary condition: sea surface restoring
	46	USE sbcrnf ! surface boundary condition: runoffs
[8524]	47	USE sbcapr ! surface boundary condition: atmo pressure
[6140]	48	USE sbcfwb ! surface boundary condition: freshwater budget
	49	USE icbstp ! Icebergs
[9940]	50	USE icb_oce , ONLY : ln_passive_mode ! iceberg interaction mode
[6140]	51	USE traqsr ! active tracers: light penetration
	52	USE sbcwave ! Wave module
[7646]	53	USE bdy_oce , ONLY: ln_bdy
	54	USE usrdef_sbc ! user defined: surface boundary condition
[9161]	55	USE closea ! closed sea
[6140]	56	!
	57	USE prtctl ! Print control (prt_ctl routine)
	58	USE iom ! IOM library
	59	USE in_out_manager ! I/O manager
	60	USE lib_mpp ! MPP library
	61	USE timing ! Timing
[10499]	62	USE wet_dry
[7646]	63	USE diurnal_bulk, ONLY: ln_diurnal_only ! diurnal SST diagnostic
[888]	64
	65	IMPLICIT NONE
	66	PRIVATE
	67
	68	PUBLIC sbc ! routine called by step.F90
[1725]	69	PUBLIC sbc_init ! routine called by opa.F90
[7646]	70
[888]	71	INTEGER :: nsbc ! type of surface boundary condition (deduced from namsbc informations)
[7646]	72
[888]	73	!!----------------------------------------------------------------------
[10068]	74	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1146]	75	!! $Id$
[10068]	76	!! Software governed by the CeCILL license (see ./LICENSE)
[888]	77	!!----------------------------------------------------------------------
	78	CONTAINS
	79
	80	SUBROUTINE sbc_init
	81	!!---------------------------------------------------------------------
	82	!! * ROUTINE sbc_init *
	83	!!
	84	!! ** Purpose : Initialisation of the ocean surface boundary computation
	85	!!
	86	!! ** Method : Read the namsbc namelist and set derived parameters
[3607]	87	!! Call init routines for all other SBC modules that have one
[888]	88	!!
	89	!! ** Action : - read namsbc parameters
	90	!! - nsbc: type of sbc
	91	!!----------------------------------------------------------------------
[7646]	92	INTEGER :: ios, icpt ! local integer
	93	LOGICAL :: ll_purecpl, ll_opa, ll_not_nemo ! local logical
[1037]	94	!!
[7646]	95	NAMELIST/namsbc/ nn_fsbc , &
[12154]	96	& ln_usr , ln_flx , ln_blk , ln_abl, &
[9019]	97	& ln_cpl , ln_mixcpl, nn_components, &
	98	& nn_ice , ln_ice_embd, &
[7646]	99	& ln_traqsr, ln_dm2dc , &
[12169]	100	& ln_rnf , nn_fwb , ln_ssr , ln_apr_dyn , &
[12154]	101	& ln_wave , ln_cdgw , ln_sdw , ln_tauwoc , ln_stcor , &
[9023]	102	& ln_tauw , nn_lsm, nn_sdrift
[1037]	103	!!----------------------------------------------------------------------
[6140]	104	!
[888]	105	IF(lwp) THEN
	106	WRITE(numout,*)
	107	WRITE(numout,*) 'sbc_init : surface boundary condition setting'
	108	WRITE(numout,*) '~~~~~~~~ '
	109	ENDIF
[6140]	110	!
[7646]	111	! !** read Surface Module namelist
	112	REWIND( numnam_ref ) !* Namelist namsbc in reference namelist : Surface boundary
[4147]	113	READ ( numnam_ref, namsbc, IOSTAT = ios, ERR = 901)
[11536]	114	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc in reference namelist' )
[7646]	115	REWIND( numnam_cfg ) !* Namelist namsbc in configuration namelist : Parameters of the run
[4147]	116	READ ( numnam_cfg, namsbc, IOSTAT = ios, ERR = 902 )
[11536]	117	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namsbc in configuration namelist' )
[6140]	118	IF(lwm) WRITE( numond, namsbc )
	119	!
[10425]	120	#if defined key_mpp_mpi
	121	ncom_fsbc = nn_fsbc ! make nn_fsbc available for lib_mpp
	122	#endif
[7646]	123	! !* overwrite namelist parameter using CPP key information
	124	#if defined key_agrif
	125	IF( Agrif_Root() ) THEN ! AGRIF zoom (cf r1242: possibility to run without ice in fine grid)
[9654]	126	IF( lk_si3 ) nn_ice = 2
[9019]	127	IF( lk_cice ) nn_ice = 3
[1242]	128	ENDIF
[12154]	129	!!GS: TBD
	130	!#else
	131	! IF( lk_si3 ) nn_ice = 2
	132	! IF( lk_cice ) nn_ice = 3
[7646]	133	#endif
	134	!
	135	IF(lwp) THEN !* Control print
	136	WRITE(numout,*) ' Namelist namsbc (partly overwritten with CPP key setting)'
	137	WRITE(numout,*) ' frequency update of sbc (and ice) nn_fsbc = ', nn_fsbc
	138	WRITE(numout,*) ' Type of air-sea fluxes : '
	139	WRITE(numout,*) ' user defined formulation ln_usr = ', ln_usr
	140	WRITE(numout,*) ' flux formulation ln_flx = ', ln_flx
	141	WRITE(numout,*) ' bulk formulation ln_blk = ', ln_blk
[12154]	142	WRITE(numout,*) ' ABL formulation ln_abl = ', ln_abl
[7646]	143	WRITE(numout,*) ' Type of coupling (Ocean/Ice/Atmosphere) : '
	144	WRITE(numout,*) ' ocean-atmosphere coupled formulation ln_cpl = ', ln_cpl
	145	WRITE(numout,*) ' mixed forced-coupled formulation ln_mixcpl = ', ln_mixcpl
	146	!!gm lk_oasis is controlled by key_oasis3 ===>>> It shoud be removed from the namelist
	147	WRITE(numout,*) ' OASIS coupling (with atm or sas) lk_oasis = ', lk_oasis
	148	WRITE(numout,*) ' components of your executable nn_components = ', nn_components
	149	WRITE(numout,*) ' Sea-ice : '
	150	WRITE(numout,*) ' ice management in the sbc (=0/1/2/3) nn_ice = ', nn_ice
[9019]	151	WRITE(numout,*) ' ice embedded into ocean ln_ice_embd = ', ln_ice_embd
[7646]	152	WRITE(numout,*) ' Misc. options of sbc : '
	153	WRITE(numout,*) ' Light penetration in temperature Eq. ln_traqsr = ', ln_traqsr
	154	WRITE(numout,*) ' daily mean to diurnal cycle qsr ln_dm2dc = ', ln_dm2dc
	155	WRITE(numout,*) ' Sea Surface Restoring on SST and/or SSS ln_ssr = ', ln_ssr
	156	WRITE(numout,*) ' FreshWater Budget control (=0/1/2) nn_fwb = ', nn_fwb
	157	WRITE(numout,*) ' Patm gradient added in ocean & ice Eqs. ln_apr_dyn = ', ln_apr_dyn
	158	WRITE(numout,*) ' runoff / runoff mouths ln_rnf = ', ln_rnf
	159	WRITE(numout,*) ' nb of iterations if land-sea-mask applied nn_lsm = ', nn_lsm
	160	WRITE(numout,*) ' surface wave ln_wave = ', ln_wave
	161	WRITE(numout,*) ' Stokes drift corr. to vert. velocity ln_sdw = ', ln_sdw
[9023]	162	WRITE(numout,*) ' vertical parametrization nn_sdrift = ', nn_sdrift
[9169]	163	WRITE(numout,*) ' wave modified ocean stress ln_tauwoc = ', ln_tauwoc
[9023]	164	WRITE(numout,*) ' wave modified ocean stress component ln_tauw = ', ln_tauw
[7646]	165	WRITE(numout,*) ' Stokes coriolis term ln_stcor = ', ln_stcor
[10190]	166	WRITE(numout,*) ' neutral drag coefficient (CORE,NCAR) ln_cdgw = ', ln_cdgw
[888]	167	ENDIF
[6140]	168	!
[10190]	169	IF( .NOT.ln_wave ) THEN
	170	ln_sdw = .false. ; ln_cdgw = .false. ; ln_tauwoc = .false. ; ln_tauw = .false. ; ln_stcor = .false.
	171	ENDIF
[9023]	172	IF( ln_sdw ) THEN
[9115]	173	IF( .NOT.(nn_sdrift==jp_breivik_2014 .OR. nn_sdrift==jp_li_2017 .OR. nn_sdrift==jp_peakfr) ) &
[9023]	174	CALL ctl_stop( 'The chosen nn_sdrift for Stokes drift vertical velocity must be 0, 1, or 2' )
	175	ENDIF
[9115]	176	ll_st_bv2014 = ( nn_sdrift==jp_breivik_2014 )
	177	ll_st_li2017 = ( nn_sdrift==jp_li_2017 )
	178	ll_st_bv_li = ( ll_st_bv2014 .OR. ll_st_li2017 )
	179	ll_st_peakfr = ( nn_sdrift==jp_peakfr )
[9033]	180	IF( ln_tauwoc .AND. ln_tauw ) &
[9023]	181	CALL ctl_stop( 'More than one method for modifying the ocean stress has been selected ', &
[9033]	182	'(ln_tauwoc=.true. and ln_tauw=.true.)' )
	183	IF( ln_tauwoc ) &
	184	CALL ctl_warn( 'You are subtracting the wave stress to the ocean (ln_tauwoc=.true.)' )
[9023]	185	IF( ln_tauw ) &
	186	CALL ctl_warn( 'The wave modified ocean stress components are used (ln_tauw=.true.) ', &
	187	'This will override any other specification of the ocean stress' )
	188	!
[7646]	189	IF( .NOT.ln_usr ) THEN ! the model calendar needs some specificities (except in user defined case)
	190	IF( MOD( rday , rdt ) /= 0. ) CALL ctl_stop( 'the time step must devide the number of second of in a day' )
	191	IF( MOD( rday , 2. ) /= 0. ) CALL ctl_stop( 'the number of second of in a day must be an even number' )
	192	IF( MOD( rdt , 2. ) /= 0. ) CALL ctl_stop( 'the time step (in second) must be an even number' )
[888]	193	ENDIF
[7646]	194	! !** check option consistency
[4161]	195	!
[7646]	196	IF(lwp) WRITE(numout,) ! Single / Multi - executable (NEMO / OPA+SAS)
	197	SELECT CASE( nn_components )
	198	CASE( jp_iam_nemo )
[9190]	199	IF(lwp) WRITE(numout,*) ' ==>>> NEMO configured as a single executable (i.e. including both OPA and Surface module)'
[7646]	200	CASE( jp_iam_opa )
[9190]	201	IF(lwp) WRITE(numout,*) ' ==>>> Multi executable configuration. Here, OPA component'
[7646]	202	IF( .NOT.lk_oasis ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but key_oasis3 disabled' )
	203	IF( ln_cpl ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_cpl = T in OPA' )
	204	IF( ln_mixcpl ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_mixcpl = T in OPA' )
	205	CASE( jp_iam_sas )
[9190]	206	IF(lwp) WRITE(numout,*) ' ==>>> Multi executable configuration. Here, SAS component'
[7646]	207	IF( .NOT.lk_oasis ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but key_oasis3 disabled' )
	208	IF( ln_mixcpl ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_mixcpl = T in OPA' )
	209	CASE DEFAULT
	210	CALL ctl_stop( 'sbc_init : unsupported value for nn_components' )
	211	END SELECT
	212	! !* coupled options
	213	IF( ln_cpl ) THEN
	214	IF( .NOT. lk_oasis ) CALL ctl_stop( 'sbc_init : coupled mode with an atmosphere model (ln_cpl=T)', &
	215	& ' required to defined key_oasis3' )
	216	ENDIF
	217	IF( ln_mixcpl ) THEN
	218	IF( .NOT. lk_oasis ) CALL ctl_stop( 'sbc_init : mixed forced-coupled mode (ln_mixcpl=T) ', &
	219	& ' required to defined key_oasis3' )
	220	IF( .NOT.ln_cpl ) CALL ctl_stop( 'sbc_init : mixed forced-coupled mode (ln_mixcpl=T) requires ln_cpl = T' )
	221	IF( nn_components /= jp_iam_nemo ) &
	222	& CALL ctl_stop( 'sbc_init : the mixed forced-coupled mode (ln_mixcpl=T) ', &
	223	& ' not yet working with sas-opa coupling via oasis' )
	224	ENDIF
	225	! !* sea-ice
	226	SELECT CASE( nn_ice )
	227	CASE( 0 ) !- no ice in the domain
	228	CASE( 1 ) !- Ice-cover climatology ("Ice-if" model)
[9656]	229	CASE( 2 ) !- SI3 ice model
[12154]	230	IF( .NOT.( ln_blk .OR. ln_cpl .OR. ln_abl .OR. ln_usr ) ) &
	231	& CALL ctl_stop( 'sbc_init : SI3 sea-ice model requires ln_blk or ln_cpl or ln_abl or ln_usr = T' )
[9019]	232	CASE( 3 ) !- CICE ice model
[12154]	233	IF( .NOT.( ln_blk .OR. ln_cpl .OR. ln_abl .OR. ln_usr ) ) &
	234	& CALL ctl_stop( 'sbc_init : CICE sea-ice model requires ln_blk or ln_cpl or ln_abl or ln_usr = T' )
	235	IF( lk_agrif ) &
	236	& CALL ctl_stop( 'sbc_init : CICE sea-ice model not currently available with AGRIF' )
[7646]	237	CASE DEFAULT !- not supported
	238	END SELECT
	239	!
	240	! !** allocate and set required variables
	241	!
	242	! !* allocate sbc arrays
[5836]	243	IF( sbc_oce_alloc() /= 0 ) CALL ctl_stop( 'sbc_init : unable to allocate sbc_oce arrays' )
[9570]	244	#if ! defined key_si3 && ! defined key_cice
[9019]	245	IF( sbc_ice_alloc() /= 0 ) CALL ctl_stop( 'sbc_init : unable to allocate sbc_ice arrays' )
	246	#endif
[7646]	247	!
[12109]	248	IF( sbc_ssr_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_ssr arrays' )
	249	IF( .NOT.ln_ssr ) THEN !* Initialize qrp and erp if no restoring
	250	qrp(:,:) = 0._wp
	251	erp(:,:) = 0._wp
	252	ENDIF
	253	!
[7646]	254	IF( nn_ice == 0 ) THEN !* No sea-ice in the domain : ice fraction is always zero
[7753]	255	IF( nn_components /= jp_iam_opa ) fr_i(:,:) = 0._wp ! except for OPA in SAS-OPA coupled case
[7646]	256	ENDIF
	257	!
[7753]	258	sfx (:,:) = 0._wp !* salt flux due to freezing/melting
	259	fmmflx(:,:) = 0._wp !* freezing minus melting flux
[1037]	260
[7753]	261	taum(:,:) = 0._wp !* wind stress module (needed in GLS in case of reduced restart)
	262
[2528]	263	! ! Choice of the Surface Boudary Condition (set nsbc)
[12154]	264	nday_qsr = -1 ! allow initialization at the 1st call !LB: now warm-layer of COARE* calls "sbc_dcy_param" of sbcdcy.F90!
[7646]	265	IF( ln_dm2dc ) THEN !* daily mean to diurnal cycle
[12154]	266	!LB:nday_qsr = -1 ! allow initialization at the 1st call
	267	IF( .NOT.( ln_flx .OR. ln_blk .OR. ln_abl ) .AND. nn_components /= jp_iam_opa ) &
	268	& CALL ctl_stop( 'qsr diurnal cycle from daily values requires flux, bulk or abl formulation' )
[7646]	269	ENDIF
	270	! !* Choice of the Surface Boudary Condition
	271	! (set nsbc)
[5407]	272	!
[7646]	273	ll_purecpl = ln_cpl .AND. .NOT.ln_mixcpl
	274	ll_opa = nn_components == jp_iam_opa
	275	ll_not_nemo = nn_components /= jp_iam_nemo
[888]	276	icpt = 0
[7646]	277	!
	278	IF( ln_usr ) THEN ; nsbc = jp_usr ; icpt = icpt + 1 ; ENDIF ! user defined formulation
[5407]	279	IF( ln_flx ) THEN ; nsbc = jp_flx ; icpt = icpt + 1 ; ENDIF ! flux formulation
[7646]	280	IF( ln_blk ) THEN ; nsbc = jp_blk ; icpt = icpt + 1 ; ENDIF ! bulk formulation
[12154]	281	IF( ln_abl ) THEN ; nsbc = jp_abl ; icpt = icpt + 1 ; ENDIF ! ABL formulation
[5407]	282	IF( ll_purecpl ) THEN ; nsbc = jp_purecpl ; icpt = icpt + 1 ; ENDIF ! Pure Coupled formulation
[7646]	283	IF( ll_opa ) THEN ; nsbc = jp_none ; icpt = icpt + 1 ; ENDIF ! opa coupling via SAS module
[2528]	284	!
[7646]	285	IF( icpt /= 1 ) CALL ctl_stop( 'sbc_init : choose ONE and only ONE sbc option' )
[5836]	286	!
[7646]	287	IF(lwp) THEN !- print the choice of surface flux formulation
[888]	288	WRITE(numout,*)
[6140]	289	SELECT CASE( nsbc )
[9190]	290	CASE( jp_usr ) ; WRITE(numout,*) ' ==>>> user defined forcing formulation'
	291	CASE( jp_flx ) ; WRITE(numout,*) ' ==>>> flux formulation'
	292	CASE( jp_blk ) ; WRITE(numout,*) ' ==>>> bulk formulation'
[12154]	293	CASE( jp_abl ) ; WRITE(numout,*) ' ==>>> ABL formulation'
[9190]	294	CASE( jp_purecpl ) ; WRITE(numout,*) ' ==>>> pure coupled formulation'
[7646]	295	!!gm abusive use of jp_none ?? ===>>> need to be check and changed by adding a jp_sas parameter
[9190]	296	CASE( jp_none ) ; WRITE(numout,*) ' ==>>> OPA coupled to SAS via oasis'
	297	IF( ln_mixcpl ) WRITE(numout,*) ' + forced-coupled mixed formulation'
[6140]	298	END SELECT
[9190]	299	IF( ll_not_nemo ) WRITE(numout,*) ' + OASIS coupled SAS'
[888]	300	ENDIF
	301	!
[7646]	302	! !* OASIS initialization
	303	!
	304	IF( lk_oasis ) CALL sbc_cpl_init( nn_ice ) ! Must be done before: (1) first time step
	305	! ! (2) the use of nn_fsbc
[6140]	306	! nn_fsbc initialization if OPA-SAS coupling via OASIS
[7646]	307	! SAS time-step has to be declared in OASIS (mandatory) -> nn_fsbc has to be modified accordingly
[6140]	308	IF( nn_components /= jp_iam_nemo ) THEN
	309	IF( nn_components == jp_iam_opa ) nn_fsbc = cpl_freq('O_SFLX') / NINT(rdt)
	310	IF( nn_components == jp_iam_sas ) nn_fsbc = cpl_freq('I_SFLX') / NINT(rdt)
[5407]	311	!
	312	IF(lwp)THEN
	313	WRITE(numout,*)
	314	WRITE(numout,*)" OPA-SAS coupled via OASIS : nn_fsbc re-defined from OASIS namcouple ", nn_fsbc
	315	WRITE(numout,*)
	316	ENDIF
	317	ENDIF
[6140]	318	!
[7646]	319	! !* check consistency between model timeline and nn_fsbc
[11536]	320	IF( ln_rst_list .OR. nn_stock /= -1 ) THEN ! we will do restart files
	321	IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 ) THEN
	322	WRITE(ctmp1,*) 'sbc_init : experiment length (', nitend - nit000 + 1, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
	323	CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
	324	ENDIF
	325	IF( .NOT. ln_rst_list .AND. MOD( nn_stock, nn_fsbc) /= 0 ) THEN ! we don't use nn_stock if ln_rst_list
	326	WRITE(ctmp1,*) 'sbc_init : nn_stock (', nn_stock, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
	327	CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
	328	ENDIF
[5407]	329	ENDIF
	330	!
	331	IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 ) &
[7646]	332	& CALL ctl_warn( 'sbc_init : nn_fsbc is NOT a multiple of the number of time steps in a day' )
[5407]	333	!
[7646]	334	IF( ln_dm2dc .AND. NINT(rday) / ( nn_fsbc * NINT(rdt) ) < 8 ) &
	335	& CALL ctl_warn( 'sbc_init : diurnal cycle for qsr: the sampling of the diurnal cycle is too small...' )
[4152]	336	!
[7646]	337
	338	! !** associated modules : initialization
[3764]	339	!
[12172]	340	IF( l_sbc_clo ) CALL sbc_clo_init ! closed sea surface initialisation
	341	!
[7646]	342	CALL sbc_ssm_init ! Sea-surface mean fields initialization
[5385]	343	!
[7646]	344	IF( ln_blk ) CALL sbc_blk_init ! bulk formulae initialization
	345
[12154]	346	IF( ln_abl ) CALL sbc_abl_init ! Atmospheric Boundary Layer (ABL)
	347
[7646]	348	IF( ln_ssr ) CALL sbc_ssr_init ! Sea-Surface Restoring initialization
[6140]	349	!
[7646]	350	CALL sbc_rnf_init ! Runof initialization
[6140]	351	!
[8524]	352	IF( ln_apr_dyn ) CALL sbc_apr_init ! Atmo Pressure Forcing initialization
	353	!
[9570]	354	#if defined key_si3
[9019]	355	IF( lk_agrif .AND. nn_ice == 0 ) THEN ! allocate ice arrays in case agrif + ice-model + no-ice in child grid
	356	IF( sbc_ice_alloc() /= 0 ) CALL ctl_stop('STOP', 'sbc_ice_alloc : unable to allocate arrays' )
	357	ELSEIF( nn_ice == 2 ) THEN
	358	CALL ice_init ! ICE initialization
	359	ENDIF
	360	#endif
	361	IF( nn_ice == 3 ) CALL cice_sbc_init( nsbc ) ! CICE initialization
[6140]	362	!
[9019]	363	IF( ln_wave ) CALL sbc_wave_init ! surface wave initialisation
[7646]	364	!
[9367]	365	IF( lwxios ) THEN
	366	CALL iom_set_rstw_var_active('utau_b')
	367	CALL iom_set_rstw_var_active('vtau_b')
	368	CALL iom_set_rstw_var_active('qns_b')
	369	! The 3D heat content due to qsr forcing is treated in traqsr
	370	! CALL iom_set_rstw_var_active('qsr_b')
	371	CALL iom_set_rstw_var_active('emp_b')
	372	CALL iom_set_rstw_var_active('sfx_b')
	373	ENDIF
	374
[888]	375	END SUBROUTINE sbc_init
	376
	377
	378	SUBROUTINE sbc( kt )
	379	!!---------------------------------------------------------------------
	380	!! * ROUTINE sbc *
[7646]	381	!!
[888]	382	!! ** Purpose : provide at each time-step the ocean surface boundary
	383	!! condition (momentum, heat and freshwater fluxes)
	384	!!
[7646]	385	!! ** Method : blah blah to be written ?????????
[888]	386	!! CAUTION : never mask the surface stress field (tke sbc)
	387	!!
[7646]	388	!! ** Action : - set the ocean surface boundary condition at before and now
	389	!! time step, i.e.
[3625]	390	!! utau_b, vtau_b, qns_b, qsr_b, emp_n, sfx_b, qrp_b, erp_b
	391	!! utau , vtau , qns , qsr , emp , sfx , qrp , erp
[1037]	392	!! - updte the ice fraction : fr_i
[888]	393	!!----------------------------------------------------------------------
[7646]	394	INTEGER, INTENT(in) :: kt ! ocean time step
	395	!
	396	LOGICAL :: ll_sas, ll_opa ! local logical
[10499]	397	!
	398	REAL(wp) :: zthscl ! wd tanh scale
	399	REAL(wp), DIMENSION(jpi,jpj) :: zwdht, zwght ! wd dep over wd limit, wgt
	400
[888]	401	!!---------------------------------------------------------------------
[3294]	402	!
[9124]	403	IF( ln_timing ) CALL timing_start('sbc')
[3294]	404	!
[2528]	405	! ! ---------------------------------------- !
	406	IF( kt /= nit000 ) THEN ! Swap of forcing fields !
	407	! ! ---------------------------------------- !
[7753]	408	utau_b(:,:) = utau(:,:) ! Swap the ocean forcing fields
	409	vtau_b(:,:) = vtau(:,:) ! (except at nit000 where before fields
	410	qns_b (:,:) = qns (:,:) ! are set at the end of the routine)
	411	emp_b (:,:) = emp (:,:)
	412	sfx_b (:,:) = sfx (:,:)
[12154]	413	IF( ln_rnf ) THEN
[7753]	414	rnf_b (:,: ) = rnf (:,: )
	415	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
[6460]	416	ENDIF
[7788]	417	!
[2528]	418	ENDIF
	419	! ! ---------------------------------------- !
	420	! ! forcing field computation !
	421	! ! ---------------------------------------- !
[1482]	422	!
[7646]	423	ll_sas = nn_components == jp_iam_sas ! component flags
	424	ll_opa = nn_components == jp_iam_opa
	425	!
	426	IF( .NOT.ll_sas ) CALL sbc_ssm ( kt ) ! mean ocean sea surface variables (sst_m, sss_m, ssu_m, ssv_m)
	427	IF( ln_wave ) CALL sbc_wave( kt ) ! surface waves
	428
	429	!
	430	! !== sbc formulation ==!
	431	!
[2528]	432	SELECT CASE( nsbc ) ! Compute ocean surface boundary condition
[3625]	433	! ! (i.e. utau,vtau, qns, qsr, emp, sfx)
[7646]	434	CASE( jp_usr ) ; CALL usrdef_sbc_oce( kt ) ! user defined formulation
	435	CASE( jp_flx ) ; CALL sbc_flx ( kt ) ! flux formulation
	436	CASE( jp_blk )
	437	IF( ll_sas ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: SAS receiving fields from OPA
	438	CALL sbc_blk ( kt ) ! bulk formulation for the ocean
	439	!
[12154]	440	CASE( jp_abl )
	441	IF( ll_sas ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: SAS receiving fields from OPA
	442	CALL sbc_abl ( kt ) ! ABL formulation for the ocean
	443	!
[7646]	444	CASE( jp_purecpl ) ; CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! pure coupled formulation
	445	CASE( jp_none )
	446	IF( ll_opa ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: OPA receiving fields from SAS
[888]	447	END SELECT
[7646]	448	!
	449	IF( ln_mixcpl ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! forced-coupled mixed formulation after forcing
[6140]	450	!
[12154]	451	IF( ln_wave .AND. (ln_tauwoc .OR. ln_tauw) ) CALL sbc_wstress( ) ! Wind stress provided by waves
[9023]	452	!
[2528]	453	! !== Misc. Options ==!
[6140]	454	!
[3632]	455	SELECT CASE( nn_ice ) ! Update heat and freshwater fluxes over sea-ice areas
[9019]	456	CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model)
[9570]	457	#if defined key_si3
[9656]	458	CASE( 2 ) ; CALL ice_stp ( kt, nsbc ) ! SI3 ice model
[9019]	459	#endif
	460	CASE( 3 ) ; CALL sbc_ice_cice ( kt, nsbc ) ! CICE ice model
[7646]	461	END SELECT
[888]	462
[9940]	463	IF( ln_icebergs ) THEN
	464	CALL icb_stp( kt ) ! compute icebergs
	465	! icebergs may advect into haloes during the icb step and alter emp.
	466	! A lbc_lnk is necessary here to ensure restartability (#2113)
[10425]	467	IF( .NOT. ln_passive_mode ) CALL lbc_lnk( 'sbcmod', emp, 'T', 1. ) ! ensure restartability with icebergs
[9940]	468	ENDIF
[3609]	469
[3632]	470	IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes
[7646]	471
[3632]	472	IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term
[888]	473
[3632]	474	IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget
[888]	475
[9161]	476	! Special treatment of freshwater fluxes over closed seas in the model domain
	477	! Should not be run if ln_diurnal_only
[12172]	478	IF( l_sbc_clo ) CALL sbc_clo( kt )
[6140]	479
[9439]	480	!!$!RBbug do not understand why see ticket 667
	481	!!$!clem: it looks like it is necessary for the north fold (in certain circumstances). Don't know why.
[10425]	482	!!$ CALL lbc_lnk( 'sbcmod', emp, 'T', 1. )
[12154]	483	IF( ll_wd ) THEN ! If near WAD point limit the flux for now
[10499]	484	zthscl = atanh(rn_wd_sbcfra) ! taper frac default is .999
	485	zwdht(:,:) = sshn(:,:) + ht_0(:,:) - rn_wdmin1 ! do this calc of water
	486	! depth above wd limit once
	487	WHERE( zwdht(:,:) <= 0.0 )
	488	taum(:,:) = 0.0
	489	utau(:,:) = 0.0
	490	vtau(:,:) = 0.0
	491	qns (:,:) = 0.0
	492	qsr (:,:) = 0.0
	493	emp (:,:) = min(emp(:,:),0.0) !can allow puddles to grow but not shrink
	494	sfx (:,:) = 0.0
	495	END WHERE
	496	zwght(:,:) = tanh(zthscl*zwdht(:,:))
	497	WHERE( zwdht(:,:) > 0.0 .and. zwdht(:,:) < rn_wd_sbcdep ) ! 5 m hard limit here is arbitrary
	498	qsr (:,:) = qsr(:,:) * zwght(:,:)
	499	qns (:,:) = qns(:,:) * zwght(:,:)
	500	taum (:,:) = taum(:,:) * zwght(:,:)
	501	utau (:,:) = utau(:,:) * zwght(:,:)
	502	vtau (:,:) = vtau(:,:) * zwght(:,:)
	503	sfx (:,:) = sfx(:,:) * zwght(:,:)
	504	emp (:,:) = emp(:,:) * zwght(:,:)
	505	END WHERE
	506	ENDIF
[2502]	507	!
[2528]	508	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
	509	! ! ---------------------------------------- !
	510	IF( ln_rstart .AND. & !* Restart: read in restart file
[7646]	511	& iom_varid( numror, 'utau_b', ldstop = .FALSE. ) > 0 ) THEN
[2528]	512	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields red in the restart file'
[9367]	513	CALL iom_get( numror, jpdom_autoglo, 'utau_b', utau_b, ldxios = lrxios ) ! before i-stress (U-point)
	514	CALL iom_get( numror, jpdom_autoglo, 'vtau_b', vtau_b, ldxios = lrxios ) ! before j-stress (V-point)
[12154]	515	CALL iom_get( numror, jpdom_autoglo, 'qns_b', qns_b, ldxios = lrxios ) ! before non solar heat flux (T-point)
[2528]	516	! The 3D heat content due to qsr forcing is treated in traqsr
[9367]	517	! CALL iom_get( numror, jpdom_autoglo, 'qsr_b' , qsr_b, ldxios = lrxios ) ! before solar heat flux (T-point)
	518	CALL iom_get( numror, jpdom_autoglo, 'emp_b', emp_b, ldxios = lrxios ) ! before freshwater flux (T-point)
[3625]	519	! To ensure restart capability with 3.3x/3.4 restart files !! to be removed in v3.6
	520	IF( iom_varid( numror, 'sfx_b', ldstop = .FALSE. ) > 0 ) THEN
[9367]	521	CALL iom_get( numror, jpdom_autoglo, 'sfx_b', sfx_b, ldxios = lrxios ) ! before salt flux (T-point)
[3625]	522	ELSE
[7753]	523	sfx_b (:,:) = sfx(:,:)
[3625]	524	ENDIF
[2528]	525	ELSE !* no restart: set from nit000 values
	526	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields set to nit000'
[7753]	527	utau_b(:,:) = utau(:,:)
	528	vtau_b(:,:) = vtau(:,:)
	529	qns_b (:,:) = qns (:,:)
	530	emp_b (:,:) = emp (:,:)
	531	sfx_b (:,:) = sfx (:,:)
[2528]	532	ENDIF
	533	ENDIF
	534	! ! ---------------------------------------- !
	535	IF( lrst_oce ) THEN ! Write in the ocean restart file !
	536	! ! ---------------------------------------- !
	537	IF(lwp) WRITE(numout,*)
	538	IF(lwp) WRITE(numout,*) 'sbc : ocean surface forcing fields written in ocean restart file ', &
	539	& 'at it= ', kt,' date= ', ndastp
	540	IF(lwp) WRITE(numout,*) '~~~~'
[9367]	541	IF( lwxios ) CALL iom_swap( cwxios_context )
	542	CALL iom_rstput( kt, nitrst, numrow, 'utau_b' , utau, ldxios = lwxios )
	543	CALL iom_rstput( kt, nitrst, numrow, 'vtau_b' , vtau, ldxios = lwxios )
	544	CALL iom_rstput( kt, nitrst, numrow, 'qns_b' , qns, ldxios = lwxios )
[2528]	545	! The 3D heat content due to qsr forcing is treated in traqsr
	546	! CALL iom_rstput( kt, nitrst, numrow, 'qsr_b' , qsr )
[9367]	547	CALL iom_rstput( kt, nitrst, numrow, 'emp_b' , emp, ldxios = lwxios )
	548	CALL iom_rstput( kt, nitrst, numrow, 'sfx_b' , sfx, ldxios = lwxios )
	549	IF( lwxios ) CALL iom_swap( cxios_context )
[2528]	550	ENDIF
	551	! ! ---------------------------------------- !
	552	! ! Outputs and control print !
	553	! ! ---------------------------------------- !
[1482]	554	IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN
[6351]	555	CALL iom_put( "empmr" , emp - rnf ) ! upward water flux
	556	CALL iom_put( "empbmr" , emp_b - rnf ) ! before upward water flux ( needed to recalculate the time evolution of ssh in offline )
[7646]	557	CALL iom_put( "saltflx", sfx ) ! downward salt flux (includes virtual salt flux beneath ice in linear free surface case)
[4148]	558	CALL iom_put( "fmmflx", fmmflx ) ! Freezing-melting water flux
[7646]	559	CALL iom_put( "qt" , qns + qsr ) ! total heat flux
[2561]	560	CALL iom_put( "qns" , qns ) ! solar heat flux
	561	CALL iom_put( "qsr" , qsr ) ! solar heat flux
[7646]	562	IF( nn_ice > 0 .OR. ll_opa ) CALL iom_put( "ice_cover", fr_i ) ! ice fraction
	563	CALL iom_put( "taum" , taum ) ! wind stress module
[4990]	564	CALL iom_put( "wspd" , wndm ) ! wind speed module over free ocean or leads in presence of sea-ice
[12109]	565	CALL iom_put( "qrp", qrp ) ! heat flux damping
	566	CALL iom_put( "erp", erp ) ! freshwater flux damping
[1482]	567	ENDIF
	568	!
[7646]	569	CALL iom_put( "utau", utau ) ! i-wind stress (stress can be updated at each time step in sea-ice)
	570	CALL iom_put( "vtau", vtau ) ! j-wind stress
[1482]	571	!
[888]	572	IF(ln_ctl) THEN ! print mean trends (used for debugging)
[12166]	573	CALL prt_ctl(tab2d_1=fr_i , clinfo1=' fr_i - : ', mask1=tmask )
	574	CALL prt_ctl(tab2d_1=(emp-rnf) , clinfo1=' emp-rnf - : ', mask1=tmask )
	575	CALL prt_ctl(tab2d_1=(sfx-rnf) , clinfo1=' sfx-rnf - : ', mask1=tmask )
[9439]	576	CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask )
	577	CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask )
	578	CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask - : ', mask1=tmask, kdim=jpk )
	579	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_tem), clinfo1=' sst - : ', mask1=tmask, kdim=1 )
	580	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_sal), clinfo1=' sss - : ', mask1=tmask, kdim=1 )
[3294]	581	CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', mask1=umask, &
[9439]	582	& tab2d_2=vtau , clinfo2=' vtau - : ', mask2=vmask )
[888]	583	ENDIF
[3294]	584
	585	IF( kt == nitend ) CALL sbc_final ! Close down surface module if necessary
[888]	586	!
[9124]	587	IF( ln_timing ) CALL timing_stop('sbc')
[3294]	588	!
[888]	589	END SUBROUTINE sbc
	590
[3764]	591
[3294]	592	SUBROUTINE sbc_final
	593	!!---------------------------------------------------------------------
	594	!! * ROUTINE sbc_final *
[3764]	595	!!
	596	!! ** Purpose : Finalize CICE (if used)
[3294]	597	!!---------------------------------------------------------------------
[3764]	598	!
[9019]	599	IF( nn_ice == 3 ) CALL cice_sbc_final
[3294]	600	!
	601	END SUBROUTINE sbc_final
	602
[888]	603	!!======================================================================
	604	END MODULE sbcmod

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

Download in other formats: