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/2013/dev_r3853_CNRS9_ConfSetting/NEMOGCM/NEMO/OPA_SRC – NEMO

Context Navigation

source: branches/2013/dev_r3853_CNRS9_ConfSetting/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3954

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

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

Download in other formats: