Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

nemogcm.F90 @ 13375

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

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

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

Context Navigation

source: branches/UKMO/dev_1d_bugfixes_BoB/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 13375

Download in other formats: