Sources/dyn3d/leapfrog.f

module leapfrog_m

  IMPLICIT NONE

contains

  SUBROUTINE leapfrog(ucov, vcov, teta, ps, masse, phis, q, time_0)

    ! From dyn3d/leapfrog.F, version 1.6, 2005/04/13 08:58:34
    ! Authors: P. Le Van, L. Fairhead, F. Hourdin
    ! Matsuno-leapfrog scheme.

    use addfi_m, only: addfi
    use bilan_dyn_m, only: bilan_dyn
    use caladvtrac_m, only: caladvtrac
    use caldyn_m, only: caldyn
    USE calfis_m, ONLY: calfis
    USE com_io_dyn, ONLY: histaveid
    USE comconst, ONLY: daysec, dtphys, dtvr
    USE comgeom, ONLY: aire_2d, apoln, apols
    USE comvert, ONLY: ap, bp
    USE conf_gcm_m, ONLY: day_step, iconser, iperiod, iphysiq, nday, offline, &
         periodav
    USE dimens_m, ONLY: iim, jjm, llm, nqmx
    USE dynetat0_m, ONLY: day_ini
    use dynredem1_m, only: dynredem1
    USE exner_hyb_m, ONLY: exner_hyb
    use filtreg_m, only: filtreg
    use geopot_m, only: geopot
    USE guide_m, ONLY: guide
    use inidissip_m, only: idissip
    use integrd_m, only: integrd
    USE logic, ONLY: iflag_phys, ok_guide
    USE paramet_m, ONLY: ip1jmp1
    USE pressure_var, ONLY: p3d
    USE temps, ONLY: itau_dyn

    ! Variables dynamiques:
    REAL, intent(inout):: ucov(ip1jmp1, llm) ! vent covariant
    REAL, intent(inout):: vcov((iim + 1) * jjm, llm) ! vent covariant

    REAL, intent(inout):: teta(:, :, :) ! (iim + 1, jjm + 1, llm)
    ! potential temperature

    REAL, intent(inout):: ps(:, :) ! (iim + 1, jjm + 1) pression au sol, en Pa
    REAL masse(ip1jmp1, llm) ! masse d'air
    REAL phis(ip1jmp1) ! geopotentiel au sol

    REAL, intent(inout):: q(:, :, :, :) ! (iim + 1, jjm + 1, llm, nqmx)
    ! mass fractions of advected fields

    REAL, intent(in):: time_0

    ! Variables local to the procedure:

    ! Variables dynamiques:

    REAL pks(ip1jmp1) ! exner au sol
    REAL pk(iim + 1, jjm + 1, llm) ! exner au milieu des couches
    REAL pkf(ip1jmp1, llm) ! exner filt.au milieu des couches
    REAL phi(ip1jmp1, llm) ! geopotential
    REAL w(ip1jmp1, llm) ! vitesse verticale

    ! variables dynamiques intermediaire pour le transport
    REAL pbaru(ip1jmp1, llm), pbarv((iim + 1) * jjm, llm) !flux de masse

    ! variables dynamiques au pas - 1
    REAL vcovm1((iim + 1) * jjm, llm), ucovm1(ip1jmp1, llm)
    REAL tetam1(iim + 1, jjm + 1, llm), psm1(iim + 1, jjm + 1)
    REAL massem1(ip1jmp1, llm)

    ! tendances dynamiques
    REAL dv((iim + 1) * jjm, llm), du(ip1jmp1, llm)
    REAL dteta(iim + 1, jjm + 1, llm), dq(ip1jmp1, llm, nqmx), dp(ip1jmp1)

    ! tendances de la dissipation
    REAL dvdis((iim + 1) * jjm, llm), dudis(ip1jmp1, llm)
    REAL dtetadis(iim + 1, jjm + 1, llm)

    ! tendances physiques
    REAL dvfi((iim + 1) * jjm, llm), dufi(ip1jmp1, llm)
    REAL dtetafi(iim + 1, jjm + 1, llm), dqfi(ip1jmp1, llm, nqmx), dpfi(ip1jmp1)

    ! variables pour le fichier histoire

    INTEGER itau ! index of the time step of the dynamics, starts at 0
    INTEGER itaufin
    REAL time ! time of day, as a fraction of day length
    real finvmaold(ip1jmp1, llm)
    INTEGER l
    REAL rdayvrai, rdaym_ini

    ! Variables test conservation energie
    REAL ecin(iim + 1, jjm + 1, llm), ecin0(iim + 1, jjm + 1, llm)

    REAL dtetaecdt(iim + 1, jjm + 1, llm)
    ! tendance de la température potentielle due à la tansformation
    ! d'énergie cinétique en énergie thermique créée par la dissipation

    REAL vcont((iim + 1) * jjm, llm), ucont(ip1jmp1, llm)
    logical leapf
    real dt

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

    print *, "Call sequence information: leapfrog"

    itaufin = nday * day_step
    ! "day_step" is a multiple of "iperiod", therefore "itaufin" is one too

    dq = 0.

    ! On initialise la pression et la fonction d'Exner :
    forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
    CALL exner_hyb(ps, p3d, pks, pk, pkf)

    time_integration: do itau = 0, itaufin - 1
       leapf = mod(itau, iperiod) /= 0
       if (leapf) then
          dt = 2 * dtvr
       else
          ! Matsuno
          dt = dtvr
          if (ok_guide .and. (itaufin - itau - 1) * dtvr > 21600.) &
               call guide(itau, ucov, vcov, teta, q, masse, ps)
          vcovm1 = vcov
          ucovm1 = ucov
          tetam1 = teta
          massem1 = masse
          psm1 = ps
          finvmaold = masse
          CALL filtreg(finvmaold, jjm + 1, llm, - 2, 2, .TRUE., 1)
       end if

       ! Calcul des tendances dynamiques:
       CALL geopot(ip1jmp1, teta, pk, pks, phis, phi)
       CALL caldyn(itau, ucov, vcov, teta, ps, masse, pk, pkf, phis, phi, &
            MOD(itau, iconser) == 0, du, dv, dteta, dp, w, pbaru, pbarv, &
            time_0)

       ! Calcul des tendances advection des traceurs (dont l'humidité)
       CALL caladvtrac(q, pbaru, pbarv, p3d, masse, dq, teta, pk)

       ! Stokage du flux de masse pour traceurs offline:
       IF (offline) CALL fluxstokenc(pbaru, pbarv, masse, teta, phi, phis, &
            dtvr, itau)

       ! Integrations dynamique et traceurs:
       CALL integrd(vcovm1, ucovm1, tetam1, psm1, massem1, dv, du, dteta, dp, &
            vcov, ucov, teta, q(:, :, :, :2), ps, masse, finvmaold, dt, leapf)

       if (.not. leapf) then
          ! Matsuno backward
          forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
          CALL exner_hyb(ps, p3d, pks, pk, pkf)

          ! Calcul des tendances dynamiques:
          CALL geopot(ip1jmp1, teta, pk, pks, phis, phi)
          CALL caldyn(itau + 1, ucov, vcov, teta, ps, masse, pk, pkf, phis, &
               phi, .false., du, dv, dteta, dp, w, pbaru, pbarv, time_0)

          ! integrations dynamique et traceurs:
          CALL integrd(vcovm1, ucovm1, tetam1, psm1, massem1, dv, du, dteta, &
               dp, vcov, ucov, teta, q(:, :, :, :2), ps, masse, finvmaold, &
               dtvr, leapf=.false.)
       end if

       IF (MOD(itau + 1, iphysiq) == 0 .AND. iflag_phys /= 0) THEN
          ! calcul des tendances physiques:

          forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
          CALL exner_hyb(ps, p3d, pks, pk, pkf)

          rdaym_ini = itau * dtvr / daysec
          rdayvrai = rdaym_ini + day_ini
          time = REAL(mod(itau, day_step)) / day_step + time_0
          IF (time > 1.) time = time - 1.

          CALL calfis(rdayvrai, time, ucov, vcov, teta, q, masse, ps, pk, &
               phis, phi, du, dv, dq, w, dufi, dvfi, dtetafi, dqfi, dpfi, &
               lafin=itau+1==itaufin)

          ! ajout des tendances physiques:
          CALL addfi(nqmx, dtphys, ucov, vcov, teta, q, ps, dufi, dvfi, &
               dtetafi, dqfi, dpfi)
       ENDIF

       forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
       CALL exner_hyb(ps, p3d, pks, pk, pkf)

       IF (MOD(itau + 1, idissip) == 0) THEN
          ! dissipation horizontale et verticale des petites echelles:

          ! calcul de l'energie cinetique avant dissipation
          call covcont(llm, ucov, vcov, ucont, vcont)
          call enercin(vcov, ucov, vcont, ucont, ecin0)

          ! dissipation
          CALL dissip(vcov, ucov, teta, p3d, dvdis, dudis, dtetadis)
          ucov=ucov + dudis
          vcov=vcov + dvdis

          ! On rajoute la tendance due à la transformation Ec -> E
          ! thermique créée lors de la dissipation
          call covcont(llm, ucov, vcov, ucont, vcont)
          call enercin(vcov, ucov, vcont, ucont, ecin)
          dtetaecdt= (ecin0 - ecin) / pk
          dtetadis=dtetadis + dtetaecdt
          teta=teta + dtetadis

          ! Calcul de la valeur moyenne aux pôles :
          forall (l = 1: llm)
             teta(:, 1, l) = SUM(aire_2d(:iim, 1) * teta(:iim, 1, l)) &
                  / apoln
             teta(:, jjm + 1, l) = SUM(aire_2d(:iim, jjm+1) &
                  * teta(:iim, jjm + 1, l)) / apols
          END forall

          ps(:, 1) = SUM(aire_2d(:iim, 1) * ps(:iim, 1)) / apoln
          ps(:, jjm + 1) = SUM(aire_2d(:iim, jjm+1) * ps(:iim, jjm + 1)) &
               / apols
       END IF

       IF (MOD(itau + 1, iperiod) == 0) THEN
          ! Écriture du fichier histoire moyenne:
          CALL writedynav(histaveid, nqmx, itau + 1, vcov, ucov, teta, pk, &
               phi, q, masse, ps, phis)
          call bilan_dyn(ps, masse, pk, pbaru, pbarv, teta, phi, ucov, vcov, &
               q(:, :, :, 1), dt_app = dtvr * iperiod, &
               dt_cum = dtvr * day_step * periodav)
       ENDIF
    end do time_integration

    CALL dynredem1("restart.nc", vcov, ucov, teta, q, masse, ps, &
         itau=itau_dyn+itaufin)

    ! Calcul des tendances dynamiques:
    CALL geopot(ip1jmp1, teta, pk, pks, phis, phi)
    CALL caldyn(itaufin, ucov, vcov, teta, ps, masse, pk, pkf, phis, phi, &
         MOD(itaufin, iconser) == 0, du, dv, dteta, dp, w, pbaru, pbarv, &
         time_0)

  END SUBROUTINE leapfrog

end module leapfrog_m
1	guez	3	module leapfrog_m
2
3			IMPLICIT NONE
4
5			contains
6
7	guez	23	SUBROUTINE leapfrog(ucov, vcov, teta, ps, masse, phis, q, time_0)
8	guez	3
9	guez	27	! From dyn3d/leapfrog.F, version 1.6, 2005/04/13 08:58:34
10			! Authors: P. Le Van, L. Fairhead, F. Hourdin
11	guez	36	! Matsuno-leapfrog scheme.
12	guez	3
13	guez	37	use addfi_m, only: addfi
14	guez	40	use bilan_dyn_m, only: bilan_dyn
15			use caladvtrac_m, only: caladvtrac
16	guez	43	use caldyn_m, only: caldyn
17	guez	26	USE calfis_m, ONLY: calfis
18			USE com_io_dyn, ONLY: histaveid
19			USE comconst, ONLY: daysec, dtphys, dtvr
20	guez	29	USE comgeom, ONLY: aire_2d, apoln, apols
21	guez	26	USE comvert, ONLY: ap, bp
22	guez	27	USE conf_gcm_m, ONLY: day_step, iconser, iperiod, iphysiq, nday, offline, &
23			periodav
24	guez	29	USE dimens_m, ONLY: iim, jjm, llm, nqmx
25	guez	26	USE dynetat0_m, ONLY: day_ini
26	guez	27	use dynredem1_m, only: dynredem1
27	guez	26	USE exner_hyb_m, ONLY: exner_hyb
28	guez	27	use filtreg_m, only: filtreg
29	guez	43	use geopot_m, only: geopot
30	guez	26	USE guide_m, ONLY: guide
31			use inidissip_m, only: idissip
32	guez	32	use integrd_m, only: integrd
33	guez	26	USE logic, ONLY: iflag_phys, ok_guide
34	guez	29	USE paramet_m, ONLY: ip1jmp1
35	guez	26	USE pressure_var, ONLY: p3d
36	guez	28	USE temps, ONLY: itau_dyn
37	guez	3
38	guez	10	! Variables dynamiques:
39	guez	36	REAL, intent(inout):: ucov(ip1jmp1, llm) ! vent covariant
40	guez	32	REAL, intent(inout):: vcov((iim + 1) * jjm, llm) ! vent covariant
41	guez	43
42			REAL, intent(inout):: teta(:, :, :) ! (iim + 1, jjm + 1, llm)
43			! potential temperature
44
45	guez	45	REAL, intent(inout):: ps(:, :) ! (iim + 1, jjm + 1) pression au sol, en Pa
46	guez	10	REAL masse(ip1jmp1, llm) ! masse d'air
47			REAL phis(ip1jmp1) ! geopotentiel au sol
48	guez	40
49			REAL, intent(inout):: q(:, :, :, :) ! (iim + 1, jjm + 1, llm, nqmx)
50			! mass fractions of advected fields
51
52	guez	24	REAL, intent(in):: time_0
53	guez	10
54			! Variables local to the procedure:
55
56			! Variables dynamiques:
57
58	guez	3	REAL pks(ip1jmp1) ! exner au sol
59	guez	29	REAL pk(iim + 1, jjm + 1, llm) ! exner au milieu des couches
60	guez	3	REAL pkf(ip1jmp1, llm) ! exner filt.au milieu des couches
61			REAL phi(ip1jmp1, llm) ! geopotential
62			REAL w(ip1jmp1, llm) ! vitesse verticale
63
64			! variables dynamiques intermediaire pour le transport
65	guez	29	REAL pbaru(ip1jmp1, llm), pbarv((iim + 1) * jjm, llm) !flux de masse
66	guez	3
67			! variables dynamiques au pas - 1
68	guez	29	REAL vcovm1((iim + 1) * jjm, llm), ucovm1(ip1jmp1, llm)
69			REAL tetam1(iim + 1, jjm + 1, llm), psm1(iim + 1, jjm + 1)
70	guez	3	REAL massem1(ip1jmp1, llm)
71
72			! tendances dynamiques
73	guez	29	REAL dv((iim + 1) * jjm, llm), du(ip1jmp1, llm)
74	guez	44	REAL dteta(iim + 1, jjm + 1, llm), dq(ip1jmp1, llm, nqmx), dp(ip1jmp1)
75	guez	3
76			! tendances de la dissipation
77	guez	29	REAL dvdis((iim + 1) * jjm, llm), dudis(ip1jmp1, llm)
78			REAL dtetadis(iim + 1, jjm + 1, llm)
79	guez	3
80			! tendances physiques
81	guez	29	REAL dvfi((iim + 1) * jjm, llm), dufi(ip1jmp1, llm)
82	guez	44	REAL dtetafi(iim + 1, jjm + 1, llm), dqfi(ip1jmp1, llm, nqmx), dpfi(ip1jmp1)
83	guez	3
84			! variables pour le fichier histoire
85
86	guez	22	INTEGER itau ! index of the time step of the dynamics, starts at 0
87	guez	27	INTEGER itaufin
88	guez	20	REAL time ! time of day, as a fraction of day length
89	guez	10	real finvmaold(ip1jmp1, llm)
90	guez	33	INTEGER l
91	guez	3	REAL rdayvrai, rdaym_ini
92
93	guez	24	! Variables test conservation energie
94	guez	29	REAL ecin(iim + 1, jjm + 1, llm), ecin0(iim + 1, jjm + 1, llm)
95	guez	43
96	guez	29	REAL dtetaecdt(iim + 1, jjm + 1, llm)
97	guez	43	! tendance de la température potentielle due à la tansformation
98			! d'énergie cinétique en énergie thermique créée par la dissipation
99
100	guez	29	REAL vcont((iim + 1) * jjm, llm), ucont(ip1jmp1, llm)
101	guez	33	logical leapf
102			real dt
103	guez	3
104			!---------------------------------------------------
105
106			print *, "Call sequence information: leapfrog"
107
108			itaufin = nday * day_step
109	guez	30	! "day_step" is a multiple of "iperiod", therefore "itaufin" is one too
110
111	guez	24	dq = 0.
112	guez	33
113	guez	3	! On initialise la pression et la fonction d'Exner :
114	guez	37	forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
115	guez	10	CALL exner_hyb(ps, p3d, pks, pk, pkf)
116	guez	3
117	guez	40	time_integration: do itau = 0, itaufin - 1
118	guez	33	leapf = mod(itau, iperiod) /= 0
119			if (leapf) then
120			dt = 2 * dtvr
121			else
122			! Matsuno
123			dt = dtvr
124			if (ok_guide .and. (itaufin - itau - 1) * dtvr > 21600.) &
125			call guide(itau, ucov, vcov, teta, q, masse, ps)
126			vcovm1 = vcov
127			ucovm1 = ucov
128			tetam1 = teta
129			massem1 = masse
130			psm1 = ps
131			finvmaold = masse
132			CALL filtreg(finvmaold, jjm + 1, llm, - 2, 2, .TRUE., 1)
133			end if
134	guez	30
135			! Calcul des tendances dynamiques:
136			CALL geopot(ip1jmp1, teta, pk, pks, phis, phi)
137			CALL caldyn(itau, ucov, vcov, teta, ps, masse, pk, pkf, phis, phi, &
138			MOD(itau, iconser) == 0, du, dv, dteta, dp, w, pbaru, pbarv, &
139	guez	33	time_0)
140	guez	30
141			! Calcul des tendances advection des traceurs (dont l'humidité)
142			CALL caladvtrac(q, pbaru, pbarv, p3d, masse, dq, teta, pk)
143	guez	33
144	guez	30	! Stokage du flux de masse pour traceurs offline:
145			IF (offline) CALL fluxstokenc(pbaru, pbarv, masse, teta, phi, phis, &
146			dtvr, itau)
147
148	guez	46	! Integrations dynamique et traceurs:
149	guez	39	CALL integrd(vcovm1, ucovm1, tetam1, psm1, massem1, dv, du, dteta, dp, &
150	guez	40	vcov, ucov, teta, q(:, :, :, :2), ps, masse, finvmaold, dt, leapf)
151	guez	30
152	guez	33	if (.not. leapf) then
153			! Matsuno backward
154	guez	37	forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
155	guez	33	CALL exner_hyb(ps, p3d, pks, pk, pkf)
156	guez	30
157	guez	27	! Calcul des tendances dynamiques:
158	guez	3	CALL geopot(ip1jmp1, teta, pk, pks, phis, phi)
159	guez	33	CALL caldyn(itau + 1, ucov, vcov, teta, ps, masse, pk, pkf, phis, &
160			phi, .false., du, dv, dteta, dp, w, pbaru, pbarv, time_0)
161	guez	3
162			! integrations dynamique et traceurs:
163	guez	39	CALL integrd(vcovm1, ucovm1, tetam1, psm1, massem1, dv, du, dteta, &
164	guez	40	dp, vcov, ucov, teta, q(:, :, :, :2), ps, masse, finvmaold, &
165			dtvr, leapf=.false.)
166	guez	33	end if
167	guez	3
168	guez	33	IF (MOD(itau + 1, iphysiq) == 0 .AND. iflag_phys /= 0) THEN
169			! calcul des tendances physiques:
170	guez	3
171	guez	37	forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
172	guez	33	CALL exner_hyb(ps, p3d, pks, pk, pkf)
173	guez	3
174	guez	33	rdaym_ini = itau * dtvr / daysec
175			rdayvrai = rdaym_ini + day_ini
176			time = REAL(mod(itau, day_step)) / day_step + time_0
177			IF (time > 1.) time = time - 1.
178	guez	3
179	guez	37	CALL calfis(rdayvrai, time, ucov, vcov, teta, q, masse, ps, pk, &
180	guez	44	phis, phi, du, dv, dq, w, dufi, dvfi, dtetafi, dqfi, dpfi, &
181			lafin=itau+1==itaufin)
182	guez	3
183	guez	33	! ajout des tendances physiques:
184			CALL addfi(nqmx, dtphys, ucov, vcov, teta, q, ps, dufi, dvfi, &
185			dtetafi, dqfi, dpfi)
186			ENDIF
187	guez	3
188	guez	37	forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
189	guez	33	CALL exner_hyb(ps, p3d, pks, pk, pkf)
190	guez	3
191	guez	33	IF (MOD(itau + 1, idissip) == 0) THEN
192			! dissipation horizontale et verticale des petites echelles:
193	guez	3
194	guez	33	! calcul de l'energie cinetique avant dissipation
195			call covcont(llm, ucov, vcov, ucont, vcont)
196			call enercin(vcov, ucov, vcont, ucont, ecin0)
197	guez	3
198	guez	33	! dissipation
199			CALL dissip(vcov, ucov, teta, p3d, dvdis, dudis, dtetadis)
200			ucov=ucov + dudis
201			vcov=vcov + dvdis
202	guez	3
203	guez	33	! On rajoute la tendance due à la transformation Ec -> E
204			! thermique créée lors de la dissipation
205			call covcont(llm, ucov, vcov, ucont, vcont)
206			call enercin(vcov, ucov, vcont, ucont, ecin)
207			dtetaecdt= (ecin0 - ecin) / pk
208			dtetadis=dtetadis + dtetaecdt
209			teta=teta + dtetadis
210	guez	3
211	guez	33	! Calcul de la valeur moyenne aux pôles :
212			forall (l = 1: llm)
213			teta(:, 1, l) = SUM(aire_2d(:iim, 1) * teta(:iim, 1, l)) &
214			/ apoln
215			teta(:, jjm + 1, l) = SUM(aire_2d(:iim, jjm+1) &
216			* teta(:iim, jjm + 1, l)) / apols
217			END forall
218	guez	3
219	guez	33	ps(:, 1) = SUM(aire_2d(:iim, 1) * ps(:iim, 1)) / apoln
220			ps(:, jjm + 1) = SUM(aire_2d(:iim, jjm+1) * ps(:iim, jjm + 1)) &
221			/ apols
222			END IF
223	guez	3
224	guez	33	IF (MOD(itau + 1, iperiod) == 0) THEN
225	guez	40	! Écriture du fichier histoire moyenne:
226	guez	33	CALL writedynav(histaveid, nqmx, itau + 1, vcov, ucov, teta, pk, &
227			phi, q, masse, ps, phis)
228	guez	40	call bilan_dyn(ps, masse, pk, pbaru, pbarv, teta, phi, ucov, vcov, &
229			q(:, :, :, 1), dt_app = dtvr * iperiod, &
230			dt_cum = dtvr * day_step * periodav)
231	guez	33	ENDIF
232	guez	40	end do time_integration
233	guez	3
234	guez	30	CALL dynredem1("restart.nc", vcov, ucov, teta, q, masse, ps, &
235			itau=itau_dyn+itaufin)
236
237			! Calcul des tendances dynamiques:
238			CALL geopot(ip1jmp1, teta, pk, pks, phis, phi)
239			CALL caldyn(itaufin, ucov, vcov, teta, ps, masse, pk, pkf, phis, phi, &
240			MOD(itaufin, iconser) == 0, du, dv, dteta, dp, w, pbaru, pbarv, &
241	guez	33	time_0)
242	guez	30
243	guez	3	END SUBROUTINE leapfrog
244
245			end module leapfrog_m