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

source: trunk/NEMO/OFF_SRC/DOM/domcfg.F90 @ 343

Last change on this file since 343 was 343, checked in by opalod, 18 years ago

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