source: branches/UKMO/dev_r5518_GO6_package/NEMOGCM/NEMO/OPA_SRC/DOM/domcfg.F90 @ 6486

Last change on this file since 6486 was 6486, checked in by davestorkey, 5 years ago

Remove SVN keywords from UKMO/dev_r5518_GO6_package branch.

File size: 10.1 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   USE timing          ! Timing
18   USE c1d             ! 1D configuration
19   USE domc1d          ! 1D configuration: column location
20
21   IMPLICIT NONE
22   PRIVATE
23
24   PUBLIC   dom_cfg    ! called by opa.F90
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( nn_timing == 1 )  CALL timing_start('dom_cfg')
42      !
43      IF(lwp) THEN                   ! Control print
44         WRITE(numout,*)
45         WRITE(numout,*) 'dom_cfg : set the ocean configuration'
46         WRITE(numout,*) '~~~~~~~ '
47         WRITE(numout,*) '   ocean model configuration used :   cp_cfg = ', cp_cfg, ' jp_cfg = ', jp_cfg
48         !
49         WRITE(numout,*) '   global domain lateral boundaries'
50         !
51         IF( jperio == 0 )   WRITE(numout,*) '      jperio= 0, closed'
52         IF( jperio == 1 )   WRITE(numout,*) '      jperio= 1, cyclic east-west'
53         IF( jperio == 2 )   WRITE(numout,*) '      jperio= 2, equatorial symmetric'
54         IF( jperio == 3 )   WRITE(numout,*) '      jperio= 3, north fold with T-point pivot'
55         IF( jperio == 4 )   WRITE(numout,*) '      jperio= 4, cyclic east-west and north fold with T-point pivot'
56         IF( jperio == 5 )   WRITE(numout,*) '      jperio= 5, north fold with F-point pivot'
57         IF( jperio == 6 )   WRITE(numout,*) '      jperio= 6, cyclic east-west and north fold with F-point pivot'
58      ENDIF
59      !
60      IF( jperio <  0 .OR. jperio > 6 )   CALL ctl_stop( 'jperio is out of range' )
61      !
62      CALL dom_glo                   ! global domain versus zoom and/or local domain
63      !
64      IF( nn_timing == 1 )  CALL timing_stop('dom_cfg')
65      !
66   END SUBROUTINE dom_cfg
67
68
69   SUBROUTINE dom_glo
70      !!----------------------------------------------------------------------
71      !!                     ***  ROUTINE dom_glo  ***
72      !!
73      !! ** Purpose :   initialization for global domain, zoom and local domain
74      !!
75      !! ** Method  :   
76      !!
77      !! ** Action  : - mig  , mjg :
78      !!              - mi0  , mi1   :
79      !!              - mj0, , mj1   :
80      !!----------------------------------------------------------------------
81      INTEGER ::   ji, jj   ! dummy loop argument
82      !!----------------------------------------------------------------------
83      !                              ! recalculate jpizoom/jpjzoom given lat/lon
84      IF( lk_c1d .AND. ln_c1d_locpt )  CALL dom_c1d( rn_lat1d, rn_lon1d )
85      !
86      !                        ! ============== !
87      !                        !  Local domain  !
88      !                        ! ============== !
89      DO ji = 1, jpi                 ! local domain indices ==> data domain indices
90        mig(ji) = ji + jpizoom - 1 + nimpp - 1
91      END DO
92      DO jj = 1, jpj
93        mjg(jj) = jj + jpjzoom - 1 + njmpp - 1
94      END DO
95      !
96      !                              ! data domain indices ==> local domain indices
97      !                                   ! (return (m.0,m.1)=(1,0) if data domain gridpoint is to the west/south of the
98      !                                   !local domain, or (m.0,m.1)=(jp.+1,jp.) to the east/north of local domain.
99      DO ji = 1, jpidta
100        mi0(ji) = MAX( 1, MIN( ji - jpizoom + 1 - nimpp + 1, jpi+1 ) )
101        mi1(ji) = MAX( 0, MIN( ji - jpizoom + 1 - nimpp + 1, jpi   ) )
102      END DO
103      DO jj = 1, jpjdta
104        mj0(jj) = MAX( 1, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj+1 ) )
105        mj1(jj) = MAX( 0, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj   ) )
106      END DO
107      IF(lwp) THEN                   ! control print
108         WRITE(numout,*)
109         WRITE(numout,*) 'dom_glo : domain: data / local '
110         WRITE(numout,*) '~~~~~~~ '
111         WRITE(numout,*) '          data input domain    : jpidta = ', jpidta,   &
112            &                                            ' jpjdta = ', jpjdta, ' jpkdta = ', jpkdta
113         WRITE(numout,*) '          global or zoom domain: jpiglo = ', jpiglo,   &
114            &                                            ' jpjglo = ', jpjglo, ' jpk    = ', jpk
115         WRITE(numout,*) '          local domain         : jpi    = ', jpi   ,   &
116            &                                            ' jpj    = ', jpj   , ' jpk    = ', jpk
117         WRITE(numout,*)
118         WRITE(numout,*) '          south-west indices    jpizoom = ', jpizoom,   &
119            &                                           ' jpjzoom = ', jpjzoom
120         WRITE(numout,*)
121         WRITE(numout,*) '          conversion local  ==> data i-index domain'
122         WRITE(numout,25)              (mig(ji),ji = 1,jpi)
123         WRITE(numout,*)
124         WRITE(numout,*) '          conversion data   ==> local  i-index domain'
125         WRITE(numout,*) '             starting index'
126         WRITE(numout,25)              (mi0(ji),ji = 1,jpidta)
127         WRITE(numout,*) '             ending index'
128         WRITE(numout,25)              (mi1(ji),ji = 1,jpidta)
129         WRITE(numout,*)
130         WRITE(numout,*) '          conversion local  ==> data j-index domain'
131         WRITE(numout,25)              (mjg(jj),jj = 1,jpj)
132         WRITE(numout,*)
133         WRITE(numout,*) '          conversion data  ==> local j-index domain'
134         WRITE(numout,*) '             starting index'
135         WRITE(numout,25)              (mj0(jj),jj = 1,jpjdta)
136         WRITE(numout,*) '             ending index'
137         WRITE(numout,25)              (mj1(jj),jj = 1,jpjdta)
138      ENDIF
139 25   FORMAT( 100(10x,19i4,/) )
140
141      !                        ! ============== !
142      !                        !  Zoom domain   !
143      !                        ! ============== !
144      !                              ! zoom control
145      IF( jpiglo + jpizoom - 1  >  jpidta .OR.   &
146          jpjglo + jpjzoom - 1  >  jpjdta      ) &
147          &   CALL ctl_stop( ' global or zoom domain exceed the data domain ! ' )
148
149      !                              ! set zoom flag
150      IF( jpiglo < jpidta .OR. jpjglo < jpjdta )   lzoom = .TRUE.
151
152      !                              ! set zoom type flags
153      IF( lzoom .AND. jpizoom /= 1 )   lzoom_w = .TRUE.                     !
154      IF( lzoom .AND. jpjzoom /= 1 )   lzoom_s = .TRUE.
155      IF( lzoom .AND. jpiglo + jpizoom -1 /= jpidta )   lzoom_e = .TRUE.
156      IF( lzoom .AND. jpjglo + jpjzoom -1 /= jpjdta )   lzoom_n = .TRUE.
157      IF(lwp) THEN
158         WRITE(numout,*)
159         WRITE(numout,*) '          zoom flags : '
160         WRITE(numout,*) '             lzoom   = ', lzoom  , ' (T = zoom, F = global )'
161         WRITE(numout,*) '             lzoom_e = ', lzoom_e, ' (T = forced closed east  boundary)'
162         WRITE(numout,*) '             lzoom_w = ', lzoom_w, ' (T = forced closed west  boundary)'
163         WRITE(numout,*) '             lzoom_s = ', lzoom_s, ' (T = forced closed South boundary)'
164         WRITE(numout,*) '             lzoom_n = ', lzoom_n, ' (T = forced closed North boundary)'
165      ENDIF
166      IF(  ( lzoom_e .OR. lzoom_w )  .AND.  ( jperio == 1 .OR. jperio == 4 .OR. jperio == 6 )  )   &
167           &   CALL ctl_stop( ' Your zoom choice is inconsistent with east-west cyclic boundary condition' )
168      IF(  lzoom_n  .AND.  ( 3 <= jperio .AND. jperio <= 6 )  )   &
169           &   CALL ctl_stop( ' Your zoom choice is inconsistent with North fold boundary condition' )
170
171      !                              ! Pre-defined arctic/antarctic zoom of ORCA configuration flag
172      IF( cp_cfg == "orca" ) THEN
173         SELECT CASE ( jp_cfg )
174         CASE ( 2 )                               !  ORCA_R2 configuration
175            IF(  cp_cfz == "arctic"    .AND. jpiglo  == 142    .AND. jpjglo  ==  53 .AND.   &
176               & jpizoom ==  21    .AND. jpjzoom ==  97         )   THEN
177              IF(lwp) WRITE(numout,*) '          ORCA configuration: arctic zoom '
178            ENDIF
179            IF(  cp_cfz == "antarctic" .AND. jpiglo  == jpidta .AND. jpjglo  ==  50 .AND.   &
180               & jpizoom ==   1    .AND. jpjzoom ==   1         )   THEN
181              IF(lwp) WRITE(numout,*) '          ORCA configuration: antarctic zoom '
182            ENDIF
183            !                             
184         CASE ( 05 )                              !  ORCA_R05 configuration
185            IF(    cp_cfz == "arctic"    .AND. jpiglo  == 562    .AND. jpjglo  == 202 .AND.   &
186               & jpizoom ==  81    .AND. jpjzoom == 301         )   THEN
187              IF(lwp) WRITE(numout,*) '          ORCA configuration: arctic zoom '
188            ENDIF
189            IF(    cp_cfz == "antarctic" .AND. jpiglo  == jpidta .AND. jpjglo  == 187 .AND.   &
190               & jpizoom ==   1    .AND. jpjzoom ==   1         )   THEN
191              IF(lwp) WRITE(numout,*) '          ORCA configuration: antarctic zoom '
192            ENDIF
193         END SELECT
194         !
195      ENDIF
196      !
197   END SUBROUTINE dom_glo
198
199   !!======================================================================
200END MODULE domcfg
Note: See TracBrowser for help on using the repository browser.