Context Navigation

nemogcm.F90 @ 15704

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

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.4_FOAM_pcbias/src/OCE/nemogcm.F90 @ 15704

Download in other formats: