New URL for NEMO forge! http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.

nemogcm.F90 in branches/2012/dev_NOC_2012_rev3555/NEMOGCM/NEMO/OPA_SRC – NEMO

Context Navigation

source: branches/2012/dev_NOC_2012_rev3555/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3625

Last change on this file since 3625 was 3625, checked in by acc, 11 years ago
Branch dev_NOC_2012_r3555. #1006. Step 7. Check in code now merged with dev_r3385_NOCS04_HAMF
Property svn:keywords set to `Id`
File size: 36.3 KB

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

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

Download in other formats: