[825] | 1 | MODULE limhdf |
---|
| 2 | !!====================================================================== |
---|
| 3 | !! *** MODULE limhdf *** |
---|
| 4 | !! LIM ice model : horizontal diffusion of sea-ice quantities |
---|
| 5 | !!====================================================================== |
---|
[2715] | 6 | !! History : LIM ! 2000-01 (LIM) Original code |
---|
| 7 | !! - ! 2001-05 (G. Madec, R. Hordoir) opa norm |
---|
| 8 | !! 1.0 ! 2002-08 (C. Ethe) F90, free form |
---|
[7877] | 9 | !! 3.0 ! 2015-08 (O. Tintó and M. Castrillo) added lim_hdf (multiple) |
---|
[2715] | 10 | !!---------------------------------------------------------------------- |
---|
[825] | 11 | #if defined key_lim3 |
---|
| 12 | !!---------------------------------------------------------------------- |
---|
[834] | 13 | !! 'key_lim3' LIM3 sea-ice model |
---|
[825] | 14 | !!---------------------------------------------------------------------- |
---|
[3625] | 15 | !! lim_hdf : diffusion trend on sea-ice variable |
---|
[5429] | 16 | !! lim_hdf_init : initialisation of diffusion trend on sea-ice variable |
---|
[825] | 17 | !!---------------------------------------------------------------------- |
---|
[3625] | 18 | USE dom_oce ! ocean domain |
---|
| 19 | USE ice ! LIM-3: ice variables |
---|
| 20 | USE lbclnk ! lateral boundary condition - MPP exchanges |
---|
| 21 | USE lib_mpp ! MPP library |
---|
| 22 | USE wrk_nemo ! work arrays |
---|
| 23 | USE prtctl ! Print control |
---|
| 24 | USE in_out_manager ! I/O manager |
---|
| 25 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
---|
[825] | 26 | |
---|
| 27 | IMPLICIT NONE |
---|
| 28 | PRIVATE |
---|
| 29 | |
---|
[7877] | 30 | PUBLIC lim_hdf ! called by lim_trp |
---|
[5429] | 31 | PUBLIC lim_hdf_init ! called by sbc_lim_init |
---|
[825] | 32 | |
---|
[5123] | 33 | LOGICAL :: linit = .TRUE. ! initialization flag (set to flase after the 1st call) |
---|
[5429] | 34 | INTEGER :: nn_convfrq !: convergence check frequency of the Crant-Nicholson scheme |
---|
[2715] | 35 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: efact ! metric coefficient |
---|
[825] | 36 | |
---|
| 37 | !! * Substitution |
---|
| 38 | # include "vectopt_loop_substitute.h90" |
---|
| 39 | !!---------------------------------------------------------------------- |
---|
[4161] | 40 | !! NEMO/LIM3 4.0 , UCL - NEMO Consortium (2010) |
---|
[1156] | 41 | !! $Id$ |
---|
[2715] | 42 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[825] | 43 | !!---------------------------------------------------------------------- |
---|
| 44 | CONTAINS |
---|
| 45 | |
---|
[7877] | 46 | SUBROUTINE lim_hdf( ptab , ihdf_vars , jpl , nlay_i ) |
---|
[825] | 47 | !!------------------------------------------------------------------- |
---|
| 48 | !! *** ROUTINE lim_hdf *** |
---|
| 49 | !! |
---|
[2715] | 50 | !! ** purpose : Compute and add the diffusive trend on sea-ice variables |
---|
[825] | 51 | !! |
---|
| 52 | !! ** method : Second order diffusive operator evaluated using a |
---|
[2715] | 53 | !! Cranck-Nicholson time Scheme. |
---|
[825] | 54 | !! |
---|
| 55 | !! ** Action : update ptab with the diffusive contribution |
---|
| 56 | !!------------------------------------------------------------------- |
---|
[7877] | 57 | INTEGER :: jpl, nlay_i, isize, ihdf_vars |
---|
| 58 | REAL(wp), DIMENSION(:,:,:), INTENT( inout ),TARGET :: ptab ! Field on which the diffusion is applied |
---|
[2715] | 59 | ! |
---|
[7877] | 60 | INTEGER :: ji, jj, jk, jl , jm ! dummy loop indices |
---|
[5123] | 61 | INTEGER :: iter, ierr ! local integers |
---|
[7877] | 62 | REAL(wp) :: zrlxint ! local scalars |
---|
| 63 | REAL(wp), POINTER , DIMENSION ( : ) :: zconv ! local scalars |
---|
| 64 | REAL(wp), POINTER , DIMENSION(:,:,:) :: zrlx,zdiv0, ztab0 |
---|
| 65 | REAL(wp), POINTER , DIMENSION(:,:) :: zflu, zflv, zdiv |
---|
[5123] | 66 | CHARACTER(lc) :: charout ! local character |
---|
| 67 | REAL(wp), PARAMETER :: zrelax = 0.5_wp ! relaxation constant for iterative procedure |
---|
| 68 | REAL(wp), PARAMETER :: zalfa = 0.5_wp ! =1.0/0.5/0.0 = implicit/Cranck-Nicholson/explicit |
---|
| 69 | INTEGER , PARAMETER :: its = 100 ! Maximum number of iteration |
---|
[825] | 70 | !!------------------------------------------------------------------- |
---|
[7877] | 71 | TYPE(arrayptr) , ALLOCATABLE, DIMENSION(:) :: pt2d_array, zrlx_array |
---|
| 72 | CHARACTER(len=1) , ALLOCATABLE, DIMENSION(:) :: type_array ! define the nature of ptab array grid-points |
---|
| 73 | ! ! = T , U , V , F , W and I points |
---|
| 74 | REAL(wp) , ALLOCATABLE, DIMENSION(:) :: psgn_array ! =-1 the sign change across the north fold boundary |
---|
| 75 | |
---|
| 76 | !!--------------------------------------------------------------------- |
---|
| 77 | |
---|
| 78 | ! !== Initialisation ==! |
---|
| 79 | ! +1 open water diffusion |
---|
| 80 | isize = jpl*(ihdf_vars+nlay_i)+1 |
---|
| 81 | ALLOCATE( zconv (isize) ) |
---|
| 82 | ALLOCATE( pt2d_array(isize) , zrlx_array(isize) ) |
---|
| 83 | ALLOCATE( type_array(isize) ) |
---|
| 84 | ALLOCATE( psgn_array(isize) ) |
---|
[2715] | 85 | |
---|
[7877] | 86 | CALL wrk_alloc( jpi, jpj, isize, zrlx, zdiv0, ztab0 ) |
---|
| 87 | CALL wrk_alloc( jpi, jpj, zflu, zflv, zdiv ) |
---|
[825] | 88 | |
---|
[7877] | 89 | DO jk= 1 , isize |
---|
| 90 | pt2d_array(jk)%pt2d=>ptab(:,:,jk) |
---|
| 91 | zrlx_array(jk)%pt2d=>zrlx(:,:,jk) |
---|
| 92 | type_array(jk)='T' |
---|
| 93 | psgn_array(jk)=1. |
---|
| 94 | END DO |
---|
| 95 | |
---|
[2715] | 96 | ! |
---|
| 97 | IF( linit ) THEN ! Metric coefficient (compute at the first call and saved in efact) |
---|
| 98 | ALLOCATE( efact(jpi,jpj) , STAT=ierr ) |
---|
| 99 | IF( lk_mpp ) CALL mpp_sum( ierr ) |
---|
| 100 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'lim_hdf : unable to allocate arrays' ) |
---|
[7877] | 101 | DO jj = 2, jpjm1 |
---|
[825] | 102 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
[5123] | 103 | efact(ji,jj) = ( e2u(ji,jj) + e2u(ji-1,jj) + e1v(ji,jj) + e1v(ji,jj-1) ) * r1_e12t(ji,jj) |
---|
[825] | 104 | END DO |
---|
| 105 | END DO |
---|
| 106 | linit = .FALSE. |
---|
| 107 | ENDIF |
---|
[2715] | 108 | ! ! Time integration parameters |
---|
| 109 | ! |
---|
[7877] | 110 | zflu (jpi,: ) = 0._wp |
---|
| 111 | zflv (jpi,: ) = 0._wp |
---|
[825] | 112 | |
---|
[7877] | 113 | DO jk=1 , isize |
---|
| 114 | ztab0(:, : , jk ) = ptab(:,:,jk) ! Arrays initialization |
---|
| 115 | zdiv0(:, 1 , jk ) = 0._wp |
---|
| 116 | zdiv0(:,jpj, jk ) = 0._wp |
---|
| 117 | zdiv0(1, :, jk ) = 0._wp |
---|
| 118 | zdiv0(jpi,:, jk ) = 0._wp |
---|
| 119 | END DO |
---|
| 120 | |
---|
[2715] | 121 | zconv = 1._wp !== horizontal diffusion using a Crant-Nicholson scheme ==! |
---|
[825] | 122 | iter = 0 |
---|
[2715] | 123 | ! |
---|
[7877] | 124 | DO WHILE( MAXVAL(zconv(:)) > ( 2._wp * 1.e-04 ) .AND. iter <= its ) ! Sub-time step loop |
---|
[2715] | 125 | ! |
---|
| 126 | iter = iter + 1 ! incrementation of the sub-time step number |
---|
| 127 | ! |
---|
[7877] | 128 | DO jk = 1 , isize |
---|
| 129 | jl = (jk-1) /( ihdf_vars+nlay_i)+1 |
---|
| 130 | IF (zconv(jk) > ( 2._wp * 1.e-04 )) THEN |
---|
| 131 | DO jj = 1, jpjm1 ! diffusive fluxes in U- and V- direction |
---|
| 132 | DO ji = 1 , fs_jpim1 ! vector opt. |
---|
| 133 | zflu(ji,jj) = pahu3D(ji,jj,jl) * e2u(ji,jj) * r1_e1u(ji,jj) * ( ptab(ji+1,jj,jk) - ptab(ji,jj,jk) ) |
---|
| 134 | zflv(ji,jj) = pahv3D(ji,jj,jl) * e1v(ji,jj) * r1_e2v(ji,jj) * ( ptab(ji,jj+1,jk) - ptab(ji,jj,jk) ) |
---|
| 135 | END DO |
---|
| 136 | END DO |
---|
| 137 | ! |
---|
| 138 | DO jj= 2, jpjm1 ! diffusive trend : divergence of the fluxes |
---|
| 139 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
| 140 | zdiv(ji,jj) = ( zflu(ji,jj) - zflu(ji-1,jj) + zflv(ji,jj) - zflv(ji,jj-1) ) * r1_e12t(ji,jj) |
---|
| 141 | END DO |
---|
| 142 | END DO |
---|
| 143 | ! |
---|
| 144 | IF( iter == 1 ) zdiv0(:,:,jk) = zdiv(:,:) ! save the 1st evaluation of the diffusive trend in zdiv0 |
---|
| 145 | ! |
---|
| 146 | DO jj = 2, jpjm1 ! iterative evaluation |
---|
| 147 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
| 148 | zrlxint = ( ztab0(ji,jj,jk) & |
---|
| 149 | & + rdt_ice * ( zalfa * ( zdiv(ji,jj) + efact(ji,jj) * ptab(ji,jj,jk) ) & |
---|
| 150 | & + ( 1.0 - zalfa ) * zdiv0(ji,jj,jk) ) & |
---|
| 151 | & ) / ( 1.0 + zalfa * rdt_ice * efact(ji,jj) ) |
---|
| 152 | zrlx(ji,jj,jk) = ptab(ji,jj,jk) + zrelax * ( zrlxint - ptab(ji,jj,jk) ) |
---|
| 153 | END DO |
---|
| 154 | END DO |
---|
| 155 | END IF |
---|
| 156 | |
---|
[825] | 157 | END DO |
---|
[7877] | 158 | |
---|
| 159 | CALL lbc_lnk_multi( zrlx_array, type_array , psgn_array , isize ) ! Multiple interchange of all the variables |
---|
[2715] | 160 | ! |
---|
[7877] | 161 | |
---|
| 162 | IF ( MOD( iter-1 , nn_convfrq ) == 0 ) THEN !Convergence test every nn_convfrq iterations (perf. optimization ) |
---|
| 163 | DO jk=1,isize |
---|
| 164 | zconv(jk) = 0._wp ! convergence test |
---|
| 165 | DO jj = 2, jpjm1 |
---|
| 166 | DO ji = fs_2, fs_jpim1 |
---|
| 167 | zconv(jk) = MAX( zconv(jk), ABS( zrlx(ji,jj,jk) - ptab(ji,jj,jk) ) ) |
---|
| 168 | END DO |
---|
[5429] | 169 | END DO |
---|
[825] | 170 | END DO |
---|
[7877] | 171 | IF( lk_mpp ) CALL mpp_max_multiple( zconv , isize ) ! max over the global domain for all the variables |
---|
[5429] | 172 | ENDIF |
---|
[2715] | 173 | ! |
---|
[7877] | 174 | DO jk=1,isize |
---|
| 175 | ptab(:,:,jk) = zrlx(:,:,jk) |
---|
| 176 | END DO |
---|
[2715] | 177 | ! |
---|
[825] | 178 | END DO ! end of sub-time step loop |
---|
| 179 | |
---|
[7877] | 180 | ! ----------------------- |
---|
[4161] | 181 | !!! final step (clem) !!! |
---|
[7877] | 182 | DO jk = 1, isize |
---|
| 183 | jl = (jk-1) /( ihdf_vars+nlay_i)+1 |
---|
| 184 | DO jj = 1, jpjm1 ! diffusive fluxes in U- and V- direction |
---|
| 185 | DO ji = 1 , fs_jpim1 ! vector opt. |
---|
| 186 | zflu(ji,jj) = pahu3D(ji,jj,jl) * e2u(ji,jj) * r1_e1u(ji,jj) * ( ptab(ji+1,jj,jk) - ptab(ji,jj,jk) ) |
---|
| 187 | zflv(ji,jj) = pahv3D(ji,jj,jl) * e1v(ji,jj) * r1_e2v(ji,jj) * ( ptab(ji,jj+1,jk) - ptab(ji,jj,jk) ) |
---|
| 188 | END DO |
---|
[4161] | 189 | END DO |
---|
[7877] | 190 | ! |
---|
| 191 | DO jj= 2, jpjm1 ! diffusive trend : divergence of the fluxes |
---|
| 192 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
| 193 | zdiv(ji,jj) = ( zflu(ji,jj) - zflu(ji-1,jj) + zflv(ji,jj) - zflv(ji,jj-1) ) * r1_e12t(ji,jj) |
---|
| 194 | ptab(ji,jj,jk) = ztab0(ji,jj,jk) + 0.5 * ( zdiv(ji,jj) + zdiv0(ji,jj,jk) ) |
---|
| 195 | END DO |
---|
[4161] | 196 | END DO |
---|
| 197 | END DO |
---|
[7877] | 198 | |
---|
| 199 | CALL lbc_lnk_multi( pt2d_array, type_array , psgn_array , isize ) ! Multiple interchange of all the variables |
---|
| 200 | |
---|
[4161] | 201 | !!! final step (clem) !!! |
---|
| 202 | ! ----------------------- |
---|
| 203 | |
---|
[825] | 204 | IF(ln_ctl) THEN |
---|
[7877] | 205 | DO jk = 1 , isize |
---|
| 206 | zrlx(:,:,jk) = ptab(:,:,jk) - ztab0(:,:,jk) |
---|
| 207 | WRITE(charout,FMT="(' lim_hdf : zconv =',D23.16, ' iter =',I4,2X)") zconv, iter |
---|
| 208 | CALL prt_ctl( tab2d_1=zrlx(:,:,jk), clinfo1=charout ) |
---|
| 209 | END DO |
---|
[825] | 210 | ENDIF |
---|
[2715] | 211 | ! |
---|
[7877] | 212 | CALL wrk_dealloc( jpi, jpj, isize, zrlx, zdiv0, ztab0 ) |
---|
| 213 | CALL wrk_dealloc( jpi, jpj, zflu, zflv, zdiv ) |
---|
| 214 | |
---|
| 215 | DEALLOCATE( zconv ) |
---|
| 216 | DEALLOCATE( pt2d_array , zrlx_array ) |
---|
| 217 | DEALLOCATE( type_array ) |
---|
| 218 | DEALLOCATE( psgn_array ) |
---|
[2715] | 219 | ! |
---|
[825] | 220 | END SUBROUTINE lim_hdf |
---|
| 221 | |
---|
[7877] | 222 | |
---|
[5429] | 223 | |
---|
| 224 | SUBROUTINE lim_hdf_init |
---|
| 225 | !!------------------------------------------------------------------- |
---|
| 226 | !! *** ROUTINE lim_hdf_init *** |
---|
| 227 | !! |
---|
| 228 | !! ** Purpose : Initialisation of horizontal diffusion of sea-ice |
---|
| 229 | !! |
---|
| 230 | !! ** Method : Read the namicehdf namelist |
---|
| 231 | !! |
---|
| 232 | !! ** input : Namelist namicehdf |
---|
| 233 | !!------------------------------------------------------------------- |
---|
| 234 | INTEGER :: ios ! Local integer output status for namelist read |
---|
[7877] | 235 | NAMELIST/namicehdf/ nn_convfrq |
---|
[5429] | 236 | !!------------------------------------------------------------------- |
---|
| 237 | ! |
---|
| 238 | IF(lwp) THEN |
---|
| 239 | WRITE(numout,*) |
---|
| 240 | WRITE(numout,*) 'lim_hdf : Ice horizontal diffusion' |
---|
| 241 | WRITE(numout,*) '~~~~~~~' |
---|
| 242 | ENDIF |
---|
| 243 | ! |
---|
| 244 | REWIND( numnam_ice_ref ) ! Namelist namicehdf in reference namelist : Ice horizontal diffusion |
---|
| 245 | READ ( numnam_ice_ref, namicehdf, IOSTAT = ios, ERR = 901) |
---|
| 246 | 901 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namicehdf in reference namelist', lwp ) |
---|
| 247 | |
---|
| 248 | REWIND( numnam_ice_cfg ) ! Namelist namicehdf in configuration namelist : Ice horizontal diffusion |
---|
| 249 | READ ( numnam_ice_cfg, namicehdf, IOSTAT = ios, ERR = 902 ) |
---|
| 250 | 902 IF( ios /= 0 ) CALL ctl_nam ( ios , 'namicehdf in configuration namelist', lwp ) |
---|
| 251 | IF(lwm) WRITE ( numoni, namicehdf ) |
---|
| 252 | ! |
---|
| 253 | IF(lwp) THEN ! control print |
---|
| 254 | WRITE(numout,*) |
---|
| 255 | WRITE(numout,*)' Namelist of ice parameters for ice horizontal diffusion computation ' |
---|
| 256 | WRITE(numout,*)' convergence check frequency of the Crant-Nicholson scheme nn_convfrq = ', nn_convfrq |
---|
| 257 | ENDIF |
---|
| 258 | ! |
---|
| 259 | END SUBROUTINE lim_hdf_init |
---|
[825] | 260 | #else |
---|
| 261 | !!---------------------------------------------------------------------- |
---|
| 262 | !! Default option Dummy module NO LIM sea-ice model |
---|
| 263 | !!---------------------------------------------------------------------- |
---|
| 264 | #endif |
---|
| 265 | |
---|
| 266 | !!====================================================================== |
---|
| 267 | END MODULE limhdf |
---|
[7877] | 268 | |
---|