[3117] | 1 | MODULE bdydyn3d |
---|
| 2 | !!====================================================================== |
---|
[3182] | 3 | !! *** MODULE bdydyn3d *** |
---|
[3191] | 4 | !! Unstructured Open Boundary Cond. : Flow relaxation scheme on baroclinic velocities |
---|
[3117] | 5 | !!====================================================================== |
---|
[3191] | 6 | !! History : 3.4 ! 2011 (D. Storkey) new module as part of BDY rewrite |
---|
[3680] | 7 | !! 3.5 ! 2012 (S. Mocavero, I. Epicoco) Optimization of BDY communications |
---|
[3117] | 8 | !!---------------------------------------------------------------------- |
---|
| 9 | #if defined key_bdy |
---|
| 10 | !!---------------------------------------------------------------------- |
---|
| 11 | !! 'key_bdy' : Unstructured Open Boundary Condition |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
| 13 | !! bdy_dyn3d : apply open boundary conditions to baroclinic velocities |
---|
| 14 | !! bdy_dyn3d_frs : apply Flow Relaxation Scheme |
---|
| 15 | !!---------------------------------------------------------------------- |
---|
[3182] | 16 | USE timing ! Timing |
---|
[3117] | 17 | USE oce ! ocean dynamics and tracers |
---|
| 18 | USE dom_oce ! ocean space and time domain |
---|
| 19 | USE bdy_oce ! ocean open boundary conditions |
---|
[4292] | 20 | USE bdylib ! for orlanski library routines |
---|
[3117] | 21 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
| 22 | USE in_out_manager ! |
---|
[3651] | 23 | Use phycst |
---|
[3117] | 24 | |
---|
| 25 | IMPLICIT NONE |
---|
| 26 | PRIVATE |
---|
| 27 | |
---|
[3191] | 28 | PUBLIC bdy_dyn3d ! routine called by bdy_dyn |
---|
[3651] | 29 | PUBLIC bdy_dyn3d_dmp ! routine called by step |
---|
[3117] | 30 | |
---|
| 31 | !!---------------------------------------------------------------------- |
---|
| 32 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[5215] | 33 | !! $Id$ |
---|
[3117] | 34 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
| 35 | !!---------------------------------------------------------------------- |
---|
| 36 | CONTAINS |
---|
| 37 | |
---|
| 38 | SUBROUTINE bdy_dyn3d( kt ) |
---|
| 39 | !!---------------------------------------------------------------------- |
---|
| 40 | !! *** SUBROUTINE bdy_dyn3d *** |
---|
| 41 | !! |
---|
| 42 | !! ** Purpose : - Apply open boundary conditions for baroclinic velocities |
---|
| 43 | !! |
---|
| 44 | !!---------------------------------------------------------------------- |
---|
[6140] | 45 | INTEGER, INTENT(in) :: kt ! Main time step counter |
---|
| 46 | ! |
---|
| 47 | INTEGER :: ib_bdy ! loop index |
---|
| 48 | !!---------------------------------------------------------------------- |
---|
| 49 | ! |
---|
[3117] | 50 | DO ib_bdy=1, nb_bdy |
---|
[6140] | 51 | ! |
---|
[4292] | 52 | SELECT CASE( cn_dyn3d(ib_bdy) ) |
---|
[6140] | 53 | CASE('none') ; CYCLE |
---|
| 54 | CASE('frs' ) ; CALL bdy_dyn3d_frs( idx_bdy(ib_bdy), dta_bdy(ib_bdy), kt, ib_bdy ) |
---|
| 55 | CASE('specified') ; CALL bdy_dyn3d_spe( idx_bdy(ib_bdy), dta_bdy(ib_bdy), kt, ib_bdy ) |
---|
| 56 | CASE('zero') ; CALL bdy_dyn3d_zro( idx_bdy(ib_bdy), dta_bdy(ib_bdy), kt, ib_bdy ) |
---|
| 57 | CASE('orlanski' ) ; CALL bdy_dyn3d_orlanski( idx_bdy(ib_bdy), dta_bdy(ib_bdy), ib_bdy, ll_npo=.false. ) |
---|
| 58 | CASE('orlanski_npo'); CALL bdy_dyn3d_orlanski( idx_bdy(ib_bdy), dta_bdy(ib_bdy), ib_bdy, ll_npo=.true. ) |
---|
| 59 | CASE DEFAULT ; CALL ctl_stop( 'bdy_dyn3d : unrecognised option for open boundaries for baroclinic velocities' ) |
---|
[3117] | 60 | END SELECT |
---|
[6140] | 61 | END DO |
---|
| 62 | ! |
---|
[3117] | 63 | END SUBROUTINE bdy_dyn3d |
---|
| 64 | |
---|
[6140] | 65 | |
---|
[3680] | 66 | SUBROUTINE bdy_dyn3d_spe( idx, dta, kt , ib_bdy ) |
---|
[3651] | 67 | !!---------------------------------------------------------------------- |
---|
| 68 | !! *** SUBROUTINE bdy_dyn3d_spe *** |
---|
| 69 | !! |
---|
| 70 | !! ** Purpose : - Apply a specified value for baroclinic velocities |
---|
| 71 | !! at open boundaries. |
---|
| 72 | !! |
---|
| 73 | !!---------------------------------------------------------------------- |
---|
[6140] | 74 | INTEGER , INTENT(in) :: kt ! time step index |
---|
| 75 | TYPE(OBC_INDEX), INTENT(in) :: idx ! OBC indices |
---|
| 76 | TYPE(OBC_DATA) , INTENT(in) :: dta ! OBC external data |
---|
| 77 | INTEGER , INTENT(in) :: ib_bdy ! BDY set index |
---|
| 78 | ! |
---|
[3651] | 79 | INTEGER :: jb, jk ! dummy loop indices |
---|
| 80 | INTEGER :: ii, ij, igrd ! local integers |
---|
| 81 | REAL(wp) :: zwgt ! boundary weight |
---|
| 82 | !!---------------------------------------------------------------------- |
---|
| 83 | ! |
---|
| 84 | IF( nn_timing == 1 ) CALL timing_start('bdy_dyn3d_spe') |
---|
| 85 | ! |
---|
| 86 | igrd = 2 ! Relaxation of zonal velocity |
---|
| 87 | DO jb = 1, idx%nblenrim(igrd) |
---|
| 88 | DO jk = 1, jpkm1 |
---|
| 89 | ii = idx%nbi(jb,igrd) |
---|
| 90 | ij = idx%nbj(jb,igrd) |
---|
| 91 | ua(ii,ij,jk) = dta%u3d(jb,jk) * umask(ii,ij,jk) |
---|
| 92 | END DO |
---|
| 93 | END DO |
---|
| 94 | ! |
---|
| 95 | igrd = 3 ! Relaxation of meridional velocity |
---|
| 96 | DO jb = 1, idx%nblenrim(igrd) |
---|
| 97 | DO jk = 1, jpkm1 |
---|
| 98 | ii = idx%nbi(jb,igrd) |
---|
| 99 | ij = idx%nbj(jb,igrd) |
---|
| 100 | va(ii,ij,jk) = dta%v3d(jb,jk) * vmask(ii,ij,jk) |
---|
| 101 | END DO |
---|
| 102 | END DO |
---|
[4292] | 103 | CALL lbc_bdy_lnk( ua, 'U', -1., ib_bdy ) ! Boundary points should be updated |
---|
| 104 | CALL lbc_bdy_lnk( va, 'V', -1., ib_bdy ) |
---|
[3651] | 105 | ! |
---|
[6140] | 106 | IF( kt == nit000 ) CLOSE( unit = 102 ) |
---|
| 107 | ! |
---|
[3651] | 108 | IF( nn_timing == 1 ) CALL timing_stop('bdy_dyn3d_spe') |
---|
[6140] | 109 | ! |
---|
[3651] | 110 | END SUBROUTINE bdy_dyn3d_spe |
---|
| 111 | |
---|
[6140] | 112 | |
---|
[3680] | 113 | SUBROUTINE bdy_dyn3d_zro( idx, dta, kt, ib_bdy ) |
---|
[3651] | 114 | !!---------------------------------------------------------------------- |
---|
| 115 | !! *** SUBROUTINE bdy_dyn3d_zro *** |
---|
| 116 | !! |
---|
| 117 | !! ** Purpose : - baroclinic velocities = 0. at open boundaries. |
---|
| 118 | !! |
---|
| 119 | !!---------------------------------------------------------------------- |
---|
[6140] | 120 | INTEGER , INTENT(in) :: kt ! time step index |
---|
| 121 | TYPE(OBC_INDEX), INTENT(in) :: idx ! OBC indices |
---|
| 122 | TYPE(OBC_DATA) , INTENT(in) :: dta ! OBC external data |
---|
[3680] | 123 | INTEGER, INTENT(in) :: ib_bdy ! BDY set index |
---|
[6140] | 124 | ! |
---|
[3651] | 125 | INTEGER :: ib, ik ! dummy loop indices |
---|
[6140] | 126 | INTEGER :: ii, ij, igrd ! local integers |
---|
[3651] | 127 | REAL(wp) :: zwgt ! boundary weight |
---|
| 128 | !!---------------------------------------------------------------------- |
---|
| 129 | ! |
---|
| 130 | IF( nn_timing == 1 ) CALL timing_start('bdy_dyn3d_zro') |
---|
| 131 | ! |
---|
| 132 | igrd = 2 ! Everything is at T-points here |
---|
| 133 | DO ib = 1, idx%nblenrim(igrd) |
---|
| 134 | ii = idx%nbi(ib,igrd) |
---|
| 135 | ij = idx%nbj(ib,igrd) |
---|
| 136 | DO ik = 1, jpkm1 |
---|
| 137 | ua(ii,ij,ik) = 0._wp |
---|
| 138 | END DO |
---|
| 139 | END DO |
---|
| 140 | |
---|
| 141 | igrd = 3 ! Everything is at T-points here |
---|
| 142 | DO ib = 1, idx%nblenrim(igrd) |
---|
| 143 | ii = idx%nbi(ib,igrd) |
---|
| 144 | ij = idx%nbj(ib,igrd) |
---|
| 145 | DO ik = 1, jpkm1 |
---|
| 146 | va(ii,ij,ik) = 0._wp |
---|
| 147 | END DO |
---|
| 148 | END DO |
---|
| 149 | ! |
---|
[3680] | 150 | CALL lbc_bdy_lnk( ua, 'U', -1., ib_bdy ) ; CALL lbc_bdy_lnk( va, 'V', -1.,ib_bdy ) ! Boundary points should be updated |
---|
[3651] | 151 | ! |
---|
[6140] | 152 | IF( kt == nit000 ) CLOSE( unit = 102 ) |
---|
| 153 | ! |
---|
| 154 | IF( nn_timing == 1 ) CALL timing_stop('bdy_dyn3d_zro') |
---|
| 155 | ! |
---|
| 156 | END SUBROUTINE bdy_dyn3d_zro |
---|
[3651] | 157 | |
---|
| 158 | |
---|
[3680] | 159 | SUBROUTINE bdy_dyn3d_frs( idx, dta, kt, ib_bdy ) |
---|
[3117] | 160 | !!---------------------------------------------------------------------- |
---|
| 161 | !! *** SUBROUTINE bdy_dyn3d_frs *** |
---|
| 162 | !! |
---|
| 163 | !! ** Purpose : - Apply the Flow Relaxation Scheme for baroclinic velocities |
---|
| 164 | !! at open boundaries. |
---|
| 165 | !! |
---|
| 166 | !! References :- Engedahl H., 1995: Use of the flow relaxation scheme in |
---|
| 167 | !! a three-dimensional baroclinic ocean model with realistic |
---|
| 168 | !! topography. Tellus, 365-382. |
---|
| 169 | !!---------------------------------------------------------------------- |
---|
[6140] | 170 | INTEGER , INTENT(in) :: kt ! time step index |
---|
| 171 | TYPE(OBC_INDEX), INTENT(in) :: idx ! OBC indices |
---|
| 172 | TYPE(OBC_DATA) , INTENT(in) :: dta ! OBC external data |
---|
[3680] | 173 | INTEGER, INTENT(in) :: ib_bdy ! BDY set index |
---|
[6140] | 174 | ! |
---|
[3117] | 175 | INTEGER :: jb, jk ! dummy loop indices |
---|
| 176 | INTEGER :: ii, ij, igrd ! local integers |
---|
| 177 | REAL(wp) :: zwgt ! boundary weight |
---|
| 178 | !!---------------------------------------------------------------------- |
---|
| 179 | ! |
---|
[3182] | 180 | IF( nn_timing == 1 ) CALL timing_start('bdy_dyn3d_frs') |
---|
[3117] | 181 | ! |
---|
| 182 | igrd = 2 ! Relaxation of zonal velocity |
---|
| 183 | DO jb = 1, idx%nblen(igrd) |
---|
| 184 | DO jk = 1, jpkm1 |
---|
| 185 | ii = idx%nbi(jb,igrd) |
---|
| 186 | ij = idx%nbj(jb,igrd) |
---|
| 187 | zwgt = idx%nbw(jb,igrd) |
---|
| 188 | ua(ii,ij,jk) = ( ua(ii,ij,jk) + zwgt * ( dta%u3d(jb,jk) - ua(ii,ij,jk) ) ) * umask(ii,ij,jk) |
---|
| 189 | END DO |
---|
| 190 | END DO |
---|
| 191 | ! |
---|
| 192 | igrd = 3 ! Relaxation of meridional velocity |
---|
| 193 | DO jb = 1, idx%nblen(igrd) |
---|
| 194 | DO jk = 1, jpkm1 |
---|
| 195 | ii = idx%nbi(jb,igrd) |
---|
| 196 | ij = idx%nbj(jb,igrd) |
---|
| 197 | zwgt = idx%nbw(jb,igrd) |
---|
| 198 | va(ii,ij,jk) = ( va(ii,ij,jk) + zwgt * ( dta%v3d(jb,jk) - va(ii,ij,jk) ) ) * vmask(ii,ij,jk) |
---|
| 199 | END DO |
---|
| 200 | END DO |
---|
[4292] | 201 | CALL lbc_bdy_lnk( ua, 'U', -1., ib_bdy ) ! Boundary points should be updated |
---|
| 202 | CALL lbc_bdy_lnk( va, 'V', -1., ib_bdy ) |
---|
[3117] | 203 | ! |
---|
[6140] | 204 | IF( kt == nit000 ) CLOSE( unit = 102 ) |
---|
| 205 | ! |
---|
| 206 | IF( nn_timing == 1 ) CALL timing_stop('bdy_dyn3d_frs') |
---|
| 207 | ! |
---|
| 208 | END SUBROUTINE bdy_dyn3d_frs |
---|
[3117] | 209 | |
---|
[3182] | 210 | |
---|
[4292] | 211 | SUBROUTINE bdy_dyn3d_orlanski( idx, dta, ib_bdy, ll_npo ) |
---|
| 212 | !!---------------------------------------------------------------------- |
---|
| 213 | !! *** SUBROUTINE bdy_dyn3d_orlanski *** |
---|
| 214 | !! |
---|
| 215 | !! - Apply Orlanski radiation to baroclinic velocities. |
---|
| 216 | !! - Wrapper routine for bdy_orlanski_3d |
---|
| 217 | !! |
---|
| 218 | !! |
---|
| 219 | !! References: Marchesiello, McWilliams and Shchepetkin, Ocean Modelling vol. 3 (2001) |
---|
| 220 | !!---------------------------------------------------------------------- |
---|
| 221 | TYPE(OBC_INDEX), INTENT(in) :: idx ! OBC indices |
---|
| 222 | TYPE(OBC_DATA), INTENT(in) :: dta ! OBC external data |
---|
| 223 | INTEGER, INTENT(in) :: ib_bdy ! BDY set index |
---|
| 224 | LOGICAL, INTENT(in) :: ll_npo ! switch for NPO version |
---|
| 225 | |
---|
| 226 | INTEGER :: jb, igrd ! dummy loop indices |
---|
| 227 | !!---------------------------------------------------------------------- |
---|
| 228 | |
---|
| 229 | IF( nn_timing == 1 ) CALL timing_start('bdy_dyn3d_orlanski') |
---|
| 230 | ! |
---|
| 231 | !! Note that at this stage the ub and ua arrays contain the baroclinic velocities. |
---|
| 232 | ! |
---|
| 233 | igrd = 2 ! Orlanski bc on u-velocity; |
---|
| 234 | ! |
---|
| 235 | CALL bdy_orlanski_3d( idx, igrd, ub, ua, dta%u3d, ll_npo ) |
---|
| 236 | |
---|
| 237 | igrd = 3 ! Orlanski bc on v-velocity |
---|
| 238 | ! |
---|
| 239 | CALL bdy_orlanski_3d( idx, igrd, vb, va, dta%v3d, ll_npo ) |
---|
| 240 | ! |
---|
| 241 | CALL lbc_bdy_lnk( ua, 'U', -1., ib_bdy ) ! Boundary points should be updated |
---|
| 242 | CALL lbc_bdy_lnk( va, 'V', -1., ib_bdy ) |
---|
| 243 | ! |
---|
| 244 | IF( nn_timing == 1 ) CALL timing_stop('bdy_dyn3d_orlanski') |
---|
| 245 | ! |
---|
| 246 | END SUBROUTINE bdy_dyn3d_orlanski |
---|
| 247 | |
---|
| 248 | |
---|
[3651] | 249 | SUBROUTINE bdy_dyn3d_dmp( kt ) |
---|
| 250 | !!---------------------------------------------------------------------- |
---|
| 251 | !! *** SUBROUTINE bdy_dyn3d_dmp *** |
---|
| 252 | !! |
---|
| 253 | !! ** Purpose : Apply damping for baroclinic velocities at open boundaries. |
---|
| 254 | !! |
---|
| 255 | !!---------------------------------------------------------------------- |
---|
[6140] | 256 | INTEGER, INTENT(in) :: kt ! time step index |
---|
| 257 | ! |
---|
[3651] | 258 | INTEGER :: jb, jk ! dummy loop indices |
---|
[6140] | 259 | INTEGER :: ib_bdy ! loop index |
---|
[3651] | 260 | INTEGER :: ii, ij, igrd ! local integers |
---|
| 261 | REAL(wp) :: zwgt ! boundary weight |
---|
| 262 | !!---------------------------------------------------------------------- |
---|
| 263 | ! |
---|
[6140] | 264 | IF( nn_timing == 1 ) CALL timing_start('bdy_dyn3d_dmp') |
---|
[3651] | 265 | ! |
---|
| 266 | DO ib_bdy=1, nb_bdy |
---|
[4292] | 267 | IF ( ln_dyn3d_dmp(ib_bdy) .and. cn_dyn3d(ib_bdy) /= 'none' ) THEN |
---|
[3651] | 268 | igrd = 2 ! Relaxation of zonal velocity |
---|
| 269 | DO jb = 1, idx_bdy(ib_bdy)%nblen(igrd) |
---|
| 270 | ii = idx_bdy(ib_bdy)%nbi(jb,igrd) |
---|
| 271 | ij = idx_bdy(ib_bdy)%nbj(jb,igrd) |
---|
| 272 | zwgt = idx_bdy(ib_bdy)%nbd(jb,igrd) |
---|
| 273 | DO jk = 1, jpkm1 |
---|
[3703] | 274 | ua(ii,ij,jk) = ( ua(ii,ij,jk) + zwgt * ( dta_bdy(ib_bdy)%u3d(jb,jk) - & |
---|
[4354] | 275 | ub(ii,ij,jk) + ub_b(ii,ij)) ) * umask(ii,ij,jk) |
---|
[3651] | 276 | END DO |
---|
| 277 | END DO |
---|
| 278 | ! |
---|
| 279 | igrd = 3 ! Relaxation of meridional velocity |
---|
| 280 | DO jb = 1, idx_bdy(ib_bdy)%nblen(igrd) |
---|
| 281 | ii = idx_bdy(ib_bdy)%nbi(jb,igrd) |
---|
| 282 | ij = idx_bdy(ib_bdy)%nbj(jb,igrd) |
---|
| 283 | zwgt = idx_bdy(ib_bdy)%nbd(jb,igrd) |
---|
| 284 | DO jk = 1, jpkm1 |
---|
[3703] | 285 | va(ii,ij,jk) = ( va(ii,ij,jk) + zwgt * ( dta_bdy(ib_bdy)%v3d(jb,jk) - & |
---|
[4354] | 286 | vb(ii,ij,jk) + vb_b(ii,ij)) ) * vmask(ii,ij,jk) |
---|
[3651] | 287 | END DO |
---|
| 288 | END DO |
---|
| 289 | ENDIF |
---|
[6140] | 290 | END DO |
---|
[3651] | 291 | ! |
---|
| 292 | CALL lbc_lnk( ua, 'U', -1. ) ; CALL lbc_lnk( va, 'V', -1. ) ! Boundary points should be updated |
---|
| 293 | ! |
---|
[6140] | 294 | IF( nn_timing == 1 ) CALL timing_stop('bdy_dyn3d_dmp') |
---|
| 295 | ! |
---|
[3651] | 296 | END SUBROUTINE bdy_dyn3d_dmp |
---|
| 297 | |
---|
| 298 | #else |
---|
[3117] | 299 | !!---------------------------------------------------------------------- |
---|
| 300 | !! Dummy module NO Unstruct Open Boundary Conditions |
---|
| 301 | !!---------------------------------------------------------------------- |
---|
| 302 | CONTAINS |
---|
| 303 | SUBROUTINE bdy_dyn3d( kt ) ! Empty routine |
---|
[3651] | 304 | WRITE(*,*) 'bdy_dyn3d: You should not have seen this print! error?', kt |
---|
[3117] | 305 | END SUBROUTINE bdy_dyn3d |
---|
[3651] | 306 | SUBROUTINE bdy_dyn3d_dmp( kt ) ! Empty routine |
---|
| 307 | WRITE(*,*) 'bdy_dyn3d_dmp: You should not have seen this print! error?', kt |
---|
| 308 | END SUBROUTINE bdy_dyn3d_dmp |
---|
[3117] | 309 | #endif |
---|
| 310 | |
---|
| 311 | !!====================================================================== |
---|
| 312 | END MODULE bdydyn3d |
---|