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

Last change on this file since 12154 was 12154, checked in by cetlod, 4 years ago
commit
Property svn:keywords set to `Id`
File size: 36.2 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
	27	USE phycst ! physical constants
	28	USE sbc_oce ! Surface boundary condition: ocean fields
	29	USE trc_oce ! shared ocean-passive tracers variables
	30	USE sbc_ice ! Surface boundary condition: ice fields
	31	USE sbcdcy ! surface boundary condition: diurnal cycle
	32	USE sbcssm ! surface boundary condition: sea-surface mean variables
	33	USE sbcflx ! surface boundary condition: flux formulation
[7646]	34	USE sbcblk ! surface boundary condition: bulk formulation
[12154]	35	USE sbcabl ! atmospheric boundary layer
[6140]	36	USE sbcice_if ! surface boundary condition: ice-if sea-ice model
[9570]	37	#if defined key_si3
[9656]	38	USE icestp ! surface boundary condition: SI3 sea-ice model
[9019]	39	#endif
[9656]	40	USE sbcice_cice ! surface boundary condition: CICE sea-ice model
[7816]	41	USE sbcisf ! surface boundary condition: ice-shelf
[7646]	42	USE sbccpl ! surface boundary condition: coupled formulation
[6140]	43	USE cpl_oasis3 ! OASIS routines for coupling
	44	USE sbcssr ! surface boundary condition: sea surface restoring
	45	USE sbcrnf ! surface boundary condition: runoffs
[8524]	46	USE sbcapr ! surface boundary condition: atmo pressure
[6140]	47	USE sbcisf ! surface boundary condition: ice shelf
	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 , &
	100	& ln_rnf , nn_fwb , ln_ssr , ln_isf , 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,*) ' iceshelf formulation ln_isf = ', ln_isf
	160	WRITE(numout,*) ' nb of iterations if land-sea-mask applied nn_lsm = ', nn_lsm
	161	WRITE(numout,*) ' surface wave ln_wave = ', ln_wave
	162	WRITE(numout,*) ' Stokes drift corr. to vert. velocity ln_sdw = ', ln_sdw
[9023]	163	WRITE(numout,*) ' vertical parametrization nn_sdrift = ', nn_sdrift
[9169]	164	WRITE(numout,*) ' wave modified ocean stress ln_tauwoc = ', ln_tauwoc
[9023]	165	WRITE(numout,*) ' wave modified ocean stress component ln_tauw = ', ln_tauw
[7646]	166	WRITE(numout,*) ' Stokes coriolis term ln_stcor = ', ln_stcor
[10190]	167	WRITE(numout,*) ' neutral drag coefficient (CORE,NCAR) ln_cdgw = ', ln_cdgw
[888]	168	ENDIF
[6140]	169	!
[10190]	170	IF( .NOT.ln_wave ) THEN
	171	ln_sdw = .false. ; ln_cdgw = .false. ; ln_tauwoc = .false. ; ln_tauw = .false. ; ln_stcor = .false.
	172	ENDIF
[9023]	173	IF( ln_sdw ) THEN
[9115]	174	IF( .NOT.(nn_sdrift==jp_breivik_2014 .OR. nn_sdrift==jp_li_2017 .OR. nn_sdrift==jp_peakfr) ) &
[9023]	175	CALL ctl_stop( 'The chosen nn_sdrift for Stokes drift vertical velocity must be 0, 1, or 2' )
	176	ENDIF
[9115]	177	ll_st_bv2014 = ( nn_sdrift==jp_breivik_2014 )
	178	ll_st_li2017 = ( nn_sdrift==jp_li_2017 )
	179	ll_st_bv_li = ( ll_st_bv2014 .OR. ll_st_li2017 )
	180	ll_st_peakfr = ( nn_sdrift==jp_peakfr )
[9033]	181	IF( ln_tauwoc .AND. ln_tauw ) &
[9023]	182	CALL ctl_stop( 'More than one method for modifying the ocean stress has been selected ', &
[9033]	183	'(ln_tauwoc=.true. and ln_tauw=.true.)' )
	184	IF( ln_tauwoc ) &
	185	CALL ctl_warn( 'You are subtracting the wave stress to the ocean (ln_tauwoc=.true.)' )
[9023]	186	IF( ln_tauw ) &
	187	CALL ctl_warn( 'The wave modified ocean stress components are used (ln_tauw=.true.) ', &
	188	'This will override any other specification of the ocean stress' )
	189	!
[7646]	190	IF( .NOT.ln_usr ) THEN ! the model calendar needs some specificities (except in user defined case)
	191	IF( MOD( rday , rdt ) /= 0. ) CALL ctl_stop( 'the time step must devide the number of second of in a day' )
	192	IF( MOD( rday , 2. ) /= 0. ) CALL ctl_stop( 'the number of second of in a day must be an even number' )
	193	IF( MOD( rdt , 2. ) /= 0. ) CALL ctl_stop( 'the time step (in second) must be an even number' )
[888]	194	ENDIF
[7646]	195	! !** check option consistency
[4161]	196	!
[7646]	197	IF(lwp) WRITE(numout,) ! Single / Multi - executable (NEMO / OPA+SAS)
	198	SELECT CASE( nn_components )
	199	CASE( jp_iam_nemo )
[9190]	200	IF(lwp) WRITE(numout,*) ' ==>>> NEMO configured as a single executable (i.e. including both OPA and Surface module)'
[7646]	201	CASE( jp_iam_opa )
[9190]	202	IF(lwp) WRITE(numout,*) ' ==>>> Multi executable configuration. Here, OPA component'
[7646]	203	IF( .NOT.lk_oasis ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but key_oasis3 disabled' )
	204	IF( ln_cpl ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_cpl = T in OPA' )
	205	IF( ln_mixcpl ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_mixcpl = T in OPA' )
	206	CASE( jp_iam_sas )
[9190]	207	IF(lwp) WRITE(numout,*) ' ==>>> Multi executable configuration. Here, SAS component'
[7646]	208	IF( .NOT.lk_oasis ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but key_oasis3 disabled' )
	209	IF( ln_mixcpl ) CALL ctl_stop( 'sbc_init : OPA-SAS coupled via OASIS, but ln_mixcpl = T in OPA' )
	210	CASE DEFAULT
	211	CALL ctl_stop( 'sbc_init : unsupported value for nn_components' )
	212	END SELECT
	213	! !* coupled options
	214	IF( ln_cpl ) THEN
	215	IF( .NOT. lk_oasis ) CALL ctl_stop( 'sbc_init : coupled mode with an atmosphere model (ln_cpl=T)', &
	216	& ' required to defined key_oasis3' )
	217	ENDIF
	218	IF( ln_mixcpl ) THEN
	219	IF( .NOT. lk_oasis ) CALL ctl_stop( 'sbc_init : mixed forced-coupled mode (ln_mixcpl=T) ', &
	220	& ' required to defined key_oasis3' )
	221	IF( .NOT.ln_cpl ) CALL ctl_stop( 'sbc_init : mixed forced-coupled mode (ln_mixcpl=T) requires ln_cpl = T' )
	222	IF( nn_components /= jp_iam_nemo ) &
	223	& CALL ctl_stop( 'sbc_init : the mixed forced-coupled mode (ln_mixcpl=T) ', &
	224	& ' not yet working with sas-opa coupling via oasis' )
	225	ENDIF
	226	! !* sea-ice
	227	SELECT CASE( nn_ice )
	228	CASE( 0 ) !- no ice in the domain
	229	CASE( 1 ) !- Ice-cover climatology ("Ice-if" model)
[9656]	230	CASE( 2 ) !- SI3 ice model
[12154]	231	IF( .NOT.( ln_blk .OR. ln_cpl .OR. ln_abl .OR. ln_usr ) ) &
	232	& CALL ctl_stop( 'sbc_init : SI3 sea-ice model requires ln_blk or ln_cpl or ln_abl or ln_usr = T' )
[9019]	233	CASE( 3 ) !- CICE ice model
[12154]	234	IF( .NOT.( ln_blk .OR. ln_cpl .OR. ln_abl .OR. ln_usr ) ) &
	235	& CALL ctl_stop( 'sbc_init : CICE sea-ice model requires ln_blk or ln_cpl or ln_abl or ln_usr = T' )
	236	IF( lk_agrif ) &
	237	& CALL ctl_stop( 'sbc_init : CICE sea-ice model not currently available with AGRIF' )
[7646]	238	CASE DEFAULT !- not supported
	239	END SELECT
	240	!
	241	! !** allocate and set required variables
	242	!
	243	! !* allocate sbc arrays
[5836]	244	IF( sbc_oce_alloc() /= 0 ) CALL ctl_stop( 'sbc_init : unable to allocate sbc_oce arrays' )
[9570]	245	#if ! defined key_si3 && ! defined key_cice
[9019]	246	IF( sbc_ice_alloc() /= 0 ) CALL ctl_stop( 'sbc_init : unable to allocate sbc_ice arrays' )
	247	#endif
[7646]	248	!
	249	IF( .NOT.ln_isf ) THEN !* No ice-shelf in the domain : allocate and set to zero
[6140]	250	IF( sbc_isf_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_isf arrays' )
[7753]	251	fwfisf (:,:) = 0._wp ; risf_tsc (:,:,:) = 0._wp
	252	fwfisf_b(:,:) = 0._wp ; risf_tsc_b(:,:,:) = 0._wp
[12154]	253	ENDIF
[12109]	254	!
	255	IF( sbc_ssr_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_ssr arrays' )
	256	IF( .NOT.ln_ssr ) THEN !* Initialize qrp and erp if no restoring
	257	qrp(:,:) = 0._wp
	258	erp(:,:) = 0._wp
	259	ENDIF
	260	!
	261
[7646]	262	IF( nn_ice == 0 ) THEN !* No sea-ice in the domain : ice fraction is always zero
[7753]	263	IF( nn_components /= jp_iam_opa ) fr_i(:,:) = 0._wp ! except for OPA in SAS-OPA coupled case
[7646]	264	ENDIF
	265	!
[7753]	266	sfx (:,:) = 0._wp !* salt flux due to freezing/melting
	267	fmmflx(:,:) = 0._wp !* freezing minus melting flux
[1037]	268
[7753]	269	taum(:,:) = 0._wp !* wind stress module (needed in GLS in case of reduced restart)
	270
[2528]	271	! ! Choice of the Surface Boudary Condition (set nsbc)
[12154]	272	nday_qsr = -1 ! allow initialization at the 1st call !LB: now warm-layer of COARE* calls "sbc_dcy_param" of sbcdcy.F90!
[7646]	273	IF( ln_dm2dc ) THEN !* daily mean to diurnal cycle
[12154]	274	!LB:nday_qsr = -1 ! allow initialization at the 1st call
	275	IF( .NOT.( ln_flx .OR. ln_blk .OR. ln_abl ) .AND. nn_components /= jp_iam_opa ) &
	276	& CALL ctl_stop( 'qsr diurnal cycle from daily values requires flux, bulk or abl formulation' )
[7646]	277	ENDIF
	278	! !* Choice of the Surface Boudary Condition
	279	! (set nsbc)
[5407]	280	!
[7646]	281	ll_purecpl = ln_cpl .AND. .NOT.ln_mixcpl
	282	ll_opa = nn_components == jp_iam_opa
	283	ll_not_nemo = nn_components /= jp_iam_nemo
[888]	284	icpt = 0
[7646]	285	!
	286	IF( ln_usr ) THEN ; nsbc = jp_usr ; icpt = icpt + 1 ; ENDIF ! user defined formulation
[5407]	287	IF( ln_flx ) THEN ; nsbc = jp_flx ; icpt = icpt + 1 ; ENDIF ! flux formulation
[7646]	288	IF( ln_blk ) THEN ; nsbc = jp_blk ; icpt = icpt + 1 ; ENDIF ! bulk formulation
[12154]	289	IF( ln_abl ) THEN ; nsbc = jp_abl ; icpt = icpt + 1 ; ENDIF ! ABL formulation
[5407]	290	IF( ll_purecpl ) THEN ; nsbc = jp_purecpl ; icpt = icpt + 1 ; ENDIF ! Pure Coupled formulation
[7646]	291	IF( ll_opa ) THEN ; nsbc = jp_none ; icpt = icpt + 1 ; ENDIF ! opa coupling via SAS module
[2528]	292	!
[7646]	293	IF( icpt /= 1 ) CALL ctl_stop( 'sbc_init : choose ONE and only ONE sbc option' )
[5836]	294	!
[7646]	295	IF(lwp) THEN !- print the choice of surface flux formulation
[888]	296	WRITE(numout,*)
[6140]	297	SELECT CASE( nsbc )
[9190]	298	CASE( jp_usr ) ; WRITE(numout,*) ' ==>>> user defined forcing formulation'
	299	CASE( jp_flx ) ; WRITE(numout,*) ' ==>>> flux formulation'
	300	CASE( jp_blk ) ; WRITE(numout,*) ' ==>>> bulk formulation'
[12154]	301	CASE( jp_abl ) ; WRITE(numout,*) ' ==>>> ABL formulation'
[9190]	302	CASE( jp_purecpl ) ; WRITE(numout,*) ' ==>>> pure coupled formulation'
[7646]	303	!!gm abusive use of jp_none ?? ===>>> need to be check and changed by adding a jp_sas parameter
[9190]	304	CASE( jp_none ) ; WRITE(numout,*) ' ==>>> OPA coupled to SAS via oasis'
	305	IF( ln_mixcpl ) WRITE(numout,*) ' + forced-coupled mixed formulation'
[6140]	306	END SELECT
[9190]	307	IF( ll_not_nemo ) WRITE(numout,*) ' + OASIS coupled SAS'
[888]	308	ENDIF
	309	!
[7646]	310	! !* OASIS initialization
	311	!
	312	IF( lk_oasis ) CALL sbc_cpl_init( nn_ice ) ! Must be done before: (1) first time step
	313	! ! (2) the use of nn_fsbc
[6140]	314	! nn_fsbc initialization if OPA-SAS coupling via OASIS
[7646]	315	! SAS time-step has to be declared in OASIS (mandatory) -> nn_fsbc has to be modified accordingly
[6140]	316	IF( nn_components /= jp_iam_nemo ) THEN
	317	IF( nn_components == jp_iam_opa ) nn_fsbc = cpl_freq('O_SFLX') / NINT(rdt)
	318	IF( nn_components == jp_iam_sas ) nn_fsbc = cpl_freq('I_SFLX') / NINT(rdt)
[5407]	319	!
	320	IF(lwp)THEN
	321	WRITE(numout,*)
	322	WRITE(numout,*)" OPA-SAS coupled via OASIS : nn_fsbc re-defined from OASIS namcouple ", nn_fsbc
	323	WRITE(numout,*)
	324	ENDIF
	325	ENDIF
[6140]	326	!
[7646]	327	! !* check consistency between model timeline and nn_fsbc
[11536]	328	IF( ln_rst_list .OR. nn_stock /= -1 ) THEN ! we will do restart files
	329	IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 ) THEN
	330	WRITE(ctmp1,*) 'sbc_init : experiment length (', nitend - nit000 + 1, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
	331	CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
	332	ENDIF
	333	IF( .NOT. ln_rst_list .AND. MOD( nn_stock, nn_fsbc) /= 0 ) THEN ! we don't use nn_stock if ln_rst_list
	334	WRITE(ctmp1,*) 'sbc_init : nn_stock (', nn_stock, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
	335	CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
	336	ENDIF
[5407]	337	ENDIF
	338	!
	339	IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 ) &
[7646]	340	& CALL ctl_warn( 'sbc_init : nn_fsbc is NOT a multiple of the number of time steps in a day' )
[5407]	341	!
[7646]	342	IF( ln_dm2dc .AND. NINT(rday) / ( nn_fsbc * NINT(rdt) ) < 8 ) &
	343	& CALL ctl_warn( 'sbc_init : diurnal cycle for qsr: the sampling of the diurnal cycle is too small...' )
[4152]	344	!
[7646]	345
	346	! !** associated modules : initialization
[3764]	347	!
[7646]	348	CALL sbc_ssm_init ! Sea-surface mean fields initialization
[5385]	349	!
[7646]	350	IF( ln_blk ) CALL sbc_blk_init ! bulk formulae initialization
	351
[12154]	352	IF( ln_abl ) CALL sbc_abl_init ! Atmospheric Boundary Layer (ABL)
	353
[7646]	354	IF( ln_ssr ) CALL sbc_ssr_init ! Sea-Surface Restoring initialization
[6140]	355	!
[9019]	356	IF( ln_isf ) CALL sbc_isf_init ! Compute iceshelves
[7788]	357	!
[7646]	358	CALL sbc_rnf_init ! Runof initialization
[6140]	359	!
[8524]	360	IF( ln_apr_dyn ) CALL sbc_apr_init ! Atmo Pressure Forcing initialization
	361	!
[9570]	362	#if defined key_si3
[9019]	363	IF( lk_agrif .AND. nn_ice == 0 ) THEN ! allocate ice arrays in case agrif + ice-model + no-ice in child grid
	364	IF( sbc_ice_alloc() /= 0 ) CALL ctl_stop('STOP', 'sbc_ice_alloc : unable to allocate arrays' )
	365	ELSEIF( nn_ice == 2 ) THEN
	366	CALL ice_init ! ICE initialization
	367	ENDIF
	368	#endif
	369	IF( nn_ice == 3 ) CALL cice_sbc_init( nsbc ) ! CICE initialization
[6140]	370	!
[9019]	371	IF( ln_wave ) CALL sbc_wave_init ! surface wave initialisation
[7646]	372	!
[9367]	373	IF( lwxios ) THEN
	374	CALL iom_set_rstw_var_active('utau_b')
	375	CALL iom_set_rstw_var_active('vtau_b')
	376	CALL iom_set_rstw_var_active('qns_b')
	377	! The 3D heat content due to qsr forcing is treated in traqsr
	378	! CALL iom_set_rstw_var_active('qsr_b')
	379	CALL iom_set_rstw_var_active('emp_b')
	380	CALL iom_set_rstw_var_active('sfx_b')
	381	ENDIF
	382
[888]	383	END SUBROUTINE sbc_init
	384
	385
	386	SUBROUTINE sbc( kt )
	387	!!---------------------------------------------------------------------
	388	!! * ROUTINE sbc *
[7646]	389	!!
[888]	390	!! ** Purpose : provide at each time-step the ocean surface boundary
	391	!! condition (momentum, heat and freshwater fluxes)
	392	!!
[7646]	393	!! ** Method : blah blah to be written ?????????
[888]	394	!! CAUTION : never mask the surface stress field (tke sbc)
	395	!!
[7646]	396	!! ** Action : - set the ocean surface boundary condition at before and now
	397	!! time step, i.e.
[3625]	398	!! utau_b, vtau_b, qns_b, qsr_b, emp_n, sfx_b, qrp_b, erp_b
	399	!! utau , vtau , qns , qsr , emp , sfx , qrp , erp
[1037]	400	!! - updte the ice fraction : fr_i
[888]	401	!!----------------------------------------------------------------------
[7646]	402	INTEGER, INTENT(in) :: kt ! ocean time step
	403	!
	404	LOGICAL :: ll_sas, ll_opa ! local logical
[10499]	405	!
	406	REAL(wp) :: zthscl ! wd tanh scale
	407	REAL(wp), DIMENSION(jpi,jpj) :: zwdht, zwght ! wd dep over wd limit, wgt
	408
[888]	409	!!---------------------------------------------------------------------
[3294]	410	!
[9124]	411	IF( ln_timing ) CALL timing_start('sbc')
[3294]	412	!
[2528]	413	! ! ---------------------------------------- !
	414	IF( kt /= nit000 ) THEN ! Swap of forcing fields !
	415	! ! ---------------------------------------- !
[7753]	416	utau_b(:,:) = utau(:,:) ! Swap the ocean forcing fields
	417	vtau_b(:,:) = vtau(:,:) ! (except at nit000 where before fields
	418	qns_b (:,:) = qns (:,:) ! are set at the end of the routine)
	419	emp_b (:,:) = emp (:,:)
	420	sfx_b (:,:) = sfx (:,:)
[12154]	421	IF( ln_rnf ) THEN
[7753]	422	rnf_b (:,: ) = rnf (:,: )
	423	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
[6460]	424	ENDIF
[7788]	425	IF( ln_isf ) THEN
	426	fwfisf_b (:,: ) = fwfisf (:,: )
	427	risf_tsc_b(:,:,:) = risf_tsc(:,:,:)
	428	ENDIF
	429	!
[2528]	430	ENDIF
	431	! ! ---------------------------------------- !
	432	! ! forcing field computation !
	433	! ! ---------------------------------------- !
[1482]	434	!
[7646]	435	ll_sas = nn_components == jp_iam_sas ! component flags
	436	ll_opa = nn_components == jp_iam_opa
	437	!
	438	IF( .NOT.ll_sas ) CALL sbc_ssm ( kt ) ! mean ocean sea surface variables (sst_m, sss_m, ssu_m, ssv_m)
	439	IF( ln_wave ) CALL sbc_wave( kt ) ! surface waves
	440
	441	!
	442	! !== sbc formulation ==!
	443	!
[2528]	444	SELECT CASE( nsbc ) ! Compute ocean surface boundary condition
[3625]	445	! ! (i.e. utau,vtau, qns, qsr, emp, sfx)
[7646]	446	CASE( jp_usr ) ; CALL usrdef_sbc_oce( kt ) ! user defined formulation
	447	CASE( jp_flx ) ; CALL sbc_flx ( kt ) ! flux formulation
	448	CASE( jp_blk )
	449	IF( ll_sas ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: SAS receiving fields from OPA
	450	CALL sbc_blk ( kt ) ! bulk formulation for the ocean
	451	!
[12154]	452	CASE( jp_abl )
	453	IF( ll_sas ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: SAS receiving fields from OPA
	454	CALL sbc_abl ( kt ) ! ABL formulation for the ocean
	455	!
[7646]	456	CASE( jp_purecpl ) ; CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! pure coupled formulation
	457	CASE( jp_none )
	458	IF( ll_opa ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: OPA receiving fields from SAS
[888]	459	END SELECT
[7646]	460	!
	461	IF( ln_mixcpl ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! forced-coupled mixed formulation after forcing
[6140]	462	!
[12154]	463	IF( ln_wave .AND. (ln_tauwoc .OR. ln_tauw) ) CALL sbc_wstress( ) ! Wind stress provided by waves
[9023]	464	!
[2528]	465	! !== Misc. Options ==!
[6140]	466	!
[3632]	467	SELECT CASE( nn_ice ) ! Update heat and freshwater fluxes over sea-ice areas
[9019]	468	CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model)
[9570]	469	#if defined key_si3
[9656]	470	CASE( 2 ) ; CALL ice_stp ( kt, nsbc ) ! SI3 ice model
[9019]	471	#endif
	472	CASE( 3 ) ; CALL sbc_ice_cice ( kt, nsbc ) ! CICE ice model
[7646]	473	END SELECT
[888]	474
[9940]	475	IF( ln_icebergs ) THEN
	476	CALL icb_stp( kt ) ! compute icebergs
	477	! icebergs may advect into haloes during the icb step and alter emp.
	478	! A lbc_lnk is necessary here to ensure restartability (#2113)
[10425]	479	IF( .NOT. ln_passive_mode ) CALL lbc_lnk( 'sbcmod', emp, 'T', 1. ) ! ensure restartability with icebergs
[9940]	480	ENDIF
[3609]	481
[6140]	482	IF( ln_isf ) CALL sbc_isf( kt ) ! compute iceshelves
[4990]	483
[3632]	484	IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes
[7646]	485
[3632]	486	IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term
[888]	487
[3632]	488	IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget
[888]	489
[9161]	490	! Special treatment of freshwater fluxes over closed seas in the model domain
	491	! Should not be run if ln_diurnal_only
	492	IF( l_sbc_clo .AND. (.NOT. ln_diurnal_only) ) CALL sbc_clo( kt )
[6140]	493
[9439]	494	!!$!RBbug do not understand why see ticket 667
	495	!!$!clem: it looks like it is necessary for the north fold (in certain circumstances). Don't know why.
[10425]	496	!!$ CALL lbc_lnk( 'sbcmod', emp, 'T', 1. )
[12154]	497	IF( ll_wd ) THEN ! If near WAD point limit the flux for now
[10499]	498	zthscl = atanh(rn_wd_sbcfra) ! taper frac default is .999
	499	zwdht(:,:) = sshn(:,:) + ht_0(:,:) - rn_wdmin1 ! do this calc of water
	500	! depth above wd limit once
	501	WHERE( zwdht(:,:) <= 0.0 )
	502	taum(:,:) = 0.0
	503	utau(:,:) = 0.0
	504	vtau(:,:) = 0.0
	505	qns (:,:) = 0.0
	506	qsr (:,:) = 0.0
	507	emp (:,:) = min(emp(:,:),0.0) !can allow puddles to grow but not shrink
	508	sfx (:,:) = 0.0
	509	END WHERE
	510	zwght(:,:) = tanh(zthscl*zwdht(:,:))
	511	WHERE( zwdht(:,:) > 0.0 .and. zwdht(:,:) < rn_wd_sbcdep ) ! 5 m hard limit here is arbitrary
	512	qsr (:,:) = qsr(:,:) * zwght(:,:)
	513	qns (:,:) = qns(:,:) * zwght(:,:)
	514	taum (:,:) = taum(:,:) * zwght(:,:)
	515	utau (:,:) = utau(:,:) * zwght(:,:)
	516	vtau (:,:) = vtau(:,:) * zwght(:,:)
	517	sfx (:,:) = sfx(:,:) * zwght(:,:)
	518	emp (:,:) = emp(:,:) * zwght(:,:)
	519	END WHERE
	520	ENDIF
[2502]	521	!
[2528]	522	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
	523	! ! ---------------------------------------- !
	524	IF( ln_rstart .AND. & !* Restart: read in restart file
[7646]	525	& iom_varid( numror, 'utau_b', ldstop = .FALSE. ) > 0 ) THEN
[2528]	526	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields red in the restart file'
[9367]	527	CALL iom_get( numror, jpdom_autoglo, 'utau_b', utau_b, ldxios = lrxios ) ! before i-stress (U-point)
	528	CALL iom_get( numror, jpdom_autoglo, 'vtau_b', vtau_b, ldxios = lrxios ) ! before j-stress (V-point)
[12154]	529	CALL iom_get( numror, jpdom_autoglo, 'qns_b', qns_b, ldxios = lrxios ) ! before non solar heat flux (T-point)
[2528]	530	! The 3D heat content due to qsr forcing is treated in traqsr
[9367]	531	! CALL iom_get( numror, jpdom_autoglo, 'qsr_b' , qsr_b, ldxios = lrxios ) ! before solar heat flux (T-point)
	532	CALL iom_get( numror, jpdom_autoglo, 'emp_b', emp_b, ldxios = lrxios ) ! before freshwater flux (T-point)
[3625]	533	! To ensure restart capability with 3.3x/3.4 restart files !! to be removed in v3.6
	534	IF( iom_varid( numror, 'sfx_b', ldstop = .FALSE. ) > 0 ) THEN
[9367]	535	CALL iom_get( numror, jpdom_autoglo, 'sfx_b', sfx_b, ldxios = lrxios ) ! before salt flux (T-point)
[3625]	536	ELSE
[7753]	537	sfx_b (:,:) = sfx(:,:)
[3625]	538	ENDIF
[2528]	539	ELSE !* no restart: set from nit000 values
	540	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields set to nit000'
[7753]	541	utau_b(:,:) = utau(:,:)
	542	vtau_b(:,:) = vtau(:,:)
	543	qns_b (:,:) = qns (:,:)
	544	emp_b (:,:) = emp (:,:)
	545	sfx_b (:,:) = sfx (:,:)
[2528]	546	ENDIF
	547	ENDIF
	548	! ! ---------------------------------------- !
	549	IF( lrst_oce ) THEN ! Write in the ocean restart file !
	550	! ! ---------------------------------------- !
	551	IF(lwp) WRITE(numout,*)
	552	IF(lwp) WRITE(numout,*) 'sbc : ocean surface forcing fields written in ocean restart file ', &
	553	& 'at it= ', kt,' date= ', ndastp
	554	IF(lwp) WRITE(numout,*) '~~~~'
[9367]	555	IF( lwxios ) CALL iom_swap( cwxios_context )
	556	CALL iom_rstput( kt, nitrst, numrow, 'utau_b' , utau, ldxios = lwxios )
	557	CALL iom_rstput( kt, nitrst, numrow, 'vtau_b' , vtau, ldxios = lwxios )
	558	CALL iom_rstput( kt, nitrst, numrow, 'qns_b' , qns, ldxios = lwxios )
[2528]	559	! The 3D heat content due to qsr forcing is treated in traqsr
	560	! CALL iom_rstput( kt, nitrst, numrow, 'qsr_b' , qsr )
[9367]	561	CALL iom_rstput( kt, nitrst, numrow, 'emp_b' , emp, ldxios = lwxios )
	562	CALL iom_rstput( kt, nitrst, numrow, 'sfx_b' , sfx, ldxios = lwxios )
	563	IF( lwxios ) CALL iom_swap( cxios_context )
[2528]	564	ENDIF
	565	! ! ---------------------------------------- !
	566	! ! Outputs and control print !
	567	! ! ---------------------------------------- !
[1482]	568	IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN
[6351]	569	CALL iom_put( "empmr" , emp - rnf ) ! upward water flux
	570	CALL iom_put( "empbmr" , emp_b - rnf ) ! before upward water flux ( needed to recalculate the time evolution of ssh in offline )
[7646]	571	CALL iom_put( "saltflx", sfx ) ! downward salt flux (includes virtual salt flux beneath ice in linear free surface case)
[4148]	572	CALL iom_put( "fmmflx", fmmflx ) ! Freezing-melting water flux
[7646]	573	CALL iom_put( "qt" , qns + qsr ) ! total heat flux
[2561]	574	CALL iom_put( "qns" , qns ) ! solar heat flux
	575	CALL iom_put( "qsr" , qsr ) ! solar heat flux
[7646]	576	IF( nn_ice > 0 .OR. ll_opa ) CALL iom_put( "ice_cover", fr_i ) ! ice fraction
	577	CALL iom_put( "taum" , taum ) ! wind stress module
[4990]	578	CALL iom_put( "wspd" , wndm ) ! wind speed module over free ocean or leads in presence of sea-ice
[12109]	579	CALL iom_put( "qrp", qrp ) ! heat flux damping
	580	CALL iom_put( "erp", erp ) ! freshwater flux damping
[1482]	581	ENDIF
	582	!
[7646]	583	CALL iom_put( "utau", utau ) ! i-wind stress (stress can be updated at each time step in sea-ice)
	584	CALL iom_put( "vtau", vtau ) ! j-wind stress
[1482]	585	!
[888]	586	IF(ln_ctl) THEN ! print mean trends (used for debugging)
[9439]	587	CALL prt_ctl(tab2d_1=fr_i , clinfo1=' fr_i - : ', mask1=tmask )
	588	CALL prt_ctl(tab2d_1=(emp-rnf + fwfisf), clinfo1=' emp-rnf - : ', mask1=tmask )
	589	CALL prt_ctl(tab2d_1=(sfx-rnf + fwfisf), clinfo1=' sfx-rnf - : ', mask1=tmask )
	590	CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask )
	591	CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask )
	592	CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask - : ', mask1=tmask, kdim=jpk )
	593	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_tem), clinfo1=' sst - : ', mask1=tmask, kdim=1 )
	594	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_sal), clinfo1=' sss - : ', mask1=tmask, kdim=1 )
[3294]	595	CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', mask1=umask, &
[9439]	596	& tab2d_2=vtau , clinfo2=' vtau - : ', mask2=vmask )
[888]	597	ENDIF
[3294]	598
	599	IF( kt == nitend ) CALL sbc_final ! Close down surface module if necessary
[888]	600	!
[9124]	601	IF( ln_timing ) CALL timing_stop('sbc')
[3294]	602	!
[888]	603	END SUBROUTINE sbc
	604
[3764]	605
[3294]	606	SUBROUTINE sbc_final
	607	!!---------------------------------------------------------------------
	608	!! * ROUTINE sbc_final *
[3764]	609	!!
	610	!! ** Purpose : Finalize CICE (if used)
[3294]	611	!!---------------------------------------------------------------------
[3764]	612	!
[9019]	613	IF( nn_ice == 3 ) CALL cice_sbc_final
[3294]	614	!
	615	END SUBROUTINE sbc_final
	616
[888]	617	!!======================================================================
	618	END MODULE sbcmod

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

Download in other formats: