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

Context Navigation

source: branches/2016/dev_r6409_SIMPLIF_2_usrdef/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 7188

Last change on this file since 7188 was 7188, checked in by gm, 7 years ago
#1692 - branch SIMPLIF_2_usrdef: e3.=dk[dep.] (discret derivative)
Property svn:keywords set to `Id`
File size: 41.8 KB

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

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

Download in other formats: