[911] | 1 | MODULE bdytides |
---|
[1125] | 2 | !!====================================================================== |
---|
[911] | 3 | !! *** MODULE bdytides *** |
---|
| 4 | !! Ocean dynamics: Tidal forcing at open boundaries |
---|
[1125] | 5 | !!====================================================================== |
---|
| 6 | !! History : 2.0 ! 2007-01 (D.Storkey) Original code |
---|
| 7 | !! 2.3 ! 2008-01 (J.Holt) Add date correction. Origins POLCOMS v6.3 2007 |
---|
| 8 | !! 3.0 ! 2008-04 (NEMO team) add in the reference version |
---|
[2528] | 9 | !! 3.3 ! 2010-09 (D.Storkey and E.O'Dea) bug fixes |
---|
[3651] | 10 | !! 3.4 ! 2012-09 (G. Reffray and J. Chanut) New inputs + mods |
---|
[4292] | 11 | !! 3.5 ! 2013-07 (J. Chanut) Compliant with time splitting changes |
---|
[1125] | 12 | !!---------------------------------------------------------------------- |
---|
[6140] | 13 | !! bdytide_init : read of namelist and initialisation of tidal harmonics data |
---|
| 14 | !! tide_update : calculation of tidal forcing at each timestep |
---|
[1125] | 15 | !!---------------------------------------------------------------------- |
---|
[6140] | 16 | USE oce ! ocean dynamics and tracers |
---|
| 17 | USE dom_oce ! ocean space and time domain |
---|
| 18 | USE phycst ! physical constants |
---|
| 19 | USE bdy_oce ! ocean open boundary conditions |
---|
[12184] | 20 | USE tide_mod ! |
---|
[6140] | 21 | USE daymod ! calendar |
---|
| 22 | ! |
---|
| 23 | USE in_out_manager ! I/O units |
---|
| 24 | USE iom ! xIO server |
---|
| 25 | USE fldread ! |
---|
| 26 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
[1125] | 27 | |
---|
[911] | 28 | IMPLICIT NONE |
---|
| 29 | PRIVATE |
---|
| 30 | |
---|
[3651] | 31 | PUBLIC bdytide_init ! routine called in bdy_init |
---|
[4292] | 32 | PUBLIC bdy_dta_tides ! routine called in dyn_spg_ts |
---|
[911] | 33 | |
---|
[3294] | 34 | TYPE, PUBLIC :: TIDES_DATA !: Storage for external tidal harmonics data |
---|
[6140] | 35 | REAL(wp), POINTER, DIMENSION(:,:,:) :: ssh0 !: Tidal constituents : SSH0 (read in file) |
---|
| 36 | REAL(wp), POINTER, DIMENSION(:,:,:) :: u0, v0 !: Tidal constituents : U0, V0 (read in file) |
---|
| 37 | REAL(wp), POINTER, DIMENSION(:,:,:) :: ssh !: Tidal constituents : SSH (after nodal cor.) |
---|
| 38 | REAL(wp), POINTER, DIMENSION(:,:,:) :: u , v !: Tidal constituents : U , V (after nodal cor.) |
---|
[3294] | 39 | END TYPE TIDES_DATA |
---|
[911] | 40 | |
---|
[4354] | 41 | !$AGRIF_DO_NOT_TREAT |
---|
[3651] | 42 | TYPE(TIDES_DATA), PUBLIC, DIMENSION(jp_bdy), TARGET :: tides !: External tidal harmonics data |
---|
[4354] | 43 | !$AGRIF_END_DO_NOT_TREAT |
---|
[5930] | 44 | TYPE(OBC_DATA) , PUBLIC, DIMENSION(jp_bdy) :: dta_bdy_s !: bdy external data (slow component) |
---|
[911] | 45 | |
---|
[12184] | 46 | INTEGER :: kt_tide |
---|
| 47 | |
---|
[1125] | 48 | !!---------------------------------------------------------------------- |
---|
[9598] | 49 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[6140] | 50 | !! $Id$ |
---|
[10068] | 51 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[1125] | 52 | !!---------------------------------------------------------------------- |
---|
[911] | 53 | CONTAINS |
---|
| 54 | |
---|
[3651] | 55 | SUBROUTINE bdytide_init |
---|
[1125] | 56 | !!---------------------------------------------------------------------- |
---|
[3651] | 57 | !! *** SUBROUTINE bdytide_init *** |
---|
[1125] | 58 | !! |
---|
[3294] | 59 | !! ** Purpose : - Read in namelist for tides and initialise external |
---|
| 60 | !! tidal harmonics data |
---|
[911] | 61 | !! |
---|
| 62 | !!---------------------------------------------------------------------- |
---|
[3294] | 63 | !! namelist variables |
---|
| 64 | !!------------------- |
---|
[3651] | 65 | CHARACTER(len=80) :: filtide !: Filename root for tidal input files |
---|
| 66 | LOGICAL :: ln_bdytide_2ddta !: If true, read 2d harmonic data |
---|
[1125] | 67 | !! |
---|
[3651] | 68 | INTEGER :: ib_bdy, itide, ib !: dummy loop indices |
---|
| 69 | INTEGER :: ii, ij !: dummy loop indices |
---|
[3294] | 70 | INTEGER :: inum, igrd |
---|
[3651] | 71 | INTEGER, DIMENSION(3) :: ilen0 !: length of boundary data (from OBC arrays) |
---|
[4147] | 72 | INTEGER :: ios ! Local integer output status for namelist read |
---|
[12202] | 73 | INTEGER :: nbdy_rdstart, nbdy_loc |
---|
| 74 | CHARACTER(LEN=50) :: cerrmsg !: error string |
---|
[3651] | 75 | CHARACTER(len=80) :: clfile !: full file name for tidal input file |
---|
| 76 | REAL(wp),ALLOCATABLE, DIMENSION(:,:,:) :: dta_read !: work space to read in tidal harmonics data |
---|
[9125] | 77 | REAL(wp),ALLOCATABLE, DIMENSION(:,:) :: ztr, zti !: " " " " " " " " |
---|
[3294] | 78 | !! |
---|
[3651] | 79 | TYPE(TIDES_DATA), POINTER :: td !: local short cut |
---|
[3294] | 80 | !! |
---|
[12184] | 81 | NAMELIST/nambdy_tide/filtide, ln_bdytide_2ddta |
---|
[1125] | 82 | !!---------------------------------------------------------------------- |
---|
[6140] | 83 | ! |
---|
[11536] | 84 | IF(lwp) WRITE(numout,*) |
---|
| 85 | IF(lwp) WRITE(numout,*) 'bdytide_init : initialization of tidal harmonic forcing at open boundaries' |
---|
| 86 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~' |
---|
[911] | 87 | |
---|
[3651] | 88 | |
---|
[12202] | 89 | nbdy_rdstart = 1 |
---|
[3294] | 90 | DO ib_bdy = 1, nb_bdy |
---|
[7646] | 91 | IF( nn_dyn2d_dta(ib_bdy) >= 2 ) THEN |
---|
| 92 | ! |
---|
[3294] | 93 | td => tides(ib_bdy) |
---|
[911] | 94 | |
---|
[3294] | 95 | ! Namelist nambdy_tide : tidal harmonic forcing at open boundaries |
---|
| 96 | filtide(:) = '' |
---|
[911] | 97 | |
---|
[11536] | 98 | READ ( numnam_ref, nambdy_tide, IOSTAT = ios, ERR = 901) |
---|
| 99 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'nambdy_tide in reference namelist' ) |
---|
[12202] | 100 | ! |
---|
| 101 | ! Need to support possibility of reading more than one |
---|
| 102 | ! nambdy_tide from the namelist_cfg internal file. |
---|
| 103 | ! Do this by finding the ib_bdy'th occurence of nambdy_tide in the |
---|
| 104 | ! character buffer as the starting point. |
---|
| 105 | ! |
---|
| 106 | nbdy_loc = INDEX( numnam_cfg( nbdy_rdstart: ), 'nambdy_tide' ) |
---|
| 107 | IF( nbdy_loc .GT. 0 ) THEN |
---|
| 108 | nbdy_rdstart = nbdy_rdstart + nbdy_loc |
---|
| 109 | ELSE |
---|
| 110 | WRITE(cerrmsg,'(A,I4,A)') 'Error: entry number ',ib_bdy,' of nambdy_tide not found' |
---|
| 111 | ios = -1 |
---|
| 112 | CALL ctl_nam ( ios , cerrmsg ) |
---|
| 113 | ENDIF |
---|
| 114 | READ ( numnam_cfg( MAX( 1, nbdy_rdstart - 2 ): ), nambdy_tide, IOSTAT = ios, ERR = 902) |
---|
[11536] | 115 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'nambdy_tide in configuration namelist' ) |
---|
[4624] | 116 | IF(lwm) WRITE ( numond, nambdy_tide ) |
---|
[3651] | 117 | ! ! Parameter control and print |
---|
| 118 | IF(lwp) WRITE(numout,*) ' ' |
---|
| 119 | IF(lwp) WRITE(numout,*) ' Namelist nambdy_tide : tidal harmonic forcing at open boundaries' |
---|
| 120 | IF(lwp) WRITE(numout,*) ' read tidal data in 2d files: ', ln_bdytide_2ddta |
---|
| 121 | IF(lwp) WRITE(numout,*) ' Number of tidal components to read: ', nb_harmo |
---|
| 122 | IF(lwp) THEN |
---|
[5084] | 123 | WRITE(numout,*) ' Tidal components: ' |
---|
[3651] | 124 | DO itide = 1, nb_harmo |
---|
[12184] | 125 | WRITE(numout,*) ' ', tide_harmonics(itide)%cname_tide |
---|
[3651] | 126 | END DO |
---|
| 127 | ENDIF |
---|
| 128 | IF(lwp) WRITE(numout,*) ' ' |
---|
[1125] | 129 | |
---|
[3651] | 130 | ! Allocate space for tidal harmonics data - get size from OBC data arrays |
---|
| 131 | ! ----------------------------------------------------------------------- |
---|
[911] | 132 | |
---|
[3651] | 133 | ! JC: If FRS scheme is used, we assume that tidal is needed over the whole |
---|
| 134 | ! relaxation area |
---|
[11536] | 135 | IF( cn_dyn2d(ib_bdy) == 'frs' ) THEN ; ilen0(:) = idx_bdy(ib_bdy)%nblen (:) |
---|
| 136 | ELSE ; ilen0(:) = idx_bdy(ib_bdy)%nblenrim(:) |
---|
[3294] | 137 | ENDIF |
---|
[911] | 138 | |
---|
[3651] | 139 | ALLOCATE( td%ssh0( ilen0(1), nb_harmo, 2 ) ) |
---|
| 140 | ALLOCATE( td%ssh ( ilen0(1), nb_harmo, 2 ) ) |
---|
[911] | 141 | |
---|
[3651] | 142 | ALLOCATE( td%u0( ilen0(2), nb_harmo, 2 ) ) |
---|
| 143 | ALLOCATE( td%u ( ilen0(2), nb_harmo, 2 ) ) |
---|
[911] | 144 | |
---|
[3651] | 145 | ALLOCATE( td%v0( ilen0(3), nb_harmo, 2 ) ) |
---|
| 146 | ALLOCATE( td%v ( ilen0(3), nb_harmo, 2 ) ) |
---|
[911] | 147 | |
---|
[4292] | 148 | td%ssh0(:,:,:) = 0._wp |
---|
| 149 | td%ssh (:,:,:) = 0._wp |
---|
| 150 | td%u0 (:,:,:) = 0._wp |
---|
| 151 | td%u (:,:,:) = 0._wp |
---|
| 152 | td%v0 (:,:,:) = 0._wp |
---|
| 153 | td%v (:,:,:) = 0._wp |
---|
[3294] | 154 | |
---|
[7646] | 155 | IF( ln_bdytide_2ddta ) THEN |
---|
[3651] | 156 | ! It is assumed that each data file contains all complex harmonic amplitudes |
---|
[7646] | 157 | ! given on the global domain (ie global, jpiglo x jpjglo) |
---|
[3651] | 158 | ! |
---|
[9125] | 159 | ALLOCATE( zti(jpi,jpj), ztr(jpi,jpj) ) |
---|
[3651] | 160 | ! |
---|
| 161 | ! SSH fields |
---|
| 162 | clfile = TRIM(filtide)//'_grid_T.nc' |
---|
[7646] | 163 | CALL iom_open( clfile , inum ) |
---|
[3651] | 164 | igrd = 1 ! Everything is at T-points here |
---|
| 165 | DO itide = 1, nb_harmo |
---|
[12184] | 166 | CALL iom_get( inum, jpdom_autoglo, TRIM(tide_harmonics(itide)%cname_tide)//'_z1', ztr(:,:) ) |
---|
| 167 | CALL iom_get( inum, jpdom_autoglo, TRIM(tide_harmonics(itide)%cname_tide)//'_z2', zti(:,:) ) |
---|
[3651] | 168 | DO ib = 1, ilen0(igrd) |
---|
| 169 | ii = idx_bdy(ib_bdy)%nbi(ib,igrd) |
---|
| 170 | ij = idx_bdy(ib_bdy)%nbj(ib,igrd) |
---|
[11536] | 171 | IF( ii == 1 .OR. ii == jpi .OR. ij == 1 .OR. ij == jpj ) CYCLE ! to remove? |
---|
[3651] | 172 | td%ssh0(ib,itide,1) = ztr(ii,ij) |
---|
| 173 | td%ssh0(ib,itide,2) = zti(ii,ij) |
---|
| 174 | END DO |
---|
| 175 | END DO |
---|
[3294] | 176 | CALL iom_close( inum ) |
---|
[3651] | 177 | ! |
---|
| 178 | ! U fields |
---|
| 179 | clfile = TRIM(filtide)//'_grid_U.nc' |
---|
[7646] | 180 | CALL iom_open( clfile , inum ) |
---|
[3651] | 181 | igrd = 2 ! Everything is at U-points here |
---|
| 182 | DO itide = 1, nb_harmo |
---|
[12184] | 183 | CALL iom_get ( inum, jpdom_autoglo, TRIM(tide_harmonics(itide)%cname_tide)//'_u1', ztr(:,:) ) |
---|
| 184 | CALL iom_get ( inum, jpdom_autoglo, TRIM(tide_harmonics(itide)%cname_tide)//'_u2', zti(:,:) ) |
---|
[3651] | 185 | DO ib = 1, ilen0(igrd) |
---|
| 186 | ii = idx_bdy(ib_bdy)%nbi(ib,igrd) |
---|
| 187 | ij = idx_bdy(ib_bdy)%nbj(ib,igrd) |
---|
[11536] | 188 | IF( ii == 1 .OR. ii == jpi .OR. ij == 1 .OR. ij == jpj ) CYCLE ! to remove? |
---|
[3651] | 189 | td%u0(ib,itide,1) = ztr(ii,ij) |
---|
| 190 | td%u0(ib,itide,2) = zti(ii,ij) |
---|
| 191 | END DO |
---|
| 192 | END DO |
---|
[3294] | 193 | CALL iom_close( inum ) |
---|
[3651] | 194 | ! |
---|
| 195 | ! V fields |
---|
| 196 | clfile = TRIM(filtide)//'_grid_V.nc' |
---|
[7646] | 197 | CALL iom_open( clfile , inum ) |
---|
[3651] | 198 | igrd = 3 ! Everything is at V-points here |
---|
| 199 | DO itide = 1, nb_harmo |
---|
[12184] | 200 | CALL iom_get ( inum, jpdom_autoglo, TRIM(tide_harmonics(itide)%cname_tide)//'_v1', ztr(:,:) ) |
---|
| 201 | CALL iom_get ( inum, jpdom_autoglo, TRIM(tide_harmonics(itide)%cname_tide)//'_v2', zti(:,:) ) |
---|
[3651] | 202 | DO ib = 1, ilen0(igrd) |
---|
| 203 | ii = idx_bdy(ib_bdy)%nbi(ib,igrd) |
---|
| 204 | ij = idx_bdy(ib_bdy)%nbj(ib,igrd) |
---|
[11536] | 205 | IF( ii == 1 .OR. ii == jpi .OR. ij == 1 .OR. ij == jpj ) CYCLE ! to remove? |
---|
[3651] | 206 | td%v0(ib,itide,1) = ztr(ii,ij) |
---|
| 207 | td%v0(ib,itide,2) = zti(ii,ij) |
---|
| 208 | END DO |
---|
| 209 | END DO |
---|
[3294] | 210 | CALL iom_close( inum ) |
---|
| 211 | ! |
---|
[9125] | 212 | DEALLOCATE( ztr, zti ) |
---|
[3651] | 213 | ! |
---|
| 214 | ELSE |
---|
| 215 | ! |
---|
| 216 | ! Read tidal data only on bdy segments |
---|
| 217 | ! |
---|
| 218 | ALLOCATE( dta_read( MAXVAL(ilen0(1:3)), 1, 1 ) ) |
---|
[5132] | 219 | ! |
---|
[3651] | 220 | ! Open files and read in tidal forcing data |
---|
| 221 | ! ----------------------------------------- |
---|
[3294] | 222 | |
---|
[3651] | 223 | DO itide = 1, nb_harmo |
---|
| 224 | ! ! SSH fields |
---|
[12184] | 225 | clfile = TRIM(filtide)//TRIM(tide_harmonics(itide)%cname_tide)//'_grid_T.nc' |
---|
[3651] | 226 | CALL iom_open( clfile, inum ) |
---|
[11536] | 227 | CALL fld_map( inum, 'z1' , dta_read(1:ilen0(1),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,1) ) |
---|
[3651] | 228 | td%ssh0(:,itide,1) = dta_read(1:ilen0(1),1,1) |
---|
[11536] | 229 | CALL fld_map( inum, 'z2' , dta_read(1:ilen0(1),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,1) ) |
---|
[3651] | 230 | td%ssh0(:,itide,2) = dta_read(1:ilen0(1),1,1) |
---|
| 231 | CALL iom_close( inum ) |
---|
| 232 | ! ! U fields |
---|
[12184] | 233 | clfile = TRIM(filtide)//TRIM(tide_harmonics(itide)%cname_tide)//'_grid_U.nc' |
---|
[3651] | 234 | CALL iom_open( clfile, inum ) |
---|
[11536] | 235 | CALL fld_map( inum, 'u1' , dta_read(1:ilen0(2),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,2) ) |
---|
[3651] | 236 | td%u0(:,itide,1) = dta_read(1:ilen0(2),1,1) |
---|
[11536] | 237 | CALL fld_map( inum, 'u2' , dta_read(1:ilen0(2),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,2) ) |
---|
[3651] | 238 | td%u0(:,itide,2) = dta_read(1:ilen0(2),1,1) |
---|
| 239 | CALL iom_close( inum ) |
---|
| 240 | ! ! V fields |
---|
[12184] | 241 | clfile = TRIM(filtide)//TRIM(tide_harmonics(itide)%cname_tide)//'_grid_V.nc' |
---|
[3651] | 242 | CALL iom_open( clfile, inum ) |
---|
[11536] | 243 | CALL fld_map( inum, 'v1' , dta_read(1:ilen0(3),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,3) ) |
---|
[3651] | 244 | td%v0(:,itide,1) = dta_read(1:ilen0(3),1,1) |
---|
[11536] | 245 | CALL fld_map( inum, 'v2' , dta_read(1:ilen0(3),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,3) ) |
---|
[3651] | 246 | td%v0(:,itide,2) = dta_read(1:ilen0(3),1,1) |
---|
| 247 | CALL iom_close( inum ) |
---|
[3294] | 248 | ! |
---|
[3651] | 249 | END DO ! end loop on tidal components |
---|
[3294] | 250 | ! |
---|
[3651] | 251 | DEALLOCATE( dta_read ) |
---|
[7646] | 252 | ! |
---|
[3651] | 253 | ENDIF ! ln_bdytide_2ddta=.true. |
---|
[1125] | 254 | ! |
---|
[5930] | 255 | ! Allocate slow varying data in the case of time splitting: |
---|
| 256 | ! Do it anyway because at this stage knowledge of free surface scheme is unknown |
---|
| 257 | ALLOCATE( dta_bdy_s(ib_bdy)%ssh ( ilen0(1) ) ) |
---|
| 258 | ALLOCATE( dta_bdy_s(ib_bdy)%u2d ( ilen0(2) ) ) |
---|
| 259 | ALLOCATE( dta_bdy_s(ib_bdy)%v2d ( ilen0(3) ) ) |
---|
[6140] | 260 | dta_bdy_s(ib_bdy)%ssh(:) = 0._wp |
---|
| 261 | dta_bdy_s(ib_bdy)%u2d(:) = 0._wp |
---|
| 262 | dta_bdy_s(ib_bdy)%v2d(:) = 0._wp |
---|
[4292] | 263 | ! |
---|
[7646] | 264 | ENDIF ! nn_dyn2d_dta(ib_bdy) >= 2 |
---|
[1125] | 265 | ! |
---|
[3294] | 266 | END DO ! loop on ib_bdy |
---|
[6140] | 267 | ! |
---|
| 268 | END SUBROUTINE bdytide_init |
---|
[911] | 269 | |
---|
[1125] | 270 | |
---|
[11536] | 271 | SUBROUTINE bdy_dta_tides( kt, kit, kt_offset ) |
---|
[4292] | 272 | !!---------------------------------------------------------------------- |
---|
| 273 | !! *** SUBROUTINE bdy_dta_tides *** |
---|
| 274 | !! |
---|
| 275 | !! ** Purpose : - Add tidal forcing to ssh, u2d and v2d OBC data arrays. |
---|
| 276 | !! |
---|
| 277 | !!---------------------------------------------------------------------- |
---|
[6140] | 278 | INTEGER, INTENT(in) :: kt ! Main timestep counter |
---|
| 279 | INTEGER, OPTIONAL, INTENT(in) :: kit ! Barotropic timestep counter (for timesplitting option) |
---|
[11536] | 280 | INTEGER, OPTIONAL, INTENT(in) :: kt_offset ! time offset in units of timesteps. NB. if kit |
---|
[6140] | 281 | ! ! is present then units = subcycle timesteps. |
---|
[11536] | 282 | ! ! kt_offset = 0 => get data at "now" time level |
---|
| 283 | ! ! kt_offset = -1 => get data at "before" time level |
---|
| 284 | ! ! kt_offset = +1 => get data at "after" time level |
---|
[6140] | 285 | ! ! etc. |
---|
| 286 | ! |
---|
| 287 | LOGICAL :: lk_first_btstp ! =.TRUE. if time splitting and first barotropic step |
---|
| 288 | INTEGER :: itide, ib_bdy, ib, igrd ! loop indices |
---|
| 289 | INTEGER :: time_add ! time offset in units of timesteps |
---|
| 290 | INTEGER, DIMENSION(jpbgrd) :: ilen0 |
---|
| 291 | INTEGER, DIMENSION(1:jpbgrd) :: nblen, nblenrim ! short cuts |
---|
| 292 | REAL(wp) :: z_arg, z_sarg, zramp, zoff, z_cost, z_sist |
---|
[4292] | 293 | !!---------------------------------------------------------------------- |
---|
[6140] | 294 | ! |
---|
[4292] | 295 | lk_first_btstp=.TRUE. |
---|
| 296 | IF ( PRESENT(kit).AND.( kit /= 1 ) ) THEN ; lk_first_btstp=.FALSE. ; ENDIF |
---|
| 297 | |
---|
| 298 | time_add = 0 |
---|
[11536] | 299 | IF( PRESENT(kt_offset) ) THEN |
---|
| 300 | time_add = kt_offset |
---|
[4292] | 301 | ENDIF |
---|
| 302 | |
---|
| 303 | ! Absolute time from model initialization: |
---|
| 304 | IF( PRESENT(kit) ) THEN |
---|
[5913] | 305 | z_arg = ( kt + (kit+time_add-1) / REAL(nn_baro,wp) ) * rdt |
---|
[4292] | 306 | ELSE |
---|
| 307 | z_arg = ( kt + time_add ) * rdt |
---|
| 308 | ENDIF |
---|
| 309 | |
---|
| 310 | ! Linear ramp on tidal component at open boundaries |
---|
| 311 | zramp = 1. |
---|
[12184] | 312 | IF (ln_tide_ramp) zramp = MIN(MAX( (z_arg - nit000*rdt)/(rn_tide_ramp_dt*rday),0.),1.) |
---|
[4292] | 313 | |
---|
| 314 | DO ib_bdy = 1,nb_bdy |
---|
[7646] | 315 | ! |
---|
| 316 | IF( nn_dyn2d_dta(ib_bdy) >= 2 ) THEN |
---|
| 317 | ! |
---|
[4292] | 318 | nblen(1:jpbgrd) = idx_bdy(ib_bdy)%nblen(1:jpbgrd) |
---|
| 319 | nblenrim(1:jpbgrd) = idx_bdy(ib_bdy)%nblenrim(1:jpbgrd) |
---|
[7646] | 320 | ! |
---|
| 321 | IF( cn_dyn2d(ib_bdy) == 'frs' ) THEN ; ilen0(:) = nblen (:) |
---|
| 322 | ELSE ; ilen0(:) = nblenrim(:) |
---|
[4292] | 323 | ENDIF |
---|
[7646] | 324 | ! |
---|
[4292] | 325 | ! We refresh nodal factors every day below |
---|
| 326 | ! This should be done somewhere else |
---|
[6140] | 327 | IF ( ( nsec_day == NINT(0.5_wp * rdt) .OR. kt==nit000 ) .AND. lk_first_btstp ) THEN |
---|
[4292] | 328 | ! |
---|
[6140] | 329 | kt_tide = kt - (nsec_day - 0.5_wp * rdt)/rdt |
---|
[4292] | 330 | ! |
---|
| 331 | IF(lwp) THEN |
---|
| 332 | WRITE(numout,*) |
---|
| 333 | WRITE(numout,*) 'bdy_tide_dta : Refresh nodal factors for tidal open bdy data at kt=',kt |
---|
| 334 | WRITE(numout,*) '~~~~~~~~~~~~~~ ' |
---|
| 335 | ENDIF |
---|
| 336 | ! |
---|
| 337 | CALL tide_init_elevation ( idx=idx_bdy(ib_bdy), td=tides(ib_bdy) ) |
---|
| 338 | CALL tide_init_velocities( idx=idx_bdy(ib_bdy), td=tides(ib_bdy) ) |
---|
| 339 | ! |
---|
| 340 | ENDIF |
---|
| 341 | zoff = -kt_tide * rdt ! time offset relative to nodal factor computation time |
---|
| 342 | ! |
---|
[5930] | 343 | ! If time splitting, initialize arrays from slow varying open boundary data: |
---|
| 344 | IF ( PRESENT(kit) ) THEN |
---|
[11536] | 345 | IF ( dta_bdy(ib_bdy)%lneed_ssh ) dta_bdy(ib_bdy)%ssh(1:ilen0(1)) = dta_bdy_s(ib_bdy)%ssh(1:ilen0(1)) |
---|
| 346 | IF ( dta_bdy(ib_bdy)%lneed_dyn2d ) dta_bdy(ib_bdy)%u2d(1:ilen0(2)) = dta_bdy_s(ib_bdy)%u2d(1:ilen0(2)) |
---|
| 347 | IF ( dta_bdy(ib_bdy)%lneed_dyn2d ) dta_bdy(ib_bdy)%v2d(1:ilen0(3)) = dta_bdy_s(ib_bdy)%v2d(1:ilen0(3)) |
---|
[4292] | 348 | ENDIF |
---|
| 349 | ! |
---|
| 350 | ! Update open boundary data arrays: |
---|
| 351 | DO itide = 1, nb_harmo |
---|
| 352 | ! |
---|
[12184] | 353 | z_sarg = (z_arg + zoff) * tide_harmonics(itide)%omega |
---|
[4292] | 354 | z_cost = zramp * COS( z_sarg ) |
---|
| 355 | z_sist = zramp * SIN( z_sarg ) |
---|
| 356 | ! |
---|
[11536] | 357 | IF ( dta_bdy(ib_bdy)%lneed_ssh ) THEN |
---|
[4758] | 358 | igrd=1 ! SSH on tracer grid |
---|
| 359 | DO ib = 1, ilen0(igrd) |
---|
| 360 | dta_bdy(ib_bdy)%ssh(ib) = dta_bdy(ib_bdy)%ssh(ib) + & |
---|
| 361 | & ( tides(ib_bdy)%ssh(ib,itide,1)*z_cost + & |
---|
| 362 | & tides(ib_bdy)%ssh(ib,itide,2)*z_sist ) |
---|
| 363 | END DO |
---|
| 364 | ENDIF |
---|
[4292] | 365 | ! |
---|
[11536] | 366 | IF ( dta_bdy(ib_bdy)%lneed_dyn2d ) THEN |
---|
[4758] | 367 | igrd=2 ! U grid |
---|
| 368 | DO ib = 1, ilen0(igrd) |
---|
| 369 | dta_bdy(ib_bdy)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) + & |
---|
| 370 | & ( tides(ib_bdy)%u(ib,itide,1)*z_cost + & |
---|
| 371 | & tides(ib_bdy)%u(ib,itide,2)*z_sist ) |
---|
| 372 | END DO |
---|
| 373 | igrd=3 ! V grid |
---|
| 374 | DO ib = 1, ilen0(igrd) |
---|
| 375 | dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) + & |
---|
| 376 | & ( tides(ib_bdy)%v(ib,itide,1)*z_cost + & |
---|
| 377 | & tides(ib_bdy)%v(ib,itide,2)*z_sist ) |
---|
| 378 | END DO |
---|
| 379 | ENDIF |
---|
| 380 | END DO |
---|
[4292] | 381 | END IF |
---|
| 382 | END DO |
---|
| 383 | ! |
---|
| 384 | END SUBROUTINE bdy_dta_tides |
---|
| 385 | |
---|
[6140] | 386 | |
---|
[3651] | 387 | SUBROUTINE tide_init_elevation( idx, td ) |
---|
[1125] | 388 | !!---------------------------------------------------------------------- |
---|
[3651] | 389 | !! *** ROUTINE tide_init_elevation *** |
---|
[1125] | 390 | !!---------------------------------------------------------------------- |
---|
[6140] | 391 | TYPE(OBC_INDEX) , INTENT(in ) :: idx ! OBC indices |
---|
| 392 | TYPE(TIDES_DATA), INTENT(inout) :: td ! tidal harmonics data |
---|
| 393 | ! |
---|
| 394 | INTEGER :: itide, igrd, ib ! dummy loop indices |
---|
| 395 | INTEGER, DIMENSION(1) :: ilen0 ! length of boundary data (from OBC arrays) |
---|
[3651] | 396 | REAL(wp),ALLOCATABLE, DIMENSION(:) :: mod_tide, phi_tide |
---|
[6140] | 397 | !!---------------------------------------------------------------------- |
---|
| 398 | ! |
---|
[3651] | 399 | igrd=1 |
---|
| 400 | ! SSH on tracer grid. |
---|
| 401 | ilen0(1) = SIZE(td%ssh0(:,1,1)) |
---|
[6140] | 402 | ! |
---|
| 403 | ALLOCATE( mod_tide(ilen0(igrd)), phi_tide(ilen0(igrd)) ) |
---|
| 404 | ! |
---|
[3651] | 405 | DO itide = 1, nb_harmo |
---|
| 406 | DO ib = 1, ilen0(igrd) |
---|
| 407 | mod_tide(ib)=SQRT(td%ssh0(ib,itide,1)**2.+td%ssh0(ib,itide,2)**2.) |
---|
| 408 | phi_tide(ib)=ATAN2(-td%ssh0(ib,itide,2),td%ssh0(ib,itide,1)) |
---|
[1125] | 409 | END DO |
---|
[3651] | 410 | DO ib = 1 , ilen0(igrd) |
---|
[12184] | 411 | mod_tide(ib)=mod_tide(ib)*tide_harmonics(itide)%f |
---|
| 412 | phi_tide(ib)=phi_tide(ib)+tide_harmonics(itide)%v0+tide_harmonics(itide)%u |
---|
[3651] | 413 | ENDDO |
---|
| 414 | DO ib = 1 , ilen0(igrd) |
---|
| 415 | td%ssh(ib,itide,1)= mod_tide(ib)*COS(phi_tide(ib)) |
---|
| 416 | td%ssh(ib,itide,2)=-mod_tide(ib)*SIN(phi_tide(ib)) |
---|
| 417 | ENDDO |
---|
| 418 | END DO |
---|
[6140] | 419 | ! |
---|
| 420 | DEALLOCATE( mod_tide, phi_tide ) |
---|
| 421 | ! |
---|
| 422 | END SUBROUTINE tide_init_elevation |
---|
[911] | 423 | |
---|
| 424 | |
---|
[3651] | 425 | SUBROUTINE tide_init_velocities( idx, td ) |
---|
[1125] | 426 | !!---------------------------------------------------------------------- |
---|
[3651] | 427 | !! *** ROUTINE tide_init_elevation *** |
---|
[1125] | 428 | !!---------------------------------------------------------------------- |
---|
[6140] | 429 | TYPE(OBC_INDEX) , INTENT(in ) :: idx ! OBC indices |
---|
| 430 | TYPE(TIDES_DATA), INTENT(inout) :: td ! tidal harmonics data |
---|
| 431 | ! |
---|
| 432 | INTEGER :: itide, igrd, ib ! dummy loop indices |
---|
| 433 | INTEGER, DIMENSION(3) :: ilen0 ! length of boundary data (from OBC arrays) |
---|
[3651] | 434 | REAL(wp),ALLOCATABLE, DIMENSION(:) :: mod_tide, phi_tide |
---|
[6140] | 435 | !!---------------------------------------------------------------------- |
---|
| 436 | ! |
---|
[3651] | 437 | ilen0(2) = SIZE(td%u0(:,1,1)) |
---|
| 438 | ilen0(3) = SIZE(td%v0(:,1,1)) |
---|
[6140] | 439 | ! |
---|
[3651] | 440 | igrd=2 ! U grid. |
---|
[6140] | 441 | ! |
---|
| 442 | ALLOCATE( mod_tide(ilen0(igrd)) , phi_tide(ilen0(igrd)) ) |
---|
| 443 | ! |
---|
[3651] | 444 | DO itide = 1, nb_harmo |
---|
| 445 | DO ib = 1, ilen0(igrd) |
---|
| 446 | mod_tide(ib)=SQRT(td%u0(ib,itide,1)**2.+td%u0(ib,itide,2)**2.) |
---|
| 447 | phi_tide(ib)=ATAN2(-td%u0(ib,itide,2),td%u0(ib,itide,1)) |
---|
| 448 | END DO |
---|
| 449 | DO ib = 1, ilen0(igrd) |
---|
[12184] | 450 | mod_tide(ib)=mod_tide(ib)*tide_harmonics(itide)%f |
---|
| 451 | phi_tide(ib)=phi_tide(ib)+tide_harmonics(itide)%v0 + tide_harmonics(itide)%u |
---|
[3651] | 452 | ENDDO |
---|
| 453 | DO ib = 1, ilen0(igrd) |
---|
| 454 | td%u(ib,itide,1)= mod_tide(ib)*COS(phi_tide(ib)) |
---|
| 455 | td%u(ib,itide,2)=-mod_tide(ib)*SIN(phi_tide(ib)) |
---|
| 456 | ENDDO |
---|
| 457 | END DO |
---|
[6140] | 458 | ! |
---|
| 459 | DEALLOCATE( mod_tide , phi_tide ) |
---|
| 460 | ! |
---|
[3651] | 461 | igrd=3 ! V grid. |
---|
[6140] | 462 | ! |
---|
| 463 | ALLOCATE( mod_tide(ilen0(igrd)) , phi_tide(ilen0(igrd)) ) |
---|
[911] | 464 | |
---|
[3651] | 465 | DO itide = 1, nb_harmo |
---|
| 466 | DO ib = 1, ilen0(igrd) |
---|
| 467 | mod_tide(ib)=SQRT(td%v0(ib,itide,1)**2.+td%v0(ib,itide,2)**2.) |
---|
| 468 | phi_tide(ib)=ATAN2(-td%v0(ib,itide,2),td%v0(ib,itide,1)) |
---|
| 469 | END DO |
---|
| 470 | DO ib = 1, ilen0(igrd) |
---|
[12184] | 471 | mod_tide(ib)=mod_tide(ib)*tide_harmonics(itide)%f |
---|
| 472 | phi_tide(ib)=phi_tide(ib)+tide_harmonics(itide)%v0 + tide_harmonics(itide)%u |
---|
[3651] | 473 | ENDDO |
---|
| 474 | DO ib = 1, ilen0(igrd) |
---|
| 475 | td%v(ib,itide,1)= mod_tide(ib)*COS(phi_tide(ib)) |
---|
| 476 | td%v(ib,itide,2)=-mod_tide(ib)*SIN(phi_tide(ib)) |
---|
| 477 | ENDDO |
---|
| 478 | END DO |
---|
[6140] | 479 | ! |
---|
| 480 | DEALLOCATE( mod_tide, phi_tide ) |
---|
| 481 | ! |
---|
| 482 | END SUBROUTINE tide_init_velocities |
---|
[1125] | 483 | |
---|
| 484 | !!====================================================================== |
---|
[911] | 485 | END MODULE bdytides |
---|
[4292] | 486 | |
---|