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

Context Navigation

source: branches/UKMO/r5936_hadgem3_cplseq/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 7134

Last change on this file since 7134 was 7134, checked in by jcastill, 7 years ago
Version as in UKMO/dev_r5107_hadgem3_cplseq@5646
File size: 40.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-10 (A. C. Coward, NOCS & J. Donners, PRACE) add nemo_northcomms
31	!! - ! 2011-11 (C. Harris) decomposition changes for running with CICE
32	!! 3.6 ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
33	!! - ! 2013-06 (I. Epicoco, S. Mocavero, CMCC) nemo_northcomms: setup avoiding MPI communication
34	!! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla)
35	!!----------------------------------------------------------------------
36
37	!!----------------------------------------------------------------------
38	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
39	!! nemo_init : initialization of the NEMO system
40	!! nemo_ctl : initialisation of the contol print
41	!! nemo_closefile : close remaining open files
42	!! nemo_alloc : dynamical allocation
43	!! nemo_partition : calculate MPP domain decomposition
44	!! factorise : calculate the factors of the no. of MPI processes
45	!!----------------------------------------------------------------------
46	USE step_oce ! module used in the ocean time stepping module (step.F90)
47	USE domcfg ! domain configuration (dom_cfg routine)
48	USE mppini ! shared/distributed memory setting (mpp_init routine)
49	USE domain ! domain initialization (dom_init routine)
50	#if defined key_nemocice_decomp
51	USE ice_domain_size, only: nx_global, ny_global
52	#endif
53	USE tideini ! tidal components initialization (tide_ini routine)
54	USE bdyini ! open boundary cond. setting (bdy_init routine)
55	USE bdydta ! open boundary cond. setting (bdy_dta_init routine)
56	USE bdytides ! open boundary cond. setting (bdytide_init routine)
57	USE istate ! initial state setting (istate_init routine)
58	USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine)
59	USE ldftra ! lateral diffusivity setting (ldftra_init routine)
60	USE zdfini ! vertical physics setting (zdf_init routine)
61	USE phycst ! physical constant (par_cst routine)
62	USE trdini ! dyn/tra trends initialization (trd_init routine)
63	USE asminc ! assimilation increments
64	USE asmbkg ! writing out state trajectory
65	USE diaptr ! poleward transports (dia_ptr_init routine)
66	USE diadct ! sections transports (dia_dct_init routine)
67	USE diaobs ! Observation diagnostics (dia_obs_init routine)
68	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
69	USE step ! NEMO time-stepping (stp routine)
70	USE icbini ! handle bergs, initialisation
71	USE icbstp ! handle bergs, calving, themodynamics and transport
72	USE sbccpl
73	USE cpl_oasis3 ! OASIS3 coupling
74	USE c1d ! 1D configuration
75	USE step_c1d ! Time stepping loop for the 1D configuration
76	USE dyndmp ! Momentum damping
77	#if defined key_top
78	USE trcini ! passive tracer initialisation
79	#endif
80	USE lib_mpp ! distributed memory computing
81	#if defined key_iomput
82	USE xios ! xIOserver
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 3.7 , NEMO Consortium (2015)
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	ENDIF
164	ENDIF
165
166	#if defined key_agrif
167	CALL Agrif_Regrid()
168	#endif
169
170	DO WHILE ( istp <= nitend .AND. nstop == 0 )
171	#if defined key_agrif
172	CALL stp ! AGRIF: time stepping
173	#else
174	IF (lk_oasis) CALL sbc_cpl_snd( istp ) ! Coupling to atmos
175	CALL stp( istp )
176	! We don't couple on the final timestep because
177	! our restart file has already been written
178	! and contains all the necessary data for a
179	! restart. sbc_cpl_snd could be called here
180	! but it would require
181	! a) A test to ensure it was not performed
182	! on the very last time-step
183	! b) the presence of another call to
184	! sbc_cpl_snd call prior to the main DO loop
185	! This solution produces identical results
186	! with fewer lines of code.
187	#endif
188	istp = istp + 1
189	IF( lk_mpp ) CALL mpp_max( nstop )
190	END DO
191	#endif
192
193	IF( lk_diaobs ) CALL dia_obs_wri
194	!
195	IF( ln_icebergs ) CALL icb_end( nitend )
196
197	! !------------------------!
198	! !== finalize the run ==!
199	! !------------------------!
200	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
201	!
202	IF( nstop /= 0 .AND. lwp ) THEN ! error print
203	WRITE(numout,cform_err)
204	WRITE(numout,*) nstop, ' error have been found'
205	ENDIF
206	!
207	#if defined key_agrif
208	IF(.NOT.Agrif_Root() ) THEN
209	CALL Agrif_ParentGrid_To_ChildGrid()
210	IF( lk_diaobs ) CALL dia_obs_wri
211	IF( nn_timing == 1 ) CALL timing_finalize
212	CALL Agrif_ChildGrid_To_ParentGrid()
213	ENDIF
214	#endif
215	IF( nn_timing == 1 ) CALL timing_finalize
216	!
217	CALL nemo_closefile
218	!
219	#if defined key_iomput
220	CALL xios_finalize ! end mpp communications with xios
221	IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS
222	#else
223	IF( lk_oasis ) THEN
224	CALL cpl_finalize ! end coupling and mpp communications with OASIS
225	ELSE
226	IF( lk_mpp ) CALL mppstop ! end mpp communications
227	ENDIF
228	#endif
229	!
230	END SUBROUTINE nemo_gcm
231
232
233	SUBROUTINE nemo_init
234	!!----------------------------------------------------------------------
235	!! * ROUTINE nemo_init *
236	!!
237	!! ** Purpose : initialization of the NEMO GCM
238	!!----------------------------------------------------------------------
239	INTEGER :: ji ! dummy loop indices
240	INTEGER :: ilocal_comm ! local integer
241	INTEGER :: ios
242	CHARACTER(len=80), DIMENSION(16) :: cltxt
243	!
244	NAMELIST/namctl/ ln_ctl , nn_print, nn_ictls, nn_ictle, &
245	& nn_isplt, nn_jsplt, nn_jctls, nn_jctle, &
246	& nn_bench, nn_timing
247	NAMELIST/namcfg/ cp_cfg, cp_cfz, jp_cfg, jpidta, jpjdta, jpkdta, jpiglo, jpjglo, &
248	& jpizoom, jpjzoom, jperio, ln_use_jattr
249	!!----------------------------------------------------------------------
250	!
251	cltxt = ''
252	cxios_context = 'nemo'
253	!
254	! ! Open reference namelist and configuration namelist files
255	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
256	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
257	!
258	REWIND( numnam_ref ) ! Namelist namctl in reference namelist : Control prints & Benchmark
259	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
260	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
261
262	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist : Control prints & Benchmark
263	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
264	902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
265
266	!
267	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist : Control prints & Benchmark
268	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
269	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
270
271	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist : Control prints & Benchmark
272	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
273	904 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
274
275	! Force values for AGRIF zoom (cf. agrif_user.F90)
276	#if defined key_agrif
277	IF( .NOT. Agrif_Root() ) THEN
278	jpiglo = nbcellsx + 2 + 2*nbghostcells
279	jpjglo = nbcellsy + 2 + 2*nbghostcells
280	jpi = ( jpiglo-2jpreci + (jpni-1+0) ) / jpni + 2jpreci
281	jpj = ( jpjglo-2jprecj + (jpnj-1+0) ) / jpnj + 2jprecj
282	jpidta = jpiglo
283	jpjdta = jpjglo
284	jpizoom = 1
285	jpjzoom = 1
286	nperio = 0
287	jperio = 0
288	ln_use_jattr = .false.
289	ENDIF
290	#endif
291	!
292	! !--------------------------------------------!
293	! ! set communicator & select the local node !
294	! ! NB: mynode also opens output.namelist.dyn !
295	! ! on unit number numond on first proc !
296	! !--------------------------------------------!
297	#if defined key_iomput
298	IF( Agrif_Root() ) THEN
299	IF( lk_oasis ) THEN
300	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
301	CALL xios_initialize( "not used",local_comm=ilocal_comm ) ! send nemo communicator to xios
302	ELSE
303	CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios
304	ENDIF
305	ENDIF
306	! Nodes selection (control print return in cltxt)
307	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
308	#else
309	IF( lk_oasis ) THEN
310	IF( Agrif_Root() ) THEN
311	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
312	ENDIF
313	! Nodes selection (control print return in cltxt)
314	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
315	ELSE
316	ilocal_comm = 0
317	! Nodes selection (control print return in cltxt)
318	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
319	ENDIF
320	#endif
321	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
322
323	lwm = (narea == 1) ! control of output namelists
324	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
325
326	IF(lwm) THEN
327	! write merged namelists from earlier to output namelist now that the
328	! file has been opened in call to mynode. nammpp has already been
329	! written in mynode (if lk_mpp_mpi)
330	WRITE( numond, namctl )
331	WRITE( numond, namcfg )
332	ENDIF
333
334	! If dimensions of processor grid weren't specified in the namelist file
335	! then we calculate them here now that we have our communicator size
336	IF( jpni < 1 .OR. jpnj < 1 ) THEN
337	#if defined key_mpp_mpi
338	IF( Agrif_Root() ) CALL nemo_partition( mppsize )
339	#else
340	jpni = 1
341	jpnj = 1
342	jpnij = jpni*jpnj
343	#endif
344	ENDIF
345
346	! Calculate domain dimensions given calculated jpni and jpnj
347	! This used to be done in par_oce.F90 when they were parameters rather than variables
348	IF( Agrif_Root() ) THEN
349	#if defined key_nemocice_decomp
350	jpi = ( nx_global+2-2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
351	jpj = ( ny_global+2-2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
352	#else
353	jpi = ( jpiglo -2jpreci + (jpni-1) ) / jpni + 2jpreci ! first dim.
354	jpj = ( jpjglo -2jprecj + (jpnj-1) ) / jpnj + 2jprecj ! second dim.
355	#endif
356	ENDIF
357	jpk = jpkdta ! third dim
358	#if defined key_agrif
359	! simple trick to use same vertical grid as parent but different number of levels:
360	! Save maximum number of levels in jpkdta, then define all vertical grids with this number.
361	! Suppress once vertical online interpolation is ok
362	IF(.NOT.Agrif_Root()) jpkdta = Agrif_Parent( jpkdta )
363	#endif
364	jpim1 = jpi-1 ! inner domain indices
365	jpjm1 = jpj-1 ! " "
366	jpkm1 = jpk-1 ! " "
367	jpij = jpi*jpj ! jpi x j
368
369	IF(lwp) THEN ! open listing units
370	!
371	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
372	!
373	WRITE(numout,*)
374	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
375	WRITE(numout,*) ' NEMO team'
376	WRITE(numout,*) ' Ocean General Circulation Model'
377	WRITE(numout,*) ' version 3.7 (2015) '
378	WRITE(numout,*)
379	WRITE(numout,*)
380	DO ji = 1, SIZE(cltxt)
381	IF( TRIM(cltxt(ji)) /= '' ) WRITE(numout,*) cltxt(ji) ! control print of mynode
382	END DO
383	WRITE(numout,cform_aaa) ! Flag AAAAAAA
384	!
385	ENDIF
386
387	! Now we know the dimensions of the grid and numout has been set we can
388	! allocate arrays
389	CALL nemo_alloc()
390
391	! !-------------------------------!
392	! ! NEMO general initialization !
393	! !-------------------------------!
394
395	CALL nemo_ctl ! Control prints & Benchmark
396
397	! ! Domain decomposition
398	IF( jpni*jpnj == jpnij ) THEN ; CALL mpp_init ! standard cutting out
399	ELSE ; CALL mpp_init2 ! eliminate land processors
400	ENDIF
401	!
402	IF( nn_timing == 1 ) CALL timing_init
403	!
404	! ! General initialization
405	CALL phy_cst ! Physical constants
406	CALL eos_init ! Equation of state
407	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
408	CALL dom_cfg ! Domain configuration
409	CALL dom_init ! Domain
410	IF( ln_crs ) CALL crs_init ! coarsened grid: domain initialization
411	IF( ln_nnogather ) CALL nemo_northcomms! northfold neighbour lists (must be done after the masks are defined)
412	IF( ln_ctl ) CALL prt_ctl_init ! Print control
413	CALL istate_init ! ocean initial state (Dynamics and tracers)
414
415	! ! external forcing
416	!!gm to be added : creation and call of sbc_apr_init
417	IF( lk_tide ) CALL tide_init( nit000 ) ! tidal harmonics
418	CALL sbc_init ! surface boundary conditions (including sea-ice)
419	!!gm ==>> bdy_init should call bdy_dta_init and bdytide_init NOT in nemogcm !!!
420	IF( lk_bdy ) CALL bdy_init ! Open boundaries initialisation
421	IF( lk_bdy ) CALL bdy_dta_init ! Open boundaries initialisation of external data arrays
422	IF( lk_bdy .AND. lk_tide ) &
423	& CALL bdytide_init ! Open boundaries initialisation of tidal harmonic forcing
424
425	! ! Ocean physics
426	! ! Vertical physics
427	CALL zdf_init ! namelist read
428	CALL zdf_bfr_init ! bottom friction
429	IF( lk_zdfric ) CALL zdf_ric_init ! Richardson number dependent Kz
430	IF( lk_zdftke ) CALL zdf_tke_init ! TKE closure scheme
431	IF( lk_zdfgls ) CALL zdf_gls_init ! GLS closure scheme
432	IF( lk_zdftmx ) CALL zdf_tmx_init ! tidal vertical mixing
433	IF( lk_zdfddm ) CALL zdf_ddm_init ! double diffusive mixing
434
435	! ! Lateral physics
436	CALL ldf_tra_init ! Lateral ocean tracer physics
437	CALL ldf_eiv_init ! eddy induced velocity param.
438	CALL ldf_dyn_init ! Lateral ocean momentum physics
439
440	! ! Active tracers
441	CALL tra_qsr_init ! penetrative solar radiation qsr
442	CALL tra_bbc_init ! bottom heat flux
443	IF( lk_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
444	CALL tra_dmp_init ! internal tracer damping
445	CALL tra_adv_init ! horizontal & vertical advection
446	CALL tra_ldf_init ! lateral mixing
447	CALL tra_zdf_init ! vertical mixing and after tracer fields
448
449	! ! Dynamics
450	IF( lk_c1d ) CALL dyn_dmp_init ! internal momentum damping
451	CALL dyn_adv_init ! advection (vector or flux form)
452	CALL dyn_vor_init ! vorticity term including Coriolis
453	CALL dyn_ldf_init ! lateral mixing
454	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
455	CALL dyn_zdf_init ! vertical diffusion
456	CALL dyn_spg_init ! surface pressure gradient
457
458	#if defined key_top
459	! ! Passive tracers
460	CALL trc_init
461	#endif
462	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
463
464	! ! Icebergs
465	CALL icb_init( rdt, nit000) ! initialise icebergs instance
466
467	! ! Misc. options
468	CALL sto_par_init ! Stochastic parametrization
469	IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations
470
471	! ! Diagnostics
472	IF( lk_floats ) CALL flo_init ! drifting Floats
473	IF( lk_diaar5 ) CALL dia_ar5_init ! ar5 diag
474	CALL dia_ptr_init ! Poleward TRansports initialization
475	IF( lk_diadct ) CALL dia_dct_init ! Sections tranports
476	CALL dia_hsb_init ! heat content, salt content and volume budgets
477	CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends
478	IF( lk_diaobs ) THEN ! Observation & model comparison
479	CALL dia_obs_init ! Initialize observational data
480	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
481	ENDIF
482	! ! Assimilation increments
483	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
484	IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
485	!
486	END SUBROUTINE nemo_init
487
488
489	SUBROUTINE nemo_ctl
490	!!----------------------------------------------------------------------
491	!! * ROUTINE nemo_ctl *
492	!!
493	!! ** Purpose : control print setting
494	!!
495	!! ** Method : - print namctl information and check some consistencies
496	!!----------------------------------------------------------------------
497	!
498	IF(lwp) THEN ! control print
499	WRITE(numout,*)
500	WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
501	WRITE(numout,*) '~~~~~~~ '
502	WRITE(numout,*) ' Namelist namctl'
503	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
504	WRITE(numout,*) ' level of print nn_print = ', nn_print
505	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
506	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
507	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
508	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
509	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
510	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
511	WRITE(numout,*) ' benchmark parameter (0/1) nn_bench = ', nn_bench
512	WRITE(numout,*) ' timing activated (0/1) nn_timing = ', nn_timing
513	ENDIF
514	!
515	nprint = nn_print ! convert DOCTOR namelist names into OLD names
516	nictls = nn_ictls
517	nictle = nn_ictle
518	njctls = nn_jctls
519	njctle = nn_jctle
520	isplt = nn_isplt
521	jsplt = nn_jsplt
522	nbench = nn_bench
523
524	IF(lwp) THEN ! control print
525	WRITE(numout,*)
526	WRITE(numout,*) 'namcfg : configuration initialization through namelist read'
527	WRITE(numout,*) '~~~~~~~ '
528	WRITE(numout,*) ' Namelist namcfg'
529	WRITE(numout,*) ' configuration name cp_cfg = ', TRIM(cp_cfg)
530	WRITE(numout,*) ' configuration zoom name cp_cfz = ', TRIM(cp_cfz)
531	WRITE(numout,*) ' configuration resolution jp_cfg = ', jp_cfg
532	WRITE(numout,*) ' 1st lateral dimension ( >= jpiglo ) jpidta = ', jpidta
533	WRITE(numout,*) ' 2nd " " ( >= jpjglo ) jpjdta = ', jpjdta
534	WRITE(numout,*) ' 3nd " " jpkdta = ', jpkdta
535	WRITE(numout,*) ' 1st dimension of global domain in i jpiglo = ', jpiglo
536	WRITE(numout,*) ' 2nd - - in j jpjglo = ', jpjglo
537	WRITE(numout,*) ' left bottom i index of the zoom (in data domain) jpizoom = ', jpizoom
538	WRITE(numout,*) ' left bottom j index of the zoom (in data domain) jpizoom = ', jpjzoom
539	WRITE(numout,*) ' lateral cond. type (between 0 and 6) jperio = ', jperio
540	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
541	ENDIF
542	! ! Parameter control
543	!
544	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
545	IF( lk_mpp .AND. jpnij > 1 ) THEN
546	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
547	ELSE
548	IF( isplt == 1 .AND. jsplt == 1 ) THEN
549	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
550	& ' - the print control will be done over the whole domain' )
551	ENDIF
552	ijsplt = isplt * jsplt ! total number of processors ijsplt
553	ENDIF
554	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
555	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
556	!
557	! ! indices used for the SUM control
558	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
559	lsp_area = .FALSE.
560	ELSE ! print control done over a specific area
561	lsp_area = .TRUE.
562	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
563	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
564	nictls = 1
565	ENDIF
566	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
567	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
568	nictle = jpiglo
569	ENDIF
570	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
571	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
572	njctls = 1
573	ENDIF
574	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
575	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
576	njctle = jpjglo
577	ENDIF
578	ENDIF
579	ENDIF
580	!
581	IF( nbench == 1 ) THEN ! Benchmark
582	SELECT CASE ( cp_cfg )
583	CASE ( 'gyre' ) ; CALL ctl_warn( ' The Benchmark is activated ' )
584	CASE DEFAULT ; CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:', &
585	& ' cp_cfg = "gyre" in namelist &namcfg or set nbench = 0' )
586	END SELECT
587	ENDIF
588	!
589	IF( 1_wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ', &
590	& 'f2003 standard. ' , &
591	& 'Compile with key_nosignedzero enabled' )
592	!
593	END SUBROUTINE nemo_ctl
594
595
596	SUBROUTINE nemo_closefile
597	!!----------------------------------------------------------------------
598	!! * ROUTINE nemo_closefile *
599	!!
600	!! ** Purpose : Close the files
601	!!----------------------------------------------------------------------
602	!
603	IF( lk_mpp ) CALL mppsync
604	!
605	CALL iom_close ! close all input/output files managed by iom_*
606	!
607	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
608	IF( numsol /= -1 ) CLOSE( numsol ) ! solver file
609	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
610	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
611	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
612	IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist
613	IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist
614	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
615	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
616	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
617	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
618	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
619	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
620	!
621	numout = 6 ! redefine numout in case it is used after this point...
622	!
623	END SUBROUTINE nemo_closefile
624
625
626	SUBROUTINE nemo_alloc
627	!!----------------------------------------------------------------------
628	!! * ROUTINE nemo_alloc *
629	!!
630	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
631	!!
632	!! ** Method :
633	!!----------------------------------------------------------------------
634	USE diawri , ONLY: dia_wri_alloc
635	USE dom_oce , ONLY: dom_oce_alloc
636	USE trc_oce , ONLY: trc_oce_alloc
637	#if defined key_diadct
638	USE diadct , ONLY: diadct_alloc
639	#endif
640	#if defined key_bdy
641	USE bdy_oce , ONLY: bdy_oce_alloc
642	#endif
643	!
644	INTEGER :: ierr
645	!!----------------------------------------------------------------------
646	!
647	ierr = oce_alloc () ! ocean
648	ierr = ierr + dia_wri_alloc ()
649	ierr = ierr + dom_oce_alloc () ! ocean domain
650	ierr = ierr + zdf_oce_alloc () ! ocean vertical physics
651	!
652	ierr = ierr + trc_oce_alloc () ! shared TRC / TRA arrays
653	!
654	#if defined key_diadct
655	ierr = ierr + diadct_alloc () !
656	#endif
657	#if defined key_bdy
658	ierr = ierr + bdy_oce_alloc () ! bdy masks (incl. initialization)
659	#endif
660	!
661	IF( lk_mpp ) CALL mpp_sum( ierr )
662	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
663	!
664	END SUBROUTINE nemo_alloc
665
666
667	SUBROUTINE nemo_partition( num_pes )
668	!!----------------------------------------------------------------------
669	!! * ROUTINE nemo_partition *
670	!!
671	!! ** Purpose :
672	!!
673	!! ** Method :
674	!!----------------------------------------------------------------------
675	INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
676	!
677	INTEGER, PARAMETER :: nfactmax = 20
678	INTEGER :: nfact ! The no. of factors returned
679	INTEGER :: ierr ! Error flag
680	INTEGER :: ji
681	INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
682	INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
683	!!----------------------------------------------------------------------
684	!
685	ierr = 0
686	!
687	CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
688	!
689	IF( nfact <= 1 ) THEN
690	WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
691	WRITE (numout, *) ' : using grid of ',num_pes,' x 1'
692	jpnj = 1
693	jpni = num_pes
694	ELSE
695	! Search through factors for the pair that are closest in value
696	mindiff = 1000000
697	imin = 1
698	DO ji = 1, nfact-1, 2
699	idiff = ABS( ifact(ji) - ifact(ji+1) )
700	IF( idiff < mindiff ) THEN
701	mindiff = idiff
702	imin = ji
703	ENDIF
704	END DO
705	jpnj = ifact(imin)
706	jpni = ifact(imin + 1)
707	ENDIF
708	!
709	jpnij = jpni*jpnj
710	!
711	END SUBROUTINE nemo_partition
712
713
714	SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
715	!!----------------------------------------------------------------------
716	!! * ROUTINE factorise *
717	!!
718	!! ** Purpose : return the prime factors of n.
719	!! knfax factors are returned in array kfax which is of
720	!! maximum dimension kmaxfax.
721	!! ** Method :
722	!!----------------------------------------------------------------------
723	INTEGER , INTENT(in ) :: kn, kmaxfax
724	INTEGER , INTENT( out) :: kerr, knfax
725	INTEGER, DIMENSION(kmaxfax), INTENT( out) :: kfax
726	!
727	INTEGER :: ifac, jl, inu
728	INTEGER, PARAMETER :: ntest = 14
729	INTEGER, DIMENSION(ntest) :: ilfax
730	!!----------------------------------------------------------------------
731	!
732	! lfax contains the set of allowed factors.
733	ilfax(:) = (/(2**jl,jl=ntest,1,-1)/)
734	!
735	! Clear the error flag and initialise output vars
736	kerr = 0
737	kfax = 1
738	knfax = 0
739	!
740	! Find the factors of n.
741	IF( kn == 1 ) GOTO 20
742
743	! nu holds the unfactorised part of the number.
744	! knfax holds the number of factors found.
745	! l points to the allowed factor list.
746	! ifac holds the current factor.
747	!
748	inu = kn
749	knfax = 0
750	!
751	DO jl = ntest, 1, -1
752	!
753	ifac = ilfax(jl)
754	IF( ifac > inu ) CYCLE
755
756	! Test whether the factor will divide.
757
758	IF( MOD(inu,ifac) == 0 ) THEN
759	!
760	knfax = knfax + 1 ! Add the factor to the list
761	IF( knfax > kmaxfax ) THEN
762	kerr = 6
763	write (,) 'FACTOR: insufficient space in factor array ', knfax
764	return
765	ENDIF
766	kfax(knfax) = ifac
767	! Store the other factor that goes with this one
768	knfax = knfax + 1
769	kfax(knfax) = inu / ifac
770	!WRITE (,) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
771	ENDIF
772	!
773	END DO
774	!
775	20 CONTINUE ! Label 20 is the exit point from the factor search loop.
776	!
777	END SUBROUTINE factorise
778
779	#if defined key_mpp_mpi
780
781	SUBROUTINE nemo_northcomms
782	!!----------------------------------------------------------------------
783	!! * ROUTINE nemo_northcomms *
784	!! ** Purpose : Setup for north fold exchanges with explicit
785	!! point-to-point messaging
786	!!
787	!! ** Method : Initialization of the northern neighbours lists.
788	!!----------------------------------------------------------------------
789	!! 1.0 ! 2011-10 (A. C. Coward, NOCS & J. Donners, PRACE)
790	!! 2.0 ! 2013-06 Setup avoiding MPI communication (I. Epicoco, S. Mocavero, CMCC)
791	!!----------------------------------------------------------------------
792	INTEGER :: sxM, dxM, sxT, dxT, jn
793	INTEGER :: njmppmax
794	!!----------------------------------------------------------------------
795	!
796	njmppmax = MAXVAL( njmppt )
797	!
798	!initializes the north-fold communication variables
799	isendto(:) = 0
800	nsndto = 0
801	!
802	!if I am a process in the north
803	IF ( njmpp == njmppmax ) THEN
804	!sxM is the first point (in the global domain) needed to compute the
805	!north-fold for the current process
806	sxM = jpiglo - nimppt(narea) - nlcit(narea) + 1
807	!dxM is the last point (in the global domain) needed to compute the
808	!north-fold for the current process
809	dxM = jpiglo - nimppt(narea) + 2
810
811	!loop over the other north-fold processes to find the processes
812	!managing the points belonging to the sxT-dxT range
813
814	DO jn = 1, jpni
815	!sxT is the first point (in the global domain) of the jn
816	!process
817	sxT = nfiimpp(jn, jpnj)
818	!dxT is the last point (in the global domain) of the jn
819	!process
820	dxT = nfiimpp(jn, jpnj) + nfilcit(jn, jpnj) - 1
821	IF ((sxM .gt. sxT) .AND. (sxM .lt. dxT)) THEN
822	nsndto = nsndto + 1
823	isendto(nsndto) = jn
824	ELSEIF ((sxM .le. sxT) .AND. (dxM .ge. dxT)) THEN
825	nsndto = nsndto + 1
826	isendto(nsndto) = jn
827	ELSEIF ((dxM .lt. dxT) .AND. (sxT .lt. dxM)) THEN
828	nsndto = nsndto + 1
829	isendto(nsndto) = jn
830	END IF
831	END DO
832	nfsloop = 1
833	nfeloop = nlci
834	DO jn = 2,jpni-1
835	IF(nfipproc(jn,jpnj) .eq. (narea - 1)) THEN
836	IF (nfipproc(jn - 1 ,jpnj) .eq. -1) THEN
837	nfsloop = nldi
838	ENDIF
839	IF (nfipproc(jn + 1,jpnj) .eq. -1) THEN
840	nfeloop = nlei
841	ENDIF
842	ENDIF
843	END DO
844
845	ENDIF
846	l_north_nogather = .TRUE.
847	END SUBROUTINE nemo_northcomms
848
849	#else
850	SUBROUTINE nemo_northcomms ! Dummy routine
851	WRITE(,) 'nemo_northcomms: You should not have seen this print! error?'
852	END SUBROUTINE nemo_northcomms
853	#endif
854
855	!!======================================================================
856	END MODULE nemogcm
857

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

Download in other formats: