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.

dynspg.F90 in NEMO/trunk/src/OCE/DYN – NEMO

Context Navigation

source: NEMO/trunk/src/OCE/DYN/dynspg.F90 @ 14110

Last change on this file since 14110 was 14072, checked in by laurent, 4 years ago
Merging branch "2020/dev_r13648_ASINTER-04_laurent_bulk_ice", ticket #2369
Property svn:keywords set to `Id`
File size: 12.7 KB

Rev	Line
[358]	1	MODULE dynspg
	2	!!======================================================================
	3	!! * MODULE dynspg *
	4	!! Ocean dynamics: surface pressure gradient control
	5	!!======================================================================
[1566]	6	!! History : 1.0 ! 2005-12 (C. Talandier, G. Madec, V. Garnier) Original code
	7	!! 3.2 ! 2009-07 (R. Benshila) Suppression of rigid-lid option
[14007]	8	!! 4.2 ! 2020-12 (G. Madec, E. Clementi) add Bernoulli Head for
	9	!! wave coupling
[503]	10	!!----------------------------------------------------------------------
[358]	11
	12	!!----------------------------------------------------------------------
[14072]	13	!! dyn_spg : update the dynamics trend with surface pressure gradient
[5930]	14	!! dyn_spg_init: initialization, namelist read, and parameters control
[358]	15	!!----------------------------------------------------------------------
	16	USE oce ! ocean dynamics and tracers variables
	17	USE dom_oce ! ocean space and time domain variables
[4245]	18	USE c1d ! 1D vertical configuration
[2715]	19	USE phycst ! physical constants
[2528]	20	USE sbc_oce ! surface boundary condition: ocean
[9019]	21	USE sbc_ice , ONLY : snwice_mass, snwice_mass_b
[2528]	22	USE sbcapr ! surface boundary condition: atmospheric pressure
[14007]	23	USE sbcwave, ONLY : bhd_wave
[358]	24	USE dynspg_exp ! surface pressure gradient (dyn_spg_exp routine)
	25	USE dynspg_ts ! surface pressure gradient (dyn_spg_ts routine)
[12377]	26	USE tide_mod !
[4990]	27	USE trd_oce ! trends: ocean variables
	28	USE trddyn ! trend manager: dynamics
	29	!
[358]	30	USE prtctl ! Print control (prt_ctl routine)
	31	USE in_out_manager ! I/O manager
[2715]	32	USE lib_mpp ! MPP library
[4990]	33	USE timing ! Timing
[358]	34
	35	IMPLICIT NONE
	36	PRIVATE
	37
[2528]	38	PUBLIC dyn_spg ! routine called by step module
	39	PUBLIC dyn_spg_init ! routine called by opa module
[358]	40
[14072]	41	INTEGER :: nspg = 0 ! type of surface pressure gradient scheme defined from lk_dynspg_...
[358]	42
[6140]	43	! ! Parameter to control the surface pressure gradient scheme
	44	INTEGER, PARAMETER :: np_TS = 1 ! split-explicit time stepping (Time-Splitting)
	45	INTEGER, PARAMETER :: np_EXP = 0 ! explicit time stepping
	46	INTEGER, PARAMETER :: np_NO =-1 ! no surface pressure gradient, no scheme
[12377]	47	!
	48	REAL(wp) :: zt0step ! Time of day at the beginning of the time step
[6140]	49
[358]	50	!! * Substitutions
[12377]	51	# include "do_loop_substitute.h90"
[358]	52	!!----------------------------------------------------------------------
[9598]	53	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[14072]	54	!! $Id$
[10068]	55	!! Software governed by the CeCILL license (see ./LICENSE)
[358]	56	!!----------------------------------------------------------------------
	57	CONTAINS
	58
[12377]	59	SUBROUTINE dyn_spg( kt, Kbb, Kmm, Krhs, puu, pvv, pssh, puu_b, pvv_b, Kaa )
[358]	60	!!----------------------------------------------------------------------
	61	!! * ROUTINE dyn_spg *
	62	!!
[14072]	63	!! ** Purpose : compute surface pressure gradient including the
[6140]	64	!! atmospheric pressure forcing (ln_apr_dyn=T).
[1566]	65	!!
[5930]	66	!! ** Method : Two schemes:
[6140]	67	!! - explicit : the spg is evaluated at now
	68	!! - split-explicit : a time splitting technique is used
[1566]	69	!!
[14072]	70	!! ln_apr_dyn=T : the atmospheric pressure forcing is applied
[2528]	71	!! as the gradient of the inverse barometer ssh:
[12489]	72	!! apgu = - 1/rho0 di[apr] = 0.5*grav di[ssh_ib+ssh_ibb]
	73	!! apgv = - 1/rho0 dj[apr] = 0.5*grav dj[ssh_ib+ssh_ibb]
	74	!! Note that as all external forcing a time averaging over a two rn_Dt
[2528]	75	!! period is used to prevent the divergence of odd and even time step.
[358]	76	!!----------------------------------------------------------------------
[12377]	77	INTEGER , INTENT( in ) :: kt ! ocean time-step index
	78	INTEGER , INTENT( in ) :: Kbb, Kmm, Krhs, Kaa ! ocean time level indices
	79	REAL(wp), DIMENSION(jpi,jpj,jpk,jpt), INTENT(inout) :: puu, pvv ! ocean velocities and RHS of momentum equation
	80	REAL(wp), DIMENSION(jpi,jpj,jpt) , INTENT(inout) :: pssh, puu_b, pvv_b ! SSH and barotropic velocities at main time levels
[2715]	81	!
[9019]	82	INTEGER :: ji, jj, jk ! dummy loop indices
[12489]	83	REAL(wp) :: z2dt, zg_2, zintp, zgrho0r, zld ! local scalars
[14064]	84	REAL(wp) , DIMENSION(jpi,jpj) :: zpgu, zpgv ! 2D workspace
	85	REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: zpice
	86	REAL(wp), ALLOCATABLE, DIMENSION(:,:,:) :: ztrdu, ztrdv
[358]	87	!!----------------------------------------------------------------------
[3294]	88	!
[9019]	89	IF( ln_timing ) CALL timing_start('dyn_spg')
[3294]	90	!
[358]	91	IF( l_trddyn ) THEN ! temporary save of ta and sa trends
[14072]	92	ALLOCATE( ztrdu(jpi,jpj,jpk) , ztrdv(jpi,jpj,jpk) )
[12377]	93	ztrdu(:,:,:) = puu(:,:,:,Krhs)
	94	ztrdv(:,:,:) = pvv(:,:,:,Krhs)
[358]	95	ENDIF
[6140]	96	!
[4292]	97	IF( ln_apr_dyn & ! atmos. pressure
[7646]	98	.OR. ( .NOT.ln_dynspg_ts .AND. (ln_tide_pot .AND. ln_tide) ) & ! tide potential (no time slitting)
[9019]	99	.OR. ln_ice_embd ) THEN ! embedded sea-ice
[4292]	100	!
[13295]	101	DO_2D( 0, 0, 0, 0 )
[14064]	102	zpgu(ji,jj) = 0._wp
	103	zpgv(ji,jj) = 0._wp
[12377]	104	END_2D
[4292]	105	!
[6140]	106	IF( ln_apr_dyn .AND. .NOT.ln_dynspg_ts ) THEN !== Atmospheric pressure gradient (added later in time-split case) ==!
[4292]	107	zg_2 = grav * 0.5
[13497]	108	DO_2D( 0, 0, 0, 0 ) ! gradient of Patm using inverse barometer ssh
[14064]	109	zpgu(ji,jj) = zpgu(ji,jj) + zg_2 * ( ssh_ib (ji+1,jj) - ssh_ib (ji,jj) &
[12377]	110	& + ssh_ibb(ji+1,jj) - ssh_ibb(ji,jj) ) * r1_e1u(ji,jj)
[14064]	111	zpgv(ji,jj) = zpgv(ji,jj) + zg_2 * ( ssh_ib (ji,jj+1) - ssh_ib (ji,jj) &
[12377]	112	& + ssh_ibb(ji,jj+1) - ssh_ibb(ji,jj) ) * r1_e2v(ji,jj)
	113	END_2D
[4292]	114	ENDIF
	115	!
	116	! !== tide potential forcing term ==!
[7646]	117	IF( .NOT.ln_dynspg_ts .AND. ( ln_tide_pot .AND. ln_tide ) ) THEN ! N.B. added directly at sub-time-step in ts-case
[4292]	118	!
[12377]	119	! Update tide potential at the beginning of current time step
[12489]	120	zt0step = REAL(nsec_day, wp)-0.5_wp*rn_Dt
[12377]	121	CALL upd_tide(zt0step, Kmm)
[4292]	122	!
[13497]	123	DO_2D( 0, 0, 0, 0 ) ! add tide potential forcing
[14064]	124	zpgu(ji,jj) = zpgu(ji,jj) + grav * ( pot_astro(ji+1,jj) - pot_astro(ji,jj) ) * r1_e1u(ji,jj)
	125	zpgv(ji,jj) = zpgv(ji,jj) + grav * ( pot_astro(ji,jj+1) - pot_astro(ji,jj) ) * r1_e2v(ji,jj)
[12377]	126	END_2D
[9023]	127	!
	128	IF (ln_scal_load) THEN
	129	zld = rn_scal_load * grav
[13497]	130	DO_2D( 0, 0, 0, 0 ) ! add scalar approximation for load potential
[14064]	131	zpgu(ji,jj) = zpgu(ji,jj) + zld * ( pssh(ji+1,jj,Kmm) - pssh(ji,jj,Kmm) ) * r1_e1u(ji,jj)
	132	zpgv(ji,jj) = zpgv(ji,jj) + zld * ( pssh(ji,jj+1,Kmm) - pssh(ji,jj,Kmm) ) * r1_e2v(ji,jj)
[12377]	133	END_2D
[9023]	134	ENDIF
[4292]	135	ENDIF
	136	!
[9019]	137	IF( ln_ice_embd ) THEN !== embedded sea ice: Pressure gradient due to snow-ice mass ==!
	138	ALLOCATE( zpice(jpi,jpj) )
[4292]	139	zintp = REAL( MOD( kt-1, nn_fsbc ) ) / REAL( nn_fsbc )
[12489]	140	zgrho0r = - grav * r1_rho0
	141	zpice(:,:) = ( zintp * snwice_mass(:,:) + ( 1.- zintp ) * snwice_mass_b(:,:) ) * zgrho0r
[13295]	142	DO_2D( 0, 0, 0, 0 )
[14064]	143	zpgu(ji,jj) = zpgu(ji,jj) + ( zpice(ji+1,jj) - zpice(ji,jj) ) * r1_e1u(ji,jj)
	144	zpgv(ji,jj) = zpgv(ji,jj) + ( zpice(ji,jj+1) - zpice(ji,jj) ) * r1_e2v(ji,jj)
[12377]	145	END_2D
[14072]	146	DEALLOCATE( zpice )
[4292]	147	ENDIF
	148	!
[14007]	149	IF( ln_wave .and. ln_bern_srfc ) THEN !== Add J terms: depth-independent Bernoulli head
	150	DO_2D( 0, 0, 0, 0 )
[14064]	151	zpgu(ji,jj) = zpgu(ji,jj) + ( bhd_wave(ji+1,jj) - bhd_wave(ji,jj) ) / e1u(ji,jj) !++ bhd_wave from wave model in m2/s2 [BHD parameters in WW3]
	152	zpgv(ji,jj) = zpgv(ji,jj) + ( bhd_wave(ji,jj+1) - bhd_wave(ji,jj) ) / e2v(ji,jj)
[14007]	153	END_2D
	154	ENDIF
	155	!
[13497]	156	DO_3D( 0, 0, 0, 0, 1, jpkm1 ) !== Add all terms to the general trend
[14064]	157	puu(ji,jj,jk,Krhs) = puu(ji,jj,jk,Krhs) + zpgu(ji,jj)
	158	pvv(ji,jj,jk,Krhs) = pvv(ji,jj,jk,Krhs) + zpgv(ji,jj)
[12377]	159	END_3D
[6140]	160	!
[4990]	161	!!gm add here a call to dyn_trd for ice pressure gradient, the surf pressure trends ????
[14072]	162	!
[3625]	163	ENDIF
[6140]	164	!
	165	SELECT CASE ( nspg ) !== surface pressure gradient computed and add to the general trend ==!
[12377]	166	CASE ( np_EXP ) ; CALL dyn_spg_exp( kt, Kmm, puu, pvv, Krhs ) ! explicit
	167	CASE ( np_TS ) ; CALL dyn_spg_ts ( kt, Kbb, Kmm, Krhs, puu, pvv, pssh, puu_b, pvv_b, Kaa ) ! time-splitting
[358]	168	END SELECT
[14072]	169	!
[6140]	170	IF( l_trddyn ) THEN ! save the surface pressure gradient trends for further diagnostics
[12377]	171	ztrdu(:,:,:) = puu(:,:,:,Krhs) - ztrdu(:,:,:)
	172	ztrdv(:,:,:) = pvv(:,:,:,Krhs) - ztrdv(:,:,:)
	173	CALL trd_dyn( ztrdu, ztrdv, jpdyn_spg, kt, Kmm )
[14072]	174	DEALLOCATE( ztrdu , ztrdv )
[358]	175	ENDIF
[6140]	176	! ! print mean trends (used for debugging)
[12377]	177	IF(sn_cfctl%l_prtctl) CALL prt_ctl( tab3d_1=puu(:,:,:,Krhs), clinfo1=' spg - Ua: ', mask1=umask, &
	178	& tab3d_2=pvv(:,:,:,Krhs), clinfo2= ' Va: ', mask2=vmask, clinfo3='dyn' )
[503]	179	!
[9019]	180	IF( ln_timing ) CALL timing_stop('dyn_spg')
[2715]	181	!
[358]	182	END SUBROUTINE dyn_spg
	183
	184
[2528]	185	SUBROUTINE dyn_spg_init
[358]	186	!!---------------------------------------------------------------------
[2528]	187	!! * ROUTINE dyn_spg_init *
[14072]	188	!!
	189	!! ** Purpose : Control the consistency between namelist options for
[1566]	190	!! surface pressure gradient schemes
[358]	191	!!----------------------------------------------------------------------
[6140]	192	INTEGER :: ioptio, ios ! local integers
[5930]	193	!
[6140]	194	NAMELIST/namdyn_spg/ ln_dynspg_exp , ln_dynspg_ts, &
	195	& ln_bt_fw, ln_bt_av , ln_bt_auto , &
[12489]	196	& nn_e , rn_bt_cmax, nn_bt_flt, rn_bt_alpha
[358]	197	!!----------------------------------------------------------------------
[3294]	198	!
[9169]	199	IF(lwp) THEN
	200	WRITE(numout,*)
	201	WRITE(numout,*) 'dyn_spg_init : choice of the surface pressure gradient scheme'
	202	WRITE(numout,*) '~~~~~~~~~~~~'
	203	ENDIF
	204	!
[5930]	205	READ ( numnam_ref, namdyn_spg, IOSTAT = ios, ERR = 901)
[11536]	206	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namdyn_spg in reference namelist' )
[6140]	207	!
[5930]	208	READ ( numnam_cfg, namdyn_spg, IOSTAT = ios, ERR = 902 )
[11536]	209	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namdyn_spg in configuration namelist' )
[5930]	210	IF(lwm) WRITE ( numond, namdyn_spg )
	211	!
	212	IF(lwp) THEN ! Namelist print
[9169]	213	WRITE(numout,*) ' Namelist : namdyn_spg '
	214	WRITE(numout,*) ' Explicit free surface ln_dynspg_exp = ', ln_dynspg_exp
	215	WRITE(numout,*) ' Free surface with time splitting ln_dynspg_ts = ', ln_dynspg_ts
[358]	216	ENDIF
[6140]	217	! ! Control of surface pressure gradient scheme options
[6981]	218	nspg = np_NO ; ioptio = 0
[6140]	219	IF( ln_dynspg_exp ) THEN ; nspg = np_EXP ; ioptio = ioptio + 1 ; ENDIF
	220	IF( ln_dynspg_ts ) THEN ; nspg = np_TS ; ioptio = ioptio + 1 ; ENDIF
[1566]	221	!
[6140]	222	IF( ioptio > 1 ) CALL ctl_stop( 'Choose only one surface pressure gradient scheme' )
	223	IF( ioptio == 0 ) CALL ctl_warn( 'NO surface pressure gradient trend in momentum Eqs.' )
	224	IF( ln_dynspg_exp .AND. ln_isfcav ) &
	225	& CALL ctl_stop( ' dynspg_exp not tested with ice shelf cavity ' )
[1566]	226	!
	227	IF(lwp) THEN
[358]	228	WRITE(numout,*)
[9190]	229	IF( nspg == np_EXP ) WRITE(numout,*) ' ==>>> explicit free surface'
	230	IF( nspg == np_TS ) WRITE(numout,*) ' ==>>> free surface with time splitting scheme'
	231	IF( nspg == np_NO ) WRITE(numout,*) ' ==>>> No surface surface pressure gradient trend in momentum Eqs.'
[358]	232	ENDIF
[1566]	233	!
[6140]	234	IF( nspg == np_TS ) THEN ! split-explicit scheme initialisation
[12489]	235	CALL dyn_spg_ts_init ! do it first: set nn_e used to allocate some arrays later on
[6140]	236	ENDIF
	237	!
[2528]	238	END SUBROUTINE dyn_spg_init
[358]	239
	240	!!======================================================================
	241	END MODULE dynspg

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

Download in other formats: