Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Normal
Revision Log

sbcmod.F90 @ 11738

Last change on this file since 11738 was 11738, checked in by marc, 5 years ago
The Dr Hook changes from my perl code.
File size: 32.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
[5120]	15	!! 3.6 ! 2014-11 (P. Mathiot, C. Harris) add ice shelves melting
[888]	16	!!----------------------------------------------------------------------
	17
	18	!!----------------------------------------------------------------------
	19	!! sbc_init : read namsbc namelist
[1037]	20	!! sbc : surface ocean momentum, heat and freshwater boundary conditions
[888]	21	!!----------------------------------------------------------------------
[2528]	22	USE oce ! ocean dynamics and tracers
	23	USE dom_oce ! ocean space and time domain
	24	USE phycst ! physical constants
	25	USE sbc_oce ! Surface boundary condition: ocean fields
[5385]	26	USE trc_oce ! shared ocean-passive tracers variables
[2528]	27	USE sbc_ice ! Surface boundary condition: ice fields
	28	USE sbcdcy ! surface boundary condition: diurnal cycle
	29	USE sbcssm ! surface boundary condition: sea-surface mean variables
	30	USE sbcapr ! surface boundary condition: atmospheric pressure
	31	USE sbcana ! surface boundary condition: analytical formulation
	32	USE sbcflx ! surface boundary condition: flux formulation
	33	USE sbcblk_clio ! surface boundary condition: bulk formulation : CLIO
	34	USE sbcblk_core ! surface boundary condition: bulk formulation : CORE
[3294]	35	USE sbcblk_mfs ! surface boundary condition: bulk formulation : MFS
[2528]	36	USE sbcice_if ! surface boundary condition: ice-if sea-ice model
	37	USE sbcice_lim ! surface boundary condition: LIM 3.0 sea-ice model
	38	USE sbcice_lim_2 ! surface boundary condition: LIM 2.0 sea-ice model
[3294]	39	USE sbcice_cice ! surface boundary condition: CICE sea-ice model
[2528]	40	USE sbccpl ! surface boundary condition: coupled florulation
[5407]	41	USE cpl_oasis3 ! OASIS routines for coupling
[2528]	42	USE sbcssr ! surface boundary condition: sea surface restoring
	43	USE sbcrnf ! surface boundary condition: runoffs
[4990]	44	USE sbcisf ! surface boundary condition: ice shelf
[2528]	45	USE sbcfwb ! surface boundary condition: freshwater budget
	46	USE closea ! closed sea
[3609]	47	USE icbstp ! Icebergs!
[888]	48
[2528]	49	USE prtctl ! Print control (prt_ctl routine)
	50	USE iom ! IOM library
	51	USE in_out_manager ! I/O manager
[2715]	52	USE lib_mpp ! MPP library
[3294]	53	USE timing ! Timing
	54	USE sbcwave ! Wave module
[5501]	55	USE bdy_par ! Require lk_bdy
[888]	56
[11738]	57	USE yomhook, ONLY: lhook, dr_hook
	58	USE parkind1, ONLY: jprb, jpim
	59
[888]	60	IMPLICIT NONE
	61	PRIVATE
	62
	63	PUBLIC sbc ! routine called by step.F90
[1725]	64	PUBLIC sbc_init ! routine called by opa.F90
[888]	65
	66	INTEGER :: nsbc ! type of surface boundary condition (deduced from namsbc informations)
	67
	68	!! * Substitutions
	69	# include "domzgr_substitute.h90"
	70	!!----------------------------------------------------------------------
[2715]	71	!! NEMO/OPA 4.0 , NEMO-consortium (2011)
[1146]	72	!! $Id$
[2715]	73	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[888]	74	!!----------------------------------------------------------------------
	75	CONTAINS
	76
	77	SUBROUTINE sbc_init
	78	!!---------------------------------------------------------------------
	79	!! * ROUTINE sbc_init *
	80	!!
	81	!! ** Purpose : Initialisation of the ocean surface boundary computation
	82	!!
	83	!! ** Method : Read the namsbc namelist and set derived parameters
[3607]	84	!! Call init routines for all other SBC modules that have one
[888]	85	!!
	86	!! ** Action : - read namsbc parameters
	87	!! - nsbc: type of sbc
	88	!!----------------------------------------------------------------------
[2715]	89	INTEGER :: icpt ! local integer
[1037]	90	!!
[5407]	91	NAMELIST/namsbc/ nn_fsbc , ln_ana , ln_flx, ln_blk_clio, ln_blk_core, ln_mixcpl, &
	92	& ln_blk_mfs, ln_apr_dyn, nn_ice, nn_ice_embd, ln_dm2dc , ln_rnf , &
	93	& ln_ssr , nn_isf , nn_fwb, ln_cdgw , ln_wave , ln_sdw , &
	94	& nn_lsm , nn_limflx , nn_components, ln_cpl
[4147]	95	INTEGER :: ios
[5407]	96	INTEGER :: ierr, ierr0, ierr1, ierr2, ierr3, jpm
	97	LOGICAL :: ll_purecpl
[11738]	98	INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
	99	INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
	100	REAL(KIND=jprb) :: zhook_handle
	101
	102	CHARACTER(LEN=*), PARAMETER :: RoutineName='SBC_INIT'
	103
	104	IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
	105
[1037]	106	!!----------------------------------------------------------------------
[888]	107
	108	IF(lwp) THEN
	109	WRITE(numout,*)
	110	WRITE(numout,*) 'sbc_init : surface boundary condition setting'
	111	WRITE(numout,*) '~~~~~~~~ '
	112	ENDIF
	113
[4147]	114	REWIND( numnam_ref ) ! Namelist namsbc in reference namelist : Surface boundary
	115	READ ( numnam_ref, namsbc, IOSTAT = ios, ERR = 901)
	116	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc in reference namelist', lwp )
[888]	117
[4147]	118	REWIND( numnam_cfg ) ! Namelist namsbc in configuration namelist : Parameters of the run
	119	READ ( numnam_cfg, namsbc, IOSTAT = ios, ERR = 902 )
	120	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namsbc in configuration namelist', lwp )
[4624]	121	IF(lwm) WRITE ( numond, namsbc )
[4147]	122
[2528]	123	! ! overwrite namelist parameter using CPP key information
	124	IF( Agrif_Root() ) THEN ! AGRIF zoom
	125	IF( lk_lim2 ) nn_ice = 2
	126	IF( lk_lim3 ) nn_ice = 3
[3294]	127	IF( lk_cice ) nn_ice = 4
[1242]	128	ENDIF
[2528]	129	IF( cp_cfg == 'gyre' ) THEN ! GYRE configuration
[888]	130	ln_ana = .TRUE.
	131	nn_ice = 0
	132	ENDIF
[5407]	133
[2528]	134	IF(lwp) THEN ! Control print
[1218]	135	WRITE(numout,*) ' Namelist namsbc (partly overwritten with CPP key setting)'
[888]	136	WRITE(numout,*) ' frequency update of sbc (and ice) nn_fsbc = ', nn_fsbc
	137	WRITE(numout,*) ' Type of sbc : '
	138	WRITE(numout,*) ' analytical formulation ln_ana = ', ln_ana
	139	WRITE(numout,*) ' flux formulation ln_flx = ', ln_flx
	140	WRITE(numout,*) ' CLIO bulk formulation ln_blk_clio = ', ln_blk_clio
[3294]	141	WRITE(numout,*) ' CORE bulk formulation ln_blk_core = ', ln_blk_core
	142	WRITE(numout,*) ' MFS bulk formulation ln_blk_mfs = ', ln_blk_mfs
[5407]	143	WRITE(numout,*) ' ocean-atmosphere coupled formulation ln_cpl = ', ln_cpl
	144	WRITE(numout,*) ' forced-coupled mixed formulation ln_mixcpl = ', ln_mixcpl
	145	WRITE(numout,*) ' OASIS coupling (with atm or sas) lk_oasis = ', lk_oasis
	146	WRITE(numout,*) ' components of your executable nn_components = ', nn_components
[4990]	147	WRITE(numout,*) ' Multicategory heat flux formulation (LIM3) nn_limflx = ', nn_limflx
[888]	148	WRITE(numout,*) ' Misc. options of sbc : '
[2528]	149	WRITE(numout,*) ' Patm gradient added in ocean & ice Eqs. ln_apr_dyn = ', ln_apr_dyn
[1037]	150	WRITE(numout,*) ' ice management in the sbc (=0/1/2/3) nn_ice = ', nn_ice
[3625]	151	WRITE(numout,*) ' ice-ocean embedded/levitating (=0/1/2) nn_ice_embd = ', nn_ice_embd
[888]	152	WRITE(numout,*) ' daily mean to diurnal cycle qsr ln_dm2dc = ', ln_dm2dc
	153	WRITE(numout,*) ' runoff / runoff mouths ln_rnf = ', ln_rnf
[4990]	154	WRITE(numout,*) ' iceshelf formulation nn_isf = ', nn_isf
[888]	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
[1601]	157	WRITE(numout,*) ' closed sea (=0/1) (set in namdom) nn_closea = ', nn_closea
[4230]	158	WRITE(numout,*) ' n. of iterations if land-sea-mask applied nn_lsm = ', nn_lsm
[888]	159	ENDIF
	160
[4990]	161	! LIM3 Multi-category heat flux formulation
	162	SELECT CASE ( nn_limflx)
	163	CASE ( -1 )
	164	IF(lwp) WRITE(numout,*) ' Use of per-category fluxes (nn_limflx = -1) '
	165	CASE ( 0 )
	166	IF(lwp) WRITE(numout,*) ' Average per-category fluxes (nn_limflx = 0) '
	167	CASE ( 1 )
	168	IF(lwp) WRITE(numout,*) ' Average then redistribute per-category fluxes (nn_limflx = 1) '
	169	CASE ( 2 )
	170	IF(lwp) WRITE(numout,*) ' Redistribute a single flux over categories (nn_limflx = 2) '
[4161]	171	END SELECT
	172	!
[5407]	173	IF ( nn_components /= jp_iam_nemo .AND. .NOT. lk_oasis ) &
	174	& CALL ctl_stop( 'STOP', 'sbc_init : OPA-SAS coupled via OASIS, but key_oasis3 disabled' )
	175	IF ( nn_components == jp_iam_opa .AND. ln_cpl ) &
	176	& CALL ctl_stop( 'STOP', 'sbc_init : OPA-SAS coupled via OASIS, but ln_cpl = T in OPA' )
	177	IF ( nn_components == jp_iam_opa .AND. ln_mixcpl ) &
	178	& CALL ctl_stop( 'STOP', 'sbc_init : OPA-SAS coupled via OASIS, but ln_mixcpl = T in OPA' )
	179	IF ( ln_cpl .AND. .NOT. lk_oasis ) &
	180	& CALL ctl_stop( 'STOP', 'sbc_init : OASIS-coupled atmosphere model, but key_oasis3 disabled' )
	181	IF( ln_mixcpl .AND. .NOT. lk_oasis ) &
	182	& CALL ctl_stop( 'the forced-coupled mixed mode (ln_mixcpl) requires the cpp key key_oasis3' )
	183	IF( ln_mixcpl .AND. .NOT. ln_cpl ) &
	184	& CALL ctl_stop( 'the forced-coupled mixed mode (ln_mixcpl) requires ln_cpl = T' )
	185	IF( ln_mixcpl .AND. nn_components /= jp_iam_nemo ) &
	186	& CALL ctl_stop( 'the forced-coupled mixed mode (ln_mixcpl) is not yet working with sas-opa coupling via oasis' )
	187
[2715]	188	! ! allocate sbc arrays
	189	IF( sbc_oce_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_oce arrays' )
	190
[2528]	191	! ! Checks:
[6487]	192	IF( nn_isf .EQ. 0 ) THEN ! variable initialisation if no ice shelf
[4990]	193	IF( sbc_isf_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_init : unable to allocate sbc_isf arrays' )
[6487]	194	fwfisf (:,:) = 0.0_wp ; fwfisf_b (:,:) = 0.0_wp
	195	risf_tsc(:,:,:) = 0.0_wp ; risf_tsc_b(:,:,:) = 0.0_wp
	196	rdivisf = 0.0_wp
[4990]	197	END IF
[5407]	198	IF( nn_ice == 0 .AND. nn_components /= jp_iam_opa ) fr_i(:,:) = 0.e0 ! no ice in the domain, ice fraction is always zero
[1037]	199
[3625]	200	sfx(:,:) = 0.0_wp ! the salt flux due to freezing/melting will be computed (i.e. will be non-zero)
	201	! only if sea-ice is present
[4148]	202
	203	fmmflx(:,:) = 0.0_wp ! freezing-melting array initialisation
[4822]	204
	205	taum(:,:) = 0.0_wp ! Initialise taum for use in gls in case of reduced restart
[3625]	206
[1218]	207	! ! restartability
[5407]	208	IF( ( nn_ice == 2 .OR. nn_ice ==3 ) .AND. .NOT.( ln_blk_clio .OR. ln_blk_core .OR. ln_cpl ) ) &
[3294]	209	& CALL ctl_stop( 'LIM sea-ice model requires a bulk formulation or coupled configuration' )
[5407]	210	IF( nn_ice == 4 .AND. .NOT.( ln_blk_core .OR. ln_cpl ) ) &
	211	& CALL ctl_stop( 'CICE sea-ice model requires ln_blk_core or ln_cpl' )
[3625]	212	IF( nn_ice == 4 .AND. lk_agrif ) &
	213	& CALL ctl_stop( 'CICE sea-ice model not currently available with AGRIF' )
	214	IF( ( nn_ice == 3 .OR. nn_ice == 4 ) .AND. nn_ice_embd == 0 ) &
[3740]	215	& CALL ctl_stop( 'LIM3 and CICE sea-ice models require nn_ice_embd = 1 or 2' )
[4990]	216	IF( ( nn_ice /= 3 ) .AND. ( nn_limflx >= 0 ) ) &
	217	& WRITE(numout,*) 'The nn_limflx>=0 option has no effect if sea ice model is not LIM3'
[5407]	218	IF( ( nn_ice == 3 ) .AND. ( ln_cpl ) .AND. ( ( nn_limflx == -1 ) .OR. ( nn_limflx == 1 ) ) ) &
[4990]	219	& CALL ctl_stop( 'The chosen nn_limflx for LIM3 in coupled mode must be 0 or 2' )
[5407]	220	IF( ( nn_ice == 3 ) .AND. ( .NOT. ln_cpl ) .AND. ( nn_limflx == 2 ) ) &
[4990]	221	& CALL ctl_stop( 'The chosen nn_limflx for LIM3 in forced mode cannot be 2' )
	222
[2528]	223	IF( ln_dm2dc ) nday_qsr = -1 ! initialisation flag
	224
[5407]	225	IF( ln_dm2dc .AND. .NOT.( ln_flx .OR. ln_blk_core ) .AND. nn_components /= jp_iam_opa ) &
[2528]	226	& CALL ctl_stop( 'diurnal cycle into qsr field from daily values requires a flux or core-bulk formulation' )
	227
[3680]	228	IF ( ln_wave ) THEN
	229	!Activated wave module but neither drag nor stokes drift activated
	230	IF ( .NOT.(ln_cdgw .OR. ln_sdw) ) THEN
	231	CALL ctl_warn( 'Ask for wave coupling but nor drag coefficient (ln_cdgw=F) neither stokes drift activated (ln_sdw=F)' )
	232	!drag coefficient read from wave model definable only with mfs bulk formulae and core
	233	ELSEIF (ln_cdgw .AND. .NOT.(ln_blk_mfs .OR. ln_blk_core) ) THEN
	234	CALL ctl_stop( 'drag coefficient read from wave model definable only with mfs bulk formulae and core')
	235	ENDIF
	236	ELSE
	237	IF ( ln_cdgw .OR. ln_sdw ) &
	238	& CALL ctl_stop('Not Activated Wave Module (ln_wave=F) but &
	239	& asked coupling with drag coefficient (ln_cdgw =T) or Stokes drift (ln_sdw=T) ')
	240	ENDIF
[2528]	241	! ! Choice of the Surface Boudary Condition (set nsbc)
[5407]	242	ll_purecpl = ln_cpl .AND. .NOT. ln_mixcpl
	243	!
[888]	244	icpt = 0
[5407]	245	IF( ln_ana ) THEN ; nsbc = jp_ana ; icpt = icpt + 1 ; ENDIF ! analytical formulation
	246	IF( ln_flx ) THEN ; nsbc = jp_flx ; icpt = icpt + 1 ; ENDIF ! flux formulation
	247	IF( ln_blk_clio ) THEN ; nsbc = jp_clio ; icpt = icpt + 1 ; ENDIF ! CLIO bulk formulation
	248	IF( ln_blk_core ) THEN ; nsbc = jp_core ; icpt = icpt + 1 ; ENDIF ! CORE bulk formulation
	249	IF( ln_blk_mfs ) THEN ; nsbc = jp_mfs ; icpt = icpt + 1 ; ENDIF ! MFS bulk formulation
	250	IF( ll_purecpl ) THEN ; nsbc = jp_purecpl ; icpt = icpt + 1 ; ENDIF ! Pure Coupled formulation
	251	IF( cp_cfg == 'gyre') THEN ; nsbc = jp_gyre ; ENDIF ! GYRE analytical formulation
	252	IF( nn_components == jp_iam_opa ) &
	253	& THEN ; nsbc = jp_none ; icpt = icpt + 1 ; ENDIF ! opa coupling via SAS module
	254	IF( lk_esopa ) nsbc = jp_esopa ! esopa test, ALL formulations
[2528]	255	!
[888]	256	IF( icpt /= 1 .AND. .NOT.lk_esopa ) THEN
	257	WRITE(numout,*)
	258	WRITE(numout,*) ' E R R O R in setting the sbc, one and only one namelist/CPP key option '
	259	WRITE(numout,*) ' must be choosen. You choose ', icpt, ' option(s)'
	260	WRITE(numout,*) ' We stop'
	261	nstop = nstop + 1
	262	ENDIF
	263	IF(lwp) THEN
	264	WRITE(numout,*)
[5407]	265	IF( nsbc == jp_esopa ) WRITE(numout,*) ' ESOPA test All surface boundary conditions'
	266	IF( nsbc == jp_gyre ) WRITE(numout,*) ' GYRE analytical formulation'
	267	IF( nsbc == jp_ana ) WRITE(numout,*) ' analytical formulation'
	268	IF( nsbc == jp_flx ) WRITE(numout,*) ' flux formulation'
	269	IF( nsbc == jp_clio ) WRITE(numout,*) ' CLIO bulk formulation'
	270	IF( nsbc == jp_core ) WRITE(numout,*) ' CORE bulk formulation'
	271	IF( nsbc == jp_purecpl ) WRITE(numout,*) ' pure coupled formulation'
	272	IF( nsbc == jp_mfs ) WRITE(numout,*) ' MFS Bulk formulation'
	273	IF( nsbc == jp_none ) WRITE(numout,*) ' OPA coupled to SAS via oasis'
	274	IF( ln_mixcpl ) WRITE(numout,*) ' + forced-coupled mixed formulation'
	275	IF( nn_components/= jp_iam_nemo ) &
	276	& WRITE(numout,*) ' + OASIS coupled SAS'
[888]	277	ENDIF
	278	!
[8280]	279	IF( lk_oasis ) THEN
	280	IF( sbc_cpl_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'sbc_cpl_alloc : unable to allocate arrays' )
	281	CALL sbc_cpl_init (nn_ice) ! OASIS initialisation. must be done before: (1) first time step
	282	! (2) the use of nn_fsbc
	283	ENDIF
[5407]	284
	285	! nn_fsbc initialization if OPA-SAS coupling via OASIS
	286	! sas model time step has to be declared in OASIS (mandatory) -> nn_fsbc has to be modified accordingly
	287	IF ( nn_components /= jp_iam_nemo ) THEN
	288
	289	IF ( nn_components == jp_iam_opa ) nn_fsbc = cpl_freq('O_SFLX') / NINT(rdt)
	290	IF ( nn_components == jp_iam_sas ) nn_fsbc = cpl_freq('I_SFLX') / NINT(rdt)
	291	!
	292	IF(lwp)THEN
	293	WRITE(numout,*)
	294	WRITE(numout,*)" OPA-SAS coupled via OASIS : nn_fsbc re-defined from OASIS namcouple ", nn_fsbc
	295	WRITE(numout,*)
	296	ENDIF
	297	ENDIF
	298
	299	IF( MOD( nitend - nit000 + 1, nn_fsbc) /= 0 .OR. &
	300	MOD( nstock , nn_fsbc) /= 0 ) THEN
	301	WRITE(ctmp1,*) 'experiment length (', nitend - nit000 + 1, ') or nstock (', nstock, &
	302	& ' is NOT a multiple of nn_fsbc (', nn_fsbc, ')'
	303	CALL ctl_stop( ctmp1, 'Impossible to properly do model restart' )
	304	ENDIF
	305	!
	306	IF( MOD( rday, REAL(nn_fsbc, wp) * rdt ) /= 0 ) &
	307	& CALL ctl_warn( 'nn_fsbc is NOT a multiple of the number of time steps in a day' )
	308	!
	309	IF( ln_dm2dc .AND. ( ( NINT(rday) / ( nn_fsbc * NINT(rdt) ) ) < 8 ) ) &
	310	& CALL ctl_warn( 'diurnal cycle for qsr: the sampling of the diurnal cycle is too small...' )
	311
[4990]	312	CALL sbc_ssm_init ! Sea-surface mean fields initialisation
[4152]	313	!
[4990]	314	IF( ln_ssr ) CALL sbc_ssr_init ! Sea-Surface Restoring initialisation
[3764]	315	!
[5431]	316	CALL sbc_rnf_init ! Runof initialisation
[5385]	317	!
[5123]	318	IF( nn_ice == 3 ) CALL sbc_lim_init ! LIM3 initialisation
	319
[4990]	320	IF( nn_ice == 4 ) CALL cice_sbc_init( nsbc ) ! CICE initialisation
[5385]	321
[11738]	322	IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
[888]	323	END SUBROUTINE sbc_init
	324
	325
	326	SUBROUTINE sbc( kt )
	327	!!---------------------------------------------------------------------
	328	!! * ROUTINE sbc *
	329	!!
	330	!! ** Purpose : provide at each time-step the ocean surface boundary
	331	!! condition (momentum, heat and freshwater fluxes)
	332	!!
	333	!! ** Method : blah blah to be written ?????????
	334	!! CAUTION : never mask the surface stress field (tke sbc)
	335	!!
[2528]	336	!! ** Action : - set the ocean surface boundary condition at before and now
	337	!! time step, i.e.
[3625]	338	!! utau_b, vtau_b, qns_b, qsr_b, emp_n, sfx_b, qrp_b, erp_b
	339	!! utau , vtau , qns , qsr , emp , sfx , qrp , erp
[1037]	340	!! - updte the ice fraction : fr_i
[888]	341	!!----------------------------------------------------------------------
	342	INTEGER, INTENT(in) :: kt ! ocean time step
[11738]	343	INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
	344	INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
	345	REAL(KIND=jprb) :: zhook_handle
	346
	347	CHARACTER(LEN=*), PARAMETER :: RoutineName='SBC'
	348
	349	IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
	350
[888]	351	!!---------------------------------------------------------------------
[3294]	352	!
	353	IF( nn_timing == 1 ) CALL timing_start('sbc')
	354	!
[2528]	355	! ! ---------------------------------------- !
	356	IF( kt /= nit000 ) THEN ! Swap of forcing fields !
	357	! ! ---------------------------------------- !
	358	utau_b(:,:) = utau(:,:) ! Swap the ocean forcing fields
	359	vtau_b(:,:) = vtau(:,:) ! (except at nit000 where before fields
	360	qns_b (:,:) = qns (:,:) ! are set at the end of the routine)
	361	! The 3D heat content due to qsr forcing is treated in traqsr
	362	! qsr_b (:,:) = qsr (:,:)
[3625]	363	emp_b(:,:) = emp(:,:)
	364	sfx_b(:,:) = sfx(:,:)
[7993]	365	IF ( ln_rnf ) THEN
	366	rnf_b (:,: ) = rnf (:,: )
	367	rnf_tsc_b(:,:,:) = rnf_tsc(:,:,:)
	368	ENDIF
[2528]	369	ENDIF
	370	! ! ---------------------------------------- !
	371	! ! forcing field computation !
	372	! ! ---------------------------------------- !
[1482]	373	!
[5501]	374	IF ( .NOT. lk_bdy ) then
	375	IF( ln_apr_dyn ) CALL sbc_apr( kt ) ! atmospheric pressure provided at kt+0.5*nn_fsbc
	376	ENDIF
[2528]	377	! (caution called before sbc_ssm)
	378	!
[5407]	379	IF( nn_components /= jp_iam_sas ) CALL sbc_ssm( kt ) ! ocean sea surface variables (sst_m, sss_m, ssu_m, ssv_m)
	380	! ! averaged over nf_sbc time-step
[888]	381
[3680]	382	IF (ln_wave) CALL sbc_wave( kt )
[2528]	383	!== sbc formulation ==!
	384
	385	SELECT CASE( nsbc ) ! Compute ocean surface boundary condition
[3625]	386	! ! (i.e. utau,vtau, qns, qsr, emp, sfx)
[4990]	387	CASE( jp_gyre ) ; CALL sbc_gyre ( kt ) ! analytical formulation : GYRE configuration
	388	CASE( jp_ana ) ; CALL sbc_ana ( kt ) ! analytical formulation : uniform sbc
	389	CASE( jp_flx ) ; CALL sbc_flx ( kt ) ! flux formulation
	390	CASE( jp_clio ) ; CALL sbc_blk_clio( kt ) ! bulk formulation : CLIO for the ocean
[5407]	391	CASE( jp_core )
	392	IF( nn_components == jp_iam_sas ) &
	393	& CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: SAS receiving fields from OPA
	394	CALL sbc_blk_core( kt ) ! bulk formulation : CORE for the ocean
	395	! from oce: sea surface variables (sst_m, sss_m, ssu_m, ssv_m)
	396	CASE( jp_purecpl ) ; CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! pure coupled formulation
	397	!
[4990]	398	CASE( jp_mfs ) ; CALL sbc_blk_mfs ( kt ) ! bulk formulation : MFS for the ocean
[5407]	399	CASE( jp_none )
	400	IF( nn_components == jp_iam_opa ) &
	401	CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! OPA-SAS coupling: OPA receiving fields from SAS
[4990]	402	CASE( jp_esopa )
	403	CALL sbc_ana ( kt ) ! ESOPA, test ALL the formulations
	404	CALL sbc_gyre ( kt ) !
	405	CALL sbc_flx ( kt ) !
	406	CALL sbc_blk_clio( kt ) !
	407	CALL sbc_blk_core( kt ) !
	408	CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) !
[888]	409	END SELECT
	410
[5407]	411	IF( ln_mixcpl ) CALL sbc_cpl_rcv ( kt, nn_fsbc, nn_ice ) ! forced-coupled mixed formulation after forcing
	412
	413
[2528]	414	! !== Misc. Options ==!
[888]	415
[3632]	416	SELECT CASE( nn_ice ) ! Update heat and freshwater fluxes over sea-ice areas
	417	CASE( 1 ) ; CALL sbc_ice_if ( kt ) ! Ice-cover climatology ("Ice-if" model)
	418	CASE( 2 ) ; CALL sbc_ice_lim_2( kt, nsbc ) ! LIM-2 ice model
	419	CASE( 3 ) ; CALL sbc_ice_lim ( kt, nsbc ) ! LIM-3 ice model
[4205]	420	CASE( 4 ) ; CALL sbc_ice_cice ( kt, nsbc ) ! CICE ice model
[1037]	421	END SELECT
[888]	422
[3632]	423	IF( ln_icebergs ) CALL icb_stp( kt ) ! compute icebergs
[3609]	424
[4990]	425	IF( nn_isf /= 0 ) CALL sbc_isf( kt ) ! compute iceshelves
	426
[3632]	427	IF( ln_rnf ) CALL sbc_rnf( kt ) ! add runoffs to fresh water fluxes
[1061]	428
[3632]	429	IF( ln_ssr ) CALL sbc_ssr( kt ) ! add SST/SSS damping term
[888]	430
[3632]	431	IF( nn_fwb /= 0 ) CALL sbc_fwb( kt, nn_fwb, nn_fsbc ) ! control the freshwater budget
[888]	432
[3632]	433	IF( nn_closea == 1 ) CALL sbc_clo( kt ) ! treatment of closed sea in the model domain
	434	! ! (update freshwater fluxes)
[2502]	435	!RBbug do not understand why see ticket 667
[5407]	436	!clem: it looks like it is necessary for the north fold (in certain circumstances). Don't know why.
	437	CALL lbc_lnk( emp, 'T', 1. )
[2502]	438	!
[2528]	439	IF( kt == nit000 ) THEN ! set the forcing field at nit000 - 1 !
	440	! ! ---------------------------------------- !
	441	IF( ln_rstart .AND. & !* Restart: read in restart file
	442	& iom_varid( numror, 'utau_b', ldstop = .FALSE. ) > 0 ) THEN
	443	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields red in the restart file'
[9321]	444	IF(nn_timing == 2) CALL timing_start('iom_rstget')
[2528]	445	CALL iom_get( numror, jpdom_autoglo, 'utau_b', utau_b ) ! before i-stress (U-point)
	446	CALL iom_get( numror, jpdom_autoglo, 'vtau_b', vtau_b ) ! before j-stress (V-point)
	447	CALL iom_get( numror, jpdom_autoglo, 'qns_b' , qns_b ) ! before non solar heat flux (T-point)
	448	! The 3D heat content due to qsr forcing is treated in traqsr
[3625]	449	! CALL iom_get( numror, jpdom_autoglo, 'qsr_b' , qsr_b ) ! before solar heat flux (T-point)
	450	CALL iom_get( numror, jpdom_autoglo, 'emp_b', emp_b ) ! before freshwater flux (T-point)
	451	! To ensure restart capability with 3.3x/3.4 restart files !! to be removed in v3.6
	452	IF( iom_varid( numror, 'sfx_b', ldstop = .FALSE. ) > 0 ) THEN
	453	CALL iom_get( numror, jpdom_autoglo, 'sfx_b', sfx_b ) ! before salt flux (T-point)
	454	ELSE
	455	sfx_b (:,:) = sfx(:,:)
	456	ENDIF
[9321]	457	IF(nn_timing == 2) CALL timing_stop('iom_rstget')
[2528]	458	ELSE !* no restart: set from nit000 values
	459	IF(lwp) WRITE(numout,*) ' nit000-1 surface forcing fields set to nit000'
	460	utau_b(:,:) = utau(:,:)
	461	vtau_b(:,:) = vtau(:,:)
	462	qns_b (:,:) = qns (:,:)
[3625]	463	emp_b (:,:) = emp(:,:)
	464	sfx_b (:,:) = sfx(:,:)
[2528]	465	ENDIF
	466	ENDIF
	467	! ! ---------------------------------------- !
	468	IF( lrst_oce ) THEN ! Write in the ocean restart file !
	469	! ! ---------------------------------------- !
	470	IF(lwp) WRITE(numout,*)
	471	IF(lwp) WRITE(numout,*) 'sbc : ocean surface forcing fields written in ocean restart file ', &
	472	& 'at it= ', kt,' date= ', ndastp
	473	IF(lwp) WRITE(numout,*) '~~~~'
[9321]	474	IF(nn_timing == 2) CALL timing_start('iom_rstput')
[2528]	475	CALL iom_rstput( kt, nitrst, numrow, 'utau_b' , utau )
	476	CALL iom_rstput( kt, nitrst, numrow, 'vtau_b' , vtau )
	477	CALL iom_rstput( kt, nitrst, numrow, 'qns_b' , qns )
	478	! The 3D heat content due to qsr forcing is treated in traqsr
	479	! CALL iom_rstput( kt, nitrst, numrow, 'qsr_b' , qsr )
	480	CALL iom_rstput( kt, nitrst, numrow, 'emp_b' , emp )
[5407]	481	CALL iom_rstput( kt, nitrst, numrow, 'sfx_b' , sfx )
[9321]	482	IF(nn_timing == 2) CALL timing_stop('iom_rstput')
[2528]	483	ENDIF
	484
	485	! ! ---------------------------------------- !
	486	! ! Outputs and control print !
	487	! ! ---------------------------------------- !
[1482]	488	IF( MOD( kt-1, nn_fsbc ) == 0 ) THEN
[6498]	489	CALL iom_put( "empmr" , emp - rnf ) ! upward water flux
	490	CALL iom_put( "empbmr" , emp_b - rnf ) ! before upward water flux ( needed to recalculate the time evolution of ssh in offline )
[3625]	491	CALL iom_put( "saltflx", sfx ) ! downward salt flux
	492	! (includes virtual salt flux beneath ice
	493	! in linear free surface case)
[4148]	494	CALL iom_put( "fmmflx", fmmflx ) ! Freezing-melting water flux
[2561]	495	CALL iom_put( "qt" , qns + qsr ) ! total heat flux
	496	CALL iom_put( "qns" , qns ) ! solar heat flux
	497	CALL iom_put( "qsr" , qsr ) ! solar heat flux
[5407]	498	IF( nn_ice > 0 .OR. nn_components == jp_iam_opa ) CALL iom_put( "ice_cover", fr_i ) ! ice fraction
[4990]	499	CALL iom_put( "taum" , taum ) ! wind stress module
	500	CALL iom_put( "wspd" , wndm ) ! wind speed module over free ocean or leads in presence of sea-ice
[1482]	501	ENDIF
	502	!
	503	CALL iom_put( "utau", utau ) ! i-wind stress (stress can be updated at
	504	CALL iom_put( "vtau", vtau ) ! j-wind stress each time step in sea-ice)
	505	!
[888]	506	IF(ln_ctl) THEN ! print mean trends (used for debugging)
[4990]	507	CALL prt_ctl(tab2d_1=fr_i , clinfo1=' fr_i - : ', mask1=tmask, ovlap=1 )
	508	CALL prt_ctl(tab2d_1=(emp-rnf + fwfisf), clinfo1=' emp-rnf - : ', mask1=tmask, ovlap=1 )
	509	CALL prt_ctl(tab2d_1=(sfx-rnf + fwfisf), clinfo1=' sfx-rnf - : ', mask1=tmask, ovlap=1 )
[3294]	510	CALL prt_ctl(tab2d_1=qns , clinfo1=' qns - : ', mask1=tmask, ovlap=1 )
	511	CALL prt_ctl(tab2d_1=qsr , clinfo1=' qsr - : ', mask1=tmask, ovlap=1 )
	512	CALL prt_ctl(tab3d_1=tmask , clinfo1=' tmask - : ', mask1=tmask, ovlap=1, kdim=jpk )
	513	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_tem), clinfo1=' sst - : ', mask1=tmask, ovlap=1, kdim=1 )
	514	CALL prt_ctl(tab3d_1=tsn(:,:,:,jp_sal), clinfo1=' sss - : ', mask1=tmask, ovlap=1, kdim=1 )
	515	CALL prt_ctl(tab2d_1=utau , clinfo1=' utau - : ', mask1=umask, &
	516	& tab2d_2=vtau , clinfo2=' vtau - : ', mask2=vmask, ovlap=1 )
[888]	517	ENDIF
[3294]	518
	519	IF( kt == nitend ) CALL sbc_final ! Close down surface module if necessary
[888]	520	!
[3294]	521	IF( nn_timing == 1 ) CALL timing_stop('sbc')
	522	!
[11738]	523	IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
[888]	524	END SUBROUTINE sbc
	525
[3764]	526
[3294]	527	SUBROUTINE sbc_final
[11738]	528	INTEGER(KIND=jpim), PARAMETER :: zhook_in = 0
	529	INTEGER(KIND=jpim), PARAMETER :: zhook_out = 1
	530	REAL(KIND=jprb) :: zhook_handle
	531
	532	CHARACTER(LEN=*), PARAMETER :: RoutineName='SBC_FINAL'
	533
	534	IF (lhook) CALL dr_hook(RoutineName,zhook_in,zhook_handle)
	535
[3294]	536	!!---------------------------------------------------------------------
	537	!! * ROUTINE sbc_final *
[3764]	538	!!
	539	!! ** Purpose : Finalize CICE (if used)
[3294]	540	!!---------------------------------------------------------------------
[3764]	541	!
[3294]	542	IF( nn_ice == 4 ) CALL cice_sbc_final
	543	!
[11738]	544	IF (lhook) CALL dr_hook(RoutineName,zhook_out,zhook_handle)
[3294]	545	END SUBROUTINE sbc_final
	546
[888]	547	!!======================================================================
	548	END MODULE sbcmod

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

New URL for NEMO forge! http://forge.nemo-ocean.eu

Context Navigation

source: branches/UKMO/dev_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/SBC/sbcmod.F90 @ 11738

Download in other formats: