Changeset 1897 for trunk/LMDZ.TITAN/libf/muphytitan/mmp_gcm.f90

Timestamp:

Jan 24, 2018, 10:24:24 PM (7 years ago)

Author:

jvatant

Message:

Making Titan's hazy again - part II
+ Major updates of J.Burgalat YAMMS library and optical coupling, including :
++ Added the routines for haze optics inside YAMMS
++ Calling rad. transf. with interactive haze is plugged
in but should stay unactive as long as the microphysics is
in test phase : cf "uncoupl_optic_haze" flag : true for now !
++ Also some sanity checks for negative tendencies and
some others upkeep of YAMMS model
+ Also added a temporary CPP key USE_QTEST in physiq_mod
that enables to have microphysical tendencies separated
from dynamics for debugging and test phases
-- JVO and JB

File:

• trunk/LMDZ.TITAN/libf/muphytitan/mmp_gcm.f90 (modified) (6 diffs)

trunk/LMDZ.TITAN/libf/muphytitan/mmp_gcm.f90

@@ +1 @@
+! Copyright 2017 Université de Reims Champagne-Ardenne 
+! Contributor: J. Burgalat (GSMA, URCA)
+! email of the author : jeremie.burgalat@univ-reims.fr
+! 
+! This software is a computer program whose purpose is to compute
+! microphysics processes using a two-moments scheme.
+! 
+! This library is governed by the CeCILL license under French law and
+! abiding by the rules of distribution of free software.  You can  use, 
+! modify and/ or redistribute the software under the terms of the CeCILL
+! license as circulated by CEA, CNRS and INRIA at the following URL
+! "http://www.cecill.info". 
+! 
+! As a counterpart to the access to the source code and  rights to copy,
+! modify and redistribute granted by the license, users are provided only
+! with a limited warranty  and the software's author,  the holder of the
+! economic rights,  and the successive licensors  have only  limited
+! liability. 
+! 
+! In this respect, the user's attention is drawn to the risks associated
+! with loading,  using,  modifying and/or developing or reproducing the
+! software by the user in light of its specific status of free software,
+! that may mean  that it is complicated to manipulate,  and  that  also
+! therefore means  that it is reserved for developers  and  experienced
+! professionals having in-depth computer knowledge. Users are therefore
+! encouraged to load and test the software's suitability as regards their
+! requirements in conditions enabling the security of their systems and/or 
+! data to be ensured and,  more generally, to use and operate it in the 
+! same conditions as regards security. 
+! 
+! The fact that you are presently reading this means that you have had
+! knowledge of the CeCILL license and that you accept its terms.
+
+!! file: mmp_gcm.f90
+!! summary: YAMMS interfaces for the LMDZ GCM.
+!! author: J. Burgalat
+!! date: 2017
 MODULE MMP_GCM
   !! Interface to YAMMS for the LMDZ GCM.
+  USE MMP_GLOBALS
   USE MM_LIB
   USE CFGPARSE
@@ -6 +44 @@
   IMPLICIT NONE
 
-  PUBLIC
-
-  !> Alpha function parameters. 
-  !!
-  !! It stores the parameters of the inter-moments relation functions.
-  !! 
-  !! The inter-moments relation function is represented by the sum of exponential
-  !! quadratic expressions:
-  !!
-  !! $$ 
-  !! \displaystyle \alpha(k) = \sum_{i=1}^{n} \exp\left( a_{i}\times k^{2} + 
-  !! b_{i}\times k^{2} +c_{i}\right) 
-  !! $$
-  TYPE, PUBLIC :: aprm
-    !> Quadratic coefficients of the quadratic expressions.
-    REAL(kind=mm_wp), DIMENSION(:), ALLOCATABLE :: a
-    !> Linear coefficients of the quadratic expressions.
-    REAL(kind=mm_wp), DIMENSION(:), ALLOCATABLE :: b
-    !> Free term of the quadratic expressions.
-    REAL(kind=mm_wp), DIMENSION(:), ALLOCATABLE :: c
-  END TYPE
-
-  !> Size distribution parameters derived type.
-  !!
-  !! It stores the parameters of the size distribution law for Titan.
-  !! 
-  !! The size distribution law is represented by the minimization of a sum of
-  !! power law functions:
-  !!
-  !! $$ 
-  !! \displaystyle n\left(r\right) = \frac{A_{0}}{C+\sum_{i=1}^{n} A_{i}\times
-  !!                                    \left(\frac{r}{r_{c}}\right)^{-b_{i}}}
-  !! $$
-  TYPE, PUBLIC :: nprm
-    !> Scaling factor.
-    REAL(kind=mm_wp)                            :: a0
-    !> Characterisitic radius.
-    REAL(kind=mm_wp)                            :: rc
-    !> Additional constant to the sum of power law.
-    REAL(kind=mm_wp)                            :: c
-    !> Scaling factor of each power law.
-    REAL(kind=mm_wp), DIMENSION(:), ALLOCATABLE :: a
-    !> Power of each power law.
-    REAL(kind=mm_wp), DIMENSION(:), ALLOCATABLE :: b
-  END TYPE 
-
-  !> Inter-moment relation set of parameters for the spherical mode.
-  TYPE(aprm), PUBLIC, SAVE :: mmp_asp
-  !> Inter-moment relation set of parameters for the fractal mode.
-  TYPE(aprm), PUBLIC, SAVE :: mmp_afp
-
-  !> Size-distribution law parameters of the spherical mode.
-  TYPE(nprm), PUBLIC, SAVE :: mmp_pns
-  !> Size-distribution law parameters of the fractal mode.
-  TYPE(nprm), PUBLIC, SAVE :: mmp_pnf
-
-  !> Data set for @f$<Q>_{SF}^{M0}@f$.
-  TYPE(dset2d), PUBLIC, SAVE, TARGET             :: mmp_qbsf0
-  !> Extended values of [[mmp_gcm(module):mmp_qbsf0(variable)]] dataset.
-  REAL(kind=mm_wp), PUBLIC, SAVE, DIMENSION(2,2) :: mmp_qbsf0_e
-  !> Data set for @f$<Q>_{SF}^{M3}@f$.
-  TYPE(dset2d), PUBLIC, SAVE, TARGET             :: mmp_qbsf3
-  !> Extended values of [[mmp_gcm(module):mmp_qbsf3(variable)]] dataset.
-  REAL(kind=mm_wp), PUBLIC, SAVE, DIMENSION(2,2) :: mmp_qbsf3_e
-  !> Data set for @f$<Q>_{FF}^{M0}@f$.
-  TYPE(dset2d), PUBLIC, SAVE, TARGET             :: mmp_qbff0
-  !> Extended values of [[mmp_gcm(module):mmp_qbff0(variable)]] dataset.
-  REAL(kind=mm_wp), PUBLIC, SAVE, DIMENSION(2,2) :: mmp_qbff0_e
-  
-  !> Data set for linear interpolation of transfert probability (M0/CO).
-  TYPE(dset1d), PUBLIC, SAVE, TARGET :: mmp_pco0p
-  !> Data set for linear interpolation of transfert probability (M3/CO).
-  TYPE(dset1d), PUBLIC, SAVE, TARGET :: mmp_pco3p
-  !> Data set for linear interpolation of transfert probability (M0/FM).
-  TYPE(dset1d), PUBLIC, SAVE, TARGET :: mmp_pfm0p
-  !> Data set for linear interpolation of transfert probability (M3/FM). 
-  TYPE(dset1d), PUBLIC, SAVE, TARGET :: mmp_pfm3p
-
-  !> \(b_{0}^{t}\) coefficients for Free-molecular regime kernel approximation.
-  REAL(kind=mm_wp), PUBLIC, SAVE, DIMENSION(5) :: mmp_bt0 = (/1._mm_wp,1._mm_wp,1._mm_wp,1._mm_wp,1._mm_wp/)
-  !> \(b_{3}^{t}\) coefficients for Free-molecular regime kernel approximation.
-  REAL(kind=mm_wp), PUBLIC, SAVE, DIMENSION(5) :: mmp_bt3 = (/1._mm_wp,1._mm_wp,1._mm_wp,1._mm_wp,1._mm_wp/)
-
-  !> Spherical probability transfert control flag.
-  LOGICAL, SAVE :: mmp_w_ps2s = .true.
-  !> Aerosol electric charge correction control flag.
-  LOGICAL, SAVE :: mmp_w_qe   = .true.
-
-
   CONTAINS 
     
-  SUBROUTINE abort_program(err)
-    !! Dump error message and abort the program.
-    TYPE(error), INTENT(in) :: err !! Error object.
-    WRITE(stderr,'(a)') "ERROR: "//TRIM(err%msg) 
-    CALL EXIT(err%id)
-  END SUBROUTINE abort_program
-
-
-  SUBROUTINE mmp_initialize(dt,df,rm,rho_aer,p_prod,tx_prod,rc_prod,rplanet,g0, air_rad,air_mmol,clouds,cfgpath)
+  SUBROUTINE mmp_initialize(dt,p_prod,tx_prod,rc_prod,rplanet,g0, air_rad,air_mmol,clouds,cfgpath)
     !! Initialize global parameters of the model.
     !! 
@@ -112 +53 @@
     !! default values are suitable for production runs.  
     !! @note
-    !! If the method fails to initialize parameters (i.e. returned error is not 0). Then the model
-    !! should probably be aborted as the global variables of the model will not be correctly setup.
+    !! If the subroutine fails to initialize parameters, the run is aborted.
     !!
     !! @warning
@@ -119 +59 @@
     !! initializes global variable that are not thread private.
     !!
-    !! '''
+    !! ```
     !! !$OMP SINGLE
     !! call mmp_initialize(...)
     !! !$OMP END SINGLE
+    !! ```
     !!
     REAL(kind=mm_wp), INTENT(in)           :: dt
       !! Microphysics timestep in seconds.
-    REAL(kind=mm_wp), INTENT(in)           :: df
-      !! Fractal dimension of fractal aerosol.
-    REAL(kind=mm_wp), INTENT(in)           :: rm
-      !! Monomer radius in meter.
-    REAL(kind=mm_wp), INTENT(in)           :: rho_aer
-      !! Aerosol density in \(kg.m^{-3}\).
     REAL(kind=mm_wp), INTENT(in)           :: p_prod
       !!  Aerosol production pressure level in Pa.
@@ -151 +86 @@
       !! Internal microphysic configuration file.
 
-    INTEGER          :: coag_choice
-    REAL(kind=mm_wp) :: fiad_max, fiad_min
-    LOGICAL          :: w_h_prod, w_h_sed, w_h_coag, w_c_sed, w_c_nucond, &
-                        no_fiadero, fwsed_m0, fwsed_m3
-    TYPE(error)      :: err
+    INTEGER                                           :: coag_choice
+    REAL(kind=mm_wp)                                  :: fiad_max, fiad_min,df,rm,rho_aer
+    LOGICAL                                           :: w_h_prod, w_h_sed, w_h_coag, w_c_sed, w_c_nucond, &
+                                                         no_fiadero, fwsed_m0, fwsed_m3
+    TYPE(error)                                       :: err
     INTEGER                                           :: i
     TYPE(cfgparser)                                   :: cparser
@@ -186 +121 @@
    
     ! YAMMS internal parameters:
+    err = mm_check_opt(cfg_get_value(cparser,"rm",rm),rm,50e-9_mm_wp,mm_log)
+    err = mm_check_opt(cfg_get_value(cparser,"df",df),df,2._mm_wp,mm_log)
+    err = mm_check_opt(cfg_get_value(cparser,"rho_aer",rho_aer),rho_aer,1000._mm_wp,mm_log)
     ! the following parameters are primarily used to test and debug YAMMS.
     ! They are set in an optional configuration file and default to suitable values for production runs.