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/2015/dev_r5218_CNRS17_coupling/NEMOGCM/NEMO/OPA_SRC – NEMO

source: branches/2015/dev_r5218_CNRS17_coupling/NEMOGCM/NEMO/OPA_SRC/nemogcm.F90 @ 5376

Last change on this file since 5376 was 5376, checked in by smasson, 9 years ago

dev_r5218_CNRS17_coupling: bugfix for SAS-OPA coupling

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