[2952] | 1 | MODULE updtide |
---|
[4292] | 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE updtide *** |
---|
| 4 | !! Initialization of tidal forcing |
---|
| 5 | !!====================================================================== |
---|
| 6 | !! History : 9.0 ! 07 (O. Le Galloudec) Original code |
---|
| 7 | !!---------------------------------------------------------------------- |
---|
[2952] | 8 | #if defined key_tide |
---|
[4292] | 9 | !!---------------------------------------------------------------------- |
---|
| 10 | !! 'key_tide' : tidal potential |
---|
| 11 | !!---------------------------------------------------------------------- |
---|
| 12 | !! upd_tide : update tidal potential |
---|
| 13 | !!---------------------------------------------------------------------- |
---|
| 14 | USE oce ! ocean dynamics and tracers variables |
---|
| 15 | USE dom_oce ! ocean space and time domain |
---|
| 16 | USE in_out_manager ! I/O units |
---|
| 17 | USE phycst ! physical constant |
---|
| 18 | USE sbctide ! tide potential variable |
---|
| 19 | USE tideini, ONLY: ln_tide_ramp, rdttideramp |
---|
[2952] | 20 | |
---|
[4292] | 21 | IMPLICIT NONE |
---|
| 22 | PUBLIC |
---|
[2952] | 23 | |
---|
[4292] | 24 | PUBLIC upd_tide ! called in dynspg_... modules |
---|
| 25 | |
---|
| 26 | !!---------------------------------------------------------------------- |
---|
| 27 | !! NEMO/OPA 3.3 , NEMO Consortium (2010) |
---|
[5215] | 28 | !! $Id$ |
---|
[4292] | 29 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
| 30 | !!---------------------------------------------------------------------- |
---|
[2952] | 31 | CONTAINS |
---|
| 32 | |
---|
[5913] | 33 | SUBROUTINE upd_tide( kt, kit, time_offset ) |
---|
[4292] | 34 | !!---------------------------------------------------------------------- |
---|
| 35 | !! *** ROUTINE upd_tide *** |
---|
| 36 | !! |
---|
| 37 | !! ** Purpose : provide at each time step the astronomical potential |
---|
| 38 | !! |
---|
| 39 | !! ** Method : computed from pulsation and amplitude of all tide components |
---|
| 40 | !! |
---|
| 41 | !! ** Action : pot_astro actronomical potential |
---|
| 42 | !!---------------------------------------------------------------------- |
---|
| 43 | INTEGER, INTENT(in) :: kt ! ocean time-step index |
---|
[5913] | 44 | INTEGER, INTENT(in), OPTIONAL :: kit ! external mode sub-time-step index (lk_dynspg_ts=T) |
---|
| 45 | INTEGER, INTENT(in), OPTIONAL :: time_offset ! time offset in number |
---|
| 46 | ! of internal steps (lk_dynspg_ts=F) |
---|
| 47 | ! of external steps (lk_dynspg_ts=T) |
---|
[4292] | 48 | ! |
---|
| 49 | INTEGER :: joffset ! local integer |
---|
| 50 | INTEGER :: ji, jj, jk ! dummy loop indices |
---|
| 51 | REAL(wp) :: zt, zramp ! local scalar |
---|
| 52 | REAL(wp), DIMENSION(nb_harmo) :: zwt |
---|
| 53 | !!---------------------------------------------------------------------- |
---|
| 54 | ! |
---|
| 55 | ! ! tide pulsation at model time step (or sub-time-step) |
---|
| 56 | zt = ( kt - kt_tide ) * rdt |
---|
| 57 | ! |
---|
| 58 | joffset = 0 |
---|
[5913] | 59 | IF( PRESENT( time_offset ) ) joffset = time_offset |
---|
[4292] | 60 | ! |
---|
[5913] | 61 | IF( PRESENT( kit ) ) THEN |
---|
| 62 | zt = zt + ( kit + joffset - 1 ) * rdt / REAL( nn_baro, wp ) |
---|
[4292] | 63 | ELSE |
---|
| 64 | zt = zt + joffset * rdt |
---|
| 65 | ENDIF |
---|
| 66 | ! |
---|
| 67 | zwt(:) = omega_tide(:) * zt |
---|
[2952] | 68 | |
---|
[4292] | 69 | pot_astro(:,:) = 0._wp ! update tidal potential (sum of all harmonics) |
---|
| 70 | DO jk = 1, nb_harmo |
---|
| 71 | pot_astro(:,:) = pot_astro(:,:) + amp_pot(:,:,jk) * COS( zwt(jk) + phi_pot(:,:,jk) ) |
---|
| 72 | END DO |
---|
| 73 | ! |
---|
| 74 | IF( ln_tide_ramp ) THEN ! linear increase if asked |
---|
| 75 | zt = ( kt - nit000 ) * rdt |
---|
[5913] | 76 | IF( PRESENT( kit ) ) zt = zt + ( kit + joffset -1) * rdt / REAL( nn_baro, wp ) |
---|
[4292] | 77 | zramp = MIN( MAX( zt / (rdttideramp*rday) , 0._wp ) , 1._wp ) |
---|
| 78 | pot_astro(:,:) = zramp * pot_astro(:,:) |
---|
| 79 | ENDIF |
---|
| 80 | ! |
---|
| 81 | END SUBROUTINE upd_tide |
---|
[2952] | 82 | |
---|
| 83 | #else |
---|
| 84 | !!---------------------------------------------------------------------- |
---|
| 85 | !! Dummy module : NO TIDE |
---|
| 86 | !!---------------------------------------------------------------------- |
---|
| 87 | CONTAINS |
---|
[5913] | 88 | SUBROUTINE upd_tide( kt, kit, time_offset ) ! Empty routine |
---|
[4292] | 89 | INTEGER, INTENT(in) :: kt ! integer arg, dummy routine |
---|
| 90 | INTEGER, INTENT(in), OPTIONAL :: kit ! optional arg, dummy routine |
---|
[5913] | 91 | INTEGER, INTENT(in), OPTIONAL :: time_offset ! optional arg, dummy routine |
---|
[2952] | 92 | WRITE(*,*) 'upd_tide: You should not have seen this print! error?', kt |
---|
| 93 | END SUBROUTINE upd_tide |
---|
| 94 | |
---|
| 95 | #endif |
---|
| 96 | |
---|
| 97 | !!====================================================================== |
---|
| 98 | |
---|
| 99 | END MODULE updtide |
---|