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

Context Navigation

source: branches/UKMO/dev_r5518_GO6_starthour_obsoper/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 13070

Last change on this file since 13070 was 13070, checked in by timgraham, 4 years ago
Added control over printing of iceshelf mass information
File size: 44.3 KB

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

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

Download in other formats: