Newer
Older
!MNH_LIC Copyright 1994-2014 CNRS, Meteo-France and Universite Paul Sabatier
!MNH_LIC This is part of the Meso-NH software governed by the CeCILL-C licence
!MNH_LIC version 1. See LICENSE, CeCILL-C_V1-en.txt and CeCILL-C_V1-fr.txt
!MNH_LIC for details. version 1.
!-----------------------------------------------------------------
!--------------- special set of characters for RCS information
!-----------------------------------------------------------------
! $Source$ $Revision$
!-----------------------------------------------------------------
! ###########################
MODULE MODI_TKE_EPS_SOURCES
! ###########################
INTERFACE
!
SUBROUTINE TKE_EPS_SOURCES(KKA,KKU,KKL,KMI,PTKEM,PLM,PLEPS,PDP,PTRH, &
PRHODJ,PDZZ,PDXX,PDYY,PDZX,PDZY,PZZ, &
PTSTEP,PIMPL,PEXPL, &
HTURBLEN,HTURBDIM, &
WAUTELET Philippe
committed
TPFILE,OCLOSE_OUT,OTURB_DIAG, &
PTP,PRTKES,PRTKESM, PRTHLS,PCOEF_DISS,PTR,PDISS )
WAUTELET Philippe
committed
USE MODD_IO_ll, ONLY: TFILEDATA
!
INTEGER, INTENT(IN) :: KKA !near ground array index
INTEGER, INTENT(IN) :: KKU !uppest atmosphere array index
INTEGER, INTENT(IN) :: KKL !vert. levels type 1=MNH -1=ARO
INTEGER, INTENT(IN) :: KMI ! model index number
REAL, DIMENSION(:,:,:), INTENT(IN) :: PTKEM ! TKE at t-deltat
REAL, DIMENSION(:,:,:), INTENT(IN) :: PLM ! mixing length
REAL, DIMENSION(:,:,:), INTENT(IN) :: PLEPS ! dissipative length
REAL, DIMENSION(:,:,:), INTENT(IN) :: PRHODJ ! density * grid volume
REAL, DIMENSION(:,:,:), INTENT(IN) :: PDXX,PDYY,PDZZ,PDZX,PDZY
! metric coefficients
REAL, DIMENSION(:,:,:), INTENT(IN) :: PZZ ! physical height w-pt
REAL, INTENT(IN) :: PEXPL, PIMPL ! Coef. temporal. disc.
CHARACTER*4, INTENT(IN) :: HTURBDIM ! dimensionality of the
! turbulence scheme
CHARACTER*4, INTENT(IN) :: HTURBLEN ! kind of mixing length
WAUTELET Philippe
committed
TYPE(TFILEDATA), INTENT(IN) :: TPFILE ! Output file
LOGICAL, INTENT(IN) :: OCLOSE_OUT ! switch for syncronous
! file opening
LOGICAL, INTENT(IN) :: OTURB_DIAG ! switch to write some
! diagnostic fields in the syncronous FM-file
WAUTELET Philippe
committed
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PDP ! Dyn. prod. of TKE
REAL, DIMENSION(:,:,:), INTENT(IN) :: PTRH
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PTP ! Ther. prod. of TKE
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PRTKES ! RHOD * Jacobian *
! TKE at t+deltat
REAL, DIMENSION(:,:,:), INTENT(IN) :: PRTKESM ! Advection source
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PRTHLS ! Source of Theta_l
REAL, DIMENSION(:,:,:), INTENT(IN) :: PCOEF_DISS ! 1/(Cph*Exner)
REAL, DIMENSION(:,:,:), INTENT(OUT) :: PTR ! Transport prod. of TKE
REAL, DIMENSION(:,:,:), INTENT(OUT) :: PDISS ! Dissipati prod. of TKE
!
!
!
END SUBROUTINE TKE_EPS_SOURCES
!
END INTERFACE
!
END MODULE MODI_TKE_EPS_SOURCES
!
! ##################################################################
SUBROUTINE TKE_EPS_SOURCES(KKA,KKU,KKL,KMI,PTKEM,PLM,PLEPS,PDP, &
PTRH,PRHODJ,PDZZ,PDXX,PDYY,PDZX,PDZY,PZZ, &
PTSTEP,PIMPL,PEXPL, &
HTURBLEN,HTURBDIM, &
WAUTELET Philippe
committed
TPFILE,OCLOSE_OUT,OTURB_DIAG, &
PTP,PRTKES,PRTKESM, PRTHLS,PCOEF_DISS,PTR,PDISS )
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
! ##################################################################
!
!
!!**** *TKE_EPS_SOURCES* - routine to compute the sources of the turbulent
!! evolutive variables: TKE and its dissipation when it is taken into
!! account. The contribution to the heating of tke dissipation is computed.
!!
!! PURPOSE
!! -------
! The purpose of this routine is to compute the sources necessary for
! the evolution of the turbulent kinetic energy and its dissipation
! if necessary.
!
!!** METHOD
!! ------
!! The vertical turbulent flux is computed in an off-centered
!! implicit scheme (a Crank-Nicholson type with coefficients different
!! than 0.5), which allows to vary the degree of implicitness of the
!! formulation.
!! In high resolution, the horizontal transport terms are also
!! calculated, but explicitly.
!! The evolution of the dissipation as a variable is made if
!! the parameter HTURBLEN is set equal to KEPS. The same reasoning
!! made for TKE applies.
!!
!! EXTERNAL
!! --------
!! GX_U_M,GY_V_M,GZ_W_M
!! GX_M_U,GY_M_V : Cartesian vertical gradient operators
!!
!! MXF,MXM.MYF,MYM,MZF,MZM: Shuman functions (mean operators)
!! DZF : Shuman functions (difference operators)
!!
!! SUBROUTINE TRIDIAG : to solve an implicit temporal scheme
!!
!!
!! IMPLICIT ARGUMENTS
!! ------------------
!! Module MODD_CST : contains physical constants
!!
!! XG : gravity constant
!!
!! Module MODD_CTURB: contains the set of constants for
!! the turbulence scheme
!!
!! XCET,XCED : transport and dissipation cts. for the TKE
!! XCDP,XCDD,XCDT: constants from the parameterization of
!! the K-epsilon equation
!! XTKEMIN,XEPSMIN : minimum values for the TKE and its
!! dissipation
!!
!! Module MODD_PARAMETERS:
!!
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
!! Module MODD_BUDGET:
!! NBUMOD : model in which budget is calculated
!! CBUTYPE : type of desired budget
!! 'CART' for cartesian box configuration
!! 'MASK' for budget zone defined by a mask
!! 'NONE' ' for no budget
!! NBUPROCCTR : process counter used for each budget variable
!! LBU_RTKE : logical for budget of RTKE (turbulent kinetic energy)
!! .TRUE. = budget of RTKE
!! .FALSE. = no budget of RTKE
!!
!!
!! REFERENCE
!! ---------
!! Book 2 of documentation (routine TKE_EPS_SOURCES)
!! Book 1 of documentation (Chapter: Turbulence)
!!
!! AUTHOR
!! ------
!! Joan Cuxart * INM and Meteo-France *
!!
!! MODIFICATIONS
!! -------------
!! Original August 23, 1994
!! Modifications: Feb 14, 1995 (J.Cuxart and J.Stein)
!! Doctorization and Optimization
!! June 29, 1995 (J.Stein) TKE budget
!! June 28, 1995 (J.Cuxart) Add LES tools
!! Modifications: February 29, 1996 (J. Stein) optimization
!! Modifications: May 6, 1996 (N. Wood) Extend some loops over
!! the outer points
!! Modifications: August 30, 1996 (P. Jabouille) calcul ZFLX at the
!! IKU level
!! October 10, 1996 (J.Stein) set Keff at t-deltat
!! Oct 8, 1996 (Cuxart,Sanchez) Var.LES: XETR_TF,XDISS_TF
!! December 20, 1996 (J.-P. Pinty) update the CALL BUDGET
!! November 24, 1997 (V. Masson) bug in <v'e>
!! removes the DO loops
!! Augu. 9, 1999 (J.Stein) TKE budget correction
!! Mar 07 2001 (V. Masson and J. Stein) remove the horizontal
!! turbulent transports of Tke computation
!! Nov 06, 2002 (V. Masson) LES budgets
!! July 20, 2003 (J.-P. Pinty P Jabouille) add the dissipative heating
!! May 2006 Remove KEPS
!! October 2009 (G. Tanguy) add ILENCH=LEN(YCOMMENT) after
!! change of YCOMMENT
!! 2012-02 Y. Seity, add possibility to run with reversed
!! vertical levels
!! 2015-01 (J. Escobar) missing get_halo(ZRES) for JPHEXT<> 1
!! J.Escobar : 15/09/2015 : WENO5 & JPHEXT <> 1
!! --------------------------------------------------------------------------
!
!* 0. DECLARATIONS
! ------------
!
USE MODD_CST
USE MODD_CONF
USE MODD_CTURB
WAUTELET Philippe
committed
USE MODD_IO_ll, ONLY: TFILEDATA
USE MODD_PARAMETERS
USE MODD_BUDGET
USE MODD_LES
USE MODD_DIAG_IN_RUN, ONLY : LDIAG_IN_RUN, XCURRENT_TKE_DISS
!
WAUTELET Philippe
committed
USE MODE_ll
USE MODE_FIELD, ONLY: TFIELDDATA, TYPEREAL
USE MODE_FMWRIT
!
USE MODI_GRADIENT_M
USE MODI_GRADIENT_U
USE MODI_GRADIENT_V
USE MODI_GRADIENT_W
USE MODI_SHUMAN
USE MODI_TRIDIAG
USE MODI_TRIDIAG_TKE
USE MODI_BUDGET
USE MODI_LES_MEAN_SUBGRID
!
USE MODD_ARGSLIST_ll, ONLY : LIST_ll
!
USE MODI_GET_HALO
!
IMPLICIT NONE
!
!
!* 0.1 declarations of arguments
!
!
INTEGER, INTENT(IN) :: KKA !near ground array index
INTEGER, INTENT(IN) :: KKU !uppest atmosphere array index
INTEGER, INTENT(IN) :: KKL !vert. levels type 1=MNH -1=ARO
INTEGER, INTENT(IN) :: KMI ! model index number
REAL, DIMENSION(:,:,:), INTENT(IN) :: PTKEM ! TKE at t-deltat
REAL, DIMENSION(:,:,:), INTENT(IN) :: PLM ! mixing length
REAL, DIMENSION(:,:,:), INTENT(IN) :: PLEPS ! dissipative length
REAL, DIMENSION(:,:,:), INTENT(IN) :: PRHODJ ! density * grid volume
REAL, DIMENSION(:,:,:), INTENT(IN) :: PDXX,PDYY,PDZZ,PDZX,PDZY
! metric coefficients
REAL, DIMENSION(:,:,:), INTENT(IN) :: PZZ ! physical height w-pt
REAL, INTENT(IN) :: PEXPL, PIMPL ! Coef. temporal. disc.
CHARACTER*4, INTENT(IN) :: HTURBDIM ! dimensionality of the
! turbulence scheme
CHARACTER*4, INTENT(IN) :: HTURBLEN ! kind of mixing length
WAUTELET Philippe
committed
TYPE(TFILEDATA), INTENT(IN) :: TPFILE ! Output file
LOGICAL, INTENT(IN) :: OCLOSE_OUT ! switch for syncronous
! file opening
LOGICAL, INTENT(IN) :: OTURB_DIAG ! switch to write some
! diagnostic fields in the syncronous FM-file
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PDP, PTRH ! Dyn. prod. of TKE
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PTP ! Ther. prod. of TKE
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PRTKES ! RHOD * Jacobian *
! TKE at t+deltat
REAL, DIMENSION(:,:,:), INTENT(INOUT):: PRTHLS ! Source of Theta_l
REAL, DIMENSION(:,:,:), INTENT(IN) :: PCOEF_DISS ! 1/(Cph*Exner)
REAL, DIMENSION(:,:,:), INTENT(IN) :: PRTKESM ! Advection source
REAL, DIMENSION(:,:,:), INTENT(OUT) :: PTR ! Transport prod. of TKE
REAL, DIMENSION(:,:,:), INTENT(OUT) :: PDISS ! Dissipati prod. of TKE
!
!
!
!* 0.2 declaration of local variables
!
REAL, DIMENSION(SIZE(PTKEM,1),SIZE(PTKEM,2),SIZE(PTKEM,3)):: &
ZA, & ! under diagonal elements of the tri-diagonal matrix involved
! in the temporal implicit scheme
ZRES, & ! treated variable at t+ deltat when the turbu-
! lence is the only source of evolution added to the ones
! considered in ZSOURCE. This variable is also used to
! temporarily store some diagnostics stored in FM file
ZFLX, & ! horizontal or vertical flux of the treated variable
ZSOURCE, & ! source of evolution for the treated variable
ZKEFF ! effectif diffusion coeff = LT * SQRT( TKE )
LOGICAL,DIMENSION(SIZE(PTKEM,1),SIZE(PTKEM,2),SIZE(PTKEM,3)) :: GTKENEG
! 3D mask .T. if TKE < XTKEMIN
INTEGER :: IIB,IIE,IJB,IJE,IKB,IKE
! Index values for the Beginning and End
! mass points of the domain
INTEGER :: IIU,IJU,IKU ! array size in the 3 dimensions
!
TYPE(LIST_ll), POINTER :: TZFIELDDISS_ll ! list of fields to exchange
INTEGER :: IINFO_ll ! return code of parallel routine
WAUTELET Philippe
committed
TYPE(TFIELDDATA) :: TZFIELD
!
!----------------------------------------------------------------------------
NULLIFY(TZFIELDDISS_ll)
!
!* 1. PRELIMINARY COMPUTATIONS
! ------------------------
!
CALL GET_INDICE_ll (IIB,IJB,IIE,IJE)
IIU=SIZE(PTKEM,1)
IJU=SIZE(PTKEM,2)
IKB=KKA+JPVEXT_TURB*KKL
IKE=KKU-JPVEXT_TURB*KKL
!
! compute the effective diffusion coefficient at the mass point
ZKEFF(:,:,:) = PLM(:,:,:) * SQRT(PTKEM(:,:,:))
!
!----------------------------------------------------------------------------
!
!* 2. TKE EQUATION
! ------------
!
!* 2.1 Horizontal turbulent explicit transport
!
!
! Complete the sources of TKE with the horizontal turbulent explicit transport
!
IF (HTURBDIM=='3DIM') THEN
WAUTELET Philippe
committed
PTR=PTRH
WAUTELET Philippe
committed
PTR=0.
END IF
!
!
!
!* 2.2 Explicit TKE sources except horizontal turbulent transport
!
!
! extrapolate the dynamic production with a 1/Z law from its value at the
! W(IKB+1) value stored in PDP(IKB) to the mass localization tke(IKB)
PDP(:,:,IKB) = PDP(:,:,IKB) * (1. + PDZZ(:,:,IKB+KKL)/PDZZ(:,:,IKB))
!
! Compute the source terms for TKE: ( ADVECtion + NUMerical DIFFusion + ..)
! + (Dynamical Production) + (Thermal Production) - (dissipation)
ZFLX(:,:,:) = XCED * SQRT(PTKEM(:,:,:)) / PLEPS(:,:,:)
ZSOURCE(:,:,:) = PRTKES(:,:,:) / PRHODJ(:,:,:) + PRTKESM(:,:,:) / PRHODJ(:,:,:) &
- PTKEM(:,:,:) / PTSTEP &
WAUTELET Philippe
committed
+ PDP(:,:,:) + PTP(:,:,:) + PTR(:,:,:) - PEXPL * ZFLX(:,:,:) * PTKEM(:,:,:)
!
!* 2.2 implicit vertical TKE transport
!
!
! Compute the vector giving the elements just under the diagonal for the
! matrix inverted in TRIDIAG
!
ZA(:,:,:) = - PTSTEP * XCET * &
MZM(KKA,KKU,KKL,ZKEFF) * MZM(KKA,KKU,KKL,PRHODJ) / PDZZ**2
!
! Compute TKE at time t+deltat: ( stored in ZRES )
!
CALL TRIDIAG_TKE(KKA,KKU,KKL,PTKEM,ZA,PTSTEP,PEXPL,PIMPL,PRHODJ,&
& ZSOURCE,PTSTEP*ZFLX,ZRES)
!
!* diagnose the dissipation
!
IF (LDIAG_IN_RUN) THEN
XCURRENT_TKE_DISS = ZFLX(:,:,:) * PTKEM(:,:,:) &
*(PEXPL*PTKEM(:,:,:) + PIMPL*ZRES(:,:,:))
CALL ADD3DFIELD_ll(TZFIELDDISS_ll,XCURRENT_TKE_DISS)
CALL UPDATE_HALO_ll(TZFIELDDISS_ll,IINFO_ll)
CALL CLEANLIST_ll(TZFIELDDISS_ll)
ENDIF
!
! TKE must be greater than its minimum value
!
! CL : Now done at the end of the time step in ADVECTION_METSV
!GTKENEG = ZRES <= XTKEMIN
!WHERE ( GTKENEG )
! ZRES = XTKEMIN
!END WHERE
!
IF ( LLES_CALL .OR. &
(OTURB_DIAG .AND. OCLOSE_OUT) ) THEN
!
! Compute the cartesian vertical flux of TKE in ZFLX
!
ZFLX(:,:,:) = - XCET * MZM(KKA,KKU,KKL,ZKEFF) * &
DZM(KKA,KKU,KKL,PIMPL * ZRES + PEXPL * PTKEM ) / PDZZ
!
ZFLX(:,:,IKB) = 0.
ZFLX(:,:,KKA) = 0.
!
! Compute the whole turbulent TRansport of TKE:
!
WAUTELET Philippe
committed
PTR(:,:,:)= PTR - DZF(KKA,KKU,KKL, MZM(KKA,KKU,KKL,PRHODJ) * ZFLX / PDZZ ) /PRHODJ
!
! Storage in the LES configuration
!
IF (LLES_CALL) THEN
CALL LES_MEAN_SUBGRID( MZF(KKA,KKU,KKL,ZFLX), X_LES_SUBGRID_WTke )
WAUTELET Philippe
committed
CALL LES_MEAN_SUBGRID( -PTR, X_LES_SUBGRID_ddz_WTke )
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
END IF
!
END IF
!
!* 2.4 stores the explicit sources for budget purposes
!
IF (LBUDGET_TKE) THEN
!
! add the dynamical production
!
PRTKES(:,:,:) = PRTKES(:,:,:) + PDP(:,:,:) * PRHODJ(:,:,:)
CALL BUDGET (PRTKES(:,:,:),5,'DP_BU_RTKE')
!
! add the thermal production
!
PRTKES(:,:,:) = PRTKES(:,:,:) + PTP(:,:,:) * PRHODJ(:,:,:)
CALL BUDGET (PRTKES(:,:,:),5,'TP_BU_RTKE')
!
! add the dissipation
!
PRTKES(:,:,:) = PRTKES(:,:,:) - XCED * SQRT(PTKEM(:,:,:)) / PLEPS(:,:,:) * &
(PEXPL*PTKEM(:,:,:) + PIMPL*ZRES(:,:,:)) * PRHODJ(:,:,:)
CALL BUDGET (PRTKES(:,:,:),5,'DISS_BU_RTKE')
END IF
!
!* 2.5 computes the final RTKE and stores the whole turbulent transport
! with the removal of the advection part
PRTKES(:,:,:) = ZRES(:,:,:) * PRHODJ(:,:,:) / PTSTEP - PRTKESM(:,:,:)
!
! stores the whole turbulent transport
!
IF (LBUDGET_TKE) CALL BUDGET (PRTKES(:,:,:),5,'TR_BU_RTKE')
!
!
!----------------------------------------------------------------------------
!
!* 3. COMPUTE THE DISSIPATIVE HEATING
! -------------------------------
!
PRTHLS(:,:,:) = PRTHLS(:,:,:) + XCED * SQRT(PTKEM(:,:,:)) / PLEPS(:,:,:) * &
(PEXPL*PTKEM(:,:,:) + PIMPL*ZRES(:,:,:)) * PRHODJ(:,:,:) * PCOEF_DISS(:,:,:)
!
!----------------------------------------------------------------------------
!
!* 4. STORES SOME DIAGNOSTICS
! -----------------------
!
WAUTELET Philippe
committed
PDISS(:,:,:) = -XCED * (PTKEM(:,:,:)**1.5) / PLEPS(:,:,:)
!
IF ( OTURB_DIAG .AND. OCLOSE_OUT ) THEN
!
! stores the dynamic production
!
WAUTELET Philippe
committed
TZFIELD%CMNHNAME = 'DP'
TZFIELD%CSTDNAME = ''
TZFIELD%CLONGNAME = 'MesoNH: DP'
TZFIELD%CUNITS = 'm2 s-3'
TZFIELD%CDIR = 'XY'
TZFIELD%CCOMMENT = 'X_Y_Z_DP'
TZFIELD%NGRID = 1
TZFIELD%NTYPE = TYPEREAL
TZFIELD%NDIMS = 3
WAUTELET Philippe
committed
CALL IO_WRITE_FIELD(TPFILE,TZFIELD,PDP)
!
! stores the thermal production
!
WAUTELET Philippe
committed
TZFIELD%CMNHNAME = 'TP'
TZFIELD%CSTDNAME = ''
TZFIELD%CLONGNAME = 'MesoNH: TP'
TZFIELD%CUNITS = 'm2 s-3'
TZFIELD%CDIR = 'XY'
TZFIELD%CCOMMENT = 'X_Y_Z_TP'
TZFIELD%NGRID = 1
TZFIELD%NTYPE = TYPEREAL
TZFIELD%NDIMS = 3
WAUTELET Philippe
committed
CALL IO_WRITE_FIELD(TPFILE,TZFIELD,PTP)
!
! stores the whole turbulent transport
!
WAUTELET Philippe
committed
TZFIELD%CMNHNAME = 'TR'
TZFIELD%CSTDNAME = ''
TZFIELD%CLONGNAME = 'MesoNH: TR'
TZFIELD%CUNITS = 'm2 s-3'
TZFIELD%CDIR = 'XY'
TZFIELD%CCOMMENT = 'X_Y_Z_TR'
TZFIELD%NGRID = 1
TZFIELD%NTYPE = TYPEREAL
TZFIELD%NDIMS = 3
WAUTELET Philippe
committed
CALL IO_WRITE_FIELD(TPFILE,TZFIELD,PTR)
!
! stores the dissipation of TKE
!
WAUTELET Philippe
committed
TZFIELD%CMNHNAME = 'DISS'
TZFIELD%CSTDNAME = ''
TZFIELD%CLONGNAME = 'MesoNH: DISS'
TZFIELD%CUNITS = 'm2 s-3'
TZFIELD%CDIR = 'XY'
TZFIELD%CCOMMENT = 'X_Y_Z_DISS'
TZFIELD%NGRID = 1
TZFIELD%NTYPE = TYPEREAL
TZFIELD%NDIMS = 3
WAUTELET Philippe
committed
CALL IO_WRITE_FIELD(TPFILE,TZFIELD,PDISS)
END IF
!
! Storage in the LES configuration of the Dynamic Production of TKE and
! the dissipation of TKE
!
IF (LLES_CALL ) THEN
WAUTELET Philippe
committed
CALL LES_MEAN_SUBGRID( PDISS, X_LES_SUBGRID_DISS_Tke )
!----------------------------------------------------------------------------
!
!
!----------------------------------------------------------------------------
!
END SUBROUTINE TKE_EPS_SOURCES