source: NEMO/branches/2020/dev_r12563_ASINTER-06_ABL_improvement/src/OFF/nemogcm.F90 @ 13159

Last change on this file since 13159 was 13159, checked in by gsamson, 3 months ago

merge trunk@r13136 into ASINTER-06 branch; pass all SETTE tests; results identical to trunk@r13136; ticket #2419

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