[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 |
---|
| 9 | !!---------------------------------------------------------------------- |
---|
[825] | 10 | #if defined key_lim3 |
---|
| 11 | !!---------------------------------------------------------------------- |
---|
[834] | 12 | !! 'key_lim3' LIM3 sea-ice model |
---|
[825] | 13 | !!---------------------------------------------------------------------- |
---|
[3625] | 14 | !! lim_hdf : diffusion trend on sea-ice variable |
---|
[825] | 15 | !!---------------------------------------------------------------------- |
---|
[3625] | 16 | USE dom_oce ! ocean domain |
---|
| 17 | USE ice ! LIM-3: ice variables |
---|
| 18 | USE lbclnk ! lateral boundary condition - MPP exchanges |
---|
| 19 | USE lib_mpp ! MPP library |
---|
| 20 | USE wrk_nemo ! work arrays |
---|
| 21 | USE prtctl ! Print control |
---|
| 22 | USE in_out_manager ! I/O manager |
---|
| 23 | USE lib_fortran ! Fortran utilities (allows no signed zero when 'key_nosignedzero' defined) |
---|
[825] | 24 | |
---|
| 25 | IMPLICIT NONE |
---|
| 26 | PRIVATE |
---|
| 27 | |
---|
[2715] | 28 | PUBLIC lim_hdf ! called by lim_tra |
---|
[825] | 29 | |
---|
[2715] | 30 | LOGICAL :: linit = .TRUE. ! initialization flag (set to flase after the 1st call) |
---|
[825] | 31 | REAL(wp) :: epsi04 = 1e-04 ! constant |
---|
[2715] | 32 | REAL(wp), ALLOCATABLE, SAVE, DIMENSION(:,:) :: efact ! metric coefficient |
---|
[825] | 33 | |
---|
| 34 | !! * Substitution |
---|
| 35 | # include "vectopt_loop_substitute.h90" |
---|
| 36 | !!---------------------------------------------------------------------- |
---|
[4161] | 37 | !! NEMO/LIM3 4.0 , UCL - NEMO Consortium (2010) |
---|
[1156] | 38 | !! $Id$ |
---|
[2715] | 39 | !! Software governed by the CeCILL licence (NEMOGCM/NEMO_CeCILL.txt) |
---|
[825] | 40 | !!---------------------------------------------------------------------- |
---|
| 41 | CONTAINS |
---|
| 42 | |
---|
| 43 | SUBROUTINE lim_hdf( ptab ) |
---|
| 44 | !!------------------------------------------------------------------- |
---|
| 45 | !! *** ROUTINE lim_hdf *** |
---|
| 46 | !! |
---|
[2715] | 47 | !! ** purpose : Compute and add the diffusive trend on sea-ice variables |
---|
[825] | 48 | !! |
---|
| 49 | !! ** method : Second order diffusive operator evaluated using a |
---|
[2715] | 50 | !! Cranck-Nicholson time Scheme. |
---|
[825] | 51 | !! |
---|
| 52 | !! ** Action : update ptab with the diffusive contribution |
---|
| 53 | !!------------------------------------------------------------------- |
---|
[2715] | 54 | REAL(wp), DIMENSION(jpi,jpj), INTENT( inout ) :: ptab ! Field on which the diffusion is applied |
---|
| 55 | ! |
---|
| 56 | INTEGER :: ji, jj ! dummy loop indices |
---|
| 57 | INTEGER :: its, iter, ierr ! local integers |
---|
| 58 | REAL(wp) :: zalfa, zrlxint, zconv, zeps ! local scalars |
---|
[3294] | 59 | REAL(wp), POINTER, DIMENSION(:,:) :: zrlx, zflu, zflv, zdiv0, zdiv, ztab0 |
---|
[2715] | 60 | CHARACTER(lc) :: charout ! local character |
---|
[825] | 61 | !!------------------------------------------------------------------- |
---|
[2715] | 62 | |
---|
[3294] | 63 | CALL wrk_alloc( jpi, jpj, zrlx, zflu, zflv, zdiv0, zdiv, ztab0 ) |
---|
[825] | 64 | |
---|
[2715] | 65 | ! !== Initialisation ==! |
---|
| 66 | ! |
---|
| 67 | IF( linit ) THEN ! Metric coefficient (compute at the first call and saved in efact) |
---|
| 68 | ALLOCATE( efact(jpi,jpj) , STAT=ierr ) |
---|
| 69 | IF( lk_mpp ) CALL mpp_sum( ierr ) |
---|
| 70 | IF( ierr /= 0 ) CALL ctl_stop( 'STOP', 'lim_hdf : unable to allocate arrays' ) |
---|
[825] | 71 | DO jj = 2, jpjm1 |
---|
| 72 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
[2715] | 73 | efact(ji,jj) = ( e2u(ji,jj) + e2u(ji-1,jj) + e1v(ji,jj) + e1v(ji,jj-1) ) / ( e1t(ji,jj) * e2t(ji,jj) ) |
---|
[825] | 74 | END DO |
---|
| 75 | END DO |
---|
| 76 | linit = .FALSE. |
---|
| 77 | ENDIF |
---|
[2715] | 78 | ! ! Time integration parameters |
---|
| 79 | zalfa = 0.5_wp ! =1.0/0.5/0.0 = implicit/Cranck-Nicholson/explicit |
---|
| 80 | its = 100 ! Maximum number of iteration |
---|
| 81 | zeps = 2._wp * epsi04 |
---|
| 82 | ! |
---|
| 83 | ztab0(:, : ) = ptab(:,:) ! Arrays initialization |
---|
| 84 | zdiv0(:, 1 ) = 0._wp |
---|
| 85 | zdiv0(:,jpj) = 0._wp |
---|
| 86 | IF( .NOT.lk_vopt_loop ) THEN |
---|
| 87 | zflu (jpi,:) = 0._wp |
---|
| 88 | zflv (jpi,:) = 0._wp |
---|
| 89 | zdiv0(1, :) = 0._wp |
---|
| 90 | zdiv0(jpi,:) = 0._wp |
---|
| 91 | ENDIF |
---|
[825] | 92 | |
---|
[2715] | 93 | zconv = 1._wp !== horizontal diffusion using a Crant-Nicholson scheme ==! |
---|
[825] | 94 | iter = 0 |
---|
[2715] | 95 | ! |
---|
| 96 | DO WHILE( zconv > zeps .AND. iter <= its ) ! Sub-time step loop |
---|
| 97 | ! |
---|
| 98 | iter = iter + 1 ! incrementation of the sub-time step number |
---|
| 99 | ! |
---|
| 100 | DO jj = 1, jpjm1 ! diffusive fluxes in U- and V- direction |
---|
[825] | 101 | DO ji = 1 , fs_jpim1 ! vector opt. |
---|
| 102 | zflu(ji,jj) = pahu(ji,jj) * e2u(ji,jj) / e1u(ji,jj) * ( ptab(ji+1,jj) - ptab(ji,jj) ) |
---|
| 103 | zflv(ji,jj) = pahv(ji,jj) * e1v(ji,jj) / e2v(ji,jj) * ( ptab(ji,jj+1) - ptab(ji,jj) ) |
---|
| 104 | END DO |
---|
| 105 | END DO |
---|
[2715] | 106 | ! |
---|
| 107 | DO jj= 2, jpjm1 ! diffusive trend : divergence of the fluxes |
---|
[825] | 108 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
| 109 | zdiv (ji,jj) = ( zflu(ji,jj) - zflu(ji-1,jj ) & |
---|
| 110 | & + zflv(ji,jj) - zflv(ji ,jj-1) ) / ( e1t (ji,jj) * e2t (ji,jj) ) |
---|
| 111 | END DO |
---|
| 112 | END DO |
---|
[2715] | 113 | ! |
---|
| 114 | IF( iter == 1 ) zdiv0(:,:) = zdiv(:,:) ! save the 1st evaluation of the diffusive trend in zdiv0 |
---|
| 115 | ! |
---|
| 116 | DO jj = 2, jpjm1 ! iterative evaluation |
---|
[825] | 117 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
[2715] | 118 | zrlxint = ( ztab0(ji,jj) & |
---|
| 119 | & + rdt_ice * ( zalfa * ( zdiv(ji,jj) + efact(ji,jj) * ptab(ji,jj) ) & |
---|
[825] | 120 | & + ( 1.0 - zalfa ) * zdiv0(ji,jj) ) ) & |
---|
[2715] | 121 | & / ( 1.0 + zalfa * rdt_ice * efact(ji,jj) ) |
---|
[825] | 122 | zrlx(ji,jj) = ptab(ji,jj) + om * ( zrlxint - ptab(ji,jj) ) |
---|
| 123 | END DO |
---|
| 124 | END DO |
---|
[2715] | 125 | CALL lbc_lnk( zrlx, 'T', 1. ) ! lateral boundary condition |
---|
| 126 | ! |
---|
| 127 | zconv = 0._wp ! convergence test |
---|
[825] | 128 | DO jj = 2, jpjm1 |
---|
[868] | 129 | DO ji = fs_2, fs_jpim1 |
---|
[825] | 130 | zconv = MAX( zconv, ABS( zrlx(ji,jj) - ptab(ji,jj) ) ) |
---|
| 131 | END DO |
---|
| 132 | END DO |
---|
[2715] | 133 | IF( lk_mpp ) CALL mpp_max( zconv ) ! max over the global domain |
---|
| 134 | ! |
---|
| 135 | ptab(:,:) = zrlx(:,:) |
---|
| 136 | ! |
---|
[825] | 137 | END DO ! end of sub-time step loop |
---|
| 138 | |
---|
[4161] | 139 | ! ----------------------- |
---|
| 140 | !!! final step (clem) !!! |
---|
| 141 | DO jj = 1, jpjm1 ! diffusive fluxes in U- and V- direction |
---|
| 142 | DO ji = 1 , fs_jpim1 ! vector opt. |
---|
| 143 | zflu(ji,jj) = pahu(ji,jj) * e2u(ji,jj) / e1u(ji,jj) * ( ptab(ji+1,jj) - ptab(ji,jj) ) |
---|
| 144 | zflv(ji,jj) = pahv(ji,jj) * e1v(ji,jj) / e2v(ji,jj) * ( ptab(ji,jj+1) - ptab(ji,jj) ) |
---|
| 145 | END DO |
---|
| 146 | END DO |
---|
| 147 | ! |
---|
| 148 | DO jj= 2, jpjm1 ! diffusive trend : divergence of the fluxes |
---|
| 149 | DO ji = fs_2 , fs_jpim1 ! vector opt. |
---|
| 150 | zdiv (ji,jj) = ( zflu(ji,jj) - zflu(ji-1,jj ) & |
---|
| 151 | & + zflv(ji,jj) - zflv(ji ,jj-1) ) / ( e1t (ji,jj) * e2t (ji,jj) ) |
---|
| 152 | ptab(ji,jj) = ztab0(ji,jj) + 0.5 * ( zdiv(ji,jj) + zdiv0(ji,jj) ) |
---|
| 153 | END DO |
---|
| 154 | END DO |
---|
| 155 | CALL lbc_lnk( ptab, 'T', 1. ) ! lateral boundary condition |
---|
| 156 | !!! final step (clem) !!! |
---|
| 157 | ! ----------------------- |
---|
| 158 | |
---|
[825] | 159 | IF(ln_ctl) THEN |
---|
[2715] | 160 | zrlx(:,:) = ptab(:,:) - ztab0(:,:) |
---|
[825] | 161 | WRITE(charout,FMT="(' lim_hdf : zconv =',D23.16, ' iter =',I4,2X)") zconv, iter |
---|
[2715] | 162 | CALL prt_ctl( tab2d_1=zrlx, clinfo1=charout ) |
---|
[825] | 163 | ENDIF |
---|
[2715] | 164 | ! |
---|
[3294] | 165 | CALL wrk_dealloc( jpi, jpj, zrlx, zflu, zflv, zdiv0, zdiv, ztab0 ) |
---|
[2715] | 166 | ! |
---|
[825] | 167 | END SUBROUTINE lim_hdf |
---|
| 168 | |
---|
| 169 | #else |
---|
| 170 | !!---------------------------------------------------------------------- |
---|
| 171 | !! Default option Dummy module NO LIM sea-ice model |
---|
| 172 | !!---------------------------------------------------------------------- |
---|
| 173 | CONTAINS |
---|
| 174 | SUBROUTINE lim_hdf ! Empty routine |
---|
| 175 | END SUBROUTINE lim_hdf |
---|
| 176 | #endif |
---|
| 177 | |
---|
| 178 | !!====================================================================== |
---|
| 179 | END MODULE limhdf |
---|