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.
opa.F90 in trunk/NEMO/OPA_SRC – NEMO

source: trunk/NEMO/OPA_SRC/opa.F90 @ 633

Last change on this file since 633 was 627, checked in by opalod, 17 years ago

nemo_v2_bugfix_025:RB: suppress hard-coded logical units except for dimg and coupled

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 18.8 KB
Line 
1MODULE opa
2   !!==============================================================================
3   !!                       ***  MODULE opa   ***
4   !! Ocean system   : OPA ocean dynamics (including on-line tracers and sea-ice)
5   !!==============================================================================
6
7   !!----------------------------------------------------------------------
8   !!   opa_model      : solve ocean dynamics, tracer and/or sea-ice
9   !!   opa_init       : initialization of the opa model
10   !!   opa_flg        : initialisation of algorithm flag
11   !!   opa_closefile  : close remaining files
12   !!----------------------------------------------------------------------
13   !! History :
14   !!   4.0  !  90-10  (C. Levy, G. Madec)  Original code
15   !!   7.0  !  91-11  (M. Imbard, C. Levy, G. Madec)
16   !!   7.1  !  93-03  (M. Imbard, C. Levy, G. Madec, O. Marti,
17   !!                   M. Guyon, A. Lazar, P. Delecluse, C. Perigaud,
18   !!                   G. Caniaux, B. Colot, C. Maes ) release 7.1
19   !!        !  92-06  (L.Terray) coupling implementation
20   !!        !  93-11  (M.A. Filiberti) IGLOO sea-ice
21   !!   8.0  !  96-03  (M. Imbard, C. Levy, G. Madec, O. Marti,
22   !!                   M. Guyon, A. Lazar, P. Delecluse, L.Terray,
23   !!                   M.A. Filiberti, J. Vialar, A.M. Treguier,
24   !!                   M. Levy)  release 8.0
25   !!   8.1  !  97-06  (M. Imbard, G. Madec)
26   !!   8.2  !  99-11  (M. Imbard, H. Goosse)  LIM sea-ice model
27   !!        !  99-12  (V. Thierry, A-M. Treguier, M. Imbard, M-A. Foujols)  OPEN-MP
28   !!        !  00-07  (J-M Molines, M. Imbard)  Open Boundary Conditions  (CLIPPER)
29   !!   9.0  !  02-08  (G. Madec)  F90: Free form and modules
30   !!    "   !  04-06  (R. Redler, NEC CCRLE, Germany) add OASIS[3/4] coupled interfaces
31   !!    "   !  04-08  (C. Talandier) New trends organization
32   !!    "   !  05-06  (C. Ethe) Add the 1D configuration possibility
33   !!    "   !  05-11  (V. Garnier) Surface pressure gradient organization
34   !!    "   !  06-03  (L. Debreu, C. Mazauric)  Agrif implementation
35   !!    "   !  06-04  (G. Madec, R. Benshila)  Step reorganization
36   !!----------------------------------------------------------------------
37   !! * Modules used
38   USE cpl_oce         ! ocean-atmosphere-sea ice coupled exchanges
39   USE dom_oce         ! ocean space domain variables
40   USE oce             ! dynamics and tracers variables
41   USE trdmod_oce      ! ocean variables trends
42   USE daymod          ! calendar
43   USE in_out_manager  ! I/O manager
44   USE lib_mpp         ! distributed memory computing
45
46   USE domcfg          ! domain configuration               (dom_cfg routine)
47   USE mppini          ! shared/distributed memory setting (mpp_init routine)
48   USE domain          ! domain initialization             (dom_init routine)
49   USE obc_par         ! open boundary cond. parameters
50   USE obcini          ! open boundary cond. initialization (obc_ini routine)
51   USE istate          ! initial state setting          (istate_init routine)
52   USE eosbn2          ! equation of state            (eos bn2 routine)
53   USE zpshde          ! partial step: hor. derivative (zps_hde routine)
54
55   ! ocean physics
56   USE ldfdyn          ! lateral viscosity setting      (ldfdyn_init routine)
57   USE ldftra          ! lateral diffusivity setting    (ldftra_init routine)
58   USE zdfini
59
60   USE phycst          ! physical constant                  (par_cst routine)
61   USE iceini          ! initialization of sea-ice         (ice_init routine)
62   USE cpl             ! coupled ocean/atmos.              (cpl_init routine)
63   USE ocfzpt          ! ocean freezing point              (oc_fz_pt routine)
64   USE trdmod          ! momentum/tracers trends       (trd_mod_init routine)
65   USE flxfwb          ! freshwater budget correction  (flx_fwb_init routine)
66   USE flxmod          ! thermohaline forcing of the ocean (flx_init routine)
67
68   USE diaptr          ! poleward transports           (dia_ptr_init routine)
69
70   USE step            ! OPA time-stepping                  (stp     routine)
71#if defined key_oasis3
72   USE cpl_oasis3      ! OASIS3 coupling (to ECHAM5)
73#elif defined key_oasis4
74   USE cpl_oasis4      ! OASIS4 coupling (to ECHAM5)
75#endif
76   USE dynspg_oce      ! Control choice of surface pressure gradient schemes
77   USE prtctl          ! Print control                 (prt_ctl_init routine)
78   USE ini1d           ! re-initialization of u-v mask for the 1D configuration
79   USE dyncor1d        ! Coriolis factor at T-point
80   USE step1d          ! Time stepping loop for the 1D configuration
81
82   USE initrc          ! Initialization of the passive tracers
83
84   IMPLICIT NONE
85   PRIVATE
86
87   !! * Module variables
88   CHARACTER (len=64) ::        &
89      cform_aaa="( /, 'AAAAAAAA', / ) "     ! flag for output listing
90
91   !! * Routine accessibility
92   PUBLIC opa_model      ! called by model.F90
93   PUBLIC opa_init
94   !!----------------------------------------------------------------------
95   !!  OPA 9.0 , LOCEAN-IPSL (2005)
96   !! $Header$
97   !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt)
98   !!----------------------------------------------------------------------
99
100CONTAINS
101
102   SUBROUTINE opa_model
103      !!----------------------------------------------------------------------
104      !!                     ***  ROUTINE opa  ***
105      !!
106      !! ** Purpose :   opa 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      !!
112      !! References :
113      !!      Madec, Delecluse,Imbard, and Levy, 1997: reference manual.
114      !!              internal report, IPSL.
115      !!----------------------------------------------------------------------
116      INTEGER ::   istp       ! time step index
117      !!----------------------------------------------------------------------
118
119#if defined key_agrif
120      CALL Agrif_Init_Grids()
121#endif
122     
123      CALL opa_init  ! Initializations
124
125      IF( lk_cfg_1d ) THEN
126         istp = nit000
127         DO WHILE ( istp <= nitend .AND. nstop == 0 )
128#if defined key_agrif
129            CALL Agrif_Step(stp_1d)
130#else
131            CALL stp_1d( istp )
132#endif
133            istp = istp + 1
134         END DO
135      ELSE
136         istp = nit000
137         DO WHILE ( istp <= nitend .AND. nstop == 0 )
138#if defined key_agrif
139            CALL Agrif_Step(stp)
140#else
141            CALL stp( istp )
142#endif
143            istp = istp + 1
144         END DO
145      ENDIF
146      !                                     ! ========= !
147      !                                     !  Job end  !
148      !                                     ! ========= !
149
150      IF(lwp) WRITE(numout,cform_aaa)       ! Flag AAAAAAA
151
152      IF( nstop /= 0 ) THEN                 ! error print
153      IF(lwp) WRITE(numout,cform_err)
154      IF(lwp) WRITE(numout,*) nstop, ' error have been found' 
155      ENDIF
156
157      CALL opa_closefile
158#if defined key_oasis3 || defined key_oasis4
159      call cpl_prism_finalize
160#else
161      IF( lk_mpp )   CALL mppstop                          ! Close all files (mpp)
162#endif
163
164   END SUBROUTINE opa_model
165
166
167   SUBROUTINE opa_init
168      !!----------------------------------------------------------------------
169      !!                     ***  ROUTINE opa_init  ***
170      !!
171      !! ** Purpose :   initialization of the opa model
172      !!
173      !!----------------------------------------------------------------------
174#if defined key_coupled
175      INTEGER ::   itro, istp0        ! ???
176#endif
177#if defined key_oasis3 || defined key_oasis4
178      INTEGER :: localComm
179#endif
180      CHARACTER (len=20) ::   namelistname
181      CHARACTER (len=28) ::   file_out
182      NAMELIST/namctl/ ln_ctl, nprint, nictls, nictle,   &
183         &             isplt , jsplt , njctls, njctle, nbench, nbit_cmp
184      !!----------------------------------------------------------------------
185
186      ! Initializations
187      ! ===============
188
189      file_out = 'ocean.output'
190     
191      ! open listing and namelist units
192      CALL ctlopn( numout, file_out, 'UNKNOWN', 'FORMATTED',   &
193         &         'SEQUENTIAL', 1, numout, .FALSE., 1 )
194
195      WRITE(numout,*)
196      WRITE(numout,*) '                 L O D Y C - I P S L'
197      WRITE(numout,*) '                     O P A model'
198      WRITE(numout,*) '            Ocean General Circulation Model'
199      WRITE(numout,*) '               version OPA 9.0  (2005) '
200      WRITE(numout,*)
201      WRITE(numout,*)
202
203      namelistname = 'namelist'
204      CALL ctlopn( numnam, namelistname, 'OLD', 'FORMATTED', 'SEQUENTIAL',   &
205         &         1, numout, .FALSE., 1 )
206
207      ! Namelist namctl : Control prints & Benchmark
208      REWIND( numnam )
209      READ  ( numnam, namctl )
210
211#if defined key_oasis3 || defined key_oasis4
212      call cpl_prism_init(localComm)
213      ! Nodes selection
214      narea = mynode(localComm)
215#else
216      ! Nodes selection
217      narea = mynode()
218#endif
219      narea = narea + 1    ! mynode return the rank of proc (0 --> jpnij -1 )
220      lwp   = narea == 1
221
222      ! open additionnal listing
223      IF( ln_ctl )   THEN
224         IF( narea-1 > 0 )   THEN
225            WRITE(file_out,FMT="('ocean.output_',I4.4)") narea-1
226            CALL ctlopn( numout, file_out, 'UNKNOWN', 'FORMATTED',   &
227               &         'SEQUENTIAL', 1, numout, .FALSE., 1 )
228            lwp = .TRUE.
229            !
230            WRITE(numout,*)
231            WRITE(numout,*) '                 L O D Y C - I P S L'
232            WRITE(numout,*) '                     O P A model'
233            WRITE(numout,*) '            Ocean General Circulation Model'
234            WRITE(numout,*) '               version OPA 9.0  (2005) '
235            WRITE(numout,*) '                   MPI Ocean output '
236            WRITE(numout,*)
237            WRITE(numout,*)
238         ENDIF
239      ENDIF
240
241      !                                     ! ============================== !
242      !                                     !  Model general initialization  !
243      !                                     ! ============================== !
244
245      IF(lwp) WRITE(numout,cform_aaa)       ! Flag AAAAAAA
246
247      CALL opa_flg                          ! Control prints & Benchmark
248
249                                            ! Domain decomposition
250      IF( jpni*jpnj == jpnij ) THEN
251         CALL mpp_init                          ! standard cutting out
252      ELSE
253         CALL mpp_init2                         ! eliminate land processors
254      ENDIF
255     
256      CALL phy_cst                          ! Physical constants
257
258      CALL dom_cfg                          ! Domain configuration
259     
260      CALL dom_init                         ! Domain
261
262      IF( ln_ctl )      CALL prt_ctl_init   ! Print control
263
264      IF( lk_cfg_1d )   CALL fcorio_1d      ! redefine Coriolis at T-point
265
266      IF( lk_obc    )   CALL obc_init       ! Open boundaries
267
268      CALL day( nit000 )                    ! Calendar
269
270      CALL istate_init                      ! ocean initial state (Dynamics and tracers)
271
272      CALL oc_fz_pt                         ! Surface freezing point
273
274#if defined key_ice_lim
275      CALL ice_init                         ! Sea ice model
276#endif
277
278      !                                     ! Ocean physics
279
280      CALL ldf_dyn_init                         ! Lateral ocean momentum physics
281
282      CALL ldf_tra_init                         ! Lateral ocean tracer physics
283
284      CALL zdf_init                             ! Vertical ocean physics
285
286      CALL trd_mod_init                         ! Mixed-layer/Vorticity/Integral constraints trends
287
288
289#if defined key_passivetrc
290      CALL ini_trc                           ! Passive tracers
291#endif
292
293#if defined key_coupled && ! defined key_oasis3 && ! defined key_oasis4
294      itro  = nitend - nit000 + 1           ! Coupled
295      istp0 = NINT( rdt )
296      CALL cpl_init( itro, nexco, istp0 )   ! Signal processing and process id exchange
297#endif
298
299#if defined key_oasis3 || defined key_oasis4
300      CALL cpl_prism_define
301#endif
302
303      CALL flx_init                         ! Thermohaline forcing initialization
304
305      CALL flx_fwb_init                     ! FreshWater Budget correction
306
307      CALL dia_ptr_init                     ! Poleward TRansports initialization
308
309      !                                     ! =============== !
310      !                                     !  time stepping  !
311      !                                     ! =============== !
312
313      IF(lwp) WRITE(numout,cform_aaa)       ! Flag AAAAAAA
314
315      IF( lk_cfg_1d  )  THEN
316         CALL init_1d
317      ENDIF
318
319   END SUBROUTINE opa_init
320
321
322   SUBROUTINE opa_flg
323      !!----------------------------------------------------------------------
324      !!                     ***  ROUTINE opa  ***
325      !!
326      !! ** Purpose :   Initialize logical flags that control the choice of
327      !!      some algorithm or control print
328      !!
329      !! ** Method  :    Read in namilist namflg logical flags
330      !!
331      !! History :
332      !!   9.0  !  03-11  (G. Madec)  Original code
333      !!----------------------------------------------------------------------
334      !! * Local declarations
335
336      NAMELIST/namflg/ ln_dynhpg_imp, nn_dynhpg_rst
337      !!----------------------------------------------------------------------
338
339      ! Parameter control and print
340      ! ---------------------------
341      IF(lwp) THEN
342         WRITE(numout,*)
343         WRITE(numout,*) 'opa_flg: Control prints & Benchmark'
344         WRITE(numout,*) '~~~~~~~ '
345         WRITE(numout,*) '          Namelist namctl'
346         WRITE(numout,*) '             run control (for debugging)     ln_ctl    = ', ln_ctl
347         WRITE(numout,*) '             level of print                  nprint    = ', nprint
348         WRITE(numout,*) '             Start i indice for SUM control  nictls    = ', nictls
349         WRITE(numout,*) '             End i indice for SUM control    nictle    = ', nictle
350         WRITE(numout,*) '             Start j indice for SUM control  njctls    = ', njctls
351         WRITE(numout,*) '             End j indice for SUM control    njctle    = ', njctle
352         WRITE(numout,*) '             number of proc. following i     isplt     = ', isplt
353         WRITE(numout,*) '             number of proc. following j     jsplt     = ', jsplt
354         WRITE(numout,*) '             benchmark parameter (0/1)       nbench    = ', nbench
355         WRITE(numout,*) '             bit comparison mode (0/1)       nbit_cmp  = ', nbit_cmp
356      ENDIF
357
358      ! ... Control the sub-domain area indices for the control prints
359      IF( ln_ctl )   THEN
360         IF( lk_mpp )   THEN
361            ! the domain is forced to the real splitted domain in MPI
362            isplt = jpni ; jsplt = jpnj ; ijsplt = jpni*jpnj
363         ELSE
364            IF( isplt == 1 .AND. jsplt == 1  ) THEN
365               CALL ctl_warn( '          - isplt & jsplt are equal to 1',   &
366                    &         '          - the print control will be done over the whole domain' )
367            ENDIF
368
369            ! compute the total number of processors ijsplt
370            ijsplt = isplt*jsplt
371         ENDIF
372
373         IF(lwp) WRITE(numout,*)'          - The total number of processors over which the'
374         IF(lwp) WRITE(numout,*)'            print control will be done is ijsplt : ', ijsplt
375
376         ! Control the indices used for the SUM control
377         IF( nictls+nictle+njctls+njctle == 0 )   THEN
378            ! the print control is done over the default area
379            lsp_area = .FALSE.
380         ELSE
381            ! the print control is done over a specific  area
382            lsp_area = .TRUE.
383            IF( nictls < 1 .OR. nictls > jpiglo )   THEN
384               CALL ctl_warn( '          - nictls must be 1<=nictls>=jpiglo, it is forced to 1' )
385               nictls = 1
386            ENDIF
387
388            IF( nictle < 1 .OR. nictle > jpiglo )   THEN
389               CALL ctl_warn( '          - nictle must be 1<=nictle>=jpiglo, it is forced to jpiglo' )
390               nictle = jpiglo
391            ENDIF
392
393            IF( njctls < 1 .OR. njctls > jpjglo )   THEN
394               CALL ctl_warn( '          - njctls must be 1<=njctls>=jpjglo, it is forced to 1' )
395               njctls = 1
396            ENDIF
397
398            IF( njctle < 1 .OR. njctle > jpjglo )   THEN
399               CALL ctl_warn( '          - njctle must be 1<=njctle>=jpjglo, it is forced to jpjglo' )
400               njctle = jpjglo
401            ENDIF
402
403         ENDIF          ! IF( nictls+nictle+njctls+njctle == 0 )
404       ENDIF            ! IF(ln_ctl)
405
406      IF( nbench == 1 )   THEN
407         SELECT CASE ( cp_cfg )
408         CASE ( 'gyre' )
409            CALL ctl_warn( '          The Benchmark is activated ' )
410         CASE DEFAULT
411            CALL ctl_stop( '          The Benchmark is based on the GYRE configuration: key_gyre must &
412               &                      be used or set nbench = 0' )
413         END SELECT
414      ENDIF
415
416      IF( nbit_cmp == 1 )   THEN
417         CALL ctl_warn( '          Bit comparison enabled. Single and multiple processor results must bit compare', &
418              &         '          WARNING: RESULTS ARE NOT PHYSICAL.' )
419      ENDIF
420
421
422      ! Read Namelist namflg : algorithm FLaG
423      ! --------------------
424      REWIND ( numnam )
425      READ   ( numnam, namflg )
426
427      ! Parameter control and print
428      ! ---------------------------
429      IF(lwp) THEN
430         WRITE(numout,*)
431         WRITE(numout,*) 'opa_flg : Hydrostatic pressure gradient algorithm'
432         WRITE(numout,*) '~~~~~~~'
433         WRITE(numout,*) '          Namelist namflg : set algorithm flags'
434         WRITE(numout,*) '             centered (F) or semi-implicit (T)   ln_dynhpg_imp = ', ln_dynhpg_imp
435         WRITE(numout,*) '             hydrostatic pressure gradient'
436         WRITE(numout,*) '             add dynhpg implicit variable        nn_dynhpg_rst = ', nn_dynhpg_rst
437         WRITE(numout,*) '             in restart ot not nn_dynhpg_rst'
438      ENDIF
439      IF( .NOT. ln_dynhpg_imp )   nn_dynhpg_rst = 0      ! force no adding dynhpg implicit variables in restart
440
441   END SUBROUTINE opa_flg
442
443
444   SUBROUTINE opa_closefile
445      !!----------------------------------------------------------------------
446      !!                     ***  ROUTINE opa_closefile  ***
447      !!
448      !! ** Purpose :   Close the files
449      !!
450      !! ** Method  :
451      !!
452      !! History :
453      !!   9.0  !  05-01  (O. Le Galloudec)  Original code
454      !!----------------------------------------------------------------------
455      !! * Modules used
456      USE dtatem        ! temperature data
457      USE dtasal        ! salinity data
458      USE dtasst        ! sea surface temperature data
459      !!----------------------------------------------------------------------
460
461      IF ( lk_mpp ) CALL mppsync
462
463      ! 1. Unit close
464      ! -------------
465
466      CLOSE( numnam )       ! namelist
467      CLOSE( numout )       ! standard model output file
468      CLOSE( numstp )       ! time-step file
469
470      IF(lwp) CLOSE( numsol )
471
472   END SUBROUTINE opa_closefile
473
474   !!======================================================================
475END MODULE opa
Note: See TracBrowser for help on using the repository browser.