Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

nemogcm.F90 @ 11738

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

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_r5518_GO6_under_ice_relax_dr_hook/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 11738

Download in other formats: