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

Context Navigation

source: branches/2015/dev_r5803_NOC_WAD/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 5842

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

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

Download in other formats: