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 branches/2017/dev_merge_2017/NEMOGCM/NEMO/OPA_SRC – NEMO

Context Navigation

source: branches/2017/dev_merge_2017/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 9210

Last change on this file since 9210 was 9210, checked in by gm, 6 years ago
dev_merge_2017: merge a 4th mpp_max (stop, see WP2017/HPC03) cleaning in nemo_gcm routine
Property svn:keywords set to `Id`
File size: 41.1 KB

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

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

Download in other formats: