Changes between Version 11 and Version 12 of ticket/0664_TRA_TRP

Timestamp:

2010-07-29T11:53:40+02:00 (14 years ago)

Author:

cetlod

Comment:

--

ticket/0664_TRA_TRP

@@ -30 +30 @@
    for example, for CEN2 advection the routine start as follows:
 {{{
-   SUBROUTINE tra_adv_cen2( kt, cdtype, pun, pvn, pwn, ptrab, ptran, ptraa )
+   SUBROUTINE tra_adv_cen2( kt, cdtype, pun, pvn, pwn, ptrab, ptran, ptraa, kjpt )
       !!----------------------------------------------------------------------
       !!                  ***  ROUTINE tra_adv_cen2  ***
@@ -38 +38 @@
       !! ** Method  : 
       !!----------------------------------------------------------------------
-      INTEGER         , INTENT(in   )                         ::   kt              ! ocean time-step index
-      CHARACTER(len=3), INTENT(in   )                         ::   cdtype          ! =TRA or TRC (tracer indicator)
-      REAL(wp)        , INTENT(in   ), DIMENSION(:,:,:  )     ::   pun, pvn, pwn   ! 3 ocean transport components
-      REAL(wp)        , INTENT(in   ), DIMENSION(:,:,:,:)     ::   ptrab, ptran    ! before and now tracer fields
-      REAL(wp)        , INTENT(inout), DIMENSION(:,:,:,:)     ::   ptraa           ! tracer trend
-}}}
-[[BR]]
-
-'''(2)''' Test for T & S 3D arrays by using the fortran '''''RESHAPE''''' function [[BR]][[BR]]
-
-   In order to test the new tra... modules without changing the temperature and salinity field every where in the code, we use the RESHAPE function in the call of the new routine. For example the call in tra_adv becomes :
+      INTEGER         , INTENT(in   )                               ::   kt              ! ocean time-step index
+      CHARACTER(len=3), INTENT(in   )                               ::   cdtype          ! =TRA or TRC (tracer indicator)
+      INTEGER         , INTENT(in   )                               ::   kjpt            ! number of tracers
+      REAL(wp)        , INTENT(in   ), DIMENSION(jpi,jpj,jpk     )  ::   pun, pvn, pwn   ! 3 ocean transport components
+      REAL(wp)        , INTENT(in   ), DIMENSION(jpi,jpj,jpk,kjpt)  ::   ptrab, ptran    ! before and now tracer fields
+      REAL(wp)        , INTENT(inout), DIMENSION(jpi,jpj,jpk,kjpt)  ::   ptraa           ! tracer trend
+
+}}}
+[[BR]]
+
+'''(2)''' Test for T & S 3D arrays  [[BR]][[BR]]
+
+   In order to test the new tra... modules without changing the temperature and salinity field every where in the code, we replace T and S 3D arrays by 4D array just within the TRA modules in the call of the new routine. For example, in the step rotuin
+
+{{{
+   SUBROUTINE stp( kstp )
+      INTEGER, INTENT(in) ::   kstp   ! ocean time-step index
+
+       bla bla bla bla bla bla
+       bla bla bla bla bla bla
+
+      !>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>>
+      ! Active tracers                              (ua, va used as workspace)
+      !<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
+                             ta(:,:,:) = 0.e0               ! set tracer trends to zero
+                             sa(:,:,:) = 0.e0
+
+                             CALL tra_swap
+                             CALL tra_sbc    ( kstp )       ! surface boundary condition
+      IF( ln_traqsr      )   CALL tra_qsr    ( kstp )       ! penetrative solar radiation qsr
+      IF( lk_trabbc      )   CALL tra_bbc    ( kstp )       ! bottom heat flux
+      IF( lk_trabbl      )   CALL tra_bbl    ( kstp )       ! advective (and/or diffusive) bottom boundary layer scheme
+      IF( lk_tradmp      )   CALL tra_dmp    ( kstp )       ! internal damping trends
+                             CALL tra_adv    ( kstp )       ! horizontal & vertical advection
+      IF( n_cla == 1     )   CALL tra_cla    ( kstp )       ! Cross Land Advection (Update Hor. advection)
+      IF( lk_zdfkpp )        CALL tra_kpp    ( kstp )       ! KPP non-local tracer fluxes
+                             CALL tra_ldf    ( kstp )       ! lateral mixing
+#if defined key_agrif
+                             CALL tra_unswap
+      IF(.NOT. Agrif_Root()) CALL Agrif_Sponge_tra          ! tracers sponge
+                             CALL tra_swap
+#endif
+                             CALL tra_zdf    ( kstp )       ! vertical mixing and after tracer fields
+
+      IF( ln_dynhpg_imp  ) THEN                             ! semi-implicit hpg (time stepping then eos)
+         IF( ln_zdfnpc   )   CALL tra_npc    ( kstp )            ! update after fields by non-penetrative convection
+                             CALL tra_nxt    ( kstp )            ! tracer fields at next time step
+                             CALL tra_unswap
+                             CALL eos( ta, sa, rhd, rhop )       ! Time-filtered in situ density for hpg computation
+         IF( ln_zps      )   CALL zps_hde( kstp, ta, sa, rhd,   &   ! Partial steps: time filtered hor. derivative
+            &                                   gtu, gsu, gru,  &   ! of t, s, rd at the bottom ocean level
+            &                                   gtv, gsv, grv )
+
+      ELSE                                                  ! centered hpg  (eos then time stepping)
+                             CALL tra_unswap
+                             CALL eos( tn, sn, rhd, rhop )       ! now in situ density for hpg computation
+         IF( ln_zps      )   CALL zps_hde( kstp, tn, sn, rhd,   &   ! Partial steps: now horizontal derivative
+            &                                   gtu, gsu, gru,  &   ! of t, s, rd at the bottom ocean level
+            &                                   gtv, gsv, grv )
+                             CALL tra_swap
+         IF( ln_zdfnpc   )   CALL tra_npc    ( kstp )       ! update after fields by non-penetrative convection
+                             CALL tra_nxt    ( kstp )       ! tracer fields at next time step
+                             CALL tra_unswap
+      ENDIF
+
+       bla bla bla bla bla bla
+       bla bla bla bla bla bla
+}}}
+
+{{{
+MODULE traswp
+   !!==============================================================================
+   !!                       ***  MODULE  traswp  ***
+   !! Ocean active tracers: swapping array 
+   !!==============================================================================
+   USE par_oce
+   USE oce             ! ocean dynamics and active tracers
+
+   IMPLICIT NONE
+   PRIVATE
+
+   PUBLIC   tra_swap    ! routine called by step.F90
+   PUBLIC   tra_unswap    ! routine called by step.F90
+
+
+CONTAINS
+
+   SUBROUTINE tra_swap
+      !!----------------------------------------------------------------------
+      !!                  ***  ROUTINE tra_swp  ***
+      !!                   
+      !! ** Purpose : Store temperature and salinity aaray into a 4D array 
+      !!
+      !!----------------------------------------------------------------------
+
+      tsn(:,:,:,jp_tem) = tn(:,:,:)      ;      tsn(:,:,:,jp_sal) = sn(:,:,:)
+      tsb(:,:,:,jp_tem) = tb(:,:,:)      ;      tsb(:,:,:,jp_sal) = sb(:,:,:)
+      tsa(:,:,:,jp_tem) = ta(:,:,:)      ;      tsa(:,:,:,jp_sal) = sa(:,:,:)
+
+   END SUBROUTINE tra_swap
+
+   SUBROUTINE tra_unswap
+      !!----------------------------------------------------------------------
+      !!                  ***  ROUTINE tra_unswap  ***
+      !!                   
+      !! ** Purpose : Store temperature and salinity aaray into a 4D array 
+      !!
+      !!----------------------------------------------------------------------
+
+      tn(:,:,:) = tsn(:,:,:,jp_tem)      ;      sn(:,:,:) = tsn(:,:,:,jp_sal)
+      tb(:,:,:) = tsb(:,:,:,jp_tem)      ;      sb(:,:,:) = tsb(:,:,:,jp_sal)
+      ta(:,:,:) = tsa(:,:,:,jp_tem)      ;      sa(:,:,:) = tsa(:,:,:,jp_sal)
+
+   END SUBROUTINE tra_unswap
+
+   !!======================================================================
+END MODULE traswp
+}}}
+
+
+For example the call in tra_adv becomes :
 
 {{{
@@ -65 +175 @@
       !!----------------------------------------------------------------------
 
-      !                                              ! effective transport
       DO jk = 1, jpkm1
-#if defined key_trabbl_adv                                      
-         !                                                ! eulerian + bbl transport
-         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * ( un(:,:,jk) - u_bbl(:,:,jk) )
-         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * ( vn(:,:,jk) - v_bbl(:,:,jk) )
-         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * ( wn(:,:,jk) + w_bbl(:,:,jk) )
-#else
          !                                                ! eulerian transport only
-         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) *   un(:,:,jk)
-         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) *   vn(:,:,jk)
-         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      *   wn(:,:,jk)
-#endif
+         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)
+         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
+         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
+         !
       END DO
       zwn(:,:,jpk) = 0.e0                                 ! no transport trough the bottom
 
       !                                                   ! add the eiv transport (if necessary)
-      IF( lk_traldf_eiv )   CALL tra_adv_eiv( kt, zun, zvn, zwn )
-
-      CALL tra_adv_cen2( kt, 'TRA', zun, zvn, zwn                        ,  &
-         &                          RESHAPE( tb, (/jpi,jpj,jpk,2/), sb ) ,  &
-         &                          RESHAPE( tn, (/jpi,jpj,jpk,2/), sn ) ,  &
-         &                          RESHAPE( ta, (/jpi,jpj,jpk,2/), sa )      )    ! 2nd order centered
+      IF( lk_traldf_eiv )   CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRA' )
+
+      CALL tra_adv_cen2( kt, 'TRA', zun, zvn, zwn, tsb, tsn, tsa, jpts )    ! 2nd order centered
 }}}
 
    N.B. the transport given in argument is now the effective transport, i.e. including the one associated with eddy induced velocity, or bbl.
-
+[[BR]]
+   N.B : We've first planned to use the fortran '''''RESHAPE''''' function for tests on T & S tracers. This function allowed to create a 4D array by  merging two 3D arrays : RESHAPE( tb, (/jpi,jpj,jpk,2/), sb ).  But, the performances of vectorisation when using the '''''RESHAPE''''' function are very poor - tests have been done on CCRT NEC-SX8 computer
+   
 [[BR]]
 
@@ -113 +215 @@
       !!----------------------------------------------------------------------
 
-      !                                              ! effective transport
       DO jk = 1, jpkm1
-#if defined key_trcbbl_adv                                      
-         !                                                ! eulerian + bbl transport
-         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * ( un(:,:,jk) - u_trc_bbl(:,:,jk) )
-         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * ( vn(:,:,jk) - v_trc_bbl(:,:,jk) )
-         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * ( wn(:,:,jk) + w_trc_bbl(:,:,jk) )
-#else
          !                                                ! eulerian transport only
-         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) *   un(:,:,jk)
-         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) *   vn(:,:,jk)
-         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      *   wn(:,:,jk)
-#endif
+         zun(:,:,jk) = e2u(:,:) * fse3u(:,:,jk) * un(:,:,jk)
+         zvn(:,:,jk) = e1v(:,:) * fse3v(:,:,jk) * vn(:,:,jk)
+         zwn(:,:,jk) = e1t(:,:) * e2t(:,:)      * wn(:,:,jk)
+         !
       END DO
       zwn(:,:,jpk) = 0.e0                                 ! no transport trough the bottom
 
       !                                                   ! add the eiv transport (if necessary)
-      IF( lk_trcldf_eiv )   CALL trc_adv_eiv( kt, zun, zvn, zwn )
-
-      CALL tra_adv_cen2( kt, 'TRC', zun, zvn, zwn, trb, trn, tra )    ! 2nd order centered
-}}}
-
-[[BR]]
+      IF( lk_traldf_eiv )   CALL tra_adv_eiv( kt, zun, zvn, zwn, 'TRC' )
+
+      CALL tra_adv_cen2( kt, 'TRC', zun, zvn, zwn, trb, trn, tra, jptra )    ! 2nd order centered
+}}}
+
+[[BR]]
+
 
 '''(4)''' Final step : replace T and S 3D arrays by 4D arrays TS throughout the code  [[BR]][[BR]]
@@ -141 +237 @@
 '''Additional Tasks'''[[BR]]
 [[BR]]
-- TRENDS[[BR]]
-   * Split the OPA_SRC/TRD/trmod.F90 module in 2 modules
-      * trends_dyn.F90 which manages dynamical trend diagnostics
-      * trends_tra.F90 for the tracers trend diagnostics
-   * As a starting point, both active & passive tracers trends modules ( trdmld.F90 & trdmld_trc.F90 ) will be encapsulate in one module
-[[BR]]
-- OBC[[BR]]
-    * rewrite the radiative OBC with 4D array as input argument. OBC will be then available for passive tracers
-----
+ - TRENDS : As a starting point, both active & passive tracers trends modules ( trdmld.F90 & trdmld_trc.F90 ) will be encapsulate in one module
+
 === Testing ===
 Testing could consider (where appropriate) other configurations in addition to NVTK].