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/UKMO/dev_merge_2017_CICE_interface/NEMOGCM/TOOLS/DOMAINcfg/src – NEMO

source: branches/UKMO/dev_merge_2017_CICE_interface/NEMOGCM/TOOLS/DOMAINcfg/src/domcfg.f90 @ 9499

Last change on this file since 9499 was 9499, checked in by davestorkey, 6 years ago

branches/UKMO/dev_merge_2017_CICE_interface : clear SVN keywords.

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
19   IMPLICIT NONE
20   PRIVATE
21
22   PUBLIC   dom_cfg    ! called by opa.F90
23
24   !!----------------------------------------------------------------------
25   !! NEMO/OPA 3.2 , LODYC-IPSL  (2009)
26   !! $Id$
27   !! Software governed by the CeCILL licence     (NEMOGCM/NEMO_CeCILL.txt)
28   !!----------------------------------------------------------------------
29CONTAINS
30
31   SUBROUTINE dom_cfg
32      !!----------------------------------------------------------------------
33      !!                  ***  ROUTINE dom_cfg  ***
34      !!                   
35      !! ** Purpose :   set the domain configuration
36      !!
37      !!----------------------------------------------------------------------
38      !
39      IF( nn_timing == 1 )  CALL timing_start('dom_cfg')
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      IF( nn_timing == 1 )  CALL timing_stop('dom_cfg')
63      !
64   END SUBROUTINE dom_cfg
65
66
67   SUBROUTINE dom_glo
68      !!----------------------------------------------------------------------
69      !!                     ***  ROUTINE dom_glo  ***
70      !!
71      !! ** Purpose :   initialization for global domain, zoom and local domain
72      !!
73      !! ** Method  :   
74      !!
75      !! ** Action  : - mig  , mjg :
76      !!              - mi0  , mi1   :
77      !!              - mj0, , mj1   :
78      !!----------------------------------------------------------------------
79      INTEGER ::   ji, jj   ! dummy loop argument
80      !!----------------------------------------------------------------------
81      !                              ! recalculate jpizoom/jpjzoom given lat/lon
82      !
83      !                        ! ============== !
84      !                        !  Local domain  !
85      !                        ! ============== !
86      DO ji = 1, jpi                 ! local domain indices ==> data domain indices
87        mig(ji) = ji + jpizoom - 1 + nimpp - 1
88      END DO
89      DO jj = 1, jpj
90        mjg(jj) = jj + jpjzoom - 1 + njmpp - 1
91      END DO
92      !
93      !                              ! data domain indices ==> local domain indices
94      !                                   ! (return (m.0,m.1)=(1,0) if data domain gridpoint is to the west/south of the
95      !                                   !local domain, or (m.0,m.1)=(jp.+1,jp.) to the east/north of local domain.
96      DO ji = 1, jpidta
97        mi0(ji) = MAX( 1, MIN( ji - jpizoom + 1 - nimpp + 1, jpi+1 ) )
98        mi1(ji) = MAX( 0, MIN( ji - jpizoom + 1 - nimpp + 1, jpi   ) )
99      END DO
100      DO jj = 1, jpjdta
101        mj0(jj) = MAX( 1, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj+1 ) )
102        mj1(jj) = MAX( 0, MIN( jj - jpjzoom + 1 - njmpp + 1, jpj   ) )
103      END DO
104      IF(lwp) THEN                   ! control print
105         WRITE(numout,*)
106         WRITE(numout,*) 'dom_glo : domain: data / local '
107         WRITE(numout,*) '~~~~~~~ '
108         WRITE(numout,*) '          data input domain    : jpidta = ', jpidta,   &
109            &                                            ' jpjdta = ', jpjdta, ' jpkdta = ', jpkdta
110         WRITE(numout,*) '          global or zoom domain: jpiglo = ', jpiglo,   &
111            &                                            ' jpjglo = ', jpjglo, ' jpk    = ', jpk
112         WRITE(numout,*) '          local domain         : jpi    = ', jpi   ,   &
113            &                                            ' jpj    = ', jpj   , ' jpk    = ', jpk
114         WRITE(numout,*)
115         WRITE(numout,*) '          south-west indices    jpizoom = ', jpizoom,   &
116            &                                           ' jpjzoom = ', jpjzoom
117         IF( nn_print >= 1 ) THEN
118            WRITE(numout,*)
119            WRITE(numout,*) '          conversion local  ==> data i-index domain'
120            WRITE(numout,25)              (mig(ji),ji = 1,jpi)
121            WRITE(numout,*)
122            WRITE(numout,*) '          conversion data   ==> local  i-index domain'
123            WRITE(numout,*) '             starting index'
124            WRITE(numout,25)              (mi0(ji),ji = 1,jpidta)
125            WRITE(numout,*) '             ending index'
126            WRITE(numout,25)              (mi1(ji),ji = 1,jpidta)
127            WRITE(numout,*)
128            WRITE(numout,*) '          conversion local  ==> data j-index domain'
129            WRITE(numout,25)              (mjg(jj),jj = 1,jpj)
130            WRITE(numout,*)
131            WRITE(numout,*) '          conversion data  ==> local j-index domain'
132            WRITE(numout,*) '             starting index'
133            WRITE(numout,25)              (mj0(jj),jj = 1,jpjdta)
134            WRITE(numout,*) '             ending index'
135            WRITE(numout,25)              (mj1(jj),jj = 1,jpjdta)
136         ENDIF
137      ENDIF
138 25   FORMAT( 100(10x,19i4,/) )
139
140      !                        ! ============== !
141      !                        !  Zoom domain   !
142      !                        ! ============== !
143      !                              ! zoom control
144      IF( jpiglo + jpizoom - 1  >  jpidta .OR.   &
145          jpjglo + jpjzoom - 1  >  jpjdta      ) &
146          &   CALL ctl_stop( ' global or zoom domain exceed the data domain ! ' )
147
148      !                              ! set zoom flag
149      IF( jpiglo < jpidta .OR. jpjglo < jpjdta )   lzoom = .TRUE.
150
151      !                              ! set zoom type flags
152      IF( lzoom .AND. jpizoom /= 1 )   lzoom_w = .TRUE.                     !
153      IF( lzoom .AND. jpjzoom /= 1 )   lzoom_s = .TRUE.
154      IF( lzoom .AND. jpiglo + jpizoom -1 /= jpidta )   lzoom_e = .TRUE.
155      IF( lzoom .AND. jpjglo + jpjzoom -1 /= jpjdta )   lzoom_n = .TRUE.
156      IF(lwp) THEN
157         WRITE(numout,*)
158         WRITE(numout,*) '          zoom flags : '
159         WRITE(numout,*) '             lzoom   = ', lzoom  , ' (T = zoom, F = global )'
160         WRITE(numout,*) '             lzoom_e = ', lzoom_e, ' (T = forced closed east  boundary)'
161         WRITE(numout,*) '             lzoom_w = ', lzoom_w, ' (T = forced closed west  boundary)'
162         WRITE(numout,*) '             lzoom_s = ', lzoom_s, ' (T = forced closed South boundary)'
163         WRITE(numout,*) '             lzoom_n = ', lzoom_n, ' (T = forced closed North boundary)'
164      ENDIF
165      IF(  ( lzoom_e .OR. lzoom_w )  .AND.  ( jperio == 1 .OR. jperio == 4 .OR. jperio == 6 )  )   &
166           &   CALL ctl_stop( ' Your zoom choice is inconsistent with east-west cyclic boundary condition' )
167      IF(  lzoom_n  .AND.  ( 3 <= jperio .AND. jperio <= 6 )  )   &
168           &   CALL ctl_stop( ' Your zoom choice is inconsistent with North fold boundary condition' )
169
170      !                              ! Pre-defined arctic/antarctic zoom of ORCA configuration flag
171      IF( cp_cfg == "orca" ) THEN
172         SELECT CASE ( jp_cfg )
173         CASE ( 2 )                               !  ORCA_R2 configuration
174            IF(  cp_cfz == "arctic"    .AND. jpiglo  == 142    .AND. jpjglo  ==  53 .AND.   &
175               & jpizoom ==  21    .AND. jpjzoom ==  97         )   THEN
176              IF(lwp) WRITE(numout,*) '          ORCA configuration: arctic zoom '
177            ENDIF
178            IF(  cp_cfz == "antarctic" .AND. jpiglo  == jpidta .AND. jpjglo  ==  50 .AND.   &
179               & jpizoom ==   1    .AND. jpjzoom ==   1         )   THEN
180              IF(lwp) WRITE(numout,*) '          ORCA configuration: antarctic zoom '
181            ENDIF
182            !                             
183         CASE ( 05 )                              !  ORCA_R05 configuration
184            IF(    cp_cfz == "arctic"    .AND. jpiglo  == 562    .AND. jpjglo  == 202 .AND.   &
185               & jpizoom ==  81    .AND. jpjzoom == 301         )   THEN
186              IF(lwp) WRITE(numout,*) '          ORCA configuration: arctic zoom '
187            ENDIF
188            IF(    cp_cfz == "antarctic" .AND. jpiglo  == jpidta .AND. jpjglo  == 187 .AND.   &
189               & jpizoom ==   1    .AND. jpjzoom ==   1         )   THEN
190              IF(lwp) WRITE(numout,*) '          ORCA configuration: antarctic zoom '
191            ENDIF
192         END SELECT
193         !
194      ENDIF
195      !
196   END SUBROUTINE dom_glo
197
198   !!======================================================================
199END MODULE domcfg
Note: See TracBrowser for help on using the repository browser.