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.
domcfg.F90 in branches/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: branches/2011/DEV_r2739_STFC_dCSE/NEMOGCM/NEMO/OPA_SRC/DOM/domcfg.F90 @ 3432

Last change on this file since 3432 was 3432, checked in by trackstand2, 12 years ago

Merge branch 'ksection_partition'
  • Property svn:keywords set to Id
File size: 11.5 KB
Line 
1MODULE domcfg
2   !!==============================================================================
3   !!                       ***  MODULE domcfg   ***
4   !! Ocean initialization : domain configuration initialization
5   !!==============================================================================
6   !! History :  1.0  ! 2003-09  (G. Madec)  Original code
7   !!            3.2  ! 2009-07  (R. Benshila) Suppression of rigid-lid option
8   !!----------------------------------------------------------------------
9
10   !!----------------------------------------------------------------------
11   !!   dom_cfg        : initialize the domain configuration
12   !!----------------------------------------------------------------------
13   USE dom_oce         ! ocean space and time domain
14   USE phycst          ! physical constants
15   USE in_out_manager  ! I/O manager
16   USE lib_mpp         ! distributed memory computing library
17
18   IMPLICIT NONE
19   PRIVATE
20
21   PUBLIC   dom_cfg    ! called by opa.F90
22
23   !! * Control permutation of array indices
24#  include "dom_oce_ftrans.h90"
25
26   !!----------------------------------------------------------------------
27   !! NEMO/OPA 3.2 , LODYC-IPSL  (2009)
28   !! $Id$
29   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
30   !!----------------------------------------------------------------------
31CONTAINS
32
33   SUBROUTINE dom_cfg
34      !!----------------------------------------------------------------------
35      !!                  ***  ROUTINE dom_cfg  ***
36      !!                   
37      !! ** Purpose :   set the domain configuration
38      !!
39      !!----------------------------------------------------------------------
40
41      IF(lwp) THEN                   ! Control print
42         WRITE(numout,*)
43         WRITE(numout,*) 'dom_cfg : set the ocean configuration'
44         WRITE(numout,*) '~~~~~~~ '
45         WRITE(numout,*) '   ocean model configuration used :   cp_cfg = ', cp_cfg, ' jp_cfg = ', jp_cfg
46         !
47         WRITE(numout,*) '   global domain lateral boundaries'
48         !
49         IF( jperio == 0 )   WRITE(numout,*) '      jperio= 0, closed'
50         IF( jperio == 1 )   WRITE(numout,*) '      jperio= 1, cyclic east-west'
51         IF( jperio == 2 )   WRITE(numout,*) '      jperio= 2, equatorial symmetric'
52         IF( jperio == 3 )   WRITE(numout,*) '      jperio= 3, north fold with T-point pivot'
53         IF( jperio == 4 )   WRITE(numout,*) '      jperio= 4, cyclic east-west and north fold with T-point pivot'
54         IF( jperio == 5 )   WRITE(numout,*) '      jperio= 5, north fold with F-point pivot'
55         IF( jperio == 6 )   WRITE(numout,*) '      jperio= 6, cyclic east-west and north fold with F-point pivot'
56      ENDIF
57      !
58      IF( jperio <  0 .OR. jperio > 6 )   CALL ctl_stop( 'jperio is out of range' )
59      !
60      CALL dom_glo                   ! global domain versus zoom and/or local domain
61      !
62   END SUBROUTINE dom_cfg
63
64
65   SUBROUTINE dom_glo
66      !!----------------------------------------------------------------------
67      !!                     ***  ROUTINE dom_glo  ***
68      !!
69      !! ** Purpose :   initialization for global domain, zoom and local domain
70      !!
71      !! ** Method  :   
72      !!
73      !! ** Action  : - mig  , mjg :
74      !!              - mi0  , mi1   :
75      !!              - mj0, , mj1   :
76      !!----------------------------------------------------------------------
77      USE mapcomm_mod, Only: iesub, jesub
78      !! * Local declarations
79      INTEGER ::   ji, jj   ! dummy loop argument
80      !!----------------------------------------------------------------------
81
82      !                        ! ============== !
83      !                        !  Local domain  !
84      !                        ! ============== !
85!!$#if defined key_mpp_rkpart
86!!$      WRITE(*,*) 'ARPDBG: ',narea,': dom_glo: nld{i,j} = ',nldi,nldj
87!!$      WRITE(*,*) 'ARPDBG: ',narea,': dom_glo: nlc{i,j} = ',nlci,nlcj
88!!$      WRITE(*,*) 'ARPDBG: ',narea,': dom_glo: n{i,j}mpp = ',nimpp, njmpp
89!!$      WRITE(*,*) 'ARPDBG: ',narea,': dom_glo: jp{i,j}zoom = ',jpizoom, jpjzoom
90!!$      DO ji = 1, jpi, 1
91!!$        mig(ji) = ji - nldi + jpizoom - 1 + nimpp - 1
92!!$!        WRITE(*,FMT="('ARPDBG, mig(',I3,') = ',I3)") &
93!!$!              ji, mig(ji)
94!!$      END DO
95!!$      DO jj = 1, jpj, 1
96!!$        mjg(jj) = jj - nldj + jpjzoom - 1 + njmpp - 1
97!!$!        WRITE(*,FMT="('ARPDBG, mjg(',I3,') = ',I3)") &
98!!$!              jj, mjg(jj)
99!!$      END DO
100!!$#else
101      DO ji = 1, jpi                 ! local domain indices ==> data domain indices
102        mig(ji) = ji + jpizoom - 1 + nimpp - 1
103      END DO
104      DO jj = 1, jpj
105        mjg(jj) = jj + jpjzoom - 1 + njmpp - 1
106      END DO
107!!$#endif
108      !
109      !                              ! data domain indices ==> local domain indices
110      !                                   ! (return (m.0,m.1)=(1,0) if data domain gridpoint is to the west/south of the
111      !                                   !local domain, or (m.0,m.1)=(jp.+1,jp.) to the east/north of local domain.
112#if defined key_mpp_rkpart
113      mi0(1:nimpp-1) = 1 !nldi
114      DO ji = 0,iesub-1,1
115         mi0(nimpp+ji) = nldi + ji
116      END DO
117      ! Halo columns (if any)
118      IF(nimpp+iesub <= jpidta)   mi0(nimpp+iesub) = jpi+1
119      IF(nimpp+iesub+1 <= jpidta) mi0(nimpp+iesub+1:)=jpi+1
120
121      mi1(1:nimpp-2) = 0
122      IF(nimpp > 1)mi1(nimpp - 1) = 0
123      DO ji = 0,iesub-1,1
124         mi1(nimpp+ji) = nldi + ji
125      END DO
126      ! Halo columns (if any)
127      IF(nimpp+iesub <= jpidta)   mi1(nimpp+iesub)   = jpi
128      IF(nimpp+iesub+1 <= jpidta) mi1(nimpp+iesub+1:)= jpi
129
130      mj0(:njmpp-1) = 1 ! nldj
131      DO jj = 0,jesub-1,1
132         mj0(njmpp+jj) = nldj + jj
133      END DO
134      ! Halo rows (if any)
135      IF(njmpp+jesub <= jpjdta)   mj0(njmpp+jesub) = jpj+1
136      IF(njmpp+jesub+1 <= jpjdta) mj0(njmpp+jesub+1:)=jpj+1
137
138      mj1(1:njmpp-2) = 0
139      IF(njmpp > 1)mj1(njmpp - 1) = 0
140      DO jj = 0,jesub-1,1
141         mj1(njmpp+jj) = nldj + jj
142      END DO
143      ! Halo rows (if any)
144      IF(njmpp+jesub <= jpjdta)   mj1(njmpp+jesub)   = jpj
145      IF(njmpp+jesub+1 <= jpjdta) mj1(njmpp+jesub+1:)= jpj
146#else
147      DO ji = 1, jpidta
148        mi0(ji) = MAX( 1, MIN( ji - jpizoom + 1 - nimpp + 1, jpi+1 ) )
149        mi1(ji) = MAX( 0, MIN( ji - jpizoom + 1 - nimpp + 1, jpi   ) )
150      END DO
151      DO jj = 1, jpjdta
152        mj0(jj) = MAX( 1, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj+1 ) )
153        mj1(jj) = MAX( 0, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj   ) )
154      END DO
155#endif
156
157      IF(lwp) THEN                   ! control print
158         WRITE(numout,*)
159         WRITE(numout,*) 'dom_glo : domain: data / local '
160         WRITE(numout,*) '~~~~~~~ '
161         WRITE(numout,*) '          data input domain    : jpidta = ', jpidta,   &
162            &                                            ' jpjdta = ', jpjdta, ' jpkdta = ', jpkdta
163         WRITE(numout,*) '          global or zoom domain: jpiglo = ', jpiglo,   &
164            &                                            ' jpjglo = ', jpjglo, ' jpk    = ', jpk
165         WRITE(numout,*) '          local domain         : jpi    = ', jpi   ,   &
166            &                                            ' jpj    = ', jpj   , ' jpk    = ', jpk
167         WRITE(numout,*)
168         WRITE(numout,*) '          south-west indices    jpizoom = ', jpizoom,   &
169            &                                           ' jpjzoom = ', jpjzoom
170         WRITE(numout,*)
171         WRITE(numout,*) '          conversion local  ==> data i-index domain'
172         WRITE(numout,25)              (mig(ji),ji = 1,jpi)
173         WRITE(numout,*)
174         WRITE(numout,*) '          conversion data   ==> local  i-index domain'
175         WRITE(numout,*) '             starting index'
176         WRITE(numout,25)              (mi0(ji),ji = 1,jpidta)
177         WRITE(numout,*) '             ending index'
178         WRITE(numout,25)              (mi1(ji),ji = 1,jpidta)
179         WRITE(numout,*)
180         WRITE(numout,*) '          conversion local  ==> data j-index domain'
181         WRITE(numout,25)              (mjg(jj),jj = 1,jpj)
182         WRITE(numout,*)
183         WRITE(numout,*) '          conversion data  ==> local j-index domain'
184         WRITE(numout,*) '             starting index'
185         WRITE(numout,25)              (mj0(jj),jj = 1,jpjdta)
186         WRITE(numout,*) '             ending index'
187         WRITE(numout,25)              (mj1(jj),jj = 1,jpjdta)
188      ENDIF
189 25   FORMAT( 100(10x,19i4,/) )
190
191      !                        ! ============== !
192      !                        !  Zoom domain   !
193      !                        ! ============== !
194      !                              ! zoom control
195      IF( jpiglo + jpizoom - 1  >  jpidta .OR.   &
196          jpjglo + jpjzoom - 1  >  jpjdta      ) &
197          &   CALL ctl_stop( ' global or zoom domain exceed the data domain ! ' )
198
199      !                              ! set zoom flag
200      IF( jpiglo < jpidta .OR. jpjglo < jpjdta )   lzoom = .TRUE.
201
202      !                              ! set zoom type flags
203      IF( lzoom .AND. jpizoom /= 1 )   lzoom_w = .TRUE.                     !
204      IF( lzoom .AND. jpjzoom /= 1 )   lzoom_s = .TRUE.
205      IF( lzoom .AND. jpiglo + jpizoom -1 /= jpidta )   lzoom_e = .TRUE.
206      IF( lzoom .AND. jpjglo + jpjzoom -1 /= jpjdta )   lzoom_n = .TRUE.
207
208      IF(lwp) THEN
209         WRITE(numout,*)
210         WRITE(numout,*) '          zoom flags : '
211         WRITE(numout,*) '             lzoom   = ', lzoom  , ' (T = zoom, F = global )'
212         WRITE(numout,*) '             lzoom_e = ', lzoom_e, ' (T = forced closed east  boundary)'
213         WRITE(numout,*) '             lzoom_w = ', lzoom_w, ' (T = forced closed west  boundary)'
214         WRITE(numout,*) '             lzoom_s = ', lzoom_s, ' (T = forced closed South boundary)'
215         WRITE(numout,*) '             lzoom_n = ', lzoom_n, ' (T = forced closed North boundary)'
216      ENDIF
217      IF(  ( lzoom_e .OR. lzoom_w )  .AND.  ( jperio == 1 .OR. jperio == 4 .OR. jperio == 6 )  )   &
218           &   CALL ctl_stop( ' Your zoom choice is inconsistent with east-west cyclic boundary condition' )
219      IF(  lzoom_n  .AND.  ( 3 <= jperio .AND. jperio <= 6 )  )   &
220           &   CALL ctl_stop( ' Your zoom choice is inconsistent with North fold boundary condition' )
221
222      !                              ! Pre-defined arctic/antarctic zoom of ORCA configuration flag
223      IF( cp_cfg == "orca" ) THEN
224         SELECT CASE ( jp_cfg )
225         CASE ( 2 )                               !  ORCA_R2 configuration
226            IF(  jpiglo  == 142    .AND. jpjglo  ==  53 .AND.   &
227               & jpizoom ==  21    .AND. jpjzoom ==  97         )   lzoom_arct = .TRUE.
228            IF(  jpiglo  == jpidta .AND. jpjglo  ==  50 .AND.   &
229               & jpizoom ==   1    .AND. jpjzoom ==   1         )   lzoom_anta = .TRUE.
230            !                             
231         CASE ( 05 )                              !  ORCA_R05 configuration
232            IF(  jpiglo  == 562    .AND. jpjglo  == 202 .AND.   &
233               & jpizoom ==  81    .AND. jpjzoom == 301         )   lzoom_arct = .TRUE.
234            IF(  jpiglo  == jpidta .AND. jpjglo  == 187 .AND.   &
235               & jpizoom ==   1    .AND. jpjzoom ==   1         )   lzoom_anta = .TRUE.
236         END SELECT
237         !
238         IF(lwp) WRITE(numout,*) '          ORCA configuration: antarctic/arctic zoom flags : '
239         IF(lwp) WRITE(numout,*) '             lzoom_arct = ', lzoom_arct, ' (T=   arctic zoom, F=global)'
240         IF(lwp) WRITE(numout,*) '             lzoom_anta = ', lzoom_anta, ' (T=antarctic zoom, F=global)'
241         !
242      ENDIF
243      !
244   END SUBROUTINE dom_glo
245
246   !!======================================================================
247END MODULE domcfg
Note: See TracBrowser for help on using the repository browser.