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/2015/dev_r5056_CMCC4_simplification/NEMOGCM/NEMO/OPA_SRC – NEMO

Context Navigation

source: branches/2015/dev_r5056_CMCC4_simplification/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 5282

Last change on this file since 5282 was 5282, checked in by diovino, 9 years ago
Dev. branch CMCC4_simplification ticket #1456
Property svn:keywords set to `Id`
File size: 38.5 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-11 (C. Harris) decomposition changes for running with CICE
31	!! ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
32	!!----------------------------------------------------------------------
33
34	!!----------------------------------------------------------------------
35	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
36	!! nemo_init : initialization of the NEMO system
37	!! nemo_ctl : initialisation of the contol print
38	!! nemo_closefile : close remaining open files
39	!! nemo_alloc : dynamical allocation
40	!! nemo_partition : calculate MPP domain decomposition
41	!! factorise : calculate the factors of the no. of MPI processes
42	!!----------------------------------------------------------------------
43	USE step_oce ! module used in the ocean time stepping module
44	USE domcfg ! domain configuration (dom_cfg routine)
45	USE mppini ! shared/distributed memory setting (mpp_init routine)
46	USE domain ! domain initialization (dom_init routine)
47	#if defined key_nemocice_decomp
48	USE ice_domain_size, only: nx_global, ny_global
49	#endif
50	USE tideini ! tidal components initialization (tide_ini routine)
51	USE bdyini ! open boundary cond. setting (bdy_init routine)
52	USE bdydta ! open boundary cond. setting (bdy_dta_init routine)
53	USE bdytides ! open boundary cond. setting (bdytide_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 zdfini ! vertical physics setting (zdf_init routine)
58	USE phycst ! physical constant (par_cst routine)
59	USE trdini ! dyn/tra trends initialization (trd_init routine)
60	USE asminc ! assimilation increments
61	USE asmbkg ! writing out state trajectory
62	USE diaptr ! poleward transports (dia_ptr_init routine)
63	USE diadct ! sections transports (dia_dct_init routine)
64	USE diaobs ! Observation diagnostics (dia_obs_init routine)
65	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
66	USE step ! NEMO time-stepping (stp routine)
67	USE icbini ! handle bergs, initialisation
68	USE icbstp ! handle bergs, calving, themodynamics and transport
69	USE cpl_oasis3 ! OASIS3 coupling
70	USE c1d ! 1D configuration
71	USE step_c1d ! Time stepping loop for the 1D configuration
72	USE dyndmp ! Momentum damping
73	#if defined key_top
74	USE trcini ! passive tracer initialisation
75	#endif
76	USE lib_mpp ! distributed memory computing
77	#if defined key_iomput
78	USE xios
79	#endif
80	USE sbctide, ONLY: lk_tide
81	USE crsini ! initialise grid coarsening utility
82	USE lbcnfd, ONLY: isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
83
84	IMPLICIT NONE
85	PRIVATE
86
87	PUBLIC nemo_gcm ! called by model.F90
88	PUBLIC nemo_init ! needed by AGRIF
89	PUBLIC nemo_alloc ! needed by TAM
90
91	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
92
93	!!----------------------------------------------------------------------
94	!! NEMO/OPA 4.0 , NEMO Consortium (2011)
95	!! $Id$
96	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
97	!!----------------------------------------------------------------------
98	CONTAINS
99
100	SUBROUTINE nemo_gcm
101	!!----------------------------------------------------------------------
102	!! * ROUTINE nemo_gcm *
103	!!
104	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
105	!! curvilinear mesh on the sphere.
106	!!
107	!! ** Method : - model general initialization
108	!! - launch the time-stepping (stp routine)
109	!! - finalize the run by closing files and communications
110	!!
111	!! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL.
112	!! Madec, 2008, internal report, IPSL.
113	!!----------------------------------------------------------------------
114	INTEGER :: istp ! time step index
115	!!----------------------------------------------------------------------
116	!
117	#if defined key_agrif
118	CALL Agrif_Init_Grids() ! AGRIF: set the meshes
119	#endif
120
121	! !-----------------------!
122	CALL nemo_init !== Initialisations ==!
123	! !-----------------------!
124	#if defined key_agrif
125	CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM
126	CALL Agrif_Declare_Var ! " " " " " DYN/TRA
127	# if defined key_top
128	CALL Agrif_Declare_Var_top ! " " " " " TOP
129	# endif
130	# if defined key_lim2
131	CALL Agrif_Declare_Var_lim2 ! " " " " " LIM
132	# endif
133	#endif
134	! check that all process are still there... If some process have an error,
135	! they will never enter in step and other processes will wait until the end of the cpu time!
136	IF( lk_mpp ) CALL mpp_max( nstop )
137
138	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
139
140	! !-----------------------!
141	! !== time stepping ==!
142	! !-----------------------!
143	istp = nit000
144	#if defined key_c1d
145	DO WHILE ( istp <= nitend .AND. nstop == 0 )
146	CALL stp_c1d( istp )
147	istp = istp + 1
148	END DO
149	#else
150	IF( lk_asminc ) THEN
151	IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields
152	IF( ln_asmdin ) THEN ! Direct initialization
153	IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers
154	IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics
155	IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH
156	ENDIF
157	ENDIF
158
159	DO WHILE ( istp <= nitend .AND. nstop == 0 )
160	#if defined key_agrif
161	CALL Agrif_Step( stp ) ! AGRIF: time stepping
162	#else
163	CALL stp( istp ) ! standard time stepping
164	#endif
165	istp = istp + 1
166	IF( lk_mpp ) CALL mpp_max( nstop )
167	END DO
168	#endif
169
170	IF( lk_diaobs ) CALL dia_obs_wri
171	!
172	IF( ln_icebergs ) CALL icb_end( nitend )
173
174	! !------------------------!
175	! !== finalize the run ==!
176	! !------------------------!
177	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
178	!
179	IF( nstop /= 0 .AND. lwp ) THEN ! error print
180	WRITE(numout,cform_err)
181	WRITE(numout,*) nstop, ' error have been found'
182	ENDIF
183	!
184	#if defined key_agrif
185	CALL Agrif_ParentGrid_To_ChildGrid()
186	IF( lk_diaobs ) CALL dia_obs_wri
187	IF( nn_timing == 1 ) CALL timing_finalize
188	CALL Agrif_ChildGrid_To_ParentGrid()
189	#endif
190	IF( nn_timing == 1 ) CALL timing_finalize
191	!
192	CALL nemo_closefile
193	!
194	#if defined key_iomput
195	CALL xios_finalize ! end mpp communications with xios
196	IF( lk_cpl ) CALL cpl_finalize ! end coupling and mpp communications with OASIS
197	#else
198	IF( lk_cpl ) THEN
199	CALL cpl_finalize ! end coupling and mpp communications with OASIS
200	ELSE
201	IF( lk_mpp ) CALL mppstop ! end mpp communications
202	ENDIF
203	#endif
204	!
205	END SUBROUTINE nemo_gcm
206
207
208	SUBROUTINE nemo_init
209	!!----------------------------------------------------------------------
210	!! * ROUTINE nemo_init *
211	!!
212	!! ** Purpose : initialization of the NEMO GCM
213	!!----------------------------------------------------------------------
214	INTEGER :: ji ! dummy loop indices
215	INTEGER :: ilocal_comm ! local integer
216	INTEGER :: ios
217	CHARACTER(len=80), DIMENSION(16) :: cltxt
218	!
219	NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, &
220	& nn_isplt, nn_jsplt, nn_jctls, nn_jctle, &
221	& nn_bench, nn_timing
222	NAMELIST/namcfg/ cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, &
223	& jpizoom, jpjzoom, jperio
224	!!----------------------------------------------------------------------
225	!
226	cltxt = ''
227	!
228	! ! Open reference namelist and configuration namelist files
229	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
230	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
231	!
232	REWIND( numnam_ref ) ! Namelist namctl in reference namelist : Control prints & Benchmark
233	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
234	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
235
236	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist : Control prints & Benchmark
237	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
238	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
239
240	!
241	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist : Control prints & Benchmark
242	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
243	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
244
245	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist : Control prints & Benchmark
246	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
247	904 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
248
249	! Force values for AGRIF zoom (cf. agrif_user.F90)
250	#if defined key_agrif
251	IF( .NOT. Agrif_Root() ) THEN
252	jpiglo = nbcellsx + 2 + 2*nbghostcells
253	jpjglo = nbcellsy + 2 + 2*nbghostcells
254	jpi = ( jpiglo-2jpreci + (jpni-1+0) ) / jpni + 2jpreci
255	jpj = ( jpjglo-2jprecj + (jpnj-1+0) ) / jpnj + 2jprecj
256	jpidta = jpiglo
257	jpjdta = jpjglo
258	jpizoom = 1
259	jpjzoom = 1
260	nperio = 0
261	jperio = 0
262	ENDIF
263	#endif
264	!
265	! !--------------------------------------------!
266	! ! set communicator & select the local node !
267	! ! NB: mynode also opens output.namelist.dyn !
268	! ! on unit number numond on first proc !
269	! !--------------------------------------------!
270	#if defined key_iomput
271	IF( Agrif_Root() ) THEN
272	IF( lk_cpl ) THEN
273	CALL cpl_init( ilocal_comm ) ! nemo local communicator given by oasis
274	CALL xios_initialize( "oceanx",local_comm=ilocal_comm ) ! send nemo communicator to xios
275	ELSE
276	CALL xios_initialize( "nemo",return_comm=ilocal_comm ) ! nemo local communicator given by xios
277	ENDIF
278	ENDIF
279	narea = mynode( cltxt, numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) ! Nodes selection
280	#else
281	IF( lk_cpl ) THEN
282	IF( Agrif_Root() ) THEN
283	CALL cpl_init( ilocal_comm ) ! nemo local communicator given by oasis
284	ENDIF
285	narea = mynode( cltxt, numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) ! Nodes selection (control print return in cltxt)
286	ELSE
287	ilocal_comm = 0
288	narea = mynode( cltxt, numnam_ref, numnam_cfg, numond , nstop ) ! Nodes selection (control print return in cltxt)
289	ENDIF
290	#endif
291	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
292
293	lwm = (narea == 1) ! control of output namelists
294	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
295
296	IF(lwm) THEN
297	! write merged namelists from earlier to output namelist now that the
298	! file has been opened in call to mynode. nammpp has already been
299	! written in mynode (if lk_mpp_mpi)
300	WRITE( numond, namctl )
301	WRITE( numond, namcfg )
302	ENDIF
303
304	! If dimensions of processor grid weren't specified in the namelist file
305	! then we calculate them here now that we have our communicator size
306	IF( (jpni < 1) .OR. (jpnj < 1) )THEN
307	#if defined key_mpp_mpi
308	IF( Agrif_Root() ) CALL nemo_partition(mppsize)
309	#else
310	jpni = 1
311	jpnj = 1
312	jpnij = jpni*jpnj
313	#endif
314	END IF
315
316	! Calculate domain dimensions given calculated jpni and jpnj
317	! This used to be done in par_oce.F90 when they were parameters rather
318	! than variables
319	IF( Agrif_Root() ) THEN
320	#if defined key_nemocice_decomp
321	jpi = ( nx_global+2-2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
322	jpj = ( ny_global+2-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
323	#else
324	jpi = ( jpiglo-2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
325	jpj = ( jpjglo-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
326	#endif
327	ENDIF
328	jpk = jpkdta ! third dim
329	jpim1 = jpi-1 ! inner domain indices
330	jpjm1 = jpj-1 ! " "
331	jpkm1 = jpk-1 ! " "
332	jpij = jpi*jpj ! jpi x j
333
334	IF(lwp) THEN ! open listing units
335	!
336	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
337	!
338	WRITE(numout,*)
339	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
340	WRITE(numout,*) ' NEMO team'
341	WRITE(numout,*) ' Ocean General Circulation Model'
342	WRITE(numout,*) ' version 3.4 (2011) '
343	WRITE(numout,*)
344	WRITE(numout,*)
345	DO ji = 1, SIZE(cltxt)
346	IF( TRIM(cltxt(ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode
347	END DO
348	WRITE(numout,cform_aaa) ! Flag AAAAAAA
349	!
350	ENDIF
351
352	! Now we know the dimensions of the grid and numout has been set we can
353	! allocate arrays
354	CALL nemo_alloc()
355
356	! !-------------------------------!
357	! ! NEMO general initialization !
358	! !-------------------------------!
359
360	CALL nemo_ctl ! Control prints & Benchmark
361
362	! ! Domain decomposition
363	IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out
364	ELSE ; CALL mpp_init2 ! eliminate land processors
365	ENDIF
366	!
367	IF( nn_timing == 1 ) CALL timing_init
368	!
369	! ! General initialization
370	CALL phy_cst ! Physical constants
371	CALL eos_init ! Equation of state
372	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
373	CALL dom_cfg ! Domain configuration
374	CALL dom_init ! Domain
375
376	IF( ln_nnogather ) CALL nemo_northcomms ! Initialise the northfold neighbour lists (must be done after the masks are defined)
377
378	IF( ln_ctl ) CALL prt_ctl_init ! Print control
379
380	CALL istate_init ! ocean initial state (Dynamics and tracers)
381
382	IF( lk_tide ) CALL tide_init( nit000 ) ! Initialisation of the tidal harmonics
383
384	IF( lk_bdy ) CALL bdy_init ! Open boundaries initialisation
385	IF( lk_bdy ) CALL bdy_dta_init ! Open boundaries initialisation of external data arrays
386	IF( lk_bdy .AND. lk_tide ) &
387	& CALL bdytide_init ! Open boundaries initialisation of tidal harmonic forcing
388
389
390	!
391	IF( ln_crs ) CALL crs_init ! Domain initialization of coarsened grid
392	!
393	! Ocean physics
394	CALL sbc_init ! Forcings : surface module
395	! ! Vertical physics
396	CALL zdf_init ! namelist read
397	CALL zdf_bfr_init ! bottom friction
398	IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz
399	IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme
400	IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme
401	IF( lk_zdfkpp ) CALL zdf_kpp_init ! KPP closure scheme
402	IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing
403	IF( lk_zdfddm .AND. .NOT. lk_zdfkpp ) &
404	& CALL zdf_ddm_init ! double diffusive mixing
405	! ! Lateral physics
406	CALL ldf_tra_init ! Lateral ocean tracer physics
407	CALL ldf_dyn_init ! Lateral ocean momentum physics
408	IF( lk_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
409
410	! ! Active tracers
411	CALL tra_qsr_init ! penetrative solar radiation qsr
412	CALL tra_bbc_init ! bottom heat flux
413	IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
414	CALL tra_dmp_init ! internal damping trends- tracers
415	CALL tra_adv_init ! horizontal & vertical advection
416	CALL tra_ldf_init ! lateral mixing
417	CALL tra_zdf_init ! vertical mixing and after tracer fields
418
419	! ! Dynamics
420	IF( lk_c1d ) CALL dyn_dmp_init ! internal damping trends- momentum
421	CALL dyn_adv_init ! advection (vector or flux form)
422	CALL dyn_vor_init ! vorticity term including Coriolis
423	CALL dyn_ldf_init ! lateral mixing
424	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
425	CALL dyn_zdf_init ! vertical diffusion
426	CALL dyn_spg_init ! surface pressure gradient
427
428	! ! Misc. options
429	CALL icb_init( rdt, nit000) ! initialise icebergs instance
430
431	#if defined key_top
432	! ! Passive tracers
433	CALL trc_init
434	#endif
435	! ! Diagnostics
436	IF( lk_floats ) CALL flo_init ! drifting Floats
437	IF( lk_diaar5 ) CALL dia_ar5_init ! ar5 diag
438	CALL dia_ptr_init ! Poleward TRansports initialization
439	IF( lk_diadct ) CALL dia_dct_init ! Sections tranports
440	CALL dia_hsb_init ! heat content, salt content and volume budgets
441	CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends
442	IF( lk_diaobs ) THEN ! Observation & model comparison
443	CALL dia_obs_init ! Initialize observational data
444	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
445	ENDIF
446
447	! ! Assimilation increments
448	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
449	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
450	!
451	END SUBROUTINE nemo_init
452
453
454	SUBROUTINE nemo_ctl
455	!!----------------------------------------------------------------------
456	!! * ROUTINE nemo_ctl *
457	!!
458	!! ** Purpose : control print setting
459	!!
460	!! ** Method : - print namctl information and check some consistencies
461	!!----------------------------------------------------------------------
462	!
463	IF(lwp) THEN ! control print
464	WRITE(numout,*)
465	WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
466	WRITE(numout,*) '~~~~~~~ '
467	WRITE(numout,*) ' Namelist namctl'
468	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
469	WRITE(numout,*) ' level of print nn_print = ', nn_print
470	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
471	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
472	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
473	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
474	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
475	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
476	WRITE(numout,*) ' benchmark parameter (0/1) nn_bench = ', nn_bench
477	WRITE(numout,*) ' timing activated (0/1) nn_timing = ', nn_timing
478	ENDIF
479	!
480	nprint = nn_print ! convert DOCTOR namelist names into OLD names
481	nictls = nn_ictls
482	nictle = nn_ictle
483	njctls = nn_jctls
484	njctle = nn_jctle
485	isplt = nn_isplt
486	jsplt = nn_jsplt
487	nbench = nn_bench
488
489	IF(lwp) THEN ! control print
490	WRITE(numout,*)
491	WRITE(numout,*) 'namcfg : configuration initialization through namelist read'
492	WRITE(numout,*) '~~~~~~~ '
493	WRITE(numout,*) ' Namelist namcfg'
494	WRITE(numout,*) ' configuration name cp_cfg = ', TRIM(cp_cfg)
495	WRITE(numout,*) ' configuration zoom name cp_cfz = ', TRIM(cp_cfz)
496	WRITE(numout,*) ' configuration resolution jp_cfg = ', jp_cfg
497	WRITE(numout,*) ' 1st lateral dimension ( >= jpi ) jpidta = ', jpidta
498	WRITE(numout,*) ' 2nd " " ( >= jpj ) jpjdta = ', jpjdta
499	WRITE(numout,*) ' 3nd " " jpkdta = ', jpkdta
500	WRITE(numout,*) ' 1st dimension of global domain in i jpiglo = ', jpiglo
501	WRITE(numout,*) ' 2nd - - in j jpjglo = ', jpjglo
502	WRITE(numout,*) ' left bottom i index of the zoom (in data domain) jpizoom = ', jpizoom
503	WRITE(numout,*) ' left bottom j index of the zoom (in data domain) jpizoom = ', jpjzoom
504	WRITE(numout,*) ' lateral cond. type (between 0 and 6) jperio = ', jperio
505	ENDIF
506	! ! Parameter control
507	!
508	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
509	IF( lk_mpp .AND. jpnij > 1 ) THEN
510	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
511	ELSE
512	IF( isplt == 1 .AND. jsplt == 1 ) THEN
513	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
514	& ' - the print control will be done over the whole domain' )
515	ENDIF
516	ijsplt = isplt * jsplt ! total number of processors ijsplt
517	ENDIF
518	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
519	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
520	!
521	! ! indices used for the SUM control
522	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
523	lsp_area = .FALSE.
524	ELSE ! print control done over a specific area
525	lsp_area = .TRUE.
526	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
527	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
528	nictls = 1
529	ENDIF
530	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
531	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
532	nictle = jpiglo
533	ENDIF
534	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
535	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
536	njctls = 1
537	ENDIF
538	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
539	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
540	njctle = jpjglo
541	ENDIF
542	ENDIF
543	ENDIF
544	!
545	IF( nbench == 1 ) THEN ! Benchmark
546	SELECT CASE ( cp_cfg )
547	CASE ( 'gyre' ) ; CALL ctl_warn( ' The Benchmark is activated ' )
548	CASE DEFAULT ; CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:', &
549	& ' cp_cfg = "gyre" in namelist &namcfg or set nbench = 0' )
550	END SELECT
551	ENDIF
552	!
553	IF( 1_wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ', &
554	& 'f2003 standard. ' , &
555	& 'Compile with key_nosignedzero enabled' )
556	!
557	END SUBROUTINE nemo_ctl
558
559
560	SUBROUTINE nemo_closefile
561	!!----------------------------------------------------------------------
562	!! * ROUTINE nemo_closefile *
563	!!
564	!! ** Purpose : Close the files
565	!!----------------------------------------------------------------------
566	!
567	IF( lk_mpp ) CALL mppsync
568	!
569	CALL iom_close ! close all input/output files managed by iom_*
570	!
571	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
572	IF( numsol /= -1 ) CLOSE( numsol ) ! solver file
573	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
574	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
575	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
576	IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist
577	IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist
578	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
579	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
580	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
581	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
582	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
583	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
584
585	!
586	numout = 6 ! redefine numout in case it is used after this point...
587	!
588	END SUBROUTINE nemo_closefile
589
590
591	SUBROUTINE nemo_alloc
592	!!----------------------------------------------------------------------
593	!! * ROUTINE nemo_alloc *
594	!!
595	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
596	!!
597	!! ** Method :
598	!!----------------------------------------------------------------------
599	USE diawri , ONLY: dia_wri_alloc
600	USE dom_oce , ONLY: dom_oce_alloc
601	USE ldfdyn_oce, ONLY: ldfdyn_oce_alloc
602	USE ldftra_oce, ONLY: ldftra_oce_alloc
603	USE trc_oce , ONLY: trc_oce_alloc
604	#if defined key_diadct
605	USE diadct , ONLY: diadct_alloc
606	#endif
607	#if defined key_bdy
608	USE bdy_oce , ONLY: bdy_oce_alloc
609	#endif
610	!
611	INTEGER :: ierr
612	!!----------------------------------------------------------------------
613	!
614	ierr = oce_alloc () ! ocean
615	ierr = ierr + dia_wri_alloc ()
616	ierr = ierr + dom_oce_alloc () ! ocean domain
617	ierr = ierr + ldfdyn_oce_alloc() ! ocean lateral physics : dynamics
618	ierr = ierr + ldftra_oce_alloc() ! ocean lateral physics : tracers
619	ierr = ierr + zdf_oce_alloc () ! ocean vertical physics
620	!
621	ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays
622	!
623	#if defined key_diadct
624	ierr = ierr + diadct_alloc () !
625	#endif
626	#if defined key_bdy
627	ierr = ierr + bdy_oce_alloc () ! bdy masks (incl. initialization)
628	#endif
629	!
630	IF( lk_mpp ) CALL mpp_sum( ierr )
631	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
632	!
633	END SUBROUTINE nemo_alloc
634
635
636	SUBROUTINE nemo_partition( num_pes )
637	!!----------------------------------------------------------------------
638	!! * ROUTINE nemo_partition *
639	!!
640	!! ** Purpose :
641	!!
642	!! ** Method :
643	!!----------------------------------------------------------------------
644	INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
645	!
646	INTEGER, PARAMETER :: nfactmax = 20
647	INTEGER :: nfact ! The no. of factors returned
648	INTEGER :: ierr ! Error flag
649	INTEGER :: ji
650	INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
651	INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
652	!!----------------------------------------------------------------------
653	!
654	ierr = 0
655	!
656	CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
657	!
658	IF( nfact <= 1 ) THEN
659	WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
660	WRITE (numout, *) ' : using grid of ',num_pes,' x 1'
661	jpnj = 1
662	jpni = num_pes
663	ELSE
664	! Search through factors for the pair that are closest in value
665	mindiff = 1000000
666	imin = 1
667	DO ji = 1, nfact-1, 2
668	idiff = ABS( ifact(ji) - ifact(ji+1) )
669	IF( idiff < mindiff ) THEN
670	mindiff = idiff
671	imin = ji
672	ENDIF
673	END DO
674	jpnj = ifact(imin)
675	jpni = ifact(imin + 1)
676	ENDIF
677	!
678	jpnij = jpni*jpnj
679	!
680	END SUBROUTINE nemo_partition
681
682
683	SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
684	!!----------------------------------------------------------------------
685	!! * ROUTINE factorise *
686	!!
687	!! ** Purpose : return the prime factors of n.
688	!! knfax factors are returned in array kfax which is of
689	!! maximum dimension kmaxfax.
690	!! ** Method :
691	!!----------------------------------------------------------------------
692	INTEGER , INTENT(in ) :: kn, kmaxfax
693	INTEGER , INTENT( out) :: kerr, knfax
694	INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax
695	!
696	INTEGER :: ifac, jl, inu
697	INTEGER, PARAMETER :: ntest = 14
698	INTEGER :: ilfax(ntest)
699	!
700	! lfax contains the set of allowed factors.
701	data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256, &
702	& 128, 64, 32, 16, 8, 4, 2 /
703	!!----------------------------------------------------------------------
704
705	! Clear the error flag and initialise output vars
706	kerr = 0
707	kfax = 1
708	knfax = 0
709
710	! Find the factors of n.
711	IF( kn == 1 ) GOTO 20
712
713	! nu holds the unfactorised part of the number.
714	! knfax holds the number of factors found.
715	! l points to the allowed factor list.
716	! ifac holds the current factor.
717
718	inu = kn
719	knfax = 0
720
721	DO jl = ntest, 1, -1
722	!
723	ifac = ilfax(jl)
724	IF( ifac > inu ) CYCLE
725
726	! Test whether the factor will divide.
727
728	IF( MOD(inu,ifac) == 0 ) THEN
729	!
730	knfax = knfax + 1 ! Add the factor to the list
731	IF( knfax > kmaxfax ) THEN
732	kerr = 6
733	write (,) 'FACTOR: insufficient space in factor array ', knfax
734	return
735	ENDIF
736	kfax(knfax) = ifac
737	! Store the other factor that goes with this one
738	knfax = knfax + 1
739	kfax(knfax) = inu / ifac
740	!WRITE (,) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
741	ENDIF
742	!
743	END DO
744
745	20 CONTINUE ! Label 20 is the exit point from the factor search loop.
746	!
747	END SUBROUTINE factorise
748
749	#if defined key_mpp_mpi
750
751	SUBROUTINE nemo_northcomms
752	!!======================================================================
753	!! * ROUTINE nemo_northcomms *
754	!! nemo_northcomms : Setup for north fold exchanges with explicit
755	!! point-to-point messaging
756	!!=====================================================================
757	!!----------------------------------------------------------------------
758	!!
759	!! ** Purpose : Initialization of the northern neighbours lists.
760	!!----------------------------------------------------------------------
761	!! 1.0 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE)
762	!! 2.0 ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
763	!!----------------------------------------------------------------------
764
765	INTEGER :: sxM, dxM, sxT, dxT, jn
766	INTEGER :: njmppmax
767
768	njmppmax = MAXVAL( njmppt )
769
770	!initializes the north-fold communication variables
771	isendto(:) = 0
772	nsndto = 0
773
774	!if I am a process in the north
775	IF ( njmpp == njmppmax ) THEN
776	!sxM is the first point (in the global domain) needed to compute the
777	!north-fold for the current process
778	sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
779	!dxM is the last point (in the global domain) needed to compute the
780	!north-fold for the current process
781	dxM = jpiglo - nimppt(narea) + 2
782
783	!loop over the other north-fold processes to find the processes
784	!managing the points belonging to the sxT-dxT range
785
786	DO jn = 1, jpni
787	!sxT is the first point (in the global domain) of the jn
788	!process
789	sxT = nfiimpp(jn, jpnj)
790	!dxT is the last point (in the global domain) of the jn
791	!process
792	dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
793	IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
794	nsndto = nsndto + 1
795	isendto(nsndto) = jn
796	ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
797	nsndto = nsndto + 1
798	isendto(nsndto) = jn
799	ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
800	nsndto = nsndto + 1
801	isendto(nsndto) = jn
802	END IF
803	END DO
804	nfsloop = 1
805	nfeloop = nlci
806	DO jn = 2,jpni-1
807	IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
808	IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
809	nfsloop = nldi
810	ENDIF
811	IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
812	nfeloop = nlei
813	ENDIF
814	ENDIF
815	END DO
816
817	ENDIF
818	l_north_nogather = .TRUE.
819	END SUBROUTINE nemo_northcomms
820	#else
821	SUBROUTINE nemo_northcomms ! Dummy routine
822	WRITE(,) 'nemo_northcomms: You should not have seen this print! error?'
823	END SUBROUTINE nemo_northcomms
824	#endif
825
826	!!======================================================================
827	END MODULE nemogcm
828
829

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

Download in other formats: