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/NEMOGCM/NEMO/OPA_SRC/DOM – NEMO

source: trunk/NEMOGCM/NEMO/OPA_SRC/DOM/domcfg.F90 @ 2715

Last change on this file since 2715 was 2715, checked in by rblod, 13 years ago

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