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

Context Navigation

source: branches/UKMO/dev_r5518_GO6_package_FOAMv14_STOPACK/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 11394

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

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

Download in other formats: