Context Navigation

nemogcm.F90 @ 8637

Last change on this file since 8637 was 8586, checked in by gm, 7 years ago
#1911 (ENHANCE-09): PART I.3 - phasing with branch dev_r8183_ICEMODEL revision 8575
Property svn:keywords set to `Id`
File size: 40.2 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	!!======================================================================
[1593]	6	!! History : OPA ! 1990-10 (C. Levy, G. Madec) Original code
	7	!! 7.0 ! 1991-11 (M. Imbard, C. Levy, G. Madec)
[3764]	8	!! 7.1 ! 1993-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
	9	!! P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1
[1593]	10	!! - ! 1992-06 (L.Terray) coupling implementation
[3764]	11	!! - ! 1993-11 (M.A. Filiberti) IGLOO sea-ice
	12	!! 8.0 ! 1996-03 (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
[2104]	13	!! P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0
[1593]	14	!! 8.1 ! 1997-06 (M. Imbard, G. Madec)
[3764]	15	!! 8.2 ! 1999-11 (M. Imbard, H. Goosse) LIM sea-ice model
	16	!! ! 1999-12 (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols) OPEN-MP
[1593]	17	!! ! 2000-07 (J-M Molines, M. Imbard) Open Boundary Conditions (CLIPPER)
	18	!! NEMO 1.0 ! 2002-08 (G. Madec) F90: Free form and modules
	19	!! - ! 2004-06 (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces
	20	!! - ! 2004-08 (C. Talandier) New trends organization
	21	!! - ! 2005-06 (C. Ethe) Add the 1D configuration possibility
	22	!! - ! 2005-11 (V. Garnier) Surface pressure gradient organization
	23	!! - ! 2006-03 (L. Debreu, C. Mazauric) Agrif implementation
	24	!! - ! 2006-04 (G. Madec, R. Benshila) Step reorganization
	25	!! - ! 2007-07 (J. Chanut, A. Sellar) Unstructured open boundaries (BDY)
	26	!! 3.2 ! 2009-08 (S. Masson) open/write in the listing file in mpp
[3764]	27	!! 3.3 ! 2010-05 (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
[2236]	28	!! - ! 2010-10 (C. Ethe, G. Madec) reorganisation of initialisation phase
[3294]	29	!! 3.3.1! 2011-01 (A. R. Porter, STFC Daresbury) dynamical allocation
[5836]	30	!! 3.4 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE) add nemo_northcomms
	31	!! - ! 2011-11 (C. Harris) decomposition changes for running with CICE
	32	!! 3.6 ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
	33	!! - ! 2013-06 (I. Epicoco, S. Mocavero, CMCC) nemo_northcomms: setup avoiding MPI communication
	34	!! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla)
[7646]	35	!! 4.0 ! 2016-10 (G. Madec, S. Flavoni) domain configuration / user defined interface
[1593]	36	!!----------------------------------------------------------------------
[3]	37
	38	!!----------------------------------------------------------------------
[6140]	39	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
	40	!! nemo_init : initialization of the NEMO system
	41	!! nemo_ctl : initialisation of the contol print
	42	!! nemo_closefile: close remaining open files
	43	!! nemo_alloc : dynamical allocation
	44	!! nemo_partition: calculate MPP domain decomposition
	45	!! factorise : calculate the factors of the no. of MPI processes
[3]	46	!!----------------------------------------------------------------------
[6140]	47	USE step_oce ! module used in the ocean time stepping module (step.F90)
[7646]	48	USE phycst ! physical constant (par_cst routine)
	49	USE domain ! domain initialization (dom_init & dom_cfg routines)
	50	USE usrdef_nam ! user defined configuration
[6140]	51	USE tideini ! tidal components initialization (tide_ini routine)
[8586]	52	USE bdy_oce, ONLY : ln_bdy
[6140]	53	USE bdyini ! open boundary cond. setting (bdy_init routine)
	54	USE istate ! initial state setting (istate_init routine)
	55	USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine)
	56	USE ldftra ! lateral diffusivity setting (ldftra_init routine)
	57	USE trdini ! dyn/tra trends initialization (trd_init routine)
	58	USE asminc ! assimilation increments
	59	USE asmbkg ! writing out state trajectory
	60	USE diaptr ! poleward transports (dia_ptr_init routine)
	61	USE diadct ! sections transports (dia_dct_init routine)
	62	USE diaobs ! Observation diagnostics (dia_obs_init routine)
	63	USE diacfl ! CFL diagnostics (dia_cfl_init routine)
	64	USE step ! NEMO time-stepping (stp routine)
	65	USE icbini ! handle bergs, initialisation
	66	USE icbstp ! handle bergs, calving, themodynamics and transport
	67	USE cpl_oasis3 ! OASIS3 coupling
	68	USE c1d ! 1D configuration
	69	USE step_c1d ! Time stepping loop for the 1D configuration
	70	USE dyndmp ! Momentum damping
	71	USE stopar ! Stochastic param.: ???
	72	USE stopts ! Stochastic param.: ???
[7646]	73	USE diurnal_bulk ! diurnal bulk SST
	74	USE step_diu ! diurnal bulk SST timestepping (called from here if run offline)
	75	USE crsini ! initialise grid coarsening utility
	76	USE diatmb ! Top,middle,bottom output
	77	USE dia25h ! 25h mean output
	78	USE sbc_oce , ONLY : lk_oasis
	79	USE wet_dry ! Wetting and drying setting (wad_init routine)
[1594]	80	#if defined key_top
[6140]	81	USE trcini ! passive tracer initialisation
[1594]	82	#endif
[7646]	83	#if defined key_nemocice_decomp
	84	USE ice_domain_size, only: nx_global, ny_global
	85	#endif
	86	!
[6140]	87	USE lib_mpp ! distributed memory computing
[7646]	88	USE mppini ! shared/distributed memory setting (mpp_init routine)
	89	USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
	90	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
[1412]	91	#if defined key_iomput
[6140]	92	USE xios ! xIOserver
[1359]	93	#endif
[268]	94
[2715]	95	IMPLICIT NONE
[3]	96	PRIVATE
	97
[2496]	98	PUBLIC nemo_gcm ! called by model.F90
	99	PUBLIC nemo_init ! needed by AGRIF
[3764]	100	PUBLIC nemo_alloc ! needed by TAM
[467]	101
[2498]	102	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
[1593]	103
[3]	104	!!----------------------------------------------------------------------
[7646]	105	!! NEMO/OPA 3.7 , NEMO Consortium (2016)
[2392]	106	!! $Id$
[2329]	107	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
[3]	108	!!----------------------------------------------------------------------
	109	CONTAINS
	110
[2496]	111	SUBROUTINE nemo_gcm
[3]	112	!!----------------------------------------------------------------------
[2496]	113	!! * ROUTINE nemo_gcm *
[3]	114	!!
[3764]	115	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
[1593]	116	!! curvilinear mesh on the sphere.
[3]	117	!!
	118	!! ** Method : - model general initialization
	119	!! - launch the time-stepping (stp routine)
[1593]	120	!! - finalize the run by closing files and communications
[3]	121	!!
[2715]	122	!! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL.
[1593]	123	!! Madec, 2008, internal report, IPSL.
[3]	124	!!----------------------------------------------------------------------
[7646]	125	INTEGER :: istp ! time step index
[389]	126	!!----------------------------------------------------------------------
[2382]	127	!
[392]	128	#if defined key_agrif
[1593]	129	CALL Agrif_Init_Grids() ! AGRIF: set the meshes
[389]	130	#endif
[7646]	131	!
[1593]	132	! !-----------------------!
[2496]	133	CALL nemo_init !== Initialisations ==!
[1593]	134	! !-----------------------!
[2715]	135	#if defined key_agrif
[3680]	136	CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM
	137	CALL Agrif_Declare_Var ! " " " " " DYN/TRA
[2715]	138	# if defined key_top
[3680]	139	CALL Agrif_Declare_Var_top ! " " " " " TOP
[2715]	140	# endif
[7646]	141	# if defined key_lim3
	142	CALL Agrif_Declare_Var_lim3 ! " " " " " LIM3
	143	# endif
[2715]	144	#endif
[682]	145	! check that all process are still there... If some process have an error,
	146	! they will never enter in step and other processes will wait until the end of the cpu time!
[900]	147	IF( lk_mpp ) CALL mpp_max( nstop )
[682]	148
[1593]	149	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
	150
	151	! !-----------------------!
	152	! !== time stepping ==!
	153	! !-----------------------!
[900]	154	istp = nit000
[2236]	155	#if defined key_c1d
[389]	156	DO WHILE ( istp <= nitend .AND. nstop == 0 )
[900]	157	CALL stp_c1d( istp )
[389]	158	istp = istp + 1
	159	END DO
[2236]	160	#else
	161	IF( lk_asminc ) THEN
	162	IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields
	163	IF( ln_asmdin ) THEN ! Direct initialization
	164	IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers
[3764]	165	IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics
[2236]	166	IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH
	167	ENDIF
	168	ENDIF
[3764]	169
[5656]	170	#if defined key_agrif
	171	CALL Agrif_Regrid()
	172	#endif
	173
[389]	174	DO WHILE ( istp <= nitend .AND. nstop == 0 )
[392]	175	#if defined key_agrif
[5656]	176	CALL stp ! AGRIF: time stepping
[389]	177	#else
[6140]	178	IF ( .NOT. ln_diurnal_only ) THEN
	179	CALL stp( istp ) ! standard time stepping
	180	ELSE
	181	CALL stp_diurnal( istp ) ! time step only the diurnal SST
	182	ENDIF
[389]	183	#endif
	184	istp = istp + 1
[900]	185	IF( lk_mpp ) CALL mpp_max( nstop )
[389]	186	END DO
[2236]	187	#endif
	188
[6140]	189	IF( ln_diaobs ) CALL dia_obs_wri
[3609]	190	!
	191	IF( ln_icebergs ) CALL icb_end( nitend )
[3764]	192
[1593]	193	! !------------------------!
	194	! !== finalize the run ==!
	195	! !------------------------!
[7646]	196	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
[1593]	197	!
[7646]	198	IF( nstop /= 0 .AND. lwp ) THEN ! error print
[682]	199	WRITE(numout,cform_err)
[3764]	200	WRITE(numout,*) nstop, ' error have been found'
[389]	201	ENDIF
[1593]	202	!
[3294]	203	#if defined key_agrif
[6140]	204	IF( .NOT. Agrif_Root() ) THEN
[8568]	205	CALL Agrif_ParentGrid_To_ChildGrid()
	206	IF( ln_diaobs ) CALL dia_obs_wri
	207	IF( ln_timing ) CALL timing_finalize
	208	CALL Agrif_ChildGrid_To_ParentGrid()
[5536]	209	ENDIF
[3294]	210	#endif
[8568]	211	IF( ln_timing ) CALL timing_finalize
[3294]	212	!
[2496]	213	CALL nemo_closefile
[4990]	214	!
[3769]	215	#if defined key_iomput
[7646]	216	CALL xios_finalize ! end mpp communications with xios
	217	IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS
[532]	218	#else
[5407]	219	IF( lk_oasis ) THEN
[7646]	220	CALL cpl_finalize ! end coupling and mpp communications with OASIS
[4990]	221	ELSE
[7646]	222	IF( lk_mpp ) CALL mppstop ! end mpp communications
[4990]	223	ENDIF
[532]	224	#endif
[900]	225	!
[2496]	226	END SUBROUTINE nemo_gcm
[389]	227
	228
[2496]	229	SUBROUTINE nemo_init
[389]	230	!!----------------------------------------------------------------------
[2496]	231	!! * ROUTINE nemo_init *
[389]	232	!!
[2496]	233	!! ** Purpose : initialization of the NEMO GCM
[389]	234	!!----------------------------------------------------------------------
[7646]	235	INTEGER :: ji ! dummy loop indices
	236	INTEGER :: ios, ilocal_comm ! local integer
	237	CHARACTER(len=120), DIMENSION(30) :: cltxt, cltxt2, clnam
[4990]	238	!
[7646]	239	NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, &
	240	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
[8568]	241	& ln_timing, ln_diacfl
[7646]	242	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_write_cfg, cn_domcfg_out, ln_use_jattr
[3]	243	!!----------------------------------------------------------------------
[1593]	244	!
[7646]	245	cltxt = ''
	246	cltxt2 = ''
	247	clnam = ''
[5407]	248	cxios_context = 'nemo'
[2496]	249	!
[4147]	250	! ! Open reference namelist and configuration namelist files
	251	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
	252	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
[1593]	253	!
[7646]	254	REWIND( numnam_ref ) ! Namelist namctl in reference namelist : Control prints
[4147]	255	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
[4289]	256	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
[7646]	257	!
	258	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist
[4147]	259	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
[4289]	260	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
[1593]	261	!
[7646]	262	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist : Control prints
[4147]	263	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
[4289]	264	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
[4147]	265
	266	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist : Control prints & Benchmark
	267	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
[4289]	268	904 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
[4309]	269
[7646]	270	! !--------------------------!
	271	! ! Set global domain size ! (control print return in cltxt2)
	272	! !--------------------------!
	273	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
	274	CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	275	!
	276	ELSE ! user-defined namelist
	277	CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
	278	ENDIF
	279	!
	280	jpk = jpkglo
	281	!
[4147]	282	#if defined key_agrif
[7646]	283	IF( .NOT. Agrif_Root() ) THEN ! AGRIF children: specific setting (cf. agrif_user.F90)
	284	jpiglo = nbcellsx + 2 + 2*nbghostcells
	285	jpjglo = nbcellsy + 2 + 2*nbghostcells
	286	jpi = ( jpiglo-2jpreci + (jpni-1+0) ) / jpni + 2jpreci
	287	jpj = ( jpjglo-2jprecj + (jpnj-1+0) ) / jpnj + 2jprecj
	288	nperio = 0
	289	jperio = 0
	290	ln_use_jattr = .false.
	291	ENDIF
[4147]	292	#endif
	293	!
[1593]	294	! !--------------------------------------------!
	295	! ! set communicator & select the local node !
[4624]	296	! ! NB: mynode also opens output.namelist.dyn !
	297	! ! on unit number numond on first proc !
[1593]	298	! !--------------------------------------------!
[1412]	299	#if defined key_iomput
[2200]	300	IF( Agrif_Root() ) THEN
[5407]	301	IF( lk_oasis ) THEN
[7646]	302	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
	303	CALL xios_initialize( "not used" ,local_comm= ilocal_comm ) ! send nemo communicator to xios
[4990]	304	ELSE
[7646]	305	CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios
[4990]	306	ENDIF
[2200]	307	ENDIF
[5407]	308	! Nodes selection (control print return in cltxt)
	309	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[532]	310	#else
[5407]	311	IF( lk_oasis ) THEN
[4990]	312	IF( Agrif_Root() ) THEN
[7646]	313	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
[4990]	314	ENDIF
[5407]	315	! Nodes selection (control print return in cltxt)
	316	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
[4990]	317	ELSE
[7646]	318	ilocal_comm = 0 ! Nodes selection (control print return in cltxt)
[5407]	319	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
[2236]	320	ENDIF
[532]	321	#endif
[7646]	322
[2715]	323	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
[3]	324
[4624]	325	lwm = (narea == 1) ! control of output namelists
[2715]	326	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
[1579]	327
[7646]	328	IF(lwm) THEN ! write merged namelists from earlier to output namelist
	329	! ! now that the file has been opened in call to mynode.
	330	! ! NB: nammpp has already been written in mynode (if lk_mpp_mpi)
[4624]	331	WRITE( numond, namctl )
	332	WRITE( numond, namcfg )
[7646]	333	IF( .NOT.ln_read_cfg ) THEN
	334	DO ji = 1, SIZE(clnam)
	335	IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print
	336	END DO
	337	ENDIF
[4624]	338	ENDIF
	339
[3764]	340	! If dimensions of processor grid weren't specified in the namelist file
[2715]	341	! then we calculate them here now that we have our communicator size
[5836]	342	IF( jpni < 1 .OR. jpnj < 1 ) THEN
[2715]	343	#if defined key_mpp_mpi
[5836]	344	IF( Agrif_Root() ) CALL nemo_partition( mppsize )
[2715]	345	#else
	346	jpni = 1
	347	jpnj = 1
	348	jpnij = jpni*jpnj
	349	#endif
[5836]	350	ENDIF
[2715]	351
[7646]	352	IF( Agrif_Root() ) THEN ! AGRIF mother: specific setting from jpni and jpnj
[3294]	353	#if defined key_nemocice_decomp
[5836]	354	jpi = ( nx_global+2-2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
	355	jpj = ( ny_global+2-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
[3294]	356	#else
[5836]	357	jpi = ( jpiglo -2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
	358	jpj = ( jpjglo -2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
[3294]	359	#endif
[7646]	360	ENDIF
	361
	362	!!gm ??? why here it has already been done in line 301 !
	363	jpk = jpkglo ! third dim
	364	!!gm end
	365
[5656]	366	#if defined key_agrif
[7646]	367	! simple trick to use same vertical grid as parent but different number of levels:
	368	! Save maximum number of levels in jpkglo, then define all vertical grids with this number.
	369	! Suppress once vertical online interpolation is ok
	370	IF(.NOT.Agrif_Root()) jpkglo = Agrif_Parent( jpkglo )
[5656]	371	#endif
[7646]	372	jpim1 = jpi-1 ! inner domain indices
	373	jpjm1 = jpj-1 ! " "
[7761]	374	jpkm1 = MAX( 1, jpk-1 ) ! " "
[7646]	375	jpij = jpi*jpj ! jpi x j
[2715]	376
[1593]	377	IF(lwp) THEN ! open listing units
	378	!
[1581]	379	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
[1593]	380	!
[1579]	381	WRITE(numout,*)
[3294]	382	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
[1593]	383	WRITE(numout,*) ' NEMO team'
[1579]	384	WRITE(numout,*) ' Ocean General Circulation Model'
[7646]	385	WRITE(numout,*) ' NEMO version 3.7 (2016) '
[1579]	386	WRITE(numout,*)
	387	WRITE(numout,*)
[3764]	388	DO ji = 1, SIZE(cltxt)
[7646]	389	IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode
[1579]	390	END DO
[7646]	391	WRITE(numout,*)
	392	WRITE(numout,*)
	393	DO ji = 1, SIZE(cltxt2)
	394	IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) cltxt2(ji) ! control print of domain size
	395	END DO
[1593]	396	!
[7646]	397	WRITE(numout,cform_aaa) ! Flag AAAAAAA
	398	!
[473]	399	ENDIF
[2715]	400
[7646]	401	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
[2715]	402	CALL nemo_alloc()
	403
[2496]	404	! !-------------------------------!
	405	! ! NEMO general initialization !
	406	! !-------------------------------!
[473]	407
[7646]	408	CALL nemo_ctl ! Control prints
[531]	409
[2082]	410	! ! Domain decomposition
[1593]	411	IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out
	412	ELSE ; CALL mpp_init2 ! eliminate land processors
[3]	413	ENDIF
[2382]	414	!
[8568]	415	IF( ln_timing ) CALL timing_init
[3294]	416	!
[2082]	417	! ! General initialization
[8568]	418	CALL phy_cst ! Physical constants
	419	CALL eos_init ! Equation of state
	420	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
	421	CALL wad_init ! Wetting and drying options
	422	CALL dom_init ! Domain
	423	IF( ln_crs ) CALL crs_init ! coarsened grid: domain initialization
	424	IF( ln_nnogather ) CALL nemo_northcomms! northfold neighbour lists (must be done after the masks are defined)
	425	IF( ln_ctl ) CALL prt_ctl_init ! Print control
[6140]	426
[8215]	427	CALL diurnal_sst_bulk_init ! diurnal sst
[6140]	428	IF ( ln_diurnal ) CALL diurnal_sst_coolskin_init ! cool skin
	429
	430	! IF ln_diurnal_only, then we only want a subset of the initialisation routines
[8568]	431	IF( ln_diurnal_only ) THEN
[6140]	432	CALL istate_init ! ocean initial state (Dynamics and tracers)
	433	CALL sbc_init ! Forcings : surface module
	434	CALL tra_qsr_init ! penetrative solar radiation qsr
[8568]	435	IF( ln_diaobs ) THEN ! Observation & model comparison
	436	CALL dia_obs_init ! Initialize observational data
	437	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
[6140]	438	ENDIF
	439	! ! Assimilation increments
[8568]	440	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
[6140]	441
	442	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
	443	RETURN
	444	ENDIF
	445
[8568]	446	CALL istate_init ! ocean initial state (Dynamics and tracers)
[3651]	447
[5836]	448	! ! external forcing
	449	!!gm to be added : creation and call of sbc_apr_init
[8568]	450	CALL tide_init ! tidal harmonics
	451	CALL sbc_init ! surface boundary conditions (including sea-ice)
	452	CALL bdy_init ! Open boundaries initialisation
[8215]	453
[5836]	454	! ! Ocean physics
[8568]	455	CALL zdf_phy_init ! Vertical physics
[8215]	456
[2082]	457	! ! Lateral physics
[8568]	458	CALL ldf_tra_init ! Lateral ocean tracer physics
	459	CALL ldf_eiv_init ! eddy induced velocity param.
	460	CALL ldf_dyn_init ! Lateral ocean momentum physics
[2082]	461
[8215]	462	! ! Active tracers
[8568]	463	CALL tra_qsr_init ! penetrative solar radiation qsr
	464	CALL tra_bbc_init ! bottom heat flux
	465	IF( ln_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
	466	CALL tra_dmp_init ! internal tracer damping
	467	CALL tra_adv_init ! horizontal & vertical advection
	468	CALL tra_ldf_init ! lateral mixing
[2027]	469
[8215]	470	! ! Dynamics
[8568]	471	IF( lk_c1d ) CALL dyn_dmp_init ! internal momentum damping
	472	CALL dyn_adv_init ! advection (vector or flux form)
	473	CALL dyn_vor_init ! vorticity term including Coriolis
	474	CALL dyn_ldf_init ! lateral mixing
	475	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
	476	CALL dyn_spg_init ! surface pressure gradient
[3764]	477
[5836]	478	#if defined key_top
	479	! ! Passive tracers
[8568]	480	CALL trc_init
[5836]	481	#endif
[8568]	482	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
[5836]	483
	484	! ! Icebergs
[8568]	485	CALL icb_init( rdt, nit000) ! initialise icebergs instance
[5836]	486
	487	! ! Misc. options
[8568]	488	CALL sto_par_init ! Stochastic parametrization
	489	IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations
[4147]	490
[5836]	491	! ! Diagnostics
[8568]	492	IF( lk_floats ) CALL flo_init ! drifting Floats
	493	IF( ln_diacfl ) CALL dia_cfl_init ! Initialise CFL diagnostics
	494	CALL dia_ptr_init ! Poleward TRansports initialization
	495	IF( lk_diadct ) CALL dia_dct_init ! Sections tranports
	496	CALL dia_hsb_init ! heat content, salt content and volume budgets
	497	CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends
	498	CALL dia_obs_init ! Initialize observational data
	499	IF( ln_diaobs ) CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
[6140]	500
[8215]	501	! ! Assimilation increments
[8568]	502	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
[2382]	503	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
[8568]	504	CALL dia_tmb_init ! TMB outputs
	505	CALL dia_25h_init ! 25h mean outputs
[1593]	506	!
[2496]	507	END SUBROUTINE nemo_init
[467]	508
	509
[2496]	510	SUBROUTINE nemo_ctl
[467]	511	!!----------------------------------------------------------------------
[2496]	512	!! * ROUTINE nemo_ctl *
[467]	513	!!
[3764]	514	!! ** Purpose : control print setting
[467]	515	!!
[2442]	516	!! ** Method : - print namctl information and check some consistencies
[467]	517	!!----------------------------------------------------------------------
[2442]	518	!
[2496]	519	IF(lwp) THEN ! control print
[531]	520	WRITE(numout,*)
[7646]	521	WRITE(numout,*) 'nemo_ctl: Control prints'
[531]	522	WRITE(numout,*) '~~~~~~~ '
[1593]	523	WRITE(numout,*) ' Namelist namctl'
[1601]	524	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
	525	WRITE(numout,*) ' level of print nn_print = ', nn_print
	526	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
	527	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
	528	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
	529	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
	530	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
	531	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
[8568]	532	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
	533	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
[531]	534	ENDIF
[2442]	535	!
[1601]	536	nprint = nn_print ! convert DOCTOR namelist names into OLD names
	537	nictls = nn_ictls
	538	nictle = nn_ictle
	539	njctls = nn_jctls
	540	njctle = nn_jctle
	541	isplt = nn_isplt
	542	jsplt = nn_jsplt
[8568]	543	!!gm to be remove at the end of the 2017 merge party
	544	if( ln_timing ) then ; nn_timing = 1
	545	else ; nn_timing = 0
	546	endif
	547	!!gm end
	548
[4147]	549
	550	IF(lwp) THEN ! control print
	551	WRITE(numout,*)
[7646]	552	WRITE(numout,*) 'namcfg : configuration initialization through namelist read'
	553	WRITE(numout,*) '~~~~~~ '
[4147]	554	WRITE(numout,*) ' Namelist namcfg'
[7646]	555	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
	556	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
	557	WRITE(numout,*) ' write configuration definition file ln_write_cfg = ', ln_write_cfg
	558	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
	559	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
[4147]	560	ENDIF
[2442]	561	! ! Parameter control
[1593]	562	!
	563	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
[3294]	564	IF( lk_mpp .AND. jpnij > 1 ) THEN
[2496]	565	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
[531]	566	ELSE
	567	IF( isplt == 1 .AND. jsplt == 1 ) THEN
[1593]	568	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
	569	& ' - the print control will be done over the whole domain' )
[531]	570	ENDIF
[1593]	571	ijsplt = isplt * jsplt ! total number of processors ijsplt
[531]	572	ENDIF
	573	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
	574	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
[1593]	575	!
	576	! ! indices used for the SUM control
	577	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
[3764]	578	lsp_area = .FALSE.
[1593]	579	ELSE ! print control done over a specific area
[531]	580	lsp_area = .TRUE.
	581	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
	582	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
	583	nictls = 1
	584	ENDIF
	585	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
	586	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
	587	nictle = jpiglo
	588	ENDIF
	589	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
	590	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
	591	njctls = 1
	592	ENDIF
	593	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
	594	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
	595	njctle = jpjglo
	596	ENDIF
[1593]	597	ENDIF
	598	ENDIF
[2442]	599	!
[3764]	600	IF( 1_wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ', &
	601	& 'f2003 standard. ' , &
	602	& 'Compile with key_nosignedzero enabled' )
	603	!
[2496]	604	END SUBROUTINE nemo_ctl
[467]	605
	606
[2496]	607	SUBROUTINE nemo_closefile
[467]	608	!!----------------------------------------------------------------------
[2496]	609	!! * ROUTINE nemo_closefile *
[467]	610	!!
	611	!! ** Purpose : Close the files
	612	!!----------------------------------------------------------------------
[1593]	613	!
	614	IF( lk_mpp ) CALL mppsync
	615	!
[1685]	616	CALL iom_close ! close all input/output files managed by iom_*
[1593]	617	!
[4147]	618	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
[8215]	619	IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file
[4147]	620	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
	621	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
[4624]	622	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
[4147]	623	IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist
	624	IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist
[4624]	625	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
[4147]	626	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
	627	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
	628	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
	629	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
	630	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
[1593]	631	!
[2442]	632	numout = 6 ! redefine numout in case it is used after this point...
	633	!
[2496]	634	END SUBROUTINE nemo_closefile
[467]	635
[2715]	636
	637	SUBROUTINE nemo_alloc
	638	!!----------------------------------------------------------------------
	639	!! * ROUTINE nemo_alloc *
	640	!!
	641	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
	642	!!
	643	!! ** Method :
	644	!!----------------------------------------------------------------------
	645	USE diawri , ONLY: dia_wri_alloc
	646	USE dom_oce , ONLY: dom_oce_alloc
	647	USE trc_oce , ONLY: trc_oce_alloc
[3680]	648	#if defined key_diadct
	649	USE diadct , ONLY: diadct_alloc
	650	#endif
[4354]	651	USE bdy_oce , ONLY: bdy_oce_alloc
[2715]	652	!
	653	INTEGER :: ierr
	654	!!----------------------------------------------------------------------
	655	!
[7646]	656	ierr = oce_alloc () ! ocean
[2715]	657	ierr = ierr + dia_wri_alloc ()
	658	ierr = ierr + dom_oce_alloc () ! ocean domain
	659	ierr = ierr + zdf_oce_alloc () ! ocean vertical physics
	660	!
	661	ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays
	662	!
[3680]	663	#if defined key_diadct
	664	ierr = ierr + diadct_alloc () !
	665	#endif
[4354]	666	ierr = ierr + bdy_oce_alloc () ! bdy masks (incl. initialization)
[3680]	667	!
[2715]	668	IF( lk_mpp ) CALL mpp_sum( ierr )
	669	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
	670	!
	671	END SUBROUTINE nemo_alloc
	672
	673
	674	SUBROUTINE nemo_partition( num_pes )
	675	!!----------------------------------------------------------------------
	676	!! * ROUTINE nemo_partition *
	677	!!
[3764]	678	!! ** Purpose :
[2715]	679	!!
	680	!! ** Method :
	681	!!----------------------------------------------------------------------
[4990]	682	INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
[2715]	683	!
	684	INTEGER, PARAMETER :: nfactmax = 20
	685	INTEGER :: nfact ! The no. of factors returned
	686	INTEGER :: ierr ! Error flag
	687	INTEGER :: ji
	688	INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
	689	INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
	690	!!----------------------------------------------------------------------
[4990]	691	!
[2715]	692	ierr = 0
[4990]	693	!
[2715]	694	CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
[4990]	695	!
[2715]	696	IF( nfact <= 1 ) THEN
	697	WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
	698	WRITE (numout, *) ' : using grid of ',num_pes,' x 1'
	699	jpnj = 1
	700	jpni = num_pes
	701	ELSE
	702	! Search through factors for the pair that are closest in value
	703	mindiff = 1000000
	704	imin = 1
	705	DO ji = 1, nfact-1, 2
	706	idiff = ABS( ifact(ji) - ifact(ji+1) )
	707	IF( idiff < mindiff ) THEN
	708	mindiff = idiff
	709	imin = ji
	710	ENDIF
	711	END DO
	712	jpnj = ifact(imin)
	713	jpni = ifact(imin + 1)
	714	ENDIF
	715	!
	716	jpnij = jpni*jpnj
	717	!
	718	END SUBROUTINE nemo_partition
	719
	720
	721	SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
	722	!!----------------------------------------------------------------------
	723	!! * ROUTINE factorise *
	724	!!
	725	!! ** Purpose : return the prime factors of n.
[3764]	726	!! knfax factors are returned in array kfax which is of
[2715]	727	!! maximum dimension kmaxfax.
	728	!! ** Method :
	729	!!----------------------------------------------------------------------
	730	INTEGER , INTENT(in ) :: kn, kmaxfax
	731	INTEGER , INTENT( out) :: kerr, knfax
	732	INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax
	733	!
	734	INTEGER :: ifac, jl, inu
	735	INTEGER, PARAMETER :: ntest = 14
[5836]	736	INTEGER, DIMENSION(ntest) :: ilfax
[5656]	737	!!----------------------------------------------------------------------
[5836]	738	!
[2715]	739	! lfax contains the set of allowed factors.
[5656]	740	ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
[5836]	741	!
[2715]	742	! Clear the error flag and initialise output vars
[5836]	743	kerr = 0
	744	kfax = 1
[2715]	745	knfax = 0
[5836]	746	!
[2715]	747	! Find the factors of n.
	748	IF( kn == 1 ) GOTO 20
	749
	750	! nu holds the unfactorised part of the number.
	751	! knfax holds the number of factors found.
	752	! l points to the allowed factor list.
	753	! ifac holds the current factor.
[5836]	754	!
[2715]	755	inu = kn
	756	knfax = 0
[5836]	757	!
[2715]	758	DO jl = ntest, 1, -1
	759	!
	760	ifac = ilfax(jl)
	761	IF( ifac > inu ) CYCLE
	762
	763	! Test whether the factor will divide.
	764
	765	IF( MOD(inu,ifac) == 0 ) THEN
	766	!
	767	knfax = knfax + 1 ! Add the factor to the list
	768	IF( knfax > kmaxfax ) THEN
	769	kerr = 6
	770	write (,) 'FACTOR: insufficient space in factor array ', knfax
	771	return
	772	ENDIF
	773	kfax(knfax) = ifac
	774	! Store the other factor that goes with this one
	775	knfax = knfax + 1
	776	kfax(knfax) = inu / ifac
	777	!WRITE (,) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
	778	ENDIF
	779	!
	780	END DO
[5836]	781	!
[2715]	782	20 CONTINUE ! Label 20 is the exit point from the factor search loop.
	783	!
	784	END SUBROUTINE factorise
	785
[3294]	786	#if defined key_mpp_mpi
[4990]	787
[3294]	788	SUBROUTINE nemo_northcomms
[5836]	789	!!----------------------------------------------------------------------
[3294]	790	!! * ROUTINE nemo_northcomms *
[5836]	791	!! ** Purpose : Setup for north fold exchanges with explicit
	792	!! point-to-point messaging
[3764]	793	!!
[5836]	794	!! ** Method : Initialization of the northern neighbours lists.
[3294]	795	!!----------------------------------------------------------------------
[3764]	796	!! 1.0 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE)
[4230]	797	!! 2.0 ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
[3294]	798	!!----------------------------------------------------------------------
[4230]	799	INTEGER :: sxM, dxM, sxT, dxT, jn
	800	INTEGER :: njmppmax
[5836]	801	!!----------------------------------------------------------------------
	802	!
[4230]	803	njmppmax = MAXVAL( njmppt )
[5836]	804	!
[4230]	805	!initializes the north-fold communication variables
	806	isendto(:) = 0
[5836]	807	nsndto = 0
	808	!
[4230]	809	!if I am a process in the north
	810	IF ( njmpp == njmppmax ) THEN
	811	!sxM is the first point (in the global domain) needed to compute the
	812	!north-fold for the current process
	813	sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
	814	!dxM is the last point (in the global domain) needed to compute the
	815	!north-fold for the current process
	816	dxM = jpiglo - nimppt(narea) + 2
[3294]	817
[4230]	818	!loop over the other north-fold processes to find the processes
	819	!managing the points belonging to the sxT-dxT range
[4671]	820
	821	DO jn = 1, jpni
[4230]	822	!sxT is the first point (in the global domain) of the jn
	823	!process
[4671]	824	sxT = nfiimpp(jn, jpnj)
[4230]	825	!dxT is the last point (in the global domain) of the jn
	826	!process
[4671]	827	dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
[4230]	828	IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
	829	nsndto = nsndto + 1
[7646]	830	isendto(nsndto) = jn
[4645]	831	ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
[4230]	832	nsndto = nsndto + 1
[7646]	833	isendto(nsndto) = jn
[4230]	834	ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
	835	nsndto = nsndto + 1
[7646]	836	isendto(nsndto) = jn
	837	ENDIF
[4230]	838	END DO
[4671]	839	nfsloop = 1
	840	nfeloop = nlci
	841	DO jn = 2,jpni-1
	842	IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
	843	IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
	844	nfsloop = nldi
	845	ENDIF
	846	IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
	847	nfeloop = nlei
	848	ENDIF
	849	ENDIF
	850	END DO
	851
[3294]	852	ENDIF
[4230]	853	l_north_nogather = .TRUE.
[3294]	854	END SUBROUTINE nemo_northcomms
[5836]	855
[3294]	856	#else
	857	SUBROUTINE nemo_northcomms ! Dummy routine
	858	WRITE(,) 'nemo_northcomms: You should not have seen this print! error?'
	859	END SUBROUTINE nemo_northcomms
	860	#endif
[4990]	861
[3]	862	!!======================================================================
[2496]	863	END MODULE nemogcm
[4354]	864

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

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

Context Navigation

source: branches/2017/dev_r7881_ENHANCE09_RK3/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 8637

Download in other formats: