Context Navigation

nemogcm.F90 @ 15814

Last change on this file since 15814 was 11367, checked in by dancopsey, 5 years ago
More print statements including fix
File size: 36.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) 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	!! - ! 2011-11 (C. Harris) decomposition changes for running with CICE
31	!! 3.6 ! 2012-05 (C. Calone, J. Simeon, G. Madec, C. Ethe) Add grid coarsening
32	!! - ! 2014-12 (G. Madec) remove KPP scheme and cross-land advection (cla)
33	!! 4.0 ! 2016-10 (G. Madec, S. Flavoni) domain configuration / user defined interface
34	!!----------------------------------------------------------------------
35
36	!!----------------------------------------------------------------------
37	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
38	!! nemo_init : initialization of the NEMO system
39	!! nemo_ctl : initialisation of the contol print
40	!! nemo_closefile: close remaining open files
41	!! nemo_alloc : dynamical allocation
42	!!----------------------------------------------------------------------
43	USE step_oce ! module used in the ocean time stepping module (step.F90)
44	USE phycst ! physical constant (par_cst routine)
45	USE domain ! domain initialization (dom_init & dom_cfg routines)
46	USE closea ! treatment of closed seas (for ln_closea)
47	USE usrdef_nam ! user defined configuration
48	USE tideini ! tidal components initialization (tide_ini routine)
49	USE bdy_oce, ONLY : ln_bdy
50	USE bdyini ! open boundary cond. setting (bdy_init routine)
51	USE istate ! initial state setting (istate_init routine)
52	USE ldfdyn ! lateral viscosity setting (ldfdyn_init routine)
53	USE ldftra ! lateral diffusivity setting (ldftra_init routine)
54	USE trdini ! dyn/tra trends initialization (trd_init routine)
55	USE asminc ! assimilation increments
56	USE asmbkg ! writing out state trajectory
57	USE diaptr ! poleward transports (dia_ptr_init routine)
58	USE diadct ! sections transports (dia_dct_init routine)
59	USE diaobs ! Observation diagnostics (dia_obs_init routine)
60	USE diacfl ! CFL diagnostics (dia_cfl_init routine)
61	USE step ! NEMO time-stepping (stp routine)
62	USE icbini ! handle bergs, initialisation
63	USE icbstp ! handle bergs, calving, themodynamics and transport
64	USE cpl_oasis3 ! OASIS3 coupling
65	USE c1d ! 1D configuration
66	USE step_c1d ! Time stepping loop for the 1D configuration
67	USE dyndmp ! Momentum damping
68	USE stopar ! Stochastic param.: ???
69	USE stopts ! Stochastic param.: ???
70	USE diurnal_bulk ! diurnal bulk SST
71	USE step_diu ! diurnal bulk SST timestepping (called from here if run offline)
72	USE crsini ! initialise grid coarsening utility
73	USE diatmb ! Top,middle,bottom output
74	USE dia25h ! 25h mean output
75	USE sbc_oce , ONLY : lk_oasis
76	USE wet_dry ! Wetting and drying setting (wad_init routine)
77	USE ice
78	#if defined key_top
79	USE trcini ! passive tracer initialisation
80	#endif
81	#if defined key_nemocice_decomp
82	USE ice_domain_size, only: nx_global, ny_global
83	#endif
84	!
85	USE lib_mpp ! distributed memory computing
86	USE mppini ! shared/distributed memory setting (mpp_init routine)
87	USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
88	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
89	#if defined key_iomput
90	USE xios ! xIOserver
91	#endif
92	#if defined key_agrif
93	USE agrif_all_update ! Master Agrif update
94	#endif
95
96	IMPLICIT NONE
97	PRIVATE
98
99	PUBLIC nemo_gcm ! called by model.F90
100	PUBLIC nemo_init ! needed by AGRIF
101	PUBLIC nemo_alloc ! needed by TAM
102
103	CHARACTER(lc) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
104
105	#if defined key_mpp_mpi
106	INCLUDE 'mpif.h'
107	#endif
108
109	!!----------------------------------------------------------------------
110	!! NEMO/OCE 4.0 , NEMO Consortium (2018)
111	!! $Id$
112	!! Software governed by the CeCILL license (see ./LICENSE)
113	!!----------------------------------------------------------------------
114	CONTAINS
115
116	SUBROUTINE nemo_gcm
117	!!----------------------------------------------------------------------
118	!! * ROUTINE nemo_gcm *
119	!!
120	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
121	!! curvilinear mesh on the sphere.
122	!!
123	!! ** Method : - model general initialization
124	!! - launch the time-stepping (stp routine)
125	!! - finalize the run by closing files and communications
126	!!
127	!! References : Madec, Delecluse, Imbard, and Levy, 1997: internal report, IPSL.
128	!! Madec, 2008, internal report, IPSL.
129	!!----------------------------------------------------------------------
130	INTEGER :: istp ! time step index
131	!!----------------------------------------------------------------------
132	!
133	#if defined key_agrif
134	CALL Agrif_Init_Grids() ! AGRIF: set the meshes
135	#endif
136	! !-----------------------!
137	CALL nemo_init !== Initialisations ==!
138	! !-----------------------!
139	#if defined key_agrif
140	CALL Agrif_Declare_Var_dom ! AGRIF: set the meshes for DOM
141	CALL Agrif_Declare_Var ! " " " " " DYN/TRA
142	# if defined key_top
143	CALL Agrif_Declare_Var_top ! " " " " " TOP
144	# endif
145	# if defined key_si3
146	CALL Agrif_Declare_Var_ice ! " " " " " Sea ice
147	# endif
148	#endif
149	! check that all process are still there... If some process have an error,
150	! they will never enter in step and other processes will wait until the end of the cpu time!
151	CALL mpp_max( 'nemogcm', nstop )
152
153	IF(narea == 419) THEN
154	OPEN(9419, file='crash_stats_419.out', status='replace')
155	WRITE(9419,*) 'Opening output file'
156	ENDIF
157
158	IF(narea == 68) THEN
159	OPEN(968, file='crash_stats_68.out', status='replace')
160	WRITE(968,*) 'Opening output file'
161	ENDIF
162
163	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
164
165	! !-----------------------!
166	! !== time stepping ==!
167	! !-----------------------!
168	istp = nit000
169
170	IF(narea == 68) THEN
171	WRITE(968,*) 'in step before any steps: u_ice = ',SUM(u_ice)
172	WRITE(968,*) 'v_ice(54,0:2) = ',SUM(v_ice)
173	WRITE(968,*) 'h_i(54,0:2) = ',SUM(h_i)
174	WRITE(968,*) 'h_s(54,0:2) = ',SUM(h_s)
175	WRITE(968,*) 'v_i(54,0:2) = ',SUM(v_i)
176	WRITE(968,*) 'sv_i(54,0:2) = ',SUM(sv_i)
177	WRITE(968,*) 'e_s(54,0:2) = ',SUM(e_s)
178	WRITE(968,*) 'e_i(54,0:2) = ',SUM(e_i)
179	ENDIF
180
181	! Initialise emp to zero
182	emp(:,:) = 0.0
183
184	!
185	#if defined key_c1d
186	DO WHILE ( istp <= nitend .AND. nstop == 0 ) !== C1D time-stepping ==!
187	CALL stp_c1d( istp )
188	istp = istp + 1
189	END DO
190	#else
191	!
192	# if defined key_agrif
193	! !== AGRIF time-stepping ==!
194	CALL Agrif_Regrid()
195	!
196	! Recursive update from highest nested level to lowest:
197	CALL Agrif_step_child_adj(Agrif_Update_All)
198	!
199	DO WHILE( istp <= nitend .AND. nstop == 0 )
200	CALL stp
201	istp = istp + 1
202	END DO
203	!
204	IF( .NOT. Agrif_Root() ) THEN
205	CALL Agrif_ParentGrid_To_ChildGrid()
206	IF( ln_diaobs ) CALL dia_obs_wri
207	IF( ln_timing ) CALL timing_finalize
208	CALL Agrif_ChildGrid_To_ParentGrid()
209	ENDIF
210	!
211	# else
212	!
213	IF( .NOT.ln_diurnal_only ) THEN !== Standard time-stepping ==!
214	!
215	DO WHILE( istp <= nitend .AND. nstop == 0 )
216	#if defined key_mpp_mpi
217	ncom_stp = istp
218	IF ( istp == ( nit000 + 1 ) ) elapsed_time = MPI_Wtime()
219	IF ( istp == nitend ) elapsed_time = MPI_Wtime() - elapsed_time
220	#endif
221	CALL stp ( istp )
222	istp = istp + 1
223	END DO
224	!
225	ELSE !== diurnal SST time-steeping only ==!
226	!
227	DO WHILE( istp <= nitend .AND. nstop == 0 )
228	CALL stp_diurnal( istp ) ! time step only the diurnal SST
229	istp = istp + 1
230	END DO
231	!
232	ENDIF
233	!
234	# endif
235	!
236	#endif
237	!
238	IF( ln_diaobs ) CALL dia_obs_wri
239	!
240	IF( ln_icebergs ) CALL icb_end( nitend )
241
242	! !------------------------!
243	! !== finalize the run ==!
244	! !------------------------!
245	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
246	CLOSE(unit=9419)
247	CLOSE(unit=968)
248	!
249	IF( nstop /= 0 .AND. lwp ) THEN ! error print
250	WRITE(numout,cform_err)
251	WRITE(numout,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found'
252	WRITE(numout,*)
253	ENDIF
254	!
255	IF( ln_timing ) CALL timing_finalize
256	!
257	CALL nemo_closefile
258	!
259	#if defined key_iomput
260	CALL xios_finalize ! end mpp communications with xios
261	IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS
262	#else
263	IF ( lk_oasis ) THEN ; CALL cpl_finalize ! end coupling and mpp communications with OASIS
264	ELSEIF( lk_mpp ) THEN ; CALL mppstop( ldfinal = .TRUE. ) ! end mpp communications
265	ENDIF
266	#endif
267	!
268	IF(lwm) THEN
269	IF( nstop == 0 ) THEN ; STOP 0
270	ELSE ; STOP 999
271	ENDIF
272	ENDIF
273	!
274	END SUBROUTINE nemo_gcm
275
276
277	SUBROUTINE nemo_init
278	!!----------------------------------------------------------------------
279	!! * ROUTINE nemo_init *
280	!!
281	!! ** Purpose : initialization of the NEMO GCM
282	!!----------------------------------------------------------------------
283	INTEGER :: ji ! dummy loop indices
284	INTEGER :: ios, ilocal_comm ! local integers
285	CHARACTER(len=120), DIMENSION(60) :: cltxt, cltxt2, clnam
286	!!
287	NAMELIST/namctl/ ln_ctl , sn_cfctl, nn_print, nn_ictls, nn_ictle, &
288	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
289	& ln_timing, ln_diacfl
290	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
291	!!----------------------------------------------------------------------
292	!
293	cltxt = ''
294	cltxt2 = ''
295	clnam = ''
296	cxios_context = 'nemo'
297	!
298	! ! Open reference namelist and configuration namelist files
299	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
300	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
301	!
302	REWIND( numnam_ref ) ! Namelist namctl in reference namelist
303	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
304	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
305	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist
306	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
307	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
308	!
309	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist
310	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
311	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
312	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist
313	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
314	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
315
316	! !--------------------------!
317	! ! Set global domain size ! (control print return in cltxt2)
318	! !--------------------------!
319	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
320	CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
321	!
322	ELSE ! user-defined namelist
323	CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
324	ENDIF
325	!
326	!
327	! !--------------------------------------------!
328	! ! set communicator & select the local node !
329	! ! NB: mynode also opens output.namelist.dyn !
330	! ! on unit number numond on first proc !
331	! !--------------------------------------------!
332	#if defined key_iomput
333	IF( Agrif_Root() ) THEN
334	IF( lk_oasis ) THEN
335	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
336	CALL xios_initialize( "not used" ,local_comm= ilocal_comm ) ! send nemo communicator to xios
337	ELSE
338	CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios
339	ENDIF
340	ENDIF
341	! Nodes selection (control print return in cltxt)
342	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
343	#else
344	IF( lk_oasis ) THEN
345	IF( Agrif_Root() ) THEN
346	CALL cpl_init( "oceanx", ilocal_comm ) ! nemo local communicator given by oasis
347	ENDIF
348	! Nodes selection (control print return in cltxt)
349	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
350	ELSE
351	ilocal_comm = 0 ! Nodes selection (control print return in cltxt)
352	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
353	ENDIF
354	#endif
355
356	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
357
358	IF( sn_cfctl%l_config ) THEN
359	! Activate finer control of report outputs
360	! optionally switch off output from selected areas (note this only
361	! applies to output which does not involve global communications)
362	IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax ) .OR. &
363	& ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) ) &
364	& CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
365	ELSE
366	! Use ln_ctl to turn on or off all options.
367	CALL nemo_set_cfctl( sn_cfctl, ln_ctl, .TRUE. )
368	ENDIF
369
370	lwm = (narea == 1) ! control of output namelists
371	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
372
373	IF(lwm) THEN ! write merged namelists from earlier to output namelist
374	! ! now that the file has been opened in call to mynode.
375	! ! NB: nammpp has already been written in mynode (if lk_mpp_mpi)
376	WRITE( numond, namctl )
377	WRITE( numond, namcfg )
378	IF( .NOT.ln_read_cfg ) THEN
379	DO ji = 1, SIZE(clnam)
380	IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print
381	END DO
382	ENDIF
383	ENDIF
384
385	IF(lwp) THEN ! open listing units
386	!
387	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
388	!
389	WRITE(numout,*)
390	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
391	WRITE(numout,*) ' NEMO team'
392	WRITE(numout,*) ' Ocean General Circulation Model'
393	WRITE(numout,*) ' NEMO version 4.0 (2019) '
394	WRITE(numout,*)
395	WRITE(numout,*) " ._ ._ ._ ._ ._ "
396	WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
397	WRITE(numout,*)
398	WRITE(numout,*) " o _, _, "
399	WRITE(numout,*) " o .' ( .-' / "
400	WRITE(numout,*) " o _/..._'. .' / "
401	WRITE(numout,*) " ( o .-'` ` '-./ _.' "
402	WRITE(numout,*) " ) ( o) ;= <_ ( "
403	WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) "
404	WRITE(numout,*) " ) ) \) \|`\ \) '. \ ( ( "
405	WRITE(numout,*) " ( ( \_/ '-._\ ) ) "
406	WRITE(numout,*) " ) ) jgs ` ( ( "
407	WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
408	WRITE(numout,*)
409
410	DO ji = 1, SIZE(cltxt)
411	IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) TRIM(cltxt(ji)) ! control print of mynode
412	END DO
413	WRITE(numout,*)
414	WRITE(numout,*)
415	DO ji = 1, SIZE(cltxt2)
416	IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) TRIM(cltxt2(ji)) ! control print of domain size
417	END DO
418	!
419	WRITE(numout,cform_aaa) ! Flag AAAAAAA
420	!
421	ENDIF
422	! open /dev/null file to be able to supress output write easily
423	CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
424	!
425	! ! Domain decomposition
426	CALL mpp_init ! MPP
427
428	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
429	CALL nemo_alloc()
430
431	! !-------------------------------!
432	! ! NEMO general initialization !
433	! !-------------------------------!
434
435	CALL nemo_ctl ! Control prints
436	!
437	! ! General initialization
438	IF( ln_timing ) CALL timing_init ! timing
439	IF( ln_timing ) CALL timing_start( 'nemo_init')
440	!
441	CALL phy_cst ! Physical constants
442	CALL eos_init ! Equation of state
443	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
444	CALL wad_init ! Wetting and drying options
445	CALL dom_init("OPA") ! Domain
446	IF( ln_crs ) CALL crs_init ! coarsened grid: domain initialization
447	IF( ln_ctl ) CALL prt_ctl_init ! Print control
448
449	CALL diurnal_sst_bulk_init ! diurnal sst
450	IF( ln_diurnal ) CALL diurnal_sst_coolskin_init ! cool skin
451	!
452	IF( ln_diurnal_only ) THEN ! diurnal only: a subset of the initialisation routines
453	CALL istate_init ! ocean initial state (Dynamics and tracers)
454	CALL sbc_init ! Forcings : surface module
455	CALL tra_qsr_init ! penetrative solar radiation qsr
456	IF( ln_diaobs ) THEN ! Observation & model comparison
457	CALL dia_obs_init ! Initialize observational data
458	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
459	ENDIF
460	IF( lk_asminc ) CALL asm_inc_init ! Assimilation increments
461	!
462	RETURN ! end of initialization
463	ENDIF
464
465	CALL istate_init ! ocean initial state (Dynamics and tracers)
466
467	! ! external forcing
468	CALL tide_init ! tidal harmonics
469	CALL sbc_init ! surface boundary conditions (including sea-ice)
470	CALL bdy_init ! Open boundaries initialisation
471
472	! ! Ocean physics
473	CALL zdf_phy_init ! Vertical physics
474
475	! ! Lateral physics
476	CALL ldf_tra_init ! Lateral ocean tracer physics
477	CALL ldf_eiv_init ! eddy induced velocity param.
478	CALL ldf_dyn_init ! Lateral ocean momentum physics
479
480	! ! Active tracers
481	IF( ln_traqsr ) CALL tra_qsr_init ! penetrative solar radiation qsr
482	CALL tra_bbc_init ! bottom heat flux
483	CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
484	CALL tra_dmp_init ! internal tracer damping
485	CALL tra_adv_init ! horizontal & vertical advection
486	CALL tra_ldf_init ! lateral mixing
487
488	! ! Dynamics
489	IF( lk_c1d ) CALL dyn_dmp_init ! internal momentum damping
490	CALL dyn_adv_init ! advection (vector or flux form)
491	CALL dyn_vor_init ! vorticity term including Coriolis
492	CALL dyn_ldf_init ! lateral mixing
493	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
494	CALL dyn_spg_init ! surface pressure gradient
495
496	#if defined key_top
497	! ! Passive tracers
498	CALL trc_init
499	#endif
500	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
501
502	! ! Icebergs
503	CALL icb_init( rdt, nit000) ! initialise icebergs instance
504
505	! ! Misc. options
506	CALL sto_par_init ! Stochastic parametrization
507	IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations
508
509	! ! Diagnostics
510	IF( lk_floats ) CALL flo_init ! drifting Floats
511	IF( ln_diacfl ) CALL dia_cfl_init ! Initialise CFL diagnostics
512	CALL dia_ptr_init ! Poleward TRansports initialization
513	IF( lk_diadct ) CALL dia_dct_init ! Sections tranports
514	CALL dia_hsb_init ! heat content, salt content and volume budgets
515	CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends
516	CALL dia_obs_init ! Initialize observational data
517	CALL dia_tmb_init ! TMB outputs
518	CALL dia_25h_init ! 25h mean outputs
519	IF( ln_diaobs ) CALL dia_obs( nit000-1 ) ! Observation operator for restart
520
521	! ! Assimilation increments
522	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
523	!
524	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
525	!
526	IF( ln_timing ) CALL timing_stop( 'nemo_init')
527	!
528	END SUBROUTINE nemo_init
529
530
531	SUBROUTINE nemo_ctl
532	!!----------------------------------------------------------------------
533	!! * ROUTINE nemo_ctl *
534	!!
535	!! ** Purpose : control print setting
536	!!
537	!! ** Method : - print namctl information and check some consistencies
538	!!----------------------------------------------------------------------
539	!
540	IF(lwp) THEN ! control print
541	WRITE(numout,*)
542	WRITE(numout,*) 'nemo_ctl: Control prints'
543	WRITE(numout,*) '~~~~~~~~'
544	WRITE(numout,*) ' Namelist namctl'
545	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
546	WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config
547	WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
548	WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
549	WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout
550	WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout
551	WRITE(numout,*) ' sn_cfctl%l_mppout = ', sn_cfctl%l_mppout
552	WRITE(numout,*) ' sn_cfctl%l_mpptop = ', sn_cfctl%l_mpptop
553	WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin
554	WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax
555	WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr
556	WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr
557	WRITE(numout,*) ' level of print nn_print = ', nn_print
558	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
559	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
560	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
561	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
562	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
563	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
564	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
565	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
566	ENDIF
567	!
568	nprint = nn_print ! convert DOCTOR namelist names into OLD names
569	nictls = nn_ictls
570	nictle = nn_ictle
571	njctls = nn_jctls
572	njctle = nn_jctle
573	isplt = nn_isplt
574	jsplt = nn_jsplt
575
576	IF(lwp) THEN ! control print
577	WRITE(numout,*)
578	WRITE(numout,*) ' Namelist namcfg'
579	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
580	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
581	WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea
582	WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg
583	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
584	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
585	ENDIF
586	IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file
587	!
588	! ! Parameter control
589	!
590	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
591	IF( lk_mpp .AND. jpnij > 1 ) THEN
592	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
593	ELSE
594	IF( isplt == 1 .AND. jsplt == 1 ) THEN
595	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
596	& ' - the print control will be done over the whole domain' )
597	ENDIF
598	ijsplt = isplt * jsplt ! total number of processors ijsplt
599	ENDIF
600	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
601	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
602	!
603	! ! indices used for the SUM control
604	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
605	lsp_area = .FALSE.
606	ELSE ! print control done over a specific area
607	lsp_area = .TRUE.
608	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
609	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
610	nictls = 1
611	ENDIF
612	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
613	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
614	nictle = jpiglo
615	ENDIF
616	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
617	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
618	njctls = 1
619	ENDIF
620	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
621	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
622	njctle = jpjglo
623	ENDIF
624	ENDIF
625	ENDIF
626	!
627	IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', &
628	& 'Compile with key_nosignedzero enabled:', &
629	& '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
630	!
631	#if defined key_agrif
632	IF( ln_timing ) CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
633	#endif
634	!
635	END SUBROUTINE nemo_ctl
636
637
638	SUBROUTINE nemo_closefile
639	!!----------------------------------------------------------------------
640	!! * ROUTINE nemo_closefile *
641	!!
642	!! ** Purpose : Close the files
643	!!----------------------------------------------------------------------
644	!
645	IF( lk_mpp ) CALL mppsync
646	!
647	CALL iom_close ! close all input/output files managed by iom_*
648	!
649	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
650	IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file
651	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
652	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
653	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
654	IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist
655	IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist
656	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
657	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
658	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
659	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
660	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
661	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
662	!
663	numout = 6 ! redefine numout in case it is used after this point...
664	!
665	END SUBROUTINE nemo_closefile
666
667
668	SUBROUTINE nemo_alloc
669	!!----------------------------------------------------------------------
670	!! * ROUTINE nemo_alloc *
671	!!
672	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
673	!!
674	!! ** Method :
675	!!----------------------------------------------------------------------
676	USE diawri , ONLY : dia_wri_alloc
677	USE dom_oce , ONLY : dom_oce_alloc
678	USE trc_oce , ONLY : trc_oce_alloc
679	USE bdy_oce , ONLY : bdy_oce_alloc
680	#if defined key_diadct
681	USE diadct , ONLY : diadct_alloc
682	#endif
683	!
684	INTEGER :: ierr
685	!!----------------------------------------------------------------------
686	!
687	ierr = oce_alloc () ! ocean
688	ierr = ierr + dia_wri_alloc()
689	ierr = ierr + dom_oce_alloc() ! ocean domain
690	ierr = ierr + zdf_oce_alloc() ! ocean vertical physics
691	ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays
692	ierr = ierr + bdy_oce_alloc() ! bdy masks (incl. initialization)
693	!
694	#if defined key_diadct
695	ierr = ierr + diadct_alloc () !
696	#endif
697	!
698	CALL mpp_sum( 'nemogcm', ierr )
699	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
700	!
701	END SUBROUTINE nemo_alloc
702
703	SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
704	!!----------------------------------------------------------------------
705	!! * ROUTINE nemo_set_cfctl *
706	!!
707	!! ** Purpose : Set elements of the output control structure to setto.
708	!! for_all should be .false. unless all areas are to be
709	!! treated identically.
710	!!
711	!! ** Method : Note this routine can be used to switch on/off some
712	!! types of output for selected areas but any output types
713	!! that involve global communications (e.g. mpp_max, glob_sum)
714	!! should be protected from selective switching by the
715	!! for_all argument
716	!!----------------------------------------------------------------------
717	LOGICAL :: setto, for_all
718	TYPE(sn_ctl) :: sn_cfctl
719	!!----------------------------------------------------------------------
720	IF( for_all ) THEN
721	sn_cfctl%l_runstat = setto
722	sn_cfctl%l_trcstat = setto
723	ENDIF
724	sn_cfctl%l_oceout = setto
725	sn_cfctl%l_layout = setto
726	sn_cfctl%l_mppout = setto
727	sn_cfctl%l_mpptop = setto
728	END SUBROUTINE nemo_set_cfctl
729
730	!!======================================================================
731	END MODULE nemogcm
732

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

New URL for NEMO forge! http://forge.nemo-ocean.eu

Context Navigation

source: NEMO/branches/UKMO/NEMO_4.0_GO8_coupled_iodef/src/OCE/nemogcm.F90 @ 15814

Download in other formats: