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

Context Navigation

source: branches/2015/dev_r5721_CNRS9_NOC3_LDF/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 5758

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

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

Download in other formats: