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/2020/dev_r12558_HPC-08_epico_Extra_Halo/src/OFF – NEMO

Context Navigation

source: NEMO/branches/2020/dev_r12558_HPC-08_epico_Extra_Halo/src/OFF/nemogcm.F90 @ 12586

Last change on this file since 12586 was 12586, checked in by francesca, 4 years ago
Add extra-halo support (jperio 3,4) - ticket #2366
Property svn:keywords set to `Id`
File size: 29.2 KB

Line
1	MODULE nemogcm
2	!!======================================================================
3	!! * MODULE nemogcm *
4	!! Off-line Ocean : passive tracer evolution, dynamics read in files
5	!!======================================================================
6	!! History : 3.3 ! 2010-05 (C. Ethe) Full reorganization of the off-line: phasing with the on-line
7	!! 3.4 ! 2011-01 (C. Ethe, A. R. Porter, STFC Daresbury) dynamical allocation
8	!! 4.0 ! 2016-10 (C. Ethe, G. Madec, S. Flavoni) domain configuration / user defined interface
9	!! 4.1 ! 2019-08 (A. Coward, D. Storkey) rewrite in preparation for new timestepping scheme
10	!!----------------------------------------------------------------------
11
12	!!----------------------------------------------------------------------
13	!! nemo_gcm : off-line: solve ocean tracer only
14	!! nemo_gcm : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
15	!! nemo_init : initialization of the NEMO system
16	!! nemo_ctl : initialisation of the contol print
17	!! nemo_closefile: close remaining open files
18	!! nemo_alloc : dynamical allocation
19	!! istate_init : simple initialization to zero of ocean fields
20	!! stp_ctl : reduced step control (no dynamics in off-line)
21	!!----------------------------------------------------------------------
22	USE dom_oce ! ocean space domain variables
23	USE oce ! dynamics and tracers variables
24	USE trc_oce ! Shared ocean/passive tracers variables
25	USE c1d ! 1D configuration
26	USE domain ! domain initialization from coordinate & bathymetry (dom_init routine)
27	USE closea ! treatment of closed seas (for ln_closea)
28	USE usrdef_nam ! user defined configuration
29	USE eosbn2 ! equation of state (eos bn2 routine)
30	! ! ocean physics
31	USE ldftra ! lateral diffusivity setting (ldf_tra_init routine)
32	USE ldfslp ! slopes of neutral surfaces (ldf_slp_init routine)
33	USE traqsr ! solar radiation penetration (tra_qsr_init routine)
34	USE trabbl ! bottom boundary layer (tra_bbl_init routine)
35	USE traldf ! lateral physics (tra_ldf_init routine)
36	USE sbcmod ! surface boundary condition (sbc_init routine)
37	USE phycst ! physical constant (par_cst routine)
38	USE dtadyn ! Lecture and Interpolation of the dynamical fields
39	USE trcini ! Initilization of the passive tracers
40	USE daymod ! calendar (day routine)
41	USE trcstp ! passive tracer time-stepping (trc_stp routine)
42	USE dtadyn ! Lecture and interpolation of the dynamical fields
43	! ! Passive tracers needs
44	USE trc ! passive tracer : variables
45	USE trcnam ! passive tracer : namelist
46	USE trcrst ! passive tracer restart
47	USE diaptr ! Need to initialise this as some variables are used in if statements later
48	USE sbc_oce , ONLY : ln_rnf
49	USE sbcrnf ! surface boundary condition : runoffs
50	! ! I/O & MPP
51	USE iom ! I/O library
52	USE in_out_manager ! I/O manager
53	USE mppini ! shared/distributed memory setting (mpp_init routine)
54	USE lib_mpp ! distributed memory computing
55	#if defined key_iomput
56	USE xios ! xIOserver
57	#endif
58	USE prtctl ! Print control (prt_ctl_init routine)
59	USE timing ! Timing
60	USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
61	USE lbcnfd , ONLY : isendto, nsndto ! Setup of north fold exchanges
62	USE step, ONLY : Nbb, Nnn, Naa, Nrhs ! time level indices
63	USE halo_mng
64
65	IMPLICIT NONE
66	PRIVATE
67
68	PUBLIC nemo_gcm ! called by nemo.F90
69
70	CHARACTER (len=64) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
71
72	!!----------------------------------------------------------------------
73	!! NEMO/OFF 4.0 , NEMO Consortium (2018)
74	!! $Id$
75	!! Software governed by the CeCILL license (see ./LICENSE)
76	!!----------------------------------------------------------------------
77	CONTAINS
78
79	SUBROUTINE nemo_gcm
80	!!----------------------------------------------------------------------
81	!! * ROUTINE nemo_gcm *
82	!!
83	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
84	!! curvilinear mesh on the sphere.
85	!!
86	!! ** Method : - model general initialization
87	!! - launch the time-stepping (dta_dyn and trc_stp)
88	!! - finalize the run by closing files and communications
89	!!
90	!! References : Madec, Delecluse,Imbard, and Levy, 1997: internal report, IPSL.
91	!! Madec, 2008, internal report, IPSL.
92	!!----------------------------------------------------------------------
93	INTEGER :: istp, indic ! time step index
94	!!----------------------------------------------------------------------
95
96	CALL nemo_init ! Initializations
97
98	! check that all process are still there... If some process have an error,
99	! they will never enter in step and other processes will wait until the end of the cpu time!
100	CALL mpp_max( 'nemogcm', nstop )
101
102	! !-----------------------!
103	! !== time stepping ==!
104	! !-----------------------!
105	istp = nit000
106	!
107	IF( ln_rnf ) CALL sbc_rnf(istp) ! runoffs initialization
108	!
109	CALL iom_init( cxios_context ) ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS)
110	!
111	DO WHILE ( istp <= nitend .AND. nstop == 0 ) !== OFF time-stepping ==!
112	!
113	IF( istp /= nit000 ) CALL day ( istp ) ! Calendar (day was already called at nit000 in day_init)
114	CALL iom_setkt ( istp - nit000 + 1, cxios_context ) ! say to iom that we are at time step kstp
115	#if defined key_sed_off
116	CALL dta_dyn_sed( istp, Nnn ) ! Interpolation of the dynamical fields
117	#else
118	CALL dta_dyn ( istp, Nbb, Nnn, Naa ) ! Interpolation of the dynamical fields
119	#endif
120	CALL trc_stp ( istp, Nbb, Nnn, Nrhs, Naa ) ! time-stepping
121	#if ! defined key_sed_off
122	IF( .NOT.ln_linssh ) CALL dta_dyn_atf( istp, Nbb, Nnn, Naa ) ! time filter of sea surface height and vertical scale factors
123	#endif
124	! Swap time levels
125	Nrhs = Nbb
126	Nbb = Nnn
127	Nnn = Naa
128	Naa = Nrhs
129	!
130	#if ! defined key_sed_off
131	IF( .NOT.ln_linssh ) CALL dta_dyn_sf_interp( istp, Nnn ) ! calculate now grid parameters
132	#endif
133	CALL stp_ctl ( istp, indic ) ! Time loop: control and print
134	istp = istp + 1
135	END DO
136	!
137	#if defined key_iomput
138	CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF
139	#endif
140
141	! !------------------------!
142	! !== finalize the run ==!
143	! !------------------------!
144	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
145
146	IF( nstop /= 0 .AND. lwp ) THEN ! error print
147	WRITE(ctmp1,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found'
148	CALL ctl_stop( ctmp1 )
149	ENDIF
150	!
151	IF( ln_timing ) CALL timing_finalize
152	!
153	CALL nemo_closefile
154	!
155	#if defined key_iomput
156	CALL xios_finalize ! end mpp communications with xios
157	#else
158	IF( lk_mpp ) CALL mppstop ! end mpp communications
159	#endif
160	!
161	IF(lwm) THEN
162	IF( nstop == 0 ) THEN ; STOP 0
163	ELSE ; STOP 123
164	ENDIF
165	ENDIF
166	!
167	END SUBROUTINE nemo_gcm
168
169
170	SUBROUTINE nemo_init
171	!!----------------------------------------------------------------------
172	!! * ROUTINE nemo_init *
173	!!
174	!! ** Purpose : initialization of the nemo model in off-line mode
175	!!----------------------------------------------------------------------
176	INTEGER :: ios, ilocal_comm ! local integers
177	!!
178	NAMELIST/namctl/ sn_cfctl, nn_print, nn_ictls, nn_ictle, &
179	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
180	& ln_timing, ln_diacfl
181	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
182	!!----------------------------------------------------------------------
183	!
184	cxios_context = 'nemo'
185	nn_hls = 1
186	!
187	! !-------------------------------------------------!
188	! ! set communicator & select the local rank !
189	! ! must be done as soon as possible to get narea !
190	! !-------------------------------------------------!
191	!
192	#if defined key_iomput
193	CALL xios_initialize( "for_xios_mpi_id", return_comm=ilocal_comm ) ! nemo local communicator given by xios
194	CALL mpp_start( ilocal_comm )
195	#else
196	CALL mpp_start( )
197	#endif
198	!
199	narea = mpprank + 1 ! mpprank: the rank of proc (0 --> mppsize -1 )
200	lwm = (narea == 1) ! control of output namelists
201	!
202	! !---------------------------------------------------------------!
203	! ! Open output files, reference and configuration namelist files !
204	! !---------------------------------------------------------------!
205	!
206	! open ocean.output as soon as possible to get all output prints (including errors messages)
207	IF( lwm ) CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
208	! open reference and configuration namelist files
209	CALL load_nml( numnam_ref, 'namelist_ref', -1, lwm )
210	CALL load_nml( numnam_cfg, 'namelist_cfg', -1, lwm )
211	IF( lwm ) CALL ctl_opn( numond, 'output.namelist.dyn', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
212	! open /dev/null file to be able to supress output write easily
213	CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE. )
214	!
215	! !--------------------!
216	! ! Open listing units ! -> need sn_cfctl from namctl to define lwp
217	! !--------------------!
218	!
219	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
220	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist' )
221	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
222	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist' )
223	!
224	! finalize the definition of namctl variables
225	IF( sn_cfctl%l_allon ) THEN
226	! Turn on all options.
227	CALL nemo_set_cfctl( sn_cfctl, .TRUE., .TRUE. )
228	! Ensure all processors are active
229	sn_cfctl%procmin = 0 ; sn_cfctl%procmax = 1000000 ; sn_cfctl%procincr = 1
230	ELSEIF( sn_cfctl%l_config ) THEN
231	! Activate finer control of report outputs
232	! optionally switch off output from selected areas (note this only
233	! applies to output which does not involve global communications)
234	IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax ) .OR. &
235	& ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) ) &
236	& CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
237	ELSE
238	! turn off all options.
239	CALL nemo_set_cfctl( sn_cfctl, .FALSE., .TRUE. )
240	ENDIF
241	!
242	lwp = (narea == 1) .OR. sn_cfctl%l_oceout ! control of all listing output print
243	!
244	IF(lwp) THEN ! open listing units
245	!
246	IF( .NOT. lwm ) & ! alreay opened for narea == 1
247	& CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, -1, .FALSE., narea )
248	!
249	WRITE(numout,*)
250	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - CMCC'
251	WRITE(numout,*) ' NEMO team'
252	WRITE(numout,*) ' Off-line TOP Model'
253	WRITE(numout,*) ' NEMO version 4.0 (2019) '
254	WRITE(numout,*)
255	WRITE(numout,*) " ._ ._ ._ ._ ._ "
256	WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
257	WRITE(numout,*)
258	WRITE(numout,*) " o _, _, "
259	WRITE(numout,*) " o .' ( .-' / "
260	WRITE(numout,*) " o _/..._'. .' / "
261	WRITE(numout,*) " ( o .-'` ` '-./ _.' "
262	WRITE(numout,*) " ) ( o) ;= <_ ( "
263	WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) "
264	WRITE(numout,*) " ) ) \) \|`\ \) '. \ ( ( "
265	WRITE(numout,*) " ( ( \_/ '-._\ ) ) "
266	WRITE(numout,*) " ) ) ` ( ( "
267	WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
268	WRITE(numout,*)
269	!
270	WRITE(numout,cform_aaa) ! Flag AAAAAAA
271	!
272	ENDIF
273	!
274	IF(lwm) WRITE( numond, namctl )
275	!
276	! !------------------------------------!
277	! ! Set global domain size parameters !
278	! !------------------------------------!
279	!
280	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
281	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist' )
282	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
283	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist' )
284	!
285	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
286	CALL domain_cfg ( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
287	ELSE ! user-defined namelist
288	CALL usr_def_nam( cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
289	ENDIF
290	!
291	IF(lwm) WRITE( numond, namcfg )
292	l_offline = .true. ! passive tracers are run offline
293	!
294	! !-----------------------------------------!
295	! ! mpp parameters and domain decomposition !
296	! !-----------------------------------------!
297	!
298	CALL mpp_init
299
300	CALL halo_mng_init()
301	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
302	CALL nemo_alloc()
303
304	! Initialise time level indices
305	Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
306
307
308	! !-------------------------------!
309	! ! NEMO general initialization !
310	! !-------------------------------!
311
312	CALL nemo_ctl ! Control prints
313	!
314	! ! General initialization
315	IF( ln_timing ) CALL timing_init
316	IF( ln_timing ) CALL timing_start( 'nemo_init')
317	!
318	CALL phy_cst ! Physical constants
319	CALL eos_init ! Equation of state
320	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
321	CALL dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
322	IF( sn_cfctl%l_prtctl ) &
323	& CALL prt_ctl_init ! Print control
324
325	CALL istate_init( Nnn, Naa ) ! ocean initial state (Dynamics and tracers)
326
327	CALL sbc_init( Nbb, Nnn, Naa ) ! Forcings : surface module
328
329	! ! Tracer physics
330	CALL ldf_tra_init ! Lateral ocean tracer physics
331	CALL ldf_eiv_init ! Eddy induced velocity param
332	CALL tra_ldf_init ! lateral mixing
333	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
334	IF( ln_traqsr ) CALL tra_qsr_init ! penetrative solar radiation
335	IF( ln_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
336
337	! ! Passive tracers
338	CALL trc_nam_run ! Needed to get restart parameters for passive tracers
339	CALL trc_rst_cal( nit000, 'READ' ) ! calendar
340	#if defined key_sed_off
341	CALL dta_dyn_sed_init( Nnn ) ! Initialization for the dynamics
342	#else
343	CALL dta_dyn_init( Nbb, Nnn, Naa ) ! Initialization for the dynamics
344	#endif
345
346	CALL trc_init( Nbb, Nnn, Naa ) ! Passive tracers initialization
347	CALL dia_ptr_init ! Poleward TRansports initialization
348
349	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
350	!
351	IF( ln_timing ) CALL timing_stop( 'nemo_init')
352	!
353	END SUBROUTINE nemo_init
354
355
356	SUBROUTINE nemo_ctl
357	!!----------------------------------------------------------------------
358	!! * ROUTINE nemo_ctl *
359	!!
360	!! ** Purpose : control print setting
361	!!
362	!! ** Method : - print namctl and namcfg information and check some consistencies
363	!!----------------------------------------------------------------------
364	!
365	IF(lwp) THEN ! control print
366	WRITE(numout,*)
367	WRITE(numout,*) 'nemo_ctl: Control prints'
368	WRITE(numout,*) '~~~~~~~~'
369	WRITE(numout,*) ' Namelist namctl'
370	WRITE(numout,*) ' sn_cfctl%l_glochk = ', sn_cfctl%l_glochk
371	WRITE(numout,*) ' sn_cfctl%l_allon = ', sn_cfctl%l_allon
372	WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config
373	WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
374	WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
375	WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout
376	WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout
377	WRITE(numout,*) ' sn_cfctl%l_prtctl = ', sn_cfctl%l_prtctl
378	WRITE(numout,*) ' sn_cfctl%l_prttrc = ', sn_cfctl%l_prttrc
379	WRITE(numout,*) ' sn_cfctl%l_oasout = ', sn_cfctl%l_oasout
380	WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin
381	WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax
382	WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr
383	WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr
384	WRITE(numout,*) ' level of print nn_print = ', nn_print
385	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
386	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
387	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
388	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
389	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
390	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
391	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
392	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
393	ENDIF
394	!
395	nprint = nn_print ! convert DOCTOR namelist names into OLD names
396	nictls = nn_ictls
397	nictle = nn_ictle
398	njctls = nn_jctls
399	njctle = nn_jctle
400	isplt = nn_isplt
401	jsplt = nn_jsplt
402
403	IF(lwp) THEN ! control print
404	WRITE(numout,*)
405	WRITE(numout,*) ' Namelist namcfg'
406	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
407	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
408	WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea
409	WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg
410	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
411	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
412	ENDIF
413	IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file
414	!
415	! ! Parameter control
416	!
417	IF( sn_cfctl%l_prtctl .OR. sn_cfctl%l_prttrc ) THEN ! sub-domain area indices for the control prints
418	IF( lk_mpp .AND. jpnij > 1 ) THEN
419	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
420	ELSE
421	IF( isplt == 1 .AND. jsplt == 1 ) THEN
422	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
423	& ' - the print control will be done over the whole domain' )
424	ENDIF
425	ijsplt = isplt * jsplt ! total number of processors ijsplt
426	ENDIF
427	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
428	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
429	!
430	! ! indices used for the SUM control
431	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
432	lsp_area = .FALSE.
433	ELSE ! print control done over a specific area
434	lsp_area = .TRUE.
435	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
436	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
437	nictls = 1
438	ENDIF
439	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
440	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
441	nictle = jpiglo
442	ENDIF
443	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
444	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
445	njctls = 1
446	ENDIF
447	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
448	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
449	njctle = jpjglo
450	ENDIF
451	ENDIF
452	ENDIF
453	!
454	IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', &
455	& 'Compile with key_nosignedzero enabled' )
456	!
457	END SUBROUTINE nemo_ctl
458
459
460	SUBROUTINE nemo_closefile
461	!!----------------------------------------------------------------------
462	!! * ROUTINE nemo_closefile *
463	!!
464	!! ** Purpose : Close the files
465	!!----------------------------------------------------------------------
466	!
467	IF( lk_mpp ) CALL mppsync
468	!
469	CALL iom_close ! close all input/output files managed by iom_*
470	!
471	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
472	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
473	!
474	numout = 6 ! redefine numout in case it is used after this point...
475	!
476	END SUBROUTINE nemo_closefile
477
478
479	SUBROUTINE nemo_alloc
480	!!----------------------------------------------------------------------
481	!! * ROUTINE nemo_alloc *
482	!!
483	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
484	!!
485	!! ** Method :
486	!!----------------------------------------------------------------------
487	USE diawri , ONLY : dia_wri_alloc
488	USE dom_oce, ONLY : dom_oce_alloc
489	USE zdf_oce, ONLY : zdf_oce_alloc
490	USE trc_oce, ONLY : trc_oce_alloc
491	!
492	INTEGER :: ierr
493	!!----------------------------------------------------------------------
494	!
495	ierr = oce_alloc () ! ocean
496	ierr = ierr + dia_wri_alloc()
497	ierr = ierr + dom_oce_alloc() ! ocean domain
498	ierr = ierr + zdf_oce_alloc() ! ocean vertical physics
499	ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays
500	!
501	CALL mpp_sum( 'nemogcm', ierr )
502	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
503	!
504	END SUBROUTINE nemo_alloc
505
506	SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
507	!!----------------------------------------------------------------------
508	!! * ROUTINE nemo_set_cfctl *
509	!!
510	!! ** Purpose : Set elements of the output control structure to setto.
511	!! for_all should be .false. unless all areas are to be
512	!! treated identically.
513	!!
514	!! ** Method : Note this routine can be used to switch on/off some
515	!! types of output for selected areas but any output types
516	!! that involve global communications (e.g. mpp_max, glob_sum)
517	!! should be protected from selective switching by the
518	!! for_all argument
519	!!----------------------------------------------------------------------
520	LOGICAL :: setto, for_all
521	TYPE(sn_ctl) :: sn_cfctl
522	!!----------------------------------------------------------------------
523	IF( for_all ) THEN
524	sn_cfctl%l_runstat = setto
525	sn_cfctl%l_trcstat = setto
526	ENDIF
527	sn_cfctl%l_oceout = setto
528	sn_cfctl%l_layout = setto
529	sn_cfctl%l_prtctl = setto
530	sn_cfctl%l_prttrc = setto
531	sn_cfctl%l_oasout = setto
532	END SUBROUTINE nemo_set_cfctl
533
534	SUBROUTINE istate_init( Kmm, Kaa )
535	!!----------------------------------------------------------------------
536	!! * ROUTINE istate_init *
537	!!
538	!! ** Purpose : Initialization to zero of the dynamics and tracers.
539	!!----------------------------------------------------------------------
540	INTEGER, INTENT(in) :: Kmm, Kaa ! ocean time level indices
541	!
542	! now fields ! after fields !
543	uu (:,:,:,Kmm) = 0._wp ; uu(:,:,:,Kaa) = 0._wp !
544	vv (:,:,:,Kmm) = 0._wp ; vv(:,:,:,Kaa) = 0._wp !
545	ww (:,:,:) = 0._wp ! !
546	hdiv (:,:,:) = 0._wp ! !
547	ts (:,:,:,:,Kmm) = 0._wp ! !
548	!
549	rhd (:,:,:) = 0.e0
550	rhop (:,:,:) = 0.e0
551	rn2 (:,:,:) = 0.e0
552	!
553	END SUBROUTINE istate_init
554
555
556	SUBROUTINE stp_ctl( kt, kindic )
557	!!----------------------------------------------------------------------
558	!! * ROUTINE stp_ctl *
559	!!
560	!! ** Purpose : Control the run
561	!!
562	!! ** Method : - Save the time step in numstp
563	!!
564	!! ** Actions : 'time.step' file containing the last ocean time-step
565	!!----------------------------------------------------------------------
566	INTEGER, INTENT(in ) :: kt ! ocean time-step index
567	INTEGER, INTENT(inout) :: kindic ! indicator of solver convergence
568	!!----------------------------------------------------------------------
569	!
570	IF( kt == nit000 .AND. lwm ) THEN
571	WRITE(numout,*)
572	WRITE(numout,*) 'stp_ctl : time-stepping control'
573	WRITE(numout,*) '~~~~~~~'
574	! open time.step file
575	CALL ctl_opn( numstp, 'time.step', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
576	ENDIF
577	!
578	IF(lwm) WRITE ( numstp, '(1x, i8)' ) kt !* save the current time step in numstp
579	IF(lwm) REWIND( numstp ) ! --------------------------
580	!
581	END SUBROUTINE stp_ctl
582	!!======================================================================
583	END MODULE nemogcm

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

Download in other formats: