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/2014/dev_CNRS1_10_TEOS10_Ediag/NEMOGCM/NEMO/OPA_SRC – NEMO

Context Navigation

source: branches/2014/dev_CNRS1_10_TEOS10_Ediag/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 4915

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

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

Download in other formats: