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

Context Navigation

source: branches/UKMO/dev_r5518_GO6_package_inc_asm/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 8042

Last change on this file since 8042 was 8042, checked in by jwhile, 7 years ago
Further merge of FOAM_local
File size: 40.0 KB

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

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

Download in other formats: