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

Context Navigation

source: branches/2015/dev_r4826_NOC_WAD/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 5014

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

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

Download in other formats: