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 | !! ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening |
---|
32 | !!---------------------------------------------------------------------- |
---|
33 | |
---|
34 | !!---------------------------------------------------------------------- |
---|
35 | !! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice |
---|
36 | !! nemo_init : initialization of the NEMO system |
---|
37 | !! nemo_ctl : initialisation of the contol print |
---|
38 | !! nemo_closefile : close remaining open files |
---|
39 | !! nemo_alloc : dynamical allocation |
---|
40 | !! nemo_partition : calculate MPP domain decomposition |
---|
41 | !! factorise : calculate the factors of the no. of MPI processes |
---|
42 | !!---------------------------------------------------------------------- |
---|
43 | USE step_oce ! module used in the ocean time stepping module |
---|
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 bdyini ! open boundary cond. setting (bdy_init routine) |
---|
53 | USE bdydta ! open boundary cond. setting (bdy_dta_init routine) |
---|
54 | USE bdytides ! open boundary cond. setting (bdytide_init routine) |
---|
55 | USE istate ! initial state setting (istate_init routine) |
---|
56 | USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine) |
---|
57 | USE ldftra ! lateral diffusivity setting (ldftra_init routine) |
---|
58 | USE zdfini ! vertical physics setting (zdf_init routine) |
---|
59 | USE phycst ! physical constant (par_cst routine) |
---|
60 | USE trdini ! dyn/tra trends initialization (trd_init routine) |
---|
61 | USE asminc ! assimilation increments |
---|
62 | USE asmbkg ! writing out state trajectory |
---|
63 | USE asmbgc ! biogeochemical assimilation increments |
---|
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 | USE sbccpl |
---|
72 | USE cpl_oasis3 ! OASIS3 coupling |
---|
73 | USE c1d ! 1D configuration |
---|
74 | USE step_c1d ! Time stepping loop for the 1D configuration |
---|
75 | USE dyndmp ! Momentum damping |
---|
76 | #if defined key_top |
---|
77 | USE trcini ! passive tracer initialisation |
---|
78 | USE trc, ONLY: numstr ! tracer stats unit number |
---|
79 | #endif |
---|
80 | USE lib_mpp ! distributed memory computing |
---|
81 | #if defined key_iomput |
---|
82 | USE xios |
---|
83 | #endif |
---|
84 | USE sbctide, ONLY: lk_tide |
---|
85 | USE crsini ! initialise grid coarsening utility |
---|
86 | USE lbcnfd, ONLY: isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges |
---|
87 | USE sbc_oce, ONLY: lk_oasis |
---|
88 | USE stopar |
---|
89 | USE stopts |
---|
90 | |
---|
91 | IMPLICIT NONE |
---|
92 | PRIVATE |
---|
93 | |
---|
94 | PUBLIC nemo_gcm ! called by model.F90 |
---|
95 | PUBLIC nemo_init ! needed by AGRIF |
---|
96 | PUBLIC nemo_alloc ! needed by TAM |
---|
97 | |
---|
98 | CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing |
---|
99 | |
---|
100 | !!---------------------------------------------------------------------- |
---|
101 | !! NEMO/OPA 4.0 , NEMO Consortium (2011) |
---|
102 | !! $Id$ |
---|
103 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
104 | !!---------------------------------------------------------------------- |
---|
105 | CONTAINS |
---|
106 | |
---|
107 | SUBROUTINE nemo_gcm |
---|
108 | !!---------------------------------------------------------------------- |
---|
109 | !! *** ROUTINE nemo_gcm *** |
---|
110 | !! |
---|
111 | !! ** Purpose : NEMO solves the primitive equations on an orthogonal |
---|
112 | !! curvilinear mesh on the sphere. |
---|
113 | !! |
---|
114 | !! ** Method : - model general initialization |
---|
115 | !! - launch the time-stepping (stp routine) |
---|
116 | !! - finalize the run by closing files and communications |
---|
117 | !! |
---|
118 | !! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL. |
---|
119 | !! Madec, 2008, internal report, IPSL. |
---|
120 | !!---------------------------------------------------------------------- |
---|
121 | INTEGER :: istp ! time step index |
---|
122 | !!---------------------------------------------------------------------- |
---|
123 | ! |
---|
124 | #if defined key_agrif |
---|
125 | CALL Agrif_Init_Grids() ! AGRIF: set the meshes |
---|
126 | #endif |
---|
127 | |
---|
128 | ! !-----------------------! |
---|
129 | CALL nemo_init !== Initialisations ==! |
---|
130 | ! !-----------------------! |
---|
131 | #if defined key_agrif |
---|
132 | CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM |
---|
133 | CALL Agrif_Declare_Var ! " " " " " DYN/TRA |
---|
134 | # if defined key_top |
---|
135 | CALL Agrif_Declare_Var_top ! " " " " " TOP |
---|
136 | # endif |
---|
137 | # if defined key_lim2 |
---|
138 | CALL Agrif_Declare_Var_lim2 ! " " " " " LIM |
---|
139 | # endif |
---|
140 | #endif |
---|
141 | ! check that all process are still there... If some process have an error, |
---|
142 | ! they will never enter in step and other processes will wait until the end of the cpu time! |
---|
143 | IF( lk_mpp ) CALL mpp_max( nstop ) |
---|
144 | |
---|
145 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
146 | |
---|
147 | ! !-----------------------! |
---|
148 | ! !== time stepping ==! |
---|
149 | ! !-----------------------! |
---|
150 | istp = nit000 |
---|
151 | #if defined key_c1d |
---|
152 | DO WHILE ( istp <= nitend .AND. nstop == 0 ) |
---|
153 | CALL stp_c1d( istp ) |
---|
154 | istp = istp + 1 |
---|
155 | END DO |
---|
156 | #else |
---|
157 | IF( lk_asminc ) THEN |
---|
158 | IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 ) ! Output background fields |
---|
159 | IF( ln_asmdin ) THEN ! Direct initialization |
---|
160 | IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 ) ! Tracers |
---|
161 | IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 ) ! Dynamics |
---|
162 | IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 ) ! SSH |
---|
163 | IF( lk_bgcinc ) CALL bgc_asm_inc( nit000 - 1 ) ! BGC |
---|
164 | ENDIF |
---|
165 | ENDIF |
---|
166 | |
---|
167 | #if defined key_agrif |
---|
168 | CALL Agrif_Regrid() |
---|
169 | #endif |
---|
170 | |
---|
171 | DO WHILE ( istp <= nitend .AND. nstop == 0 ) |
---|
172 | #if defined key_agrif |
---|
173 | CALL stp ! AGRIF: time stepping |
---|
174 | #else |
---|
175 | IF (lk_oasis) CALL sbc_cpl_snd( istp ) ! Coupling to atmos |
---|
176 | CALL stp( istp ) |
---|
177 | ! We don't couple on the final timestep because |
---|
178 | ! our restart file has already been written |
---|
179 | ! and contains all the necessary data for a |
---|
180 | ! restart. sbc_cpl_snd could be called here |
---|
181 | ! but it would require |
---|
182 | ! a) A test to ensure it was not performed |
---|
183 | ! on the very last time-step |
---|
184 | ! b) the presence of another call to |
---|
185 | ! sbc_cpl_snd call prior to the main DO loop |
---|
186 | ! This solution produces identical results |
---|
187 | ! with fewer lines of code. |
---|
188 | #endif |
---|
189 | istp = istp + 1 |
---|
190 | IF( lk_mpp ) CALL mpp_max( nstop ) |
---|
191 | END DO |
---|
192 | #endif |
---|
193 | |
---|
194 | IF( lk_diaobs ) CALL dia_obs_wri |
---|
195 | ! |
---|
196 | IF( ( lk_asminc ).AND.( ln_balwri ) ) CALL asm_bgc_bal_wri( nitend ) ! Output balancing increments |
---|
197 | ! |
---|
198 | IF( ln_icebergs ) CALL icb_end( nitend ) |
---|
199 | |
---|
200 | ! !------------------------! |
---|
201 | ! !== finalize the run ==! |
---|
202 | ! !------------------------! |
---|
203 | IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
204 | ! |
---|
205 | IF( nstop /= 0 .AND. lwp ) THEN ! error print |
---|
206 | WRITE(numout,cform_err) |
---|
207 | WRITE(numout,*) nstop, ' error have been found' |
---|
208 | ENDIF |
---|
209 | ! |
---|
210 | #if defined key_agrif |
---|
211 | IF( .NOT. Agrif_Root() ) THEN |
---|
212 | CALL Agrif_ParentGrid_To_ChildGrid() |
---|
213 | IF( lk_diaobs ) CALL dia_obs_wri |
---|
214 | IF( nn_timing > 0 ) CALL timing_finalize |
---|
215 | CALL Agrif_ChildGrid_To_ParentGrid() |
---|
216 | ENDIF |
---|
217 | #endif |
---|
218 | IF( nn_timing > 0 ) CALL timing_finalize |
---|
219 | ! |
---|
220 | CALL nemo_closefile |
---|
221 | ! |
---|
222 | #if defined key_iomput |
---|
223 | CALL xios_finalize ! end mpp communications with xios |
---|
224 | IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
225 | #else |
---|
226 | IF( lk_oasis ) THEN |
---|
227 | CALL cpl_finalize ! end coupling and mpp communications with OASIS |
---|
228 | ELSE |
---|
229 | IF( lk_mpp ) CALL mppstop ! end mpp communications |
---|
230 | ENDIF |
---|
231 | #endif |
---|
232 | ! |
---|
233 | ! Met Office addition: if failed, return non-zero exit code |
---|
234 | IF( nstop /= 0 ) CALL exit( 9 ) |
---|
235 | ! |
---|
236 | END SUBROUTINE nemo_gcm |
---|
237 | |
---|
238 | |
---|
239 | SUBROUTINE nemo_init |
---|
240 | !!---------------------------------------------------------------------- |
---|
241 | !! *** ROUTINE nemo_init *** |
---|
242 | !! |
---|
243 | !! ** Purpose : initialization of the NEMO GCM |
---|
244 | !!---------------------------------------------------------------------- |
---|
245 | INTEGER :: ji ! dummy loop indices |
---|
246 | INTEGER :: ilocal_comm ! local integer |
---|
247 | INTEGER :: ios |
---|
248 | CHARACTER(len=80), DIMENSION(16) :: cltxt |
---|
249 | ! |
---|
250 | NAMELIST/namctl/ ln_ctl ,sn_cfctl, nn_print, nn_ictls, nn_ictle, & |
---|
251 | & nn_isplt, nn_jsplt, nn_jctls, nn_jctle, & |
---|
252 | & nn_bench, nn_timing |
---|
253 | NAMELIST/namcfg/ cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, & |
---|
254 | & jpizoom, jpjzoom, jperio, ln_use_jattr |
---|
255 | !!---------------------------------------------------------------------- |
---|
256 | ! |
---|
257 | cltxt = '' |
---|
258 | cxios_context = 'nemo' |
---|
259 | ! |
---|
260 | ! ! Open reference namelist and configuration namelist files |
---|
261 | CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
---|
262 | CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. ) |
---|
263 | ! |
---|
264 | REWIND( numnam_ref ) ! Namelist namctl in reference namelist : Control prints & Benchmark |
---|
265 | READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 ) |
---|
266 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. ) |
---|
267 | |
---|
268 | REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist : Control prints & Benchmark |
---|
269 | READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 ) |
---|
270 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. ) |
---|
271 | |
---|
272 | ! |
---|
273 | REWIND( numnam_ref ) ! Namelist namcfg in reference namelist : Control prints & Benchmark |
---|
274 | READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 ) |
---|
275 | 903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. ) |
---|
276 | |
---|
277 | REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist : Control prints & Benchmark |
---|
278 | READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 ) |
---|
279 | 904 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. ) |
---|
280 | |
---|
281 | ! Force values for AGRIF zoom (cf. agrif_user.F90) |
---|
282 | #if defined key_agrif |
---|
283 | IF( .NOT. Agrif_Root() ) THEN |
---|
284 | jpiglo = nbcellsx + 2 + 2*nbghostcells |
---|
285 | jpjglo = nbcellsy + 2 + 2*nbghostcells |
---|
286 | jpi = ( jpiglo-2*jpreci + (jpni-1+0) ) / jpni + 2*jpreci |
---|
287 | jpj = ( jpjglo-2*jprecj + (jpnj-1+0) ) / jpnj + 2*jprecj |
---|
288 | jpidta = jpiglo |
---|
289 | jpjdta = jpjglo |
---|
290 | jpizoom = 1 |
---|
291 | jpjzoom = 1 |
---|
292 | nperio = 0 |
---|
293 | jperio = 0 |
---|
294 | ln_use_jattr = .false. |
---|
295 | ENDIF |
---|
296 | #endif |
---|
297 | ! |
---|
298 | ! !--------------------------------------------! |
---|
299 | ! ! set communicator & select the local node ! |
---|
300 | ! ! NB: mynode also opens output.namelist.dyn ! |
---|
301 | ! ! on unit number numond on first proc ! |
---|
302 | ! !--------------------------------------------! |
---|
303 | #if defined key_iomput |
---|
304 | IF( Agrif_Root() ) THEN |
---|
305 | IF( lk_oasis ) THEN |
---|
306 | CALL cpl_init( "toyoce", ilocal_comm ) ! nemo local communicator given by oasis |
---|
307 | CALL xios_initialize( "not used",local_comm=ilocal_comm ) ! send nemo communicator to xios |
---|
308 | ELSE |
---|
309 | CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios |
---|
310 | ENDIF |
---|
311 | ENDIF |
---|
312 | ! Nodes selection (control print return in cltxt) |
---|
313 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) |
---|
314 | #else |
---|
315 | IF( lk_oasis ) THEN |
---|
316 | IF( Agrif_Root() ) THEN |
---|
317 | CALL cpl_init( "toyoce", ilocal_comm ) ! nemo local communicator given by oasis |
---|
318 | ENDIF |
---|
319 | ! Nodes selection (control print return in cltxt) |
---|
320 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) |
---|
321 | ELSE |
---|
322 | ilocal_comm = 0 |
---|
323 | ! Nodes selection (control print return in cltxt) |
---|
324 | narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop ) |
---|
325 | ENDIF |
---|
326 | #endif |
---|
327 | narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 ) |
---|
328 | |
---|
329 | IF( sn_cfctl%l_config ) THEN |
---|
330 | ! Activate finer control of report outputs |
---|
331 | ! optionally switch off output from selected areas (note this only |
---|
332 | ! applies to output which does not involve global communications) |
---|
333 | IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax ) .OR. & |
---|
334 | & ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) ) & |
---|
335 | & CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. ) |
---|
336 | ELSE |
---|
337 | ! Use ln_ctl to turn on or off all options. |
---|
338 | CALL nemo_set_cfctl( sn_cfctl, ln_ctl, .TRUE. ) |
---|
339 | ENDIF |
---|
340 | |
---|
341 | lwm = (narea == 1) ! control of output namelists |
---|
342 | lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print |
---|
343 | |
---|
344 | IF(lwm) THEN |
---|
345 | ! write merged namelists from earlier to output namelist now that the |
---|
346 | ! file has been opened in call to mynode. nammpp has already been |
---|
347 | ! written in mynode (if lk_mpp_mpi) |
---|
348 | WRITE( numond, namctl ) |
---|
349 | WRITE( numond, namcfg ) |
---|
350 | ENDIF |
---|
351 | |
---|
352 | ! If dimensions of processor grid weren't specified in the namelist file |
---|
353 | ! then we calculate them here now that we have our communicator size |
---|
354 | IF( (jpni < 1) .OR. (jpnj < 1) )THEN |
---|
355 | #if defined key_mpp_mpi |
---|
356 | IF( Agrif_Root() ) CALL nemo_partition(mppsize) |
---|
357 | #else |
---|
358 | jpni = 1 |
---|
359 | jpnj = 1 |
---|
360 | jpnij = jpni*jpnj |
---|
361 | #endif |
---|
362 | END IF |
---|
363 | |
---|
364 | ! Calculate domain dimensions given calculated jpni and jpnj |
---|
365 | ! This used to be done in par_oce.F90 when they were parameters rather |
---|
366 | ! than variables |
---|
367 | IF( Agrif_Root() ) THEN |
---|
368 | #if defined key_nemocice_decomp |
---|
369 | jpi = ( nx_global+2-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first dim. |
---|
370 | jpj = ( ny_global+2-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim. |
---|
371 | #else |
---|
372 | jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first dim. |
---|
373 | jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim. |
---|
374 | #endif |
---|
375 | ENDIF |
---|
376 | jpk = jpkdta ! third dim |
---|
377 | #if defined key_agrif |
---|
378 | ! simple trick to use same vertical grid as parent |
---|
379 | ! but different number of levels: |
---|
380 | ! Save maximum number of levels in jpkdta, then define all vertical grids |
---|
381 | ! with this number. |
---|
382 | ! Suppress once vertical online interpolation is ok |
---|
383 | IF(.NOT.Agrif_Root()) jpkdta = Agrif_Parent(jpkdta) |
---|
384 | #endif |
---|
385 | jpim1 = jpi-1 ! inner domain indices |
---|
386 | jpjm1 = jpj-1 ! " " |
---|
387 | jpkm1 = jpk-1 ! " " |
---|
388 | jpij = jpi*jpj ! jpi x j |
---|
389 | |
---|
390 | IF(lwp) THEN ! open listing units |
---|
391 | ! |
---|
392 | CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea ) |
---|
393 | ! |
---|
394 | WRITE(numout,*) |
---|
395 | WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC' |
---|
396 | WRITE(numout,*) ' NEMO team' |
---|
397 | WRITE(numout,*) ' Ocean General Circulation Model' |
---|
398 | WRITE(numout,*) ' version 3.6 (2015) ' |
---|
399 | WRITE(numout,*) |
---|
400 | WRITE(numout,*) |
---|
401 | DO ji = 1, SIZE(cltxt) |
---|
402 | IF( TRIM(cltxt(ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode |
---|
403 | END DO |
---|
404 | WRITE(numout,cform_aaa) ! Flag AAAAAAA |
---|
405 | ! |
---|
406 | ENDIF |
---|
407 | |
---|
408 | ! Now we know the dimensions of the grid and numout has been set we can |
---|
409 | ! allocate arrays |
---|
410 | CALL nemo_alloc() |
---|
411 | |
---|
412 | ! !-------------------------------! |
---|
413 | ! ! NEMO general initialization ! |
---|
414 | ! !-------------------------------! |
---|
415 | |
---|
416 | CALL nemo_ctl ! Control prints & Benchmark |
---|
417 | |
---|
418 | ! ! Domain decomposition |
---|
419 | IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out |
---|
420 | ELSE ; CALL mpp_init2 ! eliminate land processors |
---|
421 | ENDIF |
---|
422 | ! |
---|
423 | IF( nn_timing > 0 ) CALL timing_init |
---|
424 | ! |
---|
425 | ! ! General initialization |
---|
426 | CALL phy_cst ! Physical constants |
---|
427 | CALL eos_init ! Equation of state |
---|
428 | IF( lk_c1d ) CALL c1d_init ! 1D column configuration |
---|
429 | CALL dom_cfg ! Domain configuration |
---|
430 | CALL dom_init ! Domain |
---|
431 | |
---|
432 | IF( ln_nnogather ) CALL nemo_northcomms ! Initialise the northfold neighbour lists (must be done after the masks are defined) |
---|
433 | |
---|
434 | IF( ln_ctl ) CALL prt_ctl_init ! Print control |
---|
435 | |
---|
436 | CALL istate_init ! ocean initial state (Dynamics and tracers) |
---|
437 | |
---|
438 | IF( lk_tide ) CALL tide_init( nit000 ) ! Initialisation of the tidal harmonics |
---|
439 | |
---|
440 | CALL sbc_init ! Forcings : surface module (clem: moved here for bdy purpose) |
---|
441 | |
---|
442 | IF( lk_bdy ) CALL bdy_init ! Open boundaries initialisation |
---|
443 | IF( lk_bdy ) CALL bdy_dta_init ! Open boundaries initialisation of external data arrays |
---|
444 | IF( lk_bdy .AND. lk_tide ) & |
---|
445 | & CALL bdytide_init ! Open boundaries initialisation of tidal harmonic forcing |
---|
446 | |
---|
447 | CALL dyn_nept_init ! simplified form of Neptune effect |
---|
448 | ! |
---|
449 | IF( ln_crs ) CALL crs_init ! Domain initialization of coarsened grid |
---|
450 | ! |
---|
451 | ! Ocean physics |
---|
452 | ! ! Vertical physics |
---|
453 | CALL zdf_init ! namelist read |
---|
454 | CALL zdf_bfr_init ! bottom friction |
---|
455 | IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz |
---|
456 | IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme |
---|
457 | IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme |
---|
458 | IF( lk_zdfkpp ) CALL zdf_kpp_init ! KPP closure scheme |
---|
459 | IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing |
---|
460 | IF( lk_zdfddm .AND. .NOT. lk_zdfkpp ) & |
---|
461 | & CALL zdf_ddm_init ! double diffusive mixing |
---|
462 | ! ! Lateral physics |
---|
463 | CALL ldf_tra_init ! Lateral ocean tracer physics |
---|
464 | CALL ldf_dyn_init ! Lateral ocean momentum physics |
---|
465 | IF( lk_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing |
---|
466 | |
---|
467 | ! ! Active tracers |
---|
468 | CALL tra_qsr_init ! penetrative solar radiation qsr |
---|
469 | CALL tra_bbc_init ! bottom heat flux |
---|
470 | IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme |
---|
471 | CALL tra_dmp_init ! internal damping trends- tracers |
---|
472 | CALL tra_adv_init ! horizontal & vertical advection |
---|
473 | CALL tra_ldf_init ! lateral mixing |
---|
474 | CALL tra_zdf_init ! vertical mixing and after tracer fields |
---|
475 | |
---|
476 | ! ! Dynamics |
---|
477 | IF( lk_c1d ) CALL dyn_dmp_init ! internal damping trends- momentum |
---|
478 | CALL dyn_adv_init ! advection (vector or flux form) |
---|
479 | CALL dyn_vor_init ! vorticity term including Coriolis |
---|
480 | CALL dyn_ldf_init ! lateral mixing |
---|
481 | CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure |
---|
482 | CALL dyn_zdf_init ! vertical diffusion |
---|
483 | CALL dyn_spg_init ! surface pressure gradient |
---|
484 | |
---|
485 | ! ! Misc. options |
---|
486 | IF( nn_cla == 1 .AND. cp_cfg == 'orca' .AND. jp_cfg == 2 ) CALL cla_init ! Cross Land Advection |
---|
487 | CALL icb_init( rdt, nit000) ! initialise icebergs instance |
---|
488 | CALL sto_par_init ! Stochastic parametrization |
---|
489 | IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations |
---|
490 | |
---|
491 | #if defined key_top |
---|
492 | ! ! Passive tracers |
---|
493 | CALL trc_init |
---|
494 | #endif |
---|
495 | ! ! Diagnostics |
---|
496 | IF( lk_floats ) CALL flo_init ! drifting Floats |
---|
497 | CALL dia_ptr_init ! Poleward TRansports initialization |
---|
498 | IF( lk_diadct ) CALL dia_dct_init ! Sections tranports |
---|
499 | CALL dia_hsb_init ! heat content, salt content and volume budgets |
---|
500 | CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends |
---|
501 | CALL bias_init ! Pressure correction bias |
---|
502 | IF( lk_diaobs ) THEN ! Observation & model comparison |
---|
503 | CALL dia_obs_init ! Initialize observational data |
---|
504 | CALL dia_obs( nit000 - 1 ) ! Observation operator for restart |
---|
505 | ENDIF |
---|
506 | |
---|
507 | ! ! Assimilation increments |
---|
508 | IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments |
---|
509 | IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler |
---|
510 | |
---|
511 | IF (nstop > 0) THEN |
---|
512 | CALL CTL_STOP('STOP','Critical errors in NEMO initialisation') |
---|
513 | END IF |
---|
514 | |
---|
515 | ! |
---|
516 | END SUBROUTINE nemo_init |
---|
517 | |
---|
518 | |
---|
519 | SUBROUTINE nemo_ctl |
---|
520 | !!---------------------------------------------------------------------- |
---|
521 | !! *** ROUTINE nemo_ctl *** |
---|
522 | !! |
---|
523 | !! ** Purpose : control print setting |
---|
524 | !! |
---|
525 | !! ** Method : - print namctl information and check some consistencies |
---|
526 | !!---------------------------------------------------------------------- |
---|
527 | ! |
---|
528 | IF(lwp) THEN ! control print |
---|
529 | WRITE(numout,*) |
---|
530 | WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark' |
---|
531 | WRITE(numout,*) '~~~~~~~ ' |
---|
532 | WRITE(numout,*) ' Namelist namctl' |
---|
533 | WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl |
---|
534 | WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config |
---|
535 | WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat |
---|
536 | WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat |
---|
537 | WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout |
---|
538 | WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout |
---|
539 | WRITE(numout,*) ' sn_cfctl%l_mppout = ', sn_cfctl%l_mppout |
---|
540 | WRITE(numout,*) ' sn_cfctl%l_mpptop = ', sn_cfctl%l_mpptop |
---|
541 | WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin |
---|
542 | WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax |
---|
543 | WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr |
---|
544 | WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr |
---|
545 | WRITE(numout,*) ' level of print nn_print = ', nn_print |
---|
546 | WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls |
---|
547 | WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle |
---|
548 | WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls |
---|
549 | WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle |
---|
550 | WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt |
---|
551 | WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt |
---|
552 | WRITE(numout,*) ' benchmark parameter (0/1) nn_bench = ', nn_bench |
---|
553 | WRITE(numout,*) ' timing activated (0/1) nn_timing = ', nn_timing |
---|
554 | ENDIF |
---|
555 | ! |
---|
556 | nprint = nn_print ! convert DOCTOR namelist names into OLD names |
---|
557 | nictls = nn_ictls |
---|
558 | nictle = nn_ictle |
---|
559 | njctls = nn_jctls |
---|
560 | njctle = nn_jctle |
---|
561 | isplt = nn_isplt |
---|
562 | jsplt = nn_jsplt |
---|
563 | nbench = nn_bench |
---|
564 | |
---|
565 | IF(lwp) THEN ! control print |
---|
566 | WRITE(numout,*) |
---|
567 | WRITE(numout,*) 'namcfg : configuration initialization through namelist read' |
---|
568 | WRITE(numout,*) '~~~~~~~ ' |
---|
569 | WRITE(numout,*) ' Namelist namcfg' |
---|
570 | WRITE(numout,*) ' configuration name cp_cfg = ', TRIM(cp_cfg) |
---|
571 | WRITE(numout,*) ' configuration zoom name cp_cfz = ', TRIM(cp_cfz) |
---|
572 | WRITE(numout,*) ' configuration resolution jp_cfg = ', jp_cfg |
---|
573 | WRITE(numout,*) ' 1st lateral dimension ( >= jpi ) jpidta = ', jpidta |
---|
574 | WRITE(numout,*) ' 2nd " " ( >= jpj ) jpjdta = ', jpjdta |
---|
575 | WRITE(numout,*) ' 3nd " " jpkdta = ', jpkdta |
---|
576 | WRITE(numout,*) ' 1st dimension of global domain in i jpiglo = ', jpiglo |
---|
577 | WRITE(numout,*) ' 2nd - - in j jpjglo = ', jpjglo |
---|
578 | WRITE(numout,*) ' left bottom i index of the zoom (in data domain) jpizoom = ', jpizoom |
---|
579 | WRITE(numout,*) ' left bottom j index of the zoom (in data domain) jpizoom = ', jpjzoom |
---|
580 | WRITE(numout,*) ' lateral cond. type (between 0 and 6) jperio = ', jperio |
---|
581 | WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr |
---|
582 | ENDIF |
---|
583 | ! ! Parameter control |
---|
584 | ! |
---|
585 | IF( ln_ctl ) THEN ! sub-domain area indices for the control prints |
---|
586 | IF( lk_mpp .AND. jpnij > 1 ) THEN |
---|
587 | isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain |
---|
588 | ELSE |
---|
589 | IF( isplt == 1 .AND. jsplt == 1 ) THEN |
---|
590 | CALL ctl_warn( ' - isplt & jsplt are equal to 1', & |
---|
591 | & ' - the print control will be done over the whole domain' ) |
---|
592 | ENDIF |
---|
593 | ijsplt = isplt * jsplt ! total number of processors ijsplt |
---|
594 | ENDIF |
---|
595 | IF(lwp) WRITE(numout,*)' - The total number of processors over which the' |
---|
596 | IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt |
---|
597 | ! |
---|
598 | ! ! indices used for the SUM control |
---|
599 | IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area |
---|
600 | lsp_area = .FALSE. |
---|
601 | ELSE ! print control done over a specific area |
---|
602 | lsp_area = .TRUE. |
---|
603 | IF( nictls < 1 .OR. nictls > jpiglo ) THEN |
---|
604 | CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' ) |
---|
605 | nictls = 1 |
---|
606 | ENDIF |
---|
607 | IF( nictle < 1 .OR. nictle > jpiglo ) THEN |
---|
608 | CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' ) |
---|
609 | nictle = jpiglo |
---|
610 | ENDIF |
---|
611 | IF( njctls < 1 .OR. njctls > jpjglo ) THEN |
---|
612 | CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' ) |
---|
613 | njctls = 1 |
---|
614 | ENDIF |
---|
615 | IF( njctle < 1 .OR. njctle > jpjglo ) THEN |
---|
616 | CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' ) |
---|
617 | njctle = jpjglo |
---|
618 | ENDIF |
---|
619 | ENDIF |
---|
620 | ENDIF |
---|
621 | ! |
---|
622 | IF( nbench == 1 ) THEN ! Benchmark |
---|
623 | SELECT CASE ( cp_cfg ) |
---|
624 | CASE ( 'gyre' ) ; CALL ctl_warn( ' The Benchmark is activated ' ) |
---|
625 | CASE DEFAULT ; CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:', & |
---|
626 | & ' cp_cfg = "gyre" in namelist &namcfg or set nbench = 0' ) |
---|
627 | END SELECT |
---|
628 | ENDIF |
---|
629 | ! |
---|
630 | IF( 1_wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ', & |
---|
631 | & 'f2003 standard. ' , & |
---|
632 | & 'Compile with key_nosignedzero enabled' ) |
---|
633 | ! |
---|
634 | END SUBROUTINE nemo_ctl |
---|
635 | |
---|
636 | |
---|
637 | SUBROUTINE nemo_closefile |
---|
638 | !!---------------------------------------------------------------------- |
---|
639 | !! *** ROUTINE nemo_closefile *** |
---|
640 | !! |
---|
641 | !! ** Purpose : Close the files |
---|
642 | !!---------------------------------------------------------------------- |
---|
643 | ! |
---|
644 | IF( lk_mpp ) CALL mppsync |
---|
645 | ! |
---|
646 | CALL iom_close ! close all input/output files managed by iom_* |
---|
647 | ! |
---|
648 | IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file |
---|
649 | IF( numsol /= -1 ) CLOSE( numsol ) ! solver file |
---|
650 | IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist |
---|
651 | IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist |
---|
652 | IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist |
---|
653 | IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist |
---|
654 | IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist |
---|
655 | IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist |
---|
656 | IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution) |
---|
657 | IF( numout /= 6 ) CLOSE( numout ) ! standard model output file |
---|
658 | IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports |
---|
659 | IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports |
---|
660 | IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports |
---|
661 | #if defined key_top |
---|
662 | IF( numstr /= -1 ) CLOSE( numstr ) ! tracer statistics |
---|
663 | #endif |
---|
664 | ! |
---|
665 | numout = 6 ! redefine numout in case it is used after this point... |
---|
666 | ! |
---|
667 | END SUBROUTINE nemo_closefile |
---|
668 | |
---|
669 | |
---|
670 | SUBROUTINE nemo_alloc |
---|
671 | !!---------------------------------------------------------------------- |
---|
672 | !! *** ROUTINE nemo_alloc *** |
---|
673 | !! |
---|
674 | !! ** Purpose : Allocate all the dynamic arrays of the OPA modules |
---|
675 | !! |
---|
676 | !! ** Method : |
---|
677 | !!---------------------------------------------------------------------- |
---|
678 | USE diawri , ONLY: dia_wri_alloc |
---|
679 | USE insitu_tem, ONLY: insitu_tem_alloc |
---|
680 | USE dom_oce , ONLY: dom_oce_alloc |
---|
681 | USE ldfdyn_oce, ONLY: ldfdyn_oce_alloc |
---|
682 | USE ldftra_oce, ONLY: ldftra_oce_alloc |
---|
683 | USE trc_oce , ONLY: trc_oce_alloc |
---|
684 | #if defined key_diadct |
---|
685 | USE diadct , ONLY: diadct_alloc |
---|
686 | #endif |
---|
687 | #if defined key_bdy |
---|
688 | USE bdy_oce , ONLY: bdy_oce_alloc |
---|
689 | #endif |
---|
690 | ! |
---|
691 | INTEGER :: ierr |
---|
692 | !!---------------------------------------------------------------------- |
---|
693 | ! |
---|
694 | ierr = oce_alloc () ! ocean |
---|
695 | ierr = ierr + dia_wri_alloc () |
---|
696 | ierr = ierr + insitu_tem_alloc() |
---|
697 | ierr = ierr + dom_oce_alloc () ! ocean domain |
---|
698 | ierr = ierr + ldfdyn_oce_alloc() ! ocean lateral physics : dynamics |
---|
699 | ierr = ierr + ldftra_oce_alloc() ! ocean lateral physics : tracers |
---|
700 | ierr = ierr + zdf_oce_alloc () ! ocean vertical physics |
---|
701 | ! |
---|
702 | ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays |
---|
703 | ! |
---|
704 | #if defined key_diadct |
---|
705 | ierr = ierr + diadct_alloc () ! |
---|
706 | #endif |
---|
707 | #if defined key_bdy |
---|
708 | ierr = ierr + bdy_oce_alloc () ! bdy masks (incl. initialization) |
---|
709 | #endif |
---|
710 | ! |
---|
711 | IF( lk_mpp ) CALL mpp_sum( ierr ) |
---|
712 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' ) |
---|
713 | ! |
---|
714 | END SUBROUTINE nemo_alloc |
---|
715 | |
---|
716 | SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all ) |
---|
717 | !!---------------------------------------------------------------------- |
---|
718 | !! *** ROUTINE nemo_set_cfctl *** |
---|
719 | !! |
---|
720 | !! ** Purpose : Set elements of the output control structure to setto. |
---|
721 | !! for_all should be .false. unless all areas are to be |
---|
722 | !! treated identically. |
---|
723 | !! |
---|
724 | !! ** Method : Note this routine can be used to switch on/off some |
---|
725 | !! types of output for selected areas but any output types |
---|
726 | !! that involve global communications (e.g. mpp_max, glob_sum) |
---|
727 | !! should be protected from selective switching by the |
---|
728 | !! for_all argument |
---|
729 | !!---------------------------------------------------------------------- |
---|
730 | LOGICAL :: setto, for_all |
---|
731 | TYPE(sn_ctl) :: sn_cfctl |
---|
732 | !!---------------------------------------------------------------------- |
---|
733 | IF( for_all ) THEN |
---|
734 | sn_cfctl%l_runstat = setto |
---|
735 | sn_cfctl%l_trcstat = setto |
---|
736 | ENDIF |
---|
737 | sn_cfctl%l_oceout = setto |
---|
738 | sn_cfctl%l_layout = setto |
---|
739 | sn_cfctl%l_mppout = setto |
---|
740 | sn_cfctl%l_mpptop = setto |
---|
741 | END SUBROUTINE nemo_set_cfctl |
---|
742 | |
---|
743 | SUBROUTINE nemo_partition( num_pes ) |
---|
744 | !!---------------------------------------------------------------------- |
---|
745 | !! *** ROUTINE nemo_partition *** |
---|
746 | !! |
---|
747 | !! ** Purpose : |
---|
748 | !! |
---|
749 | !! ** Method : |
---|
750 | !!---------------------------------------------------------------------- |
---|
751 | INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have |
---|
752 | ! |
---|
753 | INTEGER, PARAMETER :: nfactmax = 20 |
---|
754 | INTEGER :: nfact ! The no. of factors returned |
---|
755 | INTEGER :: ierr ! Error flag |
---|
756 | INTEGER :: ji |
---|
757 | INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value |
---|
758 | INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors |
---|
759 | !!---------------------------------------------------------------------- |
---|
760 | ! |
---|
761 | ierr = 0 |
---|
762 | ! |
---|
763 | CALL factorise( ifact, nfactmax, nfact, num_pes, ierr ) |
---|
764 | ! |
---|
765 | IF( nfact <= 1 ) THEN |
---|
766 | WRITE (numout, *) 'WARNING: factorisation of number of PEs failed' |
---|
767 | WRITE (numout, *) ' : using grid of ',num_pes,' x 1' |
---|
768 | jpnj = 1 |
---|
769 | jpni = num_pes |
---|
770 | ELSE |
---|
771 | ! Search through factors for the pair that are closest in value |
---|
772 | mindiff = 1000000 |
---|
773 | imin = 1 |
---|
774 | DO ji = 1, nfact-1, 2 |
---|
775 | idiff = ABS( ifact(ji) - ifact(ji+1) ) |
---|
776 | IF( idiff < mindiff ) THEN |
---|
777 | mindiff = idiff |
---|
778 | imin = ji |
---|
779 | ENDIF |
---|
780 | END DO |
---|
781 | jpnj = ifact(imin) |
---|
782 | jpni = ifact(imin + 1) |
---|
783 | ENDIF |
---|
784 | ! |
---|
785 | jpnij = jpni*jpnj |
---|
786 | ! |
---|
787 | END SUBROUTINE nemo_partition |
---|
788 | |
---|
789 | |
---|
790 | SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr ) |
---|
791 | !!---------------------------------------------------------------------- |
---|
792 | !! *** ROUTINE factorise *** |
---|
793 | !! |
---|
794 | !! ** Purpose : return the prime factors of n. |
---|
795 | !! knfax factors are returned in array kfax which is of |
---|
796 | !! maximum dimension kmaxfax. |
---|
797 | !! ** Method : |
---|
798 | !!---------------------------------------------------------------------- |
---|
799 | INTEGER , INTENT(in ) :: kn, kmaxfax |
---|
800 | INTEGER , INTENT( out) :: kerr, knfax |
---|
801 | INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax |
---|
802 | ! |
---|
803 | INTEGER :: ifac, jl, inu |
---|
804 | INTEGER, PARAMETER :: ntest = 14 |
---|
805 | INTEGER, DIMENSION(ntest) :: ilfax |
---|
806 | ! |
---|
807 | ! ilfax contains the set of allowed factors. |
---|
808 | ilfax(:) = (/(2**jl,jl=ntest,1,-1)/) |
---|
809 | !!---------------------------------------------------------------------- |
---|
810 | ! ilfax contains the set of allowed factors. |
---|
811 | ilfax(:) = (/(2**jl,jl=ntest,1,-1)/) |
---|
812 | |
---|
813 | ! Clear the error flag and initialise output vars |
---|
814 | kerr = 0 |
---|
815 | kfax = 1 |
---|
816 | knfax = 0 |
---|
817 | |
---|
818 | ! Find the factors of n. |
---|
819 | IF( kn == 1 ) GOTO 20 |
---|
820 | |
---|
821 | ! nu holds the unfactorised part of the number. |
---|
822 | ! knfax holds the number of factors found. |
---|
823 | ! l points to the allowed factor list. |
---|
824 | ! ifac holds the current factor. |
---|
825 | |
---|
826 | inu = kn |
---|
827 | knfax = 0 |
---|
828 | |
---|
829 | DO jl = ntest, 1, -1 |
---|
830 | ! |
---|
831 | ifac = ilfax(jl) |
---|
832 | IF( ifac > inu ) CYCLE |
---|
833 | |
---|
834 | ! Test whether the factor will divide. |
---|
835 | |
---|
836 | IF( MOD(inu,ifac) == 0 ) THEN |
---|
837 | ! |
---|
838 | knfax = knfax + 1 ! Add the factor to the list |
---|
839 | IF( knfax > kmaxfax ) THEN |
---|
840 | kerr = 6 |
---|
841 | write (*,*) 'FACTOR: insufficient space in factor array ', knfax |
---|
842 | return |
---|
843 | ENDIF |
---|
844 | kfax(knfax) = ifac |
---|
845 | ! Store the other factor that goes with this one |
---|
846 | knfax = knfax + 1 |
---|
847 | kfax(knfax) = inu / ifac |
---|
848 | !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax) |
---|
849 | ENDIF |
---|
850 | ! |
---|
851 | END DO |
---|
852 | |
---|
853 | 20 CONTINUE ! Label 20 is the exit point from the factor search loop. |
---|
854 | ! |
---|
855 | END SUBROUTINE factorise |
---|
856 | |
---|
857 | #if defined key_mpp_mpi |
---|
858 | |
---|
859 | SUBROUTINE nemo_northcomms |
---|
860 | !!====================================================================== |
---|
861 | !! *** ROUTINE nemo_northcomms *** |
---|
862 | !! nemo_northcomms : Setup for north fold exchanges with explicit |
---|
863 | !! point-to-point messaging |
---|
864 | !!===================================================================== |
---|
865 | !!---------------------------------------------------------------------- |
---|
866 | !! |
---|
867 | !! ** Purpose : Initialization of the northern neighbours lists. |
---|
868 | !!---------------------------------------------------------------------- |
---|
869 | !! 1.0 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE) |
---|
870 | !! 2.0 ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC) |
---|
871 | !!---------------------------------------------------------------------- |
---|
872 | |
---|
873 | INTEGER :: sxM, dxM, sxT, dxT, jn |
---|
874 | INTEGER :: njmppmax |
---|
875 | |
---|
876 | njmppmax = MAXVAL( njmppt ) |
---|
877 | |
---|
878 | !initializes the north-fold communication variables |
---|
879 | isendto(:) = 0 |
---|
880 | nsndto = 0 |
---|
881 | |
---|
882 | !if I am a process in the north |
---|
883 | IF ( njmpp == njmppmax ) THEN |
---|
884 | !sxM is the first point (in the global domain) needed to compute the |
---|
885 | !north-fold for the current process |
---|
886 | sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1 |
---|
887 | !dxM is the last point (in the global domain) needed to compute the |
---|
888 | !north-fold for the current process |
---|
889 | dxM = jpiglo - nimppt(narea) + 2 |
---|
890 | |
---|
891 | !loop over the other north-fold processes to find the processes |
---|
892 | !managing the points belonging to the sxT-dxT range |
---|
893 | |
---|
894 | DO jn = 1, jpni |
---|
895 | !sxT is the first point (in the global domain) of the jn |
---|
896 | !process |
---|
897 | sxT = nfiimpp(jn, jpnj) |
---|
898 | !dxT is the last point (in the global domain) of the jn |
---|
899 | !process |
---|
900 | dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1 |
---|
901 | IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN |
---|
902 | nsndto = nsndto + 1 |
---|
903 | isendto(nsndto) = jn |
---|
904 | ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN |
---|
905 | nsndto = nsndto + 1 |
---|
906 | isendto(nsndto) = jn |
---|
907 | ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN |
---|
908 | nsndto = nsndto + 1 |
---|
909 | isendto(nsndto) = jn |
---|
910 | END IF |
---|
911 | END DO |
---|
912 | nfsloop = 1 |
---|
913 | nfeloop = nlci |
---|
914 | DO jn = 2,jpni-1 |
---|
915 | IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN |
---|
916 | IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN |
---|
917 | nfsloop = nldi |
---|
918 | ENDIF |
---|
919 | IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN |
---|
920 | nfeloop = nlei |
---|
921 | ENDIF |
---|
922 | ENDIF |
---|
923 | END DO |
---|
924 | |
---|
925 | ENDIF |
---|
926 | l_north_nogather = .TRUE. |
---|
927 | END SUBROUTINE nemo_northcomms |
---|
928 | #else |
---|
929 | SUBROUTINE nemo_northcomms ! Dummy routine |
---|
930 | WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?' |
---|
931 | END SUBROUTINE nemo_northcomms |
---|
932 | #endif |
---|
933 | |
---|
934 | !!====================================================================== |
---|
935 | END MODULE nemogcm |
---|
936 | |
---|
937 | |
---|