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

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

2019/dev_r10721_KERNEL-02_Storkey_Coward_IMMERSE_first_steps : Merge in changes from branch of branch.
Main changes:

  1. "nxt" modules renamed as "atf" and now just do Asselin time filtering. The time level swapping is achieved by swapping indices.
  2. Some additional prognostic grid variables changed to use a time dimension.

Notes:

  1. This merged branch passes SETTE tests but does not identical results to the SETTE tests with the trunk@10721 unless minor bugs to do with Euler timestepping and the OFF timestepping are fixed in the trunk (NEMO tickets #2310 and #2311).
  2. The nn_dttrc > 1 option for TOP (TOP has a different timestep to OCE) doesn't work. But it doesn't work in the trunk or NEMO 4.0 release either.
  • Property svn:keywords set to Id
File size: 29.2 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   !!----------------------------------------------------------------------
10
11   !!----------------------------------------------------------------------
12   !!   nemo_gcm      : off-line: solve ocean tracer only
13   !!   nemo_gcm      : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
14   !!   nemo_init     : initialization of the NEMO system
15   !!   nemo_ctl      : initialisation of the contol print
16   !!   nemo_closefile: close remaining open files
17   !!   nemo_alloc    : dynamical allocation
18   !!   istate_init   : simple initialization to zero of ocean fields
19   !!   stp_ctl       : reduced step control (no dynamics in off-line)
20   !!----------------------------------------------------------------------
21   USE dom_oce        ! ocean space domain variables
22   USE oce            ! dynamics and tracers variables
23   USE trc_oce        ! Shared ocean/passive tracers variables
24   USE c1d            ! 1D configuration
25   USE domain         ! domain initialization from coordinate & bathymetry (dom_init routine)
26   USE closea         ! treatment of closed seas (for ln_closea)
27   USE usrdef_nam     ! user defined configuration
28   USE eosbn2         ! equation of state            (eos bn2 routine)
29   !              ! ocean physics
30   USE ldftra         ! lateral diffusivity setting    (ldf_tra_init routine)
31   USE ldfslp         ! slopes of neutral surfaces     (ldf_slp_init routine)
32   USE traqsr         ! solar radiation penetration    (tra_qsr_init routine)
33   USE trabbl         ! bottom boundary layer          (tra_bbl_init routine)
34   USE traldf         ! lateral physics                (tra_ldf_init routine)
35   USE sbcmod         ! surface boundary condition     (sbc_init     routine)
36   USE phycst         ! physical constant                   (par_cst routine)
37   USE dtadyn         ! Lecture and Interpolation of the dynamical fields
38   USE trcini         ! Initilization of the passive tracers
39   USE daymod         ! calendar                            (day     routine)
40   USE trcstp         ! passive tracer time-stepping        (trc_stp routine)
41   USE dtadyn         ! Lecture and interpolation of the dynamical fields
42   !              ! Passive tracers needs
43   USE trc            ! passive tracer : variables
44   USE trcnam         ! passive tracer : namelist
45   USE trcrst         ! passive tracer restart
46   USE diaptr         ! Need to initialise this as some variables are used in if statements later
47   USE sbc_oce , ONLY : ln_rnf
48   USE sbcrnf         ! surface boundary condition : runoffs
49   !              ! I/O & MPP
50   USE iom            ! I/O library
51   USE in_out_manager ! I/O manager
52   USE mppini         ! shared/distributed memory setting (mpp_init routine)
53   USE lib_mpp        ! distributed memory computing
54#if defined key_iomput
55   USE xios           ! xIOserver
56#endif
57   USE prtctl         ! Print control                    (prt_ctl_init routine)
58   USE timing         ! Timing
59   USE lib_fortran    ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
60   USE lbcnfd  , ONLY : isendto, nsndto, nfsloop, nfeloop   ! Setup of north fold exchanges
61
62   IMPLICIT NONE
63   PRIVATE
64   
65   PUBLIC   nemo_gcm   ! called by nemo.F90
66
67   CHARACTER (len=64) ::   cform_aaa="( /, 'AAAAAAAA', / ) "   ! flag for output listing
68
69   !!----------------------------------------------------------------------
70   !! time level indices
71   !!----------------------------------------------------------------------
72   INTEGER :: Nbb, Nnn, Naa, Nrhs       
73
74   !!----------------------------------------------------------------------
75   !! NEMO/OFF 4.0 , NEMO Consortium (2018)
76   !! $Id$
77   !! Software governed by the CeCILL license (see ./LICENSE)
78   !!----------------------------------------------------------------------
79CONTAINS
80
81   SUBROUTINE nemo_gcm
82      !!----------------------------------------------------------------------
83      !!                     ***  ROUTINE nemo_gcm  ***
84      !!
85      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
86      !!              curvilinear mesh on the sphere.
87      !!
88      !! ** Method  : - model general initialization
89      !!              - launch the time-stepping (dta_dyn and trc_stp)
90      !!              - finalize the run by closing files and communications
91      !!
92      !! References : Madec, Delecluse,Imbard, and Levy, 1997:  internal report, IPSL.
93      !!              Madec, 2008, internal report, IPSL.
94      !!----------------------------------------------------------------------
95      INTEGER :: istp, indic       ! time step index
96      !!----------------------------------------------------------------------
97
98      CALL nemo_init  ! Initializations
99
100      ! check that all process are still there... If some process have an error,
101      ! they will never enter in step and other processes will wait until the end of the cpu time!
102      CALL mpp_max( 'nemogcm', nstop )
103
104      !                            !-----------------------!
105      !                            !==   time stepping   ==!
106      !                            !-----------------------!
107      istp = nit000
108      !
109      IF( ln_rnf )   CALL sbc_rnf(istp)   ! runoffs initialization
110      !
111      CALL iom_init( cxios_context )      ! iom_put initialization (must be done after nemo_init for AGRIF+XIOS+OASIS)
112      !
113      DO WHILE ( istp <= nitend .AND. nstop == 0 )    !==  OFF time-stepping  ==!
114         !
115         IF( istp /= nit000 )   CALL day        ( istp )         ! Calendar (day was already called at nit000 in day_init)
116                                CALL iom_setkt  ( istp - nit000 + 1, cxios_context )   ! say to iom that we are at time step kstp
117#if defined key_sed_off
118                                CALL dta_dyn_sed( istp,      Nnn      )       ! Interpolation of the dynamical fields
119#else
120                                CALL dta_dyn    ( istp, Nbb, Nnn, Naa )       ! Interpolation of the dynamical fields
121#endif
122                                CALL trc_stp    ( istp, Nbb, Nnn, Nrhs, Naa ) ! time-stepping
123#if ! defined key_sed_off
124         IF( .NOT.ln_linssh )   CALL dta_dyn_atf( istp, Nbb, Nnn, Naa )       ! time filter of sea  surface height and vertical scale factors
125#endif
126         ! Swap time levels
127         Nrhs = Nbb
128         Nbb = Nnn
129         Nnn = Naa
130         Naa = Nrhs
131         !
132#if ! defined key_sed_off
133         IF( .NOT.ln_linssh )   CALL dta_dyn_sf_interp( istp, Nnn )  ! calculate now grid parameters
134#endif
135                                CALL stp_ctl    ( istp, indic )  ! Time loop: control and print
136         istp = istp + 1
137      END DO
138      !
139#if defined key_iomput
140      CALL iom_context_finalize( cxios_context ) ! needed for XIOS+AGRIF
141#endif
142
143      !                            !------------------------!
144      !                            !==  finalize the run  ==!
145      !                            !------------------------!
146      IF(lwp) WRITE(numout,cform_aaa)                 ! Flag AAAAAAA
147
148      IF( nstop /= 0 .AND. lwp ) THEN                 ! error print
149         WRITE(numout,cform_err)
150         WRITE(numout,*) '   ==>>>   nemo_gcm: a total of ', nstop, ' errors have been found'
151         WRITE(numout,*)
152      ENDIF
153      !
154      IF( ln_timing )   CALL timing_finalize
155      !
156      CALL nemo_closefile
157      !
158#if defined key_iomput
159                     CALL xios_finalize   ! end mpp communications with xios
160#else
161      IF( lk_mpp )   CALL mppstop         ! end mpp communications
162#endif
163      !
164   END SUBROUTINE nemo_gcm
165
166
167   SUBROUTINE nemo_init
168      !!----------------------------------------------------------------------
169      !!                     ***  ROUTINE nemo_init  ***
170      !!
171      !! ** Purpose :   initialization of the nemo model in off-line mode
172      !!----------------------------------------------------------------------
173      INTEGER  ::   ji                 ! dummy loop indices
174      INTEGER  ::   ios, ilocal_comm   ! local integers
175      CHARACTER(len=120), DIMENSION(30) ::   cltxt, cltxt2, clnam
176      !!
177      NAMELIST/namctl/ ln_ctl   , sn_cfctl, nn_print, nn_ictls, nn_ictle,   &
178         &             nn_isplt , nn_jsplt, nn_jctls, nn_jctle,             &
179         &             ln_timing, ln_diacfl
180      NAMELIST/namcfg/ ln_read_cfg, cn_domcfg, ln_closea, ln_write_cfg, cn_domcfg_out, ln_use_jattr
181      !!----------------------------------------------------------------------
182      !
183      cltxt  = ''
184      cltxt2 = ''
185      clnam  = '' 
186      cxios_context = 'nemo'
187      !
188      !                             ! Open reference namelist and configuration namelist files
189      CALL ctl_opn( numnam_ref, 'namelist_ref', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
190      CALL ctl_opn( numnam_cfg, 'namelist_cfg', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
191      !
192      REWIND( numnam_ref )              ! Namelist namctl in reference namelist
193      READ  ( numnam_ref, namctl, IOSTAT = ios, ERR = 901 )
194901   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namctl in reference namelist', .TRUE. )
195      REWIND( numnam_cfg )              ! Namelist namctl in confguration namelist
196      READ  ( numnam_cfg, namctl, IOSTAT = ios, ERR = 902 )
197902   IF( ios >  0 )   CALL ctl_nam ( ios , 'namctl in configuration namelist', .TRUE. )
198      !
199      REWIND( numnam_ref )              ! Namelist namcfg in reference namelist
200      READ  ( numnam_ref, namcfg, IOSTAT = ios, ERR = 903 )
201903   IF( ios /= 0 )   CALL ctl_nam ( ios , 'namcfg in reference namelist', .TRUE. )
202      REWIND( numnam_cfg )              ! Namelist namcfg in confguration namelist
203      READ  ( numnam_cfg, namcfg, IOSTAT = ios, ERR = 904 )
204904   IF( ios >  0 )   CALL ctl_nam ( ios , 'namcfg in configuration namelist', .TRUE. )   
205
206      !                             !--------------------------!
207      !                             !  Set global domain size  !   (control print return in cltxt2)
208      !                             !--------------------------!
209      IF( ln_read_cfg ) THEN              ! Read sizes in domain configuration file
210         CALL domain_cfg ( cltxt2,        cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
211         !
212      ELSE                                ! user-defined namelist
213         CALL usr_def_nam( cltxt2, clnam, cn_cfg, nn_cfg, jpiglo, jpjglo, jpkglo, jperio )
214      ENDIF
215      !
216      l_offline = .true.                  ! passive tracers are run offline
217      !
218      !                             !--------------------------------------------!
219      !                             !  set communicator & select the local node  !
220      !                             !  NB: mynode also opens output.namelist.dyn !
221      !                             !      on unit number numond on first proc   !
222      !                             !--------------------------------------------!
223#if defined key_iomput
224      CALL  xios_initialize( "for_xios_mpi_id",return_comm=ilocal_comm )
225      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop, ilocal_comm )   ! Nodes selection
226#else
227      ilocal_comm = 0
228      narea = mynode( cltxt, 'output.namelist.dyn', numnam_ref, numnam_cfg, numond , nstop )                ! Nodes selection (control print return in cltxt)
229#endif
230
231      narea = narea + 1                       ! mynode return the rank of proc (0 --> jpnij -1 )
232
233      IF( sn_cfctl%l_config ) THEN
234         ! Activate finer control of report outputs
235         ! optionally switch off output from selected areas (note this only
236         ! applies to output which does not involve global communications)
237         IF( ( narea < sn_cfctl%procmin .OR. narea > sn_cfctl%procmax  ) .OR. &
238           & ( MOD( narea - sn_cfctl%procmin, sn_cfctl%procincr ) /= 0 ) )    &
239           &   CALL nemo_set_cfctl( sn_cfctl, .FALSE., .FALSE. )
240      ELSE
241         ! Use ln_ctl to turn on or off all options.
242         CALL nemo_set_cfctl( sn_cfctl, ln_ctl, .TRUE. )
243      ENDIF
244
245      lwm = (narea == 1)                      ! control of output namelists
246      lwp = (narea == 1) .OR. ln_ctl          ! control of all listing output print
247
248      IF(lwm) THEN               ! write merged namelists from earlier to output namelist
249         !                       ! now that the file has been opened in call to mynode.
250         !                       ! NB: nammpp has already been written in mynode (if lk_mpp_mpi)
251         WRITE( numond, namctl )
252         WRITE( numond, namcfg )
253         IF( .NOT.ln_read_cfg ) THEN
254            DO ji = 1, SIZE(clnam)
255               IF( TRIM(clnam(ji)) /= '' )   WRITE(numond, * ) clnam(ji)     ! namusr_def print
256            END DO
257         ENDIF
258      ENDIF
259
260      IF(lwp) THEN                            ! open listing units
261         !
262         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
263         !
264         WRITE(numout,*)
265         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
266         WRITE(numout,*) '                       NEMO team'
267         WRITE(numout,*) '                   Off-line TOP Model'
268         WRITE(numout,*) '                NEMO version 4.0  (2019) '
269         WRITE(numout,*)
270         WRITE(numout,*) "           ._      ._      ._      ._      ._    "
271         WRITE(numout,*) "       _.-._)`\_.-._)`\_.-._)`\_.-._)`\_.-._)`\_ "
272         WRITE(numout,*)
273         WRITE(numout,*) "           o         _,           _,             "
274         WRITE(numout,*) "            o      .' (        .-' /             "
275         WRITE(numout,*) "           o     _/..._'.    .'   /              "
276         WRITE(numout,*) "      (    o .-'`      ` '-./  _.'               "
277         WRITE(numout,*) "       )    ( o)           ;= <_         (       "
278         WRITE(numout,*) "      (      '-.,\\__ __.-;`\   '.        )      "
279         WRITE(numout,*) "       )  )       \) |`\ \)  '.   \      (   (   "
280         WRITE(numout,*) "      (  (           \_/       '-._\      )   )  "
281         WRITE(numout,*) "       )  )                        `     (   (   "
282         WRITE(numout,*) "     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ "
283         WRITE(numout,*)
284         DO ji = 1, SIZE(cltxt)
285            IF( TRIM(cltxt (ji)) /= '' )   WRITE(numout,*) TRIM(cltxt(ji))    ! control print of mynode
286         END DO
287         WRITE(numout,*)
288         WRITE(numout,*)
289         DO ji = 1, SIZE(cltxt2)
290            IF( TRIM(cltxt2(ji)) /= '' )   WRITE(numout,*) TRIM(cltxt2(ji))   ! control print of domain size
291         END DO
292         !
293         WRITE(numout,cform_aaa)                                        ! Flag AAAAAAA
294         !
295      ENDIF
296      ! open /dev/null file to be able to supress output write easily
297      CALL ctl_opn( numnul, '/dev/null', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
298      !
299      !                                      ! Domain decomposition
300      CALL mpp_init                          ! MPP
301
302      ! Now we know the dimensions of the grid and numout has been set: we can allocate arrays
303      CALL nemo_alloc()
304
305      ! Initialise time level indices
306      Nbb = 1; Nnn = 2; Naa = 3; Nrhs = Naa
307   
308
309      !                             !-------------------------------!
310      !                             !  NEMO general initialization  !
311      !                             !-------------------------------!
312
313      CALL nemo_ctl                          ! Control prints
314      !
315      !                                      ! General initialization
316      IF( ln_timing    )   CALL timing_init
317      IF( ln_timing    )   CALL timing_start( 'nemo_init')
318      !
319                           CALL     phy_cst         ! Physical constants
320                           CALL     eos_init        ! Equation of state
321      IF( lk_c1d       )   CALL     c1d_init        ! 1D column configuration
322                           CALL     dom_init( Nbb, Nnn, Naa, "OPA") ! Domain
323      IF( ln_ctl       )   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                         ! 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 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,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
371         WRITE(numout,*) '       finer control over o/p sn_cfctl%l_config  = ', sn_cfctl%l_config
372         WRITE(numout,*) '                              sn_cfctl%l_runstat = ', sn_cfctl%l_runstat
373         WRITE(numout,*) '                              sn_cfctl%l_trcstat = ', sn_cfctl%l_trcstat
374         WRITE(numout,*) '                              sn_cfctl%l_oceout  = ', sn_cfctl%l_oceout
375         WRITE(numout,*) '                              sn_cfctl%l_layout  = ', sn_cfctl%l_layout
376         WRITE(numout,*) '                              sn_cfctl%l_mppout  = ', sn_cfctl%l_mppout
377         WRITE(numout,*) '                              sn_cfctl%l_mpptop  = ', sn_cfctl%l_mpptop
378         WRITE(numout,*) '                              sn_cfctl%procmin   = ', sn_cfctl%procmin 
379         WRITE(numout,*) '                              sn_cfctl%procmax   = ', sn_cfctl%procmax 
380         WRITE(numout,*) '                              sn_cfctl%procincr  = ', sn_cfctl%procincr 
381         WRITE(numout,*) '                              sn_cfctl%ptimincr  = ', sn_cfctl%ptimincr 
382         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
383         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
384         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
385         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
386         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
387         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
388         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
389         WRITE(numout,*) '      timing by routine               ln_timing  = ', ln_timing
390         WRITE(numout,*) '      CFL diagnostics                 ln_diacfl  = ', ln_diacfl
391      ENDIF
392      !
393      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
394      nictls    = nn_ictls
395      nictle    = nn_ictle
396      njctls    = nn_jctls
397      njctle    = nn_jctle
398      isplt     = nn_isplt
399      jsplt     = nn_jsplt
400
401      IF(lwp) THEN                  ! control print
402         WRITE(numout,*)
403         WRITE(numout,*) '   Namelist namcfg'
404         WRITE(numout,*) '      read domain configuration file              ln_read_cfg      = ', ln_read_cfg
405         WRITE(numout,*) '         filename to be read                         cn_domcfg     = ', TRIM(cn_domcfg)
406         WRITE(numout,*) '         keep closed seas in the domain (if exist)   ln_closea     = ', ln_closea
407         WRITE(numout,*) '      create a configuration definition file      ln_write_cfg     = ', ln_write_cfg
408         WRITE(numout,*) '         filename to be written                      cn_domcfg_out = ', TRIM(cn_domcfg_out)
409         WRITE(numout,*) '      use file attribute if exists as i/p j-start ln_use_jattr     = ', ln_use_jattr
410      ENDIF
411      IF( .NOT.ln_read_cfg )   ln_closea = .false.   ! dealing possible only with a domcfg file
412      !
413      !                             ! Parameter control
414      !
415      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
416         IF( lk_mpp .AND. jpnij > 1 ) THEN
417            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
418         ELSE
419            IF( isplt == 1 .AND. jsplt == 1  ) THEN
420               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
421                  &           ' - the print control will be done over the whole domain' )
422            ENDIF
423            ijsplt = isplt * jsplt            ! total number of processors ijsplt
424         ENDIF
425         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
426         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
427         !
428         !                              ! indices used for the SUM control
429         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
430            lsp_area = .FALSE.
431         ELSE                                             ! print control done over a specific  area
432            lsp_area = .TRUE.
433            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
434               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
435               nictls = 1
436            ENDIF
437            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
438               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
439               nictle = jpiglo
440            ENDIF
441            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
442               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
443               njctls = 1
444            ENDIF
445            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
446               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
447               njctle = jpjglo
448            ENDIF
449         ENDIF
450      ENDIF
451      !
452      IF( 1._wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows f2003 standard.',  &
453         &                                                'Compile with key_nosignedzero enabled' )
454      !
455   END SUBROUTINE nemo_ctl
456
457
458   SUBROUTINE nemo_closefile
459      !!----------------------------------------------------------------------
460      !!                     ***  ROUTINE nemo_closefile  ***
461      !!
462      !! ** Purpose :   Close the files
463      !!----------------------------------------------------------------------
464      !
465      IF( lk_mpp )   CALL mppsync
466      !
467      CALL iom_close                                 ! close all input/output files managed by iom_*
468      !
469      IF( numstp     /= -1 )   CLOSE( numstp     )   ! time-step file
470      IF( numnam_ref /= -1 )   CLOSE( numnam_ref )   ! oce reference namelist
471      IF( numnam_cfg /= -1 )   CLOSE( numnam_cfg )   ! oce configuration namelist
472      IF( numout     /=  6 )   CLOSE( numout     )   ! standard model output file
473      IF( lwm.AND.numond  /= -1 )   CLOSE( numond          )   ! oce output namelist
474      !
475      numout = 6                                     ! redefine numout in case it is used after this point...
476      !
477   END SUBROUTINE nemo_closefile
478
479
480   SUBROUTINE nemo_alloc
481      !!----------------------------------------------------------------------
482      !!                     ***  ROUTINE nemo_alloc  ***
483      !!
484      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
485      !!
486      !! ** Method  :
487      !!----------------------------------------------------------------------
488      USE diawri ,   ONLY : dia_wri_alloc
489      USE dom_oce,   ONLY : dom_oce_alloc
490      USE zdf_oce,   ONLY : zdf_oce_alloc
491      USE trc_oce,   ONLY : trc_oce_alloc
492      !
493      INTEGER :: ierr
494      !!----------------------------------------------------------------------
495      !
496      ierr =        oce_alloc    ()          ! ocean
497      ierr = ierr + dia_wri_alloc()
498      ierr = ierr + dom_oce_alloc()          ! ocean domain
499      ierr = ierr + zdf_oce_alloc()          ! ocean vertical physics
500      ierr = ierr + trc_oce_alloc()          ! shared TRC / TRA arrays
501      !
502      CALL mpp_sum( 'nemogcm', ierr )
503      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc: unable to allocate standard ocean arrays' )
504      !
505   END SUBROUTINE nemo_alloc
506
507   SUBROUTINE nemo_set_cfctl(sn_cfctl, setto, for_all )
508      !!----------------------------------------------------------------------
509      !!                     ***  ROUTINE nemo_set_cfctl  ***
510      !!
511      !! ** Purpose :   Set elements of the output control structure to setto.
512      !!                for_all should be .false. unless all areas are to be
513      !!                treated identically.
514      !!
515      !! ** Method  :   Note this routine can be used to switch on/off some
516      !!                types of output for selected areas but any output types
517      !!                that involve global communications (e.g. mpp_max, glob_sum)
518      !!                should be protected from selective switching by the
519      !!                for_all argument
520      !!----------------------------------------------------------------------
521      LOGICAL :: setto, for_all
522      TYPE(sn_ctl) :: sn_cfctl
523      !!----------------------------------------------------------------------
524      IF( for_all ) THEN
525         sn_cfctl%l_runstat = setto
526         sn_cfctl%l_trcstat = setto
527      ENDIF
528      sn_cfctl%l_oceout  = setto
529      sn_cfctl%l_layout  = setto
530      sn_cfctl%l_mppout  = setto
531      sn_cfctl%l_mpptop  = 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   !!======================================================================
583END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.