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

Context Navigation

source: branches/2012/dev_NOC_MERCATOR_2012/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3651

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

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

Download in other formats: