New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
nemogcm.F90 in NEMO/trunk/src/OFF – NEMO

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

Last change on this file since 14229 was 14229, checked in by smasson, 3 years ago

trunk: replace key_mpp_mpi by the opposite key key_mpi_off

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