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.

nemogcm.F90 in NEMO/branches/2018/dev_r10164_HPC09_ESIWACE_PREP_MERGE/src/SAO – NEMO

Context Navigation

source: NEMO/branches/2018/dev_r10164_HPC09_ESIWACE_PREP_MERGE/src/SAO/nemogcm.F90 @ 10402

Last change on this file since 10402 was 10402, checked in by smasson, 5 years ago
dev_r10164_HPC09_ESIWACE_PREP_MERGE: no more need of lk_mpp for mpp_sum/max/min, see #2133
Property svn:keywords set to `Id`
File size: 18.7 KB

Rev	Line
[2496]	1	MODULE nemogcm
[2442]	2	!!======================================================================
[2496]	3	!! * MODULE nemogcm *
	4	!! Ocean system : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice)
[2442]	5	!!======================================================================
[9598]	6	!! History : 3.6 ! 2015-12 (A. Ryan) Original code (from OCE/)
[7646]	7	!! 4.0 ! 2016-11 (G. Madec, S. Flavoni) domain configuration / user defined interface
[1593]	8	!!----------------------------------------------------------------------
[3]	9
	10	!!----------------------------------------------------------------------
[7646]	11	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
	12	!! nemo_init : initialization of the NEMO system
	13	!! nemo_ctl : initialisation of the contol print
	14	!! nemo_closefile: close remaining open files
	15	!! nemo_alloc : dynamical allocation
[3]	16	!!----------------------------------------------------------------------
[7646]	17	USE step_oce ! module used in the ocean time stepping module (step.F90)
	18	USE domain ! domain initialization (dom_init & dom_cfg routines)
	19	USE istate ! initial state setting (istate_init routine)
	20	USE phycst ! physical constant (par_cst routine)
	21	USE step ! NEMO time-stepping (stp routine)
	22	USE cpl_oasis3 ! OASIS3 coupling
	23	USE diaobs ! Observation diagnostics (dia_obs_init routine)
[3625]	24	#if defined key_nemocice_decomp
	25	USE ice_domain_size, only: nx_global, ny_global
	26	#endif
[7646]	27	! ! Stand Alone Observation operator modules
	28	USE sao_data
	29	USE sao_intp
	30	!
	31	USE lib_mpp ! distributed memory computing
	32	USE mppini ! shared/distributed memory setting (mpp_init routine)
	33	USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
	34	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[1412]	35	#if defined key_iomput
[7646]	36	USE xios ! xIOserver
[1359]	37	#endif
[268]	38
[2715]	39	IMPLICIT NONE
[3]	40	PRIVATE
	41
[4829]	42	PUBLIC nemo_gcm ! called by model.F90
[2496]	43	PUBLIC nemo_init ! needed by AGRIF
[3764]	44	PUBLIC nemo_alloc ! needed by TAM
[467]	45
[2498]	46	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
[1593]	47
[3]	48	!!----------------------------------------------------------------------
[9598]	49	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
[2392]	50	!! $Id$
[10068]	51	!! Software governed by the CeCILL license (see ./LICENSE)
[3]	52	!!----------------------------------------------------------------------
	53	CONTAINS
	54
[4120]	55	SUBROUTINE nemo_gcm
	56	!!----------------------------------------------------------------------
	57	!! * SUBROUTINE offline_obs_oper *
	58	!!
	59	!! ** Purpose : To use NEMO components to interpolate model fields
	60	!! to observation space.
	61	!!
	62	!! ** Method : 1. Initialise NEMO
	63	!! 2. Initialise offline obs_oper
	64	!! 3. Cycle through match ups
	65	!! 4. Write results to file
	66	!!----------------------------------------------------------------------
[7646]	67	!
	68	CALL nemo_init ! Initialise NEMO
	69	!
	70	CALL sao_data_init ! Initialise Stand Alone Observation operator data
	71	!
	72	CALL dia_obs_init ! Initialise obs_operator
	73	!
	74	CALL sao_interp ! Interpolate to observation space
	75	!
	76	CALL dia_obs_wri ! Pipe to output files
	77	!
	78	CALL dia_obs_dealloc ! Reset the obs_oper between
	79	!
	80	IF(lk_mpp) CALL mppstop ! Safely stop MPI (end mpp communications)
	81	!
[4120]	82	END SUBROUTINE nemo_gcm
[389]	83
[4829]	84
[2496]	85	SUBROUTINE nemo_init
[389]	86	!!----------------------------------------------------------------------
[2496]	87	!! * ROUTINE nemo_init *
[389]	88	!!
[2496]	89	!! ** Purpose : initialization of the NEMO GCM
[389]	90	!!----------------------------------------------------------------------
[7646]	91	INTEGER :: ji ! dummy loop indices
	92	INTEGER :: ios, ilocal_comm ! local integer
	93	CHARACTER(len=120), DIMENSION(30) :: cltxt, cltxt2, clnam
[5600]	94	!
[7646]	95	NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, &
	96	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
[9019]	97	& ln_timing, ln_diacfl
[9436]	98	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
[3]	99	!!----------------------------------------------------------------------
[1593]	100	!
[7646]	101	cltxt = ''
	102	cltxt2 = ''
	103	clnam = ''
[5600]	104	cxios_context = 'nemo'
[2496]	105	!
[4290]	106	! ! Open reference namelist and configuration namelist files
	107	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
	108	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[1593]	109	!
[7646]	110	REWIND( numnam_ref ) ! Namelist namctl in reference namelist : Control prints
[4290]	111	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
	112	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
[7646]	113	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist
[4290]	114	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
[9169]	115	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
[1593]	116	!
[7646]	117	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist : Control prints
[4290]	118	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
[9169]	119	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
[4290]	120	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist : Control prints & Benchmark
	121	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
[9169]	122	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
[4290]	123
[7646]	124	! !--------------------------!
	125	! ! Set global domain size ! (control print return in cltxt2)
	126	! !--------------------------!
	127	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
	128	CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	129	!
	130	ELSE ! user-defined namelist
	131	CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	132	ENDIF
	133	!
	134	!
[1593]	135	! !--------------------------------------------!
	136	! ! set communicator & select the local node !
[4624]	137	! ! NB: mynode also opens output.namelist.dyn !
	138	! ! on unit number numond on first proc !
[1593]	139	! !--------------------------------------------!
[1412]	140	#if defined key_iomput
[2200]	141	IF( Agrif_Root() ) THEN
[5600]	142	IF( lk_oasis ) THEN
	143	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
	144	CALL xios_initialize( "not used",local_comm=ilocal_comm ) ! send nemo communicator to xios
	145	ELSE
	146	CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios
	147	ENDIF
[2200]	148	ENDIF
[5600]	149	! Nodes selection (control print return in cltxt)
	150	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[532]	151	#else
[5600]	152	IF( lk_oasis ) THEN
	153	IF( Agrif_Root() ) THEN
	154	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
	155	ENDIF
	156	! Nodes selection (control print return in cltxt)
	157	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
	158	ELSE
[9436]	159	ilocal_comm = 0 ! Nodes selection (control print return in cltxt)
[5600]	160	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
[2236]	161	ENDIF
[532]	162	#endif
[7646]	163
[2715]	164	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
[3]	165
[4624]	166	lwm = (narea == 1) ! control of output namelists
[2715]	167	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
[1579]	168
[4624]	169	IF(lwm) THEN
	170	! write merged namelists from earlier to output namelist now that the
	171	! file has been opened in call to mynode. nammpp has already been
	172	! written in mynode (if lk_mpp_mpi)
	173	WRITE( numond, namctl )
	174	WRITE( numond, namcfg )
[7646]	175	IF( .NOT.ln_read_cfg ) THEN
	176	DO ji = 1, SIZE(clnam)
	177	IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print
	178	END DO
	179	ENDIF
[4624]	180	ENDIF
	181
[1593]	182	IF(lwp) THEN ! open listing units
	183	!
[1581]	184	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
[1593]	185	!
[1579]	186	WRITE(numout,*)
[3294]	187	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
[1593]	188	WRITE(numout,*) ' NEMO team'
[5042]	189	WRITE(numout,*) ' Stand Alone Observation operator'
[9436]	190	WRITE(numout,*) ' NEMO version 4.0 (2017) '
[1579]	191	WRITE(numout,*)
	192	WRITE(numout,*)
[3764]	193	DO ji = 1, SIZE(cltxt)
[7646]	194	IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode
[1579]	195	END DO
[7646]	196	WRITE(numout,*)
	197	WRITE(numout,*)
	198	DO ji = 1, SIZE(cltxt2)
	199	IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) cltxt2(ji) ! control print of domain size
	200	END DO
[1593]	201	!
[7646]	202	WRITE(numout,cform_aaa) ! Flag AAAAAAA
	203	!
[473]	204	ENDIF
[9436]	205	! ! Domain decomposition
	206	CALL mpp_init ! MPP
[2715]	207
[7646]	208	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
[2715]	209	CALL nemo_alloc()
	210
[2496]	211	! !-------------------------------!
	212	! ! NEMO general initialization !
	213	! !-------------------------------!
[473]	214
[9436]	215	CALL nemo_ctl ! Control prints
[2382]	216	!
[9436]	217	! ! General initialization
	218	IF( ln_timing ) CALL timing_init ! timing
	219	IF( ln_timing ) CALL timing_start( 'nemo_init')
[3294]	220	!
[9019]	221	CALL phy_cst ! Physical constants
	222	CALL eos_init ! Equation of state
[9367]	223	CALL dom_init('SAO') ! Domain
[413]	224
[3294]	225
[9019]	226	IF( ln_ctl ) CALL prt_ctl_init ! Print control
[2027]	227
[9019]	228	CALL istate_init ! ocean initial state (Dynamics and tracers)
[2496]	229	END SUBROUTINE nemo_init
[467]	230
	231
[2496]	232	SUBROUTINE nemo_ctl
[467]	233	!!----------------------------------------------------------------------
[2496]	234	!! * ROUTINE nemo_ctl *
[467]	235	!!
[3764]	236	!! ** Purpose : control print setting
[467]	237	!!
[2442]	238	!! ** Method : - print namctl information and check some consistencies
[467]	239	!!----------------------------------------------------------------------
[2442]	240	!
[2496]	241	IF(lwp) THEN ! control print
[531]	242	WRITE(numout,*)
[7646]	243	WRITE(numout,*) 'nemo_ctl: Control prints'
[9436]	244	WRITE(numout,*) '~~~~~~~~'
[1593]	245	WRITE(numout,*) ' Namelist namctl'
[1601]	246	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
	247	WRITE(numout,*) ' level of print nn_print = ', nn_print
	248	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
	249	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
	250	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
	251	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
	252	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
	253	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
[9019]	254	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
	255	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
[531]	256	ENDIF
[2442]	257	!
[1601]	258	nprint = nn_print ! convert DOCTOR namelist names into OLD names
	259	nictls = nn_ictls
	260	nictle = nn_ictle
	261	njctls = nn_jctls
	262	njctle = nn_jctle
	263	isplt = nn_isplt
	264	jsplt = nn_jsplt
[4829]	265
	266	IF(lwp) THEN ! control print
	267	WRITE(numout,*)
	268	WRITE(numout,*) 'namcfg : configuration initialization through namelist read'
	269	WRITE(numout,*) '~~~~~~~ '
	270	WRITE(numout,*) ' Namelist namcfg'
[7646]	271	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
	272	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
[9436]	273	WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea
[7646]	274	WRITE(numout,*) ' write configuration definition file ln_write_cfg = ', ln_write_cfg
	275	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
	276	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
[4829]	277	ENDIF
[9436]	278	IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file
	279	!
[2442]	280	! ! Parameter control
[1593]	281	!
	282	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
[3294]	283	IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]	284	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
[531]	285	ELSE
	286	IF( isplt == 1 .AND. jsplt == 1 ) THEN
[1593]	287	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
	288	& ' - the print control will be done over the whole domain' )
[531]	289	ENDIF
[1593]	290	ijsplt = isplt * jsplt ! total number of processors ijsplt
[531]	291	ENDIF
	292	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
	293	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
[1593]	294	!
	295	! ! indices used for the SUM control
	296	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
[3764]	297	lsp_area = .FALSE.
[1593]	298	ELSE ! print control done over a specific area
[531]	299	lsp_area = .TRUE.
	300	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
	301	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
	302	nictls = 1
	303	ENDIF
	304	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
	305	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
	306	nictle = jpiglo
	307	ENDIF
	308	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
	309	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
	310	njctls = 1
	311	ENDIF
	312	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
	313	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
	314	njctle = jpjglo
	315	ENDIF
[1593]	316	ENDIF
	317	ENDIF
[2442]	318	!
[3764]	319	IF( 1_wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ', &
	320	& 'f2003 standard. ' , &
	321	& 'Compile with key_nosignedzero enabled' )
	322	!
[2496]	323	END SUBROUTINE nemo_ctl
[467]	324
	325
[2496]	326	SUBROUTINE nemo_closefile
[467]	327	!!----------------------------------------------------------------------
[2496]	328	!! * ROUTINE nemo_closefile *
[467]	329	!!
	330	!! ** Purpose : Close the files
	331	!!----------------------------------------------------------------------
[1593]	332	!
	333	IF( lk_mpp ) CALL mppsync
	334	!
[1685]	335	CALL iom_close ! close all input/output files managed by iom_*
[1593]	336	!
[4829]	337	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
[9019]	338	IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file
[4829]	339	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
	340	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
	341	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
	342	IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist
	343	IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist
	344	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
	345	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
	346	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
	347	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
	348	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
	349	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
[1593]	350	!
[2442]	351	numout = 6 ! redefine numout in case it is used after this point...
	352	!
[2496]	353	END SUBROUTINE nemo_closefile
[467]	354
[2715]	355
	356	SUBROUTINE nemo_alloc
	357	!!----------------------------------------------------------------------
	358	!! * ROUTINE nemo_alloc *
	359	!!
	360	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
	361	!!
	362	!! ** Method :
	363	!!----------------------------------------------------------------------
	364	USE diawri , ONLY: dia_wri_alloc
	365	USE dom_oce , ONLY: dom_oce_alloc
	366	!
	367	INTEGER :: ierr
	368	!!----------------------------------------------------------------------
	369	!
[3764]	370	ierr = oce_alloc () ! ocean
[2715]	371	ierr = ierr + dia_wri_alloc ()
	372	ierr = ierr + dom_oce_alloc () ! ocean domain
	373	!
[10402]	374	CALL mpp_sum( 'nemogcm', ierr )
[2715]	375	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
	376	!
	377	END SUBROUTINE nemo_alloc
	378
[3]	379	!!======================================================================
[2496]	380	END MODULE nemogcm
[4829]	381

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

Download in other formats: