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/releases/r4.0/r4.0-HEAD/src/OCE/SBC – NEMO

Context Navigation

source: NEMO/releases/r4.0/r4.0-HEAD/src/OCE/SBC/sbcmod.F90 @ 13481

Last change on this file since 13481 was 13481, checked in by clem, 4 years ago
r4.0-HEAD: backward compatibility following commit r13477 from the trunk
Property svn:keywords set to `Id`
File size: 34.9 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
[7816]	39	USE sbcisf ! surface boundary condition: ice-shelf
[7646]	40	USE sbccpl ! surface boundary condition: coupled formulation
[6140]	41	USE cpl_oasis3 ! OASIS routines for coupling
	42	USE sbcssr ! surface boundary condition: sea surface restoring
	43	USE sbcrnf ! surface boundary condition: runoffs
[8524]	44	USE sbcapr ! surface boundary condition: atmo pressure
[6140]	45	USE sbcisf ! surface boundary condition: ice shelf
	46	USE sbcfwb ! surface boundary condition: freshwater budget
	47	USE icbstp ! Icebergs
[9940]	48	USE icb_oce , ONLY : ln_passive_mode ! iceberg interaction mode
[6140]	49	USE traqsr ! active tracers: light penetration
	50	USE sbcwave ! Wave module
[7646]	51	USE bdy_oce , ONLY: ln_bdy
	52	USE usrdef_sbc ! user defined: surface boundary condition
[9161]	53	USE closea ! closed sea
[6140]	54	!
	55	USE prtctl ! Print control (prt_ctl routine)
	56	USE iom ! IOM library
	57	USE in_out_manager ! I/O manager
	58	USE lib_mpp ! MPP library
	59	USE timing ! Timing
[10499]	60	USE wet_dry
[7646]	61	USE diurnal_bulk, ONLY: ln_diurnal_only ! diurnal SST diagnostic
[888]	62
	63	IMPLICIT NONE
	64	PRIVATE
	65
	66	PUBLIC sbc ! routine called by step.F90
[1725]	67	PUBLIC sbc_init ! routine called by opa.F90
[7646]	68
[888]	69	INTEGER :: nsbc ! type of surface boundary condition (deduced from namsbc informations)
[7646]	70
[888]	71	!!----------------------------------------------------------------------
[10068]	72	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1146]	73	!! $Id$
[10068]	74	!! Software governed by the CeCILL license (see ./LICENSE)
[888]	75	!!----------------------------------------------------------------------
	76	CONTAINS
	77
	78	SUBROUTINE sbc_init
	79	!!---------------------------------------------------------------------
	80	!! * ROUTINE sbc_init *
	81	!!
	82	!! ** Purpose : Initialisation of the ocean surface boundary computation
	83	!!
	84	!! ** Method : Read the namsbc namelist and set derived parameters
[3607]	85	!! Call init routines for all other SBC modules that have one
[888]	86	!!
	87	!! ** Action : - read namsbc parameters
	88	!! - nsbc: type of sbc
	89	!!----------------------------------------------------------------------
[7646]	90	INTEGER :: ios, icpt ! local integer
	91	LOGICAL :: ll_purecpl, ll_opa, ll_not_nemo ! local logical
[1037]	92	!!
[7646]	93	NAMELIST/namsbc/ nn_fsbc , &
	94	& ln_usr , ln_flx , ln_blk , &
[9019]	95	& ln_cpl , ln_mixcpl, nn_components, &
	96	& nn_ice , ln_ice_embd, &
[7646]	97	& ln_traqsr, ln_dm2dc , &
	98	& ln_rnf , nn_fwb , ln_ssr , ln_isf , ln_apr_dyn , &
[9033]	99	& ln_wave , ln_cdgw , ln_sdw , ln_tauwoc , ln_stcor , &
[9023]	100	& ln_tauw , nn_lsm, nn_sdrift
[1037]	101	!!----------------------------------------------------------------------
[6140]	102	!
[888]	103	IF(lwp) THEN
	104	WRITE(numout,*)
	105	WRITE(numout,*) 'sbc_init : surface boundary condition setting'
	106	WRITE(numout,*) '~~~~~~~~ '
	107	ENDIF
[6140]	108	!
[7646]	109	! !** read Surface Module namelist
	110	REWIND( numnam_ref ) !* Namelist namsbc in reference namelist : Surface boundary
[4147]	111	READ ( numnam_ref, namsbc, IOSTAT = ios, ERR = 901)
[11536]	112	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc in reference namelist' )
[7646]	113	REWIND( numnam_cfg ) !* Namelist namsbc in configuration namelist : Parameters of the run
[4147]	114	READ ( numnam_cfg, namsbc, IOSTAT = ios, ERR = 902 )
[11536]	115	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namsbc in configuration namelist' )
[6140]	116	IF(lwm) WRITE( numond, namsbc )
	117	!
[10425]	118	#if defined key_mpp_mpi
	119	ncom_fsbc = nn_fsbc ! make nn_fsbc available for lib_mpp
	120	#endif
[7646]	121	! !* overwrite namelist parameter using CPP key information
	122	#if defined key_agrif
	123	IF( Agrif_Root() ) THEN ! AGRIF zoom (cf r1242: possibility to run without ice in fine grid)
[9654]	124	IF( lk_si3 ) nn_ice = 2
[9019]	125	IF( lk_cice ) nn_ice = 3
[1242]	126	ENDIF
[7646]	127	#else
[9654]	128	IF( lk_si3 ) nn_ice = 2
[9019]	129	IF( lk_cice ) nn_ice = 3
[7646]	130	#endif
	131	!
[13481]	132	#if ! defined key_si3
	133	IF( nn_ice == 2 ) nn_ice = 0 ! without key key_si3 you cannot use si3...
	134	#endif
	135	!
[7646]	136	IF(lwp) THEN !* Control print
	137	WRITE(numout,*) ' Namelist namsbc (partly overwritten with CPP key setting)'
	138	WRITE(numout,*) ' frequency update of sbc (and ice) nn_fsbc = ', nn_fsbc
	139	WRITE(numout,*) ' Type of air-sea fluxes : '
	140	WRITE(numout,*) ' user defined formulation ln_usr = ', ln_usr
	141	WRITE(numout,*) ' flux formulation ln_flx = ', ln_flx
	142	WRITE(numout,*) ' bulk formulation ln_blk = ', ln_blk
	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
[9019]	231	CASE( 3 ) !- CICE ice model
[7646]	232	IF( .NOT.( ln_blk .OR. ln_cpl ) ) CALL ctl_stop( 'sbc_init : CICE sea-ice model requires ln_blk or ln_cpl = T' )
	233	IF( lk_agrif ) CALL ctl_stop( 'sbc_init : CICE sea-ice model not currently available with AGRIF' )
	234	CASE DEFAULT !- not supported
	235	END SELECT
	236	!
	237	! !** allocate and set required variables
	238	!
	239	! !* allocate sbc arrays
[5836]	240	IF( sbc_oce_alloc() /= 0 ) CALL ctl_stop( 'sbc_init : unable to allocate sbc_oce arrays' )
[9570]	241	#if ! defined key_si3 && ! defined key_cice
[9019]	242	IF( sbc_ice_alloc() /= 0 ) CALL ctl_stop( 'sbc_init : unable to allocate sbc_ice arrays' )
	243	#endif
[7646]	244	!
	245	IF( .NOT.ln_isf ) THEN !* No ice-shelf in the domain : allocate and set to zero
[6140]	246	IF( sbc_isf_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_isf arrays' )
[7753]	247	fwfisf (:,:) = 0._wp ; risf_tsc (:,:,:) = 0._wp
	248	fwfisf_b(:,:) = 0._wp ; risf_tsc_b(:,:,:) = 0._wp
[4990]	249	END IF
[12276]	250	!
	251	IF( sbc_ssr_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_ssr arrays' )
	252	IF( .NOT.ln_ssr ) THEN !* Initialize qrp and erp if no restoring
	253	qrp(:,:) = 0._wp
	254	erp(:,:) = 0._wp
	255	ENDIF
	256	!
	257
[7646]	258	IF( nn_ice == 0 ) THEN !* No sea-ice in the domain : ice fraction is always zero
[7753]	259	IF( nn_components /= jp_iam_opa ) fr_i(:,:) = 0._wp ! except for OPA in SAS-OPA coupled case
[7646]	260	ENDIF
	261	!
[7753]	262	sfx (:,:) = 0._wp !* salt flux due to freezing/melting
	263	fmmflx(:,:) = 0._wp !* freezing minus melting flux
[1037]	264
[7753]	265	taum(:,:) = 0._wp !* wind stress module (needed in GLS in case of reduced restart)
	266
[2528]	267	! ! Choice of the Surface Boudary Condition (set nsbc)
[7646]	268	IF( ln_dm2dc ) THEN !* daily mean to diurnal cycle
	269	nday_qsr = -1 ! allow initialization at the 1st call
	270	IF( .NOT.( ln_flx .OR. ln_blk ) .AND. nn_components /= jp_iam_opa ) &
	271	& CALL ctl_stop( 'qsr diurnal cycle from daily values requires a flux or bulk formulation' )
	272	ENDIF
	273	! !* Choice of the Surface Boudary Condition
	274	! (set nsbc)
[5407]	275	!
[7646]	276	ll_purecpl = ln_cpl .AND. .NOT.ln_mixcpl
	277	ll_opa = nn_components == jp_iam_opa
	278	ll_not_nemo = nn_components /= jp_iam_nemo
[888]	279	icpt = 0
[7646]	280	!
	281	IF( ln_usr ) THEN ; nsbc = jp_usr ; icpt = icpt + 1 ; ENDIF ! user defined formulation
[5407]	282	IF( ln_flx ) THEN ; nsbc = jp_flx ; icpt = icpt + 1 ; ENDIF ! flux formulation
[7646]	283	IF( ln_blk ) THEN ; nsbc = jp_blk ; icpt = icpt + 1 ; ENDIF ! bulk formulation
[5407]	284	IF( ll_purecpl ) THEN ; nsbc = jp_purecpl ; icpt = icpt + 1 ; ENDIF ! Pure Coupled formulation
[7646]	285	IF( ll_opa ) THEN ; nsbc = jp_none ; icpt = icpt + 1 ; ENDIF ! opa coupling via SAS module
[2528]	286	!
[7646]	287	IF( icpt /= 1 ) CALL ctl_stop( 'sbc_init : choose ONE and only ONE sbc option' )
[5836]	288	!
[7646]	289	IF(lwp) THEN !- print the choice of surface flux formulation
[888]	290	WRITE(numout,*)
[6140]	291	SELECT CASE( nsbc )
[9190]	292	CASE( jp_usr ) ; WRITE(numout,*) ' ==>>> user defined forcing formulation'
	293	CASE( jp_flx ) ; WRITE(numout,*) ' ==>>> flux formulation'
	294	CASE( jp_blk ) ; WRITE(numout,*) ' ==>>> bulk formulation'
	295	CASE( jp_purecpl ) ; WRITE(numout,*) ' ==>>> pure coupled formulation'
[7646]	296	!!gm abusive use of jp_none ?? ===>>> need to be check and changed by adding a jp_sas parameter
[9190]	297	CASE( jp_none ) ; WRITE(numout,*) ' ==>>> OPA coupled to SAS via oasis'
	298	IF( ln_mixcpl ) WRITE(numout,*) ' + forced-coupled mixed formulation'
[6140]	299	END SELECT
[9190]	300	IF( ll_not_nemo ) WRITE(numout,*) ' + OASIS coupled SAS'
[888]	301	ENDIF
	302	!
[7646]	303	! !* OASIS initialization
	304	!
	305	IF( lk_oasis ) CALL sbc_cpl_init( nn_ice ) ! Must be done before: (1) first time step
	306	! ! (2) the use of nn_fsbc
[6140]	307	! nn_fsbc initialization if OPA-SAS coupling via OASIS
[7646]	308	! SAS time-step has to be declared in OASIS (mandatory) -> nn_fsbc has to be modified accordingly
[6140]	309	IF( nn_components /= jp_iam_nemo ) THEN
	310	IF( nn_components == jp_iam_opa ) nn_fsbc = cpl_freq('O_SFLX') / NINT(rdt)
	311	IF( nn_components == jp_iam_sas ) nn_fsbc = cpl_freq('I_SFLX') / NINT(rdt)
[5407]	312	!
	313	IF(lwp)THEN
	314	WRITE(numout,*)
	315	WRITE(numout,*)" OPA-SAS coupled via OASIS : nn_fsbc re-defined from OASIS namcouple ", nn_fsbc
	316	WRITE(numout,*)
	317	ENDIF
	318	ENDIF
[6140]	319	!
[7646]	320	! !* check consistency between model timeline and nn_fsbc
[11536]	321	IF( ln_rst_list .OR. nn_stock /= -1 ) THEN ! we will do restart files
	322	IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 ) THEN
	323	WRITE(ctmp1,*) 'sbc_init : experiment length (', nitend - nit000 + 1, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
	324	CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
	325	ENDIF
	326	IF( .NOT. ln_rst_list .AND. MOD( nn_stock, nn_fsbc) /= 0 ) THEN ! we don't use nn_stock if ln_rst_list
	327	WRITE(ctmp1,*) 'sbc_init : nn_stock (', nn_stock, ') is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
	328	CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
	329	ENDIF
[5407]	330	ENDIF
	331	!
	332	IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 ) &
[7646]	333	& CALL ctl_warn( 'sbc_init : nn_fsbc is NOT a multiple of the number of time steps in a day' )
[5407]	334	!
[7646]	335	IF( ln_dm2dc .AND. NINT(rday) / ( nn_fsbc * NINT(rdt) ) < 8 ) &
	336	& CALL ctl_warn( 'sbc_init : diurnal cycle for qsr: the sampling of the diurnal cycle is too small...' )
[4152]	337	!
[7646]	338
	339	! !** associated modules : initialization
[3764]	340	!
[7646]	341	CALL sbc_ssm_init ! Sea-surface mean fields initialization
[5385]	342	!
[7646]	343	IF( ln_blk ) CALL sbc_blk_init ! bulk formulae initialization
	344
	345	IF( ln_ssr ) CALL sbc_ssr_init ! Sea-Surface Restoring initialization
[6140]	346	!
[9019]	347	IF( ln_isf ) CALL sbc_isf_init ! Compute iceshelves
[7788]	348	!
[7646]	349	CALL sbc_rnf_init ! Runof initialization
[6140]	350	!
[8524]	351	IF( ln_apr_dyn ) CALL sbc_apr_init ! Atmo Pressure Forcing initialization
	352	!
[9570]	353	#if defined key_si3
[9019]	354	IF( lk_agrif .AND. nn_ice == 0 ) THEN ! allocate ice arrays in case agrif + ice-model + no-ice in child grid
	355	IF( sbc_ice_alloc() /= 0 ) CALL ctl_stop('STOP', 'sbc_ice_alloc : unable to allocate arrays' )
	356	ELSEIF( nn_ice == 2 ) THEN
	357	CALL ice_init ! ICE initialization
	358	ENDIF
	359	#endif
	360	IF( nn_ice == 3 ) CALL cice_sbc_init( nsbc ) ! CICE initialization
[6140]	361	!
[9019]	362	IF( ln_wave ) CALL sbc_wave_init ! surface wave initialisation
[7646]	363	!
[9367]	364	IF( lwxios ) THEN
	365	CALL iom_set_rstw_var_active('utau_b')
	366	CALL iom_set_rstw_var_active('vtau_b')
	367	CALL iom_set_rstw_var_active('qns_b')
	368	! The 3D heat content due to qsr forcing is treated in traqsr
	369	! CALL iom_set_rstw_var_active('qsr_b')
	370	CALL iom_set_rstw_var_active('emp_b')
	371	CALL iom_set_rstw_var_active('sfx_b')
	372	ENDIF
	373
[888]	374	END SUBROUTINE sbc_init
	375
	376
	377	SUBROUTINE sbc( kt )
	378	!!---------------------------------------------------------------------
	379	!! * ROUTINE sbc *
[7646]	380	!!
[888]	381	!! ** Purpose : provide at each time-step the ocean surface boundary
	382	!! condition (momentum, heat and freshwater fluxes)
	383	!!
[7646]	384	!! ** Method : blah blah to be written ?????????
[888]	385	!! CAUTION : never mask the surface stress field (tke sbc)
	386	!!
[7646]	387	!! ** Action : - set the ocean surface boundary condition at before and now
	388	!! time step, i.e.
[3625]	389	!! utau_b, vtau_b, qns_b, qsr_b, emp_n, sfx_b, qrp_b, erp_b
	390	!! utau , vtau , qns , qsr , emp , sfx , qrp , erp
[1037]	391	!! - updte the ice fraction : fr_i
[888]	392	!!----------------------------------------------------------------------
[7646]	393	INTEGER, INTENT(in) :: kt ! ocean time step
	394	!
	395	LOGICAL :: ll_sas, ll_opa ! local logical
[10499]	396	!
	397	REAL(wp) :: zthscl ! wd tanh scale
	398	REAL(wp), DIMENSION(jpi,jpj) :: zwdht, zwght ! wd dep over wd limit, wgt
	399
[888]	400	!!---------------------------------------------------------------------
[3294]	401	!
[9124]	402	IF( ln_timing ) CALL timing_start('sbc')
[3294]	403	!
[2528]	404	! ! ---------------------------------------- !
	405	IF( kt /= nit000 ) THEN ! Swap of forcing fields !
	406	! ! ---------------------------------------- !
[7753]	407	utau_b(:,:) = utau(:,:) ! Swap the ocean forcing fields
	408	vtau_b(:,:) = vtau(:,:) ! (except at nit000 where before fields
	409	qns_b (:,:) = qns (:,:) ! are set at the end of the routine)
	410	emp_b (:,:) = emp (:,:)
	411	sfx_b (:,:) = sfx (:,:)
[6460]	412	IF ( ln_rnf ) THEN
[7753]	413	rnf_b (:,: ) = rnf (:,: )
	414	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
[6460]	415	ENDIF
[7788]	416	IF( ln_isf ) THEN
	417	fwfisf_b (:,: ) = fwfisf (:,: )
	418	risf_tsc_b(:,:,:) = risf_tsc(:,:,:)
	419	ENDIF
	420	!
[2528]	421	ENDIF
	422	! ! ---------------------------------------- !
	423	! ! forcing field computation !
	424	! ! ---------------------------------------- !
[1482]	425	!
[7646]	426	ll_sas = nn_components == jp_iam_sas ! component flags
	427	ll_opa = nn_components == jp_iam_opa
	428	!
	429	IF( .NOT.ll_sas ) CALL sbc_ssm ( kt ) ! mean ocean sea surface variables (sst_m, sss_m, ssu_m, ssv_m)
	430	IF( ln_wave ) CALL sbc_wave( kt ) ! surface waves
	431
	432	!
	433	! !== sbc formulation ==!
	434	!
[2528]	435	SELECT CASE( nsbc ) ! Compute ocean surface boundary condition
[3625]	436	! ! (i.e. utau,vtau, qns, qsr, emp, sfx)
[7646]	437	CASE( jp_usr ) ; CALL usrdef_sbc_oce( kt ) ! user defined formulation
	438	CASE( jp_flx ) ; CALL sbc_flx ( kt ) ! flux formulation
	439	CASE( jp_blk )
	440	IF( ll_sas ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: SAS receiving fields from OPA
	441	CALL sbc_blk ( kt ) ! bulk formulation for the ocean
	442	!
	443	CASE( jp_purecpl ) ; CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! pure coupled formulation
	444	CASE( jp_none )
	445	IF( ll_opa ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: OPA receiving fields from SAS
[888]	446	END SELECT
[7646]	447	!
	448	IF( ln_mixcpl ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! forced-coupled mixed formulation after forcing
[6140]	449	!
[9033]	450	IF ( ln_wave .AND. (ln_tauwoc .OR. ln_tauw) ) CALL sbc_wstress( ) ! Wind stress provided by waves
[9023]	451	!
[2528]	452	! !== Misc. Options ==!
[6140]	453	!
[3632]	454	SELECT CASE( nn_ice ) ! Update heat and freshwater fluxes over sea-ice areas
[9019]	455	CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model)
[9570]	456	#if defined key_si3
[9656]	457	CASE( 2 ) ; CALL ice_stp ( kt, nsbc ) ! SI3 ice model
[9019]	458	#endif
	459	CASE( 3 ) ; CALL sbc_ice_cice ( kt, nsbc ) ! CICE ice model
[7646]	460	END SELECT
[888]	461
[9940]	462	IF( ln_icebergs ) THEN
	463	CALL icb_stp( kt ) ! compute icebergs
	464	! icebergs may advect into haloes during the icb step and alter emp.
	465	! A lbc_lnk is necessary here to ensure restartability (#2113)
[10425]	466	IF( .NOT. ln_passive_mode ) CALL lbc_lnk( 'sbcmod', emp, 'T', 1. ) ! ensure restartability with icebergs
[9940]	467	ENDIF
[3609]	468
[6140]	469	IF( ln_isf ) CALL sbc_isf( kt ) ! compute iceshelves
[4990]	470
[3632]	471	IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes
[7646]	472
[3632]	473	IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term
[888]	474
[3632]	475	IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget
[888]	476
[9161]	477	! Special treatment of freshwater fluxes over closed seas in the model domain
	478	! Should not be run if ln_diurnal_only
	479	IF( l_sbc_clo .AND. (.NOT. ln_diurnal_only) ) CALL sbc_clo( kt )
[6140]	480
[9439]	481	!!$!RBbug do not understand why see ticket 667
	482	!!$!clem: it looks like it is necessary for the north fold (in certain circumstances). Don't know why.
[10425]	483	!!$ CALL lbc_lnk( 'sbcmod', emp, 'T', 1. )
[10499]	484	IF ( ll_wd ) THEN ! If near WAD point limit the flux for now
	485	zthscl = atanh(rn_wd_sbcfra) ! taper frac default is .999
	486	zwdht(:,:) = sshn(:,:) + ht_0(:,:) - rn_wdmin1 ! do this calc of water
	487	! depth above wd limit once
	488	WHERE( zwdht(:,:) <= 0.0 )
	489	taum(:,:) = 0.0
	490	utau(:,:) = 0.0
	491	vtau(:,:) = 0.0
	492	qns (:,:) = 0.0
	493	qsr (:,:) = 0.0
	494	emp (:,:) = min(emp(:,:),0.0) !can allow puddles to grow but not shrink
	495	sfx (:,:) = 0.0
	496	END WHERE
	497	zwght(:,:) = tanh(zthscl*zwdht(:,:))
	498	WHERE( zwdht(:,:) > 0.0 .and. zwdht(:,:) < rn_wd_sbcdep ) ! 5 m hard limit here is arbitrary
	499	qsr (:,:) = qsr(:,:) * zwght(:,:)
	500	qns (:,:) = qns(:,:) * zwght(:,:)
	501	taum (:,:) = taum(:,:) * zwght(:,:)
	502	utau (:,:) = utau(:,:) * zwght(:,:)
	503	vtau (:,:) = vtau(:,:) * zwght(:,:)
	504	sfx (:,:) = sfx(:,:) * zwght(:,:)
	505	emp (:,:) = emp(:,:) * zwght(:,:)
	506	END WHERE
	507	ENDIF
[2502]	508	!
[2528]	509	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
	510	! ! ---------------------------------------- !
	511	IF( ln_rstart .AND. & !* Restart: read in restart file
[7646]	512	& iom_varid( numror, 'utau_b', ldstop = .FALSE. ) > 0 ) THEN
[2528]	513	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields red in the restart file'
[9367]	514	CALL iom_get( numror, jpdom_autoglo, 'utau_b', utau_b, ldxios = lrxios ) ! before i-stress (U-point)
	515	CALL iom_get( numror, jpdom_autoglo, 'vtau_b', vtau_b, ldxios = lrxios ) ! before j-stress (V-point)
	516	CALL iom_get( numror, jpdom_autoglo, 'qns_b' , qns_b, ldxios = lrxios ) ! before non solar heat flux (T-point)
[2528]	517	! The 3D heat content due to qsr forcing is treated in traqsr
[9367]	518	! CALL iom_get( numror, jpdom_autoglo, 'qsr_b' , qsr_b, ldxios = lrxios ) ! before solar heat flux (T-point)
	519	CALL iom_get( numror, jpdom_autoglo, 'emp_b', emp_b, ldxios = lrxios ) ! before freshwater flux (T-point)
[3625]	520	! To ensure restart capability with 3.3x/3.4 restart files !! to be removed in v3.6
	521	IF( iom_varid( numror, 'sfx_b', ldstop = .FALSE. ) > 0 ) THEN
[9367]	522	CALL iom_get( numror, jpdom_autoglo, 'sfx_b', sfx_b, ldxios = lrxios ) ! before salt flux (T-point)
[3625]	523	ELSE
[7753]	524	sfx_b (:,:) = sfx(:,:)
[3625]	525	ENDIF
[2528]	526	ELSE !* no restart: set from nit000 values
	527	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields set to nit000'
[7753]	528	utau_b(:,:) = utau(:,:)
	529	vtau_b(:,:) = vtau(:,:)
	530	qns_b (:,:) = qns (:,:)
	531	emp_b (:,:) = emp (:,:)
	532	sfx_b (:,:) = sfx (:,:)
[2528]	533	ENDIF
	534	ENDIF
	535	! ! ---------------------------------------- !
	536	IF( lrst_oce ) THEN ! Write in the ocean restart file !
	537	! ! ---------------------------------------- !
	538	IF(lwp) WRITE(numout,*)
	539	IF(lwp) WRITE(numout,*) 'sbc : ocean surface forcing fields written in ocean restart file ', &
	540	& 'at it= ', kt,' date= ', ndastp
	541	IF(lwp) WRITE(numout,*) '~~~~'
[9367]	542	IF( lwxios ) CALL iom_swap( cwxios_context )
	543	CALL iom_rstput( kt, nitrst, numrow, 'utau_b' , utau, ldxios = lwxios )
	544	CALL iom_rstput( kt, nitrst, numrow, 'vtau_b' , vtau, ldxios = lwxios )
	545	CALL iom_rstput( kt, nitrst, numrow, 'qns_b' , qns, ldxios = lwxios )
[2528]	546	! The 3D heat content due to qsr forcing is treated in traqsr
	547	! CALL iom_rstput( kt, nitrst, numrow, 'qsr_b' , qsr )
[9367]	548	CALL iom_rstput( kt, nitrst, numrow, 'emp_b' , emp, ldxios = lwxios )
	549	CALL iom_rstput( kt, nitrst, numrow, 'sfx_b' , sfx, ldxios = lwxios )
	550	IF( lwxios ) CALL iom_swap( cxios_context )
[2528]	551	ENDIF
	552	! ! ---------------------------------------- !
	553	! ! Outputs and control print !
	554	! ! ---------------------------------------- !
[1482]	555	IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN
[6351]	556	CALL iom_put( "empmr" , emp - rnf ) ! upward water flux
	557	CALL iom_put( "empbmr" , emp_b - rnf ) ! before upward water flux ( needed to recalculate the time evolution of ssh in offline )
[7646]	558	CALL iom_put( "saltflx", sfx ) ! downward salt flux (includes virtual salt flux beneath ice in linear free surface case)
[4148]	559	CALL iom_put( "fmmflx", fmmflx ) ! Freezing-melting water flux
[7646]	560	CALL iom_put( "qt" , qns + qsr ) ! total heat flux
[2561]	561	CALL iom_put( "qns" , qns ) ! solar heat flux
	562	CALL iom_put( "qsr" , qsr ) ! solar heat flux
[7646]	563	IF( nn_ice > 0 .OR. ll_opa ) CALL iom_put( "ice_cover", fr_i ) ! ice fraction
	564	CALL iom_put( "taum" , taum ) ! wind stress module
[4990]	565	CALL iom_put( "wspd" , wndm ) ! wind speed module over free ocean or leads in presence of sea-ice
[12276]	566	CALL iom_put( "qrp", qrp ) ! heat flux damping
	567	CALL iom_put( "erp", erp ) ! freshwater flux damping
[1482]	568	ENDIF
	569	!
[888]	570	IF(ln_ctl) THEN ! print mean trends (used for debugging)
[9439]	571	CALL prt_ctl(tab2d_1=fr_i , clinfo1=' fr_i - : ', mask1=tmask )
	572	CALL prt_ctl(tab2d_1=(emp-rnf + fwfisf), clinfo1=' emp-rnf - : ', mask1=tmask )
	573	CALL prt_ctl(tab2d_1=(sfx-rnf + fwfisf), clinfo1=' sfx-rnf - : ', mask1=tmask )
	574	CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask )
	575	CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask )
	576	CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask - : ', mask1=tmask, kdim=jpk )
	577	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_tem), clinfo1=' sst - : ', mask1=tmask, kdim=1 )
	578	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_sal), clinfo1=' sss - : ', mask1=tmask, kdim=1 )
[3294]	579	CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', mask1=umask, &
[9439]	580	& tab2d_2=vtau , clinfo2=' vtau - : ', mask2=vmask )
[888]	581	ENDIF
[3294]	582
	583	IF( kt == nitend ) CALL sbc_final ! Close down surface module if necessary
[888]	584	!
[9124]	585	IF( ln_timing ) CALL timing_stop('sbc')
[3294]	586	!
[888]	587	END SUBROUTINE sbc
	588
[3764]	589
[3294]	590	SUBROUTINE sbc_final
	591	!!---------------------------------------------------------------------
	592	!! * ROUTINE sbc_final *
[3764]	593	!!
	594	!! ** Purpose : Finalize CICE (if used)
[3294]	595	!!---------------------------------------------------------------------
[3764]	596	!
[9019]	597	IF( nn_ice == 3 ) CALL cice_sbc_final
[3294]	598	!
	599	END SUBROUTINE sbc_final
	600
[888]	601	!!======================================================================
	602	END MODULE sbcmod

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

Download in other formats: