New URL for NEMO forge!   http://forge.nemo-ocean.eu

Since March 2022 along with NEMO 4.2 release, the code development moved to a self-hosted GitLab.
This present forge is now archived and remained online for history.
agrif_ice_update.F90 in NEMO/branches/UKMO/NEMO_4.0.2_mirror/src/NST – NEMO

source: NEMO/branches/UKMO/NEMO_4.0.2_mirror/src/NST/agrif_ice_update.F90 @ 12722

Last change on this file since 12722 was 12658, checked in by cguiavarch, 4 years ago

UKMO/NEMO_4.0.2_mirror : Remove SVN keywords.

File size: 10.7 KB
RevLine 
[7309]1#define TWO_WAY
[9482]2!!#undef TWO_WAY
[9761]3#undef DECAL_FEEDBACK  /* SEPARATION of INTERFACES*/
[7309]4
[9596]5MODULE agrif_ice_update
[7309]6   !!=====================================================================================
[9596]7   !!                       ***  MODULE agrif_ice_update ***
[7309]8   !! Nesting module :  update surface ocean boundary condition over ice from a child grid
9   !!=====================================================================================
[9656]10   !! History :  2.0   !  04-2008  (F. Dupont)               initial version
[7309]11   !!            3.4   !  08-2012  (R. Benshila, C. Herbaut) update and EVP
[9656]12   !!            4.0   !  2018     (C. Rousset)              SI3 compatibility
[7309]13   !!----------------------------------------------------------------------
[9570]14#if defined key_agrif && defined key_si3
[7309]15   !!----------------------------------------------------------------------
[9656]16   !!   'key_si3'  :                                      SI3 sea-ice model
17   !!   'key_agrif' :                                     AGRIF library
[7309]18   !!----------------------------------------------------------------------
[9610]19   !!   agrif_update_ice  : update sea-ice on boundaries or total
[7309]20   !!                        child domain for velocities and ice properties
[9656]21   !!   update_tra_ice    : sea-ice properties
22   !!   update_u_ice      : zonal      ice velocity
23   !!   update_v_ice      : meridional ice velocity
[7309]24   !!----------------------------------------------------------------------
25   USE dom_oce
26   USE sbc_oce
27   USE agrif_oce
28   USE ice
29   USE agrif_ice 
[9454]30   USE phycst , ONLY: rt0
[7309]31
32   IMPLICIT NONE
33   PRIVATE
34
[9610]35   PUBLIC   agrif_update_ice   ! called by agrif_user.F90 and icestp.F90
[7309]36
37   !!----------------------------------------------------------------------
[9598]38   !! NEMO/NST 4.0 , NEMO Consortium (2018)
[10069]39   !! $Id$
[10068]40   !! Software governed by the CeCILL license (see ./LICENSE)
[7309]41   !!----------------------------------------------------------------------
42CONTAINS
43
[9780]44   SUBROUTINE agrif_update_ice( )
[7309]45      !!----------------------------------------------------------------------
[9610]46      !!                     *** ROUTINE agrif_update_ice ***
[7309]47      !! ** Method  :   Call the hydrostaticupdate pressure at the boundary or the entire domain
48      !!
49      !! ** Action : - Update (u_ice,v_ice) and ice tracers
50      !!----------------------------------------------------------------------
51      !
[9482]52      IF( Agrif_Root() .OR. nn_ice == 0 ) RETURN   ! do not update if inside Parent Grid or if child domain does not have ice
[9019]53      !
[9780]54!      IF( ( MOD( (kt-nit000)/nn_fsbc + 1, Agrif_irhot() * Agrif_Parent(nn_fsbc)/nn_fsbc ) /=0 ) .AND. (kt /= 0) ) RETURN   ! update only at the parent ice time step
[9785]55      IF ( MOD(Agrif_parent_nb_step(), Agrif_Parent(nn_fsbc)) /=0 ) RETURN   ! Update only at the parent ice time step
56                                                                             ! It is assumed that at such a time, there is a child ice step which is true
57                                                                             ! as long as MOD( Agrif_irhot() * Agrif_Parent(nn_fsbc), nn_fsbc )==0.
58                                                                             ! (This condition is checked in agrif_user, Agrif_InitValues_cont_ice subroutine)
59      IF (lwp.AND.lk_agrif_debug) Write(*,*) 'Update sea ice from grid Number',Agrif_Fixed(), agrif_nb_step()
[9780]60      !
[9785]61      !
[9019]62      Agrif_SpecialValueFineGrid    = -9999.
[7309]63      Agrif_UseSpecialValueInUpdate = .TRUE.
[9761]64
[7309]65# if defined TWO_WAY
[9761]66# if ! defined DECAL_FEEDBACK
[9031]67      CALL Agrif_Update_Variable( tra_ice_id , procname = update_tra_ice  )
[9761]68#else
69      CALL Agrif_Update_Variable( tra_ice_id , locupdate=(/1,0/), procname = update_tra_ice  )
70#endif
71# if ! defined DECAL_FEEDBACK
[9031]72      CALL Agrif_Update_Variable( u_ice_id   , procname = update_u_ice    )
73      CALL Agrif_Update_Variable( v_ice_id   , procname = update_v_ice    )
[9761]74#else
75      CALL Agrif_Update_Variable( u_ice_id   , locupdate1=(/0,-1/),locupdate2=(/1,-2/),procname=update_u_ice) 
76      CALL Agrif_Update_Variable( v_ice_id   , locupdate1=(/1,-2/),locupdate2=(/0,-1/),procname=update_v_ice)
77#endif
[9031]78!      CALL Agrif_Update_Variable( tra_ice_id , locupdate=(/0,2/), procname = update_tra_ice  )
79!      CALL Agrif_Update_Variable( u_ice_id   , locupdate=(/0,1/), procname = update_u_ice    )
80!      CALL Agrif_Update_Variable( v_ice_id   , locupdate=(/0,1/), procname = update_v_ice    )
[7309]81# endif
[9019]82      Agrif_SpecialValueFineGrid    = 0.
[7309]83      Agrif_UseSpecialValueInUpdate = .FALSE.
84      !
[9610]85   END SUBROUTINE agrif_update_ice
[7309]86
87
88   SUBROUTINE update_tra_ice( ptab, i1, i2, j1, j2, k1, k2, before )
89      !!-----------------------------------------------------------------------
90      !!                        *** ROUTINE update_tra_ice ***
91      !! ** Method  : Compute the mass properties on the fine grid and recover
92      !!              the properties per mass on the coarse grid
93      !!-----------------------------------------------------------------------
[9019]94      INTEGER                               , INTENT(in   ) ::   i1, i2, j1, j2, k1, k2
95      REAL(wp), DIMENSION(i1:i2,j1:j2,k1:k2), INTENT(inout) ::   ptab
96      LOGICAL                               , INTENT(in   ) ::   before
[7309]97      !!
[9019]98      INTEGER  :: ji, jj, jk, jl, jm
[7309]99      !!-----------------------------------------------------------------------
[7761]100      ! it is ok not to multiply by e1*e2 since we conserve tracers here (same as in the ocean).
[7309]101      IF( before ) THEN
102         jm = 1
103         DO jl = 1, jpl
[9019]104            ptab(i1:i2,j1:j2,jm  ) = a_i (i1:i2,j1:j2,jl)
105            ptab(i1:i2,j1:j2,jm+1) = v_i (i1:i2,j1:j2,jl)
106            ptab(i1:i2,j1:j2,jm+2) = v_s (i1:i2,j1:j2,jl)
107            ptab(i1:i2,j1:j2,jm+3) = sv_i(i1:i2,j1:j2,jl)
[9167]108            ptab(i1:i2,j1:j2,jm+4) = oa_i(i1:i2,j1:j2,jl)
109            ptab(i1:i2,j1:j2,jm+5) = a_ip(i1:i2,j1:j2,jl)
110            ptab(i1:i2,j1:j2,jm+6) = v_ip(i1:i2,j1:j2,jl)
111            ptab(i1:i2,j1:j2,jm+7) = t_su(i1:i2,j1:j2,jl)
112            jm = jm + 8
[7309]113            DO jk = 1, nlay_s
[9019]114               ptab(i1:i2,j1:j2,jm) = e_s(i1:i2,j1:j2,jk,jl)   ;   jm = jm + 1
115            END DO
[7309]116            DO jk = 1, nlay_i
[9019]117               ptab(i1:i2,j1:j2,jm) = e_i(i1:i2,j1:j2,jk,jl)   ;   jm = jm + 1
118            END DO
119         END DO
120         !
[7309]121         DO jk = k1, k2
[9019]122            WHERE( tmask(i1:i2,j1:j2,1) == 0. )   ptab(i1:i2,j1:j2,jk) = Agrif_SpecialValueFineGrid 
123         END DO
124         !
[7309]125      ELSE
[9019]126         !
[7309]127         jm = 1
128         DO jl = 1, jpl
[9019]129            !
130            DO jj = j1, j2
131               DO ji = i1, i2
132                  IF( ptab(ji,jj,jm) /= Agrif_SpecialValueFineGrid ) THEN
133                     a_i (ji,jj,jl) = ptab(ji,jj,jm  ) * tmask(ji,jj,1)
134                     v_i (ji,jj,jl) = ptab(ji,jj,jm+1) * tmask(ji,jj,1)
135                     v_s (ji,jj,jl) = ptab(ji,jj,jm+2) * tmask(ji,jj,1)
136                     sv_i(ji,jj,jl) = ptab(ji,jj,jm+3) * tmask(ji,jj,1)
137                     oa_i(ji,jj,jl) = ptab(ji,jj,jm+4) * tmask(ji,jj,1)
[9167]138                     a_ip(ji,jj,jl) = ptab(ji,jj,jm+5) * tmask(ji,jj,1)
139                     v_ip(ji,jj,jl) = ptab(ji,jj,jm+6) * tmask(ji,jj,1)
140                     t_su(ji,jj,jl) = ptab(ji,jj,jm+7) * tmask(ji,jj,1)
[9019]141                  ENDIF
142               END DO
143            END DO
[9167]144            jm = jm + 8
[9019]145            !
[7309]146            DO jk = 1, nlay_s
[9019]147               WHERE( ptab(i1:i2,j1:j2,jm) /= Agrif_SpecialValueFineGrid )
148                  e_s(i1:i2,j1:j2,jk,jl) = ptab(i1:i2,j1:j2,jm) * tmask(i1:i2,j1:j2,1)
149               ENDWHERE
150               jm = jm + 1
151            END DO
152            !
[7309]153            DO jk = 1, nlay_i
[9019]154               WHERE( ptab(i1:i2,j1:j2,jm) /= Agrif_SpecialValueFineGrid )
155                  e_i(i1:i2,j1:j2,jk,jl) = ptab(i1:i2,j1:j2,jm) * tmask(i1:i2,j1:j2,1)
156               ENDWHERE
157               jm = jm + 1
158            END DO
159            !
160         END DO
161         !
[9454]162         DO jl = 1, jpl
163            WHERE( tmask(i1:i2,j1:j2,1) == 0._wp )   t_su(i1:i2,j1:j2,jl) = rt0   ! to avoid a division by 0 in sbcblk.F90
164         END DO
[7761]165         
[7309]166      ENDIF
167      !
168   END SUBROUTINE update_tra_ice
169
170
171   SUBROUTINE update_u_ice( ptab, i1, i2, j1, j2, before )
172      !!-----------------------------------------------------------------------
173      !!                        *** ROUTINE update_u_ice ***
174      !! ** Method  : Update the fluxes and recover the properties (C-grid)
175      !!-----------------------------------------------------------------------
[9019]176      INTEGER                         , INTENT(in   ) ::   i1, i2, j1, j2
177      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) ::   ptab
178      LOGICAL                         , INTENT(in   ) ::   before
[7309]179      !!
[9019]180      REAL(wp) ::   zrhoy   ! local scalar
[7309]181      !!-----------------------------------------------------------------------
182      !
183      IF( before ) THEN
184         zrhoy = Agrif_Rhoy()
185         ptab(:,:) = e2u(i1:i2,j1:j2) * u_ice(i1:i2,j1:j2) * zrhoy
[9019]186         WHERE( umask(i1:i2,j1:j2,1) == 0._wp )   ptab(:,:) = Agrif_SpecialValueFineGrid
[7309]187      ELSE
[9019]188         WHERE( ptab(i1:i2,j1:j2) /= Agrif_SpecialValueFineGrid )
189            u_ice(i1:i2,j1:j2) = ptab(i1:i2,j1:j2) / e2u(i1:i2,j1:j2) * umask(i1:i2,j1:j2,1)
190         ENDWHERE
[7309]191      ENDIF
192      !
193   END SUBROUTINE update_u_ice
194
195
196   SUBROUTINE update_v_ice( ptab, i1, i2, j1, j2, before )
197      !!-----------------------------------------------------------------------
198      !!                    *** ROUTINE update_v_ice ***
199      !! ** Method  : Update the fluxes and recover the properties (C-grid)
200      !!-----------------------------------------------------------------------
[9019]201      INTEGER                         , INTENT(in   ) ::   i1, i2, j1, j2
202      REAL(wp), DIMENSION(i1:i2,j1:j2), INTENT(inout) ::   ptab
203      LOGICAL                         , INTENT(in   ) ::   before
[7309]204      !!
[9019]205      REAL(wp) ::   zrhox   ! local scalar
[7309]206      !!-----------------------------------------------------------------------
207      !
208      IF( before ) THEN
209         zrhox = Agrif_Rhox()
210         ptab(:,:) = e1v(i1:i2,j1:j2) * v_ice(i1:i2,j1:j2) * zrhox
[9019]211         WHERE( vmask(i1:i2,j1:j2,1) == 0._wp )   ptab(:,:) = Agrif_SpecialValueFineGrid
[7309]212      ELSE
[9019]213         WHERE( ptab(i1:i2,j1:j2) /= Agrif_SpecialValueFineGrid )
214            v_ice(i1:i2,j1:j2) = ptab(i1:i2,j1:j2) / e1v(i1:i2,j1:j2) * vmask(i1:i2,j1:j2,1)
215         ENDWHERE
[7309]216      ENDIF
217      !
218   END SUBROUTINE update_v_ice
219
220#else
[9019]221   !!----------------------------------------------------------------------
222   !!   Empty module                                             no sea-ice
223   !!----------------------------------------------------------------------
[7309]224CONTAINS
[9596]225   SUBROUTINE agrif_ice_update_empty
226      WRITE(*,*)  'agrif_ice_update : You should not have seen this print! error?'
227   END SUBROUTINE agrif_ice_update_empty
[7309]228#endif
[9019]229
230   !!======================================================================
[9596]231END MODULE agrif_ice_update
Note: See TracBrowser for help on using the repository browser.