source: branches/2012/dev_MERGE_2012/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 3769

Last change on this file since 3769 was 3769, checked in by smasson, 8 years ago

dev_MERGE_2012: xios+agrif+oasis compliant

  • Property svn:keywords set to Id
File size: 37.2 KB
Line 
1MODULE nemogcm
2   !!======================================================================
3   !!                       ***  MODULE nemogcm   ***
4   !! Ocean system   : NEMO GCM (ocean dynamics, on-line tracers, biochemistry and sea-ice)
5   !!======================================================================
6   !! History :  OPA  ! 1990-10  (C. Levy, G. Madec)  Original code
7   !!            7.0  ! 1991-11  (M. Imbard, C. Levy, G. Madec)
8   !!            7.1  ! 1993-03  (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
9   !!                             P. Delecluse, C. Perigaud, G. Caniaux, B. Colot, C. Maes) release 7.1
10   !!             -   ! 1992-06  (L.Terray)  coupling implementation
11   !!             -   ! 1993-11  (M.A. Filiberti) IGLOO sea-ice
12   !!            8.0  ! 1996-03  (M. Imbard, C. Levy, G. Madec, O. Marti, M. Guyon, A. Lazar,
13   !!                             P. Delecluse, L.Terray, M.A. Filiberti, J. Vialar, A.M. Treguier, M. Levy) release 8.0
14   !!            8.1  ! 1997-06  (M. Imbard, G. Madec)
15   !!            8.2  ! 1999-11  (M. Imbard, H. Goosse)  LIM sea-ice model
16   !!                 ! 1999-12  (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols)  OPEN-MP
17   !!                 ! 2000-07  (J-M Molines, M. Imbard)  Open Boundary Conditions  (CLIPPER)
18   !!   NEMO     1.0  ! 2002-08  (G. Madec)  F90: Free form and modules
19   !!             -   ! 2004-06  (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces
20   !!             -   ! 2004-08  (C. Talandier) New trends organization
21   !!             -   ! 2005-06  (C. Ethe) Add the 1D configuration possibility
22   !!             -   ! 2005-11  (V. Garnier) Surface pressure gradient organization
23   !!             -   ! 2006-03  (L. Debreu, C. Mazauric)  Agrif implementation
24   !!             -   ! 2006-04  (G. Madec, R. Benshila)  Step reorganization
25   !!             -   ! 2007-07  (J. Chanut, A. Sellar) Unstructured open boundaries (BDY)
26   !!            3.2  ! 2009-08  (S. Masson)  open/write in the listing file in mpp
27   !!            3.3  ! 2010-05  (K. Mogensen, A. Weaver, M. Martin, D. Lea) Assimilation interface
28   !!             -   ! 2010-10  (C. Ethe, G. Madec) reorganisation of initialisation phase
29   !!            3.3.1! 2011-01  (A. R. Porter, STFC Daresbury) dynamical allocation
30   !!            3.4  ! 2011-11  (C. Harris) decomposition changes for running with CICE
31   !!----------------------------------------------------------------------
32
33   !!----------------------------------------------------------------------
34   !!   nemo_gcm       : solve ocean dynamics, tracer, biogeochemistry and/or sea-ice
35   !!   nemo_init      : initialization of the NEMO system
36   !!   nemo_ctl       : initialisation of the contol print
37   !!   nemo_closefile : close remaining open files
38   !!   nemo_alloc     : dynamical allocation
39   !!   nemo_partition : calculate MPP domain decomposition
40   !!   factorise      : calculate the factors of the no. of MPI processes
41   !!----------------------------------------------------------------------
42   USE step_oce        ! module used in the ocean time stepping module
43   USE sbc_oce         ! surface boundary condition: ocean
44   USE cla             ! cross land advection               (tra_cla routine)
45   USE domcfg          ! domain configuration               (dom_cfg routine)
46   USE mppini          ! shared/distributed memory setting (mpp_init routine)
47   USE domain          ! domain initialization             (dom_init routine)
48#if defined key_nemocice_decomp
49   USE ice_domain_size, only: nx_global, ny_global
50#endif
51   USE tideini         ! tidal components initialization   (tide_ini routine)
52   USE obcini          ! open boundary cond. initialization (obc_ini routine)
53   USE bdyini          ! open boundary cond. initialization (bdy_init routine)
54   USE bdydta          ! open boundary cond. initialization (bdy_dta_init routine)
55   USE bdytides        ! open boundary cond. initialization (bdytide_init routine)
56   USE istate          ! initial state setting          (istate_init routine)
57   USE ldfdyn          ! lateral viscosity setting      (ldfdyn_init routine)
58   USE ldftra          ! lateral diffusivity setting    (ldftra_init routine)
59   USE zdfini          ! vertical physics setting          (zdf_init routine)
60   USE phycst          ! physical constant                  (par_cst routine)
61   USE trdmod          ! momentum/tracers trends       (trd_mod_init routine)
62   USE asminc          ! assimilation increments     
63   USE asmbkg          ! writing out state trajectory
64   USE diaptr          ! poleward transports           (dia_ptr_init routine)
65   USE diadct          ! sections transports           (dia_dct_init routine)
66   USE diaobs          ! Observation diagnostics       (dia_obs_init routine)
67   USE lib_fortran     ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined)
68   USE step            ! NEMO time-stepping                 (stp     routine)
69   USE icbini          ! handle bergs, initialisation
70   USE icbstp          ! handle bergs, calving, themodynamics and transport
71#if defined key_oasis3
72   USE cpl_oasis3      ! OASIS3 coupling
73#elif defined key_oasis4
74   USE cpl_oasis4      ! OASIS4 coupling (not working)
75#endif
76   USE c1d             ! 1D configuration
77   USE step_c1d        ! Time stepping loop for the 1D configuration
78#if defined key_top
79   USE trcini          ! passive tracer initialisation
80#endif
81   USE lib_mpp         ! distributed memory computing
82#if defined key_iomput
83   USE xios
84#endif
85   USE sbctide, ONLY: lk_tide
86
87   IMPLICIT NONE
88   PRIVATE
89
90   PUBLIC   nemo_gcm    ! called by model.F90
91   PUBLIC   nemo_init   ! needed by AGRIF
92   PUBLIC   nemo_alloc  ! needed by TAM
93
94   CHARACTER(lc) ::   cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
95
96   !!----------------------------------------------------------------------
97   !! NEMO/OPA 4.0 , NEMO Consortium (2011)
98   !! $Id$
99   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
100   !!----------------------------------------------------------------------
101CONTAINS
102
103   SUBROUTINE nemo_gcm
104      !!----------------------------------------------------------------------
105      !!                     ***  ROUTINE nemo_gcm  ***
106      !!
107      !! ** Purpose :   NEMO solves the primitive equations on an orthogonal
108      !!              curvilinear mesh on the sphere.
109      !!
110      !! ** Method  : - model general initialization
111      !!              - launch the time-stepping (stp routine)
112      !!              - finalize the run by closing files and communications
113      !!
114      !! References : Madec, Delecluse, Imbard, and Levy, 1997:  internal report, IPSL.
115      !!              Madec, 2008, internal report, IPSL.
116      !!----------------------------------------------------------------------
117      INTEGER ::   istp       ! time step index
118      !!----------------------------------------------------------------------
119      !
120#if defined key_agrif
121      CALL Agrif_Init_Grids()      ! AGRIF: set the meshes
122#endif
123
124      !                            !-----------------------!
125      CALL nemo_init               !==  Initialisations  ==!
126      !                            !-----------------------!
127#if defined key_agrif
128      CALL Agrif_Declare_Var_dom   ! AGRIF: set the meshes for DOM
129      CALL Agrif_Declare_Var       !  "      "   "   "      "  DYN/TRA
130# if defined key_top
131      CALL Agrif_Declare_Var_top   !  "      "   "   "      "  TOP
132# endif
133# if defined key_lim2
134      CALL Agrif_Declare_Var_lim2  !  "      "   "   "      "  LIM
135# endif
136#endif
137      ! check that all process are still there... If some process have an error,
138      ! they will never enter in step and other processes will wait until the end of the cpu time!
139      IF( lk_mpp )   CALL mpp_max( nstop )
140
141      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
142
143      !                            !-----------------------!
144      !                            !==   time stepping   ==!
145      !                            !-----------------------!
146      istp = nit000
147#if defined key_c1d
148         DO WHILE ( istp <= nitend .AND. nstop == 0 )
149            CALL stp_c1d( istp )
150            istp = istp + 1
151         END DO
152#else
153          IF( lk_asminc ) THEN
154             IF( ln_bkgwri ) CALL asm_bkg_wri( nit000 - 1 )    ! Output background fields
155             IF( ln_asmdin ) THEN                        ! Direct initialization
156                IF( ln_trainc ) CALL tra_asm_inc( nit000 - 1 )    ! Tracers
157                IF( ln_dyninc ) CALL dyn_asm_inc( nit000 - 1 )    ! Dynamics
158                IF( ln_sshinc ) CALL ssh_asm_inc( nit000 - 1 )    ! SSH
159             ENDIF
160          ENDIF
161
162         DO WHILE ( istp <= nitend .AND. nstop == 0 )
163#if defined key_agrif
164            CALL Agrif_Step( stp )           ! AGRIF: time stepping
165#else
166            CALL stp( istp )                 ! standard time stepping
167#endif
168            istp = istp + 1
169            IF( lk_mpp )   CALL mpp_max( nstop )
170         END DO
171#endif
172
173      IF( lk_diaobs   )   CALL dia_obs_wri
174      !
175      IF( ln_icebergs )   CALL icb_end( nitend )
176
177      !                            !------------------------!
178      !                            !==  finalize the run  ==!
179      !                            !------------------------!
180      IF(lwp) WRITE(numout,cform_aaa)   ! Flag AAAAAAA
181      !
182      IF( nstop /= 0 .AND. lwp ) THEN   ! error print
183         WRITE(numout,cform_err)
184         WRITE(numout,*) nstop, ' error have been found'
185      ENDIF
186      !
187#if defined key_agrif
188      CALL Agrif_ParentGrid_To_ChildGrid()
189      IF( lk_diaobs ) CALL dia_obs_wri
190      IF( nn_timing == 1 )   CALL timing_finalize
191      CALL Agrif_ChildGrid_To_ParentGrid()
192#endif
193      IF( nn_timing == 1 )   CALL timing_finalize
194      !
195      CALL nemo_closefile
196#if defined key_iomput
197      CALL xios_finalize                ! end mpp communications with xios
198# if defined key_oasis3 || defined key_oasis4
199      CALL cpl_prism_finalize           ! end coupling and mpp communications with OASIS
200# endif
201#else
202# if defined key_oasis3 || defined key_oasis4
203      CALL cpl_prism_finalize           ! end coupling and mpp communications with OASIS
204# else
205      IF( lk_mpp )   CALL mppstop       ! end mpp communications
206# endif
207#endif
208      !
209   END SUBROUTINE nemo_gcm
210
211
212   SUBROUTINE nemo_init
213      !!----------------------------------------------------------------------
214      !!                     ***  ROUTINE nemo_init  ***
215      !!
216      !! ** Purpose :   initialization of the NEMO GCM
217      !!----------------------------------------------------------------------
218      INTEGER ::   ji            ! dummy loop indices
219      INTEGER ::   ilocal_comm   ! local integer
220      CHARACTER(len=80), DIMENSION(16) ::   cltxt
221      !!
222      NAMELIST/namctl/ ln_ctl  , nn_print, nn_ictls, nn_ictle,   &
223         &             nn_isplt, nn_jsplt, nn_jctls, nn_jctle,   &
224         &             nn_bench, nn_timing
225      !!----------------------------------------------------------------------
226      !
227      cltxt = ''
228      !
229      !                             ! open Namelist file
230      CALL ctl_opn( numnam, 'namelist', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE. )
231      !
232      READ( numnam, namctl )        ! Namelist namctl : Control prints & Benchmark
233      !
234      !                             !--------------------------------------------!
235      !                             !  set communicator & select the local node  !
236      !                             !--------------------------------------------!
237#if defined key_iomput
238      IF( Agrif_Root() ) THEN
239# if defined key_oasis3 || defined key_oasis4
240         CALL cpl_prism_init( ilocal_comm )      ! nemo local communicator given by oasis
241         CALL xios_initialize( "oceanx",local_comm=ilocal_comm )
242# else
243         CALL  xios_initialize( "nemo",return_comm=ilocal_comm )
244# endif
245      ENDIF
246      narea = mynode( cltxt, numnam, nstop, ilocal_comm )   ! Nodes selection
247#else
248# if defined key_oasis3 || defined key_oasis4
249      IF( Agrif_Root() ) THEN
250         CALL cpl_prism_init( ilocal_comm )                 ! nemo local communicator given by oasis
251      ENDIF
252      narea = mynode( cltxt, numnam, nstop, ilocal_comm )   ! Nodes selection (control print return in cltxt)
253# else
254      ilocal_comm = 0
255      narea = mynode( cltxt, numnam, nstop )                 ! Nodes selection (control print return in cltxt)
256# endif
257#endif
258      narea = narea + 1                                     ! mynode return the rank of proc (0 --> jpnij -1 )
259
260      lwp = (narea == 1) .OR. ln_ctl                        ! control of all listing output print
261
262      ! If dimensions of processor grid weren't specified in the namelist file
263      ! then we calculate them here now that we have our communicator size
264      IF( (jpni < 1) .OR. (jpnj < 1) )THEN
265#if   defined key_mpp_mpi
266         IF( Agrif_Root() ) CALL nemo_partition(mppsize)
267#else
268         jpni  = 1
269         jpnj  = 1
270         jpnij = jpni*jpnj
271#endif
272      END IF
273
274      ! Calculate domain dimensions given calculated jpni and jpnj
275      ! This used to be done in par_oce.F90 when they were parameters rather
276      ! than variables
277      IF( Agrif_Root() ) THEN
278#if defined key_nemocice_decomp
279         jpi = ( nx_global+2-2*jpreci + (jpni-1) ) / jpni + 2*jpreci ! first  dim.
280         jpj = ( ny_global+2-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj ! second dim.
281#else
282         jpi = ( jpiglo-2*jpreci + (jpni-1) ) / jpni + 2*jpreci   ! first  dim.
283         jpj = ( jpjglo-2*jprecj + (jpnj-1) ) / jpnj + 2*jprecj   ! second dim.
284#endif
285         jpk = jpkdta                                             ! third dim
286         jpim1 = jpi-1                                            ! inner domain indices
287         jpjm1 = jpj-1                                            !   "           "
288         jpkm1 = jpk-1                                            !   "           "
289         jpij  = jpi*jpj                                          !  jpi x j
290      ENDIF
291
292      IF(lwp) THEN                            ! open listing units
293         !
294         CALL ctl_opn( numout, 'ocean.output', 'REPLACE', 'FORMATTED', 'SEQUENTIAL', -1, 6, .FALSE., narea )
295         !
296         WRITE(numout,*)
297         WRITE(numout,*) '   CNRS - NERC - Met OFFICE - MERCATOR-ocean - INGV - CMCC'
298         WRITE(numout,*) '                       NEMO team'
299         WRITE(numout,*) '            Ocean General Circulation Model'
300         WRITE(numout,*) '                  version 3.4  (2011) '
301         WRITE(numout,*)
302         WRITE(numout,*)
303         DO ji = 1, SIZE(cltxt)
304            IF( TRIM(cltxt(ji)) /= '' )   WRITE(numout,*) cltxt(ji)      ! control print of mynode
305         END DO
306         WRITE(numout,cform_aaa)                                         ! Flag AAAAAAA
307         !
308      ENDIF
309
310      ! Now we know the dimensions of the grid and numout has been set we can
311      ! allocate arrays
312      CALL nemo_alloc()
313
314      !                             !-------------------------------!
315      !                             !  NEMO general initialization  !
316      !                             !-------------------------------!
317
318      CALL nemo_ctl                          ! Control prints & Benchmark
319
320      !                                      ! Domain decomposition
321      IF( jpni*jpnj == jpnij ) THEN   ;   CALL mpp_init      ! standard cutting out
322      ELSE                            ;   CALL mpp_init2     ! eliminate land processors
323      ENDIF
324      !
325      IF( nn_timing == 1 )  CALL timing_init
326      !
327      !                                      ! General initialization
328                            CALL     phy_cst    ! Physical constants
329                            CALL     eos_init   ! Equation of state
330                            CALL     dom_cfg    ! Domain configuration
331                            CALL     dom_init   ! Domain
332
333      IF( ln_nnogather )    CALL nemo_northcomms   ! Initialise the northfold neighbour lists (must be done after the masks are defined)
334
335      IF( ln_ctl        )   CALL prt_ctl_init   ! Print control
336
337      IF( lk_obc        )   CALL     obc_init   ! Open boundaries
338
339                            CALL  istate_init   ! ocean initial state (Dynamics and tracers)
340
341      IF( lk_tide       )   CALL tide_init( nit000 )    ! Initialisation of the tidal harmonics
342
343      IF( lk_bdy        )   CALL     bdy_init       ! Open boundaries initialisation
344      IF( lk_bdy        )   CALL     bdy_dta_init   ! Open boundaries initialisation of external data arrays
345      IF( lk_bdy        )   CALL     bdytide_init   ! Open boundaries initialisation of tidal harmonic forcing
346
347                            CALL dyn_nept_init  ! simplified form of Neptune effect
348
349      !                                     ! Ocean physics
350                            CALL     sbc_init   ! Forcings : surface module
351      !                                         ! Vertical physics
352                            CALL     zdf_init      ! namelist read
353                            CALL zdf_bfr_init      ! bottom friction
354      IF( lk_zdfric     )   CALL zdf_ric_init      ! Richardson number dependent Kz
355      IF( lk_zdftke     )   CALL zdf_tke_init      ! TKE closure scheme
356      IF( lk_zdfgls     )   CALL zdf_gls_init      ! GLS closure scheme
357      IF( lk_zdfkpp     )   CALL zdf_kpp_init      ! KPP closure scheme
358      IF( lk_zdftmx     )   CALL zdf_tmx_init      ! tidal vertical mixing
359      IF( lk_zdfddm .AND. .NOT. lk_zdfkpp )   &
360         &                  CALL zdf_ddm_init      ! double diffusive mixing
361      !                                         ! Lateral physics
362                            CALL ldf_tra_init      ! Lateral ocean tracer physics
363                            CALL ldf_dyn_init      ! Lateral ocean momentum physics
364      IF( lk_ldfslp     )   CALL ldf_slp_init      ! slope of lateral mixing
365
366      !                                     ! Active tracers
367                            CALL tra_qsr_init   ! penetrative solar radiation qsr
368                            CALL tra_bbc_init   ! bottom heat flux
369      IF( lk_trabbl     )   CALL tra_bbl_init   ! advective (and/or diffusive) bottom boundary layer scheme
370      IF( ln_tradmp     )   CALL tra_dmp_init   ! internal damping trends
371                            CALL tra_adv_init   ! horizontal & vertical advection
372                            CALL tra_ldf_init   ! lateral mixing
373                            CALL tra_zdf_init   ! vertical mixing and after tracer fields
374
375      !                                     ! Dynamics
376                            CALL dyn_adv_init   ! advection (vector or flux form)
377                            CALL dyn_vor_init   ! vorticity term including Coriolis
378                            CALL dyn_ldf_init   ! lateral mixing
379                            CALL dyn_hpg_init   ! horizontal gradient of Hydrostatic pressure
380                            CALL dyn_zdf_init   ! vertical diffusion
381                            CALL dyn_spg_init   ! surface pressure gradient
382
383      !                                     ! Misc. options
384      IF( nn_cla == 1   )   CALL cla_init       ! Cross Land Advection
385                            CALL icb_init( rdt, nit000)   ! initialise icebergs instance
386     
387#if defined key_top
388      !                                     ! Passive tracers
389                            CALL     trc_init
390#endif
391      !                                     ! Diagnostics
392      IF( lk_floats     )   CALL     flo_init   ! drifting Floats
393      IF( lk_diaar5     )   CALL dia_ar5_init   ! ar5 diag
394                            CALL dia_ptr_init   ! Poleward TRansports initialization
395      IF( lk_diadct     )   CALL dia_dct_init   ! Sections tranports
396                            CALL dia_hsb_init   ! heat content, salt content and volume budgets
397                            CALL trd_mod_init   ! Mixed-layer/Vorticity/Integral constraints trends
398      IF( lk_diaobs     ) THEN                  ! Observation & model comparison
399                            CALL dia_obs_init            ! Initialize observational data
400                            CALL dia_obs( nit000 - 1 )   ! Observation operator for restart
401      ENDIF
402      !                                     ! Assimilation increments
403      IF( lk_asminc     )   CALL asm_inc_init   ! Initialize assimilation increments
404      IF(lwp) WRITE(numout,*) 'Euler time step switch is ', neuler
405      !
406   END SUBROUTINE nemo_init
407
408
409   SUBROUTINE nemo_ctl
410      !!----------------------------------------------------------------------
411      !!                     ***  ROUTINE nemo_ctl  ***
412      !!
413      !! ** Purpose :   control print setting
414      !!
415      !! ** Method  : - print namctl information and check some consistencies
416      !!----------------------------------------------------------------------
417      !
418      IF(lwp) THEN                  ! control print
419         WRITE(numout,*)
420         WRITE(numout,*) 'nemo_ctl: Control prints & Benchmark'
421         WRITE(numout,*) '~~~~~~~ '
422         WRITE(numout,*) '   Namelist namctl'
423         WRITE(numout,*) '      run control (for debugging)     ln_ctl     = ', ln_ctl
424         WRITE(numout,*) '      level of print                  nn_print   = ', nn_print
425         WRITE(numout,*) '      Start i indice for SUM control  nn_ictls   = ', nn_ictls
426         WRITE(numout,*) '      End i indice for SUM control    nn_ictle   = ', nn_ictle
427         WRITE(numout,*) '      Start j indice for SUM control  nn_jctls   = ', nn_jctls
428         WRITE(numout,*) '      End j indice for SUM control    nn_jctle   = ', nn_jctle
429         WRITE(numout,*) '      number of proc. following i     nn_isplt   = ', nn_isplt
430         WRITE(numout,*) '      number of proc. following j     nn_jsplt   = ', nn_jsplt
431         WRITE(numout,*) '      benchmark parameter (0/1)       nn_bench   = ', nn_bench
432         WRITE(numout,*) '      timing activated    (0/1)       nn_timing  = ', nn_timing
433      ENDIF
434      !
435      nprint    = nn_print          ! convert DOCTOR namelist names into OLD names
436      nictls    = nn_ictls
437      nictle    = nn_ictle
438      njctls    = nn_jctls
439      njctle    = nn_jctle
440      isplt     = nn_isplt
441      jsplt     = nn_jsplt
442      nbench    = nn_bench
443      !                             ! Parameter control
444      !
445      IF( ln_ctl ) THEN                 ! sub-domain area indices for the control prints
446         IF( lk_mpp .AND. jpnij > 1 ) THEN
447            isplt = jpni   ;   jsplt = jpnj   ;   ijsplt = jpni*jpnj   ! the domain is forced to the real split domain
448         ELSE
449            IF( isplt == 1 .AND. jsplt == 1  ) THEN
450               CALL ctl_warn( ' - isplt & jsplt are equal to 1',   &
451                  &           ' - the print control will be done over the whole domain' )
452            ENDIF
453            ijsplt = isplt * jsplt            ! total number of processors ijsplt
454         ENDIF
455         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
456         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
457         !
458         !                              ! indices used for the SUM control
459         IF( nictls+nictle+njctls+njctle == 0 )   THEN    ! print control done over the default area
460            lsp_area = .FALSE.
461         ELSE                                             ! print control done over a specific  area
462            lsp_area = .TRUE.
463            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
464               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
465               nictls = 1
466            ENDIF
467            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
468               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
469               nictle = jpiglo
470            ENDIF
471            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
472               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
473               njctls = 1
474            ENDIF
475            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
476               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
477               njctle = jpjglo
478            ENDIF
479         ENDIF
480      ENDIF
481      !
482      IF( nbench == 1 ) THEN              ! Benchmark
483         SELECT CASE ( cp_cfg )
484         CASE ( 'gyre' )   ;   CALL ctl_warn( ' The Benchmark is activated ' )
485         CASE DEFAULT      ;   CALL ctl_stop( ' The Benchmark is based on the GYRE configuration:',   &
486            &                                 ' key_gyre must be used or set nbench = 0' )
487         END SELECT
488      ENDIF
489      !
490      IF( lk_c1d .AND. .NOT.lk_iomput )   CALL ctl_stop( 'nemo_ctl: The 1D configuration must be used ',   &
491         &                                               'with the IOM Input/Output manager. '         ,   &
492         &                                               'Compile with key_iomput enabled' )
493      !
494      IF( 1_wp /= SIGN(1._wp,-0._wp)  )   CALL ctl_stop( 'nemo_ctl: The intrinsec SIGN function follows ',  &
495         &                                               'f2003 standard. '                              ,  &
496         &                                               'Compile with key_nosignedzero enabled' )
497      !
498   END SUBROUTINE nemo_ctl
499
500
501   SUBROUTINE nemo_closefile
502      !!----------------------------------------------------------------------
503      !!                     ***  ROUTINE nemo_closefile  ***
504      !!
505      !! ** Purpose :   Close the files
506      !!----------------------------------------------------------------------
507      !
508      IF( lk_mpp )   CALL mppsync
509      !
510      CALL iom_close                                 ! close all input/output files managed by iom_*
511      !
512      IF( numstp      /= -1 )   CLOSE( numstp      )   ! time-step file
513      IF( numsol      /= -1 )   CLOSE( numsol      )   ! solver file
514      IF( numnam      /= -1 )   CLOSE( numnam      )   ! oce namelist
515      IF( numnam_ice  /= -1 )   CLOSE( numnam_ice  )   ! ice namelist
516      IF( numevo_ice  /= -1 )   CLOSE( numevo_ice  )   ! ice variables (temp. evolution)
517      IF( numout      /=  6 )   CLOSE( numout      )   ! standard model output file
518      IF( numdct_vol  /= -1 )   CLOSE( numdct_vol  )   ! volume transports
519      IF( numdct_heat /= -1 )   CLOSE( numdct_heat )   ! heat transports
520      IF( numdct_salt /= -1 )   CLOSE( numdct_salt )   ! salt transports
521
522      !
523      numout = 6                                     ! redefine numout in case it is used after this point...
524      !
525   END SUBROUTINE nemo_closefile
526
527
528   SUBROUTINE nemo_alloc
529      !!----------------------------------------------------------------------
530      !!                     ***  ROUTINE nemo_alloc  ***
531      !!
532      !! ** Purpose :   Allocate all the dynamic arrays of the OPA modules
533      !!
534      !! ** Method  :
535      !!----------------------------------------------------------------------
536      USE diawri    , ONLY: dia_wri_alloc
537      USE dom_oce   , ONLY: dom_oce_alloc
538      USE ldfdyn_oce, ONLY: ldfdyn_oce_alloc
539      USE ldftra_oce, ONLY: ldftra_oce_alloc
540      USE trc_oce   , ONLY: trc_oce_alloc
541#if defined key_diadct 
542      USE diadct    , ONLY: diadct_alloc 
543#endif 
544      !
545      INTEGER :: ierr
546      !!----------------------------------------------------------------------
547      !
548      ierr =        oce_alloc       ()          ! ocean
549      ierr = ierr + dia_wri_alloc   ()
550      ierr = ierr + dom_oce_alloc   ()          ! ocean domain
551      ierr = ierr + ldfdyn_oce_alloc()          ! ocean lateral  physics : dynamics
552      ierr = ierr + ldftra_oce_alloc()          ! ocean lateral  physics : tracers
553      ierr = ierr + zdf_oce_alloc   ()          ! ocean vertical physics
554      !
555      ierr = ierr + lib_mpp_alloc   (numout)    ! mpp exchanges
556      ierr = ierr + trc_oce_alloc   ()          ! shared TRC / TRA arrays
557      !
558#if defined key_diadct 
559      ierr = ierr + diadct_alloc    ()          !
560#endif 
561      !
562      IF( lk_mpp    )   CALL mpp_sum( ierr )
563      IF( ierr /= 0 )   CALL ctl_stop( 'STOP', 'nemo_alloc : unable to allocate standard ocean arrays' )
564      !
565   END SUBROUTINE nemo_alloc
566
567
568   SUBROUTINE nemo_partition( num_pes )
569      !!----------------------------------------------------------------------
570      !!                 ***  ROUTINE nemo_partition  ***
571      !!
572      !! ** Purpose :
573      !!
574      !! ** Method  :
575      !!----------------------------------------------------------------------
576      INTEGER, INTENT(in) :: num_pes ! The number of MPI processes we have
577      !
578      INTEGER, PARAMETER :: nfactmax = 20
579      INTEGER :: nfact ! The no. of factors returned
580      INTEGER :: ierr  ! Error flag
581      INTEGER :: ji
582      INTEGER :: idiff, mindiff, imin ! For choosing pair of factors that are closest in value
583      INTEGER, DIMENSION(nfactmax) :: ifact ! Array of factors
584      !!----------------------------------------------------------------------
585
586      ierr = 0
587
588      CALL factorise( ifact, nfactmax, nfact, num_pes, ierr )
589
590      IF( nfact <= 1 ) THEN
591         WRITE (numout, *) 'WARNING: factorisation of number of PEs failed'
592         WRITE (numout, *) '       : using grid of ',num_pes,' x 1'
593         jpnj = 1
594         jpni = num_pes
595      ELSE
596         ! Search through factors for the pair that are closest in value
597         mindiff = 1000000
598         imin    = 1
599         DO ji = 1, nfact-1, 2
600            idiff = ABS( ifact(ji) - ifact(ji+1) )
601            IF( idiff < mindiff ) THEN
602               mindiff = idiff
603               imin = ji
604            ENDIF
605         END DO
606         jpnj = ifact(imin)
607         jpni = ifact(imin + 1)
608      ENDIF
609      !
610      jpnij = jpni*jpnj
611      !
612   END SUBROUTINE nemo_partition
613
614
615   SUBROUTINE factorise( kfax, kmaxfax, knfax, kn, kerr )
616      !!----------------------------------------------------------------------
617      !!                     ***  ROUTINE factorise  ***
618      !!
619      !! ** Purpose :   return the prime factors of n.
620      !!                knfax factors are returned in array kfax which is of
621      !!                maximum dimension kmaxfax.
622      !! ** Method  :
623      !!----------------------------------------------------------------------
624      INTEGER                    , INTENT(in   ) ::   kn, kmaxfax
625      INTEGER                    , INTENT(  out) ::   kerr, knfax
626      INTEGER, DIMENSION(kmaxfax), INTENT(  out) ::   kfax
627      !
628      INTEGER :: ifac, jl, inu
629      INTEGER, PARAMETER :: ntest = 14
630      INTEGER :: ilfax(ntest)
631
632      ! lfax contains the set of allowed factors.
633      data (ilfax(jl),jl=1,ntest) / 16384, 8192, 4096, 2048, 1024, 512, 256,  &
634         &                            128,   64,   32,   16,    8,   4,   2  /
635      !!----------------------------------------------------------------------
636
637      ! Clear the error flag and initialise output vars
638      kerr = 0
639      kfax = 1
640      knfax = 0
641
642      ! Find the factors of n.
643      IF( kn == 1 )   GOTO 20
644
645      ! nu holds the unfactorised part of the number.
646      ! knfax holds the number of factors found.
647      ! l points to the allowed factor list.
648      ! ifac holds the current factor.
649
650      inu   = kn
651      knfax = 0
652
653      DO jl = ntest, 1, -1
654         !
655         ifac = ilfax(jl)
656         IF( ifac > inu )   CYCLE
657
658         ! Test whether the factor will divide.
659
660         IF( MOD(inu,ifac) == 0 ) THEN
661            !
662            knfax = knfax + 1            ! Add the factor to the list
663            IF( knfax > kmaxfax ) THEN
664               kerr = 6
665               write (*,*) 'FACTOR: insufficient space in factor array ', knfax
666               return
667            ENDIF
668            kfax(knfax) = ifac
669            ! Store the other factor that goes with this one
670            knfax = knfax + 1
671            kfax(knfax) = inu / ifac
672            !WRITE (*,*) 'ARPDBG, factors ',knfax-1,' & ',knfax,' are ', kfax(knfax-1),' and ',kfax(knfax)
673         ENDIF
674         !
675      END DO
676
677   20 CONTINUE      ! Label 20 is the exit point from the factor search loop.
678      !
679   END SUBROUTINE factorise
680
681#if defined key_mpp_mpi
682   SUBROUTINE nemo_northcomms
683      !!======================================================================
684      !!                     ***  ROUTINE  nemo_northcomms  ***
685      !! nemo_northcomms    :  Setup for north fold exchanges with explicit peer to peer messaging
686      !!=====================================================================
687      !!----------------------------------------------------------------------
688      !!
689      !! ** Purpose :   Initialization of the northern neighbours lists.
690      !!----------------------------------------------------------------------
691      !!    1.0  ! 2011-10  (A. C. Coward, NOCS & J. Donners, PRACE)
692      !!----------------------------------------------------------------------
693
694      INTEGER ::   ji, jj, jk, ij, jtyp    ! dummy loop indices
695      INTEGER ::   ijpj                    ! number of rows involved in north-fold exchange
696      INTEGER ::   northcomms_alloc        ! allocate return status
697      REAL(wp), ALLOCATABLE, DIMENSION ( :,: ) ::   znnbrs     ! workspace
698      LOGICAL,  ALLOCATABLE, DIMENSION ( : )   ::   lrankset   ! workspace
699
700      IF(lwp) WRITE(numout,*)
701      IF(lwp) WRITE(numout,*) 'nemo_northcomms : Initialization of the northern neighbours lists'
702      IF(lwp) WRITE(numout,*) '~~~~~~~~~~'
703
704      !!----------------------------------------------------------------------
705      ALLOCATE( znnbrs(jpi,jpj), stat = northcomms_alloc )
706      ALLOCATE( lrankset(jpnij), stat = northcomms_alloc )
707      IF( northcomms_alloc /= 0 ) THEN
708         WRITE(numout,cform_war)
709         WRITE(numout,*) 'northcomms_alloc : failed to allocate arrays'
710         CALL ctl_stop( 'STOP', 'nemo_northcomms : unable to allocate temporary arrays' )
711      ENDIF
712      nsndto = 0
713      isendto = -1
714      ijpj   = 4
715      !
716      ! This routine has been called because ln_nnogather has been set true ( nammpp )
717      ! However, these first few exchanges have to use the mpi_allgather method to
718      ! establish the neighbour lists to use in subsequent peer to peer exchanges.
719      ! Consequently, set l_north_nogather to be false here and set it true only after
720      ! the lists have been established.
721      !
722      l_north_nogather = .FALSE.
723      !
724      ! Exchange and store ranks on northern rows
725
726      DO jtyp = 1,4
727
728         lrankset = .FALSE.
729         znnbrs = narea
730         SELECT CASE (jtyp)
731            CASE(1)
732               CALL lbc_lnk( znnbrs, 'T', 1. )      ! Type 1: T,W-points
733            CASE(2)
734               CALL lbc_lnk( znnbrs, 'U', 1. )      ! Type 2: U-point
735            CASE(3)
736               CALL lbc_lnk( znnbrs, 'V', 1. )      ! Type 3: V-point
737            CASE(4)
738               CALL lbc_lnk( znnbrs, 'F', 1. )      ! Type 4: F-point
739         END SELECT
740
741         IF ( njmppt(narea) .EQ. MAXVAL( njmppt ) ) THEN
742            DO jj = nlcj-ijpj+1, nlcj
743               ij = jj - nlcj + ijpj
744               DO ji = 1,jpi
745                  IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND. INT(znnbrs(ji,jj)) .NE. narea ) &
746               &     lrankset(INT(znnbrs(ji,jj))) = .true.
747               END DO
748            END DO
749
750            DO jj = 1,jpnij
751               IF ( lrankset(jj) ) THEN
752                  nsndto(jtyp) = nsndto(jtyp) + 1
753                  IF ( nsndto(jtyp) .GT. jpmaxngh ) THEN
754                     CALL ctl_stop( ' Too many neighbours in nemo_northcomms ', &
755                  &                 ' jpmaxngh will need to be increased ')
756                  ENDIF
757                  isendto(nsndto(jtyp),jtyp) = jj-1   ! narea converted to MPI rank
758               ENDIF
759            END DO
760         ENDIF
761
762      END DO
763
764      !
765      ! Type 5: I-point
766      !
767      ! ICE point exchanges may involve some averaging. The neighbours list is
768      ! built up using two exchanges to ensure that the whole stencil is covered.
769      ! lrankset should not be reset between these 'J' and 'K' point exchanges
770
771      jtyp = 5
772      lrankset = .FALSE.
773      znnbrs = narea
774      CALL lbc_lnk( znnbrs, 'J', 1. ) ! first ice U-V point
775
776      IF ( njmppt(narea) .EQ. MAXVAL( njmppt ) ) THEN
777         DO jj = nlcj-ijpj+1, nlcj
778            ij = jj - nlcj + ijpj
779            DO ji = 1,jpi
780               IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND. INT(znnbrs(ji,jj)) .NE. narea ) &
781            &     lrankset(INT(znnbrs(ji,jj))) = .true.
782         END DO
783        END DO
784      ENDIF
785
786      znnbrs = narea
787      CALL lbc_lnk( znnbrs, 'K', 1. ) ! second ice U-V point
788
789      IF ( njmppt(narea) .EQ. MAXVAL( njmppt )) THEN
790         DO jj = nlcj-ijpj+1, nlcj
791            ij = jj - nlcj + ijpj
792            DO ji = 1,jpi
793               IF ( INT(znnbrs(ji,jj)) .NE. 0 .AND.  INT(znnbrs(ji,jj)) .NE. narea ) &
794            &       lrankset( INT(znnbrs(ji,jj))) = .true.
795            END DO
796         END DO
797
798         DO jj = 1,jpnij
799            IF ( lrankset(jj) ) THEN
800               nsndto(jtyp) = nsndto(jtyp) + 1
801               IF ( nsndto(jtyp) .GT. jpmaxngh ) THEN
802                  CALL ctl_stop( ' Too many neighbours in nemo_northcomms ', &
803               &                 ' jpmaxngh will need to be increased ')
804               ENDIF
805               isendto(nsndto(jtyp),jtyp) = jj-1   ! narea converted to MPI rank
806            ENDIF
807         END DO
808         !
809         ! For northern row areas, set l_north_nogather so that all subsequent exchanges
810         ! can use peer to peer communications at the north fold
811         !
812         l_north_nogather = .TRUE.
813         !
814      ENDIF
815      DEALLOCATE( znnbrs )
816      DEALLOCATE( lrankset )
817
818   END SUBROUTINE nemo_northcomms
819#else
820   SUBROUTINE nemo_northcomms      ! Dummy routine
821      WRITE(*,*) 'nemo_northcomms: You should not have seen this print! error?'
822   END SUBROUTINE nemo_northcomms
823#endif
824   !!======================================================================
825END MODULE nemogcm
Note: See TracBrowser for help on using the repository browser.