Changeset 12537 for NEMO/branches/2019/dev_r11708_aumont_PISCES_QUOTA/src/TOP/PISCES/P4Z/p4zsink.F90

Timestamp:

2020-03-11T16:02:54+01:00 (4 years ago)

Author:

aumont

Message:

Comments in routines have been revised and significantly augmented

File:

• NEMO/branches/2019/dev_r11708_aumont_PISCES_QUOTA/src/TOP/PISCES/P4Z/p4zsink.F90 (modified) (11 diffs)

NEMO/branches/2019/dev_r11708_aumont_PISCES_QUOTA/src/TOP/PISCES/P4Z/p4zsink.F90

@@ -2 +2 @@
    !!======================================================================
    !!                         ***  MODULE p4zsink  ***
-   !! TOP :  PISCES  vertical flux of particulate matter due to gravitational sinking
+   !! TOP :  PISCES  vertical flux of particulate matter due to 
+   !!        gravitational sinking
+   !!        This module is the same for both PISCES and PISCES-QUOTA
    !!======================================================================
    !! History :   1.0  !  2004     (O. Aumont) Original code
@@ -8 +10 @@
    !!             3.4  !  2011-06  (O. Aumont, C. Ethe) Change aggregation formula
    !!             3.5  !  2012-07  (O. Aumont) Introduce potential time-splitting
+   !!             4.0  !  2019     (O. Aumont) an external subroutine is called
+   !!                                          to compute the impact of sinking
    !!----------------------------------------------------------------------
    !!   p4z_sink       :  Compute vertical flux of particulate matter due to gravitational sinking
@@ -25 +29 @@
 
    PUBLIC   p4z_sink         ! called in p4zbio.F90
-   PUBLIC   p4z_sink_init    ! called in trcsms_pisces.F90
-   PUBLIC   p4z_sink_alloc
+   PUBLIC   p4z_sink_init    ! called in trcini_pisces.F90
+   PUBLIC   p4z_sink_alloc   ! called in trcini_pisces.F90
 
    REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sinking, sinking2  !: POC sinking fluxes 
    !                                                          !  (different meanings depending on the parameterization)
-   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sinkingn, sinking2n  !: POC sinking fluxes 
-   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sinkingp, sinking2p  !: POC sinking fluxes 
+   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sinkingn, sinking2n  !: PON sinking fluxes 
+   REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sinkingp, sinking2p  !: POP sinking fluxes 
    REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sinkcal, sinksil   !: CaCO3 and BSi sinking fluxes
    REAL(wp), PUBLIC, ALLOCATABLE, SAVE, DIMENSION(:,:,:) ::   sinkfer            !: Small BFe sinking fluxes
@@ -45 +49 @@
 CONTAINS
 
-   !!----------------------------------------------------------------------
-   !!   'standard sinking parameterisation'                  ???
-   !!----------------------------------------------------------------------
-
    SUBROUTINE p4z_sink ( kt, knt )
       !!---------------------------------------------------------------------
@@ -54 +54 @@
       !!
       !! ** Purpose :   Compute vertical flux of particulate matter due to 
-      !!                gravitational sinking
-      !!
-      !! ** Method  : - ???
+      !!                gravitational sinking. 
+      !!
+      !! ** Method  : - An external advection subroutine is called to compute
+      !!                the impact of sinking on the particles. The tracers
+      !!                concentrations are updated in this subroutine which
+      !!                is mandatory to deal with negative concentrations
       !!---------------------------------------------------------------------
       INTEGER, INTENT(in) :: kt, knt
@@ -75 +78 @@
       consgoc(:,:,:) = 0.
 
-      !
-      !    Sinking speeds of detritus is increased with depth as shown
-      !    by data and from the coagulation theory
-      !    -----------------------------------------------------------
+      ! Sinking speeds of big detritus is increased with depth as shown
+      ! by data and from the coagulation theory. This is controled by
+      ! wsbio2max and wsbio2scale. If wsbio2max is set to wsbio2, then
+      ! sinking speed is constant with depth.
+      ! CaCO3 and bSi are supposed to sink at the big particles speed 
+      ! due to their high density
+      ! ---------------------------------------------------------------
       DO jk = 1, jpkm1
          DO jj = 1, jpj
@@ -89 +95 @@
       END DO
 
-      ! limit the values of the sinking speeds to avoid numerical instabilities  
+      ! Sinking speed of the small particles is constant
       wsbio3(:,:,:) = wsbio
 
-      !
-      !  Initializa to zero all the sinking arrays 
-      !   -----------------------------------------
+      ! Initialize to zero all the sinking arrays 
+      ! -----------------------------------------
       sinking (:,:,:) = 0.e0
       sinking2(:,:,:) = 0.e0
@@ -102 +107 @@
       sinkfer2(:,:,:) = 0.e0
 
-      !   Compute the sedimentation term using p4zsink2 for all the sinking particles
-      !   -----------------------------------------------------
+      ! Compute the sedimentation term using trc_sink for all the sinking particles
+      ! ---------------------------------------------------------------------------
       CALL trc_sink( kt, wsbio3, sinking , jppoc, rfact2 )
       CALL trc_sink( kt, wsbio3, sinkfer , jpsfe, rfact2 )
@@ -111 +116 @@
       CALL trc_sink( kt, wsbio4, sinkcal , jpcal, rfact2 )
 
+      ! PISCES-QUOTA part
       IF( ln_p5z ) THEN
          sinkingn (:,:,:) = 0.e0
@@ -117 +123 @@
          sinking2p(:,:,:) = 0.e0
 
-         !   Compute the sedimentation term using p4zsink2 for all the sinking particles
-         !   -----------------------------------------------------
+         ! Compute the sedimentation term using trc_sink for all the sinking particles
+         ! ---------------------------------------------------------------------------
          CALL trc_sink( kt, wsbio3, sinkingn , jppon, rfact2 )
          CALL trc_sink( kt, wsbio3, sinkingp , jppop, rfact2 )
@@ -186 +192 @@
       !!----------------------------------------------------------------------
       !!                  ***  ROUTINE p4z_sink_init  ***
+      !!
+      !! ** Purpose :   Initialization of sinking parameters
+      !!
+      !! ** Method  :   
+      !!
+      !! ** input   :   
       !!----------------------------------------------------------------------
       INTEGER :: jk