[911] | 1 | MODULE bdytra |
---|
[1125] | 2 | !!====================================================================== |
---|
[911] | 3 | !! *** MODULE bdytra *** |
---|
[3294] | 4 | !! Ocean tracers: Apply boundary conditions for tracers |
---|
[1125] | 5 | !!====================================================================== |
---|
| 6 | !! History : 1.0 ! 2005-01 (J. Chanut, A. Sellar) Original code |
---|
| 7 | !! 3.0 ! 2008-04 (NEMO team) add in the reference version |
---|
[3294] | 8 | !! 3.4 ! 2011 (D. Storkey) rewrite in preparation for OBC-BDY merge |
---|
[3680] | 9 | !! 3.5 ! 2012 (S. Mocavero, I. Epicoco) Optimization of BDY communications |
---|
[7646] | 10 | !! 4.0 ! 2016 (T. Lovato) Generalize OBC structure |
---|
[1125] | 11 | !!---------------------------------------------------------------------- |
---|
[7646] | 12 | !! bdy_tra : Apply open boundary conditions & damping to T and S |
---|
[1125] | 13 | !!---------------------------------------------------------------------- |
---|
[6140] | 14 | USE oce ! ocean dynamics and tracers variables |
---|
[13982] | 15 | USE dom_oce ! ocean space and time domain variables |
---|
[6140] | 16 | USE bdy_oce ! ocean open boundary conditions |
---|
| 17 | USE bdylib ! for orlanski library routines |
---|
| 18 | ! |
---|
| 19 | USE in_out_manager ! I/O manager |
---|
[14644] | 20 | USE lib_mpp, ONLY: jpfillnothing |
---|
[6140] | 21 | USE lbclnk ! ocean lateral boundary conditions (or mpp link) |
---|
[10529] | 22 | USE lib_mpp, ONLY: ctl_stop |
---|
[6140] | 23 | USE timing ! Timing |
---|
[911] | 24 | |
---|
| 25 | IMPLICIT NONE |
---|
| 26 | PRIVATE |
---|
| 27 | |
---|
[7646] | 28 | ! Local structure to rearrange tracers data |
---|
| 29 | TYPE, PUBLIC :: ztrabdy |
---|
| 30 | REAL(wp), POINTER, DIMENSION(:,:) :: tra |
---|
| 31 | END TYPE |
---|
| 32 | |
---|
[14072] | 33 | PUBLIC bdy_tra ! called in tranxt.F90 |
---|
| 34 | PUBLIC bdy_tra_dmp ! called in step.F90 |
---|
[911] | 35 | |
---|
[1125] | 36 | !!---------------------------------------------------------------------- |
---|
[9598] | 37 | !! NEMO/OCE 4.0 , NEMO Consortium (2018) |
---|
[14072] | 38 | !! $Id$ |
---|
[10068] | 39 | !! Software governed by the CeCILL license (see ./LICENSE) |
---|
[1125] | 40 | !!---------------------------------------------------------------------- |
---|
[911] | 41 | CONTAINS |
---|
| 42 | |
---|
[12377] | 43 | SUBROUTINE bdy_tra( kt, Kbb, pts, Kaa ) |
---|
[1125] | 44 | !!---------------------------------------------------------------------- |
---|
[3294] | 45 | !! *** SUBROUTINE bdy_tra *** |
---|
| 46 | !! |
---|
| 47 | !! ** Purpose : - Apply open boundary conditions for temperature and salinity |
---|
| 48 | !! |
---|
| 49 | !!---------------------------------------------------------------------- |
---|
[12377] | 50 | INTEGER , INTENT(in) :: kt ! Main time step counter |
---|
| 51 | INTEGER , INTENT(in) :: Kbb, Kaa ! time level indices |
---|
[14219] | 52 | REAL(dp), DIMENSION(jpi,jpj,jpk,jpts,jpt), INTENT(inout) :: pts ! tracer fields |
---|
[6140] | 53 | ! |
---|
[11536] | 54 | INTEGER :: ib_bdy, jn, igrd, ir ! Loop indeces |
---|
| 55 | TYPE(ztrabdy), DIMENSION(jpts) :: zdta ! Temporary data structure |
---|
| 56 | LOGICAL :: llrim0 ! indicate if rim 0 is treated |
---|
| 57 | LOGICAL, DIMENSION(4) :: llsend1, llrecv1 ! indicate how communications are to be carried out |
---|
[6140] | 58 | !!---------------------------------------------------------------------- |
---|
[14072] | 59 | igrd = 1 |
---|
[11536] | 60 | llsend1(:) = .false. ; llrecv1(:) = .false. |
---|
| 61 | DO ir = 1, 0, -1 ! treat rim 1 before rim 0 |
---|
| 62 | IF( ir == 0 ) THEN ; llrim0 = .TRUE. |
---|
| 63 | ELSE ; llrim0 = .FALSE. |
---|
[13527] | 64 | ENDIF |
---|
[11536] | 65 | DO ib_bdy=1, nb_bdy |
---|
| 66 | ! |
---|
| 67 | zdta(1)%tra => dta_bdy(ib_bdy)%tem |
---|
| 68 | zdta(2)%tra => dta_bdy(ib_bdy)%sal |
---|
| 69 | ! |
---|
| 70 | DO jn = 1, jpts |
---|
| 71 | ! |
---|
[13527] | 72 | SELECT CASE( cn_tra(ib_bdy) ) |
---|
[11536] | 73 | CASE('none' ) ; CYCLE |
---|
| 74 | CASE('frs' ) ! treat the whole boundary at once |
---|
[13527] | 75 | IF( ir == 0 ) CALL bdy_frs ( idx_bdy(ib_bdy), pts(:,:,:,jn,Kaa), zdta(jn)%tra ) |
---|
[11536] | 76 | CASE('specified' ) ! treat the whole rim at once |
---|
[13527] | 77 | IF( ir == 0 ) CALL bdy_spe ( idx_bdy(ib_bdy), pts(:,:,:,jn,Kaa), zdta(jn)%tra ) |
---|
| 78 | CASE('neumann' ) ; CALL bdy_nmn ( idx_bdy(ib_bdy), igrd , pts(:,:,:,jn,Kaa), llrim0 ) ! tsa masked |
---|
| 79 | CASE('orlanski' ) ; CALL bdy_orl ( idx_bdy(ib_bdy), pts(:,:,:,jn,Kbb), pts(:,:,:,jn,Kaa), zdta(jn)%tra, & |
---|
| 80 | & llrim0, ll_npo=.FALSE. ) |
---|
| 81 | CASE('orlanski_npo') ; CALL bdy_orl ( idx_bdy(ib_bdy), pts(:,:,:,jn,Kbb), pts(:,:,:,jn,Kaa), zdta(jn)%tra, & |
---|
| 82 | & llrim0, ll_npo=.TRUE. ) |
---|
| 83 | CASE('runoff' ) ; CALL bdy_rnf ( idx_bdy(ib_bdy), pts(:,:,:,jn,Kaa), jn, llrim0 ) |
---|
[11536] | 84 | CASE DEFAULT ; CALL ctl_stop( 'bdy_tra : unrecognised option for open boundaries for T and S' ) |
---|
| 85 | END SELECT |
---|
[14072] | 86 | ! |
---|
[11536] | 87 | END DO |
---|
| 88 | END DO |
---|
[6140] | 89 | ! |
---|
[11536] | 90 | IF( nn_hls > 1 .AND. ir == 1 ) CYCLE ! at least 2 halos will be corrected -> no need to correct rim 1 before rim 0 |
---|
[13527] | 91 | IF( nn_hls == 1 ) THEN ; llsend1(:) = .false. ; llrecv1(:) = .false. ; ENDIF |
---|
[11536] | 92 | DO ib_bdy=1, nb_bdy |
---|
[13527] | 93 | SELECT CASE( cn_tra(ib_bdy) ) |
---|
[11536] | 94 | CASE('neumann','runoff') |
---|
| 95 | llsend1(:) = llsend1(:) .OR. lsend_bdyint(ib_bdy,1,:,ir) ! possibly every direction, T points |
---|
| 96 | llrecv1(:) = llrecv1(:) .OR. lrecv_bdyint(ib_bdy,1,:,ir) ! possibly every direction, T points |
---|
| 97 | CASE('orlanski', 'orlanski_npo') |
---|
| 98 | llsend1(:) = llsend1(:) .OR. lsend_bdy(ib_bdy,1,:,ir) ! possibly every direction, T points |
---|
| 99 | llrecv1(:) = llrecv1(:) .OR. lrecv_bdy(ib_bdy,1,:,ir) ! possibly every direction, T points |
---|
[7646] | 100 | END SELECT |
---|
| 101 | END DO |
---|
[11536] | 102 | IF( ANY(llsend1) .OR. ANY(llrecv1) ) THEN ! if need to send/recv in at least one direction |
---|
[13226] | 103 | CALL lbc_lnk( 'bdytra', pts(:,:,:,jn,Kaa), 'T', 1.0_wp, kfillmode=jpfillnothing ,lsend=llsend1, lrecv=llrecv1 ) |
---|
[13527] | 104 | ENDIF |
---|
[11536] | 105 | ! |
---|
| 106 | END DO ! ir |
---|
[3651] | 107 | ! |
---|
[3294] | 108 | END SUBROUTINE bdy_tra |
---|
| 109 | |
---|
[9124] | 110 | |
---|
[12377] | 111 | SUBROUTINE bdy_rnf( idx, pt, jpa, llrim0 ) |
---|
[3294] | 112 | !!---------------------------------------------------------------------- |
---|
[7646] | 113 | !! *** SUBROUTINE bdy_rnf *** |
---|
[14072] | 114 | !! |
---|
[7646] | 115 | !! ** Purpose : Specialized routine to apply TRA runoff values at OBs: |
---|
| 116 | !! - duplicate the neighbour value for the temperature |
---|
[3651] | 117 | !! - specified to 0.1 PSU for the salinity |
---|
[14072] | 118 | !! |
---|
[3651] | 119 | !!---------------------------------------------------------------------- |
---|
[11536] | 120 | TYPE(OBC_INDEX), INTENT(in) :: idx ! OBC indices |
---|
[14219] | 121 | REAL(dp), DIMENSION(jpi,jpj,jpk), INTENT(inout) :: pt ! tracer trend |
---|
[11536] | 122 | INTEGER, INTENT(in) :: jpa ! TRA index |
---|
| 123 | LOGICAL, INTENT(in) :: llrim0 ! indicate if rim 0 is treated |
---|
[6140] | 124 | ! |
---|
[11536] | 125 | INTEGER :: ib, ii, ij, igrd ! dummy loop indices |
---|
[3651] | 126 | !!---------------------------------------------------------------------- |
---|
| 127 | ! |
---|
| 128 | igrd = 1 ! Everything is at T-points here |
---|
[11536] | 129 | IF( jpa == jp_tem ) THEN |
---|
[12377] | 130 | CALL bdy_nmn( idx, igrd, pt, llrim0 ) |
---|
[11536] | 131 | ELSE IF( jpa == jp_sal ) THEN |
---|
| 132 | IF( .NOT. llrim0 ) RETURN |
---|
| 133 | DO ib = 1, idx%nblenrim(igrd) ! if llrim0 then treat the whole rim |
---|
| 134 | ii = idx%nbi(ib,igrd) |
---|
| 135 | ij = idx%nbj(ib,igrd) |
---|
[12377] | 136 | pt(ii,ij,1:jpkm1) = 0.1 * tmask(ii,ij,1:jpkm1) |
---|
[3651] | 137 | END DO |
---|
[13527] | 138 | ENDIF |
---|
[3651] | 139 | ! |
---|
[7646] | 140 | END SUBROUTINE bdy_rnf |
---|
[3651] | 141 | |
---|
[9124] | 142 | |
---|
[12377] | 143 | SUBROUTINE bdy_tra_dmp( kt, Kbb, pts, Krhs ) |
---|
[3651] | 144 | !!---------------------------------------------------------------------- |
---|
| 145 | !! *** SUBROUTINE bdy_tra_dmp *** |
---|
[14072] | 146 | !! |
---|
[3651] | 147 | !! ** Purpose : Apply damping for tracers at open boundaries. |
---|
[14072] | 148 | !! |
---|
[3651] | 149 | !!---------------------------------------------------------------------- |
---|
[12377] | 150 | INTEGER , INTENT(in) :: kt ! time step |
---|
| 151 | INTEGER , INTENT(in) :: Kbb, Krhs ! time level indices |
---|
[14219] | 152 | REAL(dp), DIMENSION(jpi,jpj,jpk,jpts,jpt), INTENT(inout) :: pts ! active tracers and RHS of tracer equation |
---|
[6140] | 153 | ! |
---|
[3651] | 154 | REAL(wp) :: zwgt ! boundary weight |
---|
| 155 | REAL(wp) :: zta, zsa, ztime |
---|
| 156 | INTEGER :: ib, ik, igrd ! dummy loop indices |
---|
| 157 | INTEGER :: ii, ij ! 2D addresses |
---|
| 158 | INTEGER :: ib_bdy ! Loop index |
---|
| 159 | !!---------------------------------------------------------------------- |
---|
[13982] | 160 | IF( ntile /= 0 .AND. ntile /= 1 ) RETURN ! Do only for the full domain |
---|
[3651] | 161 | ! |
---|
[9124] | 162 | IF( ln_timing ) CALL timing_start('bdy_tra_dmp') |
---|
[3651] | 163 | ! |
---|
[6140] | 164 | DO ib_bdy = 1, nb_bdy |
---|
| 165 | IF( ln_tra_dmp(ib_bdy) ) THEN |
---|
[3651] | 166 | igrd = 1 ! Everything is at T-points here |
---|
| 167 | DO ib = 1, idx_bdy(ib_bdy)%nblen(igrd) |
---|
| 168 | ii = idx_bdy(ib_bdy)%nbi(ib,igrd) |
---|
| 169 | ij = idx_bdy(ib_bdy)%nbj(ib,igrd) |
---|
| 170 | zwgt = idx_bdy(ib_bdy)%nbd(ib,igrd) |
---|
| 171 | DO ik = 1, jpkm1 |
---|
[12377] | 172 | zta = zwgt * ( dta_bdy(ib_bdy)%tem(ib,ik) - pts(ii,ij,ik,jp_tem,Kbb) ) * tmask(ii,ij,ik) |
---|
| 173 | zsa = zwgt * ( dta_bdy(ib_bdy)%sal(ib,ik) - pts(ii,ij,ik,jp_sal,Kbb) ) * tmask(ii,ij,ik) |
---|
| 174 | pts(ii,ij,ik,jp_tem,Krhs) = pts(ii,ij,ik,jp_tem,Krhs) + zta |
---|
| 175 | pts(ii,ij,ik,jp_sal,Krhs) = pts(ii,ij,ik,jp_sal,Krhs) + zsa |
---|
[3651] | 176 | END DO |
---|
| 177 | END DO |
---|
| 178 | ENDIF |
---|
[6140] | 179 | END DO |
---|
[3651] | 180 | ! |
---|
[9124] | 181 | IF( ln_timing ) CALL timing_stop('bdy_tra_dmp') |
---|
[3651] | 182 | ! |
---|
| 183 | END SUBROUTINE bdy_tra_dmp |
---|
[14072] | 184 | |
---|
[1125] | 185 | !!====================================================================== |
---|
[911] | 186 | END MODULE bdytra |
---|