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