[1271] | 1 | #define SPONGE_TOP |
---|
| 2 | |
---|
[5656] | 3 | MODULE agrif_top_sponge |
---|
[6140] | 4 | !!====================================================================== |
---|
| 5 | !! *** MODULE agrif_top_sponge *** |
---|
[9019] | 6 | !! AGRIF : sponge layer pakage for passive tracers (TOP) |
---|
[6140] | 7 | !!====================================================================== |
---|
| 8 | !! History : 2.0 ! 2006-08 (R. Benshila, L. Debreu) Original code |
---|
| 9 | !!---------------------------------------------------------------------- |
---|
[9019] | 10 | #if defined key_agrif && defined key_top |
---|
[6140] | 11 | !!---------------------------------------------------------------------- |
---|
| 12 | !! Agrif_Sponge_trc : |
---|
| 13 | !! interptrn_sponge : |
---|
| 14 | !!---------------------------------------------------------------------- |
---|
[1271] | 15 | USE par_oce |
---|
[5656] | 16 | USE par_trc |
---|
[1271] | 17 | USE oce |
---|
[6140] | 18 | USE trc |
---|
[1271] | 19 | USE dom_oce |
---|
| 20 | USE agrif_oce |
---|
[9570] | 21 | USE agrif_oce_sponge |
---|
[12377] | 22 | USE vremap |
---|
[6140] | 23 | ! |
---|
| 24 | USE in_out_manager |
---|
[2715] | 25 | USE lib_mpp |
---|
[1271] | 26 | |
---|
| 27 | IMPLICIT NONE |
---|
| 28 | PRIVATE |
---|
| 29 | |
---|
[5656] | 30 | PUBLIC Agrif_Sponge_trc, interptrn_sponge |
---|
[1271] | 31 | |
---|
| 32 | !!---------------------------------------------------------------------- |
---|
[9598] | 33 | !! NEMO/NST 4.0 , NEMO Consortium (2018) |
---|
[2528] | 34 | !! $Id$ |
---|
[10068] | 35 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[1271] | 36 | !!---------------------------------------------------------------------- |
---|
[5656] | 37 | CONTAINS |
---|
[1271] | 38 | |
---|
[5656] | 39 | SUBROUTINE Agrif_Sponge_trc |
---|
[6140] | 40 | !!---------------------------------------------------------------------- |
---|
| 41 | !! *** ROUTINE Agrif_Sponge_Trc *** |
---|
| 42 | !!---------------------------------------------------------------------- |
---|
[9019] | 43 | REAL(wp) :: zcoef ! local scalar |
---|
[6140] | 44 | !!---------------------------------------------------------------------- |
---|
| 45 | ! |
---|
[1271] | 46 | #if defined SPONGE_TOP |
---|
[9031] | 47 | !! Assume persistence |
---|
[9056] | 48 | zcoef = REAL(Agrif_rhot()-1,wp)/REAL(Agrif_rhot()) |
---|
[5656] | 49 | CALL Agrif_sponge |
---|
[6140] | 50 | Agrif_SpecialValue = 0._wp |
---|
[1271] | 51 | Agrif_UseSpecialValue = .TRUE. |
---|
[6140] | 52 | tabspongedone_trn = .FALSE. |
---|
[9019] | 53 | CALL Agrif_Bc_Variable( trn_sponge_id, calledweight=zcoef, procname=interptrn_sponge ) |
---|
[1271] | 54 | Agrif_UseSpecialValue = .FALSE. |
---|
| 55 | #endif |
---|
[6140] | 56 | ! |
---|
[1271] | 57 | END SUBROUTINE Agrif_Sponge_Trc |
---|
| 58 | |
---|
[5656] | 59 | |
---|
[6140] | 60 | SUBROUTINE interptrn_sponge( tabres, i1, i2, j1, j2, k1, k2, n1, n2, before ) |
---|
| 61 | !!---------------------------------------------------------------------- |
---|
| 62 | !! *** ROUTINE interptrn_sponge *** |
---|
| 63 | !!---------------------------------------------------------------------- |
---|
| 64 | INTEGER , INTENT(in ) :: i1, i2, j1, j2, k1, k2, n1, n2 |
---|
| 65 | REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,n1:n2), INTENT(inout) :: tabres |
---|
| 66 | LOGICAL , INTENT(in ) :: before |
---|
| 67 | ! |
---|
[5656] | 68 | INTEGER :: ji, jj, jk, jn ! dummy loop indices |
---|
[12377] | 69 | REAL(wp) :: zabe1, zabe2, ztrelax |
---|
| 70 | REAL(wp), DIMENSION(i1:i2,j1:j2) :: ztu, ztv |
---|
| 71 | REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2,1:jptra) :: trbdiff |
---|
[9031] | 72 | ! vertical interpolation: |
---|
[12377] | 73 | REAL(wp), DIMENSION(i1:i2,j1:j2,jpk,1:jptra) ::tabres_child |
---|
| 74 | REAL(wp), DIMENSION(k1:k2,1:jptra) :: tabin |
---|
[9031] | 75 | REAL(wp), DIMENSION(k1:k2) :: h_in |
---|
| 76 | REAL(wp), DIMENSION(1:jpk) :: h_out |
---|
| 77 | INTEGER :: N_in, N_out |
---|
| 78 | REAL(wp) :: h_diff |
---|
[6140] | 79 | !!---------------------------------------------------------------------- |
---|
[3680] | 80 | ! |
---|
[6140] | 81 | IF( before ) THEN |
---|
[9031] | 82 | DO jn = 1, jptra |
---|
| 83 | DO jk=k1,k2 |
---|
| 84 | DO jj=j1,j2 |
---|
| 85 | DO ji=i1,i2 |
---|
[12377] | 86 | tabres(ji,jj,jk,jn) = tr(ji,jj,jk,jn,Kbb_a) |
---|
[9031] | 87 | END DO |
---|
| 88 | END DO |
---|
| 89 | END DO |
---|
| 90 | END DO |
---|
| 91 | |
---|
| 92 | # if defined key_vertical |
---|
| 93 | DO jk=k1,k2 |
---|
| 94 | DO jj=j1,j2 |
---|
| 95 | DO ji=i1,i2 |
---|
[12377] | 96 | tabres(ji,jj,jk,jpts+1) = tmask(ji,jj,jk) * e3t(ji,jj,jk,Kbb_a) |
---|
[9031] | 97 | END DO |
---|
| 98 | END DO |
---|
| 99 | END DO |
---|
| 100 | # endif |
---|
[5656] | 101 | ELSE |
---|
[9031] | 102 | # if defined key_vertical |
---|
| 103 | tabres_child(:,:,:,:) = 0. |
---|
| 104 | DO jj=j1,j2 |
---|
| 105 | DO ji=i1,i2 |
---|
| 106 | N_in = 0 |
---|
| 107 | DO jk=k1,k2 !k2 = jpk of parent grid |
---|
| 108 | IF (tabres(ji,jj,jk,n2) == 0) EXIT |
---|
| 109 | N_in = N_in + 1 |
---|
| 110 | tabin(jk,:) = tabres(ji,jj,jk,n1:n2-1) |
---|
| 111 | h_in(N_in) = tabres(ji,jj,jk,n2) |
---|
| 112 | END DO |
---|
| 113 | N_out = 0 |
---|
| 114 | DO jk=1,jpk ! jpk of child grid |
---|
| 115 | IF (tmask(ji,jj,jk) == 0) EXIT |
---|
| 116 | N_out = N_out + 1 |
---|
[12377] | 117 | h_out(jk) = e3t(ji,jj,jk,Kbb_a) !Child grid scale factors. Could multiply by e1e2t here instead of division above |
---|
[9031] | 118 | ENDDO |
---|
| 119 | IF (N_in > 0) THEN |
---|
[12377] | 120 | CALL reconstructandremap(tabin(1:N_in,1:jptra),h_in,tabres_child(ji,jj,1:N_out,1:jptra),h_out,N_in,N_out,jptra) |
---|
[9031] | 121 | ENDIF |
---|
| 122 | ENDDO |
---|
| 123 | ENDDO |
---|
| 124 | # endif |
---|
| 125 | |
---|
| 126 | DO jj=j1,j2 |
---|
| 127 | DO ji=i1,i2 |
---|
| 128 | DO jk=1,jpkm1 |
---|
| 129 | # if defined key_vertical |
---|
[12377] | 130 | trbdiff(ji,jj,jk,1:jptra) = tr(ji,jj,jk,1:jptra,Kbb_a) - tabres_child(ji,jj,jk,1:jptra) |
---|
[9031] | 131 | # else |
---|
[12377] | 132 | trbdiff(ji,jj,jk,1:jptra) = tr(ji,jj,jk,1:jptra,Kbb_a) - tabres(ji,jj,jk,1:jptra) |
---|
[9031] | 133 | # endif |
---|
| 134 | ENDDO |
---|
| 135 | ENDDO |
---|
| 136 | ENDDO |
---|
| 137 | |
---|
[12377] | 138 | !* set relaxation time scale |
---|
[12489] | 139 | IF( l_1st_euler .AND. lk_agrif_fstep ) THEN ; ztrelax = rn_trelax_tra / ( rn_Dt ) |
---|
| 140 | ELSE ; ztrelax = rn_trelax_tra / (2._wp * rn_Dt ) |
---|
[12377] | 141 | ENDIF |
---|
| 142 | |
---|
[5656] | 143 | DO jn = 1, jptra |
---|
| 144 | DO jk = 1, jpkm1 |
---|
| 145 | DO jj = j1,j2-1 |
---|
| 146 | DO ji = i1,i2-1 |
---|
[12377] | 147 | zabe1 = rn_sponge_tra * fspu(ji,jj) * e2_e1u(ji,jj) * e3u(ji,jj,jk,Kmm_a) * umask(ji,jj,jk) |
---|
| 148 | zabe2 = rn_sponge_tra * fspv(ji,jj) * e1_e2v(ji,jj) * e3v(ji,jj,jk,Kmm_a) * vmask(ji,jj,jk) |
---|
[5656] | 149 | ztu(ji,jj) = zabe1 * ( trbdiff(ji+1,jj ,jk,jn) - trbdiff(ji,jj,jk,jn) ) |
---|
| 150 | ztv(ji,jj) = zabe2 * ( trbdiff(ji ,jj+1,jk,jn) - trbdiff(ji,jj,jk,jn) ) |
---|
[6140] | 151 | END DO |
---|
| 152 | END DO |
---|
| 153 | ! |
---|
[5656] | 154 | DO jj = j1+1,j2-1 |
---|
| 155 | DO ji = i1+1,i2-1 |
---|
[6140] | 156 | IF( .NOT. tabspongedone_trn(ji,jj) ) THEN |
---|
[12377] | 157 | tr(ji,jj,jk,jn,Krhs_a) = tr(ji,jj,jk,jn,Krhs_a) + ( ztu(ji,jj) - ztu(ji-1,jj ) & |
---|
[6140] | 158 | & + ztv(ji,jj) - ztv(ji ,jj-1) ) & |
---|
[12377] | 159 | & * r1_e1e2t(ji,jj) / e3t(ji,jj,jk,Kmm_a) & |
---|
| 160 | & - ztrelax * fspt(ji,jj) * trbdiff(ji,jj,jk,jn) |
---|
[5656] | 161 | ENDIF |
---|
[6140] | 162 | END DO |
---|
| 163 | END DO |
---|
| 164 | END DO |
---|
| 165 | ! |
---|
| 166 | END DO |
---|
| 167 | ! |
---|
[5656] | 168 | tabspongedone_trn(i1+1:i2-1,j1+1:j2-1) = .TRUE. |
---|
| 169 | ENDIF |
---|
| 170 | ! |
---|
| 171 | END SUBROUTINE interptrn_sponge |
---|
| 172 | |
---|
[1271] | 173 | #else |
---|
[9019] | 174 | !!---------------------------------------------------------------------- |
---|
| 175 | !! Empty module no TOP AGRIF |
---|
| 176 | !!---------------------------------------------------------------------- |
---|
[1271] | 177 | CONTAINS |
---|
| 178 | SUBROUTINE agrif_top_sponge_empty |
---|
| 179 | WRITE(*,*) 'agrif_top_sponge : You should not have seen this print! error?' |
---|
| 180 | END SUBROUTINE agrif_top_sponge_empty |
---|
| 181 | #endif |
---|
| 182 | |
---|
[6140] | 183 | !!====================================================================== |
---|
[1271] | 184 | END MODULE agrif_top_sponge |
---|