Context Navigation

← Previous Revision
Latest Revision
Next Revision →
Blame
Revision Log

nemogcm.F90 @ 10948

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

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_package_text_diagnostics/src/OCE/nemogcm.F90 @ 10948

Download in other formats: