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.

iom.F90 in NEMO/branches/2019/dev_r12072_TOP-01_ENHANCE-11_CEthe/src/OCE/IOM – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r12072_TOP-01_ENHANCE-11_CEthe/src/OCE/IOM/iom.F90 @ 12109

Last change on this file since 12109 was 12109, checked in by cetlod, 4 years ago
check out & merge dev_r11643_ENHANCE-11_CEthe_Shaconemo_diags branch onto dev_r12072_TOP-01_ENHANCE-11_CEthe
Property svn:keywords set to `Id`
File size: 129.1 KB

Rev	Line
[544]	1	MODULE iom
[9019]	2	!!======================================================================
[544]	3	!! * MODULE iom *
	4	!! Input/Output manager : Library to read input files
[9019]	5	!!======================================================================
[3764]	6	!! History : 2.0 ! 2005-12 (J. Belier) Original code
	7	!! 2.0 ! 2006-02 (S. Masson) Adaptation to NEMO
	8	!! 3.0 ! 2007-07 (D. Storkey) Changes to iom_gettime
	9	!! 3.4 ! 2012-12 (R. Bourdalle-Badie and G. Reffray) add C1D case
[6140]	10	!! 3.6 ! 2014-15 DIMG format removed
[7646]	11	!! 3.6 ! 2015-15 (J. Harle) Added procedure to read REAL attributes
[9019]	12	!! 4.0 ! 2017-11 (M. Andrejczuk) Extend IOM interface to write any 3D fields
	13	!!----------------------------------------------------------------------
[544]	14
[9019]	15	!!----------------------------------------------------------------------
[544]	16	!! iom_open : open a file read only
	17	!! iom_close : close a file or all files opened by iom
	18	!! iom_get : read a field (interfaced to several routines)
	19	!! iom_varid : get the id of a variable in a file
	20	!! iom_rstput : write a field in a restart file (interfaced to several routines)
[9019]	21	!!----------------------------------------------------------------------
[544]	22	USE dom_oce ! ocean space and time domain
[3764]	23	USE c1d ! 1D vertical configuration
[3294]	24	USE flo_oce ! floats module declarations
[679]	25	USE lbclnk ! lateal boundary condition / mpp exchanges
[544]	26	USE iom_def ! iom variables definitions
	27	USE iom_nf90 ! NetCDF format with native NetCDF library
[2715]	28	USE in_out_manager ! I/O manager
	29	USE lib_mpp ! MPP library
[1412]	30	#if defined key_iomput
[9019]	31	USE sbc_oce , ONLY : nn_fsbc ! ocean space and time domain
	32	USE trc_oce , ONLY : nn_dttrc ! !: frequency of step on passive tracers
	33	USE icb_oce , ONLY : nclasses, class_num ! !: iceberg classes
[9570]	34	#if defined key_si3
[9019]	35	USE ice , ONLY : jpl
[4691]	36	#endif
[1725]	37	USE domngb ! ocean space and time domain
	38	USE phycst ! physical constants
	39	USE dianam ! build name of file
[3695]	40	USE xios
[1359]	41	# endif
[4148]	42	USE ioipsl, ONLY : ju2ymds ! for calendar
[4152]	43	USE crs ! Grid coarsening
[10222]	44	#if defined key_top
	45	USE trc, ONLY : profsed
	46	#endif
[9367]	47	USE lib_fortran
	48	USE diurnal_bulk, ONLY : ln_diurnal_only, ln_diurnal
[1359]	49
[544]	50	IMPLICIT NONE
[556]	51	PUBLIC ! must be public to be able to access iom_def through iom
[550]	52
[1457]	53	#if defined key_iomput
[1725]	54	LOGICAL, PUBLIC, PARAMETER :: lk_iomput = .TRUE. !: iom_put flag
[1457]	55	#else
	56	LOGICAL, PUBLIC, PARAMETER :: lk_iomput = .FALSE. !: iom_put flag
	57	#endif
[12109]	58	PUBLIC iom_init, iom_swap, iom_open, iom_close, iom_setkt, iom_varid, iom_get, iom_get_var
[10522]	59	PUBLIC iom_chkatt, iom_getatt, iom_putatt, iom_getszuld, iom_rstput, iom_delay_rst, iom_put
[11536]	60	PUBLIC iom_use, iom_context_finalize, iom_miss_val
[544]	61
[752]	62	PRIVATE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d
	63	PRIVATE iom_g0d, iom_g1d, iom_g2d, iom_g3d, iom_get_123d
[12109]	64	PRIVATE iom_p1d, iom_p2d, iom_p3d, iom_p4d
[1412]	65	#if defined key_iomput
[4148]	66	PRIVATE iom_set_domain_attr, iom_set_axis_attr, iom_set_field_attr, iom_set_file_attr, iom_get_file_attr, iom_set_grid_attr
[5363]	67	PRIVATE set_grid, set_grid_bounds, set_scalar, set_xmlatt, set_mooring, iom_update_file_name, iom_sdate
[9367]	68	PRIVATE iom_set_rst_context, iom_set_rstw_active, iom_set_rstr_active
[1359]	69	# endif
[9535]	70	PUBLIC iom_set_rstw_var_active, iom_set_rstw_core, iom_set_rst_vars
[752]	71
[544]	72	INTERFACE iom_get
[550]	73	MODULE PROCEDURE iom_g0d, iom_g1d, iom_g2d, iom_g3d
[544]	74	END INTERFACE
[2528]	75	INTERFACE iom_getatt
[10425]	76	MODULE PROCEDURE iom_g0d_iatt, iom_g1d_iatt, iom_g0d_ratt, iom_g1d_ratt, iom_g0d_catt
[2528]	77	END INTERFACE
[7646]	78	INTERFACE iom_putatt
[10425]	79	MODULE PROCEDURE iom_p0d_iatt, iom_p1d_iatt, iom_p0d_ratt, iom_p1d_ratt, iom_p0d_catt
[7646]	80	END INTERFACE
[544]	81	INTERFACE iom_rstput
[550]	82	MODULE PROCEDURE iom_rp0d, iom_rp1d, iom_rp2d, iom_rp3d
[544]	83	END INTERFACE
[9802]	84	INTERFACE iom_put
[12109]	85	MODULE PROCEDURE iom_p0d, iom_p1d, iom_p2d, iom_p3d, iom_p4d
[9802]	86	END INTERFACE iom_put
	87
[544]	88	!!----------------------------------------------------------------------
[9598]	89	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[1152]	90	!! $Id$
[10068]	91	!! Software governed by the CeCILL license (see ./LICENSE)
[544]	92	!!----------------------------------------------------------------------
	93	CONTAINS
	94
[9903]	95	SUBROUTINE iom_init( cdname, fname, ld_tmppatch )
[1359]	96	!!----------------------------------------------------------------------
	97	!! * ROUTINE *
	98	!!
	99	!! ** Purpose :
	100	!!
	101	!!----------------------------------------------------------------------
[9903]	102	CHARACTER(len=*), INTENT(in) :: cdname
[9367]	103	CHARACTER(len=*), OPTIONAL, INTENT(in) :: fname
[9903]	104	LOGICAL , OPTIONAL, INTENT(in) :: ld_tmppatch
[1412]	105	#if defined key_iomput
[9019]	106	!
[7646]	107	TYPE(xios_duration) :: dtime = xios_duration(0, 0, 0, 0, 0, 0)
	108	TYPE(xios_date) :: start_date
[9367]	109	CHARACTER(len=lc) :: clname
[12109]	110	INTEGER :: irefyear, irefmonth, irefday
[7646]	111	INTEGER :: ji, jkmin
[9367]	112	LOGICAL :: llrst_context ! is context related to restart
[5415]	113	!
[7646]	114	REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: zt_bnds, zw_bnds
[9903]	115	LOGICAL :: ll_tmppatch = .TRUE. !: seb: patch before we remove periodicity
	116	INTEGER :: nldi_save, nlei_save !: and close boundaries in output files
	117	INTEGER :: nldj_save, nlej_save !:
[1359]	118	!!----------------------------------------------------------------------
[9019]	119	!
[9802]	120	! seb: patch before we remove periodicity and close boundaries in output files
[9903]	121	IF( PRESENT(ld_tmppatch) ) THEN ; ll_tmppatch = ld_tmppatch
	122	ELSE ; ll_tmppatch = .TRUE.
	123	ENDIF
	124	IF ( ll_tmppatch ) THEN
[9802]	125	nldi_save = nldi ; nlei_save = nlei
	126	nldj_save = nldj ; nlej_save = nlej
	127	IF( nimpp == 1 ) nldi = 1
	128	IF( nimpp + jpi - 1 == jpiglo ) nlei = jpi
	129	IF( njmpp == 1 ) nldj = 1
	130	IF( njmpp + jpj - 1 == jpjglo ) nlej = jpj
	131	ENDIF
	132	!
[7646]	133	ALLOCATE( zt_bnds(2,jpk), zw_bnds(2,jpk) )
[9019]	134	!
[4152]	135	clname = cdname
	136	IF( TRIM(Agrif_CFixed()) /= '0' ) clname = TRIM(Agrif_CFixed())//"_"//TRIM(cdname)
[9570]	137	CALL xios_context_initialize(TRIM(clname), mpi_comm_oce)
[4152]	138	CALL iom_swap( cdname )
[9367]	139	llrst_context = (TRIM(cdname) == TRIM(crxios_context) .OR. TRIM(cdname) == TRIM(cwxios_context))
[1359]	140
[7646]	141	! Calendar type is now defined in xml file
[12109]	142	IF (.NOT.(xios_getvar('ref_year' ,irefyear ))) irefyear = 1900
	143	IF (.NOT.(xios_getvar('ref_month',irefmonth))) irefmonth = 01
	144	IF (.NOT.(xios_getvar('ref_day' ,irefday ))) irefday = 01
	145
[1725]	146	SELECT CASE ( nleapy ) ! Choose calendar for IOIPSL
[12109]	147	CASE ( 1) ; CALL xios_define_calendar( TYPE = "Gregorian", time_origin = xios_date(irefyear,irefmonth,irefday,00,00,00), &
[7646]	148	& start_date = xios_date(nyear,nmonth,nday,0,0,0) )
[12109]	149	CASE ( 0) ; CALL xios_define_calendar( TYPE = "NoLeap" , time_origin = xios_date(irefyear,irefmonth,irefday,00,00,00), &
[7646]	150	& start_date = xios_date(nyear,nmonth,nday,0,0,0) )
[12109]	151	CASE (30) ; CALL xios_define_calendar( TYPE = "D360" , time_origin = xios_date(irefyear,irefmonth,irefday,00,00,00), &
[7646]	152	& start_date = xios_date(nyear,nmonth,nday,0,0,0) )
[1725]	153	END SELECT
[1359]	154
	155	! horizontal grid definition
[9367]	156	IF(.NOT.llrst_context) CALL set_scalar
[9019]	157	!
[5407]	158	IF( TRIM(cdname) == TRIM(cxios_context) ) THEN
[9984]	159	CALL set_grid( "T", glamt, gphit, .FALSE., .FALSE. )
	160	CALL set_grid( "U", glamu, gphiu, .FALSE., .FALSE. )
	161	CALL set_grid( "V", glamv, gphiv, .FALSE., .FALSE. )
	162	CALL set_grid( "W", glamt, gphit, .FALSE., .FALSE. )
[5385]	163	CALL set_grid_znl( gphit )
[5415]	164	!
	165	IF( ln_cfmeta ) THEN ! Add additional grid metadata
[5836]	166	CALL iom_set_domain_attr("grid_T", area = e1e2t(nldi:nlei, nldj:nlej))
	167	CALL iom_set_domain_attr("grid_U", area = e1e2u(nldi:nlei, nldj:nlej))
	168	CALL iom_set_domain_attr("grid_V", area = e1e2v(nldi:nlei, nldj:nlej))
	169	CALL iom_set_domain_attr("grid_W", area = e1e2t(nldi:nlei, nldj:nlej))
[5415]	170	CALL set_grid_bounds( "T", glamf, gphif, glamt, gphit )
	171	CALL set_grid_bounds( "U", glamv, gphiv, glamu, gphiu )
	172	CALL set_grid_bounds( "V", glamu, gphiu, glamv, gphiv )
	173	CALL set_grid_bounds( "W", glamf, gphif, glamt, gphit )
	174	ENDIF
[4152]	175	ENDIF
[9019]	176	!
[5407]	177	IF( TRIM(cdname) == TRIM(cxios_context)//"_crs" ) THEN
[4152]	178	CALL dom_grid_crs ! Save the parent grid information & Switch to coarse grid domain
	179	!
[9984]	180	CALL set_grid( "T", glamt_crs, gphit_crs, .FALSE., .FALSE. )
	181	CALL set_grid( "U", glamu_crs, gphiu_crs, .FALSE., .FALSE. )
	182	CALL set_grid( "V", glamv_crs, gphiv_crs, .FALSE., .FALSE. )
	183	CALL set_grid( "W", glamt_crs, gphit_crs, .FALSE., .FALSE. )
[5385]	184	CALL set_grid_znl( gphit_crs )
[4152]	185	!
	186	CALL dom_grid_glo ! Return to parent grid domain
[5415]	187	!
[9367]	188	IF( ln_cfmeta .AND. .NOT. llrst_context) THEN ! Add additional grid metadata
[5415]	189	CALL iom_set_domain_attr("grid_T", area = e1e2t_crs(nldi:nlei, nldj:nlej))
	190	CALL iom_set_domain_attr("grid_U", area = e1u_crs(nldi:nlei, nldj:nlej) * e2u_crs(nldi:nlei, nldj:nlej))
	191	CALL iom_set_domain_attr("grid_V", area = e1v_crs(nldi:nlei, nldj:nlej) * e2v_crs(nldi:nlei, nldj:nlej))
	192	CALL iom_set_domain_attr("grid_W", area = e1e2t_crs(nldi:nlei, nldj:nlej))
	193	CALL set_grid_bounds( "T", glamf_crs, gphif_crs, glamt_crs, gphit_crs )
	194	CALL set_grid_bounds( "U", glamv_crs, gphiv_crs, glamu_crs, gphiu_crs )
	195	CALL set_grid_bounds( "V", glamu_crs, gphiu_crs, glamv_crs, gphiv_crs )
	196	CALL set_grid_bounds( "W", glamf_crs, gphif_crs, glamt_crs, gphit_crs )
	197	ENDIF
[4152]	198	ENDIF
[9019]	199	!
[1359]	200	! vertical grid definition
[9367]	201	IF(.NOT.llrst_context) THEN
[10222]	202	CALL iom_set_axis_attr( "deptht", paxis = gdept_1d )
	203	CALL iom_set_axis_attr( "depthu", paxis = gdept_1d )
	204	CALL iom_set_axis_attr( "depthv", paxis = gdept_1d )
	205	CALL iom_set_axis_attr( "depthw", paxis = gdepw_1d )
[9367]	206
	207	! Add vertical grid bounds
	208	jkmin = MIN(2,jpk) ! in case jpk=1 (i.e. sas2D)
	209	zt_bnds(2,: ) = gdept_1d(:)
	210	zt_bnds(1,jkmin:jpk) = gdept_1d(1:jpkm1)
	211	zt_bnds(1,1 ) = gdept_1d(1) - e3w_1d(1)
	212	zw_bnds(1,: ) = gdepw_1d(:)
	213	zw_bnds(2,1:jpkm1 ) = gdepw_1d(jkmin:jpk)
	214	zw_bnds(2,jpk: ) = gdepw_1d(jpk) + e3t_1d(jpk)
[10361]	215	CALL iom_set_axis_attr( "deptht", bounds=zw_bnds )
	216	CALL iom_set_axis_attr( "depthu", bounds=zw_bnds )
	217	CALL iom_set_axis_attr( "depthv", bounds=zw_bnds )
	218	CALL iom_set_axis_attr( "depthw", bounds=zt_bnds )
[9580]	219	CALL iom_set_axis_attr( "nfloat", (/ (REAL(ji,wp), ji=1,jpnfl) /) )
[9570]	220	# if defined key_si3
[9367]	221	CALL iom_set_axis_attr( "ncatice", (/ (REAL(ji,wp), ji=1,jpl) /) )
	222	! SIMIP diagnostics (4 main arctic straits)
	223	CALL iom_set_axis_attr( "nstrait", (/ (REAL(ji,wp), ji=1,4) /) )
[9019]	224	# endif
[10222]	225	#if defined key_top
[10817]	226	IF( ALLOCATED(profsed) ) CALL iom_set_axis_attr( "profsed", paxis = profsed )
[10222]	227	#endif
[9367]	228	CALL iom_set_axis_attr( "icbcla", class_num )
[10817]	229	CALL iom_set_axis_attr( "iax_20C", (/ REAL(20,wp) /) ) ! strange syntaxe and idea...
[12109]	230	CALL iom_set_axis_attr( "iax_26C", (/ REAL(26,wp) /) ) ! strange syntaxe and idea...
[10817]	231	CALL iom_set_axis_attr( "iax_28C", (/ REAL(28,wp) /) ) ! strange syntaxe and idea...
[12109]	232	CALL iom_set_axis_attr( "basin" , (/ (REAL(ji,wp), ji=1,5) /) )
[9367]	233	ENDIF
	234	!
[1725]	235	! automatic definitions of some of the xml attributs
[9367]	236	IF( TRIM(cdname) == TRIM(crxios_context) ) THEN
	237	!set names of the fields in restart file IF using XIOS to read data
[9984]	238	CALL iom_set_rst_context(.TRUE.)
[9367]	239	CALL iom_set_rst_vars(rst_rfields)
	240	!set which fields are to be read from restart file
	241	CALL iom_set_rstr_active()
	242	ELSE IF( TRIM(cdname) == TRIM(cwxios_context) ) THEN
	243	!set names of the fields in restart file IF using XIOS to write data
[9984]	244	CALL iom_set_rst_context(.FALSE.)
[9367]	245	CALL iom_set_rst_vars(rst_wfields)
	246	!set which fields are to be written to a restart file
	247	CALL iom_set_rstw_active(fname)
	248	ELSE
	249	CALL set_xmlatt
	250	ENDIF
[9019]	251	!
[1359]	252	! end file definition
[4148]	253	dtime%second = rdt
[9019]	254	CALL xios_set_timestep( dtime )
[4148]	255	CALL xios_close_context_definition()
[9019]	256	CALL xios_update_calendar( 0 )
	257	!
[7646]	258	DEALLOCATE( zt_bnds, zw_bnds )
[9019]	259	!
[9903]	260	IF ( ll_tmppatch ) THEN
[9802]	261	nldi = nldi_save ; nlei = nlei_save
	262	nldj = nldj_save ; nlej = nlej_save
	263	ENDIF
[1359]	264	#endif
[9019]	265	!
[1359]	266	END SUBROUTINE iom_init
	267
[9367]	268	SUBROUTINE iom_set_rstw_var_active(field)
	269	!!---------------------------------------------------------------------
	270	!! * SUBROUTINE iom_set_rstw_var_active *
	271	!!
	272	!! ** Purpose : enable variable in restart file when writing with XIOS
	273	!!---------------------------------------------------------------------
	274	CHARACTER(len = *), INTENT(IN) :: field
	275	INTEGER :: i
	276	LOGICAL :: llis_set
[9535]	277	CHARACTER(LEN=256) :: clinfo ! info character
[1359]	278
[9535]	279	#if defined key_iomput
[9367]	280	llis_set = .FALSE.
	281
	282	DO i = 1, max_rst_fields
	283	IF(TRIM(rst_wfields(i)%vname) == field) THEN
	284	rst_wfields(i)%active = .TRUE.
	285	llis_set = .TRUE.
	286	EXIT
	287	ENDIF
	288	ENDDO
	289	!Warn if variable is not in defined in rst_wfields
	290	IF(.NOT.llis_set) THEN
[10425]	291	WRITE(ctmp1,*) 'iom_set_rstw_var_active: variable ', field ,' is available for writing but not defined'
	292	CALL ctl_stop( 'iom_set_rstw_var_active:', ctmp1 )
[9367]	293	ENDIF
[9535]	294	#else
[9536]	295	clinfo = 'iom_set_rstw_var_active: key_iomput is needed to use XIOS restart read/write functionality'
	296	CALL ctl_stop('STOP', TRIM(clinfo))
[9535]	297	#endif
[9367]	298
	299	END SUBROUTINE iom_set_rstw_var_active
	300
	301	SUBROUTINE iom_set_rstr_active()
	302	!!---------------------------------------------------------------------
	303	!! * SUBROUTINE iom_set_rstr_active *
	304	!!
	305	!! ** Purpose : define file name in XIOS context for reading restart file,
	306	!! enable variables present in restart file for reading with XIOS
	307	!!---------------------------------------------------------------------
	308
	309	!sets enabled = .TRUE. for each field in restart file
	310	CHARACTER(len=256) :: rst_file
[9535]	311
	312	#if defined key_iomput
[9367]	313	TYPE(xios_field) :: field_hdl
	314	TYPE(xios_file) :: file_hdl
	315	TYPE(xios_filegroup) :: filegroup_hdl
	316	INTEGER :: i
	317	CHARACTER(lc) :: clpath
	318
	319	clpath = TRIM(cn_ocerst_indir)
	320	IF( clpath(LEN_TRIM(clpath):) /= '/' ) clpath = TRIM(clpath) // '/'
	321	IF( TRIM(Agrif_CFixed()) == '0' ) THEN
	322	rst_file = TRIM(clpath)//TRIM(cn_ocerst_in)
	323	ELSE
	324	rst_file = TRIM(clpath)//'1_'//TRIM(cn_ocerst_in)
	325	ENDIF
	326	!set name of the restart file and enable available fields
	327	if(lwp) WRITE(numout,*) 'Setting restart filename (for XIOS) to: ',rst_file
	328	CALL xios_get_handle("file_definition", filegroup_hdl )
	329	CALL xios_add_child(filegroup_hdl, file_hdl, 'rrestart')
	330	CALL xios_set_file_attr( "rrestart", name=trim(rst_file), type="one_file", &
	331	par_access="collective", enabled=.TRUE., mode="read", &
	332	output_freq=xios_timestep)
	333	!define variables for restart context
	334	DO i = 1, max_rst_fields
	335	IF( TRIM(rst_rfields(i)%vname) /= "NO_NAME") THEN
	336	IF( iom_varid( numror, TRIM(rst_rfields(i)%vname), ldstop = .FALSE. ) > 0 ) THEN
	337	CALL xios_add_child(file_hdl, field_hdl, TRIM(rst_rfields(i)%vname))
	338	SELECT CASE (TRIM(rst_rfields(i)%grid))
	339	CASE ("grid_N_3D")
	340	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
	341	domain_ref="grid_N", axis_ref="nav_lev", operation = "instant")
	342	CASE ("grid_N")
	343	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
	344	domain_ref="grid_N", operation = "instant")
	345	CASE ("grid_vector")
	346	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
	347	axis_ref="nav_lev", operation = "instant")
	348	CASE ("grid_scalar")
	349	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_rfields(i)%vname), &
	350	scalar_ref = "grid_scalar", operation = "instant")
	351	END SELECT
	352	IF(lwp) WRITE(numout,*) 'XIOS read: ', TRIM(rst_rfields(i)%vname), ' enabled in ', TRIM(rst_file)
	353	ENDIF
	354	ENDIF
	355	END DO
[9535]	356	#endif
[9367]	357	END SUBROUTINE iom_set_rstr_active
	358
	359	SUBROUTINE iom_set_rstw_core(cdmdl)
	360	!!---------------------------------------------------------------------
	361	!! * SUBROUTINE iom_set_rstw_core *
	362	!!
	363	!! ** Purpose : set variables which are always in restart file
	364	!!---------------------------------------------------------------------
	365	CHARACTER (len=*), INTENT (IN) :: cdmdl ! model OPA or SAS
[9535]	366	CHARACTER(LEN=256) :: clinfo ! info character
	367	#if defined key_iomput
[9367]	368	IF(cdmdl == "OPA") THEN
	369	!from restart.F90
	370	CALL iom_set_rstw_var_active("rdt")
	371	IF ( .NOT. ln_diurnal_only ) THEN
	372	CALL iom_set_rstw_var_active('ub' )
	373	CALL iom_set_rstw_var_active('vb' )
	374	CALL iom_set_rstw_var_active('tb' )
	375	CALL iom_set_rstw_var_active('sb' )
	376	CALL iom_set_rstw_var_active('sshb')
	377	!
	378	CALL iom_set_rstw_var_active('un' )
	379	CALL iom_set_rstw_var_active('vn' )
	380	CALL iom_set_rstw_var_active('tn' )
	381	CALL iom_set_rstw_var_active('sn' )
	382	CALL iom_set_rstw_var_active('sshn')
	383	CALL iom_set_rstw_var_active('rhop')
	384	! extra variable needed for the ice sheet coupling
	385	IF ( ln_iscpl ) THEN
	386	CALL iom_set_rstw_var_active('tmask')
	387	CALL iom_set_rstw_var_active('umask')
	388	CALL iom_set_rstw_var_active('vmask')
	389	CALL iom_set_rstw_var_active('smask')
	390	CALL iom_set_rstw_var_active('e3t_n')
	391	CALL iom_set_rstw_var_active('e3u_n')
	392	CALL iom_set_rstw_var_active('e3v_n')
	393	CALL iom_set_rstw_var_active('gdepw_n')
	394	END IF
	395	ENDIF
	396	IF(ln_diurnal) CALL iom_set_rstw_var_active('Dsst')
	397	!from trasbc.F90
	398	CALL iom_set_rstw_var_active('sbc_hc_b')
	399	CALL iom_set_rstw_var_active('sbc_sc_b')
	400	ENDIF
[9535]	401	#else
[9536]	402	clinfo = 'iom_set_rstw_core: key_iomput is needed to use XIOS restart read/write functionality'
	403	CALL ctl_stop('STOP', TRIM(clinfo))
[9535]	404	#endif
[9367]	405	END SUBROUTINE iom_set_rstw_core
	406
	407	SUBROUTINE iom_set_rst_vars(fields)
	408	!!---------------------------------------------------------------------
[9535]	409	!! * SUBROUTINE iom_set_rst_vars *
[9367]	410	!!
	411	!! ** Purpose : Fill array fields with the information about all
	412	!! possible variables and corresponding grids definition
	413	!! for reading/writing restart with XIOS
	414	!!---------------------------------------------------------------------
	415	TYPE(RST_FIELD), INTENT(INOUT) :: fields(max_rst_fields)
[9535]	416	INTEGER :: i
[9367]	417
	418	i = 0
	419	i = i + 1; fields(i)%vname="rdt"; fields(i)%grid="grid_scalar"
	420	i = i + 1; fields(i)%vname="un"; fields(i)%grid="grid_N_3D"
	421	i = i + 1; fields(i)%vname="ub"; fields(i)%grid="grid_N_3D"
	422	i = i + 1; fields(i)%vname="vn"; fields(i)%grid="grid_N_3D"
	423	i = i + 1; fields(i)%vname="vb"; fields(i)%grid="grid_N_3D"
	424	i = i + 1; fields(i)%vname="tn"; fields(i)%grid="grid_N_3D"
	425	i = i + 1; fields(i)%vname="tb"; fields(i)%grid="grid_N_3D"
	426	i = i + 1; fields(i)%vname="sn"; fields(i)%grid="grid_N_3D"
	427	i = i + 1; fields(i)%vname="sb"; fields(i)%grid="grid_N_3D"
	428	i = i + 1; fields(i)%vname="sshn"; fields(i)%grid="grid_N"
	429	i = i + 1; fields(i)%vname="sshb"; fields(i)%grid="grid_N"
	430	i = i + 1; fields(i)%vname="rhop"; fields(i)%grid="grid_N_3D"
	431	i = i + 1; fields(i)%vname="kt"; fields(i)%grid="grid_scalar"
	432	i = i + 1; fields(i)%vname="ndastp"; fields(i)%grid="grid_scalar"
	433	i = i + 1; fields(i)%vname="adatrj"; fields(i)%grid="grid_scalar"
	434	i = i + 1; fields(i)%vname="utau_b"; fields(i)%grid="grid_N"
	435	i = i + 1; fields(i)%vname="vtau_b"; fields(i)%grid="grid_N"
	436	i = i + 1; fields(i)%vname="qns_b"; fields(i)%grid="grid_N"
	437	i = i + 1; fields(i)%vname="emp_b"; fields(i)%grid="grid_N"
	438	i = i + 1; fields(i)%vname="sfx_b"; fields(i)%grid="grid_N"
	439	i = i + 1; fields(i)%vname="en" ; fields(i)%grid="grid_N_3D"
	440	i = i + 1; fields(i)%vname="avt_k"; fields(i)%grid="grid_N_3D"
	441	i = i + 1; fields(i)%vname="avm_k"; fields(i)%grid="grid_N_3D"
	442	i = i + 1; fields(i)%vname="dissl"; fields(i)%grid="grid_N_3D"
	443	i = i + 1; fields(i)%vname="sbc_hc_b"; fields(i)%grid="grid_N"
	444	i = i + 1; fields(i)%vname="sbc_sc_b"; fields(i)%grid="grid_N"
	445	i = i + 1; fields(i)%vname="qsr_hc_b"; fields(i)%grid="grid_N_3D"
	446	i = i + 1; fields(i)%vname="fraqsr_1lev"; fields(i)%grid="grid_N"
	447	i = i + 1; fields(i)%vname="greenland_icesheet_mass"
	448	fields(i)%grid="grid_scalar"
	449	i = i + 1; fields(i)%vname="greenland_icesheet_timelapsed"
	450	fields(i)%grid="grid_scalar"
	451	i = i + 1; fields(i)%vname="greenland_icesheet_mass_roc"
	452	fields(i)%grid="grid_scalar"
	453	i = i + 1; fields(i)%vname="antarctica_icesheet_mass"
	454	fields(i)%grid="grid_scalar"
	455	i = i + 1; fields(i)%vname="antarctica_icesheet_timelapsed"
	456	fields(i)%grid="grid_scalar"
	457	i = i + 1; fields(i)%vname="antarctica_icesheet_mass_roc"
	458	fields(i)%grid="grid_scalar"
	459	i = i + 1; fields(i)%vname="frc_v"; fields(i)%grid="grid_scalar"
	460	i = i + 1; fields(i)%vname="frc_t"; fields(i)%grid="grid_scalar"
	461	i = i + 1; fields(i)%vname="frc_s"; fields(i)%grid="grid_scalar"
	462	i = i + 1; fields(i)%vname="frc_wn_t"; fields(i)%grid="grid_scalar"
	463	i = i + 1; fields(i)%vname="frc_wn_s"; fields(i)%grid="grid_scalar"
	464	i = i + 1; fields(i)%vname="ssh_ini"; fields(i)%grid="grid_N"
	465	i = i + 1; fields(i)%vname="e3t_ini"; fields(i)%grid="grid_N_3D"
	466	i = i + 1; fields(i)%vname="hc_loc_ini"; fields(i)%grid="grid_N_3D"
	467	i = i + 1; fields(i)%vname="sc_loc_ini"; fields(i)%grid="grid_N_3D"
	468	i = i + 1; fields(i)%vname="ssh_hc_loc_ini"; fields(i)%grid="grid_N"
	469	i = i + 1; fields(i)%vname="ssh_sc_loc_ini"; fields(i)%grid="grid_N"
	470	i = i + 1; fields(i)%vname="tilde_e3t_b"; fields(i)%grid="grid_N"
	471	i = i + 1; fields(i)%vname="tilde_e3t_n"; fields(i)%grid="grid_N"
	472	i = i + 1; fields(i)%vname="hdiv_lf"; fields(i)%grid="grid_N"
	473	i = i + 1; fields(i)%vname="ub2_b"; fields(i)%grid="grid_N"
	474	i = i + 1; fields(i)%vname="vb2_b"; fields(i)%grid="grid_N"
	475	i = i + 1; fields(i)%vname="sshbb_e"; fields(i)%grid="grid_N"
	476	i = i + 1; fields(i)%vname="ubb_e"; fields(i)%grid="grid_N"
	477	i = i + 1; fields(i)%vname="vbb_e"; fields(i)%grid="grid_N"
	478	i = i + 1; fields(i)%vname="sshb_e"; fields(i)%grid="grid_N"
	479	i = i + 1; fields(i)%vname="ub_e"; fields(i)%grid="grid_N"
	480	i = i + 1; fields(i)%vname="vb_e"; fields(i)%grid="grid_N"
	481	i = i + 1; fields(i)%vname="fwf_isf_b"; fields(i)%grid="grid_N"
	482	i = i + 1; fields(i)%vname="isf_sc_b"; fields(i)%grid="grid_N"
	483	i = i + 1; fields(i)%vname="isf_hc_b"; fields(i)%grid="grid_N"
	484	i = i + 1; fields(i)%vname="ssh_ibb"; fields(i)%grid="grid_N"
	485	i = i + 1; fields(i)%vname="rnf_b"; fields(i)%grid="grid_N"
	486	i = i + 1; fields(i)%vname="rnf_hc_b"; fields(i)%grid="grid_N"
	487	i = i + 1; fields(i)%vname="rnf_sc_b"; fields(i)%grid="grid_N"
	488	i = i + 1; fields(i)%vname="nn_fsbc"; fields(i)%grid="grid_scalar"
	489	i = i + 1; fields(i)%vname="ssu_m"; fields(i)%grid="grid_N"
	490	i = i + 1; fields(i)%vname="ssv_m"; fields(i)%grid="grid_N"
	491	i = i + 1; fields(i)%vname="sst_m"; fields(i)%grid="grid_N"
	492	i = i + 1; fields(i)%vname="sss_m"; fields(i)%grid="grid_N"
	493	i = i + 1; fields(i)%vname="ssh_m"; fields(i)%grid="grid_N"
	494	i = i + 1; fields(i)%vname="e3t_m"; fields(i)%grid="grid_N"
	495	i = i + 1; fields(i)%vname="frq_m"; fields(i)%grid="grid_N"
	496	i = i + 1; fields(i)%vname="avmb"; fields(i)%grid="grid_vector"
	497	i = i + 1; fields(i)%vname="avtb"; fields(i)%grid="grid_vector"
	498	i = i + 1; fields(i)%vname="ub2_i_b"; fields(i)%grid="grid_N"
	499	i = i + 1; fields(i)%vname="vb2_i_b"; fields(i)%grid="grid_N"
	500	i = i + 1; fields(i)%vname="ntime"; fields(i)%grid="grid_scalar"
	501	i = i + 1; fields(i)%vname="Dsst"; fields(i)%grid="grid_scalar"
	502	i = i + 1; fields(i)%vname="tmask"; fields(i)%grid="grid_N_3D"
	503	i = i + 1; fields(i)%vname="umask"; fields(i)%grid="grid_N_3D"
	504	i = i + 1; fields(i)%vname="vmask"; fields(i)%grid="grid_N_3D"
	505	i = i + 1; fields(i)%vname="smask"; fields(i)%grid="grid_N_3D"
	506	i = i + 1; fields(i)%vname="gdepw_n"; fields(i)%grid="grid_N_3D"
	507	i = i + 1; fields(i)%vname="e3t_n"; fields(i)%grid="grid_N_3D"
	508	i = i + 1; fields(i)%vname="e3u_n"; fields(i)%grid="grid_N_3D"
	509	i = i + 1; fields(i)%vname="e3v_n"; fields(i)%grid="grid_N_3D"
	510	i = i + 1; fields(i)%vname="surf_ini"; fields(i)%grid="grid_N"
	511	i = i + 1; fields(i)%vname="e3t_b"; fields(i)%grid="grid_N_3D"
	512	i = i + 1; fields(i)%vname="hmxl_n"; fields(i)%grid="grid_N_3D"
	513	i = i + 1; fields(i)%vname="un_bf"; fields(i)%grid="grid_N"
	514	i = i + 1; fields(i)%vname="vn_bf"; fields(i)%grid="grid_N"
	515	i = i + 1; fields(i)%vname="hbl"; fields(i)%grid="grid_N"
	516	i = i + 1; fields(i)%vname="hbli"; fields(i)%grid="grid_N"
	517	i = i + 1; fields(i)%vname="wn"; fields(i)%grid="grid_N_3D"
	518
	519	IF( i-1 > max_rst_fields) THEN
[10425]	520	WRITE(ctmp1,*) 'E R R O R : iom_set_rst_vars SIZE of RST_FIELD array is too small'
	521	CALL ctl_stop( 'iom_set_rst_vars:', ctmp1 )
[9367]	522	ENDIF
	523	END SUBROUTINE iom_set_rst_vars
	524
	525
	526	SUBROUTINE iom_set_rstw_active(cdrst_file)
	527	!!---------------------------------------------------------------------
[9535]	528	!! * SUBROUTINE iom_set_rstw_active *
[9367]	529	!!
	530	!! ** Purpose : define file name in XIOS context for writing restart
	531	!! enable variables present in restart file for writing
	532	!!---------------------------------------------------------------------
	533	!sets enabled = .TRUE. for each field in restart file
	534	CHARACTER(len=*) :: cdrst_file
	535	#if defined key_iomput
	536	TYPE(xios_field) :: field_hdl
	537	TYPE(xios_file) :: file_hdl
	538	TYPE(xios_filegroup) :: filegroup_hdl
	539	INTEGER :: i
	540	CHARACTER(lc) :: clpath
	541
	542	!set name of the restart file and enable available fields
	543	IF(lwp) WRITE(numout,*) 'Setting restart filename (for XIOS write) to: ',cdrst_file
	544	CALL xios_get_handle("file_definition", filegroup_hdl )
	545	CALL xios_add_child(filegroup_hdl, file_hdl, 'wrestart')
	546	IF(nxioso.eq.1) THEN
	547	CALL xios_set_file_attr( "wrestart", type="one_file", enabled=.TRUE.,&
	548	mode="write", output_freq=xios_timestep)
	549	if(lwp) write(numout,*) 'OPEN ', trim(cdrst_file), ' in one_file mode'
	550	ELSE
	551	CALL xios_set_file_attr( "wrestart", type="multiple_file", enabled=.TRUE.,&
	552	mode="write", output_freq=xios_timestep)
	553	if(lwp) write(numout,*) 'OPEN ', trim(cdrst_file), ' in multiple_file mode'
	554	ENDIF
	555	CALL xios_set_file_attr( "wrestart", name=trim(cdrst_file))
	556	!define fields for restart context
	557	DO i = 1, max_rst_fields
	558	IF( rst_wfields(i)%active ) THEN
	559	CALL xios_add_child(file_hdl, field_hdl, TRIM(rst_wfields(i)%vname))
	560	SELECT CASE (TRIM(rst_wfields(i)%grid))
	561	CASE ("grid_N_3D")
	562	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_wfields(i)%vname), &
	563	domain_ref="grid_N", axis_ref="nav_lev", prec = 8, operation = "instant")
	564	CASE ("grid_N")
	565	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_wfields(i)%vname), &
	566	domain_ref="grid_N", prec = 8, operation = "instant")
	567	CASE ("grid_vector")
	568	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_wfields(i)%vname), &
	569	axis_ref="nav_lev", prec = 8, operation = "instant")
	570	CASE ("grid_scalar")
	571	CALL xios_set_attr (field_hdl, enabled = .TRUE., name = TRIM(rst_wfields(i)%vname), &
	572	scalar_ref = "grid_scalar", prec = 8, operation = "instant")
	573	END SELECT
	574	ENDIF
	575	END DO
	576	#endif
	577	END SUBROUTINE iom_set_rstw_active
	578
[9984]	579	SUBROUTINE iom_set_rst_context(ld_rstr)
[9367]	580	!!---------------------------------------------------------------------
[9535]	581	!! * SUBROUTINE iom_set_rst_context *
[9367]	582	!!
	583	!! ** Purpose : Define domain, axis and grid for restart (read/write)
	584	!! context
	585	!!
	586	!!---------------------------------------------------------------------
[9984]	587	LOGICAL, INTENT(IN) :: ld_rstr
	588	!ld_rstr is true for restart context. There is no need to define grid for
	589	!restart read, because it's read from file
[9367]	590	#if defined key_iomput
	591	TYPE(xios_domaingroup) :: domaingroup_hdl
	592	TYPE(xios_domain) :: domain_hdl
	593	TYPE(xios_axisgroup) :: axisgroup_hdl
	594	TYPE(xios_axis) :: axis_hdl
	595	TYPE(xios_scalar) :: scalar_hdl
	596	TYPE(xios_scalargroup) :: scalargroup_hdl
	597
	598	CALL xios_get_handle("domain_definition",domaingroup_hdl)
	599	CALL xios_add_child(domaingroup_hdl, domain_hdl, "grid_N")
[9984]	600	CALL set_grid("N", glamt, gphit, .TRUE., ld_rstr)
[9367]	601
	602	CALL xios_get_handle("axis_definition",axisgroup_hdl)
	603	CALL xios_add_child(axisgroup_hdl, axis_hdl, "nav_lev")
	604	!AGRIF fails to compile when unit= is in call to xios_set_axis_attr
	605	! CALL xios_set_axis_attr( "nav_lev", long_name="Vertical levels", unit="m", positive="down")
	606	CALL xios_set_axis_attr( "nav_lev", long_name="Vertical levels in meters", positive="down")
	607	CALL iom_set_axis_attr( "nav_lev", paxis = gdept_1d )
	608
	609	CALL xios_get_handle("scalar_definition", scalargroup_hdl)
	610	CALL xios_add_child(scalargroup_hdl, scalar_hdl, "grid_scalar")
	611	#endif
	612	END SUBROUTINE iom_set_rst_context
	613
[4152]	614	SUBROUTINE iom_swap( cdname )
[1793]	615	!!---------------------------------------------------------------------
	616	!! * SUBROUTINE iom_swap *
	617	!!
	618	!! ** Purpose : swap context between different agrif grid for xmlio_server
	619	!!---------------------------------------------------------------------
[4152]	620	CHARACTER(len=*), INTENT(in) :: cdname
[1793]	621	#if defined key_iomput
[3695]	622	TYPE(xios_context) :: nemo_hdl
[1793]	623
[4152]	624	IF( TRIM(Agrif_CFixed()) == '0' ) THEN
	625	CALL xios_get_handle(TRIM(cdname),nemo_hdl)
	626	ELSE
	627	CALL xios_get_handle(TRIM(Agrif_CFixed())//"_"//TRIM(cdname),nemo_hdl)
	628	ENDIF
	629	!
	630	CALL xios_set_current_context(nemo_hdl)
[1793]	631	#endif
[4152]	632	!
[1793]	633	END SUBROUTINE iom_swap
	634
	635
[10425]	636	SUBROUTINE iom_open( cdname, kiomid, ldwrt, kdom, ldstop, ldiof, kdlev )
[544]	637	!!---------------------------------------------------------------------
	638	!! * SUBROUTINE iom_open *
	639	!!
	640	!! ** Purpose : open an input file (return 0 if not found)
	641	!!---------------------------------------------------------------------
	642	CHARACTER(len=*), INTENT(in ) :: cdname ! File name
	643	INTEGER , INTENT( out) :: kiomid ! iom identifier of the opened file
	644	LOGICAL , INTENT(in ), OPTIONAL :: ldwrt ! open in write modeb (default = .FALSE.)
	645	INTEGER , INTENT(in ), OPTIONAL :: kdom ! Type of domain to be written (default = jpdom_local_noovlap)
[679]	646	LOGICAL , INTENT(in ), OPTIONAL :: ldstop ! stop if open to read a non-existing file (default = .TRUE.)
[1319]	647	LOGICAL , INTENT(in ), OPTIONAL :: ldiof ! Interp On the Fly, needed for AGRIF (default = .FALSE.)
[9019]	648	INTEGER , INTENT(in ), OPTIONAL :: kdlev ! number of vertical levels
	649	!
[4148]	650	CHARACTER(LEN=256) :: clname ! the name of the file based on cdname [[+clcpu]+clcpu]
	651	CHARACTER(LEN=256) :: cltmpn ! tempory name to store clname (in writting mode)
[6140]	652	CHARACTER(LEN=10) :: clsuffix ! ".nc"
[550]	653	CHARACTER(LEN=15) :: clcpu ! the cpu number (max jpmax_digits digits)
[4148]	654	CHARACTER(LEN=256) :: clinfo ! info character
[544]	655	LOGICAL :: llok ! check the existence
[679]	656	LOGICAL :: llwrt ! local definition of ldwrt
[1200]	657	LOGICAL :: llnoov ! local definition to read overlap
[679]	658	LOGICAL :: llstop ! local definition of ldstop
[1319]	659	LOGICAL :: lliof ! local definition of ldiof
[544]	660	INTEGER :: icnt ! counter for digits in clcpu (max = jpmax_digits)
	661	INTEGER :: iln, ils ! lengths of character
	662	INTEGER :: idom ! type of domain
	663	INTEGER :: istop !
	664	INTEGER, DIMENSION(2,5) :: idompar ! domain parameters:
	665	! local number of points for x,y dimensions
	666	! position of first local point for x,y dimensions
	667	! position of last local point for x,y dimensions
	668	! start halo size for x,y dimensions
	669	! end halo size for x,y dimensions
	670	!---------------------------------------------------------------------
	671	! Initializations and control
	672	! =============
[1341]	673	kiomid = -1
[544]	674	clinfo = ' iom_open ~~~ '
	675	istop = nstop
	676	! if iom_open is called for the first time: initialize iom_file(:)%nfid to 0
	677	! (could be done when defining iom_file in f95 but not in f90)
[1441]	678	IF( Agrif_Root() ) THEN
	679	IF( iom_open_init == 0 ) THEN
	680	iom_file(:)%nfid = 0
	681	iom_open_init = 1
	682	ENDIF
[1409]	683	ENDIF
[544]	684	! do we read or write the file?
	685	IF( PRESENT(ldwrt) ) THEN ; llwrt = ldwrt
	686	ELSE ; llwrt = .FALSE.
	687	ENDIF
[679]	688	! do we call ctl_stop if we try to open a non-existing file in read mode?
	689	IF( PRESENT(ldstop) ) THEN ; llstop = ldstop
	690	ELSE ; llstop = .TRUE.
	691	ENDIF
[1319]	692	! are we using interpolation on the fly?
	693	IF( PRESENT(ldiof) ) THEN ; lliof = ldiof
	694	ELSE ; lliof = .FALSE.
	695	ENDIF
[1200]	696	! do we read the overlap
	697	! ugly patch SM+JMM+RB to overwrite global definition in some cases
[10016]	698	llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif
[544]	699	! create the file name by added, if needed, TRIM(Agrif_CFixed()) and TRIM(clsuffix)
	700	! =============
	701	clname = trim(cdname)
[1319]	702	IF ( .NOT. Agrif_Root() .AND. .NOT. lliof ) THEN
[11554]	703	!FUS iln = INDEX(clname,'/')
	704	iln = INDEX(clname,'/',BACK=.true.) ! FUS: to insert the nest index at the right location within the string, the last / has to be found (search from the right to left)
[1200]	705	cltmpn = clname(1:iln)
	706	clname = clname(iln+1:LEN_TRIM(clname))
	707	clname=TRIM(cltmpn)//TRIM(Agrif_CFixed())//'_'//TRIM(clname)
	708	ENDIF
[544]	709	! which suffix should we use?
[10425]	710	clsuffix = '.nc'
[544]	711	! Add the suffix if needed
	712	iln = LEN_TRIM(clname)
	713	ils = LEN_TRIM(clsuffix)
[742]	714	IF( iln <= ils .OR. INDEX( TRIM(clname), TRIM(clsuffix), back = .TRUE. ) /= iln - ils + 1 ) &
	715	& clname = TRIM(clname)//TRIM(clsuffix)
[544]	716	cltmpn = clname ! store this name
	717	! try to find if the file to be opened already exist
	718	! =============
	719	INQUIRE( FILE = clname, EXIST = llok )
	720	IF( .NOT.llok ) THEN
	721	! we try to add the cpu number to the name
[6140]	722	WRITE(clcpu,*) narea-1
	723
[544]	724	clcpu = TRIM(ADJUSTL(clcpu))
[679]	725	iln = INDEX(clname,TRIM(clsuffix), back = .TRUE.)
[544]	726	clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
	727	icnt = 0
	728	INQUIRE( FILE = clname, EXIST = llok )
	729	! we try different formats for the cpu number by adding 0
	730	DO WHILE( .NOT.llok .AND. icnt < jpmax_digits )
	731	clcpu = "0"//trim(clcpu)
	732	clname = clname(1:iln-1)//'_'//TRIM(clcpu)//TRIM(clsuffix)
	733	INQUIRE( FILE = clname, EXIST = llok )
	734	icnt = icnt + 1
	735	END DO
[9367]	736	ELSE
	737	lxios_sini = .TRUE.
[544]	738	ENDIF
[679]	739	IF( llwrt ) THEN
	740	! check the domain definition
	741	! JMM + SM: ugly patch before getting the new version of lib_mpp)
	742	! idom = jpdom_local_noovlap ! default definition
[1200]	743	IF( llnoov ) THEN ; idom = jpdom_local_noovlap ! default definition
	744	ELSE ; idom = jpdom_local_full ! default definition
[679]	745	ENDIF
	746	IF( PRESENT(kdom) ) idom = kdom
	747	! create the domain informations
	748	! =============
	749	SELECT CASE (idom)
	750	CASE (jpdom_local_full)
	751	idompar(:,1) = (/ jpi , jpj /)
	752	idompar(:,2) = (/ nimpp , njmpp /)
	753	idompar(:,3) = (/ nimpp + jpi - 1 , njmpp + jpj - 1 /)
	754	idompar(:,4) = (/ nldi - 1 , nldj - 1 /)
	755	idompar(:,5) = (/ jpi - nlei , jpj - nlej /)
	756	CASE (jpdom_local_noextra)
	757	idompar(:,1) = (/ nlci , nlcj /)
	758	idompar(:,2) = (/ nimpp , njmpp /)
	759	idompar(:,3) = (/ nimpp + nlci - 1, njmpp + nlcj - 1 /)
	760	idompar(:,4) = (/ nldi - 1 , nldj - 1 /)
	761	idompar(:,5) = (/ nlci - nlei , nlcj - nlej /)
	762	CASE (jpdom_local_noovlap)
	763	idompar(:,1) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
	764	idompar(:,2) = (/ nimpp + nldi - 1, njmpp + nldj - 1 /)
	765	idompar(:,3) = (/ nimpp + nlei - 1, njmpp + nlej - 1 /)
	766	idompar(:,4) = (/ 0 , 0 /)
	767	idompar(:,5) = (/ 0 , 0 /)
	768	CASE DEFAULT
	769	CALL ctl_stop( TRIM(clinfo), 'wrong value of kdom, only jpdom_local* cases are accepted' )
	770	END SELECT
	771	ENDIF
[6140]	772	! Open the NetCDF file
[544]	773	! =============
	774	! do we have some free file identifier?
	775	IF( MINVAL(iom_file(:)%nfid) /= 0 ) &
[679]	776	& CALL ctl_stop( TRIM(clinfo), 'No more free file identifier', 'increase jpmax_files in iom_def' )
	777	! if no file was found...
	778	IF( .NOT. llok ) THEN
	779	IF( .NOT. llwrt ) THEN ! we are in read mode
	780	IF( llstop ) THEN ; CALL ctl_stop( TRIM(clinfo), 'File '//TRIM(cltmpn)//'* not found' )
	781	ELSE ; istop = nstop + 1 ! make sure that istop /= nstop so we don't open the file
	782	ENDIF
	783	ELSE ! we are in write mode so we
	784	clname = cltmpn ! get back the file name without the cpu number
	785	ENDIF
[2586]	786	ELSE
	787	IF( llwrt .AND. .NOT. ln_clobber ) THEN ! we stop as we want to write in a new file
	788	CALL ctl_stop( TRIM(clinfo), 'We want to write in a new file but '//TRIM(clname)//' already exists...' )
	789	istop = nstop + 1 ! make sure that istop /= nstop so we don't open the file
[4650]	790	ELSEIF( llwrt ) THEN ! the file exists and we are in write mode with permission to
	791	clname = cltmpn ! overwrite so get back the file name without the cpu number
[2586]	792	ENDIF
[679]	793	ENDIF
[544]	794	IF( istop == nstop ) THEN ! no error within this routine
[10425]	795	CALL iom_nf90_open( clname, kiomid, llwrt, llok, idompar, kdlev = kdlev )
[544]	796	ENDIF
	797	!
	798	END SUBROUTINE iom_open
	799
	800
	801	SUBROUTINE iom_close( kiomid )
	802	!!--------------------------------------------------------------------
	803	!! * SUBROUTINE iom_close *
	804	!!
	805	!! ** Purpose : close an input file, or all files opened by iom
	806	!!--------------------------------------------------------------------
[1131]	807	INTEGER, INTENT(inout), OPTIONAL :: kiomid ! iom identifier of the file to be closed
	808	! ! return 0 when file is properly closed
	809	! ! No argument: all files opened by iom are closed
[544]	810
	811	INTEGER :: jf ! dummy loop indices
	812	INTEGER :: i_s, i_e ! temporary integer
	813	CHARACTER(LEN=100) :: clinfo ! info character
	814	!---------------------------------------------------------------------
	815	!
	816	clinfo = ' iom_close ~~~ '
	817	IF( PRESENT(kiomid) ) THEN
	818	i_s = kiomid
	819	i_e = kiomid
	820	ELSE
	821	i_s = 1
	822	i_e = jpmax_files
	823	ENDIF
	824
	825	IF( i_s > 0 ) THEN
	826	DO jf = i_s, i_e
	827	IF( iom_file(jf)%nfid > 0 ) THEN
[10425]	828	CALL iom_nf90_close( jf )
[1131]	829	iom_file(jf)%nfid = 0 ! free the id
	830	IF( PRESENT(kiomid) ) kiomid = 0 ! return 0 as id to specify that the file was closed
[679]	831	IF(lwp) WRITE(numout,*) TRIM(clinfo)//' close file: '//TRIM(iom_file(jf)%name)//' ok'
[544]	832	ELSEIF( PRESENT(kiomid) ) THEN
	833	WRITE(ctmp1,*) '--->', kiomid
	834	CALL ctl_stop( TRIM(clinfo)//' Invalid file identifier', ctmp1 )
	835	ENDIF
	836	END DO
	837	ENDIF
	838	!
	839	END SUBROUTINE iom_close
	840
	841
[11536]	842	FUNCTION iom_varid ( kiomid, cdvar, kdimsz, kndims, lduld, ldstop )
[544]	843	!!-----------------------------------------------------------------------
	844	!! * FUNCTION iom_varid *
	845	!!
	846	!! ** Purpose : get the id of a variable in a file (return 0 if not found)
	847	!!-----------------------------------------------------------------------
	848	INTEGER , INTENT(in ) :: kiomid ! file Identifier
	849	CHARACTER(len=*) , INTENT(in ) :: cdvar ! name of the variable
[9540]	850	INTEGER, DIMENSION(:), INTENT( out), OPTIONAL :: kdimsz ! size of each dimension
[11536]	851	INTEGER , INTENT( out), OPTIONAL :: kndims ! number of dimensions
	852	LOGICAL , INTENT( out), OPTIONAL :: lduld ! true if the last dimension is unlimited (time)
[745]	853	LOGICAL , INTENT(in ), OPTIONAL :: ldstop ! stop if looking for non-existing variable (default = .TRUE.)
[544]	854	!
	855	INTEGER :: iom_varid, iiv, i_nvd
	856	LOGICAL :: ll_fnd
	857	CHARACTER(LEN=100) :: clinfo ! info character
[745]	858	LOGICAL :: llstop ! local definition of ldstop
[544]	859	!!-----------------------------------------------------------------------
	860	iom_varid = 0 ! default definition
[745]	861	! do we call ctl_stop if we look for non-existing variable?
	862	IF( PRESENT(ldstop) ) THEN ; llstop = ldstop
	863	ELSE ; llstop = .TRUE.
	864	ENDIF
[544]	865	!
	866	IF( kiomid > 0 ) THEN
[679]	867	clinfo = 'iom_varid, file: '//trim(iom_file(kiomid)%name)//', var: '//trim(cdvar)
[544]	868	IF( iom_file(kiomid)%nfid == 0 ) THEN
	869	CALL ctl_stop( trim(clinfo), 'the file is not open' )
	870	ELSE
	871	ll_fnd = .FALSE.
	872	iiv = 0
	873	!
	874	DO WHILE ( .NOT.ll_fnd .AND. iiv < iom_file(kiomid)%nvars )
	875	iiv = iiv + 1
	876	ll_fnd = ( TRIM(cdvar) == TRIM(iom_file(kiomid)%cn_var(iiv)) )
	877	END DO
	878	!
	879	IF( .NOT.ll_fnd ) THEN
	880	iiv = iiv + 1
	881	IF( iiv <= jpmax_vars ) THEN
[11536]	882	iom_varid = iom_nf90_varid( kiomid, cdvar, iiv, kdimsz, kndims, lduld )
[544]	883	ELSE
	884	CALL ctl_stop( trim(clinfo), 'Too many variables in the file '//iom_file(kiomid)%name, &
[10425]	885	& 'increase the parameter jpmax_vars')
[544]	886	ENDIF
[745]	887	IF( llstop .AND. iom_varid == -1 ) CALL ctl_stop( TRIM(clinfo)//' not found' )
[544]	888	ELSE
	889	iom_varid = iiv
	890	IF( PRESENT(kdimsz) ) THEN
	891	i_nvd = iom_file(kiomid)%ndims(iiv)
[9540]	892	IF( i_nvd <= size(kdimsz) ) THEN
	893	kdimsz(1:i_nvd) = iom_file(kiomid)%dimsz(1:i_nvd,iiv)
[544]	894	ELSE
	895	WRITE(ctmp1,*) i_nvd, size(kdimsz)
	896	CALL ctl_stop( trim(clinfo), 'error in kdimsz size'//trim(ctmp1) )
	897	ENDIF
	898	ENDIF
[4205]	899	IF( PRESENT(kndims) ) kndims = iom_file(kiomid)%ndims(iiv)
[11536]	900	IF( PRESENT( lduld) ) lduld = iom_file(kiomid)%luld( iiv)
[544]	901	ENDIF
	902	ENDIF
	903	ENDIF
	904	!
	905	END FUNCTION iom_varid
	906
	907
	908	!!----------------------------------------------------------------------
	909	!! INTERFACE iom_get
	910	!!----------------------------------------------------------------------
[9367]	911	SUBROUTINE iom_g0d( kiomid, cdvar, pvar, ktime, ldxios )
[544]	912	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	913	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
	914	REAL(wp) , INTENT( out) :: pvar ! read field
[4245]	915	INTEGER , INTENT(in ), OPTIONAL :: ktime ! record number
[9367]	916	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! use xios to read restart
[544]	917	!
[4245]	918	INTEGER :: idvar ! variable id
	919	INTEGER :: idmspc ! number of spatial dimensions
	920	INTEGER , DIMENSION(1) :: itime ! record number
	921	CHARACTER(LEN=100) :: clinfo ! info character
	922	CHARACTER(LEN=100) :: clname ! file name
	923	CHARACTER(LEN=1) :: cldmspc !
[9367]	924	LOGICAL :: llxios
[544]	925	!
[9367]	926	llxios = .FALSE.
	927	IF( PRESENT(ldxios) ) llxios = ldxios
	928
	929	IF(.NOT.llxios) THEN ! read data using default library
	930	itime = 1
	931	IF( PRESENT(ktime) ) itime = ktime
	932	!
	933	clname = iom_file(kiomid)%name
	934	clinfo = ' iom_g0d, file: '//trim(clname)//', var: '//trim(cdvar)
	935	!
	936	IF( kiomid > 0 ) THEN
	937	idvar = iom_varid( kiomid, cdvar )
	938	IF( iom_file(kiomid)%nfid > 0 .AND. idvar > 0 ) THEN
	939	idmspc = iom_file ( kiomid )%ndims( idvar )
	940	IF( iom_file(kiomid)%luld(idvar) ) idmspc = idmspc - 1
	941	WRITE(cldmspc , fmt='(i1)') idmspc
	942	IF( idmspc > 0 ) CALL ctl_stop( TRIM(clinfo), 'When reading to a 0D array, we do not accept data', &
	943	& 'with 1 or more spatial dimensions: '//cldmspc//' were found.' , &
	944	& 'Use ncwa -a to suppress the unnecessary dimensions' )
[10425]	945	CALL iom_nf90_get( kiomid, idvar, pvar, itime )
[9367]	946	ENDIF
[679]	947	ENDIF
[9367]	948	ELSE
[9535]	949	#if defined key_iomput
[9367]	950	IF(lwp) WRITE(numout,*) 'XIOS RST READ (0D): ', trim(cdvar)
	951	CALL iom_swap( TRIM(crxios_context) )
	952	CALL xios_recv_field( trim(cdvar), pvar)
	953	CALL iom_swap( TRIM(cxios_context) )
[9535]	954	#else
[10425]	955	WRITE(ctmp1,*) 'Can not use XIOS in iom_g0d, file: '//trim(clname)//', var:'//trim(cdvar)
	956	CALL ctl_stop( 'iom_g0d', ctmp1 )
[9535]	957	#endif
[679]	958	ENDIF
[550]	959	END SUBROUTINE iom_g0d
[544]	960
[9367]	961	SUBROUTINE iom_g1d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount, ldxios )
[544]	962	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	963	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
	964	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
	965	REAL(wp) , INTENT( out), DIMENSION(:) :: pvar ! read field
	966	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
	967	INTEGER , INTENT(in ), DIMENSION(1), OPTIONAL :: kstart ! start axis position of the reading
	968	INTEGER , INTENT(in ), DIMENSION(1), OPTIONAL :: kcount ! number of points in each axis
[9367]	969	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! read data using XIOS
[544]	970	!
[679]	971	IF( kiomid > 0 ) THEN
	972	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r1d=pvar, &
[9367]	973	& ktime=ktime, kstart=kstart, kcount=kcount, &
	974	& ldxios=ldxios )
[679]	975	ENDIF
[550]	976	END SUBROUTINE iom_g1d
[544]	977
[9367]	978	SUBROUTINE iom_g2d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount, lrowattr, ldxios)
[544]	979	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	980	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
	981	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
	982	REAL(wp) , INTENT( out), DIMENSION(:,:) :: pvar ! read field
	983	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
	984	INTEGER , INTENT(in ), DIMENSION(2) , OPTIONAL :: kstart ! start axis position of the reading
	985	INTEGER , INTENT(in ), DIMENSION(2) , OPTIONAL :: kcount ! number of points in each axis
[5118]	986	LOGICAL , INTENT(in ) , OPTIONAL :: lrowattr ! logical flag telling iom_get to
	987	! look for and use a file attribute
	988	! called open_ocean_jstart to set the start
	989	! value for the 2nd dimension (netcdf only)
[9367]	990	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! read data using XIOS
[544]	991	!
[679]	992	IF( kiomid > 0 ) THEN
	993	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r2d=pvar, &
[5118]	994	& ktime=ktime, kstart=kstart, kcount=kcount, &
[9367]	995	& lrowattr=lrowattr, ldxios=ldxios)
[679]	996	ENDIF
[550]	997	END SUBROUTINE iom_g2d
[544]	998
[9367]	999	SUBROUTINE iom_g3d( kiomid, kdom, cdvar, pvar, ktime, kstart, kcount, lrowattr, ldxios )
[544]	1000	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1001	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
	1002	CHARACTER(len=*), INTENT(in ) :: cdvar ! Name of the variable
	1003	REAL(wp) , INTENT( out), DIMENSION(:,:,:) :: pvar ! read field
	1004	INTEGER , INTENT(in ) , OPTIONAL :: ktime ! record number
	1005	INTEGER , INTENT(in ), DIMENSION(3) , OPTIONAL :: kstart ! start axis position of the reading
	1006	INTEGER , INTENT(in ), DIMENSION(3) , OPTIONAL :: kcount ! number of points in each axis
[5118]	1007	LOGICAL , INTENT(in ) , OPTIONAL :: lrowattr ! logical flag telling iom_get to
	1008	! look for and use a file attribute
	1009	! called open_ocean_jstart to set the start
	1010	! value for the 2nd dimension (netcdf only)
[9367]	1011	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! read data using XIOS
[544]	1012	!
[679]	1013	IF( kiomid > 0 ) THEN
	1014	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_get_123d( kiomid, kdom , cdvar , pv_r3d=pvar, &
[5118]	1015	& ktime=ktime, kstart=kstart, kcount=kcount, &
[9367]	1016	& lrowattr=lrowattr, ldxios=ldxios )
[679]	1017	ENDIF
[550]	1018	END SUBROUTINE iom_g3d
[544]	1019	!!----------------------------------------------------------------------
	1020
	1021	SUBROUTINE iom_get_123d( kiomid, kdom , cdvar , &
[679]	1022	& pv_r1d, pv_r2d, pv_r3d, &
[5118]	1023	& ktime , kstart, kcount, &
[9367]	1024	& lrowattr, ldxios )
[544]	1025	!!-----------------------------------------------------------------------
	1026	!! * ROUTINE iom_get_123d *
	1027	!!
	1028	!! ** Purpose : read a 1D/2D/3D variable
	1029	!!
	1030	!! ** Method : read ONE record at each CALL
	1031	!!-----------------------------------------------------------------------
	1032	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1033	INTEGER , INTENT(in ) :: kdom ! Type of domain to be read
	1034	CHARACTER(len=*) , INTENT(in ) :: cdvar ! Name of the variable
	1035	REAL(wp), DIMENSION(:) , INTENT( out), OPTIONAL :: pv_r1d ! read field (1D case)
	1036	REAL(wp), DIMENSION(:,:) , INTENT( out), OPTIONAL :: pv_r2d ! read field (2D case)
	1037	REAL(wp), DIMENSION(:,:,:) , INTENT( out), OPTIONAL :: pv_r3d ! read field (3D case)
	1038	INTEGER , INTENT(in ), OPTIONAL :: ktime ! record number
	1039	INTEGER , DIMENSION(:) , INTENT(in ), OPTIONAL :: kstart ! start position of the reading in each axis
	1040	INTEGER , DIMENSION(:) , INTENT(in ), OPTIONAL :: kcount ! number of points to be read in each axis
[5118]	1041	LOGICAL , INTENT(in ), OPTIONAL :: lrowattr ! logical flag telling iom_get to
[9367]	1042	! look for and use a file attribute
	1043	! called open_ocean_jstart to set the start
	1044	! value for the 2nd dimension (netcdf only)
	1045	LOGICAL , INTENT(in ), OPTIONAL :: ldxios ! use XIOS to read restart
[544]	1046	!
[9367]	1047	LOGICAL :: llxios ! local definition for XIOS read
[1200]	1048	LOGICAL :: llnoov ! local definition to read overlap
[5118]	1049	LOGICAL :: luse_jattr ! local definition to read open_ocean_jstart file attribute
	1050	INTEGER :: jstartrow ! start point for 2nd dimension optionally set by file attribute
[544]	1051	INTEGER :: jl ! loop on number of dimension
	1052	INTEGER :: idom ! type of domain
	1053	INTEGER :: idvar ! id of the variable
	1054	INTEGER :: inbdim ! number of dimensions of the variable
	1055	INTEGER :: idmspc ! number of spatial dimensions
	1056	INTEGER :: itime ! record number
	1057	INTEGER :: istop ! temporary value of nstop
[679]	1058	INTEGER :: ix1, ix2, iy1, iy2 ! subdomain indexes
	1059	INTEGER :: ji, jj ! loop counters
[5118]	1060	INTEGER :: irankpv !
[679]	1061	INTEGER :: ind1, ind2 ! substring index
[544]	1062	INTEGER, DIMENSION(jpmax_dims) :: istart ! starting point to read for each axis
	1063	INTEGER, DIMENSION(jpmax_dims) :: icnt ! number of value to read along each axis
	1064	INTEGER, DIMENSION(jpmax_dims) :: idimsz ! size of the dimensions of the variable
[679]	1065	INTEGER, DIMENSION(jpmax_dims) :: ishape ! size of the dimensions of the variable
[544]	1066	REAL(wp) :: zscf, zofs ! sacle_factor and add_offset
	1067	INTEGER :: itmp ! temporary integer
[4148]	1068	CHARACTER(LEN=256) :: clinfo ! info character
	1069	CHARACTER(LEN=256) :: clname ! file name
[679]	1070	CHARACTER(LEN=1) :: clrankpv, cldmspc !
[6140]	1071	LOGICAL :: ll_depth_spec ! T => if kstart, kcount present then only use values for 3rd spatial dimension.
[9019]	1072	INTEGER :: inlev ! number of levels for 3D data
[9367]	1073	REAL(wp) :: gma, gmi
[544]	1074	!---------------------------------------------------------------------
	1075	!
[9019]	1076	inlev = -1
	1077	IF( PRESENT(pv_r3d) ) inlev = SIZE(pv_r3d, 3)
[9367]	1078	!
	1079	llxios = .FALSE.
	1080	if(PRESENT(ldxios)) llxios = ldxios
	1081	idvar = iom_varid( kiomid, cdvar )
[544]	1082	idom = kdom
[9367]	1083	!
	1084	IF(.NOT.llxios) THEN
	1085	clname = iom_file(kiomid)%name ! esier to read
	1086	clinfo = ' iom_get_123d, file: '//trim(clname)//', var: '//trim(cdvar)
	1087	! local definition of the domain ?
	1088	! do we read the overlap
	1089	! ugly patch SM+JMM+RB to overwrite global definition in some cases
	1090	llnoov = (jpni * jpnj ) == jpnij .AND. .NOT. lk_agrif
	1091	! check kcount and kstart optionals parameters...
	1092	IF( PRESENT(kcount) .AND. (.NOT. PRESENT(kstart)) ) CALL ctl_stop(trim(clinfo), 'kcount present needs kstart present')
	1093	IF( PRESENT(kstart) .AND. (.NOT. PRESENT(kcount)) ) CALL ctl_stop(trim(clinfo), 'kstart present needs kcount present')
	1094	IF( PRESENT(kstart) .AND. idom /= jpdom_unknown .AND. idom /= jpdom_autoglo_xy ) &
	1095	& CALL ctl_stop(trim(clinfo), 'kstart present needs kdom = jpdom_unknown or kdom = jpdom_autoglo_xy')
[544]	1096
[9367]	1097	luse_jattr = .false.
	1098	IF( PRESENT(lrowattr) ) THEN
	1099	IF( lrowattr .AND. idom /= jpdom_data ) CALL ctl_stop(trim(clinfo), 'lrowattr present and true needs kdom = jpdom_data')
	1100	IF( lrowattr .AND. idom == jpdom_data ) luse_jattr = .true.
[6140]	1101	ENDIF
[679]	1102
[9367]	1103	! Search for the variable in the data base (eventually actualize data)
	1104	istop = nstop
[544]	1105	!
[9367]	1106	IF( idvar > 0 ) THEN
	1107	! to write iom_file(kiomid)%dimsz in a shorter way !
	1108	idimsz(:) = iom_file(kiomid)%dimsz(:, idvar)
	1109	inbdim = iom_file(kiomid)%ndims(idvar) ! number of dimensions in the file
	1110	idmspc = inbdim ! number of spatial dimensions in the file
	1111	IF( iom_file(kiomid)%luld(idvar) ) idmspc = inbdim - 1
	1112	IF( idmspc > 3 ) CALL ctl_stop(trim(clinfo), 'the file has more than 3 spatial dimensions this case is not coded...')
	1113	!
	1114	! update idom definition...
	1115	! Identify the domain in case of jpdom_auto(glo/dta) definition
	1116	IF( idom == jpdom_autoglo_xy ) THEN
	1117	ll_depth_spec = .TRUE.
	1118	idom = jpdom_autoglo
	1119	ELSE
	1120	ll_depth_spec = .FALSE.
	1121	ENDIF
	1122	IF( idom == jpdom_autoglo .OR. idom == jpdom_autodta ) THEN
	1123	IF( idom == jpdom_autoglo ) THEN ; idom = jpdom_global
	1124	ELSE ; idom = jpdom_data
[544]	1125	ENDIF
[9367]	1126	ind1 = INDEX( clname, '_', back = .TRUE. ) + 1
	1127	ind2 = INDEX( clname, '.', back = .TRUE. ) - 1
	1128	IF( ind2 > ind1 ) THEN ; IF( VERIFY( clname(ind1:ind2), '0123456789' ) == 0 ) idom = jpdom_local ; ENDIF
	1129	ENDIF
	1130	! Identify the domain in case of jpdom_local definition
	1131	IF( idom == jpdom_local ) THEN
	1132	IF( idimsz(1) == jpi .AND. idimsz(2) == jpj ) THEN ; idom = jpdom_local_full
	1133	ELSEIF( idimsz(1) == nlci .AND. idimsz(2) == nlcj ) THEN ; idom = jpdom_local_noextra
	1134	ELSEIF( idimsz(1) == (nlei - nldi + 1) .AND. idimsz(2) == (nlej - nldj + 1) ) THEN ; idom = jpdom_local_noovlap
	1135	ELSE ; CALL ctl_stop( trim(clinfo), 'impossible to identify the local domain' )
	1136	ENDIF
	1137	ENDIF
	1138	!
	1139	! check the consistency between input array and data rank in the file
	1140	!
	1141	! initializations
	1142	itime = 1
	1143	IF( PRESENT(ktime) ) itime = ktime
	1144	!
	1145	irankpv = 1 * COUNT( (/PRESENT(pv_r1d)/) ) + 2 * COUNT( (/PRESENT(pv_r2d)/) ) + 3 * COUNT( (/PRESENT(pv_r3d)/) )
	1146	WRITE(clrankpv, fmt='(i1)') irankpv
	1147	WRITE(cldmspc , fmt='(i1)') idmspc
	1148	!
	1149	IF( idmspc < irankpv ) THEN
	1150	CALL ctl_stop( TRIM(clinfo), 'The file has only '//cldmspc//' spatial dimension', &
	1151	& 'it is impossible to read a '//clrankpv//'D array from this file...' )
	1152	ELSEIF( idmspc == irankpv ) THEN
	1153	IF( PRESENT(pv_r1d) .AND. idom /= jpdom_unknown ) &
	1154	& CALL ctl_stop( TRIM(clinfo), 'case not coded...You must use jpdom_unknown' )
	1155	ELSEIF( idmspc > irankpv ) THEN
	1156	IF( PRESENT(pv_r2d) .AND. itime == 1 .AND. idimsz(3) == 1 .AND. idmspc == 3 ) THEN
	1157	CALL ctl_warn( trim(clinfo), '2D array but 3 spatial dimensions for the data...' , &
	1158	& 'As the size of the z dimension is 1 and as we try to read the first record, ', &
	1159	& 'we accept this case, even if there is a possible mix-up between z and time dimension' )
	1160	idmspc = idmspc - 1
	1161	ELSE
	1162	CALL ctl_stop( TRIM(clinfo), 'To keep iom lisibility, when reading a '//clrankpv//'D array,' , &
	1163	& 'we do not accept data with '//cldmspc//' spatial dimensions', &
	1164	& 'Use ncwa -a to suppress the unnecessary dimensions' )
	1165	ENDIF
	1166	ENDIF
	1167	!
	1168	! definition of istart and icnt
	1169	!
	1170	icnt (:) = 1
	1171	istart(:) = 1
	1172	istart(idmspc+1) = itime
	1173
	1174	IF( PRESENT(kstart) .AND. .NOT. ll_depth_spec ) THEN
	1175	istart(1:idmspc) = kstart(1:idmspc)
	1176	icnt (1:idmspc) = kcount(1:idmspc)
	1177	ELSE
	1178	IF(idom == jpdom_unknown ) THEN
	1179	icnt(1:idmspc) = idimsz(1:idmspc)
	1180	ELSE
	1181	IF( .NOT. PRESENT(pv_r1d) ) THEN ! not a 1D array
	1182	IF( idom == jpdom_data ) THEN
	1183	jstartrow = 1
	1184	IF( luse_jattr ) THEN
	1185	CALL iom_getatt(kiomid, 'open_ocean_jstart', jstartrow ) ! -999 is returned if the attribute is not found
	1186	jstartrow = MAX(1,jstartrow)
	1187	ENDIF
	1188	istart(1:2) = (/ mig(1), mjg(1) + jstartrow - 1 /) ! icnt(1:2) done below
	1189	ELSEIF( idom == jpdom_global ) THEN ; istart(1:2) = (/ nimpp , njmpp /) ! icnt(1:2) done below
[5118]	1190	ENDIF
[9367]	1191	! we do not read the overlap -> we start to read at nldi, nldj
[679]	1192	! JMM + SM: ugly patch before getting the new version of lib_mpp)
	1193	! IF( idom /= jpdom_local_noovlap ) istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
[9367]	1194	IF( llnoov .AND. idom /= jpdom_local_noovlap ) istart(1:2) = istart(1:2) + (/ nldi - 1, nldj - 1 /)
[679]	1195	! we do not read the overlap and the extra-halos -> from nldi to nlei and from nldj to nlej
	1196	! JMM + SM: ugly patch before getting the new version of lib_mpp)
	1197	! icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
[9367]	1198	IF( llnoov ) THEN ; icnt(1:2) = (/ nlei - nldi + 1, nlej - nldj + 1 /)
	1199	ELSE ; icnt(1:2) = (/ nlci , nlcj /)
[544]	1200	ENDIF
[9367]	1201	IF( PRESENT(pv_r3d) ) THEN
	1202	IF( idom == jpdom_data ) THEN ; icnt(3) = inlev
	1203	ELSEIF( ll_depth_spec .AND. PRESENT(kstart) ) THEN ; istart(3) = kstart(3) ; icnt(3) = kcount(3)
	1204	ELSE ; icnt(3) = inlev
	1205	ENDIF
	1206	ENDIF
[544]	1207	ENDIF
	1208	ENDIF
[679]	1209	ENDIF
[544]	1210
[9367]	1211	! check that istart and icnt can be used with this file
	1212	!-
	1213	DO jl = 1, jpmax_dims
	1214	itmp = istart(jl)+icnt(jl)-1
	1215	IF( itmp > idimsz(jl) .AND. idimsz(jl) /= 0 ) THEN
	1216	WRITE( ctmp1, FMT="('(istart(', i1, ') + icnt(', i1, ') - 1) = ', i5)" ) jl, jl, itmp
	1217	WRITE( ctmp2, FMT="(' is larger than idimsz(', i1,') = ', i5)" ) jl, idimsz(jl)
	1218	CALL ctl_stop( trim(clinfo), 'start and count too big regarding to the size of the data, ', ctmp1, ctmp2 )
	1219	ENDIF
	1220	END DO
[544]	1221
[9367]	1222	! check that icnt matches the input array
	1223	!-
	1224	IF( idom == jpdom_unknown ) THEN
	1225	IF( irankpv == 1 ) ishape(1:1) = SHAPE(pv_r1d)
	1226	IF( irankpv == 2 ) ishape(1:2) = SHAPE(pv_r2d)
	1227	IF( irankpv == 3 ) ishape(1:3) = SHAPE(pv_r3d)
	1228	ctmp1 = 'd'
	1229	ELSE
	1230	IF( irankpv == 2 ) THEN
[679]	1231	! JMM + SM: ugly patch before getting the new version of lib_mpp)
	1232	! ishape(1:2) = SHAPE(pv_r2d(nldi:nlei,nldj:nlej )) ; ctmp1 = 'd(nldi:nlei,nldj:nlej)'
[9367]	1233	IF( llnoov ) THEN ; ishape(1:2)=SHAPE(pv_r2d(nldi:nlei,nldj:nlej )) ; ctmp1='d(nldi:nlei,nldj:nlej)'
	1234	ELSE ; ishape(1:2)=SHAPE(pv_r2d(1 :nlci,1 :nlcj )) ; ctmp1='d(1:nlci,1:nlcj)'
	1235	ENDIF
[544]	1236	ENDIF
[9367]	1237	IF( irankpv == 3 ) THEN
[679]	1238	! JMM + SM: ugly patch before getting the new version of lib_mpp)
	1239	! ishape(1:3) = SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:)) ; ctmp1 = 'd(nldi:nlei,nldj:nlej,:)'
[9367]	1240	IF( llnoov ) THEN ; ishape(1:3)=SHAPE(pv_r3d(nldi:nlei,nldj:nlej,:)) ; ctmp1='d(nldi:nlei,nldj:nlej,:)'
	1241	ELSE ; ishape(1:3)=SHAPE(pv_r3d(1 :nlci,1 :nlcj,:)) ; ctmp1='d(1:nlci,1:nlcj,:)'
	1242	ENDIF
[544]	1243	ENDIF
[679]	1244	ENDIF
	1245
[9367]	1246	DO jl = 1, irankpv
	1247	WRITE( ctmp2, FMT="(', ', i1,'): ', i5,' /= icnt(', i1,'):', i5)" ) jl, ishape(jl), jl, icnt(jl)
	1248	IF( ishape(jl) /= icnt(jl) ) CALL ctl_stop( TRIM(clinfo), 'size(pv_r'//clrankpv//TRIM(ctmp1)//TRIM(ctmp2) )
	1249	END DO
[679]	1250
[9367]	1251	ENDIF
[544]	1252
[9367]	1253	! read the data
	1254	!-
	1255	IF( idvar > 0 .AND. istop == nstop ) THEN ! no additional errors until this point...
	1256	!
[679]	1257	! find the right index of the array to be read
	1258	! JMM + SM: ugly patch before getting the new version of lib_mpp)
	1259	! IF( idom /= jpdom_unknown ) THEN ; ix1 = nldi ; ix2 = nlei ; iy1 = nldj ; iy2 = nlej
	1260	! ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
	1261	! ENDIF
[9367]	1262	IF( llnoov ) THEN
	1263	IF( idom /= jpdom_unknown ) THEN ; ix1 = nldi ; ix2 = nlei ; iy1 = nldj ; iy2 = nlej
	1264	ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
	1265	ENDIF
	1266	ELSE
	1267	IF( idom /= jpdom_unknown ) THEN ; ix1 = 1 ; ix2 = nlci ; iy1 = 1 ; iy2 = nlcj
	1268	ELSE ; ix1 = 1 ; ix2 = icnt(1) ; iy1 = 1 ; iy2 = icnt(2)
	1269	ENDIF
[679]	1270	ENDIF
	1271
[10425]	1272	CALL iom_nf90_get( kiomid, idvar, inbdim, istart, icnt, ix1, ix2, iy1, iy2, pv_r1d, pv_r2d, pv_r3d )
[679]	1273
[9367]	1274	IF( istop == nstop ) THEN ! no additional errors until this point...
	1275	IF(lwp) WRITE(numout,"(10x,' read ',a,' (rec: ',i6,') in ',a,' ok')") TRIM(cdvar), itime, TRIM(iom_file(kiomid)%name)
	1276
	1277	!--- overlap areas and extra hallows (mpp)
	1278	IF( PRESENT(pv_r2d) .AND. idom /= jpdom_unknown ) THEN
[11536]	1279	CALL lbc_lnk( 'iom', pv_r2d,'Z', -999., kfillmode = jpfillnothing )
[9367]	1280	ELSEIF( PRESENT(pv_r3d) .AND. idom /= jpdom_unknown ) THEN
	1281	! this if could be simplified with the new lbc_lnk that works with any size of the 3rd dimension
	1282	IF( icnt(3) == inlev ) THEN
[11536]	1283	CALL lbc_lnk( 'iom', pv_r3d,'Z', -999., kfillmode = jpfillnothing )
[9367]	1284	ELSE ! put some arbitrary value (a call to lbc_lnk will be done later...)
	1285	DO jj = nlcj+1, jpj ; pv_r3d(1:nlci, jj, :) = pv_r3d(1:nlci, nlej, :) ; END DO
	1286	DO ji = nlci+1, jpi ; pv_r3d(ji , : , :) = pv_r3d(nlei , : , :) ; END DO
	1287	ENDIF
[679]	1288	ENDIF
[9367]	1289	!
	1290	ELSE
	1291	! return if istop == nstop is false
	1292	RETURN
[679]	1293	ENDIF
[9367]	1294	ELSE
	1295	! return if statment idvar > 0 .AND. istop == nstop is false
	1296	RETURN
	1297	ENDIF
	1298	!
	1299	ELSE ! read using XIOS. Only if KEY_IOMPUT is defined
	1300	#if defined key_iomput
	1301	!would be good to be able to check which context is active and swap only if current is not restart
	1302	CALL iom_swap( TRIM(crxios_context) )
	1303	IF( PRESENT(pv_r3d) ) THEN
[9535]	1304	pv_r3d(:, :, :) = 0.
[9367]	1305	if(lwp) write(numout,*) 'XIOS RST READ (3D): ',trim(cdvar)
	1306	CALL xios_recv_field( trim(cdvar), pv_r3d)
	1307	IF(idom /= jpdom_unknown ) then
[11536]	1308	CALL lbc_lnk( 'iom', pv_r3d,'Z', -999., kfillmode = jpfillnothing)
[679]	1309	ENDIF
[9367]	1310	ELSEIF( PRESENT(pv_r2d) ) THEN
[9535]	1311	pv_r2d(:, :) = 0.
[9367]	1312	if(lwp) write(numout,*) 'XIOS RST READ (2D): ', trim(cdvar)
	1313	CALL xios_recv_field( trim(cdvar), pv_r2d)
	1314	IF(idom /= jpdom_unknown ) THEN
[11536]	1315	CALL lbc_lnk('iom', pv_r2d,'Z',-999., kfillmode = jpfillnothing)
[9367]	1316	ENDIF
	1317	ELSEIF( PRESENT(pv_r1d) ) THEN
[9535]	1318	pv_r1d(:) = 0.
[9367]	1319	if(lwp) write(numout,*) 'XIOS RST READ (1D): ', trim(cdvar)
	1320	CALL xios_recv_field( trim(cdvar), pv_r1d)
[544]	1321	ENDIF
[9367]	1322	CALL iom_swap( TRIM(cxios_context) )
	1323	#else
	1324	istop = istop + 1
	1325	clinfo = 'Can not use XIOS in iom_get_123d, file: '//trim(clname)//', var:'//trim(cdvar)
	1326	#endif
[544]	1327	ENDIF
[9367]	1328	!some final adjustments
	1329	! C1D case : always call lbc_lnk to replicate the central value over the whole 3X3 domain
[10425]	1330	IF( lk_c1d .AND. PRESENT(pv_r2d) ) CALL lbc_lnk( 'iom', pv_r2d,'Z',1. )
	1331	IF( lk_c1d .AND. PRESENT(pv_r3d) ) CALL lbc_lnk( 'iom', pv_r3d,'Z',1. )
[9367]	1332
	1333	!--- Apply scale_factor and offset
	1334	zscf = iom_file(kiomid)%scf(idvar) ! scale factor
	1335	zofs = iom_file(kiomid)%ofs(idvar) ! offset
	1336	IF( PRESENT(pv_r1d) ) THEN
	1337	IF( zscf /= 1. ) pv_r1d(:) = pv_r1d(:) * zscf
	1338	IF( zofs /= 0. ) pv_r1d(:) = pv_r1d(:) + zofs
	1339	ELSEIF( PRESENT(pv_r2d) ) THEN
	1340	IF( zscf /= 1.) pv_r2d(:,:) = pv_r2d(:,:) * zscf
	1341	IF( zofs /= 0.) pv_r2d(:,:) = pv_r2d(:,:) + zofs
	1342	ELSEIF( PRESENT(pv_r3d) ) THEN
	1343	IF( zscf /= 1.) pv_r3d(:,:,:) = pv_r3d(:,:,:) * zscf
	1344	IF( zofs /= 0.) pv_r3d(:,:,:) = pv_r3d(:,:,:) + zofs
	1345	ENDIF
[544]	1346	!
	1347	END SUBROUTINE iom_get_123d
	1348
[12109]	1349	SUBROUTINE iom_get_var( cdname, z2d)
	1350	CHARACTER(LEN=*), INTENT(in ) :: cdname
	1351	REAL(wp), DIMENSION(jpi,jpj) :: z2d
	1352	#if defined key_iomput
	1353	IF( xios_field_is_active( cdname, at_current_timestep_arg = .TRUE. ) ) THEN
	1354	z2d(:,:) = 0._wp
	1355	CALL xios_recv_field( cdname, z2d)
	1356	ENDIF
	1357	#else
	1358	IF( .FALSE. ) WRITE(numout,*) cdname, z2d ! useless test to avoid compilation warnings
	1359	#endif
	1360	END SUBROUTINE iom_get_var
[544]	1361
[12109]	1362
[10522]	1363	FUNCTION iom_getszuld ( kiomid )
	1364	!!-----------------------------------------------------------------------
	1365	!! * FUNCTION iom_getszuld *
[544]	1366	!!
[10522]	1367	!! ** Purpose : get the size of the unlimited dimension in a file
	1368	!! (return -1 if not found)
	1369	!!-----------------------------------------------------------------------
	1370	INTEGER, INTENT(in ) :: kiomid ! file Identifier
[544]	1371	!
[10522]	1372	INTEGER :: iom_getszuld
	1373	!!-----------------------------------------------------------------------
	1374	iom_getszuld = -1
[679]	1375	IF( kiomid > 0 ) THEN
[10523]	1376	IF( iom_file(kiomid)%iduld > 0 ) iom_getszuld = iom_file(kiomid)%lenuld
[544]	1377	ENDIF
[10522]	1378	END FUNCTION iom_getszuld
	1379
[544]	1380
	1381	!!----------------------------------------------------------------------
[10425]	1382	!! INTERFACE iom_chkatt
[2528]	1383	!!----------------------------------------------------------------------
[10425]	1384	SUBROUTINE iom_chkatt( kiomid, cdatt, llok, ksize, cdvar )
[2528]	1385	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1386	CHARACTER(len=*), INTENT(in ) :: cdatt ! Name of the attribute
[10425]	1387	LOGICAL , INTENT( out) :: llok ! Error code
	1388	INTEGER , INTENT( out), OPTIONAL :: ksize ! Size of the attribute array
[7646]	1389	CHARACTER(len=*), INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
[2528]	1390	!
	1391	IF( kiomid > 0 ) THEN
[10425]	1392	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_chkatt( kiomid, cdatt, llok, ksize=ksize, cdvar=cdvar )
[2528]	1393	ENDIF
[10425]	1394	!
	1395	END SUBROUTINE iom_chkatt
	1396
	1397	!!----------------------------------------------------------------------
	1398	!! INTERFACE iom_getatt
	1399	!!----------------------------------------------------------------------
	1400	SUBROUTINE iom_g0d_iatt( kiomid, cdatt, katt0d, cdvar )
	1401	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1402	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1403	INTEGER , INTENT( out) :: katt0d ! read field
	1404	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
	1405	!
	1406	IF( kiomid > 0 ) THEN
	1407	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, katt0d = katt0d, cdvar=cdvar )
	1408	ENDIF
[7646]	1409	END SUBROUTINE iom_g0d_iatt
[2528]	1410
[10425]	1411	SUBROUTINE iom_g1d_iatt( kiomid, cdatt, katt1d, cdvar )
	1412	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1413	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1414	INTEGER, DIMENSION(:) , INTENT( out) :: katt1d ! read field
	1415	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
[7646]	1416	!
	1417	IF( kiomid > 0 ) THEN
[10425]	1418	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, katt1d = katt1d, cdvar=cdvar )
[7646]	1419	ENDIF
[10425]	1420	END SUBROUTINE iom_g1d_iatt
	1421
	1422	SUBROUTINE iom_g0d_ratt( kiomid, cdatt, patt0d, cdvar )
	1423	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1424	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1425	REAL(wp) , INTENT( out) :: patt0d ! read field
	1426	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
	1427	!
	1428	IF( kiomid > 0 ) THEN
	1429	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, patt0d = patt0d, cdvar=cdvar )
	1430	ENDIF
[7646]	1431	END SUBROUTINE iom_g0d_ratt
[2528]	1432
[10425]	1433	SUBROUTINE iom_g1d_ratt( kiomid, cdatt, patt1d, cdvar )
	1434	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1435	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1436	REAL(wp), DIMENSION(:), INTENT( out) :: patt1d ! read field
	1437	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
[7646]	1438	!
	1439	IF( kiomid > 0 ) THEN
[10425]	1440	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, patt1d = patt1d, cdvar=cdvar )
[7646]	1441	ENDIF
[10425]	1442	END SUBROUTINE iom_g1d_ratt
	1443
	1444	SUBROUTINE iom_g0d_catt( kiomid, cdatt, cdatt0d, cdvar )
	1445	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1446	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1447	CHARACTER(len=*) , INTENT( out) :: cdatt0d ! read field
	1448	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
	1449	!
	1450	IF( kiomid > 0 ) THEN
	1451	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_getatt( kiomid, cdatt, cdatt0d = cdatt0d, cdvar=cdvar )
	1452	ENDIF
[7646]	1453	END SUBROUTINE iom_g0d_catt
	1454
[10425]	1455
[2528]	1456	!!----------------------------------------------------------------------
[7646]	1457	!! INTERFACE iom_putatt
	1458	!!----------------------------------------------------------------------
[10425]	1459	SUBROUTINE iom_p0d_iatt( kiomid, cdatt, katt0d, cdvar )
	1460	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1461	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1462	INTEGER , INTENT(in ) :: katt0d ! written field
	1463	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
[7646]	1464	!
	1465	IF( kiomid > 0 ) THEN
[10425]	1466	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, katt0d = katt0d, cdvar=cdvar )
[7646]	1467	ENDIF
	1468	END SUBROUTINE iom_p0d_iatt
	1469
[10425]	1470	SUBROUTINE iom_p1d_iatt( kiomid, cdatt, katt1d, cdvar )
	1471	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1472	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1473	INTEGER, DIMENSION(:) , INTENT(in ) :: katt1d ! written field
	1474	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
[7646]	1475	!
	1476	IF( kiomid > 0 ) THEN
[10425]	1477	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, katt1d = katt1d, cdvar=cdvar )
[7646]	1478	ENDIF
[10425]	1479	END SUBROUTINE iom_p1d_iatt
	1480
	1481	SUBROUTINE iom_p0d_ratt( kiomid, cdatt, patt0d, cdvar )
	1482	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1483	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1484	REAL(wp) , INTENT(in ) :: patt0d ! written field
	1485	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
	1486	!
	1487	IF( kiomid > 0 ) THEN
	1488	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, patt0d = patt0d, cdvar=cdvar )
	1489	ENDIF
[7646]	1490	END SUBROUTINE iom_p0d_ratt
	1491
[10425]	1492	SUBROUTINE iom_p1d_ratt( kiomid, cdatt, patt1d, cdvar )
	1493	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1494	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1495	REAL(wp), DIMENSION(:), INTENT(in ) :: patt1d ! written field
	1496	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
[7646]	1497	!
	1498	IF( kiomid > 0 ) THEN
[10425]	1499	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, patt1d = patt1d, cdvar=cdvar )
[7646]	1500	ENDIF
[10425]	1501	END SUBROUTINE iom_p1d_ratt
	1502
	1503	SUBROUTINE iom_p0d_catt( kiomid, cdatt, cdatt0d, cdvar )
	1504	INTEGER , INTENT(in ) :: kiomid ! Identifier of the file
	1505	CHARACTER(len=*) , INTENT(in ) :: cdatt ! Name of the attribute
	1506	CHARACTER(len=*) , INTENT(in ) :: cdatt0d ! written field
	1507	CHARACTER(len=*) , INTENT(in ), OPTIONAL :: cdvar ! Name of the variable
	1508	!
	1509	IF( kiomid > 0 ) THEN
	1510	IF( iom_file(kiomid)%nfid > 0 ) CALL iom_nf90_putatt( kiomid, cdatt, cdatt0d = cdatt0d, cdvar=cdvar )
	1511	ENDIF
[7646]	1512	END SUBROUTINE iom_p0d_catt
	1513
[10425]	1514
[7646]	1515	!!----------------------------------------------------------------------
[544]	1516	!! INTERFACE iom_rstput
	1517	!!----------------------------------------------------------------------
[9367]	1518	SUBROUTINE iom_rp0d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
[544]	1519	INTEGER , INTENT(in) :: kt ! ocean time-step
	1520	INTEGER , INTENT(in) :: kwrite ! writing time-step
	1521	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
	1522	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
[556]	1523	REAL(wp) , INTENT(in) :: pvar ! written field
[544]	1524	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
[9367]	1525	LOGICAL, OPTIONAL :: ldxios ! xios write flag
	1526	LOGICAL :: llx ! local xios write flag
[544]	1527	INTEGER :: ivid ! variable id
[9367]	1528
	1529	llx = .FALSE.
	1530	IF(PRESENT(ldxios)) llx = ldxios
	1531	IF( llx ) THEN
	1532	#ifdef key_iomput
	1533	IF( kt == kwrite ) THEN
	1534	IF(lwp) write(numout,*) 'RESTART: write (XIOS 0D) ',trim(cdvar)
	1535	CALL xios_send_field(trim(cdvar), pvar)
	1536	ENDIF
	1537	#endif
	1538	ELSE
	1539	IF( kiomid > 0 ) THEN
	1540	IF( iom_file(kiomid)%nfid > 0 ) THEN
	1541	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
[10425]	1542	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r0d = pvar )
[9367]	1543	ENDIF
[679]	1544	ENDIF
	1545	ENDIF
[550]	1546	END SUBROUTINE iom_rp0d
[544]	1547
[9367]	1548	SUBROUTINE iom_rp1d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
[544]	1549	INTEGER , INTENT(in) :: kt ! ocean time-step
	1550	INTEGER , INTENT(in) :: kwrite ! writing time-step
	1551	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
	1552	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
[2715]	1553	REAL(wp) , INTENT(in), DIMENSION( :) :: pvar ! written field
[544]	1554	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
[9367]	1555	LOGICAL, OPTIONAL :: ldxios ! xios write flag
	1556	LOGICAL :: llx ! local xios write flag
[544]	1557	INTEGER :: ivid ! variable id
[9367]	1558
	1559	llx = .FALSE.
	1560	IF(PRESENT(ldxios)) llx = ldxios
	1561	IF( llx ) THEN
	1562	#ifdef key_iomput
	1563	IF( kt == kwrite ) THEN
	1564	IF(lwp) write(numout,*) 'RESTART: write (XIOS 1D) ',trim(cdvar)
	1565	CALL xios_send_field(trim(cdvar), pvar)
	1566	ENDIF
	1567	#endif
	1568	ELSE
	1569	IF( kiomid > 0 ) THEN
	1570	IF( iom_file(kiomid)%nfid > 0 ) THEN
	1571	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
[10425]	1572	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r1d = pvar )
[9367]	1573	ENDIF
[679]	1574	ENDIF
	1575	ENDIF
[550]	1576	END SUBROUTINE iom_rp1d
[544]	1577
[9367]	1578	SUBROUTINE iom_rp2d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
[544]	1579	INTEGER , INTENT(in) :: kt ! ocean time-step
	1580	INTEGER , INTENT(in) :: kwrite ! writing time-step
	1581	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
	1582	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
[2715]	1583	REAL(wp) , INTENT(in), DIMENSION(:, : ) :: pvar ! written field
[544]	1584	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
[9367]	1585	LOGICAL, OPTIONAL :: ldxios ! xios write flag
	1586	LOGICAL :: llx
[544]	1587	INTEGER :: ivid ! variable id
[9367]	1588
	1589	llx = .FALSE.
	1590	IF(PRESENT(ldxios)) llx = ldxios
	1591	IF( llx ) THEN
	1592	#ifdef key_iomput
	1593	IF( kt == kwrite ) THEN
	1594	IF(lwp) write(numout,*) 'RESTART: write (XIOS 2D) ',trim(cdvar)
	1595	CALL xios_send_field(trim(cdvar), pvar)
	1596	ENDIF
	1597	#endif
	1598	ELSE
	1599	IF( kiomid > 0 ) THEN
	1600	IF( iom_file(kiomid)%nfid > 0 ) THEN
	1601	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
[10425]	1602	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r2d = pvar )
[9367]	1603	ENDIF
[679]	1604	ENDIF
	1605	ENDIF
[550]	1606	END SUBROUTINE iom_rp2d
[544]	1607
[9367]	1608	SUBROUTINE iom_rp3d( kt, kwrite, kiomid, cdvar, pvar, ktype, ldxios )
[544]	1609	INTEGER , INTENT(in) :: kt ! ocean time-step
	1610	INTEGER , INTENT(in) :: kwrite ! writing time-step
	1611	INTEGER , INTENT(in) :: kiomid ! Identifier of the file
	1612	CHARACTER(len=*), INTENT(in) :: cdvar ! time axis name
[2715]	1613	REAL(wp) , INTENT(in), DIMENSION(:,:,:) :: pvar ! written field
[544]	1614	INTEGER , INTENT(in), OPTIONAL :: ktype ! variable external type
[9367]	1615	LOGICAL, OPTIONAL :: ldxios ! xios write flag
	1616	LOGICAL :: llx ! local xios write flag
[544]	1617	INTEGER :: ivid ! variable id
[9367]	1618
	1619	llx = .FALSE.
	1620	IF(PRESENT(ldxios)) llx = ldxios
	1621	IF( llx ) THEN
	1622	#ifdef key_iomput
	1623	IF( kt == kwrite ) THEN
	1624	IF(lwp) write(numout,*) 'RESTART: write (XIOS 3D) ',trim(cdvar)
	1625	CALL xios_send_field(trim(cdvar), pvar)
	1626	ENDIF
	1627	#endif
	1628	ELSE
	1629	IF( kiomid > 0 ) THEN
	1630	IF( iom_file(kiomid)%nfid > 0 ) THEN
	1631	ivid = iom_varid( kiomid, cdvar, ldstop = .FALSE. )
[10425]	1632	CALL iom_nf90_rstput( kt, kwrite, kiomid, cdvar, ivid, ktype, pv_r3d = pvar )
[9367]	1633	ENDIF
[679]	1634	ENDIF
	1635	ENDIF
[550]	1636	END SUBROUTINE iom_rp3d
[1359]	1637
	1638
[10425]	1639	SUBROUTINE iom_delay_rst( cdaction, cdcpnt, kncid )
	1640	!!---------------------------------------------------------------------
	1641	!! Routine iom_delay_rst: used read/write restart related to mpp_delay
	1642	!!
	1643	!!---------------------------------------------------------------------
	1644	CHARACTER(len=*), INTENT(in ) :: cdaction !
	1645	CHARACTER(len=*), INTENT(in ) :: cdcpnt
	1646	INTEGER , INTENT(in ) :: kncid
	1647	!
	1648	INTEGER :: ji
	1649	INTEGER :: indim
	1650	LOGICAL :: llattexist
	1651	REAL(wp), ALLOCATABLE, DIMENSION(:) :: zreal1d
	1652	!!---------------------------------------------------------------------
	1653	!
	1654	! ===================================
	1655	IF( TRIM(cdaction) == 'READ' ) THEN ! read restart related to mpp_delay !
	1656	! ===================================
	1657	DO ji = 1, nbdelay
	1658	IF ( c_delaycpnt(ji) == cdcpnt ) THEN
	1659	CALL iom_chkatt( kncid, 'DELAY_'//c_delaylist(ji), llattexist, indim )
	1660	IF( llattexist ) THEN
	1661	ALLOCATE( todelay(ji)%z1d(indim) )
	1662	CALL iom_getatt( kncid, 'DELAY_'//c_delaylist(ji), todelay(ji)%z1d(:) )
	1663	ndelayid(ji) = 0 ! set to 0 to specify that the value was read in the restart
	1664	ENDIF
	1665	ENDIF
	1666	END DO
	1667	! ====================================
	1668	ELSE ! write restart related to mpp_delay !
	1669	! ====================================
	1670	DO ji = 1, nbdelay ! save only ocean delayed global communication variables
	1671	IF ( c_delaycpnt(ji) == cdcpnt ) THEN
	1672	IF( ASSOCIATED(todelay(ji)%z1d) ) THEN
	1673	CALL mpp_delay_rcv(ji) ! make sure %z1d is received
	1674	CALL iom_putatt( kncid, 'DELAY_'//c_delaylist(ji), todelay(ji)%z1d(:) )
	1675	ENDIF
	1676	ENDIF
	1677	END DO
	1678	!
	1679	ENDIF
	1680
	1681	END SUBROUTINE iom_delay_rst
	1682
	1683
	1684
[544]	1685	!!----------------------------------------------------------------------
[1457]	1686	!! INTERFACE iom_put
[1359]	1687	!!----------------------------------------------------------------------
[1738]	1688	SUBROUTINE iom_p0d( cdname, pfield0d )
	1689	CHARACTER(LEN=*), INTENT(in) :: cdname
	1690	REAL(wp) , INTENT(in) :: pfield0d
[11536]	1691	!! REAL(wp) , DIMENSION(jpi,jpj) :: zz ! masson
[1738]	1692	#if defined key_iomput
[11536]	1693	!!clem zz(:,:)=pfield0d
	1694	!!clem CALL xios_send_field(cdname, zz)
	1695	CALL xios_send_field(cdname, (/pfield0d/))
[1738]	1696	#else
	1697	IF( .FALSE. ) WRITE(numout,*) cdname, pfield0d ! useless test to avoid compilation warnings
	1698	#endif
	1699	END SUBROUTINE iom_p0d
	1700
[3294]	1701	SUBROUTINE iom_p1d( cdname, pfield1d )
	1702	CHARACTER(LEN=*) , INTENT(in) :: cdname
	1703	REAL(wp), DIMENSION(:), INTENT(in) :: pfield1d
	1704	#if defined key_iomput
[3695]	1705	CALL xios_send_field( cdname, RESHAPE( (/pfield1d/), (/1,1,SIZE(pfield1d)/) ) )
[3294]	1706	#else
	1707	IF( .FALSE. ) WRITE(numout,*) cdname, pfield1d ! useless test to avoid compilation warnings
	1708	#endif
	1709	END SUBROUTINE iom_p1d
	1710
[1359]	1711	SUBROUTINE iom_p2d( cdname, pfield2d )
	1712	CHARACTER(LEN=*) , INTENT(in) :: cdname
[2715]	1713	REAL(wp), DIMENSION(:,:), INTENT(in) :: pfield2d
[1412]	1714	#if defined key_iomput
[3695]	1715	CALL xios_send_field(cdname, pfield2d)
[1520]	1716	#else
	1717	IF( .FALSE. ) WRITE(numout,*) cdname, pfield2d ! useless test to avoid compilation warnings
[1359]	1718	#endif
	1719	END SUBROUTINE iom_p2d
[544]	1720
[1359]	1721	SUBROUTINE iom_p3d( cdname, pfield3d )
	1722	CHARACTER(LEN=*) , INTENT(in) :: cdname
[2715]	1723	REAL(wp), DIMENSION(:,:,:), INTENT(in) :: pfield3d
[1412]	1724	#if defined key_iomput
[9019]	1725	CALL xios_send_field( cdname, pfield3d )
[1520]	1726	#else
	1727	IF( .FALSE. ) WRITE(numout,*) cdname, pfield3d ! useless test to avoid compilation warnings
[1359]	1728	#endif
	1729	END SUBROUTINE iom_p3d
[544]	1730
[12109]	1731	SUBROUTINE iom_p4d( cdname, pfield4d )
	1732	CHARACTER(LEN=*) , INTENT(in) :: cdname
	1733	REAL(wp), DIMENSION(:,:,:,:), INTENT(in) :: pfield4d
[1412]	1734	#if defined key_iomput
[12109]	1735	CALL xios_send_field(cdname, pfield4d)
	1736	#else
	1737	IF( .FALSE. ) WRITE(numout,*) cdname, pfield4d ! useless test to avoid compilation warnings
	1738	#endif
	1739	END SUBROUTINE iom_p4d
	1740
	1741
	1742	#if defined key_iomput
[9019]	1743	!!----------------------------------------------------------------------
[9802]	1744	!! 'key_iomput' XIOS interface
[9019]	1745	!!----------------------------------------------------------------------
[1359]	1746
[9930]	1747	SUBROUTINE iom_set_domain_attr( cdid, ni_glo, nj_glo, ibegin, jbegin, ni, nj, &
[5363]	1748	& data_dim, data_ibegin, data_ni, data_jbegin, data_nj, lonvalue, latvalue, mask, &
[5415]	1749	& nvertex, bounds_lon, bounds_lat, area )
[9019]	1750	!!----------------------------------------------------------------------
	1751	!!----------------------------------------------------------------------
	1752	CHARACTER(LEN=*) , INTENT(in) :: cdid
	1753	INTEGER , OPTIONAL, INTENT(in) :: ni_glo, nj_glo, ibegin, jbegin, ni, nj
	1754	INTEGER , OPTIONAL, INTENT(in) :: data_dim, data_ibegin, data_ni, data_jbegin, data_nj
[9930]	1755	INTEGER , OPTIONAL, INTENT(in) :: nvertex
[9019]	1756	REAL(wp), DIMENSION(:) , OPTIONAL, INTENT(in) :: lonvalue, latvalue
	1757	REAL(wp), DIMENSION(:,:), OPTIONAL, INTENT(in) :: bounds_lon, bounds_lat, area
	1758	LOGICAL , DIMENSION(:) , OPTIONAL, INTENT(in) :: mask
	1759	!!----------------------------------------------------------------------
	1760	!
	1761	IF( xios_is_valid_domain (cdid) ) THEN
[4148]	1762	CALL xios_set_domain_attr ( cdid, ni_glo=ni_glo, nj_glo=nj_glo, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj, &
	1763	& data_dim=data_dim, data_ibegin=data_ibegin, data_ni=data_ni, data_jbegin=data_jbegin, data_nj=data_nj , &
[7646]	1764	& lonvalue_1D=lonvalue, latvalue_1D=latvalue, mask_1D=mask, nvertex=nvertex, bounds_lon_1D=bounds_lon, &
	1765	& bounds_lat_1D=bounds_lat, area=area, type='curvilinear')
[9367]	1766	ENDIF
[9019]	1767	IF( xios_is_valid_domaingroup(cdid) ) THEN
[4148]	1768	CALL xios_set_domaingroup_attr( cdid, ni_glo=ni_glo, nj_glo=nj_glo, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj, &
	1769	& data_dim=data_dim, data_ibegin=data_ibegin, data_ni=data_ni, data_jbegin=data_jbegin, data_nj=data_nj , &
[7646]	1770	& lonvalue_1D=lonvalue, latvalue_1D=latvalue, mask_1D=mask, nvertex=nvertex, bounds_lon_1D=bounds_lon, &
	1771	& bounds_lat_1D=bounds_lat, area=area, type='curvilinear' )
[3695]	1772	ENDIF
[9019]	1773	!
[4148]	1774	CALL xios_solve_inheritance()
[9019]	1775	!
[3695]	1776	END SUBROUTINE iom_set_domain_attr
	1777
	1778
[9019]	1779	SUBROUTINE iom_set_zoom_domain_attr( cdid, ibegin, jbegin, ni, nj )
	1780	!!----------------------------------------------------------------------
	1781	!!----------------------------------------------------------------------
[9930]	1782	CHARACTER(LEN=*), INTENT(in) :: cdid
	1783	INTEGER , INTENT(in) :: ibegin, jbegin, ni, nj
	1784	!
	1785	TYPE(xios_gridgroup) :: gridgroup_hdl
	1786	TYPE(xios_grid) :: grid_hdl
	1787	TYPE(xios_domain) :: domain_hdl
	1788	TYPE(xios_axis) :: axis_hdl
	1789	CHARACTER(LEN=64) :: cldomrefid ! domain_ref name
	1790	CHARACTER(len=1) :: cl1 ! last character of this name
[9019]	1791	!!----------------------------------------------------------------------
[9930]	1792	!
	1793	IF( xios_is_valid_zoom_domain(cdid) ) THEN
	1794	! define the zoom_domain attributs
	1795	CALL xios_set_zoom_domain_attr( cdid, ibegin=ibegin, jbegin=jbegin, ni=ni, nj=nj )
	1796	! define a new 2D grid with this new domain
	1797	CALL xios_get_handle("grid_definition", gridgroup_hdl )
	1798	CALL xios_add_child(gridgroup_hdl, grid_hdl, TRIM(cdid)//'_2D' ) ! add a new 2D grid to grid_definition
	1799	CALL xios_add_child(grid_hdl, domain_hdl, TRIM(cdid) ) ! add its domain
	1800	! define a new 3D grid with this new domain
	1801	CALL xios_add_child(gridgroup_hdl, grid_hdl, TRIM(cdid)//'_3D' ) ! add a new 3D grid to grid_definition
	1802	CALL xios_add_child(grid_hdl, domain_hdl, TRIM(cdid) ) ! add its domain
	1803	! vertical axis
	1804	cl1 = cdid(LEN_TRIM(cdid):) ! last letter of cdid
	1805	cl1 = CHAR(ICHAR(cl1)+32) ! from upper to lower case
	1806	CALL xios_add_child(grid_hdl, axis_hdl, 'depth'//cl1) ! add its axis
	1807	ENDIF
	1808	!
[7646]	1809	END SUBROUTINE iom_set_zoom_domain_attr
	1810
	1811
[5415]	1812	SUBROUTINE iom_set_axis_attr( cdid, paxis, bounds )
[9019]	1813	!!----------------------------------------------------------------------
	1814	!!----------------------------------------------------------------------
[4148]	1815	CHARACTER(LEN=*) , INTENT(in) :: cdid
[5415]	1816	REAL(wp), DIMENSION(:) , OPTIONAL, INTENT(in) :: paxis
	1817	REAL(wp), DIMENSION(:,:), OPTIONAL, INTENT(in) :: bounds
[9019]	1818	!!----------------------------------------------------------------------
	1819	IF( PRESENT(paxis) ) THEN
	1820	IF( xios_is_valid_axis (cdid) ) CALL xios_set_axis_attr ( cdid, n_glo=SIZE(paxis), value=paxis )
	1821	IF( xios_is_valid_axisgroup(cdid) ) CALL xios_set_axisgroup_attr( cdid, n_glo=SIZE(paxis), value=paxis )
[5415]	1822	ENDIF
[9019]	1823	IF( xios_is_valid_axis (cdid) ) CALL xios_set_axis_attr ( cdid, bounds=bounds )
	1824	IF( xios_is_valid_axisgroup(cdid) ) CALL xios_set_axisgroup_attr( cdid, bounds=bounds )
[4148]	1825	CALL xios_solve_inheritance()
[3737]	1826	END SUBROUTINE iom_set_axis_attr
	1827
	1828
[4148]	1829	SUBROUTINE iom_set_field_attr( cdid, freq_op, freq_offset )
[9019]	1830	!!----------------------------------------------------------------------
	1831	!!----------------------------------------------------------------------
	1832	CHARACTER(LEN=*) , INTENT(in) :: cdid
	1833	TYPE(xios_duration), OPTIONAL, INTENT(in) :: freq_op
	1834	TYPE(xios_duration), OPTIONAL, INTENT(in) :: freq_offset
	1835	!!----------------------------------------------------------------------
	1836	IF( xios_is_valid_field (cdid) ) CALL xios_set_field_attr ( cdid, freq_op=freq_op, freq_offset=freq_offset )
	1837	IF( xios_is_valid_fieldgroup(cdid) ) CALL xios_set_fieldgroup_attr( cdid, freq_op=freq_op, freq_offset=freq_offset )
[4148]	1838	CALL xios_solve_inheritance()
[3695]	1839	END SUBROUTINE iom_set_field_attr
	1840
	1841
[4148]	1842	SUBROUTINE iom_set_file_attr( cdid, name, name_suffix )
[9019]	1843	!!----------------------------------------------------------------------
	1844	!!----------------------------------------------------------------------
[4148]	1845	CHARACTER(LEN=*) , INTENT(in) :: cdid
[3695]	1846	CHARACTER(LEN=*),OPTIONAL , INTENT(in) :: name, name_suffix
[9019]	1847	!!----------------------------------------------------------------------
	1848	IF( xios_is_valid_file (cdid) ) CALL xios_set_file_attr ( cdid, name=name, name_suffix=name_suffix )
	1849	IF( xios_is_valid_filegroup(cdid) ) CALL xios_set_filegroup_attr( cdid, name=name, name_suffix=name_suffix )
[4148]	1850	CALL xios_solve_inheritance()
[3771]	1851	END SUBROUTINE iom_set_file_attr
[3695]	1852
	1853
[4148]	1854	SUBROUTINE iom_get_file_attr( cdid, name, name_suffix, output_freq )
[9019]	1855	!!----------------------------------------------------------------------
	1856	!!----------------------------------------------------------------------
[4148]	1857	CHARACTER(LEN=*) , INTENT(in ) :: cdid
[7646]	1858	CHARACTER(LEN=*),OPTIONAL , INTENT(out) :: name, name_suffix
	1859	TYPE(xios_duration), OPTIONAL , INTENT(out) :: output_freq
[4148]	1860	LOGICAL :: llexist1,llexist2,llexist3
	1861	!---------------------------------------------------------------------
	1862	IF( PRESENT( name ) ) name = '' ! default values
	1863	IF( PRESENT( name_suffix ) ) name_suffix = ''
[7646]	1864	IF( PRESENT( output_freq ) ) output_freq = xios_duration(0,0,0,0,0,0)
[9019]	1865	IF( xios_is_valid_file (cdid) ) THEN
[4148]	1866	CALL xios_solve_inheritance()
	1867	CALL xios_is_defined_file_attr ( cdid, name = llexist1, name_suffix = llexist2, output_freq = llexist3)
	1868	IF(llexist1) CALL xios_get_file_attr ( cdid, name = name )
	1869	IF(llexist2) CALL xios_get_file_attr ( cdid, name_suffix = name_suffix )
	1870	IF(llexist3) CALL xios_get_file_attr ( cdid, output_freq = output_freq )
	1871	ENDIF
[9019]	1872	IF( xios_is_valid_filegroup(cdid) ) THEN
[4148]	1873	CALL xios_solve_inheritance()
	1874	CALL xios_is_defined_filegroup_attr( cdid, name = llexist1, name_suffix = llexist2, output_freq = llexist3)
	1875	IF(llexist1) CALL xios_get_filegroup_attr( cdid, name = name )
	1876	IF(llexist2) CALL xios_get_filegroup_attr( cdid, name_suffix = name_suffix )
	1877	IF(llexist3) CALL xios_get_filegroup_attr( cdid, output_freq = output_freq )
	1878	ENDIF
	1879	END SUBROUTINE iom_get_file_attr
	1880
	1881
	1882	SUBROUTINE iom_set_grid_attr( cdid, mask )
[9019]	1883	!!----------------------------------------------------------------------
	1884	!!----------------------------------------------------------------------
[4148]	1885	CHARACTER(LEN=*) , INTENT(in) :: cdid
[3771]	1886	LOGICAL, DIMENSION(:,:,:), OPTIONAL, INTENT(in) :: mask
[9019]	1887	!!----------------------------------------------------------------------
	1888	IF( xios_is_valid_grid (cdid) ) CALL xios_set_grid_attr ( cdid, mask_3D=mask )
	1889	IF( xios_is_valid_gridgroup(cdid) ) CALL xios_set_gridgroup_attr( cdid, mask_3D=mask )
[4148]	1890	CALL xios_solve_inheritance()
[3771]	1891	END SUBROUTINE iom_set_grid_attr
[3695]	1892
[4152]	1893	SUBROUTINE iom_setkt( kt, cdname )
[9019]	1894	!!----------------------------------------------------------------------
	1895	!!----------------------------------------------------------------------
[4152]	1896	INTEGER , INTENT(in) :: kt
	1897	CHARACTER(LEN=*), INTENT(in) :: cdname
[9019]	1898	!!----------------------------------------------------------------------
[4152]	1899	CALL iom_swap( cdname ) ! swap to cdname context
	1900	CALL xios_update_calendar(kt)
[9019]	1901	IF( cdname /= TRIM(cxios_context) ) CALL iom_swap( TRIM(cxios_context) ) ! return back to nemo context
[4152]	1902	END SUBROUTINE iom_setkt
[3695]	1903
[4152]	1904	SUBROUTINE iom_context_finalize( cdname )
[9019]	1905	!!----------------------------------------------------------------------
	1906	!!----------------------------------------------------------------------
[4152]	1907	CHARACTER(LEN=*), INTENT(in) :: cdname
[9367]	1908	CHARACTER(LEN=120) :: clname
[9019]	1909	!!----------------------------------------------------------------------
[9367]	1910	clname = cdname
	1911	IF( TRIM(Agrif_CFixed()) .NE. '0' ) clname = TRIM(Agrif_CFixed())//"_"//clname
	1912	IF( xios_is_valid_context(clname) ) THEN
[4990]	1913	CALL iom_swap( cdname ) ! swap to cdname context
	1914	CALL xios_context_finalize() ! finalize the context
[5407]	1915	IF( cdname /= TRIM(cxios_context) ) CALL iom_swap( TRIM(cxios_context) ) ! return back to nemo context
[4990]	1916	ENDIF
[9367]	1917	!
[4152]	1918	END SUBROUTINE iom_context_finalize
	1919
	1920
[9984]	1921	SUBROUTINE set_grid( cdgrd, plon, plat, ldxios, ldrxios )
[1359]	1922	!!----------------------------------------------------------------------
[4148]	1923	!! * ROUTINE set_grid *
[1359]	1924	!!
[1725]	1925	!! ** Purpose : define horizontal grids
[1359]	1926	!!----------------------------------------------------------------------
[3771]	1927	CHARACTER(LEN=1) , INTENT(in) :: cdgrd
[1359]	1928	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plon
	1929	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plat
[3771]	1930	!
[9019]	1931	INTEGER :: ni, nj
[3771]	1932	REAL(wp), DIMENSION(jpi,jpj,jpk) :: zmask
[9984]	1933	LOGICAL, INTENT(IN) :: ldxios, ldrxios
[9019]	1934	!!----------------------------------------------------------------------
	1935	!
	1936	ni = nlei-nldi+1
	1937	nj = nlej-nldj+1
	1938	!
[7646]	1939	CALL iom_set_domain_attr("grid_"//cdgrd, ni_glo=jpiglo, nj_glo=jpjglo, ibegin=nimpp+nldi-2, jbegin=njmpp+nldj-2, ni=ni, nj=nj)
[3771]	1940	CALL iom_set_domain_attr("grid_"//cdgrd, data_dim=2, data_ibegin = 1-nldi, data_ni = jpi, data_jbegin = 1-nldj, data_nj = jpj)
[9984]	1941	!don't define lon and lat for restart reading context.
	1942	IF ( .NOT.ldrxios ) &
	1943	CALL iom_set_domain_attr("grid_"//cdgrd, lonvalue = RESHAPE(plon(nldi:nlei, nldj:nlej),(/ ni*nj /)), &
[3771]	1944	& latvalue = RESHAPE(plat(nldi:nlei, nldj:nlej),(/ ni*nj /)))
[9019]	1945	!
[9367]	1946	IF ( ln_mskland .AND. (.NOT.ldxios) ) THEN
[3771]	1947	! mask land points, keep values on coast line -> specific mask for U, V and W points
	1948	SELECT CASE ( cdgrd )
	1949	CASE('T') ; zmask(:,:,:) = tmask(:,:,:)
[10425]	1950	CASE('U') ; zmask(2:jpim1,:,:) = tmask(2:jpim1,:,:) + tmask(3:jpi,:,:) ; CALL lbc_lnk( 'iom', zmask, 'U', 1. )
	1951	CASE('V') ; zmask(:,2:jpjm1,:) = tmask(:,2:jpjm1,:) + tmask(:,3:jpj,:) ; CALL lbc_lnk( 'iom', zmask, 'V', 1. )
[3771]	1952	CASE('W') ; zmask(:,:,2:jpk ) = tmask(:,:,1:jpkm1) + tmask(:,:,2:jpk) ; zmask(:,:,1) = tmask(:,:,1)
	1953	END SELECT
	1954	!
[7646]	1955	CALL iom_set_domain_attr( "grid_"//cdgrd , mask = RESHAPE(zmask(nldi:nlei,nldj:nlej,1),(/ni*nj /)) /= 0. )
[4148]	1956	CALL iom_set_grid_attr ( "grid_"//cdgrd//"_3D", mask = RESHAPE(zmask(nldi:nlei,nldj:nlej,:),(/ni,nj,jpk/)) /= 0. )
[3771]	1957	ENDIF
[9019]	1958	!
[1359]	1959	END SUBROUTINE set_grid
	1960
[1725]	1961
[5415]	1962	SUBROUTINE set_grid_bounds( cdgrd, plon_cnr, plat_cnr, plon_pnt, plat_pnt )
[5363]	1963	!!----------------------------------------------------------------------
	1964	!! * ROUTINE set_grid_bounds *
	1965	!!
	1966	!! ** Purpose : define horizontal grid corners
	1967	!!
	1968	!!----------------------------------------------------------------------
[9019]	1969	CHARACTER(LEN=1) , INTENT(in) :: cdgrd
	1970	REAL(wp), DIMENSION(jpi,jpj) , INTENT(in) :: plon_cnr, plat_cnr ! Lat/lon coord. of a contiguous vertex of cell (i,j)
	1971	REAL(wp), DIMENSION(jpi,jpj), OPTIONAL, INTENT(in) :: plon_pnt, plat_pnt ! Lat/lon coord. of the point of cell (i,j)
[5363]	1972	!
[9019]	1973	INTEGER :: ji, jj, jn, ni, nj
	1974	INTEGER :: icnr, jcnr ! Offset such that the vertex coordinate (i+icnr,j+jcnr)
	1975	! ! represents the bottom-left corner of cell (i,j)
	1976	REAL(wp), ALLOCATABLE, DIMENSION(:,:,:,:) :: z_bnds ! Lat/lon coordinates of the vertices of cell (i,j)
	1977	REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: z_fld ! Working array to determine where to rotate cells
	1978	REAL(wp), ALLOCATABLE, DIMENSION(:,:) :: z_rot ! Lat/lon working array for rotation of cells
	1979	!!----------------------------------------------------------------------
[5415]	1980	!
[9019]	1981	ALLOCATE( z_bnds(4,jpi,jpj,2), z_fld(jpi,jpj), z_rot(4,2) )
[5363]	1982	!
[5415]	1983	! Offset of coordinate representing bottom-left corner
[5363]	1984	SELECT CASE ( TRIM(cdgrd) )
[9019]	1985	CASE ('T', 'W') ; icnr = -1 ; jcnr = -1
	1986	CASE ('U') ; icnr = 0 ; jcnr = -1
	1987	CASE ('V') ; icnr = -1 ; jcnr = 0
[5363]	1988	END SELECT
[9019]	1989	!
	1990	ni = nlei-nldi+1 ! Dimensions of subdomain interior
	1991	nj = nlej-nldj+1
	1992	!
[5363]	1993	z_fld(:,:) = 1._wp
[10425]	1994	CALL lbc_lnk( 'iom', z_fld, cdgrd, -1. ) ! Working array for location of northfold
[9019]	1995	!
[5363]	1996	! Cell vertices that can be defined
	1997	DO jj = 2, jpjm1
	1998	DO ji = 2, jpim1
[5415]	1999	z_bnds(1,ji,jj,1) = plat_cnr(ji+icnr, jj+jcnr ) ! Bottom-left
	2000	z_bnds(2,ji,jj,1) = plat_cnr(ji+icnr+1,jj+jcnr ) ! Bottom-right
	2001	z_bnds(3,ji,jj,1) = plat_cnr(ji+icnr+1,jj+jcnr+1) ! Top-right
	2002	z_bnds(4,ji,jj,1) = plat_cnr(ji+icnr, jj+jcnr+1) ! Top-left
	2003	z_bnds(1,ji,jj,2) = plon_cnr(ji+icnr, jj+jcnr ) ! Bottom-left
	2004	z_bnds(2,ji,jj,2) = plon_cnr(ji+icnr+1,jj+jcnr ) ! Bottom-right
	2005	z_bnds(3,ji,jj,2) = plon_cnr(ji+icnr+1,jj+jcnr+1) ! Top-right
	2006	z_bnds(4,ji,jj,2) = plon_cnr(ji+icnr, jj+jcnr+1) ! Top-left
[5363]	2007	END DO
	2008	END DO
[9019]	2009	!
[5363]	2010	! Cell vertices on boundries
	2011	DO jn = 1, 4
[11536]	2012	CALL lbc_lnk( 'iom', z_bnds(jn,:,:,1), cdgrd, 1., pfillval=999._wp )
	2013	CALL lbc_lnk( 'iom', z_bnds(jn,:,:,2), cdgrd, 1., pfillval=999._wp )
[5363]	2014	END DO
[9019]	2015	!
[5415]	2016	! Zero-size cells at closed boundaries if cell points provided,
	2017	! otherwise they are closed cells with unrealistic bounds
	2018	IF( PRESENT(plon_pnt) .AND. PRESENT(plat_pnt) ) THEN
	2019	IF( (nbondi == -1 .OR. nbondi == 2) .AND. .NOT. (jperio == 1 .OR. jperio == 4 .OR. jperio == 6) ) THEN
	2020	DO jn = 1, 4 ! (West or jpni = 1), closed E-W
	2021	z_bnds(jn,1,:,1) = plat_pnt(1,:) ; z_bnds(jn,1,:,2) = plon_pnt(1,:)
	2022	END DO
	2023	ENDIF
	2024	IF( (nbondi == 1 .OR. nbondi == 2) .AND. .NOT. (jperio == 1 .OR. jperio == 4 .OR. jperio == 6) ) THEN
	2025	DO jn = 1, 4 ! (East or jpni = 1), closed E-W
	2026	z_bnds(jn,nlci,:,1) = plat_pnt(nlci,:) ; z_bnds(jn,nlci,:,2) = plon_pnt(nlci,:)
	2027	END DO
	2028	ENDIF
	2029	IF( nbondj == -1 .OR. (nbondj == 2 .AND. jperio /= 2) ) THEN
	2030	DO jn = 1, 4 ! South or (jpnj = 1, not symmetric)
	2031	z_bnds(jn,:,1,1) = plat_pnt(:,1) ; z_bnds(jn,:,1,2) = plon_pnt(:,1)
	2032	END DO
	2033	ENDIF
	2034	IF( (nbondj == 1 .OR. nbondj == 2) .AND. jperio < 3 ) THEN
	2035	DO jn = 1, 4 ! (North or jpnj = 1), no north fold
	2036	z_bnds(jn,:,nlcj,1) = plat_pnt(:,nlcj) ; z_bnds(jn,:,nlcj,2) = plon_pnt(:,nlcj)
	2037	END DO
	2038	ENDIF
[5363]	2039	ENDIF
[9019]	2040	!
	2041	IF( (nbondj == 1 .OR. nbondj == 2) .AND. jperio >= 3 ) THEN ! Rotate cells at the north fold
[5363]	2042	DO jj = 1, jpj
	2043	DO ji = 1, jpi
	2044	IF( z_fld(ji,jj) == -1. ) THEN
	2045	z_rot(1,:) = z_bnds(3,ji,jj,:) ; z_rot(2,:) = z_bnds(4,ji,jj,:)
	2046	z_rot(3,:) = z_bnds(1,ji,jj,:) ; z_rot(4,:) = z_bnds(2,ji,jj,:)
	2047	z_bnds(:,ji,jj,:) = z_rot(:,:)
	2048	ENDIF
	2049	END DO
	2050	END DO
[9019]	2051	ELSE IF( nbondj == 2 .AND. jperio == 2 ) THEN ! Invert cells at the symmetric equator
[5363]	2052	DO ji = 1, jpi
	2053	z_rot(1:2,:) = z_bnds(3:4,ji,1,:)
	2054	z_rot(3:4,:) = z_bnds(1:2,ji,1,:)
	2055	z_bnds(:,ji,1,:) = z_rot(:,:)
	2056	END DO
	2057	ENDIF
[9019]	2058	!
[5363]	2059	CALL iom_set_domain_attr("grid_"//cdgrd, bounds_lat = RESHAPE(z_bnds(:,nldi:nlei,nldj:nlej,1),(/ 4,ni*nj /)), &
[9019]	2060	& bounds_lon = RESHAPE(z_bnds(:,nldi:nlei,nldj:nlej,2),(/ 4,ni*nj /)), nvertex=4 )
	2061	!
[5415]	2062	DEALLOCATE( z_bnds, z_fld, z_rot )
[9019]	2063	!
[5363]	2064	END SUBROUTINE set_grid_bounds
	2065
	2066
[5385]	2067	SUBROUTINE set_grid_znl( plat )
	2068	!!----------------------------------------------------------------------
	2069	!! * ROUTINE set_grid_znl *
	2070	!!
	2071	!! ** Purpose : define grids for zonal mean
	2072	!!
	2073	!!----------------------------------------------------------------------
	2074	REAL(wp), DIMENSION(jpi,jpj), INTENT(in) :: plat
	2075	!
[9019]	2076	INTEGER :: ni, nj, ix, iy
[5385]	2077	REAL(wp), DIMENSION(:), ALLOCATABLE :: zlon
[9019]	2078	!!----------------------------------------------------------------------
	2079	!
	2080	ni=nlei-nldi+1 ! define zonal mean domain (jpj*jpk)
	2081	nj=nlej-nldj+1
	2082	ALLOCATE( zlon(ni*nj) ) ; zlon(:) = 0._wp
	2083	!
[12109]	2084	! CALL dom_ngb( -168.53, 65.03, ix, iy, 'T' ) ! i-line that passes through Bering Strait: Reference latitude (used in plots)
	2085	CALL dom_ngb( 180., 90., ix, iy, 'T' ) ! i-line that passes near the North Pole : Reference latitude (used in plots)
[7646]	2086	CALL iom_set_domain_attr("gznl", ni_glo=jpiglo, nj_glo=jpjglo, ibegin=nimpp+nldi-2, jbegin=njmpp+nldj-2, ni=ni, nj=nj)
[5385]	2087	CALL iom_set_domain_attr("gznl", data_dim=2, data_ibegin = 1-nldi, data_ni = jpi, data_jbegin = 1-nldj, data_nj = jpj)
	2088	CALL iom_set_domain_attr("gznl", lonvalue = zlon, &
	2089	& latvalue = RESHAPE(plat(nldi:nlei, nldj:nlej),(/ ni*nj /)))
[12109]	2090	CALL iom_set_zoom_domain_attr("ptr", ibegin=ix-1, jbegin=0, ni=1, nj=jpjglo)
[5385]	2091	!
	2092	CALL iom_update_file_name('ptr')
	2093	!
	2094	END SUBROUTINE set_grid_znl
	2095
[9019]	2096
[1738]	2097	SUBROUTINE set_scalar
	2098	!!----------------------------------------------------------------------
[4148]	2099	!! * ROUTINE set_scalar *
[1738]	2100	!!
	2101	!! ** Purpose : define fake grids for scalar point
	2102	!!
	2103	!!----------------------------------------------------------------------
[5426]	2104	REAL(wp), DIMENSION(1) :: zz = 1.
[1738]	2105	!!----------------------------------------------------------------------
[9019]	2106	!
[7646]	2107	CALL iom_set_domain_attr('scalarpoint', ni_glo=jpnij, nj_glo=1, ibegin=narea-1, jbegin=0, ni=1, nj=1)
[5426]	2108	CALL iom_set_domain_attr('scalarpoint', data_dim=2, data_ibegin = 1, data_ni = 1, data_jbegin = 1, data_nj = 1)
[9019]	2109	!
	2110	zz = REAL( narea, wp )
[5426]	2111	CALL iom_set_domain_attr('scalarpoint', lonvalue=zz, latvalue=zz)
[9019]	2112	!
[1738]	2113	END SUBROUTINE set_scalar
	2114
	2115
[1725]	2116	SUBROUTINE set_xmlatt
	2117	!!----------------------------------------------------------------------
[4148]	2118	!! * ROUTINE set_xmlatt *
[1725]	2119	!!
	2120	!! ** Purpose : automatic definitions of some of the xml attributs...
	2121	!!
	2122	!!----------------------------------------------------------------------
	2123	CHARACTER(len=1),DIMENSION( 3) :: clgrd ! suffix name
[4148]	2124	CHARACTER(len=256) :: clsuff ! suffix name
[1725]	2125	CHARACTER(len=1) :: cl1 ! 1 character
[5003]	2126	CHARACTER(len=2) :: cl2 ! 2 characters
	2127	CHARACTER(len=3) :: cl3 ! 3 characters
[4148]	2128	INTEGER :: ji, jg ! loop counters
[1725]	2129	INTEGER :: ix, iy ! i-,j- index
	2130	REAL(wp) ,DIMENSION(11) :: zlontao ! longitudes of tao moorings
	2131	REAL(wp) ,DIMENSION( 7) :: zlattao ! latitudes of tao moorings
	2132	REAL(wp) ,DIMENSION( 4) :: zlonrama ! longitudes of rama moorings
	2133	REAL(wp) ,DIMENSION(11) :: zlatrama ! latitudes of rama moorings
	2134	REAL(wp) ,DIMENSION( 3) :: zlonpira ! longitudes of pirata moorings
	2135	REAL(wp) ,DIMENSION( 9) :: zlatpira ! latitudes of pirata moorings
[7646]	2136	TYPE(xios_duration) :: f_op, f_of
[1725]	2137	!!----------------------------------------------------------------------
	2138	!
	2139	! frequency of the call of iom_put (attribut: freq_op)
[9019]	2140	f_op%timestep = 1 ; f_of%timestep = 0 ; CALL iom_set_field_attr('field_definition', freq_op=f_op, freq_offset=f_of)
	2141	f_op%timestep = 2 ; f_of%timestep = 0 ; CALL iom_set_field_attr('trendT_even' , freq_op=f_op, freq_offset=f_of)
	2142	f_op%timestep = 2 ; f_of%timestep = -1 ; CALL iom_set_field_attr('trendT_odd' , freq_op=f_op, freq_offset=f_of)
	2143	f_op%timestep = nn_fsbc ; f_of%timestep = 0 ; CALL iom_set_field_attr('SBC' , freq_op=f_op, freq_offset=f_of)
	2144	f_op%timestep = nn_fsbc ; f_of%timestep = 0 ; CALL iom_set_field_attr('SBC_scalar' , freq_op=f_op, freq_offset=f_of)
	2145	f_op%timestep = nn_dttrc ; f_of%timestep = 0 ; CALL iom_set_field_attr('ptrc_T' , freq_op=f_op, freq_offset=f_of)
	2146	f_op%timestep = nn_dttrc ; f_of%timestep = 0 ; CALL iom_set_field_attr('diad_T' , freq_op=f_op, freq_offset=f_of)
[7646]	2147
[1725]	2148	! output file names (attribut: name)
[4148]	2149	DO ji = 1, 9
	2150	WRITE(cl1,'(i1)') ji
	2151	CALL iom_update_file_name('file'//cl1)
[1725]	2152	END DO
[4148]	2153	DO ji = 1, 99
	2154	WRITE(cl2,'(i2.2)') ji
	2155	CALL iom_update_file_name('file'//cl2)
	2156	END DO
[5003]	2157	DO ji = 1, 999
	2158	WRITE(cl3,'(i3.3)') ji
	2159	CALL iom_update_file_name('file'//cl3)
	2160	END DO
[1725]	2161
	2162	! Zooms...
	2163	clgrd = (/ 'T', 'U', 'W' /)
	2164	DO jg = 1, SIZE(clgrd) ! grid type
	2165	cl1 = clgrd(jg)
	2166	! Equatorial section (attributs: jbegin, ni, name_suffix)
	2167	CALL dom_ngb( 0., 0., ix, iy, cl1 )
[9930]	2168	CALL iom_set_zoom_domain_attr('Eq'//cl1, ibegin=0, jbegin=iy-1, ni=jpiglo, nj=1 )
[4148]	2169	CALL iom_get_file_attr ('Eq'//cl1, name_suffix = clsuff )
	2170	CALL iom_set_file_attr ('Eq'//cl1, name_suffix = TRIM(clsuff)//'_Eq')
	2171	CALL iom_update_file_name('Eq'//cl1)
[1725]	2172	END DO
	2173	! TAO moorings (attributs: ibegin, jbegin, name_suffix)
	2174	zlontao = (/ 137.0, 147.0, 156.0, 165.0, -180.0, -170.0, -155.0, -140.0, -125.0, -110.0, -95.0 /)
	2175	zlattao = (/ -8.0, -5.0, -2.0, 0.0, 2.0, 5.0, 8.0 /)
	2176	CALL set_mooring( zlontao, zlattao )
	2177	! RAMA moorings (attributs: ibegin, jbegin, name_suffix)
	2178	zlonrama = (/ 55.0, 67.0, 80.5, 90.0 /)
	2179	zlatrama = (/ -16.0, -12.0, -8.0, -4.0, -1.5, 0.0, 1.5, 4.0, 8.0, 12.0, 15.0 /)
	2180	CALL set_mooring( zlonrama, zlatrama )
	2181	! PIRATA moorings (attributs: ibegin, jbegin, name_suffix)
	2182	zlonpira = (/ -38.0, -23.0, -10.0 /)
	2183	zlatpira = (/ -19.0, -14.0, -8.0, 0.0, 4.0, 8.0, 12.0, 15.0, 20.0 /)
	2184	CALL set_mooring( zlonpira, zlatpira )
[9019]	2185	!
[1725]	2186	END SUBROUTINE set_xmlatt
	2187
	2188
[9019]	2189	SUBROUTINE set_mooring( plon, plat )
[1725]	2190	!!----------------------------------------------------------------------
[4148]	2191	!! * ROUTINE set_mooring *
[1725]	2192	!!
	2193	!! ** Purpose : automatic definitions of moorings xml attributs...
	2194	!!
	2195	!!----------------------------------------------------------------------
[9019]	2196	REAL(wp), DIMENSION(:), INTENT(in) :: plon, plat ! longitudes/latitudes oft the mooring
[1725]	2197	!
	2198	!!$ CHARACTER(len=1),DIMENSION(4) :: clgrd = (/ 'T', 'U', 'V', 'W' /) ! suffix name
	2199	CHARACTER(len=1),DIMENSION(1) :: clgrd = (/ 'T' /) ! suffix name
[4148]	2200	CHARACTER(len=256) :: clname ! file name
	2201	CHARACTER(len=256) :: clsuff ! suffix name
[1725]	2202	CHARACTER(len=1) :: cl1 ! 1 character
	2203	CHARACTER(len=6) :: clon,clat ! name of longitude, latitude
	2204	INTEGER :: ji, jj, jg ! loop counters
	2205	INTEGER :: ix, iy ! i-,j- index
	2206	REAL(wp) :: zlon, zlat
	2207	!!----------------------------------------------------------------------
	2208	DO jg = 1, SIZE(clgrd)
	2209	cl1 = clgrd(jg)
	2210	DO ji = 1, SIZE(plon)
	2211	DO jj = 1, SIZE(plat)
	2212	zlon = plon(ji)
	2213	zlat = plat(jj)
	2214	! modifications for RAMA moorings
	2215	IF( zlon == 67. .AND. zlat == 15. ) zlon = 65.
	2216	IF( zlon == 90. .AND. zlat <= -4. ) zlon = 95.
	2217	IF( zlon == 95. .AND. zlat == -4. ) zlat = -5.
	2218	! modifications for PIRATA moorings
	2219	IF( zlon == -38. .AND. zlat == -19. ) zlon = -34.
	2220	IF( zlon == -38. .AND. zlat == -14. ) zlon = -32.
	2221	IF( zlon == -38. .AND. zlat == -8. ) zlon = -30.
	2222	IF( zlon == -38. .AND. zlat == 0. ) zlon = -35.
	2223	IF( zlon == -23. .AND. zlat == 20. ) zlat = 21.
	2224	IF( zlon == -10. .AND. zlat == -14. ) zlat = -10.
	2225	IF( zlon == -10. .AND. zlat == -8. ) zlat = -6.
	2226	IF( zlon == -10. .AND. zlat == 4. ) THEN ; zlon = 0. ; zlat = 0. ; ENDIF
	2227	CALL dom_ngb( zlon, zlat, ix, iy, cl1 )
	2228	IF( zlon >= 0. ) THEN
	2229	IF( zlon == REAL(NINT(zlon), wp) ) THEN ; WRITE(clon, '(i3, a)') NINT( zlon), 'e'
	2230	ELSE ; WRITE(clon, '(f5.1,a)') zlon , 'e'
	2231	ENDIF
	2232	ELSE
	2233	IF( zlon == REAL(NINT(zlon), wp) ) THEN ; WRITE(clon, '(i3, a)') NINT(-zlon), 'w'
	2234	ELSE ; WRITE(clon, '(f5.1,a)') -zlon , 'w'
	2235	ENDIF
	2236	ENDIF
	2237	IF( zlat >= 0. ) THEN
	2238	IF( zlat == REAL(NINT(zlat), wp) ) THEN ; WRITE(clat, '(i2, a)') NINT( zlat), 'n'
	2239	ELSE ; WRITE(clat, '(f4.1,a)') zlat , 'n'
	2240	ENDIF
	2241	ELSE
	2242	IF( zlat == REAL(NINT(zlat), wp) ) THEN ; WRITE(clat, '(i2, a)') NINT(-zlat), 's'
	2243	ELSE ; WRITE(clat, '(f4.1,a)') -zlat , 's'
	2244	ENDIF
	2245	ENDIF
	2246	clname = TRIM(ADJUSTL(clat))//TRIM(ADJUSTL(clon))
[9930]	2247	CALL iom_set_zoom_domain_attr(TRIM(clname)//cl1, ibegin= ix-1, jbegin= iy-1, ni=1, nj=1)
[7646]	2248
[4148]	2249	CALL iom_get_file_attr (TRIM(clname)//cl1, name_suffix = clsuff )
	2250	CALL iom_set_file_attr (TRIM(clname)//cl1, name_suffix = TRIM(clsuff)//'_'//TRIM(clname))
	2251	CALL iom_update_file_name(TRIM(clname)//cl1)
[1725]	2252	END DO
	2253	END DO
	2254	END DO
	2255
	2256	END SUBROUTINE set_mooring
	2257
[4148]	2258
	2259	SUBROUTINE iom_update_file_name( cdid )
	2260	!!----------------------------------------------------------------------
	2261	!! * ROUTINE iom_update_file_name *
	2262	!!
	2263	!! ** Purpose :
	2264	!!
	2265	!!----------------------------------------------------------------------
	2266	CHARACTER(LEN=*) , INTENT(in) :: cdid
	2267	!
	2268	CHARACTER(LEN=256) :: clname
	2269	CHARACTER(LEN=20) :: clfreq
	2270	CHARACTER(LEN=20) :: cldate
[11554]	2271	CHARACTER(LEN=256) :: cltmpn !FUS needed for correct path with AGRIF
	2272	INTEGER :: iln !FUS needed for correct path with AGRIF
[4148]	2273	INTEGER :: idx
	2274	INTEGER :: jn
	2275	INTEGER :: itrlen
	2276	INTEGER :: iyear, imonth, iday, isec
	2277	REAL(wp) :: zsec
	2278	LOGICAL :: llexist
[7646]	2279	TYPE(xios_duration) :: output_freq
[4148]	2280	!!----------------------------------------------------------------------
[9019]	2281	!
	2282	DO jn = 1, 2
	2283	!
[7646]	2284	output_freq = xios_duration(0,0,0,0,0,0)
	2285	IF( jn == 1 ) CALL iom_get_file_attr( cdid, name = clname, output_freq = output_freq )
[4148]	2286	IF( jn == 2 ) CALL iom_get_file_attr( cdid, name_suffix = clname )
[9019]	2287	!
[4148]	2288	IF ( TRIM(clname) /= '' ) THEN
[9019]	2289	!
[4148]	2290	idx = INDEX(clname,'@expname@') + INDEX(clname,'@EXPNAME@')
	2291	DO WHILE ( idx /= 0 )
	2292	clname = clname(1:idx-1)//TRIM(cexper)//clname(idx+9:LEN_TRIM(clname))
	2293	idx = INDEX(clname,'@expname@') + INDEX(clname,'@EXPNAME@')
	2294	END DO
[9019]	2295	!
[4148]	2296	idx = INDEX(clname,'@freq@') + INDEX(clname,'@FREQ@')
	2297	DO WHILE ( idx /= 0 )
[7646]	2298	IF ( output_freq%timestep /= 0) THEN
	2299	WRITE(clfreq,'(I18,A2)')INT(output_freq%timestep),'ts'
	2300	itrlen = LEN_TRIM(ADJUSTL(clfreq))
[7764]	2301	ELSE IF ( output_freq%second /= 0 ) THEN
	2302	WRITE(clfreq,'(I19,A1)')INT(output_freq%second),'s'
	2303	itrlen = LEN_TRIM(ADJUSTL(clfreq))
	2304	ELSE IF ( output_freq%minute /= 0 ) THEN
[7768]	2305	WRITE(clfreq,'(I18,A2)')INT(output_freq%minute),'mi'
[7764]	2306	itrlen = LEN_TRIM(ADJUSTL(clfreq))
[7646]	2307	ELSE IF ( output_freq%hour /= 0 ) THEN
	2308	WRITE(clfreq,'(I19,A1)')INT(output_freq%hour),'h'
	2309	itrlen = LEN_TRIM(ADJUSTL(clfreq))
	2310	ELSE IF ( output_freq%day /= 0 ) THEN
	2311	WRITE(clfreq,'(I19,A1)')INT(output_freq%day),'d'
	2312	itrlen = LEN_TRIM(ADJUSTL(clfreq))
	2313	ELSE IF ( output_freq%month /= 0 ) THEN
	2314	WRITE(clfreq,'(I19,A1)')INT(output_freq%month),'m'
	2315	itrlen = LEN_TRIM(ADJUSTL(clfreq))
	2316	ELSE IF ( output_freq%year /= 0 ) THEN
	2317	WRITE(clfreq,'(I19,A1)')INT(output_freq%year),'y'
	2318	itrlen = LEN_TRIM(ADJUSTL(clfreq))
	2319	ELSE
[4148]	2320	CALL ctl_stop('error in the name of file id '//TRIM(cdid), &
	2321	& ' attribute output_freq is undefined -> cannot replace @freq@ in '//TRIM(clname) )
[7646]	2322	ENDIF
	2323	clname = clname(1:idx-1)//TRIM(ADJUSTL(clfreq))//clname(idx+6:LEN_TRIM(clname))
	2324	idx = INDEX(clname,'@freq@') + INDEX(clname,'@FREQ@')
[4148]	2325	END DO
[9019]	2326	!
[4148]	2327	idx = INDEX(clname,'@startdate@') + INDEX(clname,'@STARTDATE@')
	2328	DO WHILE ( idx /= 0 )
[6140]	2329	cldate = iom_sdate( fjulday - rdt / rday )
[4148]	2330	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+11:LEN_TRIM(clname))
	2331	idx = INDEX(clname,'@startdate@') + INDEX(clname,'@STARTDATE@')
	2332	END DO
[9019]	2333	!
[4148]	2334	idx = INDEX(clname,'@startdatefull@') + INDEX(clname,'@STARTDATEFULL@')
	2335	DO WHILE ( idx /= 0 )
[6140]	2336	cldate = iom_sdate( fjulday - rdt / rday, ldfull = .TRUE. )
[4148]	2337	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+15:LEN_TRIM(clname))
	2338	idx = INDEX(clname,'@startdatefull@') + INDEX(clname,'@STARTDATEFULL@')
	2339	END DO
[9019]	2340	!
[4148]	2341	idx = INDEX(clname,'@enddate@') + INDEX(clname,'@ENDDATE@')
	2342	DO WHILE ( idx /= 0 )
[6140]	2343	cldate = iom_sdate( fjulday + rdt / rday * REAL( nitend - nit000, wp ), ld24 = .TRUE. )
[4148]	2344	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+9:LEN_TRIM(clname))
	2345	idx = INDEX(clname,'@enddate@') + INDEX(clname,'@ENDDATE@')
	2346	END DO
[9019]	2347	!
[4148]	2348	idx = INDEX(clname,'@enddatefull@') + INDEX(clname,'@ENDDATEFULL@')
	2349	DO WHILE ( idx /= 0 )
[6140]	2350	cldate = iom_sdate( fjulday + rdt / rday * REAL( nitend - nit000, wp ), ld24 = .TRUE., ldfull = .TRUE. )
[4148]	2351	clname = clname(1:idx-1)//TRIM(cldate)//clname(idx+13:LEN_TRIM(clname))
	2352	idx = INDEX(clname,'@enddatefull@') + INDEX(clname,'@ENDDATEFULL@')
	2353	END DO
[9019]	2354	!
[11554]	2355	!FUS IF( jn == 1 .AND. TRIM(Agrif_CFixed()) /= '0' ) clname = TRIM(Agrif_CFixed())//"_"//TRIM(clname)
	2356	!FUS see comment line 700
	2357	IF( jn == 1 .AND. TRIM(Agrif_CFixed()) /= '0' ) THEN
	2358	iln = INDEX(clname,'/',BACK=.true.)
	2359	cltmpn = clname(1:iln)
	2360	clname = clname(iln+1:LEN_TRIM(clname))
	2361	clname = TRIM(cltmpn)//TRIM(Agrif_CFixed())//'_'//TRIM(clname)
	2362	ENDIF
	2363	!FUS
[4148]	2364	IF( jn == 1 ) CALL iom_set_file_attr( cdid, name = clname )
	2365	IF( jn == 2 ) CALL iom_set_file_attr( cdid, name_suffix = clname )
[9019]	2366	!
[4148]	2367	ENDIF
[9019]	2368	!
[4148]	2369	END DO
[9019]	2370	!
[4148]	2371	END SUBROUTINE iom_update_file_name
	2372
	2373
	2374	FUNCTION iom_sdate( pjday, ld24, ldfull )
	2375	!!----------------------------------------------------------------------
	2376	!! * ROUTINE iom_sdate *
	2377	!!
	2378	!! ** Purpose : send back the date corresponding to the given julian day
	2379	!!----------------------------------------------------------------------
[9019]	2380	REAL(wp), INTENT(in ) :: pjday ! julian day
	2381	LOGICAL , INTENT(in ), OPTIONAL :: ld24 ! true to force 24:00 instead of 00:00
	2382	LOGICAL , INTENT(in ), OPTIONAL :: ldfull ! true to get the compleate date: yyyymmdd_hh:mm:ss
[4148]	2383	!
	2384	CHARACTER(LEN=20) :: iom_sdate
	2385	CHARACTER(LEN=50) :: clfmt ! format used to write the date
	2386	INTEGER :: iyear, imonth, iday, ihour, iminute, isec
	2387	REAL(wp) :: zsec
	2388	LOGICAL :: ll24, llfull
[9019]	2389	!!----------------------------------------------------------------------
[4148]	2390	!
	2391	IF( PRESENT(ld24) ) THEN ; ll24 = ld24
	2392	ELSE ; ll24 = .FALSE.
	2393	ENDIF
[9019]	2394	!
[4148]	2395	IF( PRESENT(ldfull) ) THEN ; llfull = ldfull
	2396	ELSE ; llfull = .FALSE.
	2397	ENDIF
[9019]	2398	!
[4148]	2399	CALL ju2ymds( pjday, iyear, imonth, iday, zsec )
	2400	isec = NINT(zsec)
[9019]	2401	!
[4148]	2402	IF ( ll24 .AND. isec == 0 ) THEN ! 00:00 of the next day -> move to 24:00 of the current day
	2403	CALL ju2ymds( pjday - 1., iyear, imonth, iday, zsec )
	2404	isec = 86400
	2405	ENDIF
[9019]	2406	!
[4148]	2407	IF( iyear < 10000 ) THEN ; clfmt = "i4.4,2i2.2" ! format used to write the date
	2408	ELSE ; WRITE(clfmt, "('i',i1,',2i2.2')") INT(LOG10(REAL(iyear,wp))) + 1
	2409	ENDIF
[9019]	2410	!
[5656]	2411	!$AGRIF_DO_NOT_TREAT
[9019]	2412	! needed in the conv
[4148]	2413	IF( llfull ) THEN
	2414	clfmt = TRIM(clfmt)//",'_',i2.2,':',i2.2,':',i2.2"
	2415	ihour = isec / 3600
	2416	isec = MOD(isec, 3600)
	2417	iminute = isec / 60
	2418	isec = MOD(isec, 60)
	2419	WRITE(iom_sdate, '('//TRIM(clfmt)//')') iyear, imonth, iday, ihour, iminute, isec ! date of the end of run
	2420	ELSE
	2421	WRITE(iom_sdate, '('//TRIM(clfmt)//')') iyear, imonth, iday ! date of the end of run
	2422	ENDIF
[5656]	2423	!$AGRIF_END_DO_NOT_TREAT
[9019]	2424	!
[4148]	2425	END FUNCTION iom_sdate
	2426
[1359]	2427	#else
[9019]	2428	!!----------------------------------------------------------------------
	2429	!! NOT 'key_iomput' a few dummy routines
	2430	!!----------------------------------------------------------------------
[4152]	2431	SUBROUTINE iom_setkt( kt, cdname )
	2432	INTEGER , INTENT(in):: kt
	2433	CHARACTER(LEN=*), INTENT(in) :: cdname
	2434	IF( .FALSE. ) WRITE(numout,*) kt, cdname ! useless test to avoid compilation warnings
[1359]	2435	END SUBROUTINE iom_setkt
	2436
[4152]	2437	SUBROUTINE iom_context_finalize( cdname )
	2438	CHARACTER(LEN=*), INTENT(in) :: cdname
	2439	IF( .FALSE. ) WRITE(numout,*) cdname ! useless test to avoid compilation warnings
	2440	END SUBROUTINE iom_context_finalize
	2441
[1359]	2442	#endif
[4689]	2443
	2444	LOGICAL FUNCTION iom_use( cdname )
	2445	CHARACTER(LEN=*), INTENT(in) :: cdname
	2446	#if defined key_iomput
	2447	iom_use = xios_field_is_active( cdname )
	2448	#else
	2449	iom_use = .FALSE.
	2450	#endif
	2451	END FUNCTION iom_use
[11536]	2452
	2453	SUBROUTINE iom_miss_val( cdname, pmiss_val )
	2454	CHARACTER(LEN=*), INTENT(in ) :: cdname
	2455	REAL(wp) , INTENT(out) :: pmiss_val
	2456	#if defined key_iomput
	2457	! get missing value
	2458	CALL xios_get_field_attr( cdname, default_value = pmiss_val )
	2459	#else
	2460	IF( .FALSE. ) WRITE(numout,*) cdname, pmiss_val ! useless test to avoid compilation warnings
	2461	#endif
	2462	END SUBROUTINE iom_miss_val
	2463
[544]	2464	!!======================================================================
	2465	END MODULE iom

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

Download in other formats: