source: NEMO/trunk/src/OFF/nemogcm.F90 @ 13237

Last change on this file since 13237 was 13237, checked in by smasson, 3 months ago

trunk: Mid-year merge, merge back KERNEL-06_techene_e3

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