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 branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OFF_SRC – NEMO

source: branches/dev_r2586_dynamic_mem/NEMOGCM/NEMO/OFF_SRC/nemogcm.F90 @ 2666

Last change on this file since 2666 was 2666, checked in by cetlod, 12 years ago

Offline: minor updates

File size: 22.0 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   !!            4.0  ! 2011-01  (C. Ethe, A. R. Porter, STFC Daresbury) dynamical allocation
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   nemo_gcm        : off-line: solve ocean tracer only
12   !!   nemo_init       : initialization of the nemo model
13   !!   nemo_ctl        : initialisation of algorithm flag
14   !!   nemo_closefile  : close remaining files
15   !!----------------------------------------------------------------------
16   USE dom_oce         ! ocean space domain variables
17   USE oce             ! dynamics and tracers variables
18   USE c1d             ! 1D configuration
19   USE domcfg          ! domain configuration               (dom_cfg routine)
20   USE domain          ! domain initialization             (dom_init routine)
21   USE istate          ! initial state setting          (istate_init routine)
22   USE eosbn2          ! equation of state            (eos bn2 routine)
23   !              ! ocean physics
24   USE ldftra          ! lateral diffusivity setting    (ldf_tra_init routine)
25   USE ldfslp          ! slopes of neutral surfaces     (ldf_slp_init routine)
26   USE traqsr          ! solar radiation penetration    (tra_qsr_init routine)
27   USE trabbl          ! bottom boundary layer          (tra_bbl_init routine)
28   USE zdfini          ! vertical physics: initialization
29   USE sbcmod          ! surface boundary condition       (sbc_init     routine)
30   USE phycst          ! physical constant                  (par_cst routine)
31   USE dtadyn          ! Lecture and Interpolation of the dynamical fields
32   USE trcini          ! Initilization of the passive tracers
33   USE daymod          ! calendar                         (day     routine)
34   USE trcstp          ! passive tracer time-stepping      (trc_stp routine)
35   USE dtadyn          ! Lecture and interpolation of the dynamical fields
36   USE stpctl          ! time stepping control            (stp_ctl routine)
37   !              ! I/O & MPP
38   USE iom             ! I/O library
39   USE in_out_manager  ! I/O manager
40   USE mppini          ! shared/distributed memory setting (mpp_init routine)
41   USE lib_mpp         ! distributed memory computing
42#if defined key_iomput
43   USE  mod_ioclient
44#endif
45
46   IMPLICIT NONE
47   PRIVATE
48   
49   PUBLIC   nemo_gcm   ! called by nemo.F90
50
51   CHARACTER (len=64) ::   cform_aaa="( /, 'AAAAAAAA', / ) "   ! flag for output listing
52
53   !!----------------------------------------------------------------------
54   !! NEMO/OFF 3.3 , NEMO Consortium (2010)
55   !! $Id: nemogcm.F90 2528 2010-12-27 17:33:53Z rblod $
56   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
57   !!----------------------------------------------------------------------
58CONTAINS
59
60   SUBROUTINE nemo_gcm
61      !!----------------------------------------------------------------------
62      !!                     ***  ROUTINE nemo_gcm  ***
63      !!
64      !! ** Purpose :   nemo solves the primitive equations on an orthogonal
65      !!      curvilinear mesh on the sphere.
66      !!
67      !! ** Method  : - model general initialization
68      !!              - launch the time-stepping (dta_dyn and trc_stp)
69      !!              - finalize the run by closing files and communications
70      !!
71      !! References : Madec, Delecluse,Imbard, and Levy, 1997:  internal report, IPSL.
72      !!              Madec, 2008, internal report, IPSL.
73      !!----------------------------------------------------------------------
74      INTEGER :: istp, indic       ! time step index
75      !!----------------------------------------------------------------------
76
77      CALL nemo_init  ! Initializations
78
79      IF( lk_mpp )   CALL mpp_max( nstop )
80
81      ! check that all process are still there... If some process have an error,
82      ! they will never enter in step and other processes will wait until the end of the cpu time!
83      IF( lk_mpp )   CALL mpp_max( nstop )
84
85      !                            !-----------------------!
86      !                            !==   time stepping   ==!
87      !                            !-----------------------!
88      istp = nit000
89         !
90      DO WHILE ( istp <= nitend .AND. nstop == 0 )    ! time stepping
91         !
92         IF( istp /= nit000 )   CALL day      ( istp )         ! Calendar (day was already called at nit000 in day_init)
93                                CALL iom_setkt( istp )         ! say to iom that we are at time step kstp
94                                CALL dta_dyn  ( istp )         ! Interpolation of the dynamical fields
95                                CALL trc_stp  ( istp )         ! time-stepping
96                                CALL stp_ctl  ( istp, indic )  ! Time loop: control and print
97         istp = istp + 1
98         IF( lk_mpp )   CALL mpp_max( nstop )
99      END DO
100
101      !                            !------------------------!
102      !                            !==  finalize the run  ==!
103      !                            !------------------------!
104      IF(lwp) WRITE(numout,cform_aaa)                 ! Flag AAAAAAA
105
106      IF( nstop /= 0 .AND. lwp ) THEN                 ! error print
107         WRITE(numout,cform_err)
108         WRITE(numout,*) nstop, ' error have been found'
109      ENDIF
110      !
111      CALL nemo_closefile
112      !
113      IF( lk_mpp )   CALL mppstop                          ! Close all files (mpp)
114      !
115   END SUBROUTINE nemo_gcm
116
117
118   SUBROUTINE nemo_init
119      !!----------------------------------------------------------------------
120      !!                     ***  ROUTINE nemo_init ***
121      !!
122      !! ** Purpose :   initialization of the nemo model in off-line mode
123      !!----------------------------------------------------------------------
124      INTEGER ::   ji            ! dummy loop indices
125      INTEGER ::   ilocal_comm   ! local integer
126      CHARACTER(len=80), DIMENSION(10) ::   cltxt = ''
127      !!
128      NAMELIST/namctl/ ln_ctl  , nn_print, nn_ictls, nn_ictle,   &
129         &             nn_isplt, nn_jsplt, nn_jctls, nn_jctle, nn_bench
130      !!----------------------------------------------------------------------
131      !
132      !                             ! open Namelist file     
133      CALL ctl_opn( numnam, 'namelist', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
134      !
135      READ( numnam, namctl )        ! Namelist namctl : Control prints & Benchmark
136      !
137      !                             !--------------------------------------------!
138      !                             !  set communicator & select the local node  !
139      !                             !--------------------------------------------!
140#if defined key_iomput
141      CALL  init_ioclient( ilocal_comm )                 ! exchange io_server nemo local communicator with the io_server
142      narea = mynode( cltxt, numnam, nstop, ilocal_comm )   ! Nodes selection
143#else
144      ilocal_comm = 0
145      narea = mynode( cltxt, numnam, nstop )                 ! Nodes selection (control print return in cltxt)
146#endif
147
148      narea = narea + 1                       ! mynode return the rank of proc (0 --> jpnij -1 )
149
150      lwp = (narea == 1) .OR. ln_ctl          ! control of all listing output print
151
152      ! Decide on size of grid now that we have our communicator size
153      ! If we're not using dynamic memory then mpp_partition does nothing.
154
155#if   defined key_mpp_mpi   ||   defined key_mpp_shmem
156      CALL nemo_partition(mppsize)
157#else
158      jpni = 1
159      jpnj = 1
160      jpnij = jpni*jpnj
161#endif
162      ! Calculate domain dimensions given calculated jpni and jpnj
163      ! This used to be done in par_oce.F90 when they were parameters rather
164      ! than variables
165      jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci !: first  dim.
166      jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj !: second dim.
167      jpk = jpkdta                                           !: third dim
168      jpim1 = jpi-1                                          !: inner domain indices
169      jpjm1 = jpj-1                                          !:   "           "
170      jpkm1 = jpk-1                                          !:   "           "
171      jpij  = jpi*jpj                                        !:  jpi x j
172
173
174      IF(lwp) THEN                            ! open listing units
175         !
176         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
177         !
178         WRITE(numout,*)
179         WRITE(numout,*) '         CNRS - NERC - Met OFFICE - MERCATOR-ocean'
180         WRITE(numout,*) '                       NEMO team'
181         WRITE(numout,*) '            Ocean General Circulation Model'
182         WRITE(numout,*) '                  version 3.3  (2010) '
183         WRITE(numout,*)
184         WRITE(numout,*)
185         DO ji = 1, SIZE(cltxt) 
186            IF( TRIM(cltxt(ji)) /= '' )   WRITE(numout,*) cltxt(ji)      ! control print of mynode
187         END DO
188         WRITE(numout,cform_aaa)                                         ! Flag AAAAAAA
189         !
190      ENDIF
191
192      ! Now we know the dimensions of the grid and numout has been set we can
193      ! allocate arrays
194      CALL nemo_alloc()
195
196      !                             !--------------------------------!
197      !                             !  Model general initialization  !
198      !                             !--------------------------------!
199
200      CALL nemo_ctl                           ! Control prints & Benchmark
201
202      !                                      ! Domain decomposition
203      IF( jpni*jpnj == jpnij ) THEN   ;   CALL mpp_init      ! standard cutting out
204      ELSE                            ;   CALL mpp_init2     ! eliminate land processors
205      ENDIF
206      !
207      !                                      ! General initialization
208                            CALL     phy_cst    ! Physical constants
209                            CALL     eos_init   ! Equation of state
210                            CALL     dom_cfg    ! Domain configuration
211                            CALL     dom_init   ! Domain
212                            CALL  istate_init   ! ocean initial state (Dynamics and tracers)
213
214      !                                     ! Ocean physics
215                            CALL     sbc_init   ! Forcings : surface module
216#if ! defined key_degrad
217                            CALL ldf_tra_init   ! Lateral ocean tracer physics
218#endif
219      IF( lk_ldfslp )       CALL ldf_slp_init   ! slope of lateral mixing
220
221      !                                     ! Active tracers
222                            CALL tra_qsr_init   ! penetrative solar radiation qsr
223      IF( lk_trabbl     )   CALL tra_bbl_init   ! advective (and/or diffusive) bottom boundary layer scheme
224
225      !                                     ! Passive tracers
226                            CALL     trc_init   ! Passive tracers initialization
227      !                                     ! Dynamics
228                            CALL dta_dyn_init   ! Initialization for the dynamics
229                            CALL     iom_init       ! iom_put initialization
230
231      IF(lwp) WRITE(numout,cform_aaa)       ! Flag AAAAAAA
232      !
233   END SUBROUTINE nemo_init
234
235
236   SUBROUTINE nemo_ctl
237      !!----------------------------------------------------------------------
238      !!                     ***  ROUTINE nemo_ctl  ***
239      !!
240      !! ** Purpose :   control print setting
241      !!
242      !! ** Method  : - print namctl information and check some consistencies
243      !!----------------------------------------------------------------------
244      !
245      IF(lwp) THEN                  ! Parameter print
246         WRITE(numout,*)
247         WRITE(numout,*) 'nemo_flg: Control prints & Benchmark'
248         WRITE(numout,*) '~~~~~~~ '
249         WRITE(numout,*) '   Namelist namctl'
250         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
251         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
252         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
253         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
254         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
255         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
256         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
257         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
258         WRITE(numout,*) '      benchmark parameter (0/1)       nn_bench   = ', nn_bench
259      ENDIF
260      !
261      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
262      nictls    = nn_ictls
263      nictle    = nn_ictle
264      njctls    = nn_jctls
265      njctle    = nn_jctle
266      isplt     = nn_isplt
267      jsplt     = nn_jsplt
268      nbench    = nn_bench
269      !                             ! Parameter control
270      !
271      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
272         IF( lk_mpp ) THEN
273            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real splitted domain
274         ELSE
275            IF( isplt == 1 .AND. jsplt == 1  ) THEN
276               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
277                  &           ' - the print control will be done over the whole domain' )
278            ENDIF
279            ijsplt = isplt * jsplt            ! total number of processors ijsplt
280         ENDIF
281         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
282         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
283         !
284         !                              ! indices used for the SUM control
285         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
286            lsp_area = .FALSE.
287         ELSE                                             ! print control done over a specific  area
288            lsp_area = .TRUE.
289            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
290               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
291               nictls = 1
292            ENDIF
293            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
294               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
295               nictle = jpiglo
296            ENDIF
297            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
298               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
299               njctls = 1
300            ENDIF
301            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
302               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
303               njctle = jpjglo
304            ENDIF
305         ENDIF
306      ENDIF
307      !
308      IF( nbench == 1 )   THEN            ! Benchmark
309         SELECT CASE ( cp_cfg )
310         CASE ( 'gyre' )   ;   CALL ctl_warn( ' The Benchmark is activated ' )
311         CASE DEFAULT      ;   CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:',   &
312            &                                 ' key_gyre must be used or set nbench = 0' )
313         END SELECT
314      ENDIF
315      !
316      IF( lk_c1d .AND. .NOT.lk_iomput )   CALL ctl_stop( 'nemo_ctl: The 1D configuration must be used ',   &
317         &                                               'with the IOM Input/Output manager. '        ,   &
318         &                                               'Compile with key_iomput enabled' )
319      !
320   END SUBROUTINE nemo_ctl
321
322
323   SUBROUTINE nemo_closefile
324      !!----------------------------------------------------------------------
325      !!                     ***  ROUTINE nemo_closefile  ***
326      !!
327      !! ** Purpose :   Close the files
328      !!----------------------------------------------------------------------
329      !
330      IF ( lk_mpp ) CALL mppsync
331      !
332      CALL iom_close                                 ! close all input/output files managed by iom_*
333      !
334      IF( numstp     /= -1 )   CLOSE( numstp     )   ! time-step file
335      IF( numnam     /= -1 )   CLOSE( numnam     )   ! oce namelist
336      IF( numout     /=  6 )   CLOSE( numout     )   ! standard model output file
337      numout = 6                                     ! redefine numout in case it is used after this point...
338      !
339   END SUBROUTINE nemo_closefile
340
341   SUBROUTINE nemo_alloc
342     !!----------------------------------------------------------------------
343     !!                     ***  ROUTINE nemo_alloc  ***
344     !!
345     !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
346     !!
347     !! ** Method  :
348     !!----------------------------------------------------------------------
349     USE diawri,       ONLY: dia_wri_alloc
350     USE dom_oce,      ONLY: dom_oce_alloc
351     USE zdf_oce,      ONLY: zdf_oce_alloc
352     USE zdfmxl,       ONLY: zdf_mxl_alloc
353     USE ldftra_oce,   ONLY: ldftra_oce_alloc
354     USE trc_oce,      ONLY: trc_oce_alloc
355
356      USE wrk_nemo,    ONLY: wrk_alloc
357
358      INTEGER :: ierr
359      !!----------------------------------------------------------------------
360
361      ierr =        oce_alloc       ()          ! ocean
362      ierr = ierr + dia_wri_alloc   ()
363      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
364      ierr = ierr + ldftra_oce_alloc()          ! ocean lateral  physics : tracers
365      ierr = ierr + zdf_oce_alloc   ()          ! ocean vertical physics
366      ierr = ierr + zdf_mxl_alloc   ()          ! ocean vertical physics
367      !
368      ierr = ierr + lib_mpp_alloc   (numout)    ! mpp exchanges
369      ierr = ierr + trc_oce_alloc   ()          ! shared TRC / TRA arrays
370      ierr = ierr + wrk_alloc(numout, lwp)
371
372      IF( lk_mpp    )   CALL mpp_sum( ierr )
373      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
374      !
375   END SUBROUTINE nemo_alloc
376
377   SUBROUTINE nemo_partition( num_pes )
378      !!----------------------------------------------------------------------
379      !!                 ***  ROUTINE nemo_partition  ***
380      !!
381      !! ** Purpose :   
382      !!
383      !! ** Method  :
384      !!----------------------------------------------------------------------
385      INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
386      !
387      INTEGER, PARAMETER :: nfactmax = 20
388      INTEGER :: nfact ! The no. of factors returned
389      INTEGER :: ierr  ! Error flag
390      INTEGER :: ji
391      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
392      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
393      !!----------------------------------------------------------------------
394
395      ierr = 0
396
397      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
398
399      IF( nfact <= 1 ) THEN
400         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
401         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
402         jpnj = 1
403         jpni = num_pes
404      ELSE
405         ! Search through factors for the pair that are closest in value
406         mindiff = 1000000
407         imin    = 1
408         DO ji = 1, nfact-1, 2
409            idiff = ABS( ifact(ji) - ifact(ji+1) )
410            IF( idiff < mindiff ) THEN
411               mindiff = idiff
412               imin = ji
413            ENDIF
414         END DO
415         jpnj = ifact(imin)
416         jpni = ifact(imin + 1)
417      ENDIF
418      jpnij = jpni*jpnj
419
420      WRITE(*,*) 'ARPDBG: jpni = ',jpni,'jpnj = ',jpnj,'jpnij = ',jpnij
421      !
422   END SUBROUTINE nemo_partition
423
424   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
425      !!----------------------------------------------------------------------
426      !!                     ***  ROUTINE factorise  ***
427      !!
428      !! ** Purpose :   return the prime factors of n.
429      !!                knfax factors are returned in array kfax which is of
430      !!                maximum dimension kmaxfax.
431      !! ** Method  :
432      !!----------------------------------------------------------------------
433      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
434      INTEGER                    , INTENT(  out) ::   kerr, knfax
435      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
436      !
437      INTEGER :: ifac, jl, inu
438      INTEGER, PARAMETER :: ntest = 14
439      INTEGER :: ilfax(ntest)
440
441      ! lfax contains the set of allowed factors.
442      data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256,  &
443         &                            128,   64,   32,   16,    8,   4,   2  /
444      !!----------------------------------------------------------------------
445
446      ! Clear the error flag and initialise output vars
447      kerr = 0
448      kfax = 1
449      knfax = 0
450
451      ! Find the factors of n.
452      IF( kn == 1 )   GOTO 20
453
454      ! nu holds the unfactorised part of the number.
455      ! knfax holds the number of factors found.
456      ! l points to the allowed factor list.
457      ! ifac holds the current factor.
458
459      inu   = kn
460      knfax = 0
461
462      DO jl = ntest, 1, -1
463         !
464         ifac = ilfax(jl)
465         IF( ifac > inu )   CYCLE
466
467         ! Test whether the factor will divide.
468
469         IF( MOD(inu,ifac) == 0 ) THEN
470            !
471            knfax = knfax + 1            ! Add the factor to the list
472            IF( knfax > kmaxfax ) THEN
473               kerr = 6
474               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
475               return
476            ENDIF
477            kfax(knfax) = ifac
478            ! Store the other factor that goes with this one
479            knfax = knfax + 1
480            kfax(knfax) = inu / ifac
481            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
482         ENDIF
483         !
484      END DO
485
486   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
487      !
488   END SUBROUTINE factorise
489
490   !!======================================================================
491END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.