Sources/dyn3d/leapfrog.f

module leapfrog_m

  IMPLICIT NONE

contains

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

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

    ! Intégration temporelle du modèle : 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 comconst, ONLY: daysec, dtvr
    USE comgeom, ONLY: aire_2d, apoln, apols
    use covcont_m, only: covcont
    USE disvert_m, ONLY: ap, bp
    USE conf_gcm_m, ONLY: day_step, iconser, iperiod, iphysiq, nday, offline, &
         iflag_phys, iecri
    USE conf_guide_m, ONLY: ok_guide
    USE dimens_m, ONLY: iim, jjm, llm, nqmx
    use dissip_m, only: dissip
    USE dynetat0_m, ONLY: day_ini
    use dynredem1_m, only: dynredem1
    USE exner_hyb_m, ONLY: exner_hyb
    use filtreg_scal_m, only: filtreg_scal
    use fluxstokenc_m, only: fluxstokenc
    use geopot_m, only: geopot
    USE guide_m, ONLY: guide
    use inidissip_m, only: idissip
    use integrd_m, only: integrd
    use nr_util, only: assert
    USE temps, ONLY: itau_dyn
    use writedynav_m, only: writedynav
    use writehist_m, only: writehist

    ! Variables dynamiques:
    REAL, intent(inout):: ucov(:, :, :) ! (iim + 1, jjm + 1, 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, intent(inout):: masse(:, :, :) ! (iim + 1, jjm + 1, llm) masse d'air
    REAL, intent(in):: phis(:, :) ! (iim + 1, jjm + 1) surface geopotential

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

    ! Local:

    ! Variables dynamiques:

    REAL pks(iim + 1, jjm + 1) ! exner au sol
    REAL pk(iim + 1, jjm + 1, llm) ! exner au milieu des couches
    REAL pkf(iim + 1, jjm + 1, llm) ! exner filtr\'e au milieu des couches
    REAL phi(iim + 1, jjm + 1, llm) ! geopotential
    REAL w(iim + 1, jjm + 1, llm) ! vitesse verticale

    ! Variables dynamiques intermediaire pour le transport
    ! Flux de masse :
    REAL pbaru(iim + 1, jjm + 1, llm), pbarv(iim + 1, jjm, llm)

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

    ! Tendances dynamiques
    REAL dv((iim + 1) * jjm, llm), dudyn(iim + 1, jjm + 1, llm)
    REAL dteta(iim + 1, jjm + 1, llm)
    real dp((iim + 1) * (jjm + 1))

    ! Tendances de la dissipation :
    REAL dvdis(iim + 1, jjm, llm), dudis(iim + 1, jjm + 1, llm)
    REAL dtetadis(iim + 1, jjm + 1, llm)

    ! Tendances physiques
    REAL dvfi(iim + 1, jjm, llm), dufi(iim + 1, jjm + 1, llm)
    REAL dtetafi(iim + 1, jjm + 1, llm), dqfi(iim + 1, jjm + 1, llm, nqmx)

    ! Variables pour le fichier histoire
    INTEGER itau ! index of the time step of the dynamics, starts at 0
    INTEGER itaufin
    INTEGER l

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

    REAL vcont((iim + 1) * jjm, llm), ucont((iim + 1) * (jjm + 1), llm)
    logical leapf
    real dt ! time step, in s

    REAL p3d(iim + 1, jjm + 1, llm+1) ! pressure at layer interfaces, in Pa
    ! ("p3d(i, j, l)" is at longitude "rlonv(i)", latitude "rlatu(j)",
    ! for interface "l")

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

    print *, "Call sequence information: leapfrog"
    call assert(shape(ucov) == (/iim + 1, jjm + 1, llm/), "leapfrog")

    itaufin = nday * day_step
    ! "day_step" is a multiple of "iperiod", therefore so is "itaufin".

    ! 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 = pk
    CALL filtreg_scal(pkf, direct = .true., intensive = .true.)

    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) call guide(itau, ucov, vcov, teta, q(:, :, :, 1), ps)
          vcovm1 = vcov
          ucovm1 = ucov
          tetam1 = teta
          massem1 = masse
          psm1 = ps
       end if

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

       CALL caladvtrac(q, pbaru, pbarv, p3d, masse, teta, pk)

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

       ! Int\'egrations dynamique et traceurs:
       CALL integrd(vcovm1, ucovm1, tetam1, psm1, massem1, dv, dudyn, dteta, &
            dp, vcov, ucov, teta, q(:, :, :, :2), ps, masse, dt, leapf)

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

       if (.not. leapf) then
          ! Matsuno backward
          ! Calcul des tendances dynamiques:
          CALL geopot(teta, pk, pks, phis, phi)
          CALL caldyn(itau + 1, ucov, vcov, teta, ps, masse, pk, pkf, phis, &
               phi, dudyn, dv, dteta, dp, w, pbaru, pbarv, conser = .false.)

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

          forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
          CALL exner_hyb(ps, p3d, pks, pk)
          pkf = pk
          CALL filtreg_scal(pkf, direct = .true., intensive = .true.)
       end if

       IF (MOD(itau + 1, iphysiq) == 0 .AND. iflag_phys /= 0) THEN
          CALL calfis(ucov, vcov, teta, q, p3d, pk, phis, phi, w, dufi, dvfi, &
               dtetafi, dqfi, dayvrai = itau / day_step + day_ini, &
               time = REAL(mod(itau, day_step)) / day_step, &
               lafin = itau + 1 == itaufin)

          CALL addfi(ucov, vcov, teta, q, dufi, dvfi, dtetafi, dqfi)
       ENDIF

       IF (MOD(itau + 1, idissip) == 0) THEN
          ! Dissipation horizontale et verticale des petites \'echelles

          ! calcul de l'\'energie cin\'etique 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 ajoute la tendance due \`a la transformation \'energie
          ! cin\'etique en \'energie thermique par la dissipation
          call covcont(llm, ucov, vcov, ucont, vcont)
          call enercin(vcov, ucov, vcont, ucont, ecin)
          dtetadis = dtetadis + (ecin0 - ecin) / pk
          teta = teta + dtetadis

          ! Calcul de la valeur moyenne aux p\^oles :
          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
       END IF

       IF (MOD(itau + 1, iperiod) == 0) THEN
          ! \'Ecriture du fichier histoire moyenne:
          CALL writedynav(vcov, ucov, teta, pk, phi, q, masse, ps, phis, &
               time = itau + 1)
          call bilan_dyn(ps, masse, pk, pbaru, pbarv, teta, phi, ucov, vcov, &
               q(:, :, :, 1))
       ENDIF

       IF (MOD(itau + 1, iecri * day_step) == 0) THEN
          CALL geopot(teta, pk, pks, phis, phi)
          CALL writehist(itau, vcov, ucov, teta, phi, masse, ps)
       END IF
    end do time_integration

    CALL dynredem1(vcov, ucov, teta, q, masse, ps, itau = itau_dyn + itaufin)

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

  END SUBROUTINE leapfrog

end module leapfrog_m
1	guez	3	module leapfrog_m
2
3			IMPLICIT NONE
4
5			contains
6
7	guez	128	SUBROUTINE leapfrog(ucov, vcov, teta, ps, masse, phis, q)
8	guez	3
9	guez	67	! From dyn3d/leapfrog.F, version 1.6, 2005/04/13 08:58:34 revision 616
10	guez	27	! Authors: P. Le Van, L. Fairhead, F. Hourdin
11	guez	3
12	guez	129	! Intégration temporelle du modèle : Matsuno-leapfrog scheme.
13
14	guez	37	use addfi_m, only: addfi
15	guez	40	use bilan_dyn_m, only: bilan_dyn
16			use caladvtrac_m, only: caladvtrac
17	guez	43	use caldyn_m, only: caldyn
18	guez	26	USE calfis_m, ONLY: calfis
19	guez	103	USE comconst, ONLY: daysec, dtvr
20	guez	29	USE comgeom, ONLY: aire_2d, apoln, apols
21	guez	161	use covcont_m, only: covcont
22	guez	66	USE disvert_m, ONLY: ap, bp
23	guez	57	USE conf_gcm_m, ONLY: day_step, iconser, iperiod, iphysiq, nday, offline, &
24	guez	115	iflag_phys, iecri
25			USE conf_guide_m, ONLY: ok_guide
26	guez	29	USE dimens_m, ONLY: iim, jjm, llm, nqmx
27	guez	47	use dissip_m, only: dissip
28	guez	26	USE dynetat0_m, ONLY: day_ini
29	guez	27	use dynredem1_m, only: dynredem1
30	guez	26	USE exner_hyb_m, ONLY: exner_hyb
31	guez	137	use filtreg_scal_m, only: filtreg_scal
32	guez	69	use fluxstokenc_m, only: fluxstokenc
33	guez	43	use geopot_m, only: geopot
34	guez	26	USE guide_m, ONLY: guide
35			use inidissip_m, only: idissip
36	guez	32	use integrd_m, only: integrd
37	guez	55	use nr_util, only: assert
38	guez	28	USE temps, ONLY: itau_dyn
39	guez	56	use writedynav_m, only: writedynav
40	guez	69	use writehist_m, only: writehist
41	guez	3
42	guez	10	! Variables dynamiques:
43	guez	55	REAL, intent(inout):: ucov(:, :, :) ! (iim + 1, jjm + 1, llm) vent covariant
44			REAL, intent(inout):: vcov(:, :, :) ! (iim + 1, jjm, llm) ! vent covariant
45	guez	43
46			REAL, intent(inout):: teta(:, :, :) ! (iim + 1, jjm + 1, llm)
47			! potential temperature
48
49	guez	45	REAL, intent(inout):: ps(:, :) ! (iim + 1, jjm + 1) pression au sol, en Pa
50	guez	70	REAL, intent(inout):: masse(:, :, :) ! (iim + 1, jjm + 1, llm) masse d'air
51	guez	69	REAL, intent(in):: phis(:, :) ! (iim + 1, jjm + 1) surface geopotential
52	guez	40
53			REAL, intent(inout):: q(:, :, :, :) ! (iim + 1, jjm + 1, llm, nqmx)
54			! mass fractions of advected fields
55
56	guez	91	! Local:
57	guez	10
58			! Variables dynamiques:
59
60	guez	70	REAL pks(iim + 1, jjm + 1) ! exner au sol
61	guez	29	REAL pk(iim + 1, jjm + 1, llm) ! exner au milieu des couches
62	guez	90	REAL pkf(iim + 1, jjm + 1, llm) ! exner filtr\'e au milieu des couches
63	guez	47	REAL phi(iim + 1, jjm + 1, llm) ! geopotential
64	guez	91	REAL w(iim + 1, jjm + 1, llm) ! vitesse verticale
65	guez	3
66	guez	55	! Variables dynamiques intermediaire pour le transport
67			! Flux de masse :
68	guez	91	REAL pbaru(iim + 1, jjm + 1, llm), pbarv(iim + 1, jjm, llm)
69	guez	3
70	guez	56	! Variables dynamiques au pas - 1
71	guez	55	REAL vcovm1(iim + 1, jjm, llm), ucovm1(iim + 1, jjm + 1, llm)
72	guez	29	REAL tetam1(iim + 1, jjm + 1, llm), psm1(iim + 1, jjm + 1)
73	guez	67	REAL massem1(iim + 1, jjm + 1, llm)
74	guez	3
75	guez	56	! Tendances dynamiques
76	guez	88	REAL dv((iim + 1) * jjm, llm), dudyn(iim + 1, jjm + 1, llm)
77	guez	71	REAL dteta(iim + 1, jjm + 1, llm)
78	guez	55	real dp((iim + 1) * (jjm + 1))
79	guez	3
80	guez	56	! Tendances de la dissipation :
81	guez	55	REAL dvdis(iim + 1, jjm, llm), dudis(iim + 1, jjm + 1, llm)
82	guez	29	REAL dtetadis(iim + 1, jjm + 1, llm)
83	guez	3
84	guez	56	! Tendances physiques
85	guez	91	REAL dvfi(iim + 1, jjm, llm), dufi(iim + 1, jjm + 1, llm)
86			REAL dtetafi(iim + 1, jjm + 1, llm), dqfi(iim + 1, jjm + 1, llm, nqmx)
87	guez	3
88	guez	56	! Variables pour le fichier histoire
89	guez	22	INTEGER itau ! index of the time step of the dynamics, starts at 0
90	guez	27	INTEGER itaufin
91	guez	33	INTEGER l
92	guez	3
93	guez	90	! 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	55	REAL vcont((iim + 1) * jjm, llm), ucont((iim + 1) * (jjm + 1), llm)
97	guez	33	logical leapf
98	guez	91	real dt ! time step, in s
99	guez	3
100	guez	162	REAL p3d(iim + 1, jjm + 1, llm+1) ! pressure at layer interfaces, in Pa
101			! ("p3d(i, j, l)" is at longitude "rlonv(i)", latitude "rlatu(j)",
102			! for interface "l")
103
104	guez	3	!---------------------------------------------------
105
106			print *, "Call sequence information: leapfrog"
107	guez	55	call assert(shape(ucov) == (/iim + 1, jjm + 1, llm/), "leapfrog")
108	guez	3
109			itaufin = nday * day_step
110	guez	62	! "day_step" is a multiple of "iperiod", therefore so is "itaufin".
111	guez	30
112	guez	3	! On initialise la pression et la fonction d'Exner :
113	guez	37	forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
114	guez	137	CALL exner_hyb(ps, p3d, pks, pk)
115			pkf = pk
116			CALL filtreg_scal(pkf, direct = .true., intensive = .true.)
117	guez	3
118	guez	40	time_integration: do itau = 0, itaufin - 1
119	guez	33	leapf = mod(itau, iperiod) /= 0
120			if (leapf) then
121			dt = 2 * dtvr
122			else
123			! Matsuno
124			dt = dtvr
125	guez	108	if (ok_guide) call guide(itau, ucov, vcov, teta, q(:, :, :, 1), ps)
126	guez	33	vcovm1 = vcov
127			ucovm1 = ucov
128			tetam1 = teta
129			massem1 = masse
130			psm1 = ps
131			end if
132	guez	30
133			! Calcul des tendances dynamiques:
134	guez	70	CALL geopot(teta, pk, pks, phis, phi)
135	guez	30	CALL caldyn(itau, ucov, vcov, teta, ps, masse, pk, pkf, phis, phi, &
136	guez	128	dudyn, dv, dteta, dp, w, pbaru, pbarv, &
137	guez	78	conser = MOD(itau, iconser) == 0)
138	guez	30
139	guez	71	CALL caladvtrac(q, pbaru, pbarv, p3d, masse, teta, pk)
140	guez	33
141	guez	30	! Stokage du flux de masse pour traceurs offline:
142			IF (offline) CALL fluxstokenc(pbaru, pbarv, masse, teta, phi, phis, &
143			dtvr, itau)
144
145	guez	90	! Int\'egrations dynamique et traceurs:
146	guez	47	CALL integrd(vcovm1, ucovm1, tetam1, psm1, massem1, dv, dudyn, dteta, &
147	guez	161	dp, vcov, ucov, teta, q(:, :, :, :2), ps, masse, dt, leapf)
148	guez	30
149	guez	97	forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
150	guez	137	CALL exner_hyb(ps, p3d, pks, pk)
151			pkf = pk
152			CALL filtreg_scal(pkf, direct = .true., intensive = .true.)
153	guez	97
154	guez	33	if (.not. leapf) then
155			! Matsuno backward
156	guez	27	! Calcul des tendances dynamiques:
157	guez	70	CALL geopot(teta, pk, pks, phis, phi)
158	guez	33	CALL caldyn(itau + 1, ucov, vcov, teta, ps, masse, pk, pkf, phis, &
159	guez	128	phi, dudyn, dv, dteta, dp, w, pbaru, pbarv, conser = .false.)
160	guez	3
161			! integrations dynamique et traceurs:
162	guez	47	CALL integrd(vcovm1, ucovm1, tetam1, psm1, massem1, dv, dudyn, &
163	guez	161	dteta, dp, vcov, ucov, teta, q(:, :, :, :2), ps, masse, dtvr, &
164			leapf=.false.)
165	guez	97
166			forall (l = 1: llm + 1) p3d(:, :, l) = ap(l) + bp(l) * ps
167	guez	137	CALL exner_hyb(ps, p3d, pks, pk)
168			pkf = pk
169			CALL filtreg_scal(pkf, direct = .true., intensive = .true.)
170	guez	33	end if
171	guez	3
172	guez	33	IF (MOD(itau + 1, iphysiq) == 0 .AND. iflag_phys /= 0) THEN
173	guez	162	CALL calfis(ucov, vcov, teta, q, p3d, pk, phis, phi, w, dufi, dvfi, &
174	guez	154	dtetafi, dqfi, dayvrai = itau / day_step + day_ini, &
175			time = REAL(mod(itau, day_step)) / day_step, &
176	guez	128	lafin = itau + 1 == itaufin)
177	guez	3
178	guez	91	CALL addfi(ucov, vcov, teta, q, dufi, dvfi, dtetafi, dqfi)
179	guez	33	ENDIF
180	guez	3
181	guez	33	IF (MOD(itau + 1, idissip) == 0) THEN
182	guez	90	! Dissipation horizontale et verticale des petites \'echelles
183	guez	3
184	guez	90	! calcul de l'\'energie cin\'etique avant dissipation
185	guez	33	call covcont(llm, ucov, vcov, ucont, vcont)
186			call enercin(vcov, ucov, vcont, ucont, ecin0)
187	guez	3
188	guez	33	! dissipation
189			CALL dissip(vcov, ucov, teta, p3d, dvdis, dudis, dtetadis)
190	guez	55	ucov = ucov + dudis
191			vcov = vcov + dvdis
192	guez	3
193	guez	90	! On ajoute la tendance due \`a la transformation \'energie
194			! cin\'etique en \'energie thermique par la dissipation
195	guez	33	call covcont(llm, ucov, vcov, ucont, vcont)
196			call enercin(vcov, ucov, vcont, ucont, ecin)
197	guez	56	dtetadis = dtetadis + (ecin0 - ecin) / pk
198	guez	55	teta = teta + dtetadis
199	guez	3
200	guez	90	! Calcul de la valeur moyenne aux p\^oles :
201	guez	33	forall (l = 1: llm)
202			teta(:, 1, l) = SUM(aire_2d(:iim, 1) * teta(:iim, 1, l)) &
203			/ apoln
204			teta(:, jjm + 1, l) = SUM(aire_2d(:iim, jjm+1) &
205			* teta(:iim, jjm + 1, l)) / apols
206			END forall
207			END IF
208	guez	3
209	guez	33	IF (MOD(itau + 1, iperiod) == 0) THEN
210	guez	90	! \'Ecriture du fichier histoire moyenne:
211	guez	61	CALL writedynav(vcov, ucov, teta, pk, phi, q, masse, ps, phis, &
212			time = itau + 1)
213	guez	40	call bilan_dyn(ps, masse, pk, pbaru, pbarv, teta, phi, ucov, vcov, &
214	guez	57	q(:, :, :, 1))
215	guez	33	ENDIF
216	guez	68
217			IF (MOD(itau + 1, iecri * day_step) == 0) THEN
218	guez	70	CALL geopot(teta, pk, pks, phis, phi)
219	guez	138	CALL writehist(itau, vcov, ucov, teta, phi, masse, ps)
220	guez	68	END IF
221	guez	40	end do time_integration
222	guez	3
223	guez	157	CALL dynredem1(vcov, ucov, teta, q, masse, ps, itau = itau_dyn + itaufin)
224	guez	30
225			! Calcul des tendances dynamiques:
226	guez	70	CALL geopot(teta, pk, pks, phis, phi)
227	guez	30	CALL caldyn(itaufin, ucov, vcov, teta, ps, masse, pk, pkf, phis, phi, &
228	guez	128	dudyn, dv, dteta, dp, w, pbaru, pbarv, &
229	guez	67	conser = MOD(itaufin, iconser) == 0)
230	guez	56
231	guez	3	END SUBROUTINE leapfrog
232
233			end module leapfrog_m