source: codes/icosagcm/devel/src/dynamics/caldyn_gcm.F90 @ 851

Last change on this file since 851 was 846, checked in by dubos, 5 years ago

devel : towards Fortran driver for unstructured/LAM meshes
File size: 13.9 KB
Line 
1MODULE caldyn_gcm_mod
2  USE icosa
3  USE transfert_mod
4  USE caldyn_vars_mod
5  USE caldyn_kernels_hevi_mod
6  USE caldyn_kernels_base_mod
7  USE caldyn_kernels_mod
8  USE omp_para
9  USE mpipara
10  IMPLICIT NONE
11  PRIVATE
12
13  PUBLIC init_caldyn, caldyn_BC, caldyn
14 
15CONTAINS
16 
17  SUBROUTINE init_caldyn
18    USE compute_mod, ONLY : compute_pvort_only
19    USE compute_pvort_only_mod, ONLY : compute_pvort_only_hex
20
21    CHARACTER(len=255) :: def
22    INTEGER            :: ind
23    REAL(rstd),POINTER :: planetvel(:)
24
25    hydrostatic=.TRUE.
26    CALL getin("hydrostatic",hydrostatic)
27 
28    dysl=.NOT.hydrostatic ! dysl defaults to .FALSE. if hydrostatic, .TRUE. if NH                                             
29    CALL getin("dysl",dysl)
30    dysl_geopot=dysl
31    CALL getin("dysl_geopot",dysl_geopot)
32    dysl_caldyn_fast=dysl
33    CALL getin("dysl_caldyn_fast",dysl_caldyn_fast)
34    dysl_slow_hydro=dysl
35    CALL getin("dysl_slow_hydro",dysl_slow_hydro)
36    dysl_pvort_only=dysl
37    CALL getin("dysl_pvort_only",dysl_pvort_only)
38    dysl_caldyn_coriolis=dysl
39    CALL getin("dysl_caldyn_coriolis",dysl_caldyn_coriolis)
40    dysl_caldyn_vert=dysl
41    CALL getin("dysl_caldyn_vert",dysl_caldyn_vert)
42
43    def='advective'
44    CALL getin('caldyn_vert',def)
45    SELECT CASE(TRIM(def))
46    CASE('advective')
47       caldyn_vert_variant=caldyn_vert_noncons
48    CASE('conservative')
49       IF(.NOT. dysl_caldyn_vert) THEN
50          IF (is_mpi_root) PRINT *,'caldyn_vert=cons requires dysl_caldyn_vert=.TRUE.'
51          STOP
52       END IF
53       caldyn_vert_variant=caldyn_vert_cons
54    CASE DEFAULT
55       IF (is_mpi_root) PRINT *,'Bad selector for variable caldyn_vert : <', &
56            TRIM(def),'> options are <conservative>, <advective>'
57       STOP
58    END SELECT
59    IF (is_master) PRINT *, 'caldyn_vert=',def
60   
61    def='energy'
62    CALL getin('caldyn_conserv',def)
63    SELECT CASE(TRIM(def))
64    CASE('energy')
65       caldyn_conserv=conserv_energy
66    CASE('energy_gassmann')
67       caldyn_conserv=conserv_gassmann
68    CASE('enstrophy')
69       caldyn_conserv=conserv_enstrophy
70    CASE DEFAULT
71       IF (is_mpi_root) PRINT *,'Bad selector for variable caldyn_conserv : <', &
72            TRIM(def),'> options are <energy>, <energy_gassmann>, <enstrophy>'
73       STOP
74    END SELECT
75    IF (is_master) PRINT *, 'caldyn_conserv=',def
76
77    def='trisk'
78    CALL getin('caldyn_kinetic',def)
79    SELECT CASE(TRIM(def))
80    CASE('trisk')
81       caldyn_kinetic=kinetic_trisk
82    CASE('consistent')
83       caldyn_kinetic=kinetic_consistent
84    CASE DEFAULT
85       IF (is_mpi_root) PRINT *,'Bad selector for variable caldyn_kinetic : <', &
86            TRIM(def),'> options are <trisk>, <consistent>'
87       STOP
88    END SELECT
89    IF (is_master) PRINT *, 'caldyn_kinetic=',def
90
91    nqdyn=1 ! default value
92    physics_thermo = thermo_none
93
94    def='theta'
95    CALL getin('thermo',def)
96    SELECT CASE(TRIM(def))
97    CASE('boussinesq')
98       boussinesq=.TRUE.
99       caldyn_thermo=thermo_boussinesq
100       IF(.NOT. hydrostatic) THEN
101          PRINT *, 'thermo=boussinesq and hydrostatic=.FALSE. : Non-hydrostatic boussinesq equations are not supported'
102          STOP
103       END IF
104    CASE('theta')
105       caldyn_thermo=thermo_theta
106       physics_thermo=thermo_dry
107    CASE('entropy')
108       caldyn_thermo=thermo_entropy
109       physics_thermo=thermo_dry
110    CASE('theta_fake_moist')
111       caldyn_thermo=thermo_theta
112       physics_thermo=thermo_fake_moist
113    CASE('entropy_fake_moist')
114       caldyn_thermo=thermo_entropy
115       physics_thermo=thermo_fake_moist
116    CASE('moist')
117       caldyn_thermo=thermo_moist_debug
118       physics_thermo=thermo_moist
119       nqdyn = 2
120    CASE DEFAULT
121       IF (is_mpi_root) PRINT *,'Bad selector for variable caldyn_thermo : <', &
122            TRIM(def),'> options are <theta>, <entropy>'
123       STOP
124    END SELECT
125
126    IF(is_master) THEN
127       SELECT CASE(caldyn_thermo)
128       CASE(thermo_theta)
129          PRINT *, 'caldyn_thermo = thermo_theta'
130       CASE(thermo_entropy)
131          PRINT *, 'caldyn_thermo = thermo_entropy'
132       CASE(thermo_moist_debug)
133          PRINT *, 'caldyn_thermo = thermo_moist_debug'
134       CASE DEFAULT
135          STOP
136       END SELECT
137
138       SELECT CASE(physics_thermo)
139       CASE(thermo_dry)
140          PRINT *, 'physics_thermo = thermo_dry'
141       CASE(thermo_fake_moist)
142          PRINT *, 'physics_thermo = thermo_fake_moist'
143       CASE(thermo_moist)
144          PRINT *, 'physics_thermo = thermo_moist'
145       END SELECT
146
147       PRINT *, 'nqdyn =', nqdyn
148    END IF
149
150    CALL allocate_caldyn
151
152    IF(grid_type==grid_ico) THEN
153       ! NB : unused now, would be useful for non-traditional / deep-atmosphere
154       DO ind=1,ndomain
155          IF (.NOT. assigned_domain(ind)) CYCLE
156          CALL swap_dimensions(ind)
157          CALL swap_geometry(ind)
158          planetvel=f_planetvel(ind)
159          CALL compute_planetvel(planetvel)
160       END DO
161    END IF
162
163    compute_pvort_only => compute_pvort_only_hex
164
165  END SUBROUTINE init_caldyn
166
167  SUBROUTINE allocate_caldyn
168    CALL allocate_field(f_qu,field_u,type_real,llm, name='qu')
169    CALL allocate_field(f_qv,field_z,type_real,llm, name='qv')
170    CALL allocate_field(f_Kv,field_z,type_real,llm, name='Kv')
171    CALL allocate_field(f_hv,field_z,type_real,llm, name='hv')
172    CALL allocate_field(f_pk,    field_t,type_real,llm,  name='pk')
173    CALL allocate_field(f_wwuu,  field_u,type_real,llm+1,name='wwuu')
174    CALL allocate_field(f_planetvel,  field_u,type_real, name='planetvel') ! planetary velocity at r=a
175    IF(.NOT.hydrostatic) THEN
176       CALL allocate_field(f_Fel,      field_u,type_real,llm+1,name='F_el')
177       CALL allocate_field(f_gradPhi2, field_t,type_real,llm+1,name='gradPhi2')
178       CALL allocate_field(f_wil,      field_t,type_real,llm+1,name='w_il')
179       CALL allocate_field(f_Wetadot,  field_t,type_real,llm,name='W_etadot')
180    END IF
181  END SUBROUTINE allocate_caldyn
182
183  SUBROUTINE caldyn_BC(f_phis, f_geopot, f_wflux)
184    TYPE(t_field),POINTER :: f_phis(:)
185    TYPE(t_field),POINTER :: f_geopot(:)
186    TYPE(t_field),POINTER :: f_wflux(:)
187    REAL(rstd),POINTER  :: phis(:)
188    REAL(rstd),POINTER  :: wflux(:,:)
189    REAL(rstd),POINTER  :: geopot(:,:)
190    REAL(rstd),POINTER  :: wwuu(:,:)
191
192    INTEGER :: ind,i,j,ij,l
193
194    IF (is_omp_first_level) THEN
195       DO ind=1,ndomain
196          IF (.NOT. assigned_domain(ind)) CYCLE
197          CALL swap_dimensions(ind)
198          CALL swap_geometry(ind)
199          geopot=f_geopot(ind)
200          phis=f_phis(ind)
201          wflux=f_wflux(ind)
202          wwuu=f_wwuu(ind)
203         
204          DO ij=ij_begin_ext,ij_end_ext
205              ! lower BCs : geopot=phis, wflux=0, wwuu=0
206              geopot(ij,1) = phis(ij)
207              wflux(ij,1) = 0.
208              wwuu(ij+u_right,1)=0   
209              wwuu(ij+u_lup,1)=0   
210              wwuu(ij+u_ldown,1)=0
211              ! top BCs : wflux=0, wwuu=0
212              wflux(ij,llm+1)  = 0.
213              wwuu(ij+u_right,llm+1)=0   
214              wwuu(ij+u_lup,llm+1)=0   
215              wwuu(ij+u_ldown,llm+1)=0
216          ENDDO
217       END DO
218    ENDIF
219
220    !$OMP BARRIER
221  END SUBROUTINE caldyn_BC
222   
223  SUBROUTINE caldyn(write_out,f_phis, f_ps, f_mass, f_theta_rhodz, f_u, f_q, &
224       f_geopot, f_hflux, f_wflux, f_dps, f_dmass, f_dtheta_rhodz, f_du)
225    USE observable_mod
226    USE disvert_mod, ONLY : caldyn_eta, eta_mass
227    USE trace
228    LOGICAL,INTENT(IN)    :: write_out
229    TYPE(t_field),POINTER :: f_phis(:)
230    TYPE(t_field),POINTER :: f_ps(:)
231    TYPE(t_field),POINTER :: f_mass(:)
232    TYPE(t_field),POINTER :: f_theta_rhodz(:)
233    TYPE(t_field),POINTER :: f_u(:)
234    TYPE(t_field),POINTER :: f_q(:)
235    TYPE(t_field),POINTER :: f_geopot(:)
236    TYPE(t_field),POINTER :: f_hflux(:), f_wflux(:)
237    TYPE(t_field) :: f_dps(:)
238    TYPE(t_field) :: f_dmass(:)
239    TYPE(t_field) :: f_dtheta_rhodz(:)
240    TYPE(t_field) :: f_du(:)
241   
242    REAL(rstd),POINTER :: ps(:), dps(:)
243    REAL(rstd),POINTER :: mass(:,:), theta_rhodz(:,:,:), dtheta_rhodz(:,:,:)
244    REAL(rstd),POINTER :: u(:,:), du(:,:), hflux(:,:), wflux(:,:)
245    REAL(rstd),POINTER :: qu(:,:)
246    REAL(rstd),POINTER :: qv(:,:)
247
248! temporary shared variable
249    REAL(rstd),POINTER  :: theta(:,:,:) 
250    REAL(rstd),POINTER  :: pk(:,:)
251    REAL(rstd),POINTER  :: geopot(:,:)
252    REAL(rstd),POINTER  :: convm(:,:) 
253    REAL(rstd),POINTER  :: wwuu(:,:)
254       
255    INTEGER :: ind
256    LOGICAL,SAVE :: first=.TRUE.
257!$OMP THREADPRIVATE(first)
258   
259    IF (first) THEN
260      first=.FALSE.
261      IF(caldyn_eta==eta_mass) THEN
262         CALL init_message(f_ps,req_i1,req_ps)
263      ELSE
264         CALL init_message(f_mass,req_i1,req_mass)
265      END IF
266      CALL init_message(f_theta_rhodz,req_i1,req_theta_rhodz)
267      CALL init_message(f_u,req_e1_vect,req_u)
268      CALL init_message(f_qu,req_e1_scal,req_qu)
269      ! Overlapping com/compute (deactivated) : MPI messages need to be sent at first call to caldyn
270      ! This is needed only once : the next ones will be sent by timeloop
271!      IF(caldyn_eta==eta_mass) THEN
272!         CALL send_message(f_ps,req_ps)
273!         CALL wait_message(req_ps) 
274!      ELSE
275!         CALL send_message(f_mass,req_mass)
276!         CALL wait_message(req_mass) 
277!      END IF
278    ENDIF
279   
280    CALL trace_start("caldyn")
281
282    IF(caldyn_eta==eta_mass) THEN
283       CALL send_message(f_ps,req_ps) ! COM00
284       CALL wait_message(req_ps) ! COM00
285    ELSE
286       CALL send_message(f_mass,req_mass) ! COM00
287       CALL wait_message(req_mass) ! COM00
288    END IF
289   
290    CALL send_message(f_theta_rhodz,req_theta_rhodz) ! COM01
291    CALL wait_message(req_theta_rhodz) ! COM01 Moved from caldyn_pvort
292    CALL send_message(f_u,req_u) ! COM02
293    CALL wait_message(req_u) ! COM02
294
295    IF(.NOT.hydrostatic) THEN
296       STOP 'caldyn_gcm may not be used yet when non-hydrostatic'
297    END IF
298
299    SELECT CASE(caldyn_conserv)
300    CASE(conserv_energy) ! energy-conserving
301       DO ind=1,ndomain
302          IF (.NOT. assigned_domain(ind)) CYCLE
303          CALL swap_dimensions(ind)
304          CALL swap_geometry(ind)
305          ps=f_ps(ind)
306          u=f_u(ind)
307          theta_rhodz = f_theta_rhodz(ind)
308          mass=f_mass(ind)
309          theta = f_theta(ind)
310          qu=f_qu(ind)
311          qv=f_qv(ind)
312          pk = f_pk(ind)
313          geopot = f_geopot(ind) 
314          hflux=f_hflux(ind)
315          convm = f_dmass(ind)
316          dtheta_rhodz=f_dtheta_rhodz(ind)
317          du=f_du(ind)
318          CALL compute_pvort(ps,u,theta_rhodz(:,:,1), mass,theta,qu,qv) ! COM00 COM01 COM02
319!          CALL compute_theta(ps,theta_rhodz, mass,theta)
320!          CALL compute_pvort_only(u,mass,qu,qv)
321
322          CALL compute_geopot(mass,theta, ps,pk,geopot)
323!          du(:,:)=0.
324!          CALL compute_caldyn_fast(0.,u,mass,theta,pk,geopot,du)
325       ENDDO       
326
327       CALL send_message(f_u,req_u) ! COM02
328       CALL wait_message(req_u) ! COM02
329       CALL send_message(f_qu,req_qu) ! COM03
330       CALL wait_message(req_qu) ! COM03
331
332       DO ind=1,ndomain
333          IF (.NOT. assigned_domain(ind)) CYCLE
334          CALL swap_dimensions(ind)
335          CALL swap_geometry(ind)
336          ps=f_ps(ind)
337          u=f_u(ind)
338          theta_rhodz = f_theta_rhodz(ind)
339          mass=f_mass(ind)
340          theta = f_theta(ind)
341          qu=f_qu(ind)
342          qv=f_qv(ind)
343          pk = f_pk(ind)
344          geopot = f_geopot(ind) 
345          hflux=f_hflux(ind)
346          convm = f_dmass(ind)
347          dtheta_rhodz=f_dtheta_rhodz(ind)
348          du=f_du(ind)
349
350          CALL compute_caldyn_horiz(u,mass,qu,theta,pk,geopot, hflux,convm,dtheta_rhodz(:,:,1),du)
351!          CALL compute_caldyn_slow_hydro(u,mass,hflux,du, .FALSE.) ! FIXME
352!          CALL compute_caldyn_Coriolis(hflux,theta,qu, convm,dtheta_rhodz,du)
353          IF(caldyn_eta==eta_mass) THEN
354             wflux=f_wflux(ind)
355             wwuu=f_wwuu(ind)
356             dps=f_dps(ind)
357             CALL compute_caldyn_vert(u,theta,mass,convm, wflux,wwuu, dps, dtheta_rhodz(:,:,1), du)
358          END IF
359       ENDDO       
360   
361    CASE(conserv_enstrophy) ! enstrophy-conserving
362       DO ind=1,ndomain
363          IF (.NOT. assigned_domain(ind)) CYCLE
364          CALL swap_dimensions(ind)
365          CALL swap_geometry(ind)
366          ps=f_ps(ind)
367          u=f_u(ind)
368          theta_rhodz=f_theta_rhodz(ind)
369          mass=f_mass(ind)
370          theta = f_theta(ind)
371          qu=f_qu(ind)
372          qv=f_qv(ind)
373          CALL compute_pvort(ps,u,theta_rhodz(:,:,1), mass,theta,qu,qv)
374          pk = f_pk(ind)
375          geopot = f_geopot(ind) 
376          CALL compute_geopot(ps,mass,theta, pk,geopot)
377          hflux=f_hflux(ind)
378          convm = f_dmass(ind)
379          dtheta_rhodz=f_dtheta_rhodz(ind)
380          du=f_du(ind)
381          CALL compute_caldyn_horiz(u,mass,qu,theta,pk,geopot, hflux,convm,dtheta_rhodz(:,:,1),du)
382          IF(caldyn_eta==eta_mass) THEN
383             wflux=f_wflux(ind)
384             wwuu=f_wwuu(ind)
385             dps=f_dps(ind)
386             CALL compute_caldyn_vert(u,theta,mass,convm, wflux,wwuu, dps, dtheta_rhodz, du)
387          END IF
388       ENDDO
389       
390    CASE DEFAULT
391       STOP
392    END SELECT
393
394!$OMP BARRIER
395    !    CALL check_mass_conservation(f_ps,f_dps)
396    CALL trace_end("caldyn")
397!!$OMP BARRIER
398   
399END SUBROUTINE caldyn
400
401!-------------------------------- Diagnostics ----------------------------
402
403  SUBROUTINE check_mass_conservation(f_ps,f_dps)
404    TYPE(t_field),POINTER :: f_ps(:)
405    TYPE(t_field),POINTER :: f_dps(:)
406    REAL(rstd),POINTER :: ps(:)
407    REAL(rstd),POINTER :: dps(:)
408    REAL(rstd) :: mass_tot,dmass_tot
409    INTEGER :: ind,i,j,ij
410   
411    mass_tot=0
412    dmass_tot=0
413   
414    CALL transfert_request(f_dps,req_i1)
415    CALL transfert_request(f_ps,req_i1)
416
417    DO ind=1,ndomain
418      CALL swap_dimensions(ind)
419      CALL swap_geometry(ind)
420
421      ps=f_ps(ind)
422      dps=f_dps(ind)
423
424      DO j=jj_begin,jj_end
425        DO i=ii_begin,ii_end
426          ij=(j-1)*iim+i
427          IF (domain(ind)%own(i,j)) THEN
428            mass_tot=mass_tot+ps(ij)*Ai(ij)/g
429            dmass_tot=dmass_tot+dps(ij)*Ai(ij)/g
430          ENDIF
431        ENDDO
432      ENDDO
433   
434    ENDDO
435    IF (is_mpi_root) PRINT*, "mass_tot ", mass_tot,"      dmass_tot ",dmass_tot       
436
437  END SUBROUTINE check_mass_conservation 
438 
439END MODULE caldyn_gcm_mod
Note: See TracBrowser for help on using the repository browser.