[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 |
---|
| 20 | USE tideini ! |
---|
| 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 |
---|
| 32 | PUBLIC bdytide_update ! routine called in bdy_dta |
---|
[4292] | 33 | PUBLIC bdy_dta_tides ! routine called in dyn_spg_ts |
---|
[911] | 34 | |
---|
[3294] | 35 | TYPE, PUBLIC :: TIDES_DATA !: Storage for external tidal harmonics data |
---|
[6140] | 36 | REAL(wp), POINTER, DIMENSION(:,:,:) :: ssh0 !: Tidal constituents : SSH0 (read in file) |
---|
| 37 | REAL(wp), POINTER, DIMENSION(:,:,:) :: u0, v0 !: Tidal constituents : U0, V0 (read in file) |
---|
| 38 | REAL(wp), POINTER, DIMENSION(:,:,:) :: ssh !: Tidal constituents : SSH (after nodal cor.) |
---|
| 39 | REAL(wp), POINTER, DIMENSION(:,:,:) :: u , v !: Tidal constituents : U , V (after nodal cor.) |
---|
[3294] | 40 | END TYPE TIDES_DATA |
---|
[911] | 41 | |
---|
[4354] | 42 | !$AGRIF_DO_NOT_TREAT |
---|
[3651] | 43 | TYPE(TIDES_DATA), PUBLIC, DIMENSION(jp_bdy), TARGET :: tides !: External tidal harmonics data |
---|
[4354] | 44 | !$AGRIF_END_DO_NOT_TREAT |
---|
[5930] | 45 | TYPE(OBC_DATA) , PUBLIC, DIMENSION(jp_bdy) :: dta_bdy_s !: bdy external data (slow component) |
---|
[911] | 46 | |
---|
[1125] | 47 | !!---------------------------------------------------------------------- |
---|
[9598] | 48 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[6140] | 49 | !! $Id$ |
---|
[10068] | 50 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[1125] | 51 | !!---------------------------------------------------------------------- |
---|
[911] | 52 | CONTAINS |
---|
| 53 | |
---|
[3651] | 54 | SUBROUTINE bdytide_init |
---|
[1125] | 55 | !!---------------------------------------------------------------------- |
---|
[3651] | 56 | !! *** SUBROUTINE bdytide_init *** |
---|
[1125] | 57 | !! |
---|
[3294] | 58 | !! ** Purpose : - Read in namelist for tides and initialise external |
---|
| 59 | !! tidal harmonics data |
---|
[911] | 60 | !! |
---|
| 61 | !!---------------------------------------------------------------------- |
---|
[3294] | 62 | !! namelist variables |
---|
| 63 | !!------------------- |
---|
[3651] | 64 | CHARACTER(len=80) :: filtide !: Filename root for tidal input files |
---|
| 65 | LOGICAL :: ln_bdytide_2ddta !: If true, read 2d harmonic data |
---|
| 66 | LOGICAL :: ln_bdytide_conj !: If true, assume complex conjugate tidal 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 |
---|
[3651] | 73 | CHARACTER(len=80) :: clfile !: full file name for tidal input file |
---|
| 74 | REAL(wp),ALLOCATABLE, DIMENSION(:,:,:) :: dta_read !: work space to read in tidal harmonics data |
---|
[9125] | 75 | REAL(wp),ALLOCATABLE, DIMENSION(:,:) :: ztr, zti !: " " " " " " " " |
---|
[3294] | 76 | !! |
---|
[3651] | 77 | TYPE(TIDES_DATA), POINTER :: td !: local short cut |
---|
[3294] | 78 | !! |
---|
[3651] | 79 | NAMELIST/nambdy_tide/filtide, ln_bdytide_2ddta, ln_bdytide_conj |
---|
[1125] | 80 | !!---------------------------------------------------------------------- |
---|
[6140] | 81 | ! |
---|
[11536] | 82 | IF(lwp) WRITE(numout,*) |
---|
| 83 | IF(lwp) WRITE(numout,*) 'bdytide_init : initialization of tidal harmonic forcing at open boundaries' |
---|
| 84 | IF(lwp) WRITE(numout,*) '~~~~~~~~~~~~' |
---|
[911] | 85 | |
---|
[4147] | 86 | REWIND(numnam_cfg) |
---|
[3651] | 87 | |
---|
[3294] | 88 | DO ib_bdy = 1, nb_bdy |
---|
[7646] | 89 | IF( nn_dyn2d_dta(ib_bdy) >= 2 ) THEN |
---|
| 90 | ! |
---|
[3294] | 91 | td => tides(ib_bdy) |
---|
[911] | 92 | |
---|
[3294] | 93 | ! Namelist nambdy_tide : tidal harmonic forcing at open boundaries |
---|
| 94 | filtide(:) = '' |
---|
[911] | 95 | |
---|
[11536] | 96 | REWIND( numnam_ref ) |
---|
| 97 | READ ( numnam_ref, nambdy_tide, IOSTAT = ios, ERR = 901) |
---|
| 98 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'nambdy_tide in reference namelist' ) |
---|
[4147] | 99 | ! Don't REWIND here - may need to read more than one of these namelists. |
---|
| 100 | READ ( numnam_cfg, nambdy_tide, IOSTAT = ios, ERR = 902 ) |
---|
[11536] | 101 | 902 IF( ios > 0 ) CALL ctl_nam ( ios , 'nambdy_tide in configuration namelist' ) |
---|
[4624] | 102 | IF(lwm) WRITE ( numond, nambdy_tide ) |
---|
[3651] | 103 | ! ! Parameter control and print |
---|
| 104 | IF(lwp) WRITE(numout,*) ' ' |
---|
| 105 | IF(lwp) WRITE(numout,*) ' Namelist nambdy_tide : tidal harmonic forcing at open boundaries' |
---|
| 106 | IF(lwp) WRITE(numout,*) ' read tidal data in 2d files: ', ln_bdytide_2ddta |
---|
| 107 | IF(lwp) WRITE(numout,*) ' assume complex conjugate : ', ln_bdytide_conj |
---|
| 108 | IF(lwp) WRITE(numout,*) ' Number of tidal components to read: ', nb_harmo |
---|
| 109 | IF(lwp) THEN |
---|
[5084] | 110 | WRITE(numout,*) ' Tidal components: ' |
---|
[3651] | 111 | DO itide = 1, nb_harmo |
---|
[5084] | 112 | WRITE(numout,*) ' ', Wave(ntide(itide))%cname_tide |
---|
[3651] | 113 | END DO |
---|
| 114 | ENDIF |
---|
| 115 | IF(lwp) WRITE(numout,*) ' ' |
---|
[1125] | 116 | |
---|
[3651] | 117 | ! Allocate space for tidal harmonics data - get size from OBC data arrays |
---|
| 118 | ! ----------------------------------------------------------------------- |
---|
[911] | 119 | |
---|
[3651] | 120 | ! JC: If FRS scheme is used, we assume that tidal is needed over the whole |
---|
| 121 | ! relaxation area |
---|
[11536] | 122 | IF( cn_dyn2d(ib_bdy) == 'frs' ) THEN ; ilen0(:) = idx_bdy(ib_bdy)%nblen (:) |
---|
| 123 | ELSE ; ilen0(:) = idx_bdy(ib_bdy)%nblenrim(:) |
---|
[3294] | 124 | ENDIF |
---|
[911] | 125 | |
---|
[3651] | 126 | ALLOCATE( td%ssh0( ilen0(1), nb_harmo, 2 ) ) |
---|
| 127 | ALLOCATE( td%ssh ( ilen0(1), nb_harmo, 2 ) ) |
---|
[911] | 128 | |
---|
[3651] | 129 | ALLOCATE( td%u0( ilen0(2), nb_harmo, 2 ) ) |
---|
| 130 | ALLOCATE( td%u ( ilen0(2), nb_harmo, 2 ) ) |
---|
[911] | 131 | |
---|
[3651] | 132 | ALLOCATE( td%v0( ilen0(3), nb_harmo, 2 ) ) |
---|
| 133 | ALLOCATE( td%v ( ilen0(3), nb_harmo, 2 ) ) |
---|
[911] | 134 | |
---|
[4292] | 135 | td%ssh0(:,:,:) = 0._wp |
---|
| 136 | td%ssh (:,:,:) = 0._wp |
---|
| 137 | td%u0 (:,:,:) = 0._wp |
---|
| 138 | td%u (:,:,:) = 0._wp |
---|
| 139 | td%v0 (:,:,:) = 0._wp |
---|
| 140 | td%v (:,:,:) = 0._wp |
---|
[3294] | 141 | |
---|
[7646] | 142 | IF( ln_bdytide_2ddta ) THEN |
---|
[3651] | 143 | ! It is assumed that each data file contains all complex harmonic amplitudes |
---|
[7646] | 144 | ! given on the global domain (ie global, jpiglo x jpjglo) |
---|
[3651] | 145 | ! |
---|
[9125] | 146 | ALLOCATE( zti(jpi,jpj), ztr(jpi,jpj) ) |
---|
[3651] | 147 | ! |
---|
| 148 | ! SSH fields |
---|
| 149 | clfile = TRIM(filtide)//'_grid_T.nc' |
---|
[7646] | 150 | CALL iom_open( clfile , inum ) |
---|
[3651] | 151 | igrd = 1 ! Everything is at T-points here |
---|
| 152 | DO itide = 1, nb_harmo |
---|
[7646] | 153 | CALL iom_get( inum, jpdom_autoglo, TRIM(Wave(ntide(itide))%cname_tide)//'_z1', ztr(:,:) ) |
---|
| 154 | CALL iom_get( inum, jpdom_autoglo, TRIM(Wave(ntide(itide))%cname_tide)//'_z2', zti(:,:) ) |
---|
[3651] | 155 | DO ib = 1, ilen0(igrd) |
---|
| 156 | ii = idx_bdy(ib_bdy)%nbi(ib,igrd) |
---|
| 157 | ij = idx_bdy(ib_bdy)%nbj(ib,igrd) |
---|
[11536] | 158 | IF( ii == 1 .OR. ii == jpi .OR. ij == 1 .OR. ij == jpj ) CYCLE ! to remove? |
---|
[3651] | 159 | td%ssh0(ib,itide,1) = ztr(ii,ij) |
---|
| 160 | td%ssh0(ib,itide,2) = zti(ii,ij) |
---|
| 161 | END DO |
---|
| 162 | END DO |
---|
[3294] | 163 | CALL iom_close( inum ) |
---|
[3651] | 164 | ! |
---|
| 165 | ! U fields |
---|
| 166 | clfile = TRIM(filtide)//'_grid_U.nc' |
---|
[7646] | 167 | CALL iom_open( clfile , inum ) |
---|
[3651] | 168 | igrd = 2 ! Everything is at U-points here |
---|
| 169 | DO itide = 1, nb_harmo |
---|
[7646] | 170 | CALL iom_get ( inum, jpdom_autoglo, TRIM(Wave(ntide(itide))%cname_tide)//'_u1', ztr(:,:) ) |
---|
| 171 | CALL iom_get ( inum, jpdom_autoglo, TRIM(Wave(ntide(itide))%cname_tide)//'_u2', zti(:,:) ) |
---|
[3651] | 172 | DO ib = 1, ilen0(igrd) |
---|
| 173 | ii = idx_bdy(ib_bdy)%nbi(ib,igrd) |
---|
| 174 | ij = idx_bdy(ib_bdy)%nbj(ib,igrd) |
---|
[11536] | 175 | IF( ii == 1 .OR. ii == jpi .OR. ij == 1 .OR. ij == jpj ) CYCLE ! to remove? |
---|
[3651] | 176 | td%u0(ib,itide,1) = ztr(ii,ij) |
---|
| 177 | td%u0(ib,itide,2) = zti(ii,ij) |
---|
| 178 | END DO |
---|
| 179 | END DO |
---|
[3294] | 180 | CALL iom_close( inum ) |
---|
[3651] | 181 | ! |
---|
| 182 | ! V fields |
---|
| 183 | clfile = TRIM(filtide)//'_grid_V.nc' |
---|
[7646] | 184 | CALL iom_open( clfile , inum ) |
---|
[3651] | 185 | igrd = 3 ! Everything is at V-points here |
---|
| 186 | DO itide = 1, nb_harmo |
---|
[7646] | 187 | CALL iom_get ( inum, jpdom_autoglo, TRIM(Wave(ntide(itide))%cname_tide)//'_v1', ztr(:,:) ) |
---|
| 188 | CALL iom_get ( inum, jpdom_autoglo, TRIM(Wave(ntide(itide))%cname_tide)//'_v2', zti(:,:) ) |
---|
[3651] | 189 | DO ib = 1, ilen0(igrd) |
---|
| 190 | ii = idx_bdy(ib_bdy)%nbi(ib,igrd) |
---|
| 191 | ij = idx_bdy(ib_bdy)%nbj(ib,igrd) |
---|
[11536] | 192 | IF( ii == 1 .OR. ii == jpi .OR. ij == 1 .OR. ij == jpj ) CYCLE ! to remove? |
---|
[3651] | 193 | td%v0(ib,itide,1) = ztr(ii,ij) |
---|
| 194 | td%v0(ib,itide,2) = zti(ii,ij) |
---|
| 195 | END DO |
---|
| 196 | END DO |
---|
[3294] | 197 | CALL iom_close( inum ) |
---|
| 198 | ! |
---|
[9125] | 199 | DEALLOCATE( ztr, zti ) |
---|
[3651] | 200 | ! |
---|
| 201 | ELSE |
---|
| 202 | ! |
---|
| 203 | ! Read tidal data only on bdy segments |
---|
| 204 | ! |
---|
| 205 | ALLOCATE( dta_read( MAXVAL(ilen0(1:3)), 1, 1 ) ) |
---|
[5132] | 206 | ! |
---|
[3651] | 207 | ! Open files and read in tidal forcing data |
---|
| 208 | ! ----------------------------------------- |
---|
[3294] | 209 | |
---|
[3651] | 210 | DO itide = 1, nb_harmo |
---|
| 211 | ! ! SSH fields |
---|
| 212 | clfile = TRIM(filtide)//TRIM(Wave(ntide(itide))%cname_tide)//'_grid_T.nc' |
---|
| 213 | CALL iom_open( clfile, inum ) |
---|
[11536] | 214 | CALL fld_map( inum, 'z1' , dta_read(1:ilen0(1),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,1) ) |
---|
[3651] | 215 | td%ssh0(:,itide,1) = dta_read(1:ilen0(1),1,1) |
---|
[11536] | 216 | CALL fld_map( inum, 'z2' , dta_read(1:ilen0(1),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,1) ) |
---|
[3651] | 217 | td%ssh0(:,itide,2) = dta_read(1:ilen0(1),1,1) |
---|
| 218 | CALL iom_close( inum ) |
---|
| 219 | ! ! U fields |
---|
| 220 | clfile = TRIM(filtide)//TRIM(Wave(ntide(itide))%cname_tide)//'_grid_U.nc' |
---|
| 221 | CALL iom_open( clfile, inum ) |
---|
[11536] | 222 | CALL fld_map( inum, 'u1' , dta_read(1:ilen0(2),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,2) ) |
---|
[3651] | 223 | td%u0(:,itide,1) = dta_read(1:ilen0(2),1,1) |
---|
[11536] | 224 | CALL fld_map( inum, 'u2' , dta_read(1:ilen0(2),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,2) ) |
---|
[3651] | 225 | td%u0(:,itide,2) = dta_read(1:ilen0(2),1,1) |
---|
| 226 | CALL iom_close( inum ) |
---|
| 227 | ! ! V fields |
---|
| 228 | clfile = TRIM(filtide)//TRIM(Wave(ntide(itide))%cname_tide)//'_grid_V.nc' |
---|
| 229 | CALL iom_open( clfile, inum ) |
---|
[11536] | 230 | CALL fld_map( inum, 'v1' , dta_read(1:ilen0(3),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,3) ) |
---|
[3651] | 231 | td%v0(:,itide,1) = dta_read(1:ilen0(3),1,1) |
---|
[11536] | 232 | CALL fld_map( inum, 'v2' , dta_read(1:ilen0(3),1:1,1:1) , 1, idx_bdy(ib_bdy)%nbmap(:,3) ) |
---|
[3651] | 233 | td%v0(:,itide,2) = dta_read(1:ilen0(3),1,1) |
---|
| 234 | CALL iom_close( inum ) |
---|
[3294] | 235 | ! |
---|
[3651] | 236 | END DO ! end loop on tidal components |
---|
[3294] | 237 | ! |
---|
[3651] | 238 | DEALLOCATE( dta_read ) |
---|
[7646] | 239 | ! |
---|
[3651] | 240 | ENDIF ! ln_bdytide_2ddta=.true. |
---|
[1125] | 241 | ! |
---|
[6140] | 242 | IF( ln_bdytide_conj ) THEN ! assume complex conjugate in data files |
---|
[3651] | 243 | td%ssh0(:,:,2) = - td%ssh0(:,:,2) |
---|
| 244 | td%u0 (:,:,2) = - td%u0 (:,:,2) |
---|
| 245 | td%v0 (:,:,2) = - td%v0 (:,:,2) |
---|
| 246 | ENDIF |
---|
| 247 | ! |
---|
[5930] | 248 | ! Allocate slow varying data in the case of time splitting: |
---|
| 249 | ! Do it anyway because at this stage knowledge of free surface scheme is unknown |
---|
| 250 | ALLOCATE( dta_bdy_s(ib_bdy)%ssh ( ilen0(1) ) ) |
---|
| 251 | ALLOCATE( dta_bdy_s(ib_bdy)%u2d ( ilen0(2) ) ) |
---|
| 252 | ALLOCATE( dta_bdy_s(ib_bdy)%v2d ( ilen0(3) ) ) |
---|
[6140] | 253 | dta_bdy_s(ib_bdy)%ssh(:) = 0._wp |
---|
| 254 | dta_bdy_s(ib_bdy)%u2d(:) = 0._wp |
---|
| 255 | dta_bdy_s(ib_bdy)%v2d(:) = 0._wp |
---|
[4292] | 256 | ! |
---|
[7646] | 257 | ENDIF ! nn_dyn2d_dta(ib_bdy) >= 2 |
---|
[1125] | 258 | ! |
---|
[3294] | 259 | END DO ! loop on ib_bdy |
---|
[6140] | 260 | ! |
---|
| 261 | END SUBROUTINE bdytide_init |
---|
[911] | 262 | |
---|
[1125] | 263 | |
---|
[12127] | 264 | SUBROUTINE bdytide_update( kt, idx, dta, td, kit, pt_offset ) |
---|
[1125] | 265 | !!---------------------------------------------------------------------- |
---|
[3651] | 266 | !! *** SUBROUTINE bdytide_update *** |
---|
[1125] | 267 | !! |
---|
[3294] | 268 | !! ** Purpose : - Add tidal forcing to ssh, u2d and v2d OBC data arrays. |
---|
[911] | 269 | !! |
---|
[1125] | 270 | !!---------------------------------------------------------------------- |
---|
[6140] | 271 | INTEGER , INTENT(in ) :: kt ! Main timestep counter |
---|
| 272 | TYPE(OBC_INDEX) , INTENT(in ) :: idx ! OBC indices |
---|
| 273 | TYPE(OBC_DATA) , INTENT(inout) :: dta ! OBC external data |
---|
| 274 | TYPE(TIDES_DATA) , INTENT(inout) :: td ! tidal harmonics data |
---|
[11536] | 275 | INTEGER, OPTIONAL, INTENT(in ) :: kit ! Barotropic timestep counter (for timesplitting option) |
---|
[12127] | 276 | REAL(wp), OPTIONAL,INTENT(in ) :: pt_offset ! time offset in units of timesteps. NB. if kit |
---|
[6140] | 277 | ! ! is present then units = subcycle timesteps. |
---|
| 278 | ! |
---|
| 279 | INTEGER :: itide, igrd, ib ! dummy loop indices |
---|
| 280 | INTEGER, DIMENSION(3) :: ilen0 ! length of boundary data (from OBC arrays) |
---|
[12127] | 281 | REAL(wp) :: z_arg, z_sarg, zflag, zramp, zt_offset ! local scalars |
---|
[3651] | 282 | REAL(wp), DIMENSION(jpmax_harmo) :: z_sist, z_cost |
---|
[1125] | 283 | !!---------------------------------------------------------------------- |
---|
[6140] | 284 | ! |
---|
[3651] | 285 | ilen0(1) = SIZE(td%ssh(:,1,1)) |
---|
| 286 | ilen0(2) = SIZE(td%u(:,1,1)) |
---|
| 287 | ilen0(3) = SIZE(td%v(:,1,1)) |
---|
| 288 | |
---|
| 289 | zflag=1 |
---|
[11536] | 290 | IF ( PRESENT(kit) ) THEN |
---|
| 291 | IF ( kit /= 1 ) zflag=0 |
---|
[3651] | 292 | ENDIF |
---|
| 293 | |
---|
[6140] | 294 | IF ( (nsec_day == NINT(0.5_wp * rdt) .OR. kt==nit000) .AND. zflag==1 ) THEN |
---|
[3651] | 295 | ! |
---|
[12127] | 296 | kt_tide = kt - NINT((REAL(nsec_day,wp) - 0.5_wp * rdt)/rdt) |
---|
[3651] | 297 | ! |
---|
| 298 | IF(lwp) THEN |
---|
| 299 | WRITE(numout,*) |
---|
| 300 | WRITE(numout,*) 'bdytide_update : (re)Initialization of the tidal bdy forcing at kt=',kt |
---|
| 301 | WRITE(numout,*) '~~~~~~~~~~~~~~ ' |
---|
| 302 | ENDIF |
---|
| 303 | ! |
---|
| 304 | CALL tide_init_elevation ( idx, td ) |
---|
| 305 | CALL tide_init_velocities( idx, td ) |
---|
| 306 | ! |
---|
| 307 | ENDIF |
---|
| 308 | |
---|
[12127] | 309 | zt_offset = 0._wp |
---|
| 310 | IF( PRESENT(pt_offset) ) zt_offset = pt_offset |
---|
[3294] | 311 | |
---|
[11536] | 312 | IF( PRESENT(kit) ) THEN |
---|
[12127] | 313 | z_arg = REAL( kt - kt_tide, wp) * rdt + ( REAL(kit, wp) + 0.5_wp * ( zt_offset - 1._wp ) ) * rdt / REAL(nn_baro, wp) |
---|
[3294] | 314 | ELSE |
---|
[12127] | 315 | z_arg = ( REAL( kt - kt_tide, wp) + zt_offset ) * rdt |
---|
[1125] | 316 | ENDIF |
---|
[911] | 317 | |
---|
[3651] | 318 | ! Linear ramp on tidal component at open boundaries |
---|
[4292] | 319 | zramp = 1._wp |
---|
[12127] | 320 | IF (ln_tide_ramp) zramp = MIN(MAX( (z_arg + REAL(kt_tide-nit000,wp)*rdt)/(rdttideramp*rday),0._wp),1._wp) |
---|
[3651] | 321 | |
---|
| 322 | DO itide = 1, nb_harmo |
---|
| 323 | z_sarg = z_arg * omega_tide(itide) |
---|
[1125] | 324 | z_cost(itide) = COS( z_sarg ) |
---|
| 325 | z_sist(itide) = SIN( z_sarg ) |
---|
| 326 | END DO |
---|
[911] | 327 | |
---|
[3651] | 328 | DO itide = 1, nb_harmo |
---|
| 329 | igrd=1 ! SSH on tracer grid |
---|
| 330 | DO ib = 1, ilen0(igrd) |
---|
| 331 | dta%ssh(ib) = dta%ssh(ib) + zramp*(td%ssh(ib,itide,1)*z_cost(itide) + td%ssh(ib,itide,2)*z_sist(itide)) |
---|
[1125] | 332 | END DO |
---|
[3294] | 333 | igrd=2 ! U grid |
---|
[3651] | 334 | DO ib = 1, ilen0(igrd) |
---|
| 335 | dta%u2d(ib) = dta%u2d(ib) + zramp*(td%u (ib,itide,1)*z_cost(itide) + td%u (ib,itide,2)*z_sist(itide)) |
---|
[1125] | 336 | END DO |
---|
[3294] | 337 | igrd=3 ! V grid |
---|
[3651] | 338 | DO ib = 1, ilen0(igrd) |
---|
| 339 | dta%v2d(ib) = dta%v2d(ib) + zramp*(td%v (ib,itide,1)*z_cost(itide) + td%v (ib,itide,2)*z_sist(itide)) |
---|
[1125] | 340 | END DO |
---|
| 341 | END DO |
---|
| 342 | ! |
---|
[3651] | 343 | END SUBROUTINE bdytide_update |
---|
[911] | 344 | |
---|
[7646] | 345 | |
---|
[12127] | 346 | SUBROUTINE bdy_dta_tides( kt, kit, pt_offset ) |
---|
[4292] | 347 | !!---------------------------------------------------------------------- |
---|
| 348 | !! *** SUBROUTINE bdy_dta_tides *** |
---|
| 349 | !! |
---|
| 350 | !! ** Purpose : - Add tidal forcing to ssh, u2d and v2d OBC data arrays. |
---|
| 351 | !! |
---|
| 352 | !!---------------------------------------------------------------------- |
---|
[6140] | 353 | INTEGER, INTENT(in) :: kt ! Main timestep counter |
---|
| 354 | INTEGER, OPTIONAL, INTENT(in) :: kit ! Barotropic timestep counter (for timesplitting option) |
---|
[12127] | 355 | REAL(wp),OPTIONAL, INTENT(in) :: pt_offset ! time offset in units of timesteps. NB. if kit |
---|
[6140] | 356 | ! ! is present then units = subcycle timesteps. |
---|
| 357 | ! |
---|
| 358 | LOGICAL :: lk_first_btstp ! =.TRUE. if time splitting and first barotropic step |
---|
| 359 | INTEGER :: itide, ib_bdy, ib, igrd ! loop indices |
---|
| 360 | INTEGER, DIMENSION(jpbgrd) :: ilen0 |
---|
| 361 | INTEGER, DIMENSION(1:jpbgrd) :: nblen, nblenrim ! short cuts |
---|
[12127] | 362 | REAL(wp) :: z_arg, z_sarg, zramp, zoff, z_cost, z_sist, zt_offset |
---|
[4292] | 363 | !!---------------------------------------------------------------------- |
---|
[6140] | 364 | ! |
---|
[4292] | 365 | lk_first_btstp=.TRUE. |
---|
| 366 | IF ( PRESENT(kit).AND.( kit /= 1 ) ) THEN ; lk_first_btstp=.FALSE. ; ENDIF |
---|
| 367 | |
---|
[12127] | 368 | zt_offset = 0._wp |
---|
| 369 | IF( PRESENT(pt_offset) ) zt_offset = pt_offset |
---|
[4292] | 370 | |
---|
| 371 | ! Absolute time from model initialization: |
---|
| 372 | IF( PRESENT(kit) ) THEN |
---|
[12127] | 373 | z_arg = ( REAL(kt, wp) + ( REAL(kit, wp) + zt_offset - 1. ) / REAL(nn_baro, wp) ) * rdt |
---|
[4292] | 374 | ELSE |
---|
[12127] | 375 | z_arg = ( REAL(kt, wp) + zt_offset ) * rdt |
---|
[4292] | 376 | ENDIF |
---|
| 377 | |
---|
| 378 | ! Linear ramp on tidal component at open boundaries |
---|
| 379 | zramp = 1. |
---|
[12127] | 380 | IF (ln_tide_ramp) zramp = MIN(MAX( (z_arg - REAL(nit000, wp)*rdt)/(rdttideramp*rday),0.),1.) |
---|
[4292] | 381 | |
---|
| 382 | DO ib_bdy = 1,nb_bdy |
---|
[7646] | 383 | ! |
---|
| 384 | IF( nn_dyn2d_dta(ib_bdy) >= 2 ) THEN |
---|
| 385 | ! |
---|
[4292] | 386 | nblen(1:jpbgrd) = idx_bdy(ib_bdy)%nblen(1:jpbgrd) |
---|
| 387 | nblenrim(1:jpbgrd) = idx_bdy(ib_bdy)%nblenrim(1:jpbgrd) |
---|
[7646] | 388 | ! |
---|
| 389 | IF( cn_dyn2d(ib_bdy) == 'frs' ) THEN ; ilen0(:) = nblen (:) |
---|
| 390 | ELSE ; ilen0(:) = nblenrim(:) |
---|
[4292] | 391 | ENDIF |
---|
[7646] | 392 | ! |
---|
[4292] | 393 | ! We refresh nodal factors every day below |
---|
| 394 | ! This should be done somewhere else |
---|
[6140] | 395 | IF ( ( nsec_day == NINT(0.5_wp * rdt) .OR. kt==nit000 ) .AND. lk_first_btstp ) THEN |
---|
[4292] | 396 | ! |
---|
[12127] | 397 | kt_tide = kt - NINT((REAL(nsec_day,wp) - 0.5_wp * rdt)/rdt) |
---|
[4292] | 398 | ! |
---|
| 399 | IF(lwp) THEN |
---|
| 400 | WRITE(numout,*) |
---|
| 401 | WRITE(numout,*) 'bdy_tide_dta : Refresh nodal factors for tidal open bdy data at kt=',kt |
---|
| 402 | WRITE(numout,*) '~~~~~~~~~~~~~~ ' |
---|
| 403 | ENDIF |
---|
| 404 | ! |
---|
| 405 | CALL tide_init_elevation ( idx=idx_bdy(ib_bdy), td=tides(ib_bdy) ) |
---|
| 406 | CALL tide_init_velocities( idx=idx_bdy(ib_bdy), td=tides(ib_bdy) ) |
---|
| 407 | ! |
---|
| 408 | ENDIF |
---|
[12127] | 409 | zoff = REAL(-kt_tide,wp) * rdt ! time offset relative to nodal factor computation time |
---|
[4292] | 410 | ! |
---|
[5930] | 411 | ! If time splitting, initialize arrays from slow varying open boundary data: |
---|
| 412 | IF ( PRESENT(kit) ) THEN |
---|
[11536] | 413 | IF ( dta_bdy(ib_bdy)%lneed_ssh ) dta_bdy(ib_bdy)%ssh(1:ilen0(1)) = dta_bdy_s(ib_bdy)%ssh(1:ilen0(1)) |
---|
| 414 | IF ( dta_bdy(ib_bdy)%lneed_dyn2d ) dta_bdy(ib_bdy)%u2d(1:ilen0(2)) = dta_bdy_s(ib_bdy)%u2d(1:ilen0(2)) |
---|
| 415 | 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] | 416 | ENDIF |
---|
| 417 | ! |
---|
| 418 | ! Update open boundary data arrays: |
---|
| 419 | DO itide = 1, nb_harmo |
---|
| 420 | ! |
---|
| 421 | z_sarg = (z_arg + zoff) * omega_tide(itide) |
---|
| 422 | z_cost = zramp * COS( z_sarg ) |
---|
| 423 | z_sist = zramp * SIN( z_sarg ) |
---|
| 424 | ! |
---|
[11536] | 425 | IF ( dta_bdy(ib_bdy)%lneed_ssh ) THEN |
---|
[4758] | 426 | igrd=1 ! SSH on tracer grid |
---|
| 427 | DO ib = 1, ilen0(igrd) |
---|
| 428 | dta_bdy(ib_bdy)%ssh(ib) = dta_bdy(ib_bdy)%ssh(ib) + & |
---|
| 429 | & ( tides(ib_bdy)%ssh(ib,itide,1)*z_cost + & |
---|
| 430 | & tides(ib_bdy)%ssh(ib,itide,2)*z_sist ) |
---|
| 431 | END DO |
---|
| 432 | ENDIF |
---|
[4292] | 433 | ! |
---|
[11536] | 434 | IF ( dta_bdy(ib_bdy)%lneed_dyn2d ) THEN |
---|
[4758] | 435 | igrd=2 ! U grid |
---|
| 436 | DO ib = 1, ilen0(igrd) |
---|
| 437 | dta_bdy(ib_bdy)%u2d(ib) = dta_bdy(ib_bdy)%u2d(ib) + & |
---|
| 438 | & ( tides(ib_bdy)%u(ib,itide,1)*z_cost + & |
---|
| 439 | & tides(ib_bdy)%u(ib,itide,2)*z_sist ) |
---|
| 440 | END DO |
---|
| 441 | igrd=3 ! V grid |
---|
| 442 | DO ib = 1, ilen0(igrd) |
---|
| 443 | dta_bdy(ib_bdy)%v2d(ib) = dta_bdy(ib_bdy)%v2d(ib) + & |
---|
| 444 | & ( tides(ib_bdy)%v(ib,itide,1)*z_cost + & |
---|
| 445 | & tides(ib_bdy)%v(ib,itide,2)*z_sist ) |
---|
| 446 | END DO |
---|
| 447 | ENDIF |
---|
| 448 | END DO |
---|
[4292] | 449 | END IF |
---|
| 450 | END DO |
---|
| 451 | ! |
---|
| 452 | END SUBROUTINE bdy_dta_tides |
---|
| 453 | |
---|
[6140] | 454 | |
---|
[3651] | 455 | SUBROUTINE tide_init_elevation( idx, td ) |
---|
[1125] | 456 | !!---------------------------------------------------------------------- |
---|
[3651] | 457 | !! *** ROUTINE tide_init_elevation *** |
---|
[1125] | 458 | !!---------------------------------------------------------------------- |
---|
[6140] | 459 | TYPE(OBC_INDEX) , INTENT(in ) :: idx ! OBC indices |
---|
| 460 | TYPE(TIDES_DATA), INTENT(inout) :: td ! tidal harmonics data |
---|
| 461 | ! |
---|
| 462 | INTEGER :: itide, igrd, ib ! dummy loop indices |
---|
| 463 | INTEGER, DIMENSION(1) :: ilen0 ! length of boundary data (from OBC arrays) |
---|
[3651] | 464 | REAL(wp),ALLOCATABLE, DIMENSION(:) :: mod_tide, phi_tide |
---|
[6140] | 465 | !!---------------------------------------------------------------------- |
---|
| 466 | ! |
---|
[3651] | 467 | igrd=1 |
---|
| 468 | ! SSH on tracer grid. |
---|
| 469 | ilen0(1) = SIZE(td%ssh0(:,1,1)) |
---|
[6140] | 470 | ! |
---|
| 471 | ALLOCATE( mod_tide(ilen0(igrd)), phi_tide(ilen0(igrd)) ) |
---|
| 472 | ! |
---|
[3651] | 473 | DO itide = 1, nb_harmo |
---|
| 474 | DO ib = 1, ilen0(igrd) |
---|
| 475 | mod_tide(ib)=SQRT(td%ssh0(ib,itide,1)**2.+td%ssh0(ib,itide,2)**2.) |
---|
| 476 | phi_tide(ib)=ATAN2(-td%ssh0(ib,itide,2),td%ssh0(ib,itide,1)) |
---|
[1125] | 477 | END DO |
---|
[3651] | 478 | DO ib = 1 , ilen0(igrd) |
---|
| 479 | mod_tide(ib)=mod_tide(ib)*ftide(itide) |
---|
| 480 | phi_tide(ib)=phi_tide(ib)+v0tide(itide)+utide(itide) |
---|
| 481 | ENDDO |
---|
| 482 | DO ib = 1 , ilen0(igrd) |
---|
| 483 | td%ssh(ib,itide,1)= mod_tide(ib)*COS(phi_tide(ib)) |
---|
| 484 | td%ssh(ib,itide,2)=-mod_tide(ib)*SIN(phi_tide(ib)) |
---|
| 485 | ENDDO |
---|
| 486 | END DO |
---|
[6140] | 487 | ! |
---|
| 488 | DEALLOCATE( mod_tide, phi_tide ) |
---|
| 489 | ! |
---|
| 490 | END SUBROUTINE tide_init_elevation |
---|
[911] | 491 | |
---|
| 492 | |
---|
[3651] | 493 | SUBROUTINE tide_init_velocities( idx, td ) |
---|
[1125] | 494 | !!---------------------------------------------------------------------- |
---|
[3651] | 495 | !! *** ROUTINE tide_init_elevation *** |
---|
[1125] | 496 | !!---------------------------------------------------------------------- |
---|
[6140] | 497 | TYPE(OBC_INDEX) , INTENT(in ) :: idx ! OBC indices |
---|
| 498 | TYPE(TIDES_DATA), INTENT(inout) :: td ! tidal harmonics data |
---|
| 499 | ! |
---|
| 500 | INTEGER :: itide, igrd, ib ! dummy loop indices |
---|
| 501 | INTEGER, DIMENSION(3) :: ilen0 ! length of boundary data (from OBC arrays) |
---|
[3651] | 502 | REAL(wp),ALLOCATABLE, DIMENSION(:) :: mod_tide, phi_tide |
---|
[6140] | 503 | !!---------------------------------------------------------------------- |
---|
| 504 | ! |
---|
[3651] | 505 | ilen0(2) = SIZE(td%u0(:,1,1)) |
---|
| 506 | ilen0(3) = SIZE(td%v0(:,1,1)) |
---|
[6140] | 507 | ! |
---|
[3651] | 508 | igrd=2 ! U grid. |
---|
[6140] | 509 | ! |
---|
| 510 | ALLOCATE( mod_tide(ilen0(igrd)) , phi_tide(ilen0(igrd)) ) |
---|
| 511 | ! |
---|
[3651] | 512 | DO itide = 1, nb_harmo |
---|
| 513 | DO ib = 1, ilen0(igrd) |
---|
| 514 | mod_tide(ib)=SQRT(td%u0(ib,itide,1)**2.+td%u0(ib,itide,2)**2.) |
---|
| 515 | phi_tide(ib)=ATAN2(-td%u0(ib,itide,2),td%u0(ib,itide,1)) |
---|
| 516 | END DO |
---|
| 517 | DO ib = 1, ilen0(igrd) |
---|
| 518 | mod_tide(ib)=mod_tide(ib)*ftide(itide) |
---|
| 519 | phi_tide(ib)=phi_tide(ib)+v0tide(itide)+utide(itide) |
---|
| 520 | ENDDO |
---|
| 521 | DO ib = 1, ilen0(igrd) |
---|
| 522 | td%u(ib,itide,1)= mod_tide(ib)*COS(phi_tide(ib)) |
---|
| 523 | td%u(ib,itide,2)=-mod_tide(ib)*SIN(phi_tide(ib)) |
---|
| 524 | ENDDO |
---|
| 525 | END DO |
---|
[6140] | 526 | ! |
---|
| 527 | DEALLOCATE( mod_tide , phi_tide ) |
---|
| 528 | ! |
---|
[3651] | 529 | igrd=3 ! V grid. |
---|
[6140] | 530 | ! |
---|
| 531 | ALLOCATE( mod_tide(ilen0(igrd)) , phi_tide(ilen0(igrd)) ) |
---|
[911] | 532 | |
---|
[3651] | 533 | DO itide = 1, nb_harmo |
---|
| 534 | DO ib = 1, ilen0(igrd) |
---|
| 535 | mod_tide(ib)=SQRT(td%v0(ib,itide,1)**2.+td%v0(ib,itide,2)**2.) |
---|
| 536 | phi_tide(ib)=ATAN2(-td%v0(ib,itide,2),td%v0(ib,itide,1)) |
---|
| 537 | END DO |
---|
| 538 | DO ib = 1, ilen0(igrd) |
---|
| 539 | mod_tide(ib)=mod_tide(ib)*ftide(itide) |
---|
| 540 | phi_tide(ib)=phi_tide(ib)+v0tide(itide)+utide(itide) |
---|
| 541 | ENDDO |
---|
| 542 | DO ib = 1, ilen0(igrd) |
---|
| 543 | td%v(ib,itide,1)= mod_tide(ib)*COS(phi_tide(ib)) |
---|
| 544 | td%v(ib,itide,2)=-mod_tide(ib)*SIN(phi_tide(ib)) |
---|
| 545 | ENDDO |
---|
| 546 | END DO |
---|
[6140] | 547 | ! |
---|
| 548 | DEALLOCATE( mod_tide, phi_tide ) |
---|
| 549 | ! |
---|
| 550 | END SUBROUTINE tide_init_velocities |
---|
[1125] | 551 | |
---|
| 552 | !!====================================================================== |
---|
[911] | 553 | END MODULE bdytides |
---|
[4292] | 554 | |
---|