Context Navigation

nemogcm.F90

Last change on this file was 11105, checked in by dancopsey, 5 years ago
Merged in changes from dev_merge_2017_GC_couple_pkg branch except for zotx1 and zoty1 changes in sbccpl.F90.
File size: 35.7 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	#if defined key_top
78	USE trcini ! passive tracer initialisation
79	#endif
80	#if defined key_nemocice_decomp
81	USE ice_domain_size, only: nx_global, ny_global
82	#endif
83	!
84	USE lib_mpp ! distributed memory computing
85	USE mppini ! shared/distributed memory setting (mpp_init routine)
86	USE lbcnfd , ONLY : isendto, nsndto, nfsloop, nfeloop ! Setup of north fold exchanges
87	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
88	USE sbccpl
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(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
154
155	! !-----------------------!
156	! !== time stepping ==!
157	! !-----------------------!
158	istp = nit000
159	!
160	#if defined key_c1d
161	DO WHILE ( istp <= nitend .AND. nstop == 0 ) !== C1D time-stepping ==!
162	CALL stp_c1d( istp )
163	istp = istp + 1
164	END DO
165	#else
166	!
167	# if defined key_agrif
168	! !== AGRIF time-stepping ==!
169	CALL Agrif_Regrid()
170	!
171	! Recursive update from highest nested level to lowest:
172	CALL Agrif_step_child_adj(Agrif_Update_All)
173	!
174	DO WHILE( istp <= nitend .AND. nstop == 0 )
175	CALL stp
176	istp = istp + 1
177	END DO
178	!
179	IF( .NOT. Agrif_Root() ) THEN
180	CALL Agrif_ParentGrid_To_ChildGrid()
181	IF( ln_diaobs ) CALL dia_obs_wri
182	IF( ln_timing ) CALL timing_finalize
183	CALL Agrif_ChildGrid_To_ParentGrid()
184	ENDIF
185	!
186	# else
187	!
188	IF( .NOT.ln_diurnal_only ) THEN !== Standard time-stepping ==!
189	!
190	DO WHILE( istp <= nitend .AND. nstop == 0 )
191	#if defined key_mpp_mpi
192	ncom_stp = istp
193	IF ( istp == ( nit000 + 1 ) ) elapsed_time = MPI_Wtime()
194	IF ( istp == nitend ) elapsed_time = MPI_Wtime() - elapsed_time
195	#endif
196	IF (lk_oasis) THEN
197	CALL sbc_cpl_snd( istp ) ! Coupling to atmos
198	ENDIF
199	CALL stp ( istp )
200	istp = istp + 1
201	END DO
202	!
203	ELSE !== diurnal SST time-steeping only ==!
204	!
205	DO WHILE( istp <= nitend .AND. nstop == 0 )
206	CALL stp_diurnal( istp ) ! time step only the diurnal SST
207	istp = istp + 1
208	END DO
209	!
210	ENDIF
211	!
212	# endif
213	!
214	#endif
215	!
216	IF( ln_diaobs ) CALL dia_obs_wri
217	!
218	IF( ln_icebergs ) CALL icb_end( nitend )
219
220	! !------------------------!
221	! !== finalize the run ==!
222	! !------------------------!
223	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
224	!
225	IF( nstop /= 0 .AND. lwp ) THEN ! error print
226	WRITE(numout,cform_err)
227	WRITE(numout,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found'
228	WRITE(numout,*)
229	ENDIF
230	!
231	IF( ln_timing ) CALL timing_finalize
232	!
233	CALL nemo_closefile
234	!
235	#if defined key_iomput
236	CALL xios_finalize ! end mpp communications with xios
237	IF( lk_oasis ) CALL cpl_finalize ! end coupling and mpp communications with OASIS
238	#else
239	IF ( lk_oasis ) THEN ; CALL cpl_finalize ! end coupling and mpp communications with OASIS
240	ELSEIF( lk_mpp ) THEN ; CALL mppstop( ldfinal = .TRUE. ) ! end mpp communications
241	ENDIF
242	#endif
243	!
244	IF(lwm) THEN
245	IF( nstop == 0 ) THEN ; STOP 0
246	ELSE ; STOP 999
247	ENDIF
248	ENDIF
249	!
250	END SUBROUTINE nemo_gcm
251
252
253	SUBROUTINE nemo_init
254	!!----------------------------------------------------------------------
255	!! * ROUTINE nemo_init *
256	!!
257	!! ** Purpose : initialization of the NEMO GCM
258	!!----------------------------------------------------------------------
259	INTEGER :: ji ! dummy loop indices
260	INTEGER :: ios, ilocal_comm ! local integers
261	CHARACTER(len=120), DIMENSION(60) :: cltxt, cltxt2, clnam
262	!!
263	NAMELIST/namctl/ ln_ctl , sn_cfctl, nn_print, nn_ictls, nn_ictle, &
264	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
265	& ln_timing, ln_diacfl
266	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
267	!!----------------------------------------------------------------------
268	!
269	cltxt = ''
270	cltxt2 = ''
271	clnam = ''
272	cxios_context = 'nemo'
273	!
274	! ! Open reference namelist and configuration namelist files
275	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
276	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
277	!
278	REWIND( numnam_ref ) ! Namelist namctl in reference namelist
279	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
280	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
281	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist
282	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
283	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
284	!
285	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist
286	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
287	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
288	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist
289	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
290	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
291
292	! !--------------------------!
293	! ! Set global domain size ! (control print return in cltxt2)
294	! !--------------------------!
295	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
296	CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
297	!
298	ELSE ! user-defined namelist
299	CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
300	ENDIF
301	!
302	!
303	! !--------------------------------------------!
304	! ! set communicator & select the local node !
305	! ! NB: mynode also opens output.namelist.dyn !
306	! ! on unit number numond on first proc !
307	! !--------------------------------------------!
308	#if defined key_iomput
309	IF( Agrif_Root() ) THEN
310	IF( lk_oasis ) THEN
311	CALL cpl_init( "toyoce", ilocal_comm ) ! nemo local communicator given by oasis
312	CALL xios_initialize( "not used" ,local_comm= ilocal_comm ) ! send nemo communicator to xios
313	ELSE
314	CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm ) ! nemo local communicator given by xios
315	ENDIF
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	IF( lk_oasis ) THEN
321	IF( Agrif_Root() ) THEN
322	CALL cpl_init( "toyoce", ilocal_comm ) ! nemo local communicator given by oasis
323	ENDIF
324	! Nodes selection (control print return in cltxt)
325	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )
326	ELSE
327	ilocal_comm = 0 ! Nodes selection (control print return in cltxt)
328	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )
329	ENDIF
330	#endif
331
332	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
333
334	IF( sn_cfctl%l_config ) THEN
335	! Activate finer control of report outputs
336	! optionally switch off output from selected areas (note this only
337	! applies to output which does not involve global communications)
338	IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax ) .OR. &
339	& ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) ) &
340	& CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
341	ELSE
342	! Use ln_ctl to turn on or off all options.
343	CALL nemo_set_cfctl( sn_cfctl, ln_ctl, .TRUE. )
344	ENDIF
345
346	lwm = (narea == 1) ! control of output namelists
347	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
348
349	IF(lwm) THEN ! write merged namelists from earlier to output namelist
350	! ! now that the file has been opened in call to mynode.
351	! ! NB: nammpp has already been written in mynode (if lk_mpp_mpi)
352	WRITE( numond, namctl )
353	WRITE( numond, namcfg )
354	IF( .NOT.ln_read_cfg ) THEN
355	DO ji = 1, SIZE(clnam)
356	IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print
357	END DO
358	ENDIF
359	ENDIF
360
361	IF(lwp) THEN ! open listing units
362	!
363	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
364	!
365	WRITE(numout,*)
366	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
367	WRITE(numout,*) ' NEMO team'
368	WRITE(numout,*) ' Ocean General Circulation Model'
369	WRITE(numout,*) ' NEMO version 4.0 (2019) '
370	WRITE(numout,*)
371	WRITE(numout,*) " ._ ._ ._ ._ ._ "
372	WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
373	WRITE(numout,*)
374	WRITE(numout,*) " o _, _, "
375	WRITE(numout,*) " o .' ( .-' / "
376	WRITE(numout,*) " o _/..._'. .' / "
377	WRITE(numout,*) " ( o .-'` ` '-./ _.' "
378	WRITE(numout,*) " ) ( o) ;= <_ ( "
379	WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) "
380	WRITE(numout,*) " ) ) \) \|`\ \) '. \ ( ( "
381	WRITE(numout,*) " ( ( \_/ '-._\ ) ) "
382	WRITE(numout,*) " ) ) jgs ` ( ( "
383	WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
384	WRITE(numout,*)
385
386	DO ji = 1, SIZE(cltxt)
387	IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) TRIM(cltxt(ji)) ! control print of mynode
388	END DO
389	WRITE(numout,*)
390	WRITE(numout,*)
391	DO ji = 1, SIZE(cltxt2)
392	IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) TRIM(cltxt2(ji)) ! control print of domain size
393	END DO
394	!
395	WRITE(numout,cform_aaa) ! Flag AAAAAAA
396	!
397	ENDIF
398	! open /dev/null file to be able to supress output write easily
399	CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
400	!
401	! ! Domain decomposition
402	CALL mpp_init ! MPP
403
404	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
405	CALL nemo_alloc()
406
407	! !-------------------------------!
408	! ! NEMO general initialization !
409	! !-------------------------------!
410
411	CALL nemo_ctl ! Control prints
412	!
413	! ! General initialization
414	IF( ln_timing ) CALL timing_init ! timing
415	IF( ln_timing ) CALL timing_start( 'nemo_init')
416	!
417	CALL phy_cst ! Physical constants
418	CALL eos_init ! Equation of state
419	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
420	CALL wad_init ! Wetting and drying options
421	CALL dom_init("OPA") ! Domain
422	IF( ln_crs ) CALL crs_init ! coarsened grid: domain initialization
423	IF( ln_ctl ) CALL prt_ctl_init ! Print control
424
425	CALL diurnal_sst_bulk_init ! diurnal sst
426	IF( ln_diurnal ) CALL diurnal_sst_coolskin_init ! cool skin
427	!
428	IF( ln_diurnal_only ) THEN ! diurnal only: a subset of the initialisation routines
429	CALL istate_init ! ocean initial state (Dynamics and tracers)
430	CALL sbc_init ! Forcings : surface module
431	CALL tra_qsr_init ! penetrative solar radiation qsr
432	IF( ln_diaobs ) THEN ! Observation & model comparison
433	CALL dia_obs_init ! Initialize observational data
434	CALL dia_obs( nit000 - 1 ) ! Observation operator for restart
435	ENDIF
436	IF( lk_asminc ) CALL asm_inc_init ! Assimilation increments
437	!
438	RETURN ! end of initialization
439	ENDIF
440
441	CALL istate_init ! ocean initial state (Dynamics and tracers)
442
443	! ! external forcing
444	CALL tide_init ! tidal harmonics
445	CALL sbc_init ! surface boundary conditions (including sea-ice)
446	CALL bdy_init ! Open boundaries initialisation
447
448	! ! Ocean physics
449	CALL zdf_phy_init ! Vertical physics
450
451	! ! Lateral physics
452	CALL ldf_tra_init ! Lateral ocean tracer physics
453	CALL ldf_eiv_init ! eddy induced velocity param.
454	CALL ldf_dyn_init ! Lateral ocean momentum physics
455
456	! ! Active tracers
457	IF( ln_traqsr ) CALL tra_qsr_init ! penetrative solar radiation qsr
458	CALL tra_bbc_init ! bottom heat flux
459	CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
460	CALL tra_dmp_init ! internal tracer damping
461	CALL tra_adv_init ! horizontal & vertical advection
462	CALL tra_ldf_init ! lateral mixing
463
464	! ! Dynamics
465	IF( lk_c1d ) CALL dyn_dmp_init ! internal momentum damping
466	CALL dyn_adv_init ! advection (vector or flux form)
467	CALL dyn_vor_init ! vorticity term including Coriolis
468	CALL dyn_ldf_init ! lateral mixing
469	CALL dyn_hpg_init ! horizontal gradient of Hydrostatic pressure
470	CALL dyn_spg_init ! surface pressure gradient
471
472	#if defined key_top
473	! ! Passive tracers
474	CALL trc_init
475	#endif
476	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
477
478	! ! Icebergs
479	CALL icb_init( rdt, nit000) ! initialise icebergs instance
480
481	! ! Misc. options
482	CALL sto_par_init ! Stochastic parametrization
483	IF( ln_sto_eos ) CALL sto_pts_init ! RRandom T/S fluctuations
484
485	! ! Diagnostics
486	IF( lk_floats ) CALL flo_init ! drifting Floats
487	IF( ln_diacfl ) CALL dia_cfl_init ! Initialise CFL diagnostics
488	CALL dia_ptr_init ! Poleward TRansports initialization
489	IF( lk_diadct ) CALL dia_dct_init ! Sections tranports
490	CALL dia_hsb_init ! heat content, salt content and volume budgets
491	CALL trd_init ! Mixed-layer/Vorticity/Integral constraints trends
492	CALL dia_obs_init ! Initialize observational data
493	CALL dia_tmb_init ! TMB outputs
494	CALL dia_25h_init ! 25h mean outputs
495	IF( ln_diaobs ) CALL dia_obs( nit000-1 ) ! Observation operator for restart
496
497	! ! Assimilation increments
498	IF( lk_asminc ) CALL asm_inc_init ! Initialize assimilation increments
499	!
500	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
501
502	IF (nstop > 0) THEN
503	CALL CTL_STOP('STOP','Critical errors in NEMO initialisation')
504	END IF
505
506	!
507	IF( ln_timing ) CALL timing_stop( 'nemo_init')
508	!
509	END SUBROUTINE nemo_init
510
511
512	SUBROUTINE nemo_ctl
513	!!----------------------------------------------------------------------
514	!! * ROUTINE nemo_ctl *
515	!!
516	!! ** Purpose : control print setting
517	!!
518	!! ** Method : - print namctl information and check some consistencies
519	!!----------------------------------------------------------------------
520	!
521	IF(lwp) THEN ! control print
522	WRITE(numout,*)
523	WRITE(numout,*) 'nemo_ctl: Control prints'
524	WRITE(numout,*) '~~~~~~~~'
525	WRITE(numout,*) ' Namelist namctl'
526	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
527	WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config
528	WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
529	WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
530	WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout
531	WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout
532	WRITE(numout,*) ' sn_cfctl%l_mppout = ', sn_cfctl%l_mppout
533	WRITE(numout,*) ' sn_cfctl%l_mpptop = ', sn_cfctl%l_mpptop
534	WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin
535	WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax
536	WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr
537	WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr
538	WRITE(numout,*) ' level of print nn_print = ', nn_print
539	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
540	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
541	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
542	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
543	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
544	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
545	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
546	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
547	ENDIF
548	!
549	nprint = nn_print ! convert DOCTOR namelist names into OLD names
550	nictls = nn_ictls
551	nictle = nn_ictle
552	njctls = nn_jctls
553	njctle = nn_jctle
554	isplt = nn_isplt
555	jsplt = nn_jsplt
556
557	IF(lwp) THEN ! control print
558	WRITE(numout,*)
559	WRITE(numout,*) ' Namelist namcfg'
560	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
561	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
562	WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea
563	WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg
564	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
565	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
566	ENDIF
567	IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file
568	!
569	! ! Parameter control
570	!
571	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
572	IF( lk_mpp .AND. jpnij > 1 ) THEN
573	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
574	ELSE
575	IF( isplt == 1 .AND. jsplt == 1 ) THEN
576	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
577	& ' - the print control will be done over the whole domain' )
578	ENDIF
579	ijsplt = isplt * jsplt ! total number of processors ijsplt
580	ENDIF
581	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
582	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
583	!
584	! ! indices used for the SUM control
585	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
586	lsp_area = .FALSE.
587	ELSE ! print control done over a specific area
588	lsp_area = .TRUE.
589	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
590	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
591	nictls = 1
592	ENDIF
593	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
594	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
595	nictle = jpiglo
596	ENDIF
597	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
598	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
599	njctls = 1
600	ENDIF
601	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
602	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
603	njctle = jpjglo
604	ENDIF
605	ENDIF
606	ENDIF
607	!
608	IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', &
609	& 'Compile with key_nosignedzero enabled:', &
610	& '--> add -Dkey_nosignedzero to the definition of %CPP in your arch file' )
611	!
612	#if defined key_agrif
613	IF( ln_timing ) CALL ctl_stop( 'AGRIF not implemented with ln_timing = true')
614	#endif
615	!
616	END SUBROUTINE nemo_ctl
617
618
619	SUBROUTINE nemo_closefile
620	!!----------------------------------------------------------------------
621	!! * ROUTINE nemo_closefile *
622	!!
623	!! ** Purpose : Close the files
624	!!----------------------------------------------------------------------
625	!
626	IF( lk_mpp ) CALL mppsync
627	!
628	CALL iom_close ! close all input/output files managed by iom_*
629	!
630	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
631	IF( numrun /= -1 ) CLOSE( numrun ) ! run statistics file
632	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
633	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
634	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
635	IF( numnam_ice_ref /= -1 ) CLOSE( numnam_ice_ref ) ! ice reference namelist
636	IF( numnam_ice_cfg /= -1 ) CLOSE( numnam_ice_cfg ) ! ice configuration namelist
637	IF( lwm.AND.numoni /= -1 ) CLOSE( numoni ) ! ice output namelist
638	IF( numevo_ice /= -1 ) CLOSE( numevo_ice ) ! ice variables (temp. evolution)
639	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
640	IF( numdct_vol /= -1 ) CLOSE( numdct_vol ) ! volume transports
641	IF( numdct_heat /= -1 ) CLOSE( numdct_heat ) ! heat transports
642	IF( numdct_salt /= -1 ) CLOSE( numdct_salt ) ! salt transports
643	!
644	numout = 6 ! redefine numout in case it is used after this point...
645	!
646	END SUBROUTINE nemo_closefile
647
648
649	SUBROUTINE nemo_alloc
650	!!----------------------------------------------------------------------
651	!! * ROUTINE nemo_alloc *
652	!!
653	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
654	!!
655	!! ** Method :
656	!!----------------------------------------------------------------------
657	USE diawri , ONLY : dia_wri_alloc
658	USE dom_oce , ONLY : dom_oce_alloc
659	USE trc_oce , ONLY : trc_oce_alloc
660	USE bdy_oce , ONLY : bdy_oce_alloc
661	#if defined key_diadct
662	USE diadct , ONLY : diadct_alloc
663	#endif
664	!
665	INTEGER :: ierr
666	!!----------------------------------------------------------------------
667	!
668	ierr = oce_alloc () ! ocean
669	ierr = ierr + dia_wri_alloc()
670	ierr = ierr + dom_oce_alloc() ! ocean domain
671	ierr = ierr + zdf_oce_alloc() ! ocean vertical physics
672	ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays
673	ierr = ierr + bdy_oce_alloc() ! bdy masks (incl. initialization)
674	!
675	#if defined key_diadct
676	ierr = ierr + diadct_alloc () !
677	#endif
678	!
679	CALL mpp_sum( 'nemogcm', ierr )
680	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
681	!
682	END SUBROUTINE nemo_alloc
683
684	SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
685	!!----------------------------------------------------------------------
686	!! * ROUTINE nemo_set_cfctl *
687	!!
688	!! ** Purpose : Set elements of the output control structure to setto.
689	!! for_all should be .false. unless all areas are to be
690	!! treated identically.
691	!!
692	!! ** Method : Note this routine can be used to switch on/off some
693	!! types of output for selected areas but any output types
694	!! that involve global communications (e.g. mpp_max, glob_sum)
695	!! should be protected from selective switching by the
696	!! for_all argument
697	!!----------------------------------------------------------------------
698	LOGICAL :: setto, for_all
699	TYPE(sn_ctl) :: sn_cfctl
700	!!----------------------------------------------------------------------
701	IF( for_all ) THEN
702	sn_cfctl%l_runstat = setto
703	sn_cfctl%l_trcstat = setto
704	ENDIF
705	sn_cfctl%l_oceout = setto
706	sn_cfctl%l_layout = setto
707	sn_cfctl%l_mppout = setto
708	sn_cfctl%l_mpptop = setto
709	END SUBROUTINE nemo_set_cfctl
710
711	!!======================================================================
712	END MODULE nemogcm
713

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_GC_couple_pkg/src/OCE/nemogcm.F90

Download in other formats: