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/UKMO_MERGE_2019/src/OCE/SBC – NEMO

Context Navigation

source: NEMO/branches/2019/UKMO_MERGE_2019/src/OCE/SBC/sbcmod.F90 @ 12068

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

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

Download in other formats: