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_tam.F90 in branches/2012/dev_r3604_LEGI8_TAM/NEMOGCM/NEMO/OPATAM_SRC – NEMO

source: branches/2012/dev_r3604_LEGI8_TAM/NEMOGCM/NEMO/OPATAM_SRC/nemogcm_tam.F90 @ 3641

Last change on this file since 3641 was 3641, checked in by pabouttier, 10 years ago

Add possibility to run in stand-alone Tangent Linear Model - See ticket 1014

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