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

Last change on this file since 11483 was 11483, checked in by davestorkey, 2 years ago

2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps : Update more header comments and change logs.
Also remove debugging output from trcstp.F90 and correct bug in step_c1d.F90. Note C1D untested in this branch.

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