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.

domvvl.F90 in NEMO/trunk/src/OCE/DOM – NEMO

Context Navigation

source: NEMO/trunk/src/OCE/DOM/domvvl.F90 @ 13700

Last change on this file since 13700 was 13497, checked in by techene, 4 years ago
re-introduce comments that have been erased by loops transformation see #2525
Property svn:keywords set to `Id`
File size: 56.3 KB

Rev	Line
[592]	1	MODULE domvvl
	2	!!======================================================================
	3	!! * MODULE domvvl *
	4	!! Ocean :
	5	!!======================================================================
[1438]	6	!! History : 2.0 ! 2006-06 (B. Levier, L. Marie) original code
	7	!! 3.1 ! 2009-02 (G. Madec, M. Leclair, R. Benshila) pure z* coordinate
[9019]	8	!! 3.3 ! 2011-10 (M. Leclair) totally rewrote domvvl: vvl option includes z_star and z_tilde coordinates
[5120]	9	!! 3.6 ! 2014-11 (P. Mathiot) add ice shelf capability
[12377]	10	!! 4.1 ! 2019-08 (A. Coward, D. Storkey) rename dom_vvl_sf_swp -> dom_vvl_sf_update for new timestepping
[13237]	11	!! 4.x ! 2020-02 (G. Madec, S. Techene) introduce ssh to h0 ratio
[592]	12	!!----------------------------------------------------------------------
[5836]	13
[592]	14	USE oce ! ocean dynamics and tracers
[6140]	15	USE phycst ! physical constant
[592]	16	USE dom_oce ! ocean space and time domain
[4292]	17	USE sbc_oce ! ocean surface boundary condition
[6152]	18	USE wet_dry ! wetting and drying
[7646]	19	USE usrdef_istate ! user defined initial state (wad only)
[6140]	20	USE restart ! ocean restart
	21	!
[592]	22	USE in_out_manager ! I/O manager
[4292]	23	USE iom ! I/O manager library
[592]	24	USE lib_mpp ! distributed memory computing library
	25	USE lbclnk ! ocean lateral boundary conditions (or mpp link)
[3294]	26	USE timing ! Timing
[592]	27
	28	IMPLICIT NONE
	29	PRIVATE
	30
[5836]	31	! !!* Namelist nam_vvl
	32	LOGICAL , PUBLIC :: ln_vvl_zstar = .FALSE. ! zstar vertical coordinate
	33	LOGICAL , PUBLIC :: ln_vvl_ztilde = .FALSE. ! ztilde vertical coordinate
	34	LOGICAL , PUBLIC :: ln_vvl_layer = .FALSE. ! level vertical coordinate
	35	LOGICAL , PUBLIC :: ln_vvl_ztilde_as_zstar = .FALSE. ! ztilde vertical coordinate
	36	LOGICAL , PUBLIC :: ln_vvl_zstar_at_eqtor = .FALSE. ! ztilde vertical coordinate
	37	LOGICAL , PUBLIC :: ln_vvl_kepe = .FALSE. ! kinetic/potential energy transfer
	38	! ! conservation: not used yet
	39	REAL(wp) :: rn_ahe3 ! thickness diffusion coefficient
	40	REAL(wp) :: rn_rst_e3t ! ztilde to zstar restoration timescale [days]
	41	REAL(wp) :: rn_lf_cutoff ! cutoff frequency for low-pass filter [days]
	42	REAL(wp) :: rn_zdef_max ! maximum fractional e3t deformation
	43	LOGICAL , PUBLIC :: ln_vvl_dbg = .FALSE. ! debug control prints
[592]	44
[5836]	45	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: un_td, vn_td ! thickness diffusion transport
	46	REAL(wp) , ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: hdiv_lf ! low frequency part of hz divergence
	47	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tilde_e3t_b, tilde_e3t_n ! baroclinic scale factors
	48	REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) :: tilde_e3t_a, dtilde_e3t_a ! baroclinic scale factors
	49	REAL(wp) , ALLOCATABLE, SAVE, DIMENSION(:,:) :: frq_rst_e3t ! retoring period for scale factors
	50	REAL(wp) , ALLOCATABLE, SAVE, DIMENSION(:,:) :: frq_rst_hdv ! retoring period for low freq. divergence
[1438]	51
[13237]	52	#if defined key_qco
	53	!!----------------------------------------------------------------------
	54	!! 'key_qco' EMPTY MODULE Quasi-Eulerian vertical coordonate
	55	!!----------------------------------------------------------------------
	56	#else
	57	!!----------------------------------------------------------------------
	58	!! Default key Old management of time varying vertical coordinate
	59	!!----------------------------------------------------------------------
	60
	61	!!----------------------------------------------------------------------
	62	!! dom_vvl_init : define initial vertical scale factors, depths and column thickness
	63	!! dom_vvl_sf_nxt : Compute next vertical scale factors
	64	!! dom_vvl_sf_update : Swap vertical scale factors and update the vertical grid
	65	!! dom_vvl_interpol : Interpolate vertical scale factors from one grid point to another
	66	!! dom_vvl_rst : read/write restart file
	67	!! dom_vvl_ctl : Check the vvl options
	68	!!----------------------------------------------------------------------
	69
	70	PUBLIC dom_vvl_init ! called by domain.F90
	71	PUBLIC dom_vvl_zgr ! called by isfcpl.F90
	72	PUBLIC dom_vvl_sf_nxt ! called by step.F90
	73	PUBLIC dom_vvl_sf_update ! called by step.F90
	74	PUBLIC dom_vvl_interpol ! called by dynnxt.F90
	75
[592]	76	!! * Substitutions
[12377]	77	# include "do_loop_substitute.h90"
[592]	78	!!----------------------------------------------------------------------
[10068]	79	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[888]	80	!! $Id$
[10068]	81	!! Software governed by the CeCILL license (see ./LICENSE)
[592]	82	!!----------------------------------------------------------------------
[4292]	83	CONTAINS
	84
[2715]	85	INTEGER FUNCTION dom_vvl_alloc()
	86	!!----------------------------------------------------------------------
[4292]	87	!! * FUNCTION dom_vvl_alloc *
[2715]	88	!!----------------------------------------------------------------------
[6140]	89	IF( ln_vvl_zstar ) dom_vvl_alloc = 0
[4292]	90	IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
[4338]	91	ALLOCATE( tilde_e3t_b(jpi,jpj,jpk) , tilde_e3t_n(jpi,jpj,jpk) , tilde_e3t_a(jpi,jpj,jpk) , &
	92	& dtilde_e3t_a(jpi,jpj,jpk) , un_td (jpi,jpj,jpk) , vn_td (jpi,jpj,jpk) , &
	93	& STAT = dom_vvl_alloc )
[10425]	94	CALL mpp_sum ( 'domvvl', dom_vvl_alloc )
	95	IF( dom_vvl_alloc /= 0 ) CALL ctl_stop( 'STOP', 'dom_vvl_alloc: failed to allocate arrays' )
[6140]	96	un_td = 0._wp
	97	vn_td = 0._wp
[4292]	98	ENDIF
	99	IF( ln_vvl_ztilde ) THEN
	100	ALLOCATE( frq_rst_e3t(jpi,jpj) , frq_rst_hdv(jpi,jpj) , hdiv_lf(jpi,jpj,jpk) , STAT= dom_vvl_alloc )
[10425]	101	CALL mpp_sum ( 'domvvl', dom_vvl_alloc )
	102	IF( dom_vvl_alloc /= 0 ) CALL ctl_stop( 'STOP', 'dom_vvl_alloc: failed to allocate arrays' )
[4292]	103	ENDIF
[6140]	104	!
[2715]	105	END FUNCTION dom_vvl_alloc
	106
	107
[12377]	108	SUBROUTINE dom_vvl_init( Kbb, Kmm, Kaa )
[592]	109	!!----------------------------------------------------------------------
[4292]	110	!! * ROUTINE dom_vvl_init *
[592]	111	!!
[4292]	112	!! ** Purpose : Initialization of all scale factors, depths
	113	!! and water column heights
	114	!!
	115	!! ** Method : - use restart file and/or initialize
	116	!! - interpolate scale factors
	117	!!
[6140]	118	!! ** Action : - e3t_(n/b) and tilde_e3t_(n/b)
[12377]	119	!! - Regrid: e3[u/v](:,:,:,Kmm)
	120	!! e3[u/v](:,:,:,Kmm)
	121	!! e3w(:,:,:,Kmm)
	122	!! e3[u/v]w_b
	123	!! e3[u/v]w_n
	124	!! gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm) and gde3w
[4292]	125	!! - h(t/u/v)_0
	126	!! - frq_rst_e3t and frq_rst_hdv
	127	!!
	128	!! Reference : Leclair, M., and G. Madec, 2011, Ocean Modelling.
[592]	129	!!----------------------------------------------------------------------
[12377]	130	INTEGER, INTENT(in) :: Kbb, Kmm, Kaa
[6140]	131	!
[4292]	132	IF(lwp) WRITE(numout,*)
	133	IF(lwp) WRITE(numout,*) 'dom_vvl_init : Variable volume activated'
	134	IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~'
[6140]	135	!
	136	CALL dom_vvl_ctl ! choose vertical coordinate (z_star, z_tilde or layer)
	137	!
	138	! ! Allocate module arrays
[4292]	139	IF( dom_vvl_alloc() /= 0 ) CALL ctl_stop( 'STOP', 'dom_vvl_init : unable to allocate arrays' )
[6140]	140	!
	141	! ! Read or initialize e3t_(b/n), tilde_e3t_(b/n) and hdiv_lf
[12377]	142	CALL dom_vvl_rst( nit000, Kbb, Kmm, 'READ' )
	143	e3t(:,:,jpk,Kaa) = e3t_0(:,:,jpk) ! last level always inside the sea floor set one for all
[6140]	144	!
[12377]	145	CALL dom_vvl_zgr(Kbb, Kmm, Kaa) ! interpolation scale factor, depth and water column
	146	!
	147	END SUBROUTINE dom_vvl_init
[13237]	148
	149
[12377]	150	SUBROUTINE dom_vvl_zgr(Kbb, Kmm, Kaa)
	151	!!----------------------------------------------------------------------
	152	!! * ROUTINE dom_vvl_init *
	153	!!
	154	!! ** Purpose : Interpolation of all scale factors,
	155	!! depths and water column heights
	156	!!
	157	!! ** Method : - interpolate scale factors
	158	!!
	159	!! ** Action : - e3t_(n/b) and tilde_e3t_(n/b)
	160	!! - Regrid: e3(u/v)_n
	161	!! e3(u/v)_b
	162	!! e3w_n
	163	!! e3(u/v)w_b
	164	!! e3(u/v)w_n
	165	!! gdept_n, gdepw_n and gde3w_n
	166	!! - h(t/u/v)_0
	167	!! - frq_rst_e3t and frq_rst_hdv
	168	!!
	169	!! Reference : Leclair, M., and G. Madec, 2011, Ocean Modelling.
	170	!!----------------------------------------------------------------------
	171	INTEGER, INTENT(in) :: Kbb, Kmm, Kaa
	172	!!----------------------------------------------------------------------
	173	INTEGER :: ji, jj, jk
	174	INTEGER :: ii0, ii1, ij0, ij1
	175	REAL(wp):: zcoef
	176	!!----------------------------------------------------------------------
	177	!
[6140]	178	! !== Set of all other vertical scale factors ==! (now and before)
	179	! ! Horizontal interpolation of e3t
[12377]	180	CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3u(:,:,:,Kbb), 'U' ) ! from T to U
	181	CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3u(:,:,:,Kmm), 'U' )
	182	CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3v(:,:,:,Kbb), 'V' ) ! from T to V
	183	CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3v(:,:,:,Kmm), 'V' )
	184	CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F' ) ! from U to F
[6140]	185	! ! Vertical interpolation of e3t,u,v
[12377]	186	CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3w (:,:,:,Kmm), 'W' ) ! from T to W
	187	CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3w (:,:,:,Kbb), 'W' )
	188	CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3uw(:,:,:,Kmm), 'UW' ) ! from U to UW
	189	CALL dom_vvl_interpol( e3u(:,:,:,Kbb), e3uw(:,:,:,Kbb), 'UW' )
	190	CALL dom_vvl_interpol( e3v(:,:,:,Kmm), e3vw(:,:,:,Kmm), 'VW' ) ! from V to UW
	191	CALL dom_vvl_interpol( e3v(:,:,:,Kbb), e3vw(:,:,:,Kbb), 'VW' )
[9449]	192
	193	! We need to define e3[tuv]_a for AGRIF initialisation (should not be a problem for the restartability...)
[12377]	194	e3t(:,:,:,Kaa) = e3t(:,:,:,Kmm)
	195	e3u(:,:,:,Kaa) = e3u(:,:,:,Kmm)
	196	e3v(:,:,:,Kaa) = e3v(:,:,:,Kmm)
[6140]	197	!
	198	! !== depth of t and w-point ==! (set the isf depth as it is in the initial timestep)
[12377]	199	gdept(:,:,1,Kmm) = 0.5_wp * e3w(:,:,1,Kmm) ! reference to the ocean surface (used for MLD and light penetration)
	200	gdepw(:,:,1,Kmm) = 0.0_wp
	201	gde3w(:,:,1) = gdept(:,:,1,Kmm) - ssh(:,:,Kmm) ! reference to a common level z=0 for hpg
	202	gdept(:,:,1,Kbb) = 0.5_wp * e3w(:,:,1,Kbb)
	203	gdepw(:,:,1,Kbb) = 0.0_wp
[13497]	204	DO_3D( 1, 1, 1, 1, 2, jpk ) ! vertical sum
[12377]	205	! zcoef = tmask - wmask ! 0 everywhere tmask = wmask, ie everywhere expect at jk = mikt
	206	! ! 1 everywhere from mbkt to mikt + 1 or 1 (if no isf)
	207	! ! 0.5 where jk = mikt
	208	!!gm ??????? BUG ? gdept(:,:,:,Kmm) as well as gde3w does not include the thickness of ISF ??
	209	zcoef = ( tmask(ji,jj,jk) - wmask(ji,jj,jk) )
	210	gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm)
	211	gdept(ji,jj,jk,Kmm) = zcoef * ( gdepw(ji,jj,jk ,Kmm) + 0.5 * e3w(ji,jj,jk,Kmm)) &
	212	& + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) + e3w(ji,jj,jk,Kmm))
	213	gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm)
	214	gdepw(ji,jj,jk,Kbb) = gdepw(ji,jj,jk-1,Kbb) + e3t(ji,jj,jk-1,Kbb)
	215	gdept(ji,jj,jk,Kbb) = zcoef * ( gdepw(ji,jj,jk ,Kbb) + 0.5 * e3w(ji,jj,jk,Kbb)) &
	216	& + (1-zcoef) * ( gdept(ji,jj,jk-1,Kbb) + e3w(ji,jj,jk,Kbb))
	217	END_3D
[6140]	218	!
	219	! !== thickness of the water column !! (ocean portion only)
[12377]	220	ht(:,:) = e3t(:,:,1,Kmm) * tmask(:,:,1) !!gm BUG : this should be 1/2 * e3w(k=1) ....
	221	hu(:,:,Kbb) = e3u(:,:,1,Kbb) * umask(:,:,1)
	222	hu(:,:,Kmm) = e3u(:,:,1,Kmm) * umask(:,:,1)
	223	hv(:,:,Kbb) = e3v(:,:,1,Kbb) * vmask(:,:,1)
	224	hv(:,:,Kmm) = e3v(:,:,1,Kmm) * vmask(:,:,1)
[6140]	225	DO jk = 2, jpkm1
[12377]	226	ht(:,:) = ht(:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
	227	hu(:,:,Kbb) = hu(:,:,Kbb) + e3u(:,:,jk,Kbb) * umask(:,:,jk)
	228	hu(:,:,Kmm) = hu(:,:,Kmm) + e3u(:,:,jk,Kmm) * umask(:,:,jk)
	229	hv(:,:,Kbb) = hv(:,:,Kbb) + e3v(:,:,jk,Kbb) * vmask(:,:,jk)
	230	hv(:,:,Kmm) = hv(:,:,Kmm) + e3v(:,:,jk,Kmm) * vmask(:,:,jk)
[4370]	231	END DO
[6140]	232	!
	233	! !== inverse of water column thickness ==! (u- and v- points)
[12377]	234	r1_hu(:,:,Kbb) = ssumask(:,:) / ( hu(:,:,Kbb) + 1._wp - ssumask(:,:) ) ! _i mask due to ISF
	235	r1_hu(:,:,Kmm) = ssumask(:,:) / ( hu(:,:,Kmm) + 1._wp - ssumask(:,:) )
	236	r1_hv(:,:,Kbb) = ssvmask(:,:) / ( hv(:,:,Kbb) + 1._wp - ssvmask(:,:) )
	237	r1_hv(:,:,Kmm) = ssvmask(:,:) / ( hv(:,:,Kmm) + 1._wp - ssvmask(:,:) )
[7753]	238
[6140]	239	! !== z_tilde coordinate case ==! (Restoring frequencies)
[4292]	240	IF( ln_vvl_ztilde ) THEN
[6140]	241	!!gm : idea: add here a READ in a file of custumized restoring frequency
	242	! ! Values in days provided via the namelist
	243	! ! use rsmall to avoid possible division by zero errors with faulty settings
[7753]	244	frq_rst_e3t(:,:) = 2._wp * rpi / ( MAX( rn_rst_e3t , rsmall ) * 86400.0_wp )
	245	frq_rst_hdv(:,:) = 2._wp * rpi / ( MAX( rn_lf_cutoff, rsmall ) * 86400.0_wp )
[6140]	246	!
	247	IF( ln_vvl_ztilde_as_zstar ) THEN ! z-star emulation using z-tile
[7753]	248	frq_rst_e3t(:,:) = 0._wp !Ignore namelist settings
[12489]	249	frq_rst_hdv(:,:) = 1._wp / rn_Dt
[4292]	250	ENDIF
[6140]	251	IF ( ln_vvl_zstar_at_eqtor ) THEN ! use z-star in vicinity of the Equator
[13295]	252	DO_2D( 1, 1, 1, 1 )
[6140]	253	!!gm case \|gphi\| >= 6 degrees is useless initialized just above by default
[12377]	254	IF( ABS(gphit(ji,jj)) >= 6.) THEN
	255	! values outside the equatorial band and transition zone (ztilde)
	256	frq_rst_e3t(ji,jj) = 2.0_wp * rpi / ( MAX( rn_rst_e3t , rsmall ) * 86400.e0_wp )
	257	frq_rst_hdv(ji,jj) = 2.0_wp * rpi / ( MAX( rn_lf_cutoff, rsmall ) * 86400.e0_wp )
	258	ELSEIF( ABS(gphit(ji,jj)) <= 2.5) THEN ! Equator strip ==> z-star
	259	! values inside the equatorial band (ztilde as zstar)
	260	frq_rst_e3t(ji,jj) = 0.0_wp
[12489]	261	frq_rst_hdv(ji,jj) = 1.0_wp / rn_Dt
[12377]	262	ELSE ! transition band (2.5 to 6 degrees N/S)
	263	! ! (linearly transition from z-tilde to z-star)
	264	frq_rst_e3t(ji,jj) = 0.0_wp + (frq_rst_e3t(ji,jj)-0.0_wp)*0.5_wp &
	265	& * ( 1.0_wp - COS( rad*(ABS(gphit(ji,jj))-2.5_wp) &
	266	& * 180._wp / 3.5_wp ) )
[12489]	267	frq_rst_hdv(ji,jj) = (1.0_wp / rn_Dt) &
	268	& + ( frq_rst_hdv(ji,jj)-(1.e0_wp / rn_Dt) )*0.5_wp &
[12377]	269	& * ( 1._wp - COS( rad*(ABS(gphit(ji,jj))-2.5_wp) &
	270	& * 180._wp / 3.5_wp ) )
	271	ENDIF
	272	END_2D
[10213]	273	IF( cn_cfg == "orca" .OR. cn_cfg == "ORCA" ) THEN
	274	IF( nn_cfg == 3 ) THEN ! ORCA2: Suppress ztilde in the Foxe Basin for ORCA2
[13286]	275	ii0 = 103 + nn_hls - 1 ; ii1 = 111 + nn_hls - 1
	276	ij0 = 128 + nn_hls ; ij1 = 135 + nn_hls
[10213]	277	frq_rst_e3t( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) = 0.0_wp
[12489]	278	frq_rst_hdv( mi0(ii0):mi1(ii1) , mj0(ij0):mj1(ij1) ) = 1.e0_wp / rn_Dt
[10213]	279	ENDIF
[4292]	280	ENDIF
	281	ENDIF
	282	ENDIF
[6140]	283	!
[9367]	284	IF(lwxios) THEN
	285	! define variables in restart file when writing with XIOS
	286	CALL iom_set_rstw_var_active('e3t_b')
	287	CALL iom_set_rstw_var_active('e3t_n')
	288	! ! ----------------------- !
	289	IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN ! z_tilde and layer cases !
	290	! ! ----------------------- !
	291	CALL iom_set_rstw_var_active('tilde_e3t_b')
	292	CALL iom_set_rstw_var_active('tilde_e3t_n')
	293	END IF
	294	! ! -------------!
	295	IF( ln_vvl_ztilde ) THEN ! z_tilde case !
	296	! ! ------------ !
	297	CALL iom_set_rstw_var_active('hdiv_lf')
	298	ENDIF
	299	!
	300	ENDIF
	301	!
[12377]	302	END SUBROUTINE dom_vvl_zgr
[4292]	303
	304
[12377]	305	SUBROUTINE dom_vvl_sf_nxt( kt, Kbb, Kmm, Kaa, kcall )
[4292]	306	!!----------------------------------------------------------------------
	307	!! * ROUTINE dom_vvl_sf_nxt *
	308	!!
	309	!! ** Purpose : - compute the after scale factors used in tra_zdf, dynnxt,
	310	!! tranxt and dynspg routines
	311	!!
	312	!! ** Method : - z_star case: Repartition of ssh INCREMENT proportionnaly to the level thickness.
	313	!! - z_tilde_case: after scale factor increment =
	314	!! high frequency part of horizontal divergence
	315	!! + retsoring towards the background grid
	316	!! + thickness difusion
	317	!! Then repartition of ssh INCREMENT proportionnaly
	318	!! to the "baroclinic" level thickness.
	319	!!
	320	!! ** Action : - hdiv_lf : restoring towards full baroclinic divergence in z_tilde case
	321	!! - tilde_e3t_a: after increment of vertical scale factor
	322	!! in z_tilde case
[6140]	323	!! - e3(t/u/v)_a
[4292]	324	!!
	325	!! Reference : Leclair, M., and Madec, G. 2011, Ocean Modelling.
	326	!!----------------------------------------------------------------------
[12377]	327	INTEGER, INTENT( in ) :: kt ! time step
	328	INTEGER, INTENT( in ) :: Kbb, Kmm, Kaa ! time step
	329	INTEGER, INTENT( in ), OPTIONAL :: kcall ! optional argument indicating call sequence
[6140]	330	!
	331	INTEGER :: ji, jj, jk ! dummy loop indices
	332	INTEGER , DIMENSION(3) :: ijk_max, ijk_min ! temporary integers
[12489]	333	REAL(wp) :: z_tmin, z_tmax ! local scalars
[6140]	334	LOGICAL :: ll_do_bclinic ! local logical
[9019]	335	REAL(wp), DIMENSION(jpi,jpj) :: zht, z_scale, zwu, zwv, zhdiv
[13458]	336	REAL(wp), DIMENSION(:,:,:), ALLOCATABLE :: ze3t
	337	LOGICAL , DIMENSION(:,:,:), ALLOCATABLE :: llmsk
[4292]	338	!!----------------------------------------------------------------------
[6140]	339	!
	340	IF( ln_linssh ) RETURN ! No calculation in linear free surface
	341	!
[9019]	342	IF( ln_timing ) CALL timing_start('dom_vvl_sf_nxt')
[6140]	343	!
	344	IF( kt == nit000 ) THEN
[4292]	345	IF(lwp) WRITE(numout,*)
	346	IF(lwp) WRITE(numout,*) 'dom_vvl_sf_nxt : compute after scale factors'
	347	IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~'
	348	ENDIF
	349
[4338]	350	ll_do_bclinic = .TRUE.
	351	IF( PRESENT(kcall) ) THEN
[6140]	352	IF( kcall == 2 .AND. ln_vvl_ztilde ) ll_do_bclinic = .FALSE.
[4338]	353	ENDIF
	354
[4292]	355	! ******************************* !
	356	! After acale factors at t-points !
	357	! ******************************* !
[4338]	358	! ! --------------------------------------------- !
[6140]	359	! ! z_star coordinate and barotropic z-tilde part !
[4338]	360	! ! --------------------------------------------- !
[6140]	361	!
[12377]	362	z_scale(:,:) = ( ssh(:,:,Kaa) - ssh(:,:,Kbb) ) * ssmask(:,:) / ( ht_0(:,:) + ssh(:,:,Kmm) + 1. - ssmask(:,:) )
[4338]	363	DO jk = 1, jpkm1
[12377]	364	! formally this is the same as e3t(:,:,:,Kaa) = e3t_0*(1+ssha/ht_0)
	365	e3t(:,:,jk,Kaa) = e3t(:,:,jk,Kbb) + e3t(:,:,jk,Kmm) * z_scale(:,:) * tmask(:,:,jk)
[4338]	366	END DO
[6140]	367	!
[11415]	368	IF( (ln_vvl_ztilde .OR. ln_vvl_layer) .AND. ll_do_bclinic ) THEN ! z_tilde or layer coordinate !
	369	! ! ------baroclinic part------ !
[4292]	370	! I - initialization
	371	! ==================
	372
	373	! 1 - barotropic divergence
	374	! -------------------------
[7753]	375	zhdiv(:,:) = 0._wp
	376	zht(:,:) = 0._wp
[4292]	377	DO jk = 1, jpkm1
[12377]	378	zhdiv(:,:) = zhdiv(:,:) + e3t(:,:,jk,Kmm) * hdiv(:,:,jk)
	379	zht (:,:) = zht (:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
[592]	380	END DO
[7753]	381	zhdiv(:,:) = zhdiv(:,:) / ( zht(:,:) + 1. - tmask_i(:,:) )
[2528]	382
[4292]	383	! 2 - Low frequency baroclinic horizontal divergence (z-tilde case only)
	384	! --------------------------------------------------
	385	IF( ln_vvl_ztilde ) THEN
[6140]	386	IF( kt > nit000 ) THEN
[4292]	387	DO jk = 1, jpkm1
[12489]	388	hdiv_lf(:,:,jk) = hdiv_lf(:,:,jk) - rn_Dt * frq_rst_hdv(:,:) &
[12377]	389	& * ( hdiv_lf(:,:,jk) - e3t(:,:,jk,Kmm) * ( hdiv(:,:,jk) - zhdiv(:,:) ) )
[4292]	390	END DO
	391	ENDIF
[6140]	392	ENDIF
[3294]	393
[4292]	394	! II - after z_tilde increments of vertical scale factors
	395	! =======================================================
[7753]	396	tilde_e3t_a(:,:,:) = 0._wp ! tilde_e3t_a used to store tendency terms
[4292]	397
	398	! 1 - High frequency divergence term
	399	! ----------------------------------
	400	IF( ln_vvl_ztilde ) THEN ! z_tilde case
	401	DO jk = 1, jpkm1
[12377]	402	tilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) - ( e3t(:,:,jk,Kmm) * ( hdiv(:,:,jk) - zhdiv(:,:) ) - hdiv_lf(:,:,jk) )
[4292]	403	END DO
	404	ELSE ! layer case
	405	DO jk = 1, jpkm1
[12377]	406	tilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) - e3t(:,:,jk,Kmm) * ( hdiv(:,:,jk) - zhdiv(:,:) ) * tmask(:,:,jk)
[4292]	407	END DO
[6140]	408	ENDIF
[4292]	409
	410	! 2 - Restoring term (z-tilde case only)
	411	! ------------------
	412	IF( ln_vvl_ztilde ) THEN
	413	DO jk = 1, jpk
[7753]	414	tilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) - frq_rst_e3t(:,:) * tilde_e3t_b(:,:,jk)
[4292]	415	END DO
[6140]	416	ENDIF
[4292]	417
	418	! 3 - Thickness diffusion term
	419	! ----------------------------
[7753]	420	zwu(:,:) = 0._wp
	421	zwv(:,:) = 0._wp
[13497]	422	DO_3D( 1, 0, 1, 0, 1, jpkm1 ) ! a - first derivative: diffusive fluxes
[12377]	423	un_td(ji,jj,jk) = rn_ahe3 * umask(ji,jj,jk) * e2_e1u(ji,jj) &
	424	& * ( tilde_e3t_b(ji,jj,jk) - tilde_e3t_b(ji+1,jj ,jk) )
	425	vn_td(ji,jj,jk) = rn_ahe3 * vmask(ji,jj,jk) * e1_e2v(ji,jj) &
	426	& * ( tilde_e3t_b(ji,jj,jk) - tilde_e3t_b(ji ,jj+1,jk) )
	427	zwu(ji,jj) = zwu(ji,jj) + un_td(ji,jj,jk)
	428	zwv(ji,jj) = zwv(ji,jj) + vn_td(ji,jj,jk)
	429	END_3D
[13497]	430	DO_2D( 1, 1, 1, 1 ) ! b - correction for last oceanic u-v points
[12377]	431	un_td(ji,jj,mbku(ji,jj)) = un_td(ji,jj,mbku(ji,jj)) - zwu(ji,jj)
	432	vn_td(ji,jj,mbkv(ji,jj)) = vn_td(ji,jj,mbkv(ji,jj)) - zwv(ji,jj)
	433	END_2D
[13497]	434	DO_3D( 0, 0, 0, 0, 1, jpkm1 ) ! c - second derivative: divergence of diffusive fluxes
[12377]	435	tilde_e3t_a(ji,jj,jk) = tilde_e3t_a(ji,jj,jk) + ( un_td(ji-1,jj ,jk) - un_td(ji,jj,jk) &
	436	& + vn_td(ji ,jj-1,jk) - vn_td(ji,jj,jk) &
	437	& ) * r1_e1e2t(ji,jj)
	438	END_3D
[13497]	439	! ! d - thickness diffusion transport: boundary conditions
[6140]	440	! (stored for tracer advction and continuity equation)
[10425]	441	CALL lbc_lnk_multi( 'domvvl', un_td , 'U' , -1._wp, vn_td , 'V' , -1._wp)
[4292]	442
	443	! 4 - Time stepping of baroclinic scale factors
	444	! ---------------------------------------------
[10425]	445	CALL lbc_lnk( 'domvvl', tilde_e3t_a(:,:,:), 'T', 1._wp )
[12489]	446	tilde_e3t_a(:,:,:) = tilde_e3t_b(:,:,:) + rDt * tmask(:,:,:) * tilde_e3t_a(:,:,:)
[4292]	447
	448	! Maximum deformation control
	449	! ~~~~~~~~~~~~~~~~~~~~~~~~~~~
[13458]	450	ALLOCATE( ze3t(jpi,jpj,jpk), llmsk(jpi,jpj,jpk) )
	451	DO_3D( 0, 0, 0, 0, 1, jpkm1 )
	452	ze3t(ji,jj,jk) = tilde_e3t_a(ji,jj,jk) / e3t_0(ji,jj,jk) * tmask(ji,jj,jk) * tmask_i(ji,jj)
	453	END_3D
	454	!
	455	llmsk( 1:Nis1,:,:) = .FALSE. ! exclude halos from the checked region
	456	llmsk(Nie1: jpi,:,:) = .FALSE.
	457	llmsk(:, 1:Njs1,:) = .FALSE.
	458	llmsk(:,Nje1: jpj,:) = .FALSE.
	459	!
	460	llmsk(Nis0:Nie0,Njs0:Nje0,:) = tmask(Nis0:Nie0,Njs0:Nje0,:) == 1._wp ! define only the inner domain
	461	z_tmax = MAXVAL( ze3t(:,:,:), mask = llmsk ) ; CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
	462	z_tmin = MINVAL( ze3t(:,:,:), mask = llmsk ) ; CALL mpp_min( 'domvvl', z_tmin ) ! min over the global domain
[4292]	463	! - ML - test: for the moment, stop simulation for too large e3_t variations
[6140]	464	IF( ( z_tmax > rn_zdef_max ) .OR. ( z_tmin < - rn_zdef_max ) ) THEN
[13458]	465	CALL mpp_maxloc( 'domvvl', ze3t, llmsk, z_tmax, ijk_max )
	466	CALL mpp_minloc( 'domvvl', ze3t, llmsk, z_tmin, ijk_min )
[4292]	467	IF (lwp) THEN
	468	WRITE(numout, *) 'MAX( tilde_e3t_a(:,:,:) / e3t_0(:,:,:) ) =', z_tmax
	469	WRITE(numout, *) 'at i, j, k=', ijk_max
	470	WRITE(numout, *) 'MIN( tilde_e3t_a(:,:,:) / e3t_0(:,:,:) ) =', z_tmin
	471	WRITE(numout, *) 'at i, j, k=', ijk_min
[10425]	472	CALL ctl_stop( 'STOP', 'MAX( ABS( tilde_e3t_a(:,:,: ) ) / e3t_0(:,:,:) ) too high')
[4292]	473	ENDIF
	474	ENDIF
[13458]	475	DEALLOCATE( ze3t, llmsk )
[4292]	476	! - ML - end test
	477	! - ML - Imposing these limits will cause a baroclinicity error which is corrected for below
[7753]	478	tilde_e3t_a(:,:,:) = MIN( tilde_e3t_a(:,:,:), rn_zdef_max * e3t_0(:,:,:) )
	479	tilde_e3t_a(:,:,:) = MAX( tilde_e3t_a(:,:,:), - rn_zdef_max * e3t_0(:,:,:) )
[4292]	480
[4338]	481	!
	482	! "tilda" change in the after scale factor
[4292]	483	! ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
[4338]	484	DO jk = 1, jpkm1
[7753]	485	dtilde_e3t_a(:,:,jk) = tilde_e3t_a(:,:,jk) - tilde_e3t_b(:,:,jk)
[4338]	486	END DO
[4292]	487	! III - Barotropic repartition of the sea surface height over the baroclinic profile
	488	! ==================================================================================
[4338]	489	! add ( ssh increment + "baroclinicity error" ) proportionly to e3t(n)
[4292]	490	! - ML - baroclinicity error should be better treated in the future
	491	! i.e. locally and not spread over the water column.
	492	! (keep in mind that the idea is to reduce Eulerian velocity as much as possible)
[7753]	493	zht(:,:) = 0.
[4292]	494	DO jk = 1, jpkm1
[7753]	495	zht(:,:) = zht(:,:) + tilde_e3t_a(:,:,jk) * tmask(:,:,jk)
[4292]	496	END DO
[12377]	497	z_scale(:,:) = - zht(:,:) / ( ht_0(:,:) + ssh(:,:,Kmm) + 1. - ssmask(:,:) )
[4292]	498	DO jk = 1, jpkm1
[12377]	499	dtilde_e3t_a(:,:,jk) = dtilde_e3t_a(:,:,jk) + e3t(:,:,jk,Kmm) * z_scale(:,:) * tmask(:,:,jk)
[4292]	500	END DO
[7753]	501
[4292]	502	ENDIF
	503
[4338]	504	IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN ! z_tilde or layer coordinate !
	505	! ! ---baroclinic part--------- !
	506	DO jk = 1, jpkm1
[12377]	507	e3t(:,:,jk,Kaa) = e3t(:,:,jk,Kaa) + dtilde_e3t_a(:,:,jk) * tmask(:,:,jk)
[4338]	508	END DO
	509	ENDIF
	510
	511	IF( ln_vvl_dbg .AND. .NOT. ll_do_bclinic ) THEN ! - ML - test: control prints for debuging
[4292]	512	!
	513	IF( lwp ) WRITE(numout, *) 'kt =', kt
	514	IF ( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
	515	z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( zht(:,:) ) )
[10425]	516	CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
[4292]	517	IF( lwp ) WRITE(numout, *) kt,' MAXVAL(abs(SUM(tilde_e3t_a))) =', z_tmax
	518	END IF
	519	!
[7753]	520	zht(:,:) = 0.0_wp
[4292]	521	DO jk = 1, jpkm1
[12377]	522	zht(:,:) = zht(:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
[4292]	523	END DO
[12377]	524	z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( ht_0(:,:) + ssh(:,:,Kmm) - zht(:,:) ) )
[10425]	525	CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
[12377]	526	IF( lwp ) WRITE(numout, *) kt,' MAXVAL(abs(ht_0+sshn-SUM(e3t(:,:,:,Kmm)))) =', z_tmax
[4292]	527	!
[7753]	528	zht(:,:) = 0.0_wp
[4292]	529	DO jk = 1, jpkm1
[12377]	530	zht(:,:) = zht(:,:) + e3t(:,:,jk,Kaa) * tmask(:,:,jk)
[4292]	531	END DO
[12377]	532	z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( ht_0(:,:) + ssh(:,:,Kaa) - zht(:,:) ) )
[10425]	533	CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
[12377]	534	IF( lwp ) WRITE(numout, *) kt,' MAXVAL(abs(ht_0+ssha-SUM(e3t(:,:,:,Kaa)))) =', z_tmax
[4292]	535	!
[7753]	536	zht(:,:) = 0.0_wp
[4292]	537	DO jk = 1, jpkm1
[12377]	538	zht(:,:) = zht(:,:) + e3t(:,:,jk,Kbb) * tmask(:,:,jk)
[4292]	539	END DO
[12377]	540	z_tmax = MAXVAL( tmask(:,:,1) * tmask_i(:,:) * ABS( ht_0(:,:) + ssh(:,:,Kbb) - zht(:,:) ) )
[10425]	541	CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
[12377]	542	IF( lwp ) WRITE(numout, *) kt,' MAXVAL(abs(ht_0+sshb-SUM(e3t(:,:,:,Kbb)))) =', z_tmax
[4292]	543	!
[12377]	544	z_tmax = MAXVAL( tmask(:,:,1) * ABS( ssh(:,:,Kbb) ) )
[10425]	545	CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
[12377]	546	IF( lwp ) WRITE(numout, *) kt,' MAXVAL(abs(ssh(:,:,Kbb)))) =', z_tmax
[4292]	547	!
[12377]	548	z_tmax = MAXVAL( tmask(:,:,1) * ABS( ssh(:,:,Kmm) ) )
[10425]	549	CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
[12377]	550	IF( lwp ) WRITE(numout, *) kt,' MAXVAL(abs(ssh(:,:,Kmm)))) =', z_tmax
[4292]	551	!
[12377]	552	z_tmax = MAXVAL( tmask(:,:,1) * ABS( ssh(:,:,Kaa) ) )
[10425]	553	CALL mpp_max( 'domvvl', z_tmax ) ! max over the global domain
[12377]	554	IF( lwp ) WRITE(numout, *) kt,' MAXVAL(abs(ssh(:,:,Kaa)))) =', z_tmax
[4292]	555	END IF
	556
	557	! *********************************** !
	558	! After scale factors at u- v- points !
	559	! *********************************** !
	560
[12377]	561	CALL dom_vvl_interpol( e3t(:,:,:,Kaa), e3u(:,:,:,Kaa), 'U' )
	562	CALL dom_vvl_interpol( e3t(:,:,:,Kaa), e3v(:,:,:,Kaa), 'V' )
[4292]	563
[4370]	564	! *********************************** !
	565	! After depths at u- v points !
	566	! *********************************** !
	567
[12377]	568	hu(:,:,Kaa) = e3u(:,:,1,Kaa) * umask(:,:,1)
	569	hv(:,:,Kaa) = e3v(:,:,1,Kaa) * vmask(:,:,1)
[6140]	570	DO jk = 2, jpkm1
[12377]	571	hu(:,:,Kaa) = hu(:,:,Kaa) + e3u(:,:,jk,Kaa) * umask(:,:,jk)
	572	hv(:,:,Kaa) = hv(:,:,Kaa) + e3v(:,:,jk,Kaa) * vmask(:,:,jk)
[4370]	573	END DO
	574	! ! Inverse of the local depth
[6140]	575	!!gm BUG ? don't understand the use of umask_i here .....
[12377]	576	r1_hu(:,:,Kaa) = ssumask(:,:) / ( hu(:,:,Kaa) + 1._wp - ssumask(:,:) )
	577	r1_hv(:,:,Kaa) = ssvmask(:,:) / ( hv(:,:,Kaa) + 1._wp - ssvmask(:,:) )
[6140]	578	!
[9019]	579	IF( ln_timing ) CALL timing_stop('dom_vvl_sf_nxt')
[6140]	580	!
[4292]	581	END SUBROUTINE dom_vvl_sf_nxt
	582
	583
[12377]	584	SUBROUTINE dom_vvl_sf_update( kt, Kbb, Kmm, Kaa )
[3294]	585	!!----------------------------------------------------------------------
[12377]	586	!! * ROUTINE dom_vvl_sf_update *
[3294]	587	!!
[12377]	588	!! ** Purpose : for z tilde case: compute time filter and swap of scale factors
[4292]	589	!! compute all depths and related variables for next time step
	590	!! write outputs and restart file
[3294]	591	!!
[12377]	592	!! ** Method : - swap of e3t with trick for volume/tracer conservation (ONLY FOR Z TILDE CASE)
[4292]	593	!! - reconstruct scale factor at other grid points (interpolate)
	594	!! - recompute depths and water height fields
	595	!!
[12377]	596	!! ** Action : - tilde_e3t_(b/n) ready for next time step
[4292]	597	!! - Recompute:
[6140]	598	!! e3(u/v)_b
[12377]	599	!! e3w(:,:,:,Kmm)
[6140]	600	!! e3(u/v)w_b
	601	!! e3(u/v)w_n
[12377]	602	!! gdept(:,:,:,Kmm), gdepw(:,:,:,Kmm) and gde3w
[4292]	603	!! h(u/v) and h(u/v)r
	604	!!
	605	!! Reference : Leclair, M., and G. Madec, 2009, Ocean Modelling.
	606	!! Leclair, M., and G. Madec, 2011, Ocean Modelling.
[3294]	607	!!----------------------------------------------------------------------
[12377]	608	INTEGER, INTENT( in ) :: kt ! time step
	609	INTEGER, INTENT( in ) :: Kbb, Kmm, Kaa ! time level indices
[6140]	610	!
	611	INTEGER :: ji, jj, jk ! dummy loop indices
	612	REAL(wp) :: zcoef ! local scalar
[3294]	613	!!----------------------------------------------------------------------
[6140]	614	!
	615	IF( ln_linssh ) RETURN ! No calculation in linear free surface
	616	!
[12377]	617	IF( ln_timing ) CALL timing_start('dom_vvl_sf_update')
[3294]	618	!
[4292]	619	IF( kt == nit000 ) THEN
	620	IF(lwp) WRITE(numout,*)
[12377]	621	IF(lwp) WRITE(numout,*) 'dom_vvl_sf_update : - interpolate scale factors and compute depths for next time step'
	622	IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~~~~~~'
[3294]	623	ENDIF
[4292]	624	!
	625	! Time filter and swap of scale factors
	626	! =====================================
[6140]	627	! - ML - e3(t/u/v)_b are allready computed in dynnxt.
[4292]	628	IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN
[12489]	629	IF( l_1st_euler ) THEN
[7753]	630	tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:)
[4292]	631	ELSE
[7753]	632	tilde_e3t_b(:,:,:) = tilde_e3t_n(:,:,:) &
[12489]	633	& + rn_atfp * ( tilde_e3t_b(:,:,:) - 2.0_wp * tilde_e3t_n(:,:,:) + tilde_e3t_a(:,:,:) )
[4292]	634	ENDIF
[7753]	635	tilde_e3t_n(:,:,:) = tilde_e3t_a(:,:,:)
[4292]	636	ENDIF
[4488]	637
[4292]	638	! Compute all missing vertical scale factor and depths
	639	! ====================================================
	640	! Horizontal scale factor interpolations
	641	! --------------------------------------
[12377]	642	! - ML - e3u(:,:,:,Kbb) and e3v(:,:,:,Kbb) are already computed in dynnxt
	643	! - JC - hu(:,:,:,Kbb), hv(:,:,:,:,Kbb), hur_b, hvr_b also
[6140]	644
[12377]	645	CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3f(:,:,:), 'F' )
[6140]	646
[4292]	647	! Vertical scale factor interpolations
[12377]	648	CALL dom_vvl_interpol( e3t(:,:,:,Kmm), e3w(:,:,:,Kmm), 'W' )
	649	CALL dom_vvl_interpol( e3u(:,:,:,Kmm), e3uw(:,:,:,Kmm), 'UW' )
	650	CALL dom_vvl_interpol( e3v(:,:,:,Kmm), e3vw(:,:,:,Kmm), 'VW' )
	651	CALL dom_vvl_interpol( e3t(:,:,:,Kbb), e3w(:,:,:,Kbb), 'W' )
	652	CALL dom_vvl_interpol( e3u(:,:,:,Kbb), e3uw(:,:,:,Kbb), 'UW' )
	653	CALL dom_vvl_interpol( e3v(:,:,:,Kbb), e3vw(:,:,:,Kbb), 'VW' )
[5120]	654
[6140]	655	! t- and w- points depth (set the isf depth as it is in the initial step)
[12377]	656	gdept(:,:,1,Kmm) = 0.5_wp * e3w(:,:,1,Kmm)
	657	gdepw(:,:,1,Kmm) = 0.0_wp
	658	gde3w(:,:,1) = gdept(:,:,1,Kmm) - ssh(:,:,Kmm)
[13295]	659	DO_3D( 1, 1, 1, 1, 2, jpk )
[12377]	660	! zcoef = (tmask(ji,jj,jk) - wmask(ji,jj,jk)) ! 0 everywhere tmask = wmask, ie everywhere expect at jk = mikt
	661	! 1 for jk = mikt
	662	zcoef = (tmask(ji,jj,jk) - wmask(ji,jj,jk))
	663	gdepw(ji,jj,jk,Kmm) = gdepw(ji,jj,jk-1,Kmm) + e3t(ji,jj,jk-1,Kmm)
	664	gdept(ji,jj,jk,Kmm) = zcoef * ( gdepw(ji,jj,jk ,Kmm) + 0.5 * e3w(ji,jj,jk,Kmm) ) &
	665	& + (1-zcoef) * ( gdept(ji,jj,jk-1,Kmm) + e3w(ji,jj,jk,Kmm) )
	666	gde3w(ji,jj,jk) = gdept(ji,jj,jk,Kmm) - ssh(ji,jj,Kmm)
	667	END_3D
[5120]	668
[6140]	669	! Local depth and Inverse of the local depth of the water
	670	! -------------------------------------------------------
[7753]	671	!
[12377]	672	ht(:,:) = e3t(:,:,1,Kmm) * tmask(:,:,1)
[6140]	673	DO jk = 2, jpkm1
[12377]	674	ht(:,:) = ht(:,:) + e3t(:,:,jk,Kmm) * tmask(:,:,jk)
[4370]	675	END DO
[7753]	676
[4292]	677	! write restart file
	678	! ==================
[12377]	679	IF( lrst_oce ) CALL dom_vvl_rst( kt, Kbb, Kmm, 'WRITE' )
[4292]	680	!
[12377]	681	IF( ln_timing ) CALL timing_stop('dom_vvl_sf_update')
[6140]	682	!
[12377]	683	END SUBROUTINE dom_vvl_sf_update
[4292]	684
	685
	686	SUBROUTINE dom_vvl_interpol( pe3_in, pe3_out, pout )
	687	!!---------------------------------------------------------------------
	688	!! * ROUTINE dom_vvl__interpol *
	689	!!
	690	!! ** Purpose : interpolate scale factors from one grid point to another
	691	!!
	692	!! ** Method : e3_out = e3_0 + interpolation(e3_in - e3_0)
	693	!! - horizontal interpolation: grid cell surface averaging
	694	!! - vertical interpolation: simple averaging
	695	!!----------------------------------------------------------------------
[5836]	696	REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(in ) :: pe3_in ! input e3 to be interpolated
	697	REAL(wp), DIMENSION(jpi,jpj,jpk), INTENT(inout) :: pe3_out ! output interpolated e3
	698	CHARACTER(LEN=*) , INTENT(in ) :: pout ! grid point of out scale factors
	699	! ! = 'U', 'V', 'W, 'F', 'UW' or 'VW'
	700	!
[6152]	701	INTEGER :: ji, jj, jk ! dummy loop indices
[9023]	702	REAL(wp) :: zlnwd ! =1./0. when ln_wd_il = T/F
[4292]	703	!!----------------------------------------------------------------------
[5836]	704	!
[9023]	705	IF(ln_wd_il) THEN
[6152]	706	zlnwd = 1.0_wp
	707	ELSE
	708	zlnwd = 0.0_wp
	709	END IF
	710	!
[5836]	711	SELECT CASE ( pout ) !== type of interpolation ==!
[4292]	712	!
[5836]	713	CASE( 'U' ) !* from T- to U-point : hor. surface weighted mean
[13295]	714	DO_3D( 1, 0, 1, 0, 1, jpk )
[12377]	715	pe3_out(ji,jj,jk) = 0.5_wp * ( umask(ji,jj,jk) * (1.0_wp - zlnwd) + zlnwd ) * r1_e1e2u(ji,jj) &
	716	& * ( e1e2t(ji ,jj) * ( pe3_in(ji ,jj,jk) - e3t_0(ji ,jj,jk) ) &
	717	& + e1e2t(ji+1,jj) * ( pe3_in(ji+1,jj,jk) - e3t_0(ji+1,jj,jk) ) )
	718	END_3D
[10425]	719	CALL lbc_lnk( 'domvvl', pe3_out(:,:,:), 'U', 1._wp )
[7753]	720	pe3_out(:,:,:) = pe3_out(:,:,:) + e3u_0(:,:,:)
[5836]	721	!
	722	CASE( 'V' ) !* from T- to V-point : hor. surface weighted mean
[13295]	723	DO_3D( 1, 0, 1, 0, 1, jpk )
[12377]	724	pe3_out(ji,jj,jk) = 0.5_wp * ( vmask(ji,jj,jk) * (1.0_wp - zlnwd) + zlnwd ) * r1_e1e2v(ji,jj) &
	725	& * ( e1e2t(ji,jj ) * ( pe3_in(ji,jj ,jk) - e3t_0(ji,jj ,jk) ) &
	726	& + e1e2t(ji,jj+1) * ( pe3_in(ji,jj+1,jk) - e3t_0(ji,jj+1,jk) ) )
	727	END_3D
[10425]	728	CALL lbc_lnk( 'domvvl', pe3_out(:,:,:), 'V', 1._wp )
[7753]	729	pe3_out(:,:,:) = pe3_out(:,:,:) + e3v_0(:,:,:)
[5836]	730	!
	731	CASE( 'F' ) !* from U-point to F-point : hor. surface weighted mean
[13295]	732	DO_3D( 1, 0, 1, 0, 1, jpk )
[12377]	733	pe3_out(ji,jj,jk) = 0.5_wp * ( umask(ji,jj,jk) * umask(ji,jj+1,jk) * (1.0_wp - zlnwd) + zlnwd ) &
	734	& * r1_e1e2f(ji,jj) &
	735	& * ( e1e2u(ji,jj ) * ( pe3_in(ji,jj ,jk) - e3u_0(ji,jj ,jk) ) &
	736	& + e1e2u(ji,jj+1) * ( pe3_in(ji,jj+1,jk) - e3u_0(ji,jj+1,jk) ) )
	737	END_3D
[10425]	738	CALL lbc_lnk( 'domvvl', pe3_out(:,:,:), 'F', 1._wp )
[7753]	739	pe3_out(:,:,:) = pe3_out(:,:,:) + e3f_0(:,:,:)
[5836]	740	!
	741	CASE( 'W' ) !* from T- to W-point : vertical simple mean
	742	!
[7753]	743	pe3_out(:,:,1) = e3w_0(:,:,1) + pe3_in(:,:,1) - e3t_0(:,:,1)
[5836]	744	! - ML - The use of mask in this formulea enables the special treatment of the last w-point without indirect adressing
	745	!!gm BUG? use here wmask in case of ISF ? to be checked
[4292]	746	DO jk = 2, jpk
[7753]	747	pe3_out(:,:,jk) = e3w_0(:,:,jk) + ( 1.0_wp - 0.5_wp * ( tmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) ) &
	748	& * ( pe3_in(:,:,jk-1) - e3t_0(:,:,jk-1) ) &
	749	& + 0.5_wp * ( tmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) &
	750	& * ( pe3_in(:,:,jk ) - e3t_0(:,:,jk ) )
[4292]	751	END DO
[5836]	752	!
	753	CASE( 'UW' ) !* from U- to UW-point : vertical simple mean
	754	!
[7753]	755	pe3_out(:,:,1) = e3uw_0(:,:,1) + pe3_in(:,:,1) - e3u_0(:,:,1)
[4292]	756	! - ML - The use of mask in this formaula enables the special treatment of the last w- point without indirect adressing
[5836]	757	!!gm BUG? use here wumask in case of ISF ? to be checked
[4292]	758	DO jk = 2, jpk
[7753]	759	pe3_out(:,:,jk) = e3uw_0(:,:,jk) + ( 1.0_wp - 0.5_wp * ( umask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) ) &
	760	& * ( pe3_in(:,:,jk-1) - e3u_0(:,:,jk-1) ) &
	761	& + 0.5_wp * ( umask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) &
	762	& * ( pe3_in(:,:,jk ) - e3u_0(:,:,jk ) )
[4292]	763	END DO
[5836]	764	!
	765	CASE( 'VW' ) !* from V- to VW-point : vertical simple mean
	766	!
[7753]	767	pe3_out(:,:,1) = e3vw_0(:,:,1) + pe3_in(:,:,1) - e3v_0(:,:,1)
[4292]	768	! - ML - The use of mask in this formaula enables the special treatment of the last w- point without indirect adressing
[5836]	769	!!gm BUG? use here wvmask in case of ISF ? to be checked
[4292]	770	DO jk = 2, jpk
[7753]	771	pe3_out(:,:,jk) = e3vw_0(:,:,jk) + ( 1.0_wp - 0.5_wp * ( vmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) ) &
	772	& * ( pe3_in(:,:,jk-1) - e3v_0(:,:,jk-1) ) &
	773	& + 0.5_wp * ( vmask(:,:,jk) * (1.0_wp - zlnwd) + zlnwd ) &
	774	& * ( pe3_in(:,:,jk ) - e3v_0(:,:,jk ) )
[4292]	775	END DO
	776	END SELECT
	777	!
	778	END SUBROUTINE dom_vvl_interpol
	779
[5836]	780
[12377]	781	SUBROUTINE dom_vvl_rst( kt, Kbb, Kmm, cdrw )
[4292]	782	!!---------------------------------------------------------------------
	783	!! * ROUTINE dom_vvl_rst *
	784	!!
	785	!! ** Purpose : Read or write VVL file in restart file
	786	!!
	787	!! ** Method : use of IOM library
	788	!! if the restart does not contain vertical scale factors,
	789	!! they are set to the _0 values
	790	!! if the restart does not contain vertical scale factors increments (z_tilde),
	791	!! they are set to 0.
	792	!!----------------------------------------------------------------------
[12377]	793	INTEGER , INTENT(in) :: kt ! ocean time-step
	794	INTEGER , INTENT(in) :: Kbb, Kmm ! ocean time level indices
	795	CHARACTER(len=*), INTENT(in) :: cdrw ! "READ"/"WRITE" flag
[5836]	796	!
[6152]	797	INTEGER :: ji, jj, jk
[4292]	798	INTEGER :: id1, id2, id3, id4, id5 ! local integers
	799	!!----------------------------------------------------------------------
	800	!
	801	IF( TRIM(cdrw) == 'READ' ) THEN ! Read/initialise
	802	! ! ===============
	803	IF( ln_rstart ) THEN !* Read the restart file
	804	CALL rst_read_open ! open the restart file if necessary
[13286]	805	CALL iom_get( numror, jpdom_auto, 'sshn' , ssh(:,:,Kmm), ldxios = lrxios )
[4366]	806	!
[6140]	807	id1 = iom_varid( numror, 'e3t_b', ldstop = .FALSE. )
	808	id2 = iom_varid( numror, 'e3t_n', ldstop = .FALSE. )
[4292]	809	id3 = iom_varid( numror, 'tilde_e3t_b', ldstop = .FALSE. )
	810	id4 = iom_varid( numror, 'tilde_e3t_n', ldstop = .FALSE. )
[4795]	811	id5 = iom_varid( numror, 'hdiv_lf', ldstop = .FALSE. )
[12377]	812	!
[4292]	813	! ! --------- !
	814	! ! all cases !
	815	! ! --------- !
[12377]	816	!
[4292]	817	IF( MIN( id1, id2 ) > 0 ) THEN ! all required arrays exist
[13286]	818	CALL iom_get( numror, jpdom_auto, 'e3t_b', e3t(:,:,:,Kbb), ldxios = lrxios )
	819	CALL iom_get( numror, jpdom_auto, 'e3t_n', e3t(:,:,:,Kmm), ldxios = lrxios )
[4990]	820	! needed to restart if land processor not computed
[12377]	821	IF(lwp) write(numout,*) 'dom_vvl_rst : e3t(:,:,:,Kbb) and e3t(:,:,:,Kmm) found in restart files'
[4990]	822	WHERE ( tmask(:,:,:) == 0.0_wp )
[12377]	823	e3t(:,:,:,Kmm) = e3t_0(:,:,:)
	824	e3t(:,:,:,Kbb) = e3t_0(:,:,:)
[4990]	825	END WHERE
[12489]	826	IF( l_1st_euler ) THEN
[12377]	827	e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[4292]	828	ENDIF
	829	ELSE IF( id1 > 0 ) THEN
[12377]	830	IF(lwp) write(numout,*) 'dom_vvl_rst WARNING : e3t(:,:,:,Kmm) not found in restart files'
[6140]	831	IF(lwp) write(numout,*) 'e3t_n set equal to e3t_b.'
[12489]	832	IF(lwp) write(numout,*) 'l_1st_euler is forced to true'
[13286]	833	CALL iom_get( numror, jpdom_auto, 'e3t_b', e3t(:,:,:,Kbb), ldxios = lrxios )
[12377]	834	e3t(:,:,:,Kmm) = e3t(:,:,:,Kbb)
[12489]	835	l_1st_euler = .true.
[4990]	836	ELSE IF( id2 > 0 ) THEN
[12377]	837	IF(lwp) write(numout,*) 'dom_vvl_rst WARNING : e3t(:,:,:,Kbb) not found in restart files'
[6140]	838	IF(lwp) write(numout,*) 'e3t_b set equal to e3t_n.'
[12489]	839	IF(lwp) write(numout,*) 'l_1st_euler is forced to true'
[13286]	840	CALL iom_get( numror, jpdom_auto, 'e3t_n', e3t(:,:,:,Kmm), ldxios = lrxios )
[12377]	841	e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[12489]	842	l_1st_euler = .true.
[4490]	843	ELSE
[12377]	844	IF(lwp) write(numout,*) 'dom_vvl_rst WARNING : e3t(:,:,:,Kmm) not found in restart file'
[4490]	845	IF(lwp) write(numout,*) 'Compute scale factor from sshn'
[12489]	846	IF(lwp) write(numout,*) 'l_1st_euler is forced to true'
[6140]	847	DO jk = 1, jpk
[12377]	848	e3t(:,:,jk,Kmm) = e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kmm) ) &
[6140]	849	& / ( ht_0(:,:) + 1._wp - ssmask(:,:) ) * tmask(:,:,jk) &
	850	& + e3t_0(:,:,jk) * (1._wp -tmask(:,:,jk))
[4490]	851	END DO
[12377]	852	e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[12489]	853	l_1st_euler = .true.
[4292]	854	ENDIF
	855	! ! ----------- !
	856	IF( ln_vvl_zstar ) THEN ! z_star case !
	857	! ! ----------- !
	858	IF( MIN( id3, id4 ) > 0 ) THEN
	859	CALL ctl_stop( 'dom_vvl_rst: z_star cannot restart from a z_tilde or layer run' )
	860	ENDIF
	861	! ! ----------------------- !
	862	ELSE ! z_tilde and layer cases !
	863	! ! ----------------------- !
	864	IF( MIN( id3, id4 ) > 0 ) THEN ! all required arrays exist
[13286]	865	CALL iom_get( numror, jpdom_auto, 'tilde_e3t_b', tilde_e3t_b(:,:,:), ldxios = lrxios )
	866	CALL iom_get( numror, jpdom_auto, 'tilde_e3t_n', tilde_e3t_n(:,:,:), ldxios = lrxios )
[4292]	867	ELSE ! one at least array is missing
	868	tilde_e3t_b(:,:,:) = 0.0_wp
	869	tilde_e3t_n(:,:,:) = 0.0_wp
	870	ENDIF
	871	! ! ------------ !
	872	IF( ln_vvl_ztilde ) THEN ! z_tilde case !
	873	! ! ------------ !
	874	IF( id5 > 0 ) THEN ! required array exists
[13286]	875	CALL iom_get( numror, jpdom_auto, 'hdiv_lf', hdiv_lf(:,:,:), ldxios = lrxios )
[4292]	876	ELSE ! array is missing
	877	hdiv_lf(:,:,:) = 0.0_wp
	878	ENDIF
	879	ENDIF
	880	ENDIF
	881	!
	882	ELSE !* Initialize at "rest"
[7646]	883	!
[9023]	884
	885	IF( ll_wd ) THEN ! MJB ll_wd edits start here - these are essential
	886	!
	887	IF( cn_cfg == 'wad' ) THEN
	888	! Wetting and drying test case
[12377]	889	CALL usr_def_istate( gdept(:,:,:,Kbb), tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb) )
	890	ts (:,:,:,:,Kmm) = ts (:,:,:,:,Kbb) ! set now values from to before ones
	891	ssh (:,:,Kmm) = ssh(:,:,Kbb)
	892	uu (:,:,:,Kmm) = uu (:,:,:,Kbb)
	893	vv (:,:,:,Kmm) = vv (:,:,:,Kbb)
[9023]	894	ELSE
	895	! if not test case
[12377]	896	ssh(:,:,Kmm) = -ssh_ref
	897	ssh(:,:,Kbb) = -ssh_ref
[9023]	898
[13295]	899	DO_2D( 1, 1, 1, 1 )
[12377]	900	IF( ht_0(ji,jj)-ssh_ref < rn_wdmin1 ) THEN ! if total depth is less than min depth
	901	ssh(ji,jj,Kbb) = rn_wdmin1 - (ht_0(ji,jj) )
	902	ssh(ji,jj,Kmm) = rn_wdmin1 - (ht_0(ji,jj) )
	903	ENDIF
	904	END_2D
[9023]	905	ENDIF !If test case else
	906
	907	! Adjust vertical metrics for all wad
[7646]	908	DO jk = 1, jpk
[12377]	909	e3t(:,:,jk,Kmm) = e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kmm) ) &
[7646]	910	& / ( ht_0(:,:) + 1._wp - ssmask(:,:) ) * tmask(:,:,jk) &
[9023]	911	& + e3t_0(:,:,jk) * ( 1._wp - tmask(:,:,jk) )
[7646]	912	END DO
[12377]	913	e3t(:,:,:,Kbb) = e3t(:,:,:,Kmm)
[9023]	914
[13295]	915	DO_2D( 1, 1, 1, 1 )
[12740]	916	IF ( ht_0(ji,jj) .LE. 0.0 .AND. NINT( ssmask(ji,jj) ) .EQ. 1) THEN
	917	CALL ctl_stop( 'dom_vvl_rst: ht_0 must be positive at potentially wet points' )
	918	ENDIF
	919	END_2D
[7646]	920	!
	921	ELSE
	922	!
[9059]	923	! Just to read set ssh in fact, called latter once vertical grid
	924	! is set up:
[12377]	925	! CALL usr_def_istate( gdept_0, tmask, ts(:,:,:,:,Kbb), uu(:,:,:,Kbb), vv(:,:,:,Kbb), ssh(:,:,Kbb) )
[9065]	926	! !
	927	! DO jk=1,jpk
[12377]	928	! e3t(:,:,jk,Kbb) = e3t_0(:,:,jk) * ( ht_0(:,:) + ssh(:,:,Kbb) ) &
[9065]	929	! & / ( ht_0(:,:) + 1._wp -ssmask(:,:) ) * tmask(:,:,jk)
	930	! END DO
[12377]	931	! e3t(:,:,:,Kmm) = e3t(:,:,:,Kbb)
	932	ssh(:,:,Kmm)=0._wp
	933	e3t(:,:,:,Kmm)=e3t_0(:,:,:)
	934	e3t(:,:,:,Kbb)=e3t_0(:,:,:)
[7646]	935	!
[9023]	936	END IF ! end of ll_wd edits
[6152]	937
[4292]	938	IF( ln_vvl_ztilde .OR. ln_vvl_layer) THEN
[7646]	939	tilde_e3t_b(:,:,:) = 0._wp
	940	tilde_e3t_n(:,:,:) = 0._wp
	941	IF( ln_vvl_ztilde ) hdiv_lf(:,:,:) = 0._wp
[4292]	942	END IF
	943	ENDIF
[5836]	944	!
[4292]	945	ELSEIF( TRIM(cdrw) == 'WRITE' ) THEN ! Create restart file
	946	! ! ===================
	947	IF(lwp) WRITE(numout,*) '---- dom_vvl_rst ----'
[9367]	948	IF( lwxios ) CALL iom_swap( cwxios_context )
[4292]	949	! ! --------- !
	950	! ! all cases !
	951	! ! --------- !
[12377]	952	CALL iom_rstput( kt, nitrst, numrow, 'e3t_b', e3t(:,:,:,Kbb), ldxios = lwxios )
	953	CALL iom_rstput( kt, nitrst, numrow, 'e3t_n', e3t(:,:,:,Kmm), ldxios = lwxios )
[4292]	954	! ! ----------------------- !
	955	IF( ln_vvl_ztilde .OR. ln_vvl_layer ) THEN ! z_tilde and layer cases !
	956	! ! ----------------------- !
[9367]	957	CALL iom_rstput( kt, nitrst, numrow, 'tilde_e3t_b', tilde_e3t_b(:,:,:), ldxios = lwxios)
	958	CALL iom_rstput( kt, nitrst, numrow, 'tilde_e3t_n', tilde_e3t_n(:,:,:), ldxios = lwxios)
[4292]	959	END IF
	960	! ! -------------!
	961	IF( ln_vvl_ztilde ) THEN ! z_tilde case !
	962	! ! ------------ !
[9367]	963	CALL iom_rstput( kt, nitrst, numrow, 'hdiv_lf', hdiv_lf(:,:,:), ldxios = lwxios)
[4292]	964	ENDIF
[5836]	965	!
[9367]	966	IF( lwxios ) CALL iom_swap( cxios_context )
[4292]	967	ENDIF
[5836]	968	!
[4292]	969	END SUBROUTINE dom_vvl_rst
	970
	971
	972	SUBROUTINE dom_vvl_ctl
	973	!!---------------------------------------------------------------------
	974	!! * ROUTINE dom_vvl_ctl *
	975	!!
	976	!! ** Purpose : Control the consistency between namelist options
	977	!! for vertical coordinate
	978	!!----------------------------------------------------------------------
[5836]	979	INTEGER :: ioptio, ios
	980	!!
[4292]	981	NAMELIST/nam_vvl/ ln_vvl_zstar, ln_vvl_ztilde, ln_vvl_layer, ln_vvl_ztilde_as_zstar, &
[5836]	982	& ln_vvl_zstar_at_eqtor , rn_ahe3 , rn_rst_e3t , &
	983	& rn_lf_cutoff , rn_zdef_max , ln_vvl_dbg ! not yet implemented: ln_vvl_kepe
[4292]	984	!!----------------------------------------------------------------------
[5836]	985	!
[4294]	986	READ ( numnam_ref, nam_vvl, IOSTAT = ios, ERR = 901)
[11536]	987	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'nam_vvl in reference namelist' )
[4294]	988	READ ( numnam_cfg, nam_vvl, IOSTAT = ios, ERR = 902 )
[11536]	989	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'nam_vvl in configuration namelist' )
[4624]	990	IF(lwm) WRITE ( numond, nam_vvl )
[5836]	991	!
[4292]	992	IF(lwp) THEN ! Namelist print
	993	WRITE(numout,*)
	994	WRITE(numout,*) 'dom_vvl_ctl : choice/control of the variable vertical coordinate'
	995	WRITE(numout,*) '~~~~~~~~~~~'
[9168]	996	WRITE(numout,*) ' Namelist nam_vvl : chose a vertical coordinate'
	997	WRITE(numout,*) ' zstar ln_vvl_zstar = ', ln_vvl_zstar
	998	WRITE(numout,*) ' ztilde ln_vvl_ztilde = ', ln_vvl_ztilde
	999	WRITE(numout,*) ' layer ln_vvl_layer = ', ln_vvl_layer
	1000	WRITE(numout,*) ' ztilde as zstar ln_vvl_ztilde_as_zstar = ', ln_vvl_ztilde_as_zstar
[4292]	1001	WRITE(numout,*) ' ztilde near the equator ln_vvl_zstar_at_eqtor = ', ln_vvl_zstar_at_eqtor
[9168]	1002	WRITE(numout,*) ' !'
	1003	WRITE(numout,*) ' thickness diffusion coefficient rn_ahe3 = ', rn_ahe3
	1004	WRITE(numout,*) ' maximum e3t deformation fractional change rn_zdef_max = ', rn_zdef_max
[4292]	1005	IF( ln_vvl_ztilde_as_zstar ) THEN
[9168]	1006	WRITE(numout,*) ' ztilde running in zstar emulation mode (ln_vvl_ztilde_as_zstar=T) '
	1007	WRITE(numout,*) ' ignoring namelist timescale parameters and using:'
	1008	WRITE(numout,*) ' hard-wired : z-tilde to zstar restoration timescale (days)'
	1009	WRITE(numout,*) ' rn_rst_e3t = 0.e0'
	1010	WRITE(numout,*) ' hard-wired : z-tilde cutoff frequency of low-pass filter (days)'
[12489]	1011	WRITE(numout,*) ' rn_lf_cutoff = 1.0/rn_Dt'
[4292]	1012	ELSE
[9168]	1013	WRITE(numout,*) ' z-tilde to zstar restoration timescale (days) rn_rst_e3t = ', rn_rst_e3t
	1014	WRITE(numout,*) ' z-tilde cutoff frequency of low-pass filter (days) rn_lf_cutoff = ', rn_lf_cutoff
[4292]	1015	ENDIF
[9168]	1016	WRITE(numout,*) ' debug prints flag ln_vvl_dbg = ', ln_vvl_dbg
[4292]	1017	ENDIF
[5836]	1018	!
[4292]	1019	ioptio = 0 ! Parameter control
[5836]	1020	IF( ln_vvl_ztilde_as_zstar ) ln_vvl_ztilde = .true.
	1021	IF( ln_vvl_zstar ) ioptio = ioptio + 1
	1022	IF( ln_vvl_ztilde ) ioptio = ioptio + 1
	1023	IF( ln_vvl_layer ) ioptio = ioptio + 1
	1024	!
[4292]	1025	IF( ioptio /= 1 ) CALL ctl_stop( 'Choose ONE vertical coordinate in namelist nam_vvl' )
[5836]	1026	!
[4292]	1027	IF(lwp) THEN ! Print the choice
	1028	WRITE(numout,*)
[9168]	1029	IF( ln_vvl_zstar ) WRITE(numout,*) ' ==>>> zstar vertical coordinate is used'
	1030	IF( ln_vvl_ztilde ) WRITE(numout,*) ' ==>>> ztilde vertical coordinate is used'
	1031	IF( ln_vvl_layer ) WRITE(numout,*) ' ==>>> layer vertical coordinate is used'
	1032	IF( ln_vvl_ztilde_as_zstar ) WRITE(numout,*) ' ==>>> to emulate a zstar coordinate'
[4292]	1033	ENDIF
[5836]	1034	!
[4486]	1035	#if defined key_agrif
[9190]	1036	IF( (.NOT.Agrif_Root()).AND.(.NOT.ln_vvl_zstar) ) CALL ctl_stop( 'AGRIF is implemented with zstar coordinate only' )
[4486]	1037	#endif
[5836]	1038	!
[4292]	1039	END SUBROUTINE dom_vvl_ctl
	1040
[13237]	1041	#endif
	1042
[592]	1043	!!======================================================================
	1044	END MODULE domvvl

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

Download in other formats: