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

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.

nemogcm.F90 in NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r11943_MERGE_2019/src/OCE/nemogcm.F90 @ 12205

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

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

Download in other formats: