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

Context Navigation

source: branches/2011/dev_UKM0_2011/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3291

Last change on this file since 3291 was 3066, checked in by rfurner, 13 years ago
ticket #885 adding changes from branches/2011/dev_r2802_UKMO8_cice between r2802 and r3041
Property svn:keywords set to `Id`
File size: 29.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	USE obcini ! open boundary cond. initialization (obc_ini routine)
49	USE bdyini ! open boundary cond. initialization (bdy_init routine)
50	USE bdydta ! open boundary cond. initialization (bdy_dta_init routine)
51	USE bdytides ! open boundary cond. initialization (tide_init routine)
52	USE istate ! initial state setting (istate_init routine)
53	USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine)
54	USE ldftra ! lateral diffusivity setting (ldftra_init routine)
55	USE zdfini ! vertical physics setting (zdf_init routine)
56	USE phycst ! physical constant (par_cst routine)
57	USE trdmod ! momentum/tracers trends (trd_mod_init routine)
58	USE asminc ! assimilation increments (asm_inc_init routine)
59	USE asmtrj ! writing out state trajectory
60	USE sshwzv ! vertical velocity used in asm
61	USE diaptr ! poleward transports (dia_ptr_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
79	IMPLICIT NONE
80	PRIVATE
81
82	PUBLIC nemo_gcm ! called by model.F90
83	PUBLIC nemo_init ! needed by AGRIF
84
85	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
86
87	!!----------------------------------------------------------------------
88	!! NEMO/OPA 4.0 , NEMO Consortium (2011)
89	!! $Id$
90	!! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt)
91	!!----------------------------------------------------------------------
92	CONTAINS
93
94	SUBROUTINE nemo_gcm
95	!!----------------------------------------------------------------------
96	!! * ROUTINE nemo_gcm *
97	!!
98	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
99	!! curvilinear mesh on the sphere.
100	!!
101	!! ** Method : - model general initialization
102	!! - launch the time-stepping (stp routine)
103	!! - finalize the run by closing files and communications
104	!!
105	!! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL.
106	!! Madec, 2008, internal report, IPSL.
107	!!----------------------------------------------------------------------
108	INTEGER :: istp ! time step index
109	!!----------------------------------------------------------------------
110	!
111	#if defined key_agrif
112	CALL Agrif_Init_Grids() ! AGRIF: set the meshes
113	#endif
114
115	! !-----------------------!
116	CALL nemo_init !== Initialisations ==!
117	! !-----------------------!
118	#if defined key_agrif
119	CALL Agrif_Declare_Var ! AGRIF: set the meshes
120	# if defined key_top
121	CALL Agrif_Declare_Var_Top ! AGRIF: set the meshes
122	# endif
123	#endif
124	! check that all process are still there... If some process have an error,
125	! they will never enter in step and other processes will wait until the end of the cpu time!
126	IF( lk_mpp ) CALL mpp_max( nstop )
127
128	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
129
130	! !-----------------------!
131	! !== time stepping ==!
132	! !-----------------------!
133	istp = nit000
134	#if defined key_c1d
135	DO WHILE ( istp <= nitend .AND. nstop == 0 )
136	CALL stp_c1d( istp )
137	istp = istp + 1
138	END DO
139	#else
140	IF( lk_asminc ) THEN
141	IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields
142	IF( ln_trjwri ) CALL asm_trj_wri( nit000 - 1 ) ! Output trajectory fields
143	IF( ln_asmdin ) THEN ! Direct initialization
144	IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers
145	IF( ln_dyninc ) THEN
146	CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics
147	IF ( ln_asmdin ) CALL ssh_wzv ( nit000 - 1 ) ! update vertical velocity
148	ENDIF
149	IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH
150	ENDIF
151	ENDIF
152
153	DO WHILE ( istp <= nitend .AND. nstop == 0 )
154	#if defined key_agrif
155	CALL Agrif_Step( stp ) ! AGRIF: time stepping
156	#else
157	CALL stp( istp ) ! standard time stepping
158	#endif
159	istp = istp + 1
160	IF( lk_mpp ) CALL mpp_max( nstop )
161	END DO
162	#endif
163
164	IF( lk_diaobs ) CALL dia_obs_wri
165
166	! !------------------------!
167	! !== finalize the run ==!
168	! !------------------------!
169	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
170	!
171	IF( nstop /= 0 .AND. lwp ) THEN ! error print
172	WRITE(numout,cform_err)
173	WRITE(numout,*) nstop, ' error have been found'
174	ENDIF
175	!
176	CALL nemo_closefile
177	#if defined key_oasis3 \|\| defined key_oasis4
178	CALL cpl_prism_finalize ! end coupling and mpp communications with OASIS
179	#else
180	IF( lk_mpp ) CALL mppstop ! end mpp communications
181	#endif
182	!
183	END SUBROUTINE nemo_gcm
184
185
186	SUBROUTINE nemo_init
187	!!----------------------------------------------------------------------
188	!! * ROUTINE nemo_init *
189	!!
190	!! ** Purpose : initialization of the NEMO GCM
191	!!----------------------------------------------------------------------
192	INTEGER :: ji ! dummy loop indices
193	INTEGER :: ilocal_comm ! local integer
194	CHARACTER(len=80), DIMENSION(16) :: cltxt
195	!!
196	NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, &
197	& nn_isplt, nn_jsplt, nn_jctls, nn_jctle, nn_bench
198	!!----------------------------------------------------------------------
199	!
200	cltxt = ''
201	!
202	! ! open Namelist file
203	CALL ctl_opn( numnam, 'namelist', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
204	!
205	READ( numnam, namctl ) ! Namelist namctl : Control prints & Benchmark
206	!
207	! !--------------------------------------------!
208	! ! set communicator & select the local node !
209	! !--------------------------------------------!
210	#if defined key_iomput
211	IF( Agrif_Root() ) THEN
212	# if defined key_oasis3 \|\| defined key_oasis4
213	CALL cpl_prism_init( ilocal_comm ) ! nemo local communicator given by oasis
214	# endif
215	CALL init_ioclient( ilocal_comm ) ! exchange io_server nemo local communicator with the io_server
216	ENDIF
217	narea = mynode( cltxt, numnam, nstop, ilocal_comm ) ! Nodes selection
218	#else
219	# if defined key_oasis3 \|\| defined key_oasis4
220	IF( Agrif_Root() ) THEN
221	CALL cpl_prism_init( ilocal_comm ) ! nemo local communicator given by oasis
222	ENDIF
223	narea = mynode( cltxt, numnam, nstop, ilocal_comm ) ! Nodes selection (control print return in cltxt)
224	# else
225	ilocal_comm = 0
226	narea = mynode( cltxt, numnam, nstop ) ! Nodes selection (control print return in cltxt)
227	# endif
228	#endif
229	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
230
231	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
232
233	! If dimensions of processor grid weren't specified in the namelist file
234	! then we calculate them here now that we have our communicator size
235	IF( (jpni < 1) .OR. (jpnj < 1) )THEN
236	#if defined key_mpp_mpi
237	IF( Agrif_Root() ) CALL nemo_partition(mppsize)
238	#else
239	jpni = 1
240	jpnj = 1
241	jpnij = jpni*jpnj
242	#endif
243	END IF
244
245	! Calculate domain dimensions given calculated jpni and jpnj
246	! This used to be done in par_oce.F90 when they were parameters rather
247	! than variables
248	IF( Agrif_Root() ) THEN
249	jpi = ( jpiglo-2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
250	#if defined key_nemocice_decomp
251	jpj = ( jpjglo+1-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
252	#else
253	jpj = ( jpjglo-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
254	#endif
255	jpk = jpkdta ! third dim
256	jpim1 = jpi-1 ! inner domain indices
257	jpjm1 = jpj-1 ! " "
258	jpkm1 = jpk-1 ! " "
259	jpij = jpi*jpj ! jpi x j
260	ENDIF
261
262	IF(lwp) THEN ! open listing units
263	!
264	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
265	!
266	WRITE(numout,*)
267	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean'
268	WRITE(numout,*) ' NEMO team'
269	WRITE(numout,*) ' Ocean General Circulation Model'
270	WRITE(numout,*) ' version 3.3 (2010) '
271	WRITE(numout,*)
272	WRITE(numout,*)
273	DO ji = 1, SIZE(cltxt)
274	IF( TRIM(cltxt(ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode
275	END DO
276	WRITE(numout,cform_aaa) ! Flag AAAAAAA
277	!
278	ENDIF
279
280	! Now we know the dimensions of the grid and numout has been set we can
281	! allocate arrays
282	CALL nemo_alloc()
283
284	! !-------------------------------!
285	! ! NEMO general initialization !
286	! !-------------------------------!
287
288	CALL nemo_ctl ! Control prints & Benchmark
289
290	! ! Domain decomposition
291	IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out
292	ELSE ; CALL mpp_init2 ! eliminate land processors
293	ENDIF
294	!
295	! ! General initialization
296	CALL phy_cst ! Physical constants
297	CALL eos_init ! Equation of state
298	CALL dom_cfg ! Domain configuration
299	CALL dom_init ! Domain
300
301	IF( ln_ctl ) CALL prt_ctl_init ! Print control
302
303	IF( lk_obc ) CALL obc_init ! Open boundaries
304	IF( lk_bdy ) CALL bdy_init ! Open boundaries initialisation
305	IF( lk_bdy ) CALL bdy_dta_init ! Open boundaries initialisation of external data arrays
306	IF( lk_bdy ) CALL tide_init ! Open boundaries initialisation of tidal harmonic forcing
307
308	CALL istate_init ! ocean initial state (Dynamics and tracers)
309
310	! ! Ocean physics
311	CALL sbc_init ! Forcings : surface module
312	! ! Vertical physics
313	CALL zdf_init ! namelist read
314	CALL zdf_bfr_init ! bottom friction
315	IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz
316	IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme
317	IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme
318	IF( lk_zdfkpp ) CALL zdf_kpp_init ! KPP closure scheme
319	IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing
320	IF( lk_zdfddm .AND. .NOT. lk_zdfkpp ) &
321	& CALL zdf_ddm_init ! double diffusive mixing
322	! ! Lateral physics
323	CALL ldf_tra_init ! Lateral ocean tracer physics
324	CALL ldf_dyn_init ! Lateral ocean momentum physics
325	IF( lk_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
326
327	! ! Active tracers
328	CALL tra_qsr_init ! penetrative solar radiation qsr
329	CALL tra_bbc_init ! bottom heat flux
330	IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
331	IF( lk_tradmp ) CALL tra_dmp_init ! internal damping trends
332	CALL tra_adv_init ! horizontal & vertical advection
333	CALL tra_ldf_init ! lateral mixing
334	CALL tra_zdf_init ! vertical mixing and after tracer fields
335
336	! ! Dynamics
337	CALL dyn_adv_init ! advection (vector or flux form)
338	CALL dyn_vor_init ! vorticity term including Coriolis
339	CALL dyn_ldf_init ! lateral mixing
340	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
341	CALL dyn_zdf_init ! vertical diffusion
342	CALL dyn_spg_init ! surface pressure gradient
343
344	! ! Misc. options
345	IF( nn_cla == 1 ) CALL cla_init ! Cross Land Advection
346
347	#if defined key_top
348	! ! Passive tracers
349	CALL trc_init
350	#endif
351	! ! Diagnostics
352	CALL iom_init ! iom_put initialization
353	IF( lk_floats ) CALL flo_init ! drifting Floats
354	IF( lk_diaar5 ) CALL dia_ar5_init ! ar5 diag
355	CALL dia_ptr_init ! Poleward TRansports initialization
356	CALL dia_hsb_init ! heat content, salt content and volume budgets
357	CALL trd_mod_init ! Mixed-layer/Vorticity/Integral constraints trends
358	IF( lk_diaobs ) THEN ! Observation & model comparison
359	CALL dia_obs_init ! Initialize observational data
360	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
361	ENDIF
362	! ! Assimilation increments
363	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
364	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
365	!
366	END SUBROUTINE nemo_init
367
368
369	SUBROUTINE nemo_ctl
370	!!----------------------------------------------------------------------
371	!! * ROUTINE nemo_ctl *
372	!!
373	!! ** Purpose : control print setting
374	!!
375	!! ** Method : - print namctl information and check some consistencies
376	!!----------------------------------------------------------------------
377	!
378	IF(lwp) THEN ! control print
379	WRITE(numout,*)
380	WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
381	WRITE(numout,*) '~~~~~~~ '
382	WRITE(numout,*) ' Namelist namctl'
383	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
384	WRITE(numout,*) ' level of print nn_print = ', nn_print
385	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
386	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
387	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
388	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
389	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
390	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
391	WRITE(numout,*) ' benchmark parameter (0/1) nn_bench = ', nn_bench
392	ENDIF
393	!
394	nprint = nn_print ! convert DOCTOR namelist names into OLD names
395	nictls = nn_ictls
396	nictle = nn_ictle
397	njctls = nn_jctls
398	njctle = nn_jctle
399	isplt = nn_isplt
400	jsplt = nn_jsplt
401	nbench = nn_bench
402	! ! Parameter control
403	!
404	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
405	IF( lk_mpp ) THEN
406	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
407	ELSE
408	IF( isplt == 1 .AND. jsplt == 1 ) THEN
409	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
410	& ' - the print control will be done over the whole domain' )
411	ENDIF
412	ijsplt = isplt * jsplt ! total number of processors ijsplt
413	ENDIF
414	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
415	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
416	!
417	! ! indices used for the SUM control
418	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
419	lsp_area = .FALSE.
420	ELSE ! print control done over a specific area
421	lsp_area = .TRUE.
422	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
423	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
424	nictls = 1
425	ENDIF
426	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
427	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
428	nictle = jpiglo
429	ENDIF
430	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
431	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
432	njctls = 1
433	ENDIF
434	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
435	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
436	njctle = jpjglo
437	ENDIF
438	ENDIF
439	ENDIF
440	!
441	IF( nbench == 1 ) THEN ! Benchmark
442	SELECT CASE ( cp_cfg )
443	CASE ( 'gyre' ) ; CALL ctl_warn( ' The Benchmark is activated ' )
444	CASE DEFAULT ; CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:', &
445	& ' key_gyre must be used or set nbench = 0' )
446	END SELECT
447	ENDIF
448	!
449	IF( lk_c1d .AND. .NOT.lk_iomput ) CALL ctl_stop( 'nemo_ctl: The 1D configuration must be used ', &
450	& 'with the IOM Input/Output manager. ' , &
451	& 'Compile with key_iomput enabled' )
452	!
453	END SUBROUTINE nemo_ctl
454
455
456	SUBROUTINE nemo_closefile
457	!!----------------------------------------------------------------------
458	!! * ROUTINE nemo_closefile *
459	!!
460	!! ** Purpose : Close the files
461	!!----------------------------------------------------------------------
462	!
463	IF( lk_mpp ) CALL mppsync
464	!
465	CALL iom_close ! close all input/output files managed by iom_*
466	!
467	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
468	IF( numsol /= -1 ) CLOSE( numsol ) ! solver file
469	IF( numnam /= -1 ) CLOSE( numnam ) ! oce namelist
470	IF( numnam_ice /= -1 ) CLOSE( numnam_ice ) ! ice namelist
471	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
472	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
473	!
474	numout = 6 ! redefine numout in case it is used after this point...
475	!
476	END SUBROUTINE nemo_closefile
477
478
479	SUBROUTINE nemo_alloc
480	!!----------------------------------------------------------------------
481	!! * ROUTINE nemo_alloc *
482	!!
483	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
484	!!
485	!! ** Method :
486	!!----------------------------------------------------------------------
487	USE diawri , ONLY: dia_wri_alloc
488	USE dom_oce , ONLY: dom_oce_alloc
489	USE ldfdyn_oce, ONLY: ldfdyn_oce_alloc
490	USE ldftra_oce, ONLY: ldftra_oce_alloc
491	USE trc_oce , ONLY: trc_oce_alloc
492	USE wrk_nemo , ONLY: wrk_alloc
493	!
494	INTEGER :: ierr
495	!!----------------------------------------------------------------------
496	!
497	ierr = oce_alloc () ! ocean
498	ierr = ierr + dia_wri_alloc ()
499	ierr = ierr + dom_oce_alloc () ! ocean domain
500	ierr = ierr + ldfdyn_oce_alloc() ! ocean lateral physics : dynamics
501	ierr = ierr + ldftra_oce_alloc() ! ocean lateral physics : tracers
502	ierr = ierr + zdf_oce_alloc () ! ocean vertical physics
503	!
504	ierr = ierr + lib_mpp_alloc (numout) ! mpp exchanges
505	ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays
506	!
507	ierr = ierr + wrk_alloc(numout, lwp) ! workspace
508	!
509	IF( lk_mpp ) CALL mpp_sum( ierr )
510	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
511	!
512	END SUBROUTINE nemo_alloc
513
514
515	SUBROUTINE nemo_partition( num_pes )
516	!!----------------------------------------------------------------------
517	!! * ROUTINE nemo_partition *
518	!!
519	!! ** Purpose :
520	!!
521	!! ** Method :
522	!!----------------------------------------------------------------------
523	INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
524	!
525	INTEGER, PARAMETER :: nfactmax = 20
526	INTEGER :: nfact ! The no. of factors returned
527	INTEGER :: ierr ! Error flag
528	INTEGER :: ji
529	INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
530	INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
531	!!----------------------------------------------------------------------
532
533	ierr = 0
534
535	CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
536
537	IF( nfact <= 1 ) THEN
538	WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
539	WRITE (numout, *) ' : using grid of ',num_pes,' x 1'
540	jpnj = 1
541	jpni = num_pes
542	ELSE
543	! Search through factors for the pair that are closest in value
544	mindiff = 1000000
545	imin = 1
546	DO ji = 1, nfact-1, 2
547	idiff = ABS( ifact(ji) - ifact(ji+1) )
548	IF( idiff < mindiff ) THEN
549	mindiff = idiff
550	imin = ji
551	ENDIF
552	END DO
553	jpnj = ifact(imin)
554	jpni = ifact(imin + 1)
555	ENDIF
556	!
557	jpnij = jpni*jpnj
558	!
559	END SUBROUTINE nemo_partition
560
561
562	SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
563	!!----------------------------------------------------------------------
564	!! * ROUTINE factorise *
565	!!
566	!! ** Purpose : return the prime factors of n.
567	!! knfax factors are returned in array kfax which is of
568	!! maximum dimension kmaxfax.
569	!! ** Method :
570	!!----------------------------------------------------------------------
571	INTEGER , INTENT(in ) :: kn, kmaxfax
572	INTEGER , INTENT( out) :: kerr, knfax
573	INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax
574	!
575	INTEGER :: ifac, jl, inu
576	INTEGER, PARAMETER :: ntest = 14
577	INTEGER :: ilfax(ntest)
578
579	! lfax contains the set of allowed factors.
580	data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256, &
581	& 128, 64, 32, 16, 8, 4, 2 /
582	!!----------------------------------------------------------------------
583
584	! Clear the error flag and initialise output vars
585	kerr = 0
586	kfax = 1
587	knfax = 0
588
589	! Find the factors of n.
590	IF( kn == 1 ) GOTO 20
591
592	! nu holds the unfactorised part of the number.
593	! knfax holds the number of factors found.
594	! l points to the allowed factor list.
595	! ifac holds the current factor.
596
597	inu = kn
598	knfax = 0
599
600	DO jl = ntest, 1, -1
601	!
602	ifac = ilfax(jl)
603	IF( ifac > inu ) CYCLE
604
605	! Test whether the factor will divide.
606
607	IF( MOD(inu,ifac) == 0 ) THEN
608	!
609	knfax = knfax + 1 ! Add the factor to the list
610	IF( knfax > kmaxfax ) THEN
611	kerr = 6
612	write (,) 'FACTOR: insufficient space in factor array ', knfax
613	return
614	ENDIF
615	kfax(knfax) = ifac
616	! Store the other factor that goes with this one
617	knfax = knfax + 1
618	kfax(knfax) = inu / ifac
619	!WRITE (,) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
620	ENDIF
621	!
622	END DO
623
624	20 CONTINUE ! Label 20 is the exit point from the factor search loop.
625	!
626	END SUBROUTINE factorise
627
628	!!======================================================================
629	END MODULE nemogcm

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

Download in other formats: