| 1 | MODULE trc_oce |
|---|
| 2 | !!====================================================================== |
|---|
| 3 | !! *** MODULE trc_oce *** |
|---|
| 4 | !! Ocean passive tracer : share SMS/Ocean variables |
|---|
| 5 | !!====================================================================== |
|---|
| 6 | !! History : 1.0 ! 2004-03 (C. Ethe) Original code |
|---|
| 7 | !!---------------------------------------------------------------------- |
|---|
| 8 | |
|---|
| 9 | !!---------------------------------------------------------------------- |
|---|
| 10 | !! trc_oce_rgb : tabulated attenuation coefficients for RGB light penetration |
|---|
| 11 | !!---------------------------------------------------------------------- |
|---|
| 12 | USE par_oce |
|---|
| 13 | USE in_out_manager ! I/O manager |
|---|
| 14 | USE dom_oce ! ocean space and time domain |
|---|
| 15 | |
|---|
| 16 | IMPLICIT NONE |
|---|
| 17 | PRIVATE |
|---|
| 18 | |
|---|
| 19 | PUBLIC trc_oce_rgb ! routine called by traqsr.F90 |
|---|
| 20 | PUBLIC trc_oce_rgb_read ! routine called by traqsr.F90 |
|---|
| 21 | PUBLIC trc_oce_ext_lev ! function called by traqsr.F90 at least |
|---|
| 22 | |
|---|
| 23 | REAL(wp), PUBLIC , DIMENSION(jpi,jpj,jpk) :: etot3 !: light absortion coefficient |
|---|
| 24 | |
|---|
| 25 | #if defined key_top && defined key_pisces |
|---|
| 26 | !!---------------------------------------------------------------------- |
|---|
| 27 | !! 'key_top' & 'key_pisces' PISCES bio-model |
|---|
| 28 | !!---------------------------------------------------------------------- |
|---|
| 29 | LOGICAL, PUBLIC, PARAMETER :: lk_qsr_bio = .TRUE. !: bio-model light absorption flag |
|---|
| 30 | #else |
|---|
| 31 | !!---------------------------------------------------------------------- |
|---|
| 32 | !! Default option No bio-model light absorption |
|---|
| 33 | !!---------------------------------------------------------------------- |
|---|
| 34 | LOGICAL, PUBLIC, PARAMETER :: lk_qsr_bio = .FALSE. !: bio-model light absorption flag |
|---|
| 35 | #endif |
|---|
| 36 | |
|---|
| 37 | !! * Substitutions |
|---|
| 38 | # include "domzgr_substitute.h90" |
|---|
| 39 | !!---------------------------------------------------------------------- |
|---|
| 40 | !! NEMO/OPA 3.2 , LOCEAN-IPSL (2009) |
|---|
| 41 | !! $Id$ |
|---|
| 42 | !! Software governed by the CeCILL licence (modipsl/doc/NEMO_CeCILL.txt) |
|---|
| 43 | !!---------------------------------------------------------------------- |
|---|
| 44 | |
|---|
| 45 | CONTAINS |
|---|
| 46 | |
|---|
| 47 | SUBROUTINE trc_oce_rgb( prgb ) |
|---|
| 48 | !!--------------------------------------------------------------------- |
|---|
| 49 | !! *** ROUTINE p4z_opt_init *** |
|---|
| 50 | !! |
|---|
| 51 | !! ** Purpose : Initialization of of the optical scheme |
|---|
| 52 | !! |
|---|
| 53 | !! ** Method : Set a look up table for the optical coefficients |
|---|
| 54 | !! i.e. the attenuation coefficient for R-G-B light |
|---|
| 55 | !! tabulated in Chlorophyll class (from JM Andre) |
|---|
| 56 | !! |
|---|
| 57 | !! ** Action : prgb(3,61) tabulated R-G-B attenuation coef. |
|---|
| 58 | !! |
|---|
| 59 | !! Reference : Lengaigne et al. 2007, Clim. Dyn., V28, 5, 503-516. |
|---|
| 60 | !!---------------------------------------------------------------------- |
|---|
| 61 | REAL(wp), DIMENSION(3,61), INTENT(out) :: prgb ! tabulated attenuation coefficient |
|---|
| 62 | !! |
|---|
| 63 | INTEGER :: jc ! dummy loop indice |
|---|
| 64 | INTEGER :: irgb ! temporary integer |
|---|
| 65 | REAL(wp) :: zchl ! temporary scalar |
|---|
| 66 | REAL(wp), DIMENSION(4,61) :: zrgb ! tabulated attenuation coefficient (formerly read in 'kRGB61.txt') |
|---|
| 67 | !!---------------------------------------------------------------------- |
|---|
| 68 | ! |
|---|
| 69 | IF(lwp) THEN |
|---|
| 70 | WRITE(numout,*) |
|---|
| 71 | WRITE(numout,*) 'trc_oce_rgb : Initialisation of the optical look-up table' |
|---|
| 72 | WRITE(numout,*) '~~~~~~~~~~~ ' |
|---|
| 73 | ENDIF |
|---|
| 74 | ! |
|---|
| 75 | ! Chlorophyll ! Blue attenuation ! Green attenuation ! Red attenuation ! |
|---|
| 76 | zrgb(1, 1) = 0.010 ; zrgb(2, 1) = 0.01618 ; zrgb(3, 1) = 0.07464 ; zrgb(4, 1) = 0.37807 |
|---|
| 77 | zrgb(1, 2) = 0.011 ; zrgb(2, 2) = 0.01654 ; zrgb(3, 2) = 0.07480 ; zrgb(4, 2) = 0.37823 |
|---|
| 78 | zrgb(1, 3) = 0.013 ; zrgb(2, 3) = 0.01693 ; zrgb(3, 3) = 0.07499 ; zrgb(4, 3) = 0.37840 |
|---|
| 79 | zrgb(1, 4) = 0.014 ; zrgb(2, 4) = 0.01736 ; zrgb(3, 4) = 0.07518 ; zrgb(4, 4) = 0.37859 |
|---|
| 80 | zrgb(1, 5) = 0.016 ; zrgb(2, 5) = 0.01782 ; zrgb(3, 5) = 0.07539 ; zrgb(4, 5) = 0.37879 |
|---|
| 81 | zrgb(1, 6) = 0.018 ; zrgb(2, 6) = 0.01831 ; zrgb(3, 6) = 0.07562 ; zrgb(4, 6) = 0.37900 |
|---|
| 82 | zrgb(1, 7) = 0.020 ; zrgb(2, 7) = 0.01885 ; zrgb(3, 7) = 0.07586 ; zrgb(4, 7) = 0.37923 |
|---|
| 83 | zrgb(1, 8) = 0.022 ; zrgb(2, 8) = 0.01943 ; zrgb(3, 8) = 0.07613 ; zrgb(4, 8) = 0.37948 |
|---|
| 84 | zrgb(1, 9) = 0.025 ; zrgb(2, 9) = 0.02005 ; zrgb(3, 9) = 0.07641 ; zrgb(4, 9) = 0.37976 |
|---|
| 85 | zrgb(1,10) = 0.028 ; zrgb(2,10) = 0.02073 ; zrgb(3,10) = 0.07672 ; zrgb(4,10) = 0.38005 |
|---|
| 86 | zrgb(1,11) = 0.032 ; zrgb(2,11) = 0.02146 ; zrgb(3,11) = 0.07705 ; zrgb(4,11) = 0.38036 |
|---|
| 87 | zrgb(1,12) = 0.035 ; zrgb(2,12) = 0.02224 ; zrgb(3,12) = 0.07741 ; zrgb(4,12) = 0.38070 |
|---|
| 88 | zrgb(1,13) = 0.040 ; zrgb(2,13) = 0.02310 ; zrgb(3,13) = 0.07780 ; zrgb(4,13) = 0.38107 |
|---|
| 89 | zrgb(1,14) = 0.045 ; zrgb(2,14) = 0.02402 ; zrgb(3,14) = 0.07821 ; zrgb(4,14) = 0.38146 |
|---|
| 90 | zrgb(1,15) = 0.050 ; zrgb(2,15) = 0.02501 ; zrgb(3,15) = 0.07866 ; zrgb(4,15) = 0.38189 |
|---|
| 91 | zrgb(1,16) = 0.056 ; zrgb(2,16) = 0.02608 ; zrgb(3,16) = 0.07914 ; zrgb(4,16) = 0.38235 |
|---|
| 92 | zrgb(1,17) = 0.063 ; zrgb(2,17) = 0.02724 ; zrgb(3,17) = 0.07967 ; zrgb(4,17) = 0.38285 |
|---|
| 93 | zrgb(1,18) = 0.071 ; zrgb(2,18) = 0.02849 ; zrgb(3,18) = 0.08023 ; zrgb(4,18) = 0.38338 |
|---|
| 94 | zrgb(1,19) = 0.079 ; zrgb(2,19) = 0.02984 ; zrgb(3,19) = 0.08083 ; zrgb(4,19) = 0.38396 |
|---|
| 95 | zrgb(1,20) = 0.089 ; zrgb(2,20) = 0.03131 ; zrgb(3,20) = 0.08149 ; zrgb(4,20) = 0.38458 |
|---|
| 96 | zrgb(1,21) = 0.100 ; zrgb(2,21) = 0.03288 ; zrgb(3,21) = 0.08219 ; zrgb(4,21) = 0.38526 |
|---|
| 97 | zrgb(1,22) = 0.112 ; zrgb(2,22) = 0.03459 ; zrgb(3,22) = 0.08295 ; zrgb(4,22) = 0.38598 |
|---|
| 98 | zrgb(1,23) = 0.126 ; zrgb(2,23) = 0.03643 ; zrgb(3,23) = 0.08377 ; zrgb(4,23) = 0.38676 |
|---|
| 99 | zrgb(1,24) = 0.141 ; zrgb(2,24) = 0.03842 ; zrgb(3,24) = 0.08466 ; zrgb(4,24) = 0.38761 |
|---|
| 100 | zrgb(1,25) = 0.158 ; zrgb(2,25) = 0.04057 ; zrgb(3,25) = 0.08561 ; zrgb(4,25) = 0.38852 |
|---|
| 101 | zrgb(1,26) = 0.178 ; zrgb(2,26) = 0.04289 ; zrgb(3,26) = 0.08664 ; zrgb(4,26) = 0.38950 |
|---|
| 102 | zrgb(1,27) = 0.200 ; zrgb(2,27) = 0.04540 ; zrgb(3,27) = 0.08775 ; zrgb(4,27) = 0.39056 |
|---|
| 103 | zrgb(1,28) = 0.224 ; zrgb(2,28) = 0.04811 ; zrgb(3,28) = 0.08894 ; zrgb(4,28) = 0.39171 |
|---|
| 104 | zrgb(1,29) = 0.251 ; zrgb(2,29) = 0.05103 ; zrgb(3,29) = 0.09023 ; zrgb(4,29) = 0.39294 |
|---|
| 105 | zrgb(1,30) = 0.282 ; zrgb(2,30) = 0.05420 ; zrgb(3,30) = 0.09162 ; zrgb(4,30) = 0.39428 |
|---|
| 106 | zrgb(1,31) = 0.316 ; zrgb(2,31) = 0.05761 ; zrgb(3,31) = 0.09312 ; zrgb(4,31) = 0.39572 |
|---|
| 107 | zrgb(1,32) = 0.355 ; zrgb(2,32) = 0.06130 ; zrgb(3,32) = 0.09474 ; zrgb(4,32) = 0.39727 |
|---|
| 108 | zrgb(1,33) = 0.398 ; zrgb(2,33) = 0.06529 ; zrgb(3,33) = 0.09649 ; zrgb(4,33) = 0.39894 |
|---|
| 109 | zrgb(1,34) = 0.447 ; zrgb(2,34) = 0.06959 ; zrgb(3,34) = 0.09837 ; zrgb(4,34) = 0.40075 |
|---|
| 110 | zrgb(1,35) = 0.501 ; zrgb(2,35) = 0.07424 ; zrgb(3,35) = 0.10040 ; zrgb(4,35) = 0.40270 |
|---|
| 111 | zrgb(1,36) = 0.562 ; zrgb(2,36) = 0.07927 ; zrgb(3,36) = 0.10259 ; zrgb(4,36) = 0.40480 |
|---|
| 112 | zrgb(1,37) = 0.631 ; zrgb(2,37) = 0.08470 ; zrgb(3,37) = 0.10495 ; zrgb(4,37) = 0.40707 |
|---|
| 113 | zrgb(1,38) = 0.708 ; zrgb(2,38) = 0.09056 ; zrgb(3,38) = 0.10749 ; zrgb(4,38) = 0.40952 |
|---|
| 114 | zrgb(1,39) = 0.794 ; zrgb(2,39) = 0.09690 ; zrgb(3,39) = 0.11024 ; zrgb(4,39) = 0.41216 |
|---|
| 115 | zrgb(1,40) = 0.891 ; zrgb(2,40) = 0.10374 ; zrgb(3,40) = 0.11320 ; zrgb(4,40) = 0.41502 |
|---|
| 116 | zrgb(1,41) = 1.000 ; zrgb(2,41) = 0.11114 ; zrgb(3,41) = 0.11639 ; zrgb(4,41) = 0.41809 |
|---|
| 117 | zrgb(1,42) = 1.122 ; zrgb(2,42) = 0.11912 ; zrgb(3,42) = 0.11984 ; zrgb(4,42) = 0.42142 |
|---|
| 118 | zrgb(1,43) = 1.259 ; zrgb(2,43) = 0.12775 ; zrgb(3,43) = 0.12356 ; zrgb(4,43) = 0.42500 |
|---|
| 119 | zrgb(1,44) = 1.413 ; zrgb(2,44) = 0.13707 ; zrgb(3,44) = 0.12757 ; zrgb(4,44) = 0.42887 |
|---|
| 120 | zrgb(1,45) = 1.585 ; zrgb(2,45) = 0.14715 ; zrgb(3,45) = 0.13189 ; zrgb(4,45) = 0.43304 |
|---|
| 121 | zrgb(1,46) = 1.778 ; zrgb(2,46) = 0.15803 ; zrgb(3,46) = 0.13655 ; zrgb(4,46) = 0.43754 |
|---|
| 122 | zrgb(1,47) = 1.995 ; zrgb(2,47) = 0.16978 ; zrgb(3,47) = 0.14158 ; zrgb(4,47) = 0.44240 |
|---|
| 123 | zrgb(1,48) = 2.239 ; zrgb(2,48) = 0.18248 ; zrgb(3,48) = 0.14701 ; zrgb(4,48) = 0.44765 |
|---|
| 124 | zrgb(1,49) = 2.512 ; zrgb(2,49) = 0.19620 ; zrgb(3,49) = 0.15286 ; zrgb(4,49) = 0.45331 |
|---|
| 125 | zrgb(1,50) = 2.818 ; zrgb(2,50) = 0.21102 ; zrgb(3,50) = 0.15918 ; zrgb(4,50) = 0.45942 |
|---|
| 126 | zrgb(1,51) = 3.162 ; zrgb(2,51) = 0.22703 ; zrgb(3,51) = 0.16599 ; zrgb(4,51) = 0.46601 |
|---|
| 127 | zrgb(1,52) = 3.548 ; zrgb(2,52) = 0.24433 ; zrgb(3,52) = 0.17334 ; zrgb(4,52) = 0.47313 |
|---|
| 128 | zrgb(1,53) = 3.981 ; zrgb(2,53) = 0.26301 ; zrgb(3,53) = 0.18126 ; zrgb(4,53) = 0.48080 |
|---|
| 129 | zrgb(1,54) = 4.467 ; zrgb(2,54) = 0.28320 ; zrgb(3,54) = 0.18981 ; zrgb(4,54) = 0.48909 |
|---|
| 130 | zrgb(1,55) = 5.012 ; zrgb(2,55) = 0.30502 ; zrgb(3,55) = 0.19903 ; zrgb(4,55) = 0.49803 |
|---|
| 131 | zrgb(1,56) = 5.623 ; zrgb(2,56) = 0.32858 ; zrgb(3,56) = 0.20898 ; zrgb(4,56) = 0.50768 |
|---|
| 132 | zrgb(1,57) = 6.310 ; zrgb(2,57) = 0.35404 ; zrgb(3,57) = 0.21971 ; zrgb(4,57) = 0.51810 |
|---|
| 133 | zrgb(1,58) = 7.079 ; zrgb(2,58) = 0.38154 ; zrgb(3,58) = 0.23129 ; zrgb(4,58) = 0.52934 |
|---|
| 134 | zrgb(1,59) = 7.943 ; zrgb(2,59) = 0.41125 ; zrgb(3,59) = 0.24378 ; zrgb(4,59) = 0.54147 |
|---|
| 135 | zrgb(1,60) = 8.912 ; zrgb(2,60) = 0.44336 ; zrgb(3,60) = 0.25725 ; zrgb(4,60) = 0.55457 |
|---|
| 136 | zrgb(1,61) = 10.000 ; zrgb(2,61) = 0.47804 ; zrgb(3,61) = 0.27178 ; zrgb(4,61) = 0.56870 |
|---|
| 137 | ! |
|---|
| 138 | prgb(:,:) = zrgb(2:4,:) |
|---|
| 139 | ! |
|---|
| 140 | DO jc = 1, 61 ! check |
|---|
| 141 | zchl = zrgb(1,jc) |
|---|
| 142 | irgb = NINT( 41 + 20.* LOG10( zchl ) + 1.e-15 ) |
|---|
| 143 | IF(lwp) WRITE(numout,*) ' jc =', jc, ' Chl = ', zchl, ' irgb = ', irgb |
|---|
| 144 | IF( irgb /= jc ) THEN |
|---|
| 145 | IF(lwp) WRITE(numout,*) ' jc =', jc, ' Chl = ', zchl, ' Chl class = ', irgb |
|---|
| 146 | CALL ctl_stop( 'trc_oce_rgb : inconsistency in Chl tabulated attenuation coeff.' ) |
|---|
| 147 | ENDIF |
|---|
| 148 | END DO |
|---|
| 149 | ! |
|---|
| 150 | END SUBROUTINE trc_oce_rgb |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | SUBROUTINE trc_oce_rgb_read( prgb ) |
|---|
| 154 | !!---------------------------------------------------------------------- |
|---|
| 155 | !! *** ROUTINE p4z_opt_init *** |
|---|
| 156 | !! |
|---|
| 157 | !! ** Purpose : Initialization of of the optical scheme |
|---|
| 158 | !! |
|---|
| 159 | !! ** Method : read the look up table for the optical coefficients |
|---|
| 160 | !! |
|---|
| 161 | !! ** input : xkrgb(61) precomputed array corresponding to the |
|---|
| 162 | !! attenuation coefficient (from JM Andre) |
|---|
| 163 | !!---------------------------------------------------------------------- |
|---|
| 164 | REAL(wp), DIMENSION(3,61), INTENT(out) :: prgb ! tabulated attenuation coefficient |
|---|
| 165 | !! |
|---|
| 166 | INTEGER :: jchl, jband ! dummy loop indices |
|---|
| 167 | INTEGER :: numlight |
|---|
| 168 | REAL(wp) :: zchl |
|---|
| 169 | !!---------------------------------------------------------------------- |
|---|
| 170 | ! |
|---|
| 171 | CALL ctl_opn( numlight, 'kRGB61.txt', 'OLD', 'FORMATTED', 'SEQUENTIAL', -1, numout, lwp ) |
|---|
| 172 | DO jchl = 1, 61 |
|---|
| 173 | READ(numlight,*) zchl, ( prgb(jband,jchl), jband=1,3 ) |
|---|
| 174 | END DO |
|---|
| 175 | CLOSE( numlight ) |
|---|
| 176 | ! |
|---|
| 177 | IF(lwp) THEN ! control print |
|---|
| 178 | WRITE(numout,*) |
|---|
| 179 | WRITE(numout,*) ' trc_oce_rgb_read : optical look-up table read in kRGB61.txt file' |
|---|
| 180 | WRITE(numout,*) ' ~~~~~~~~~~~~~~~~' |
|---|
| 181 | ENDIF |
|---|
| 182 | ! |
|---|
| 183 | END SUBROUTINE trc_oce_rgb_read |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | FUNCTION trc_oce_ext_lev( prldex, pqsr_frc ) RESULT( pjl ) |
|---|
| 187 | !!---------------------------------------------------------------------- |
|---|
| 188 | !! *** ROUTINE trc_oce_ext_lev *** |
|---|
| 189 | !! |
|---|
| 190 | !! ** Purpose : compute max. level for light penetration |
|---|
| 191 | !! |
|---|
| 192 | !! ** Method : the function provides the level at which irradiance |
|---|
| 193 | !! becomes negligible (i.e. = 1.e-15 W/m2) for 3 or 2 bands light |
|---|
| 194 | !! penetration: I(z) = pqsr_frc * EXP(hext/prldex) = 1.e-15 W/m2 |
|---|
| 195 | !! # prldex is the longest depth of extinction: |
|---|
| 196 | !! - prldex = 23 m (2 bands case) |
|---|
| 197 | !! - prldex = 62 m (3 bands case: blue waveband & 0.01 mg/m2 for the chlorophyll) |
|---|
| 198 | !! # pqsr_frc is the fraction of solar radiation which penetrates, |
|---|
| 199 | !! considering Qsr=240 W/m2 and rn_abs = 0.58: |
|---|
| 200 | !! - pqsr_frc = Qsr * (1-rn_abs) = 1.00e2 W/m2 (2 bands case) |
|---|
| 201 | !! - pqsr_frc = Qsr * (1-rn_abs)/3 = 0.33e2 W/m2 (3 bands case & equi-partition) |
|---|
| 202 | !! |
|---|
| 203 | !!---------------------------------------------------------------------- |
|---|
| 204 | REAL(wp), INTENT(in) :: prldex ! longest depth of extinction |
|---|
| 205 | REAL(wp), INTENT(in) :: pqsr_frc ! frac. solar radiation which penetrates |
|---|
| 206 | !! |
|---|
| 207 | INTEGER :: jk, pjl ! levels |
|---|
| 208 | REAL(wp) :: zhext ! deepest level till which light penetrates |
|---|
| 209 | REAL(wp) :: zprec = 15._wp ! precision to reach -LOG10(1.e-15) |
|---|
| 210 | REAL(wp) :: zem ! temporary scalar |
|---|
| 211 | !!---------------------------------------------------------------------- |
|---|
| 212 | ! |
|---|
| 213 | ! It is not necessary to compute anything bellow the following depth |
|---|
| 214 | zhext = prldex * ( LOG(10.e0) * zprec + LOG(pqsr_frc) ) |
|---|
| 215 | |
|---|
| 216 | ! Level of light extinction |
|---|
| 217 | pjl = jpkm1 |
|---|
| 218 | DO jk = jpkm1, 1, -1 |
|---|
| 219 | zem = MAXVAL( fsdepw(:,:,jk+1) * tmask(:,:,jk) ) |
|---|
| 220 | IF( zem >= zhext ) pjl = jk ! last T-level reached by Qsr |
|---|
| 221 | END DO |
|---|
| 222 | ! |
|---|
| 223 | END FUNCTION trc_oce_ext_lev |
|---|
| 224 | |
|---|
| 225 | |
|---|
| 226 | !!====================================================================== |
|---|
| 227 | END MODULE trc_oce |
|---|
