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

Context Navigation

source: branches/2013/dev_MERCATOR_UKMO_2013/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 9088

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

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

Download in other formats: