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

Context Navigation

source: branches/2012/dev_r3327_MERCATOR1_BDY/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3490

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

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

Download in other formats: