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 tags/start/NEMO/OFF_SRC/DOM – NEMO

source: tags/start/NEMO/OFF_SRC/DOM/domcfg.F90 @ 8479

Last change on this file since 8479 was 325, checked in by opalod, 19 years ago

Initial revision
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 10.1 KB
Line 
1MODULE domcfg
2   !!==============================================================================
3   !!                       ***  MODULE domcfg   ***
4   !! Ocean initialization : domain configuration initialization
5   !!==============================================================================
6
7   !!----------------------------------------------------------------------
8   !!   dom_cfg        : initialize the domain configuration
9   !!----------------------------------------------------------------------
10   !! * Modules used
11   USE dom_oce         ! ocean space and time domain
12   USE phycst          ! physical constants
13   USE in_out_manager  ! I/O manager
14   USE lib_mpp         ! distributed memory computing library
15
16   IMPLICIT NONE
17   PRIVATE
18
19   !! * Routine accessibility
20   PUBLIC dom_cfg        ! called by opa.F90
21   !!----------------------------------------------------------------------
22   !!   OPA 9.0 , LODYC-IPSL  (2003)
23   !!----------------------------------------------------------------------
24
25CONTAINS
26
27   SUBROUTINE dom_cfg
28      !!----------------------------------------------------------------------
29      !!                  ***  ROUTINE dom_cfg  ***
30      !!                   
31      !! ** Purpose :   set the domain configuration
32      !!
33      !! ** Method  :
34      !!
35      !! History :
36      !!   9.0  !  03-09  (G. Madec)  Original code
37      !!----------------------------------------------------------------------
38      !! * Local declarations
39      INTEGER ::   iconf = 0         ! temporary integers
40      !!----------------------------------------------------------------------
41
42      IF(lwp) THEN
43         WRITE(numout,*)
44         WRITE(numout,*) 'dom_cfg : set the ocean configuration'
45         WRITE(numout,*) '~~~~~~~      ocean model configuration used :',   &
46            &                             ' cp_cfg = ', cp_cfg, ' jp_cfg = ', jp_cfg
47      ENDIF
48
49      ! Global domain boundary conditions
50      ! ---------------------------------
51      IF(lwp) THEN
52         WRITE(numout,*) '          global domain lateral boundaries'
53
54         IF( jperio == 0 ) WRITE(numout,*) '             jperio= 0, closed'
55         IF( jperio == 1 ) WRITE(numout,*) '             jperio= 1, cyclic east-west'
56         IF( jperio == 2 ) WRITE(numout,*) '             jperio= 2, equatorial symmetric'
57         IF( jperio == 3 ) WRITE(numout,*) '             jperio= 3, north fold with T-point pivot'
58         IF( jperio == 4 ) WRITE(numout,*) '             jperio= 4, cyclic east-west and',   &
59                                                                  ' north fold with T-point pivot'
60         IF( jperio == 5 ) WRITE(numout,*) '             jperio= 5, north fold with F-point pivot'
61         IF( jperio == 6 ) WRITE(numout,*) '             jperio= 6, cyclic east-west and',   &
62                                                                  ' north fold with F-point pivot'
63      ENDIF
64      IF( jperio <  0 .OR. jperio > 6 ) THEN
65          IF(lwp) WRITE(numout,cform_err)
66          IF(lwp) WRITE(numout,*) 'jperio is out of range'
67          nstop = nstop + 1
68      ENDIF
69
70
71      ! global domain versus zoom and/or local domain
72      ! ---------------------------------------------
73
74      CALL dom_glo 
75
76   END SUBROUTINE dom_cfg
77
78
79   SUBROUTINE dom_glo
80      !!----------------------------------------------------------------------
81      !!                     ***  ROUTINE dom_glo  ***
82      !!
83      !! ** Purpose :   initialization for global domain, zoom and local domain
84      !!
85      !! ** Method  :   
86      !!
87      !! ** Action  : - mig  , mjg :
88      !!              - mi0  , mi1   :
89      !!              - mj0, , mj1   :
90      !!
91      !! History :
92      !!   8.5  !  02-08  (G. Madec)    Original code
93      !!----------------------------------------------------------------------
94      !! * Local declarations
95      INTEGER ::   ji, jj            ! dummy loop argument
96      !!----------------------------------------------------------------------
97
98      ! Local domain
99      ! ============
100
101      ! local domain indices ==> data domain indices
102      DO ji = 1, jpi
103        mig(ji) = ji + jpizoom - 1 + nimpp - 1
104      END DO
105      DO jj = 1, jpj
106        mjg(jj) = jj + jpjzoom - 1 + njmpp - 1
107      END DO
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      DO ji = 1, jpidta
113        mi0(ji) = MAX( 1, MIN( ji - jpizoom + 1 - nimpp + 1, jpi+1 ) )
114        mi1(ji) = MAX( 0, MIN( ji - jpizoom + 1 - nimpp + 1, jpi   ) )
115      END DO
116      DO jj = 1, jpjdta
117        mj0(jj) = MAX( 1, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj+1 ) )
118        mj1(jj) = MAX( 0, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj   ) )
119      END DO
120
121      IF(lwp) THEN
122         WRITE(numout,*)
123         WRITE(numout,*) 'dom_glo : domain: data / local '
124         WRITE(numout,*) '~~~~~~~ '
125         WRITE(numout,*) '          data input domain    : jpidta = ', jpidta,   &
126            &                                            ' jpjdta = ', jpjdta, ' jpkdta = ', jpkdta
127         WRITE(numout,*) '          global or zoom domain: jpiglo = ', jpiglo,   &
128            &                                            ' jpjglo = ', jpjglo, ' jpk    = ', jpk
129         WRITE(numout,*) '          local domain         : jpi    = ', jpi   ,   &
130            &                                            ' jpj    = ', jpj   , ' jpk    = ', jpk
131         WRITE(numout,*)
132         WRITE(numout,*) '          south-west indices    jpizoom = ', jpizoom,   &
133            &                                           ' jpjzoom = ', jpjzoom
134         WRITE(numout,*)
135         WRITE(numout,*) '          conversion local  ==> data i-index domain'
136         WRITE(numout,25)              (mig(ji),ji = 1,jpi)
137         WRITE(numout,*)
138         WRITE(numout,*) '          conversion data   ==> local  i-index domain'
139         WRITE(numout,*) '             starting index'
140         WRITE(numout,25)              (mi0(ji),ji = 1,jpidta)
141         WRITE(numout,*) '             ending index'
142         WRITE(numout,25)              (mi1(ji),ji = 1,jpidta)
143         WRITE(numout,*)
144         WRITE(numout,*) '          conversion local  ==> data i-index domain'
145         WRITE(numout,25)              (mjg(jj),jj = 1,jpj)
146         WRITE(numout,*)
147         WRITE(numout,*) '          conversion data  ==> local i-index domain'
148         WRITE(numout,*) '             starting index'
149         WRITE(numout,25)              (mj0(jj),jj = 1,jpjdta)
150         WRITE(numout,*) '             ending index'
151         WRITE(numout,25)              (mj1(jj),jj = 1,jpjdta)
152      ENDIF
153 25   FORMAT( 100(10x,19i4,/) )
154
155      ! Zoom domain
156      ! ===========
157
158      ! zoom control
159      IF( jpiglo + jpizoom - 1  >  jpidta .OR.   &
160          jpjglo + jpjzoom - 1  >  jpjdta      ) THEN
161         IF(lwp)WRITE(numout,cform_err)
162         IF(lwp)WRITE(numout,*)' global or zoom domain exceed the data domain ! '
163         nstop = nstop + 1
164      ENDIF
165
166      ! set zoom flag
167      IF ( jpiglo < jpidta .OR. jpjglo < jpjdta )   lzoom = .TRUE.
168
169      ! set zoom type flags
170      IF( lzoom .AND. jpizoom /= 1 )   lzoom_w = .TRUE.                     !
171      IF( lzoom .AND. jpjzoom /= 1 )   lzoom_s = .TRUE.
172      IF( lzoom .AND. jpiglo + jpizoom -1 /= jpidta )   lzoom_e = .TRUE.
173      IF( lzoom .AND. jpjglo + jpjzoom -1 /= jpjdta )   lzoom_n = .TRUE.
174
175      IF(lwp) THEN
176         WRITE(numout,*)
177         WRITE(numout,*) '          zoom flags : '
178         WRITE(numout,*) '             lzoom   = ', lzoom  , ' (T = zoom, F = global )'
179         WRITE(numout,*) '             lzoom_e = ', lzoom_e, ' (T = forced closed east  boundary)'
180         WRITE(numout,*) '             lzoom_w = ', lzoom_w, ' (T = forced closed west  boundary)'
181         WRITE(numout,*) '             lzoom_s = ', lzoom_s, ' (T = forced closed South boundary)'
182         WRITE(numout,*) '             lzoom_n = ', lzoom_n, ' (T = forced closed North boundary)'
183      ENDIF
184      IF(  ( lzoom_e .OR. lzoom_w )  .AND.  ( jperio == 1 .OR. jperio == 4 .OR. jperio == 6 )  ) THEN
185         IF(lwp)WRITE(numout,cform_err)
186         IF(lwp)WRITE(numout,*)' Your zoom choice is inconsistent with east-west cyclic boundary condition'
187         nstop = nstop + 1
188      ENDIF
189      IF(  lzoom_n  .AND.  ( 3 <= jperio .AND. jperio <= 6 )  ) THEN
190         IF(lwp)WRITE(numout,cform_err)
191         IF(lwp)WRITE(numout,*)' Your zoom choice is inconsistent with North fold boundary condition'
192         nstop = nstop + 1
193      ENDIF
194
195      ! Pre-defined arctic/antarctic zoom of ORCA configuration flag
196      IF( cp_cfg == "orca" ) THEN
197         SELECT CASE ( jp_cfg )
198         !                                        ! =======================
199         CASE ( 2 )                               !  ORCA_R2 configuration
200            !                                     ! =======================
201            IF(  jpiglo  == 142    .AND. jpjglo  ==  53 .AND.   &
202               & jpizoom ==  21    .AND. jpjzoom ==  97         )   lzoom_arct = .TRUE.
203            IF(  jpiglo  == jpidta .AND. jpjglo  ==  50 .AND.   &
204               & jpizoom ==   1    .AND. jpjzoom ==   1         )   lzoom_anta = .TRUE.
205            !                                     ! =======================
206         CASE ( 05 )                              !  ORCA_R05 configuration
207            !                                     ! =======================
208            IF(  jpiglo  == 562    .AND. jpjglo  == 202 .AND.   &
209               & jpizoom ==  81    .AND. jpjzoom == 301         )   lzoom_arct = .TRUE.
210            IF(  jpiglo  == jpidta .AND. jpjglo  == 187 .AND.   &
211               & jpizoom ==   1    .AND. jpjzoom ==   1         )   lzoom_anta = .TRUE.
212         END SELECT
213         !
214         IF(lwp) WRITE(numout,*) '          ORCA configuration: antarctic/arctic zoom flags : '
215         IF(lwp) WRITE(numout,*) '             lzoom_arct = ', lzoom_arct, ' (T=   arctic zoom, F=global)'
216         IF(lwp) WRITE(numout,*) '             lzoom_anta = ', lzoom_anta, ' (T=antarctic zoom, F=global)'
217         !
218      ENDIF
219         
220   END SUBROUTINE dom_glo
221
222   !!======================================================================
223END MODULE domcfg
Note: See TracBrowser for help on using the repository browser.