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/src/OFF – NEMO

Context Navigation

source: NEMO/branches/2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps/src/OFF/nemogcm.F90 @ 11527

Last change on this file since 11527 was 11527, checked in by acc, 5 years ago
Branch 2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps. Removal of TOP-specific time indices (Nnn_trc etc.). This completes the removal of the trc sub-timestepping option and dynamics, active tracers and passive tracers must now have common time-steps. Note time-filtering for passive tracers is done in trc_trp (trc_atf) but the (now shared) time indices are not swapped until after calls to tra_atf, dyn_atf and ssh_atf in step. Calls to trc routines after trc_atf have had their time-index arguments adjusted accordingly. These changes have been fully SETTE-tested.
Property svn:keywords set to `Id`
File size: 29.1 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, nfsloop, nfeloop ! Setup of north fold exchanges
62	USE step, ONLY : Nbb, Nnn, Naa, Nrhs ! time level indices
63
64	IMPLICIT NONE
65	PRIVATE
66
67	PUBLIC nemo_gcm ! called by nemo.F90
68
69	CHARACTER (len=64) :: cform_aaa="( /, 'AAAAAAAA', / ) " ! flag for output listing
70
71	!!----------------------------------------------------------------------
72	!! NEMO/OFF 4.0 , NEMO Consortium (2018)
73	!! $Id$
74	!! Software governed by the CeCILL license (see ./LICENSE)
75	!!----------------------------------------------------------------------
76	CONTAINS
77
78	SUBROUTINE nemo_gcm
79	!!----------------------------------------------------------------------
80	!! * ROUTINE nemo_gcm *
81	!!
82	!! ** Purpose : NEMO solves the primitive equations on an orthogonal
83	!! curvilinear mesh on the sphere.
84	!!
85	!! ** Method : - model general initialization
86	!! - launch the time-stepping (dta_dyn and trc_stp)
87	!! - finalize the run by closing files and communications
88	!!
89	!! References : Madec, Delecluse,Imbard, and Levy, 1997: internal report, IPSL.
90	!! Madec, 2008, internal report, IPSL.
91	!!----------------------------------------------------------------------
92	INTEGER :: istp, indic ! time step index
93	!!----------------------------------------------------------------------
94
95	CALL nemo_init ! Initializations
96
97	! check that all process are still there... If some process have an error,
98	! they will never enter in step and other processes will wait until the end of the cpu time!
99	CALL mpp_max( 'nemogcm', nstop )
100
101	! !-----------------------!
102	! !== time stepping ==!
103	! !-----------------------!
104	istp = nit000
105	!
106	IF( ln_rnf ) CALL sbc_rnf(istp) ! runoffs initialization
107	!
108	CALL iom_init( cxios_context ) ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS)
109	!
110	DO WHILE ( istp <= nitend .AND. nstop == 0 ) !== OFF time-stepping ==!
111	!
112	IF( istp /= nit000 ) CALL day ( istp ) ! Calendar (day was already called at nit000 in day_init)
113	CALL iom_setkt ( istp - nit000 + 1, cxios_context ) ! say to iom that we are at time step kstp
114	#if defined key_sed_off
115	CALL dta_dyn_sed( istp, Nnn ) ! Interpolation of the dynamical fields
116	#else
117	CALL dta_dyn ( istp, Nbb, Nnn, Naa ) ! Interpolation of the dynamical fields
118	#endif
119	CALL trc_stp ( istp, Nbb, Nnn, Nrhs, Naa ) ! time-stepping
120	#if ! defined key_sed_off
121	IF( .NOT.ln_linssh ) CALL dta_dyn_atf( istp, Nbb, Nnn, Naa ) ! time filter of sea surface height and vertical scale factors
122	#endif
123	! Swap time levels
124	Nrhs = Nbb
125	Nbb = Nnn
126	Nnn = Naa
127	Naa = Nrhs
128	!
129	#if ! defined key_sed_off
130	IF( .NOT.ln_linssh ) CALL dta_dyn_sf_interp( istp, Nnn ) ! calculate now grid parameters
131	#endif
132	CALL stp_ctl ( istp, indic ) ! Time loop: control and print
133	istp = istp + 1
134	END DO
135	!
136	#if defined key_iomput
137	CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF
138	#endif
139
140	! !------------------------!
141	! !== finalize the run ==!
142	! !------------------------!
143	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
144
145	IF( nstop /= 0 .AND. lwp ) THEN ! error print
146	WRITE(numout,cform_err)
147	WRITE(numout,*) ' ==>>> nemo_gcm: a total of ', nstop, ' errors have been found'
148	WRITE(numout,*)
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	END SUBROUTINE nemo_gcm
162
163
164	SUBROUTINE nemo_init
165	!!----------------------------------------------------------------------
166	!! * ROUTINE nemo_init *
167	!!
168	!! ** Purpose : initialization of the nemo model in off-line mode
169	!!----------------------------------------------------------------------
170	INTEGER :: ji ! dummy loop indices
171	INTEGER :: ios, ilocal_comm ! local integers
172	CHARACTER(len=120), DIMENSION(30) :: cltxt, cltxt2, clnam
173	!!
174	NAMELIST/namctl/ ln_ctl , sn_cfctl, nn_print, nn_ictls, nn_ictle, &
175	& nn_isplt , nn_jsplt, nn_jctls, nn_jctle, &
176	& ln_timing, ln_diacfl
177	NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
178	!!----------------------------------------------------------------------
179	!
180	cltxt = ''
181	cltxt2 = ''
182	clnam = ''
183	cxios_context = 'nemo'
184	!
185	! ! Open reference namelist and configuration namelist files
186	CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
187	CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
188	!
189	REWIND( numnam_ref ) ! Namelist namctl in reference namelist
190	READ ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
191	901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
192	REWIND( numnam_cfg ) ! Namelist namctl in confguration namelist
193	READ ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
194	902 IF( ios > 0 ) CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
195	!
196	REWIND( numnam_ref ) ! Namelist namcfg in reference namelist
197	READ ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
198	903 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
199	REWIND( numnam_cfg ) ! Namelist namcfg in confguration namelist
200	READ ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
201	904 IF( ios > 0 ) CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )
202
203	! !--------------------------!
204	! ! Set global domain size ! (control print return in cltxt2)
205	! !--------------------------!
206	IF( ln_read_cfg ) THEN ! Read sizes in domain configuration file
207	CALL domain_cfg ( cltxt2, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
208	!
209	ELSE ! user-defined namelist
210	CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
211	ENDIF
212	!
213	l_offline = .true. ! passive tracers are run offline
214	!
215	! !--------------------------------------------!
216	! ! set communicator & select the local node !
217	! ! NB: mynode also opens output.namelist.dyn !
218	! ! on unit number numond on first proc !
219	! !--------------------------------------------!
220	#if defined key_iomput
221	CALL xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )
222	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm ) ! Nodes selection
223	#else
224	ilocal_comm = 0
225	narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop ) ! Nodes selection (control print return in cltxt)
226	#endif
227
228	narea = narea + 1 ! mynode return the rank of proc (0 --> jpnij -1 )
229
230	IF( 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	! Use ln_ctl to turn on or off all options.
239	CALL nemo_set_cfctl( sn_cfctl, ln_ctl, .TRUE. )
240	ENDIF
241
242	lwm = (narea == 1) ! control of output namelists
243	lwp = (narea == 1) .OR. ln_ctl ! control of all listing output print
244
245	IF(lwm) THEN ! write merged namelists from earlier to output namelist
246	! ! now that the file has been opened in call to mynode.
247	! ! NB: nammpp has already been written in mynode (if lk_mpp_mpi)
248	WRITE( numond, namctl )
249	WRITE( numond, namcfg )
250	IF( .NOT.ln_read_cfg ) THEN
251	DO ji = 1, SIZE(clnam)
252	IF( TRIM(clnam(ji)) /= '' ) WRITE(numond, * ) clnam(ji) ! namusr_def print
253	END DO
254	ENDIF
255	ENDIF
256
257	IF(lwp) THEN ! open listing units
258	!
259	CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
260	!
261	WRITE(numout,*)
262	WRITE(numout,*) ' CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
263	WRITE(numout,*) ' NEMO team'
264	WRITE(numout,*) ' Off-line TOP Model'
265	WRITE(numout,*) ' NEMO version 4.0 (2019) '
266	WRITE(numout,*)
267	WRITE(numout,*) " ._ ._ ._ ._ ._ "
268	WRITE(numout,*) " _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
269	WRITE(numout,*)
270	WRITE(numout,*) " o _, _, "
271	WRITE(numout,*) " o .' ( .-' / "
272	WRITE(numout,*) " o _/..._'. .' / "
273	WRITE(numout,*) " ( o .-'` ` '-./ _.' "
274	WRITE(numout,*) " ) ( o) ;= <_ ( "
275	WRITE(numout,*) " ( '-.,\\__ __.-;`\ '. ) "
276	WRITE(numout,*) " ) ) \) \|`\ \) '. \ ( ( "
277	WRITE(numout,*) " ( ( \_/ '-._\ ) ) "
278	WRITE(numout,*) " ) ) ` ( ( "
279	WRITE(numout,*) " ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
280	WRITE(numout,*)
281	DO ji = 1, SIZE(cltxt)
282	IF( TRIM(cltxt (ji)) /= '' ) WRITE(numout,*) TRIM(cltxt(ji)) ! control print of mynode
283	END DO
284	WRITE(numout,*)
285	WRITE(numout,*)
286	DO ji = 1, SIZE(cltxt2)
287	IF( TRIM(cltxt2(ji)) /= '' ) WRITE(numout,*) TRIM(cltxt2(ji)) ! control print of domain size
288	END DO
289	!
290	WRITE(numout,cform_aaa) ! Flag AAAAAAA
291	!
292	ENDIF
293	! open /dev/null file to be able to supress output write easily
294	CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
295	!
296	! ! Domain decomposition
297	CALL mpp_init ! MPP
298
299	! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
300	CALL nemo_alloc()
301
302	! Initialise time level indices
303	Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
304
305
306	! !-------------------------------!
307	! ! NEMO general initialization !
308	! !-------------------------------!
309
310	CALL nemo_ctl ! Control prints
311	!
312	! ! General initialization
313	IF( ln_timing ) CALL timing_init
314	IF( ln_timing ) CALL timing_start( 'nemo_init')
315	!
316	CALL phy_cst ! Physical constants
317	CALL eos_init ! Equation of state
318	IF( lk_c1d ) CALL c1d_init ! 1D column configuration
319	CALL dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
320	IF( ln_ctl ) CALL prt_ctl_init ! Print control
321
322	CALL istate_init( Nnn, Naa ) ! ocean initial state (Dynamics and tracers)
323
324	CALL sbc_init( Nbb, Nnn, Naa ) ! Forcings : surface module
325
326	! ! Tracer physics
327	CALL ldf_tra_init ! Lateral ocean tracer physics
328	CALL ldf_eiv_init ! Eddy induced velocity param
329	CALL tra_ldf_init ! lateral mixing
330	IF( l_ldfslp ) CALL ldf_slp_init ! slope of lateral mixing
331	IF( ln_traqsr ) CALL tra_qsr_init ! penetrative solar radiation
332	IF( ln_trabbl ) CALL tra_bbl_init ! advective (and/or diffusive) bottom boundary layer scheme
333
334	! ! Passive tracers
335	CALL trc_nam_run ! Needed to get restart parameters for passive tracers
336	CALL trc_rst_cal( nit000, 'READ' ) ! calendar
337	#if defined key_sed_off
338	CALL dta_dyn_sed_init( Nnn ) ! Initialization for the dynamics
339	#else
340	CALL dta_dyn_init( Nbb, Nnn, Naa ) ! Initialization for the dynamics
341	#endif
342
343	CALL trc_init ! Passive tracers initialization
344	CALL dia_ptr_init ! Poleward TRansports initialization
345
346	IF(lwp) WRITE(numout,cform_aaa) ! Flag AAAAAAA
347	!
348	IF( ln_timing ) CALL timing_stop( 'nemo_init')
349	!
350	END SUBROUTINE nemo_init
351
352
353	SUBROUTINE nemo_ctl
354	!!----------------------------------------------------------------------
355	!! * ROUTINE nemo_ctl *
356	!!
357	!! ** Purpose : control print setting
358	!!
359	!! ** Method : - print namctl information and check some consistencies
360	!!----------------------------------------------------------------------
361	!
362	IF(lwp) THEN ! control print
363	WRITE(numout,*)
364	WRITE(numout,*) 'nemo_ctl: Control prints'
365	WRITE(numout,*) '~~~~~~~~'
366	WRITE(numout,*) ' Namelist namctl'
367	WRITE(numout,*) ' run control (for debugging) ln_ctl = ', ln_ctl
368	WRITE(numout,*) ' finer control over o/p sn_cfctl%l_config = ', sn_cfctl%l_config
369	WRITE(numout,*) ' sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
370	WRITE(numout,*) ' sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
371	WRITE(numout,*) ' sn_cfctl%l_oceout = ', sn_cfctl%l_oceout
372	WRITE(numout,*) ' sn_cfctl%l_layout = ', sn_cfctl%l_layout
373	WRITE(numout,*) ' sn_cfctl%l_mppout = ', sn_cfctl%l_mppout
374	WRITE(numout,*) ' sn_cfctl%l_mpptop = ', sn_cfctl%l_mpptop
375	WRITE(numout,*) ' sn_cfctl%procmin = ', sn_cfctl%procmin
376	WRITE(numout,*) ' sn_cfctl%procmax = ', sn_cfctl%procmax
377	WRITE(numout,*) ' sn_cfctl%procincr = ', sn_cfctl%procincr
378	WRITE(numout,*) ' sn_cfctl%ptimincr = ', sn_cfctl%ptimincr
379	WRITE(numout,*) ' level of print nn_print = ', nn_print
380	WRITE(numout,*) ' Start i indice for SUM control nn_ictls = ', nn_ictls
381	WRITE(numout,*) ' End i indice for SUM control nn_ictle = ', nn_ictle
382	WRITE(numout,*) ' Start j indice for SUM control nn_jctls = ', nn_jctls
383	WRITE(numout,*) ' End j indice for SUM control nn_jctle = ', nn_jctle
384	WRITE(numout,*) ' number of proc. following i nn_isplt = ', nn_isplt
385	WRITE(numout,*) ' number of proc. following j nn_jsplt = ', nn_jsplt
386	WRITE(numout,*) ' timing by routine ln_timing = ', ln_timing
387	WRITE(numout,*) ' CFL diagnostics ln_diacfl = ', ln_diacfl
388	ENDIF
389	!
390	nprint = nn_print ! convert DOCTOR namelist names into OLD names
391	nictls = nn_ictls
392	nictle = nn_ictle
393	njctls = nn_jctls
394	njctle = nn_jctle
395	isplt = nn_isplt
396	jsplt = nn_jsplt
397
398	IF(lwp) THEN ! control print
399	WRITE(numout,*)
400	WRITE(numout,*) ' Namelist namcfg'
401	WRITE(numout,*) ' read domain configuration file ln_read_cfg = ', ln_read_cfg
402	WRITE(numout,*) ' filename to be read cn_domcfg = ', TRIM(cn_domcfg)
403	WRITE(numout,*) ' keep closed seas in the domain (if exist) ln_closea = ', ln_closea
404	WRITE(numout,*) ' create a configuration definition file ln_write_cfg = ', ln_write_cfg
405	WRITE(numout,*) ' filename to be written cn_domcfg_out = ', TRIM(cn_domcfg_out)
406	WRITE(numout,*) ' use file attribute if exists as i/p j-start ln_use_jattr = ', ln_use_jattr
407	ENDIF
408	IF( .NOT.ln_read_cfg ) ln_closea = .false. ! dealing possible only with a domcfg file
409	!
410	! ! Parameter control
411	!
412	IF( ln_ctl ) THEN ! sub-domain area indices for the control prints
413	IF( lk_mpp .AND. jpnij > 1 ) THEN
414	isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj ! the domain is forced to the real split domain
415	ELSE
416	IF( isplt == 1 .AND. jsplt == 1 ) THEN
417	CALL ctl_warn( ' - isplt & jsplt are equal to 1', &
418	& ' - the print control will be done over the whole domain' )
419	ENDIF
420	ijsplt = isplt * jsplt ! total number of processors ijsplt
421	ENDIF
422	IF(lwp) WRITE(numout,*)' - The total number of processors over which the'
423	IF(lwp) WRITE(numout,*)' print control will be done is ijsplt : ', ijsplt
424	!
425	! ! indices used for the SUM control
426	IF( nictls+nictle+njctls+njctle == 0 ) THEN ! print control done over the default area
427	lsp_area = .FALSE.
428	ELSE ! print control done over a specific area
429	lsp_area = .TRUE.
430	IF( nictls < 1 .OR. nictls > jpiglo ) THEN
431	CALL ctl_warn( ' - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
432	nictls = 1
433	ENDIF
434	IF( nictle < 1 .OR. nictle > jpiglo ) THEN
435	CALL ctl_warn( ' - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
436	nictle = jpiglo
437	ENDIF
438	IF( njctls < 1 .OR. njctls > jpjglo ) THEN
439	CALL ctl_warn( ' - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
440	njctls = 1
441	ENDIF
442	IF( njctle < 1 .OR. njctle > jpjglo ) THEN
443	CALL ctl_warn( ' - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
444	njctle = jpjglo
445	ENDIF
446	ENDIF
447	ENDIF
448	!
449	IF( 1._wp /= SIGN(1._wp,-0._wp) ) CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.', &
450	& 'Compile with key_nosignedzero enabled' )
451	!
452	END SUBROUTINE nemo_ctl
453
454
455	SUBROUTINE nemo_closefile
456	!!----------------------------------------------------------------------
457	!! * ROUTINE nemo_closefile *
458	!!
459	!! ** Purpose : Close the files
460	!!----------------------------------------------------------------------
461	!
462	IF( lk_mpp ) CALL mppsync
463	!
464	CALL iom_close ! close all input/output files managed by iom_*
465	!
466	IF( numstp /= -1 ) CLOSE( numstp ) ! time-step file
467	IF( numnam_ref /= -1 ) CLOSE( numnam_ref ) ! oce reference namelist
468	IF( numnam_cfg /= -1 ) CLOSE( numnam_cfg ) ! oce configuration namelist
469	IF( numout /= 6 ) CLOSE( numout ) ! standard model output file
470	IF( lwm.AND.numond /= -1 ) CLOSE( numond ) ! oce output namelist
471	!
472	numout = 6 ! redefine numout in case it is used after this point...
473	!
474	END SUBROUTINE nemo_closefile
475
476
477	SUBROUTINE nemo_alloc
478	!!----------------------------------------------------------------------
479	!! * ROUTINE nemo_alloc *
480	!!
481	!! ** Purpose : Allocate all the dynamic arrays of the OPA modules
482	!!
483	!! ** Method :
484	!!----------------------------------------------------------------------
485	USE diawri , ONLY : dia_wri_alloc
486	USE dom_oce, ONLY : dom_oce_alloc
487	USE zdf_oce, ONLY : zdf_oce_alloc
488	USE trc_oce, ONLY : trc_oce_alloc
489	!
490	INTEGER :: ierr
491	!!----------------------------------------------------------------------
492	!
493	ierr = oce_alloc () ! ocean
494	ierr = ierr + dia_wri_alloc()
495	ierr = ierr + dom_oce_alloc() ! ocean domain
496	ierr = ierr + zdf_oce_alloc() ! ocean vertical physics
497	ierr = ierr + trc_oce_alloc() ! shared TRC / TRA arrays
498	!
499	CALL mpp_sum( 'nemogcm', ierr )
500	IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
501	!
502	END SUBROUTINE nemo_alloc
503
504	SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
505	!!----------------------------------------------------------------------
506	!! * ROUTINE nemo_set_cfctl *
507	!!
508	!! ** Purpose : Set elements of the output control structure to setto.
509	!! for_all should be .false. unless all areas are to be
510	!! treated identically.
511	!!
512	!! ** Method : Note this routine can be used to switch on/off some
513	!! types of output for selected areas but any output types
514	!! that involve global communications (e.g. mpp_max, glob_sum)
515	!! should be protected from selective switching by the
516	!! for_all argument
517	!!----------------------------------------------------------------------
518	LOGICAL :: setto, for_all
519	TYPE(sn_ctl) :: sn_cfctl
520	!!----------------------------------------------------------------------
521	IF( for_all ) THEN
522	sn_cfctl%l_runstat = setto
523	sn_cfctl%l_trcstat = setto
524	ENDIF
525	sn_cfctl%l_oceout = setto
526	sn_cfctl%l_layout = setto
527	sn_cfctl%l_mppout = setto
528	sn_cfctl%l_mpptop = setto
529	END SUBROUTINE nemo_set_cfctl
530
531	SUBROUTINE istate_init( Kmm, Kaa )
532	!!----------------------------------------------------------------------
533	!! * ROUTINE istate_init *
534	!!
535	!! ** Purpose : Initialization to zero of the dynamics and tracers.
536	!!----------------------------------------------------------------------
537	INTEGER, INTENT(in) :: Kmm, Kaa ! ocean time level indices
538	!
539	! now fields ! after fields !
540	uu (:,:,:,Kmm) = 0._wp ; uu(:,:,:,Kaa) = 0._wp !
541	vv (:,:,:,Kmm) = 0._wp ; vv(:,:,:,Kaa) = 0._wp !
542	ww (:,:,:) = 0._wp ! !
543	hdiv (:,:,:) = 0._wp ! !
544	ts (:,:,:,:,Kmm) = 0._wp ! !
545	!
546	rhd (:,:,:) = 0.e0
547	rhop (:,:,:) = 0.e0
548	rn2 (:,:,:) = 0.e0
549	!
550	END SUBROUTINE istate_init
551
552
553	SUBROUTINE stp_ctl( kt, kindic )
554	!!----------------------------------------------------------------------
555	!! * ROUTINE stp_ctl *
556	!!
557	!! ** Purpose : Control the run
558	!!
559	!! ** Method : - Save the time step in numstp
560	!!
561	!! ** Actions : 'time.step' file containing the last ocean time-step
562	!!----------------------------------------------------------------------
563	INTEGER, INTENT(in ) :: kt ! ocean time-step index
564	INTEGER, INTENT(inout) :: kindic ! indicator of solver convergence
565	!!----------------------------------------------------------------------
566	!
567	IF( kt == nit000 .AND. lwm ) THEN
568	WRITE(numout,*)
569	WRITE(numout,*) 'stp_ctl : time-stepping control'
570	WRITE(numout,*) '~~~~~~~'
571	! open time.step file
572	CALL ctl_opn( numstp, 'time.step', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp, narea )
573	ENDIF
574	!
575	IF(lwm) WRITE ( numstp, '(1x, i8)' ) kt !* save the current time step in numstp
576	IF(lwm) REWIND( numstp ) ! --------------------------
577	!
578	END SUBROUTINE stp_ctl
579	!!======================================================================
580	END MODULE nemogcm

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

Download in other formats: