Context Navigation

bdydta.F90 @ 11480

Last change on this file since 11480 was 11480, checked in by davestorkey, 5 years ago

2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps : Merge in changes from branch of branch.
Main changes:

"nxt" modules renamed as "atf" and now just do Asselin time filtering. The time level swapping is achieved by swapping indices.
Some additional prognostic grid variables changed to use a time dimension.

Notes:

This merged branch passes SETTE tests but does not identical results to the SETTE tests with the trunk@10721 unless minor bugs to do with Euler timestepping and the OFF timestepping are fixed in the trunk (NEMO tickets #2310 and #2311).
The nn_dttrc > 1 option for TOP (TOP has a different timestep to OCE) doesn't work. But it doesn't work in the trunk or NEMO 4.0 release either.

Property svn:keywords set to Id

File size: 34.3 KB

Rev	Line
[911]	1	MODULE bdydta
[1125]	2	!!======================================================================
	3	!! * MODULE bdydta *
[911]	4	!! Open boundary data : read the data for the unstructured open boundaries.
[1125]	5	!!======================================================================
	6	!! History : 1.0 ! 2005-01 (J. Chanut, A. Sellar) Original code
	7	!! - ! 2007-01 (D. Storkey) Update to use IOM module
[2528]	8	!! - ! 2007-07 (D. Storkey) add bdy_dta_fla
[1125]	9	!! 3.0 ! 2008-04 (NEMO team) add in the reference version
[2528]	10	!! 3.3 ! 2010-09 (E.O'Dea) modifications for Shelf configurations
	11	!! 3.3 ! 2010-09 (D.Storkey) add ice boundary conditions
[3294]	12	!! 3.4 ! 2011 (D. Storkey) rewrite in preparation for OBC-BDY merge
[9656]	13	!! 3.6 ! 2012-01 (C. Rousset) add ice boundary conditions for sea ice
	14	!! 4.0 ! 2018 (C. Rousset) SI3 compatibility
[1125]	15	!!----------------------------------------------------------------------
[9019]	16
[1125]	17	!!----------------------------------------------------------------------
[9019]	18	!! bdy_dta : read external data along open boundaries from file
	19	!! bdy_dta_init : initialise arrays etc for reading of external data
	20	!!----------------------------------------------------------------------
	21	USE oce ! ocean dynamics and tracers
	22	USE dom_oce ! ocean space and time domain
	23	USE phycst ! physical constants
	24	USE sbcapr ! atmospheric pressure forcing
	25	USE sbctide ! Tidal forcing or not
	26	USE bdy_oce ! ocean open boundary conditions
	27	USE bdytides ! tidal forcing at boundaries
[9570]	28	#if defined key_si3
[9019]	29	USE ice ! sea-ice variables
	30	USE icevar ! redistribute ice input into categories
[2528]	31	#endif
[9019]	32	!
[10529]	33	USE lib_mpp, ONLY: ctl_stop, ctl_nam
[9019]	34	USE fldread ! read input fields
	35	USE iom ! IOM library
	36	USE in_out_manager ! I/O logical units
	37	USE timing ! Timing
[911]	38
	39	IMPLICIT NONE
	40	PRIVATE
	41
[3294]	42	PUBLIC bdy_dta ! routine called by step.F90 and dynspg_ts.F90
	43	PUBLIC bdy_dta_init ! routine called by nemogcm.F90
[911]	44
[3294]	45	INTEGER, ALLOCATABLE, DIMENSION(:) :: nb_bdy_fld ! Number of fields to update for each boundary set.
	46	INTEGER :: nb_bdy_fld_sum ! Total number of fields to update for all boundary sets.
	47	LOGICAL, DIMENSION(jp_bdy) :: ln_full_vel_array ! =T => full velocities in 3D boundary conditions
	48	! =F => baroclinic velocities in 3D boundary conditions
[4354]	49	!$AGRIF_DO_NOT_TREAT
[3294]	50	TYPE(FLD), PUBLIC, ALLOCATABLE, DIMENSION(:), TARGET :: bf ! structure of input fields (file informations, fields read)
[4354]	51	!$AGRIF_END_DO_NOT_TREAT
[3294]	52	TYPE(MAP_POINTER), ALLOCATABLE, DIMENSION(:) :: nbmap_ptr ! array of pointers to nbmap
[911]	53
[9570]	54	#if defined key_si3
[9019]	55	INTEGER :: nice_cat ! number of categories in the input file
	56	INTEGER :: jfld_hti, jfld_hts, jfld_ai ! indices of ice thickness, snow thickness and concentration in bf structure
[9810]	57	INTEGER, DIMENSION(jp_bdy) :: jfld_htit, jfld_htst, jfld_ait
[4292]	58	#endif
	59
[1125]	60	!!----------------------------------------------------------------------
[9598]	61	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1146]	62	!! $Id$
[10068]	63	!! Software governed by the CeCILL license (see ./LICENSE)
[1125]	64	!!----------------------------------------------------------------------
[911]	65	CONTAINS
	66
[10957]	67	SUBROUTINE bdy_dta( kt, Kmm, time_offset )
[1125]	68	!!----------------------------------------------------------------------
[3294]	69	!! * SUBROUTINE bdy_dta *
[911]	70	!!
[3294]	71	!! ** Purpose : Update external data for open boundary conditions
[911]	72	!!
[3294]	73	!! ** Method : Use fldread.F90
	74	!!
[1125]	75	!!----------------------------------------------------------------------
[6140]	76	INTEGER, INTENT(in) :: kt ! ocean time-step index
[10957]	77	INTEGER, INTENT(in) :: Kmm ! ocean time level index
[6140]	78	INTEGER, INTENT(in), OPTIONAL :: time_offset ! time offset in units of timesteps. NB. if jit
	79	! ! is present then units = subcycle timesteps.
	80	! ! time_offset = 0 => get data at "now" time level
	81	! ! time_offset = -1 => get data at "before" time level
	82	! ! time_offset = +1 => get data at "after" time level
	83	! ! etc.
	84	!
[9019]	85	INTEGER :: jbdy, jfld, jstart, jend, ib, jl ! dummy loop indices
	86	INTEGER :: ii, ij, ik, igrd ! local integers
[3294]	87	INTEGER, DIMENSION(jpbgrd) :: ilen1
	88	INTEGER, POINTER, DIMENSION(:) :: nblen, nblenrim ! short cuts
[4292]	89	TYPE(OBC_DATA), POINTER :: dta ! short cut
[911]	90	!!---------------------------------------------------------------------------
[6140]	91	!
[9124]	92	IF( ln_timing ) CALL timing_start('bdy_dta')
[6140]	93	!
[3294]	94	! Initialise data arrays once for all from initial conditions where required
	95	!---------------------------------------------------------------------------
[10957]	96	IF( kt == nit000 ) THEN
[1125]	97
[3294]	98	! Calculate depth-mean currents
	99	!-----------------------------
	100
[9019]	101	DO jbdy = 1, nb_bdy
[6140]	102	!
[9019]	103	nblen => idx_bdy(jbdy)%nblen
	104	nblenrim => idx_bdy(jbdy)%nblenrim
	105	dta => dta_bdy(jbdy)
	106	!
	107	IF( nn_dyn2d_dta(jbdy) == 0 ) THEN
[3651]	108	ilen1(:) = nblen(:)
[4292]	109	IF( dta%ll_ssh ) THEN
	110	igrd = 1
	111	DO ib = 1, ilen1(igrd)
[9019]	112	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	113	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	114	dta_bdy(jbdy)%ssh(ib) = ssh(ii,ij,Kmm) * tmask(ii,ij,1)
[4292]	115	END DO
[9019]	116	ENDIF
[4292]	117	IF( dta%ll_u2d ) THEN
	118	igrd = 2
	119	DO ib = 1, ilen1(igrd)
[9019]	120	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	121	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	122	dta_bdy(jbdy)%u2d(ib) = uu_b(ii,ij,Kmm) * umask(ii,ij,1)
[4292]	123	END DO
[9019]	124	ENDIF
[4292]	125	IF( dta%ll_v2d ) THEN
	126	igrd = 3
	127	DO ib = 1, ilen1(igrd)
[9019]	128	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	129	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	130	dta_bdy(jbdy)%v2d(ib) = vv_b(ii,ij,Kmm) * vmask(ii,ij,1)
[4292]	131	END DO
[9019]	132	ENDIF
[4292]	133	ENDIF
[9019]	134	!
	135	IF( nn_dyn3d_dta(jbdy) == 0 ) THEN
[4292]	136	ilen1(:) = nblen(:)
	137	IF( dta%ll_u3d ) THEN
	138	igrd = 2
	139	DO ib = 1, ilen1(igrd)
	140	DO ik = 1, jpkm1
[9019]	141	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	142	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	143	dta_bdy(jbdy)%u3d(ib,ik) = ( uu(ii,ij,ik,Kmm) - uu_b(ii,ij,Kmm) ) * umask(ii,ij,ik)
[3294]	144	END DO
[4292]	145	END DO
[9019]	146	ENDIF
[4292]	147	IF( dta%ll_v3d ) THEN
	148	igrd = 3
	149	DO ib = 1, ilen1(igrd)
	150	DO ik = 1, jpkm1
[9019]	151	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	152	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	153	dta_bdy(jbdy)%v3d(ib,ik) = ( vv(ii,ij,ik,Kmm) - vv_b(ii,ij,Kmm) ) * vmask(ii,ij,ik)
[4292]	154	END DO
	155	END DO
[9019]	156	ENDIF
[3294]	157	ENDIF
[911]	158
[9019]	159	IF( nn_tra_dta(jbdy) == 0 ) THEN
[3651]	160	ilen1(:) = nblen(:)
[4292]	161	IF( dta%ll_tem ) THEN
	162	igrd = 1
	163	DO ib = 1, ilen1(igrd)
	164	DO ik = 1, jpkm1
[9019]	165	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	166	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	167	dta_bdy(jbdy)%tem(ib,ik) = ts(ii,ij,ik,jp_tem,Kmm) * tmask(ii,ij,ik)
[4292]	168	END DO
	169	END DO
[9019]	170	ENDIF
[4292]	171	IF( dta%ll_sal ) THEN
	172	igrd = 1
	173	DO ib = 1, ilen1(igrd)
	174	DO ik = 1, jpkm1
[9019]	175	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	176	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	177	dta_bdy(jbdy)%sal(ib,ik) = ts(ii,ij,ik,jp_sal,Kmm) * tmask(ii,ij,ik)
[4292]	178	END DO
	179	END DO
[9019]	180	ENDIF
[3294]	181	ENDIF
[911]	182
[9570]	183	#if defined key_si3
[9657]	184	IF( nn_ice_dta(jbdy) == 0 ) THEN ! set ice to initial values
[3651]	185	ilen1(:) = nblen(:)
[4292]	186	IF( dta%ll_a_i ) THEN
	187	igrd = 1
	188	DO jl = 1, jpl
	189	DO ib = 1, ilen1(igrd)
[9019]	190	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	191	ij = idx_bdy(jbdy)%nbj(ib,igrd)
	192	dta_bdy(jbdy)%a_i (ib,jl) = a_i(ii,ij,jl) * tmask(ii,ij,1)
[4292]	193	END DO
	194	END DO
	195	ENDIF
[9019]	196	IF( dta%ll_h_i ) THEN
[4292]	197	igrd = 1
	198	DO jl = 1, jpl
	199	DO ib = 1, ilen1(igrd)
[9019]	200	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	201	ij = idx_bdy(jbdy)%nbj(ib,igrd)
	202	dta_bdy(jbdy)%h_i (ib,jl) = h_i(ii,ij,jl) * tmask(ii,ij,1)
[4292]	203	END DO
	204	END DO
	205	ENDIF
[9019]	206	IF( dta%ll_h_s ) THEN
[4292]	207	igrd = 1
	208	DO jl = 1, jpl
	209	DO ib = 1, ilen1(igrd)
[9019]	210	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	211	ij = idx_bdy(jbdy)%nbj(ib,igrd)
	212	dta_bdy(jbdy)%h_s (ib,jl) = h_s(ii,ij,jl) * tmask(ii,ij,1)
[4292]	213	END DO
	214	END DO
	215	ENDIF
	216	ENDIF
[3294]	217	#endif
[9019]	218	END DO ! jbdy
[6140]	219	!
	220	ENDIF ! kt == nit000
[911]	221
[3294]	222	! update external data from files
	223	!--------------------------------
	224
	225	jstart = 1
[9019]	226	DO jbdy = 1, nb_bdy
	227	dta => dta_bdy(jbdy)
	228	IF( nn_dta(jbdy) == 1 ) THEN ! skip this bit if no external data required
[10957]	229	IF (cn_tra(jbdy) == 'runoff') then ! runoff condition
	230	jend = nb_bdy_fld(jbdy)
	231	CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), &
	232	& map=nbmap_ptr(jstart:jend), kt_offset=time_offset )
	233	!
	234	igrd = 2 ! zonal velocity
	235	DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
	236	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	237	ij = idx_bdy(jbdy)%nbj(ib,igrd)
	238	dta%u2d(ib) = dta%u2d(ib) / ( e2u(ii,ij) * hu_0(ii,ij) )
	239	END DO
	240	!
	241	igrd = 3 ! meridional velocity
	242	DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
	243	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	244	ij = idx_bdy(jbdy)%nbj(ib,igrd)
	245	dta%v2d(ib) = dta%v2d(ib) / ( e1v(ii,ij) * hv_0(ii,ij) )
	246	END DO
	247	ELSE
	248	IF( nn_dyn2d_dta(jbdy) == 2 ) THEN ! tidal harmonic forcing ONLY: initialise arrays
	249	IF( dta%ll_ssh ) dta%ssh(:) = 0._wp
	250	IF( dta%ll_u2d ) dta%u2d(:) = 0._wp
	251	IF( dta%ll_v2d ) dta%v2d(:) = 0._wp
[1125]	252	ENDIF
[10957]	253	IF( dta%nread(1) .gt. 0 ) THEN ! update external data
	254	jend = jstart + dta%nread(1) - 1
	255	CALL fld_read( kt=kt, kn_fsbc=1, sd=bf(jstart:jend), &
	256	& map=nbmap_ptr(jstart:jend), kt_offset=time_offset, jpk_bdy=nb_jpk_bdy, &
[11480]	257	& fvl=ln_full_vel_array(jbdy), Kmm=Kmm )
[10957]	258	ENDIF
	259	! If full velocities in boundary data then split into barotropic and baroclinic data
	260	IF( ln_full_vel_array(jbdy) .and. &
	261	& ( nn_dyn2d_dta(jbdy) == 1 .OR. nn_dyn2d_dta(jbdy) == 3 .OR. &
	262	& nn_dyn3d_dta(jbdy) == 1 ) ) THEN
[3651]	263	igrd = 2 ! zonal velocity
[10957]	264	dta%u2d(:) = 0._wp
[9019]	265	DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
	266	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	267	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	268	DO ik = 1, jpkm1
	269	dta%u2d(ib) = dta%u2d(ib) &
	270	& + e3u(ii,ij,ik,Kmm) * umask(ii,ij,ik) * dta%u3d(ib,ik)
	271	END DO
[11480]	272	dta%u2d(ib) = dta%u2d(ib) * r1_hu(ii,ij,Kmm)
[10957]	273	DO ik = 1, jpkm1
	274	dta%u3d(ib,ik) = dta%u3d(ib,ik) - dta%u2d(ib)
	275	END DO
[3651]	276	END DO
	277	igrd = 3 ! meridional velocity
[10957]	278	dta%v2d(:) = 0._wp
[9019]	279	DO ib = 1, idx_bdy(jbdy)%nblen(igrd)
	280	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	281	ij = idx_bdy(jbdy)%nbj(ib,igrd)
[10957]	282	DO ik = 1, jpkm1
	283	dta%v2d(ib) = dta%v2d(ib) &
	284	& + e3v(ii,ij,ik,Kmm) * vmask(ii,ij,ik) * dta%v3d(ib,ik)
[3651]	285	END DO
[11480]	286	dta%v2d(ib) = dta%v2d(ib) * r1_hv(ii,ij,Kmm)
[10957]	287	DO ik = 1, jpkm1
	288	dta%v3d(ib,ik) = dta%v3d(ib,ik) - dta%v2d(ib)
[3651]	289	END DO
[10957]	290	END DO
	291	ENDIF
[4292]	292
[10957]	293	ENDIF
[9570]	294	#if defined key_si3
[10957]	295	! convert N-cat fields (input) into jpl-cat (output)
	296	IF( cn_ice(jbdy) /= 'none' .AND. nn_ice_dta(jbdy) == 1 ) THEN
	297	jfld_hti = jfld_htit(jbdy)
	298	jfld_hts = jfld_htst(jbdy)
	299	jfld_ai = jfld_ait(jbdy)
	300	IF ( jpl /= 1 .AND. nice_cat == 1 ) THEN ! case input cat = 1
	301	CALL ice_var_itd ( bf(jfld_hti)%fnow(:,1,1), bf(jfld_hts)%fnow(:,1,1), bf(jfld_ai)%fnow(:,1,1), &
	302	& dta_bdy(jbdy)%h_i , dta_bdy(jbdy)%h_s , dta_bdy(jbdy)%a_i )
	303	ELSEIF( jpl /= 1 .AND. nice_cat /= 1 .AND. nice_cat /= jpl ) THEN ! case input cat /=1 and /=jpl
	304	CALL ice_var_itd2( bf(jfld_hti)%fnow(:,1,:), bf(jfld_hts)%fnow(:,1,:), bf(jfld_ai)%fnow(:,1,:), &
	305	& dta_bdy(jbdy)%h_i , dta_bdy(jbdy)%h_s , dta_bdy(jbdy)%a_i )
[4292]	306	ENDIF
[10957]	307	ENDIF
[4292]	308	#endif
	309	jstart = jstart + dta%nread(1)
[9019]	310	ENDIF ! nn_dta(jbdy) = 1
	311	END DO ! jbdy
[911]	312
[10647]	313	IF ( ln_apr_obc ) THEN
	314	DO jbdy = 1, nb_bdy
	315	IF (cn_tra(jbdy) /= 'runoff')THEN
	316	igrd = 1 ! meridional velocity
	317	DO ib = 1, idx_bdy(jbdy)%nblenrim(igrd)
	318	ii = idx_bdy(jbdy)%nbi(ib,igrd)
	319	ij = idx_bdy(jbdy)%nbj(ib,igrd)
	320	dta_bdy(jbdy)%ssh(ib) = dta_bdy(jbdy)%ssh(ib) + ssh_ib(ii,ij)
	321	END DO
	322	ENDIF
	323	END DO
	324	ENDIF
	325
[7646]	326	IF ( ln_tide ) THEN
	327	IF (ln_dynspg_ts) THEN ! Fill temporary arrays with slow-varying bdy data
[9019]	328	DO jbdy = 1, nb_bdy ! Tidal component added in ts loop
	329	IF ( nn_dyn2d_dta(jbdy) .ge. 2 ) THEN
	330	nblen => idx_bdy(jbdy)%nblen
	331	nblenrim => idx_bdy(jbdy)%nblenrim
	332	IF( cn_dyn2d(jbdy) == 'frs' ) THEN; ilen1(:)=nblen(:) ; ELSE ; ilen1(:)=nblenrim(:) ; ENDIF
	333	IF ( dta_bdy(jbdy)%ll_ssh ) dta_bdy_s(jbdy)%ssh(1:ilen1(1)) = dta_bdy(jbdy)%ssh(1:ilen1(1))
	334	IF ( dta_bdy(jbdy)%ll_u2d ) dta_bdy_s(jbdy)%u2d(1:ilen1(2)) = dta_bdy(jbdy)%u2d(1:ilen1(2))
	335	IF ( dta_bdy(jbdy)%ll_v2d ) dta_bdy_s(jbdy)%v2d(1:ilen1(3)) = dta_bdy(jbdy)%v2d(1:ilen1(3))
[7646]	336	ENDIF
	337	END DO
	338	ELSE ! Add tides if not split-explicit free surface else this is done in ts loop
	339	!
	340	CALL bdy_dta_tides( kt=kt, time_offset=time_offset )
	341	ENDIF
[5930]	342	ENDIF
[4292]	343
[6140]	344	!
[9124]	345	IF( ln_timing ) CALL timing_stop('bdy_dta')
[6140]	346	!
	347	END SUBROUTINE bdy_dta
[911]	348
	349
[6140]	350	SUBROUTINE bdy_dta_init
[3294]	351	!!----------------------------------------------------------------------
	352	!! * SUBROUTINE bdy_dta_init *
	353	!!
	354	!! ** Purpose : Initialise arrays for reading of external data
	355	!! for open boundary conditions
	356	!!
[4292]	357	!! ** Method :
[3294]	358	!!
	359	!!----------------------------------------------------------------------
[9019]	360	INTEGER :: jbdy, jfld, jstart, jend, ierror, ios ! Local integers
[6140]	361	!
[3294]	362	CHARACTER(len=100) :: cn_dir ! Root directory for location of data files
	363	CHARACTER(len=100), DIMENSION(nb_bdy) :: cn_dir_array ! Root directory for location of data files
[5919]	364	CHARACTER(len = 256):: clname ! temporary file name
[3294]	365	LOGICAL :: ln_full_vel ! =T => full velocities in 3D boundary data
[9019]	366	! ! =F => baroclinic velocities in 3D boundary data
[3294]	367	INTEGER :: ilen_global ! Max length required for global bdy dta arrays
	368	INTEGER, ALLOCATABLE, DIMENSION(:) :: ilen1, ilen3 ! size of 1st and 3rd dimensions of local arrays
	369	INTEGER, ALLOCATABLE, DIMENSION(:) :: ibdy ! bdy set for a particular jfld
	370	INTEGER, ALLOCATABLE, DIMENSION(:) :: igrid ! index for grid type (1,2,3 = T,U,V)
	371	INTEGER, POINTER, DIMENSION(:) :: nblen, nblenrim ! short cuts
[4292]	372	TYPE(OBC_DATA), POINTER :: dta ! short cut
[9570]	373	#if defined key_si3
[9019]	374	INTEGER :: kndims ! number of dimensions in an array (i.e. 3 = wo ice cat; 4 = w ice cat)
	375	INTEGER, DIMENSION(4) :: kdimsz ! size of dimensions
[4292]	376	INTEGER :: inum,id1 ! local integer
	377	#endif
[3294]	378	TYPE(FLD_N), ALLOCATABLE, DIMENSION(:) :: blf_i ! array of namelist information structures
	379	TYPE(FLD_N) :: bn_tem, bn_sal, bn_u3d, bn_v3d !
	380	TYPE(FLD_N) :: bn_ssh, bn_u2d, bn_v2d ! informations about the fields to be read
[9570]	381	#if defined key_si3
[9019]	382	TYPE(FLD_N) :: bn_a_i, bn_h_i, bn_h_s
[2528]	383	#endif
[3294]	384	NAMELIST/nambdy_dta/ cn_dir, bn_tem, bn_sal, bn_u3d, bn_v3d, bn_ssh, bn_u2d, bn_v2d
[9570]	385	#if defined key_si3
[9019]	386	NAMELIST/nambdy_dta/ bn_a_i, bn_h_i, bn_h_s
[3294]	387	#endif
[7646]	388	NAMELIST/nambdy_dta/ ln_full_vel, nb_jpk_bdy
[3294]	389	!!---------------------------------------------------------------------------
[6140]	390	!
[3651]	391	IF(lwp) WRITE(numout,*)
	392	IF(lwp) WRITE(numout,*) 'bdy_dta_ini : initialization of data at the open boundaries'
	393	IF(lwp) WRITE(numout,*) '~~~~~~~~~~'
	394	IF(lwp) WRITE(numout,*) ''
	395
[3294]	396	! Set nn_dta
[9019]	397	DO jbdy = 1, nb_bdy
	398	nn_dta(jbdy) = MAX( nn_dyn2d_dta (jbdy) &
	399	& , nn_dyn3d_dta (jbdy) &
	400	& , nn_tra_dta (jbdy) &
[9570]	401	#if defined key_si3
[9657]	402	& , nn_ice_dta (jbdy) &
[2528]	403	#endif
[3294]	404	)
[9019]	405	IF(nn_dta(jbdy) > 1) nn_dta(jbdy) = 1
[3294]	406	END DO
[911]	407
[3294]	408	! Work out upper bound of how many fields there are to read in and allocate arrays
	409	! ---------------------------------------------------------------------------
	410	ALLOCATE( nb_bdy_fld(nb_bdy) )
	411	nb_bdy_fld(:) = 0
[9019]	412	DO jbdy = 1, nb_bdy
	413	IF( cn_dyn2d(jbdy) /= 'none' .AND. ( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) ) THEN
	414	nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 3
[3294]	415	ENDIF
[9019]	416	IF( cn_dyn3d(jbdy) /= 'none' .AND. nn_dyn3d_dta(jbdy) == 1 ) THEN
	417	nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 2
[3294]	418	ENDIF
[9019]	419	IF( cn_tra(jbdy) /= 'none' .AND. nn_tra_dta(jbdy) == 1 ) THEN
	420	nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 2
[3294]	421	ENDIF
[9570]	422	#if defined key_si3
[9657]	423	IF( cn_ice(jbdy) /= 'none' .AND. nn_ice_dta(jbdy) == 1 ) THEN
[9019]	424	nb_bdy_fld(jbdy) = nb_bdy_fld(jbdy) + 3
[3294]	425	ENDIF
	426	#endif
[9019]	427	IF(lwp) WRITE(numout,*) 'Maximum number of files to open =', nb_bdy_fld(jbdy)
[6140]	428	END DO
[2528]	429
[3294]	430	nb_bdy_fld_sum = SUM( nb_bdy_fld )
[911]	431
[3294]	432	ALLOCATE( bf(nb_bdy_fld_sum), STAT=ierror )
	433	IF( ierror > 0 ) THEN
	434	CALL ctl_stop( 'bdy_dta: unable to allocate bf structure' ) ; RETURN
[911]	435	ENDIF
[3294]	436	ALLOCATE( blf_i(nb_bdy_fld_sum), STAT=ierror )
	437	IF( ierror > 0 ) THEN
	438	CALL ctl_stop( 'bdy_dta: unable to allocate blf_i structure' ) ; RETURN
[1125]	439	ENDIF
[3294]	440	ALLOCATE( nbmap_ptr(nb_bdy_fld_sum), STAT=ierror )
	441	IF( ierror > 0 ) THEN
	442	CALL ctl_stop( 'bdy_dta: unable to allocate nbmap_ptr structure' ) ; RETURN
	443	ENDIF
	444	ALLOCATE( ilen1(nb_bdy_fld_sum), ilen3(nb_bdy_fld_sum) )
	445	ALLOCATE( ibdy(nb_bdy_fld_sum) )
	446	ALLOCATE( igrid(nb_bdy_fld_sum) )
[911]	447
[3294]	448	! Read namelists
	449	! --------------
[4147]	450	REWIND(numnam_ref)
	451	REWIND(numnam_cfg)
[3294]	452	jfld = 0
[9019]	453	DO jbdy = 1, nb_bdy
	454	IF( nn_dta(jbdy) == 1 ) THEN
[4147]	455	READ ( numnam_ref, nambdy_dta, IOSTAT = ios, ERR = 901)
[6140]	456	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'nambdy_dta in reference namelist', lwp )
[4147]	457	READ ( numnam_cfg, nambdy_dta, IOSTAT = ios, ERR = 902 )
[9168]	458	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'nambdy_dta in configuration namelist', lwp )
[6140]	459	IF(lwm) WRITE( numond, nambdy_dta )
[4147]	460
[9019]	461	cn_dir_array(jbdy) = cn_dir
	462	ln_full_vel_array(jbdy) = ln_full_vel
[911]	463
[9019]	464	nblen => idx_bdy(jbdy)%nblen
	465	nblenrim => idx_bdy(jbdy)%nblenrim
	466	dta => dta_bdy(jbdy)
[4292]	467	dta%nread(2) = 0
[911]	468
[3294]	469	! Only read in necessary fields for this set.
	470	! Important that barotropic variables come first.
[9019]	471	IF( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) THEN
[911]	472
[4292]	473	IF( dta%ll_ssh ) THEN
	474	if(lwp) write(numout,*) '++++++ reading in ssh field'
[3294]	475	jfld = jfld + 1
	476	blf_i(jfld) = bn_ssh
[9019]	477	ibdy(jfld) = jbdy
[3294]	478	igrid(jfld) = 1
[3651]	479	ilen1(jfld) = nblen(igrid(jfld))
[3294]	480	ilen3(jfld) = 1
[4292]	481	dta%nread(2) = dta%nread(2) + 1
[3294]	482	ENDIF
[911]	483
[9019]	484	IF( dta%ll_u2d .and. .not. ln_full_vel_array(jbdy) ) THEN
[4292]	485	if(lwp) write(numout,*) '++++++ reading in u2d field'
[3294]	486	jfld = jfld + 1
	487	blf_i(jfld) = bn_u2d
[9019]	488	ibdy(jfld) = jbdy
[3294]	489	igrid(jfld) = 2
[3651]	490	ilen1(jfld) = nblen(igrid(jfld))
[3294]	491	ilen3(jfld) = 1
[4292]	492	dta%nread(2) = dta%nread(2) + 1
	493	ENDIF
[911]	494
[9019]	495	IF( dta%ll_v2d .and. .not. ln_full_vel_array(jbdy) ) THEN
[4292]	496	if(lwp) write(numout,*) '++++++ reading in v2d field'
[3294]	497	jfld = jfld + 1
	498	blf_i(jfld) = bn_v2d
[9019]	499	ibdy(jfld) = jbdy
[3294]	500	igrid(jfld) = 3
[3651]	501	ilen1(jfld) = nblen(igrid(jfld))
[3294]	502	ilen3(jfld) = 1
[4292]	503	dta%nread(2) = dta%nread(2) + 1
[3294]	504	ENDIF
[911]	505
[3294]	506	ENDIF
[1125]	507
[4292]	508	! read 3D velocities if baroclinic velocities require OR if
	509	! barotropic velocities required and ln_full_vel set to .true.
[9019]	510	IF( nn_dyn3d_dta(jbdy) == 1 .OR. &
	511	& ( ln_full_vel_array(jbdy) .AND. ( nn_dyn2d_dta(jbdy) == 1 .OR. nn_dyn2d_dta(jbdy) == 3 ) ) ) THEN
[911]	512
[9019]	513	IF( dta%ll_u3d .OR. ( ln_full_vel_array(jbdy) .and. dta%ll_u2d ) ) THEN
[4292]	514	if(lwp) write(numout,*) '++++++ reading in u3d field'
	515	jfld = jfld + 1
	516	blf_i(jfld) = bn_u3d
[9019]	517	ibdy(jfld) = jbdy
[4292]	518	igrid(jfld) = 2
	519	ilen1(jfld) = nblen(igrid(jfld))
	520	ilen3(jfld) = jpk
[9019]	521	IF( ln_full_vel_array(jbdy) .and. dta%ll_u2d ) dta%nread(2) = dta%nread(2) + 1
[4292]	522	ENDIF
[911]	523
[9019]	524	IF( dta%ll_v3d .OR. ( ln_full_vel_array(jbdy) .and. dta%ll_v2d ) ) THEN
[4292]	525	if(lwp) write(numout,*) '++++++ reading in v3d field'
	526	jfld = jfld + 1
	527	blf_i(jfld) = bn_v3d
[9019]	528	ibdy(jfld) = jbdy
[4292]	529	igrid(jfld) = 3
	530	ilen1(jfld) = nblen(igrid(jfld))
	531	ilen3(jfld) = jpk
[9019]	532	IF( ln_full_vel_array(jbdy) .and. dta%ll_v2d ) dta%nread(2) = dta%nread(2) + 1
[4292]	533	ENDIF
[911]	534
[3294]	535	ENDIF
[911]	536
[3294]	537	! temperature and salinity
[9019]	538	IF( nn_tra_dta(jbdy) == 1 ) THEN
[911]	539
[4292]	540	IF( dta%ll_tem ) THEN
	541	if(lwp) write(numout,*) '++++++ reading in tem field'
	542	jfld = jfld + 1
	543	blf_i(jfld) = bn_tem
[9019]	544	ibdy(jfld) = jbdy
[4292]	545	igrid(jfld) = 1
	546	ilen1(jfld) = nblen(igrid(jfld))
	547	ilen3(jfld) = jpk
	548	ENDIF
[911]	549
[4292]	550	IF( dta%ll_sal ) THEN
	551	if(lwp) write(numout,*) '++++++ reading in sal field'
	552	jfld = jfld + 1
	553	blf_i(jfld) = bn_sal
[9019]	554	ibdy(jfld) = jbdy
[4292]	555	igrid(jfld) = 1
	556	ilen1(jfld) = nblen(igrid(jfld))
	557	ilen3(jfld) = jpk
	558	ENDIF
[911]	559
	560	ENDIF
	561
[9570]	562	#if defined key_si3
[3294]	563	! sea ice
[9657]	564	IF( nn_ice_dta(jbdy) == 1 ) THEN
[9019]	565	! Test for types of ice input (1cat or Xcat)
[5919]	566	! Build file name to find dimensions
[7861]	567	clname=TRIM( cn_dir )//TRIM(bn_a_i%clname)
[5919]	568	IF( .NOT. bn_a_i%ln_clim ) THEN
[7861]	569	WRITE(clname, '(a,"_y",i4.4)' ) TRIM( clname ), nyear ! add year
	570	IF( bn_a_i%cltype /= 'yearly' ) WRITE(clname, '(a,"m" ,i2.2)' ) TRIM( clname ), nmonth ! add month
[5919]	571	ELSE
[7861]	572	IF( bn_a_i%cltype /= 'yearly' ) WRITE(clname, '(a,"_m",i2.2)' ) TRIM( clname ), nmonth ! add month
[5919]	573	ENDIF
	574	IF( bn_a_i%cltype == 'daily' .OR. bn_a_i%cltype(1:4) == 'week' ) &
[7861]	575	& WRITE(clname, '(a,"d" ,i2.2)' ) TRIM( clname ), nday ! add day
[5919]	576	!
	577	CALL iom_open ( clname, inum )
[9019]	578	id1 = iom_varid( inum, bn_a_i%clvar, kdimsz=kdimsz, kndims=kndims, ldstop = .FALSE. )
[5919]	579	CALL iom_close ( inum )
[4292]	580
[9019]	581	IF ( kndims == 4 ) THEN
	582	nice_cat = kdimsz(4) ! Xcat input
[4292]	583	ELSE
[9019]	584	nice_cat = 1 ! 1cat input
[4292]	585	ENDIF
	586	! End test
	587
	588	IF( dta%ll_a_i ) THEN
	589	jfld = jfld + 1
	590	blf_i(jfld) = bn_a_i
[9019]	591	ibdy(jfld) = jbdy
[4292]	592	igrid(jfld) = 1
	593	ilen1(jfld) = nblen(igrid(jfld))
[9019]	594	ilen3(jfld) = nice_cat
[4292]	595	ENDIF
	596
[9019]	597	IF( dta%ll_h_i ) THEN
[4292]	598	jfld = jfld + 1
[9019]	599	blf_i(jfld) = bn_h_i
	600	ibdy(jfld) = jbdy
[4292]	601	igrid(jfld) = 1
	602	ilen1(jfld) = nblen(igrid(jfld))
[9019]	603	ilen3(jfld) = nice_cat
[4292]	604	ENDIF
	605
[9019]	606	IF( dta%ll_h_s ) THEN
[4292]	607	jfld = jfld + 1
[9019]	608	blf_i(jfld) = bn_h_s
	609	ibdy(jfld) = jbdy
[4292]	610	igrid(jfld) = 1
	611	ilen1(jfld) = nblen(igrid(jfld))
[9019]	612	ilen3(jfld) = nice_cat
[4292]	613	ENDIF
	614
[4333]	615	ENDIF
[3294]	616	#endif
	617	! Recalculate field counts
	618	!-------------------------
[9019]	619	IF( jbdy == 1 ) THEN
[4148]	620	nb_bdy_fld_sum = 0
[9019]	621	nb_bdy_fld(jbdy) = jfld
[3294]	622	nb_bdy_fld_sum = jfld
	623	ELSE
[9019]	624	nb_bdy_fld(jbdy) = jfld - nb_bdy_fld_sum
	625	nb_bdy_fld_sum = nb_bdy_fld_sum + nb_bdy_fld(jbdy)
[3294]	626	ENDIF
[911]	627
[9019]	628	dta%nread(1) = nb_bdy_fld(jbdy)
[4292]	629
[6140]	630	ENDIF ! nn_dta == 1
[9019]	631	ENDDO ! jbdy
[911]	632
[3294]	633	DO jfld = 1, nb_bdy_fld_sum
	634	ALLOCATE( bf(jfld)%fnow(ilen1(jfld),1,ilen3(jfld)) )
	635	IF( blf_i(jfld)%ln_tint ) ALLOCATE( bf(jfld)%fdta(ilen1(jfld),1,ilen3(jfld),2) )
	636	nbmap_ptr(jfld)%ptr => idx_bdy(ibdy(jfld))%nbmap(:,igrid(jfld))
[5132]	637	nbmap_ptr(jfld)%ll_unstruc = ln_coords_file(ibdy(jfld))
[3294]	638	ENDDO
[911]	639
[3294]	640	! fill bf with blf_i and control print
	641	!-------------------------------------
	642	jstart = 1
[9019]	643	DO jbdy = 1, nb_bdy
	644	jend = jstart - 1 + nb_bdy_fld(jbdy)
	645	CALL fld_fill( bf(jstart:jend), blf_i(jstart:jend), cn_dir_array(jbdy), 'bdy_dta', &
[3294]	646	& 'open boundary conditions', 'nambdy_dta' )
	647	jstart = jend + 1
	648	ENDDO
[911]	649
[9629]	650	DO jfld = 1, nb_bdy_fld_sum
	651	bf(jfld)%igrd = igrid(jfld)
	652	bf(jfld)%ibdy = ibdy(jfld)
	653	ENDDO
	654
[3294]	655	! Initialise local boundary data arrays
	656	! nn_xxx_dta=0 : allocate space - will be filled from initial conditions later
	657	! nn_xxx_dta=1 : point to "fnow" arrays
	658	!-------------------------------------
[911]	659
[3294]	660	jfld = 0
[9019]	661	DO jbdy=1, nb_bdy
[911]	662
[9019]	663	nblen => idx_bdy(jbdy)%nblen
	664	dta => dta_bdy(jbdy)
[911]	665
[4292]	666	if(lwp) then
	667	write(numout,*) '++++++ dta%ll_ssh = ',dta%ll_ssh
	668	write(numout,*) '++++++ dta%ll_u2d = ',dta%ll_u2d
	669	write(numout,*) '++++++ dta%ll_v2d = ',dta%ll_v2d
	670	write(numout,*) '++++++ dta%ll_u3d = ',dta%ll_u3d
	671	write(numout,*) '++++++ dta%ll_v3d = ',dta%ll_v3d
	672	write(numout,*) '++++++ dta%ll_tem = ',dta%ll_tem
	673	write(numout,*) '++++++ dta%ll_sal = ',dta%ll_sal
	674	endif
	675
[9019]	676	IF ( nn_dyn2d_dta(jbdy) == 0 .or. nn_dyn2d_dta(jbdy) == 2 ) THEN
[4292]	677	if(lwp) write(numout,*) '++++++ dta%ssh/u2d/u3d allocated space'
	678	IF( dta%ll_ssh ) ALLOCATE( dta%ssh(nblen(1)) )
	679	IF( dta%ll_u2d ) ALLOCATE( dta%u2d(nblen(2)) )
	680	IF( dta%ll_v2d ) ALLOCATE( dta%v2d(nblen(3)) )
	681	ENDIF
[9019]	682	IF ( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) THEN
[4292]	683	IF( dta%ll_ssh ) THEN
	684	if(lwp) write(numout,*) '++++++ dta%ssh pointing to fnow'
	685	jfld = jfld + 1
	686	dta%ssh => bf(jfld)%fnow(:,1,1)
	687	ENDIF
	688	IF ( dta%ll_u2d ) THEN
[9019]	689	IF ( ln_full_vel_array(jbdy) ) THEN
[4292]	690	if(lwp) write(numout,*) '++++++ dta%u2d allocated space'
	691	ALLOCATE( dta%u2d(nblen(2)) )
	692	ELSE
	693	if(lwp) write(numout,*) '++++++ dta%u2d pointing to fnow'
[3651]	694	jfld = jfld + 1
[4292]	695	dta%u2d => bf(jfld)%fnow(:,1,1)
	696	ENDIF
	697	ENDIF
	698	IF ( dta%ll_v2d ) THEN
[9019]	699	IF ( ln_full_vel_array(jbdy) ) THEN
[4292]	700	if(lwp) write(numout,*) '++++++ dta%v2d allocated space'
	701	ALLOCATE( dta%v2d(nblen(3)) )
[3294]	702	ELSE
[4292]	703	if(lwp) write(numout,*) '++++++ dta%v2d pointing to fnow'
[3294]	704	jfld = jfld + 1
[4292]	705	dta%v2d => bf(jfld)%fnow(:,1,1)
[3294]	706	ENDIF
	707	ENDIF
	708	ENDIF
[911]	709
[9019]	710	IF ( nn_dyn3d_dta(jbdy) == 0 ) THEN
[4292]	711	if(lwp) write(numout,*) '++++++ dta%u3d/v3d allocated space'
[9019]	712	IF( dta%ll_u3d ) ALLOCATE( dta_bdy(jbdy)%u3d(nblen(2),jpk) )
	713	IF( dta%ll_v3d ) ALLOCATE( dta_bdy(jbdy)%v3d(nblen(3),jpk) )
[3294]	714	ENDIF
[9019]	715	IF ( nn_dyn3d_dta(jbdy) == 1 .or. &
	716	& ( ln_full_vel_array(jbdy) .and. ( nn_dyn2d_dta(jbdy) == 1 .or. nn_dyn2d_dta(jbdy) == 3 ) ) ) THEN
	717	IF ( dta%ll_u3d .or. ( ln_full_vel_array(jbdy) .and. dta%ll_u2d ) ) THEN
[4292]	718	if(lwp) write(numout,*) '++++++ dta%u3d pointing to fnow'
	719	jfld = jfld + 1
[9019]	720	dta_bdy(jbdy)%u3d => bf(jfld)%fnow(:,1,:)
[4292]	721	ENDIF
[9019]	722	IF ( dta%ll_v3d .or. ( ln_full_vel_array(jbdy) .and. dta%ll_v2d ) ) THEN
[4292]	723	if(lwp) write(numout,*) '++++++ dta%v3d pointing to fnow'
	724	jfld = jfld + 1
[9019]	725	dta_bdy(jbdy)%v3d => bf(jfld)%fnow(:,1,:)
[4292]	726	ENDIF
[3294]	727	ENDIF
[911]	728
[9019]	729	IF( nn_tra_dta(jbdy) == 0 ) THEN
[4292]	730	if(lwp) write(numout,*) '++++++ dta%tem/sal allocated space'
[9019]	731	IF( dta%ll_tem ) ALLOCATE( dta_bdy(jbdy)%tem(nblen(1),jpk) )
	732	IF( dta%ll_sal ) ALLOCATE( dta_bdy(jbdy)%sal(nblen(1),jpk) )
[4292]	733	ELSE
	734	IF( dta%ll_tem ) THEN
	735	if(lwp) write(numout,*) '++++++ dta%tem pointing to fnow'
[3294]	736	jfld = jfld + 1
[9019]	737	dta_bdy(jbdy)%tem => bf(jfld)%fnow(:,1,:)
[4292]	738	ENDIF
	739	IF( dta%ll_sal ) THEN
	740	if(lwp) write(numout,*) '++++++ dta%sal pointing to fnow'
[3294]	741	jfld = jfld + 1
[9019]	742	dta_bdy(jbdy)%sal => bf(jfld)%fnow(:,1,:)
[3294]	743	ENDIF
	744	ENDIF
[911]	745
[9570]	746	#if defined key_si3
[9657]	747	IF (cn_ice(jbdy) /= 'none') THEN
	748	IF( nn_ice_dta(jbdy) == 0 ) THEN
[9019]	749	ALLOCATE( dta_bdy(jbdy)%a_i(nblen(1),jpl) )
	750	ALLOCATE( dta_bdy(jbdy)%h_i(nblen(1),jpl) )
	751	ALLOCATE( dta_bdy(jbdy)%h_s(nblen(1),jpl) )
[3294]	752	ELSE
[9019]	753	IF ( nice_cat == jpl ) THEN ! case input cat = jpl
[4292]	754	jfld = jfld + 1
[9019]	755	dta_bdy(jbdy)%a_i => bf(jfld)%fnow(:,1,:)
[4292]	756	jfld = jfld + 1
[9019]	757	dta_bdy(jbdy)%h_i => bf(jfld)%fnow(:,1,:)
[4292]	758	jfld = jfld + 1
[9019]	759	dta_bdy(jbdy)%h_s => bf(jfld)%fnow(:,1,:)
	760	ELSE ! case input cat = 1 OR (/=1 and /=jpl)
[9810]	761	jfld_ait(jbdy) = jfld + 1
	762	jfld_htit(jbdy) = jfld + 2
	763	jfld_htst(jbdy) = jfld + 3
[4292]	764	jfld = jfld + 3
[9019]	765	ALLOCATE( dta_bdy(jbdy)%a_i(nblen(1),jpl) )
	766	ALLOCATE( dta_bdy(jbdy)%h_i(nblen(1),jpl) )
	767	ALLOCATE( dta_bdy(jbdy)%h_s(nblen(1),jpl) )
	768	dta_bdy(jbdy)%a_i(:,:) = 0._wp
	769	dta_bdy(jbdy)%h_i(:,:) = 0._wp
	770	dta_bdy(jbdy)%h_s(:,:) = 0._wp
[4292]	771	ENDIF
	772
	773	ENDIF
	774	ENDIF
[3294]	775	#endif
[6140]	776	!
[9019]	777	END DO ! jbdy
[6140]	778	!
	779	END SUBROUTINE bdy_dta_init
[911]	780
	781	!!==============================================================================
	782	END MODULE bdydta

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

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

Context Navigation

source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/OCE/BDY/bdydta.F90 @ 11480

Download in other formats: