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_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps_rewrite_time_filterswap/src/OCE – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps_rewrite_time_filterswap/src/OCE/nemogcm.F90 @ 11427

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

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

Download in other formats: