!

! $Id: flott_gwd_rando_m.F90 3531 2019-06-06 15:08:45Z fairhead $

!

module FLOTT_GWD_rando_m

  implicit none

contains

    ! Parametrization of the momentum flux deposition due to a discrete

    ! number of gravity waves.

    ! Author: F. Lott

    ! July, 12th, 2012

    ! Gaussian distribution of the source, source is precipitation

    ! Reference: Lott (JGR, vol 118, page 8897, 2013)

    !ONLINE:

      use dimphy, only: klon, klev

      use assert_m, only: assert

      USE ioipsl_getin_p_mod, ONLY : getin_p

      USE vertical_layers_mod, ONLY : presnivs

      CHARACTER (LEN=20) :: modname='flott_gwd_rando'

      CHARACTER (LEN=80) :: abort_message

      include "YOMCST.h"

      include "clesphys.h"

    ! OFFLINE:

    ! include "dimensions.h"

    ! include "dimphy.h"

    ! END OF DIFFERENCE ONLINE-OFFLINE

    include "YOEGWD.h"

    ! 0. DECLARATIONS:

    ! 0.1 INPUTS

    REAL, intent(in)::DTIME ! Time step of the Physics

    REAL, intent(in):: pp(:, :) ! (KLON, KLEV) Pressure at full levels

    REAL, intent(in):: prec(:) ! (klon) Precipitation (kg/m^2/s)

    REAL, intent(in):: TT(:, :) ! (KLON, KLEV) Temp at full levels

    REAL, intent(in):: UU(:, :) ! (KLON, KLEV) Zonal wind at full levels

    REAL, intent(in):: VV(:, :) ! (KLON, KLEV) Merid wind at full levels

    ! 0.2 OUTPUTS

    REAL, intent(out):: zustr(:), zvstr(:) ! (KLON) Surface Stresses

    REAL, intent(inout):: d_u(:, :), d_v(:, :)

    REAL, intent(inout):: east_gwstress(:, :) !  Profile of eastward stress

    REAL, intent(inout):: west_gwstress(:, :) !  Profile of westward stress

    ! (KLON, KLEV) tendencies on winds

    ! O.3 INTERNAL ARRAYS

    REAL DZ   !  Characteristic depth of the Source

    INTEGER II, JJ, LL

    ! 0.3.0 TIME SCALE OF THE LIFE CYCLE OF THE WAVES PARAMETERIZED

    REAL DELTAT

    ! 0.3.1 GRAVITY-WAVES SPECIFICATIONS

    INTEGER, PARAMETER:: NK = 2, NP = 2, NO = 2, NW = NK * NP * NO

    INTEGER JK, JP, JO, JW

    INTEGER, PARAMETER:: NA = 5  !number of realizations to get the phase speed

    REAL KMIN, KMAX ! Min and Max horizontal wavenumbers

    REAL CMAX ! standard deviation of the phase speed distribution

    REAL RUWMAX,SAT  ! ONLINE SPECIFIED IN run.def

    REAL CPHA ! absolute PHASE VELOCITY frequency

    ! Waves Intr. freq. at the 1/2 lev surrounding the full level

    ! Wave EP-fluxes at the 2 semi levels surrounding the full level

    ! Fluxes X and Y for each waves at 1/2 Levels

    INTEGER LAUNCH, LTROP ! Launching altitude and tropo altitude

    REAL XLAUNCH ! Controle the launching altitude

    REAL XTROP ! SORT of Tropopause altitude

    REAL PRMAX ! Maximum value of PREC, and for which our linear formula

    ! for GWs parameterisation apply

    ! 0.3.2 PARAMETERS OF WAVES DISSIPATIONS

    REAL RDISS, ZOISEC ! COEFF DE DISSIPATION, SECURITY FOR INTRINSIC FREQ

    ! 0.3.3 BACKGROUND FLOW AT 1/2 LEVELS AND VERTICAL COORDINATE

    REAL H0 ! Characteristic Height of the atmosphere

    REAL PR, TR ! Reference Pressure and Temperature

    REAL PSEC ! Security to avoid division by 0 pressure

    REAL BVSEC ! Security to avoid negative BVF

    REAL RAN_NUM_1,RAN_NUM_2,RAN_NUM_3

    LOGICAL, SAVE :: gwd_reproductibilite_mpiomp=.true.

    LOGICAL, SAVE :: firstcall = .TRUE.

  !$OMP THREADPRIVATE(firstcall,gwd_reproductibilite_mpiomp)

    ! Cle introduite pour resoudre un probleme de non reproductibilite

    ! Le but est de pouvoir tester de revenir a la version precedenete

    ! A eliminer rapidement

    ENDIF

  ENDIF

    !-----------------------------------------------------------------

    ! 1. INITIALISATIONS

    ! 1.1 Basic parameter

    ! Are provided from elsewhere (latent heat of vaporization, dry

    ! gaz constant for air, gravity constant, heat capacity of dry air

    ! at constant pressure, earth rotation rate, pi).

    ! 1.2 Tuning parameters of V14

    RDISS = 0.5 ! Diffusion parameter

    ! ONLINE

    !END ONLINE

    ! OFFLINE

    ! RUWMAX= 1.75    ! Launched flux

    ! SAT=0.25     ! Saturation parameter

    ! END OFFLINE

    PRMAX = 20. / 24. /3600.

    ! maximum of rain for which our theory applies (in kg/m^2/s)

 ! Characteristic depth of the source

    DZ = 1000.

    XLAUNCH=0.5 ! Parameter that control launching altitude

    XTROP=0.2 ! Parameter that control tropopause altitude

    DELTAT=24.*3600. ! Time scale of the waves (first introduced in 9b)

    !  OFFLINE

    !  DELTAT=DTIME

    !  END OFFLINE

    KMIN = 2.E-5

    ! minimum horizontal wavenumber (inverse of the subgrid scale resolution)

    KMAX = 1.E-3 ! Max horizontal wavenumber

    CMAX = 30. ! Max phase speed velocity

    TR = 240. ! Reference Temperature

    PR = 101300. ! Reference pressure

    BVSEC = 5.E-3 ! Security to avoid negative BVF

    PSEC = 1.E-6 ! Security to avoid division by 0 pressure

    ZOISEC = 1.E-6 ! Security FOR 0 INTRINSIC FREQ

IF (1==0) THEN

    !ONLINE

        call assert(klon == (/size(pp, 1), size(tt, 1), size(uu, 1), &

         size(vv, 1), size(zustr), size(zvstr), size(d_u, 1), &

         size(d_v, 1), &

         size(east_gwstress, 1), size(west_gwstress, 1) /), &

         "FLOTT_GWD_RANDO klon")

     call assert(klev == (/size(pp, 2), size(tt, 2), size(uu, 2), &

          size(vv, 2), size(d_u, 2), size(d_v, 2), &

          size(east_gwstress,2), size(west_gwstress,2) /), &

          "FLOTT_GWD_RANDO klev")

    !END ONLINE

ENDIF

    ENDIF

    ENDIF

    ! 2. EVALUATION OF THE BACKGROUND FLOW AT SEMI-LEVELS

    ! Pressure and Inv of pressure

    end DO

    ! Launching altitude

    !Pour revenir a la version non reproductible en changeant le nombre de process

       ! Reprend la formule qui calcule PH en fonction de PP=play

       end DO

    ELSE

    ENDIF

    LAUNCH=0

    LTROP =0

    ENDDO

    ENDDO

    !LAUNCH=22 ; LTROP=33

!   print*,'LAUNCH=',LAUNCH,'LTROP=',LTROP

    ! Log pressure vert. coordinate

    end DO

    ! BV frequency

       ! BVSEC: BV Frequency (UH USED IS AS A TEMPORARY ARRAY DOWN TO WINDS)

       UH(:, LL) = 0.5 * (TT(:, LL) + TT(:, LL - 1)) &

            * RD**2 / RCPD / H0**2 + (TT(:, LL) &

    end DO

    BVLOW(:) = 0.5 * (TT(:, LTROP )+ TT(:, LAUNCH)) &

         * RD**2 / RCPD / H0**2 + (TT(:, LTROP ) &

    ! SMOOTHING THE BV HELPS

    end DO

    ! WINDS

    end DO

    ! 3 WAVES CHARACTERISTICS CHOSEN RANDOMLY AT THE LAUNCH ALTITUDE

    ! The mod functions of weird arguments are used to produce the

    ! waves characteristics in an almost stochastic way

             ! Angle

                ! Angle (0 or PI so far)

                ZP(JW, II) = (SIGN(1., 0.5 - RAN_NUM_1) + 1.) &

                ! Horizontal wavenumber amplitude

                ! Horizontal phase speed

                CPHA = 0.

                    CPHA = CPHA + &

                END DO

                ENDIF

                ! Absolute frequency is imposed

                ! Intrinsic frequency is imposed

                ZO(JW, II) = ZO(JW, II) &

                     + ZK(JW, II) * COS(ZP(JW, II)) * UH(II, LAUNCH) &

                ! Momentum flux at launch lev

             ENDDO

    ENDDO

    ! 4. COMPUTE THE FLUXES

    ! 4.1 Vertical velocity at launching altitude to ensure

    ! the correct value to the imposed fluxes.

       ! Evaluate intrinsic frequency at launching altitude:

       ZOP(JW, :) = ZO(JW, :) &

            - ZK(JW, :) * COS(ZP(JW, :)) * UH(:, LAUNCH) &

       ! VERSION WITH CONVECTIVE SOURCE

       ! Vertical velocity at launch level, value to ensure the

       ! imposed factor related to the convective forcing:

       ! precipitations.

       ! tanh limitation to values above prmax:

       WWP(JW, :) = RUW0(JW, :) &

       ! Factor related to the characteristics of the waves:

       WWP(JW, :) = WWP(JW, :) * ZK(JW, :)**3 / KMIN / BVLOW(:)  &

       ! Moderation by the depth of the source (dz here):

       WWP(JW, :) = WWP(JW, :) &

            * EXP(- BVLOW(:)**2 / MAX(ABS(ZOP(JW, :)), ZOISEC)**2 * ZK(JW, :)**2 &

       ! Put the stress in the right direction:

       RUWP(JW, :) = ZOP(JW, :) / MAX(ABS(ZOP(JW, :)), ZOISEC)**2 &

       RVWP(JW, :) = ZOP(JW, :) / MAX(ABS(ZOP(JW, :)), ZOISEC)**2 &

    end DO

    ! 4.2 Uniform values below the launching altitude

       end DO

    end DO

    ! 4.3 Loop over altitudes, with passage from one level to the next

    ! done by i) conserving the EP flux, ii) dissipating a little,

    ! iii) testing critical levels, and vi) testing the breaking.

       ! Warning: all the physics is here (passage from one level

       ! to the next)

          ! Intrinsic Frequency

          ZOP(JW, :) = ZO(JW, :) - ZK(JW, :) * COS(ZP(JW, :)) * UH(:, LL + 1) &

          ! No breaking (Eq.6)

          ! Dissipation (Eq. 8)

          WWP(JW, :) = WWM(JW, :) * EXP(- 4. * RDISS * PR / (PH(:, LL + 1) &

               + PH(:, LL)) * ((BV(:, LL + 1) + BV(:, LL)) / 2.)**3 &

               / MAX(ABS(ZOP(JW, :) + ZOM(JW, :)) / 2., ZOISEC)**4 &

          ! Critical levels (forced to zero if intrinsic frequency changes sign)

          ! Saturation (Eq. 12)

          WWP(JW, :) = min(WWP(JW, :), MAX(0., &

               SIGN(1., ZOP(JW, :) * ZOM(JW, :))) * ABS(ZOP(JW, :))**3 &

               / BV(:, LL + 1) * EXP(- ZH(:, LL + 1) / H0) * KMIN**2  &

       end DO

       ! Evaluate EP-flux from Eq. 7 and give the right orientation to

       ! the stress

       end DO

       end DO

    end DO

! OFFLINE ONLY

!   PRINT *,'SAT PROFILE:'

!   DO LL=1,KLEV

!   PRINT *,ZH(KLON/2,LL)/1000.,SAT*(2.+TANH(ZH(KLON/2,LL)/H0-8.))

!   ENDDO

    ! 5 CALCUL DES TENDANCES:

    ! 5.1 Rectification des flux au sommet et dans les basses couches

    end DO

    ! AR-1 RECURSIVE FORMULA (13) IN VERSION 4

       D_U(:, LL) = (1.-DTIME/DELTAT) * D_U(:, LL) + DTIME/DELTAT/REAL(NW) * &

            RG * (RUW(:, LL + 1) - RUW(:, LL)) &

       ! NO AR-1 FOR MERIDIONAL TENDENCIES

       D_V(:, LL) =                                            1./REAL(NW) * &

            RG * (RVW(:, LL + 1) - RVW(:, LL)) &

    ENDDO

    ! Cosmetic: evaluation of the cumulated stress

    ENDDO

end module FLOTT_GWD_rando_m