source: palm/trunk/SOURCE/data_output_dvrp.f90 @ 1874

Last change on this file since 1874 was 1874, checked in by maronga, 5 years ago

last commit documented

  • Property svn:keywords set to Id
File size: 19.6 KB
Line 
1!> @file data_output_dvrp.f90
2!--------------------------------------------------------------------------------!
3! This file is part of PALM.
4!
5! PALM is free software: you can redistribute it and/or modify it under the terms
6! of the GNU General Public License as published by the Free Software Foundation,
7! either version 3 of the License, or (at your option) any later version.
8!
9! PALM is distributed in the hope that it will be useful, but WITHOUT ANY
10! WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
11! A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
12!
13! You should have received a copy of the GNU General Public License along with
14! PALM. If not, see <http://www.gnu.org/licenses/>.
15!
16! Copyright 1997-2016 Leibniz Universitaet Hannover
17!--------------------------------------------------------------------------------!
18!
19! Current revisions:
20! -----------------
21!
22!
23! Former revisions:
24! -----------------
25! $Id: data_output_dvrp.f90 1874 2016-04-18 14:51:10Z maronga $
26!
27! 1873 2016-04-18 14:50:06Z maronga
28! Module renamed (removed _mod)
29!
30!
31! 1850 2016-04-08 13:29:27Z maronga
32! Module renamed
33!
34!
35! 1822 2016-04-07 07:49:42Z hoffmann
36! Particles and tails removed.
37!
38! 1682 2015-10-07 23:56:08Z knoop
39! Code annotations made doxygen readable
40!
41! 1353 2014-04-08 15:21:23Z heinze
42! REAL constants provided with KIND-attribute
43!
44! 1346 2014-03-27 13:18:20Z heinze
45! Bugfix: REAL constants provided with KIND-attribute especially in call of
46! intrinsic function like MAX, MIN, SIGN
47!
48! 1320 2014-03-20 08:40:49Z raasch
49! ONLY-attribute added to USE-statements,
50! kind-parameters added to all INTEGER and REAL declaration statements,
51! kinds are defined in new module kinds,
52! revision history before 2012 removed,
53! comment fields (!:) to be used for variable explanations added to
54! all variable declaration statements
55!
56! 1318 2014-03-17 13:35:16Z raasch
57! module interfaces removed
58!
59! 1036 2012-10-22 13:43:42Z raasch
60! code put under GPL (PALM 3.9)
61!
62! 828 2012-02-21 12:00:36Z raasch
63! particle feature color renamed class
64!
65! Revision 1.1  2000/04/27 06:27:17  raasch
66! Initial revision
67!
68!
69! Description:
70! ------------
71!> Plot of isosurface and slicers with dvrp-software
72!------------------------------------------------------------------------------!
73 MODULE dvrp_color
74 
75
76    USE dvrp_variables
77   
78    USE kinds
79
80    IMPLICIT NONE
81
82 CONTAINS
83
84!------------------------------------------------------------------------------!
85! Description:
86! ------------
87!> @todo Missing subroutine description.
88!------------------------------------------------------------------------------!
89    SUBROUTINE color_dvrp( value, color )
90
91       REAL(wp), INTENT(IN)  ::  value    !<
92       REAL(wp), INTENT(OUT) ::  color(4) !<
93
94       REAL(wp)              ::  scale    !<
95
96       scale = ( value - slicer_range_limits_dvrp(1,islice_dvrp) ) /           &
97               ( slicer_range_limits_dvrp(2,islice_dvrp) -                     &
98                 slicer_range_limits_dvrp(1,islice_dvrp) )
99
100       scale = MODULO( 180.0_wp + 180.0_wp * scale, 360.0_wp )
101
102       color = (/ scale, 0.5_wp, 1.0_wp, 0.0_wp /)
103
104    END SUBROUTINE color_dvrp
105
106 END MODULE dvrp_color
107
108
109 RECURSIVE SUBROUTINE data_output_dvrp
110
111#if defined( __dvrp_graphics )
112
113    USE arrays_3d,                                                             &
114        ONLY:  p, pt, q, ql, ts, u, us, v, w, zu
115       
116    USE cloud_parameters,                                                      &
117        ONLY:  l_d_cp, pt_d_t
118       
119    USE constants,                                                             &
120        ONLY:  pi
121       
122    USE control_parameters,                                                    &
123        ONLY:  cloud_droplets, cloud_physics, do2d, do3d, humidity, ibc_uv_b,  &
124               message_string, nz_do3d, passive_scalar, simulated_time,        &
125               threshold
126       
127    USE cpulog,                                                                &
128        ONLY:  log_point, log_point_s, cpu_log
129       
130    USE DVRP
131   
132    USE dvrp_color
133       
134    USE dvrp_variables
135       
136    USE grid_variables,                                                        &
137        ONLY:  dx, dy
138       
139    USE indices,                                                               &
140        ONLY:  nxl, nxr, nyn, nys, nzb
141       
142    USE kinds
143
144    USE pegrid
145
146    IMPLICIT NONE
147
148    CHARACTER (LEN=2) ::  section_chr      !<
149    CHARACTER (LEN=6) ::  output_variable  !<
150   
151    INTEGER(iwp) ::  c_mode           !< 
152    INTEGER(iwp) ::  c_size_x         !<
153    INTEGER(iwp) ::  c_size_y         !<
154    INTEGER(iwp) ::  c_size_z         !<
155    INTEGER(iwp) ::  dvrp_nop         !<
156    INTEGER(iwp) ::  dvrp_not         !<
157    INTEGER(iwp) ::  gradient_normals !<
158    INTEGER(iwp) ::  i                !<
159    INTEGER(iwp) ::  ip               !<
160    INTEGER(iwp) ::  j                !<
161    INTEGER(iwp) ::  jp               !<
162    INTEGER(iwp) ::  k                !<
163    INTEGER(iwp) ::  l                !<
164    INTEGER(iwp) ::  m                !<
165    INTEGER(iwp) ::  n                !<
166    INTEGER(iwp) ::  n_isosurface     !<
167    INTEGER(iwp) ::  n_slicer         !<
168    INTEGER(iwp) ::  nn               !<
169    INTEGER(iwp) ::  section_mode     !<
170    INTEGER(iwp) ::  vn               !<
171    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  p_c  !<
172    INTEGER(iwp), DIMENSION(:), ALLOCATABLE ::  p_t  !<
173
174    LOGICAL, DIMENSION(:), ALLOCATABLE ::  dvrp_mask  !<
175
176    REAL(sp) ::  slicer_position  !<
177    REAL(sp) ::  tmp_alpha        !<
178    REAL(sp) ::  tmp_alpha_w      !<
179    REAL(sp) ::  tmp_b            !<
180    REAL(sp) ::  tmp_c_alpha      !<
181    REAL(sp) ::  tmp_g            !<
182    REAL(sp) ::  tmp_norm         !<
183    REAL(sp) ::  tmp_pos          !<
184    REAL(sp) ::  tmp_r            !<
185    REAL(sp) ::  tmp_t            !<
186    REAL(sp) ::  tmp_th           !<
187    REAL(sp), DIMENSION(:),     ALLOCATABLE   ::  psize  !<
188    REAL(sp), DIMENSION(:),     ALLOCATABLE   ::  p_x    !<
189    REAL(sp), DIMENSION(:),     ALLOCATABLE   ::  p_y    !<
190    REAL(sp), DIMENSION(:),     ALLOCATABLE   ::  p_z    !<
191    REAL(sp), DIMENSION(:,:,:), ALLOCATABLE   ::  local_pf  !<
192    REAL(sp), DIMENSION(:,:,:,:), ALLOCATABLE ::  local_pfi !<
193
194
195    CALL cpu_log( log_point(27), 'data_output_dvrp', 'start' )
196
197!
198!-- Loop over all output modes choosed
199    m            = 1
200    n_isosurface = 0  ! isosurface counter (for threshold values and color)
201    n_slicer     = 0  ! slice plane counter (for range of values)
202    DO WHILE ( mode_dvrp(m) /= ' ' )
203!
204!--    Update of the steering variables
205       IF ( .NOT. lock_steering_update )  THEN
206!
207!--       Set lock to avoid recursive calls of DVRP_STEERING_UPDATE
208          lock_steering_update = .TRUE.
209!          CALL DVRP_STEERING_UPDATE( m-1, data_output_dvrp )
210          lock_steering_update = .FALSE.
211       ENDIF
212
213!
214!--    Determine the variable which shall be plotted (in case of slicers or
215!--    isosurfaces)
216       IF ( mode_dvrp(m)(1:10) == 'isosurface' )  THEN
217          READ ( mode_dvrp(m), '(10X,I2)' )  vn
218          output_variable = do3d(0,vn)
219          n_isosurface = n_isosurface + 1
220       ELSEIF ( mode_dvrp(m)(1:6) == 'slicer' )  THEN
221          READ ( mode_dvrp(m), '(6X,I2)' )  vn
222          output_variable = do2d(0,vn)
223          l = MAX( 2, LEN_TRIM( do2d(0,vn) ) )
224          section_chr = do2d(0,vn)(l-1:l)
225          SELECT CASE ( section_chr )
226             CASE ( 'xy' )
227                section_mode = 2
228                slicer_position = zu(MIN( slicer_position_dvrp(m), nz_do3d ))
229             CASE ( 'xz' )
230                section_mode = 1
231                slicer_position = slicer_position_dvrp(m) * dy
232             CASE ( 'yz' )
233                section_mode = 0
234                slicer_position = slicer_position_dvrp(m) * dx
235          END SELECT
236       ENDIF
237
238!
239!--    Select the plot mode (in case of isosurface or slicer only if user has
240!--    defined a variable which shall be plotted; otherwise do nothing)
241       IF ( ( mode_dvrp(m)(1:10) == 'isosurface'  .OR.                     &
242                  mode_dvrp(m)(1:6)  == 'slicer'           )                   &
243                  .AND.  output_variable /= ' ' )  THEN
244
245!
246!--       Create an intermediate array, properly dimensioned for plot-output
247          ALLOCATE( local_pf(nxl_dvrp:nxr_dvrp+1,nys_dvrp:nyn_dvrp+1,          &
248                             nzb:nz_do3d) )
249
250!
251!--       Move original array to intermediate array
252          IF ( dvrp_overlap )  THEN
253
254             SELECT CASE ( output_variable )
255
256                CASE ( 'u', 'u_xy', 'u_xz', 'u_yz' )
257                   DO  i = nxl_dvrp, nxr_dvrp+1
258                      DO  j = nys_dvrp, nyn_dvrp+1
259                         DO  k = nzb, nz_do3d
260                            local_pf(i,j,k) = u(k,j,i)
261                         ENDDO
262                      ENDDO
263                   ENDDO
264!
265!--                Replace mirrored values at lower surface by real surface
266!--                values
267                   IF ( output_variable == 'u_xz'  .OR.                        &
268                        output_variable == 'u_yz' )  THEN
269                      IF ( ibc_uv_b == 0 )  local_pf(:,:,nzb) = 0.0_wp
270                   ENDIF
271
272
273                CASE ( 'v', 'v_xy', 'v_xz', 'v_yz' )
274                   DO  i = nxl_dvrp, nxr_dvrp+1
275                      DO  j = nys_dvrp, nyn_dvrp+1
276                         DO  k = nzb, nz_do3d
277                            local_pf(i,j,k) = v(k,j,i)
278                         ENDDO
279                      ENDDO
280                   ENDDO
281!
282!--                Replace mirrored values at lower surface by real surface
283!--                values
284                   IF ( output_variable == 'v_xz'  .OR.                        &
285                        output_variable == 'v_yz' )  THEN
286                      IF ( ibc_uv_b == 0 )  local_pf(:,:,nzb) = 0.0_wp
287                   ENDIF
288
289                CASE ( 'w', 'w_xy', 'w_xz', 'w_yz' )
290                   DO  i = nxl_dvrp, nxr_dvrp+1
291                      DO  j = nys_dvrp, nyn_dvrp+1
292                         DO  k = nzb, nz_do3d
293                            local_pf(i,j,k) = w(k,j,i)
294                         ENDDO
295                      ENDDO
296                   ENDDO
297! Averaging for Langmuir circulation
298!                   DO  k = nzb, nz_do3d
299!                      DO  j = nys_dvrp+1, nyn_dvrp
300!                         DO  i = nxl_dvrp, nxr_dvrp+1
301!                            local_pf(i,j,k) = 0.25 * local_pf(i,j-1,k) + &
302!                                              0.50 * local_pf(i,j,k)   + &
303!                                              0.25 * local_pf(i,j+1,k)
304!                         ENDDO
305!                      ENDDO
306!                   ENDDO
307
308                CASE ( 'p', 'p_xy', 'p_xz', 'p_yz' )
309                   DO  i = nxl_dvrp, nxr_dvrp+1
310                      DO  j = nys_dvrp, nyn_dvrp+1
311                         DO  k = nzb, nz_do3d
312                            local_pf(i,j,k) = p(k,j,i)
313                         ENDDO
314                      ENDDO
315                   ENDDO
316
317                CASE ( 'pt', 'pt_xy', 'pt_xz', 'pt_yz' )
318                   IF ( .NOT. cloud_physics ) THEN
319                      DO  i = nxl_dvrp, nxr_dvrp+1
320                         DO  j = nys_dvrp, nyn_dvrp+1
321                            DO  k = nzb, nz_do3d
322                               local_pf(i,j,k) = pt(k,j,i)
323                            ENDDO
324                         ENDDO
325                      ENDDO
326                   ELSE
327                      DO  i = nxl_dvrp, nxr_dvrp+1
328                         DO  j = nys_dvrp, nyn_dvrp+1
329                            DO  k = nzb, nz_do3d
330                               local_pf(i,j,k) = pt(k,j,i) + l_d_cp *          &
331                                                 pt_d_t(k) * ql(k,j,i)
332                            ENDDO
333                         ENDDO
334                      ENDDO
335                   ENDIF
336
337                CASE ( 'q', 'q_xy', 'q_xz', 'q_yz' )
338                   IF ( humidity  .OR.  passive_scalar )  THEN
339                      DO  i = nxl_dvrp, nxr_dvrp+1
340                         DO  j = nys_dvrp, nyn_dvrp+1
341                            DO  k = nzb, nz_do3d
342                               local_pf(i,j,k) = q(k,j,i)
343                            ENDDO
344                         ENDDO
345                      ENDDO           
346                   ELSE                   
347                      message_string = 'if humidity/passive_scalar = '    //   & 
348                            'FALSE output of ' // TRIM( output_variable ) //   &
349                            'is not provided' 
350                      CALL message( 'data_output_dvrp', 'PA0183',&
351                                                                 0, 0, 0, 6, 0 )
352                   ENDIF
353             
354                CASE ( 'ql', 'ql_xy', 'ql_xz', 'ql_yz' )
355                   IF ( cloud_physics  .OR.  cloud_droplets )  THEN
356                      DO  i = nxl_dvrp, nxr_dvrp+1
357                         DO  j = nys_dvrp, nyn_dvrp+1
358                            DO  k = nzb, nz_do3d
359                               local_pf(i,j,k) = ql(k,j,i)
360                            ENDDO
361                         ENDDO
362                      ENDDO
363                   ELSE                     
364                      message_string = 'if cloud_physics = FALSE '       //    & 
365                                  'output of ' // TRIM( output_variable) //    &
366                                  'is not provided' 
367                      CALL message( 'data_output_dvrp', 'PA0184',&
368                                                                 0, 0, 0, 6, 0 )
369                   ENDIF
370
371                CASE ( 'u*_xy' )
372                   DO  i = nxl_dvrp, nxr_dvrp+1
373                      DO  j = nys_dvrp, nyn_dvrp+1
374                         local_pf(i,j,nzb+1) = us(j,i)
375                      ENDDO
376                   ENDDO
377                   slicer_position = zu(nzb+1)
378
379                CASE ( 't*_xy' )
380                   DO  i = nxl_dvrp, nxr_dvrp+1
381                      DO  j = nys_dvrp, nyn_dvrp+1
382                         local_pf(i,j,nzb+1) = ts(j,i)
383                      ENDDO
384                   ENDDO
385                   slicer_position = zu(nzb+1)
386
387
388                CASE DEFAULT
389!
390!--                The DEFAULT case is reached either if output_variable
391!--                contains unsupported variable or if the user has coded a
392!--                special case in the user interface. There, the subroutine
393!--                user_data_output_dvrp checks which of these two conditions
394!--                applies.
395                   CALL user_data_output_dvrp( output_variable, local_pf )
396
397
398             END SELECT
399
400          ELSE
401!
402!--          No overlap of clipping domain with the current subdomain
403             DO  i = nxl_dvrp, nxr_dvrp+1
404                DO  j = nys_dvrp, nyn_dvrp+1
405                   DO  k = nzb, nz_do3d
406                      local_pf(i,j,k) = 0.0_wp
407                   ENDDO
408                ENDDO
409             ENDDO
410
411          ENDIF
412
413          IF ( mode_dvrp(m)(1:10) == 'isosurface' )  THEN
414
415!
416!--          DVRP-Calls for plotting isosurfaces:
417             CALL cpu_log( log_point_s(26), 'dvrp_isosurface', 'start' )
418
419!
420!--          Definition of isosurface color
421             tmp_r = isosurface_color(1,n_isosurface)
422             tmp_g = isosurface_color(2,n_isosurface)
423             tmp_b = isosurface_color(3,n_isosurface)
424             tmp_t = 0.0_wp
425             CALL DVRP_MATERIAL_RGB( m-1, 1, tmp_r, tmp_g, tmp_b, tmp_t )
426
427!
428!--          Compute and plot isosurface in dvr-format
429             CALL DVRP_DATA( m-1, local_pf, 1, nx_dvrp, ny_dvrp, nz_dvrp,      &
430                             cyclic_dvrp, cyclic_dvrp, cyclic_dvrp )
431
432             c_size_x = vc_size_x;  c_size_y = vc_size_y;  c_size_z = vc_size_z
433             CALL DVRP_CLUSTER_SIZE( m-1, c_size_x, c_size_y, c_size_z )
434
435             c_mode   = vc_mode
436             CALL DVRP_CLUSTERING_MODE( m-1, c_mode )
437
438             gradient_normals = vc_gradient_normals
439             CALL DVRP_GRADIENTNORMALS( m-1, gradient_normals )
440
441!
442!--          A seperate procedure for setting vc_alpha will be in the next
443!--          version of libDVRP
444             tmp_c_alpha = vc_alpha
445             CALL DVRP_THRESHOLD( -(m-1)-1, tmp_c_alpha )
446
447             IF ( dvrp_overlap )  THEN
448                tmp_th = threshold(n_isosurface)
449             ELSE
450                tmp_th = 1.0_wp  ! nothing is plotted because array values are 0
451             ENDIF
452
453             CALL DVRP_THRESHOLD( m-1, tmp_th )
454
455             CALL DVRP_VISUALIZE( m-1, 21, dvrp_filecount )
456
457             CALL cpu_log( log_point_s(26), 'dvrp_isosurface', 'stop' )
458
459          ELSEIF ( mode_dvrp(m)(1:6) == 'slicer' )  THEN
460
461!
462!--          DVRP-Calls for plotting slicers:
463             CALL cpu_log( log_point_s(27), 'dvrp_slicer', 'start' )
464
465!
466!--          Material and color definitions
467             tmp_r = 0.0_wp;  tmp_g = 0.0_wp;  tmp_b = 0.0_wp;  tmp_t = 0.0_wp
468             CALL DVRP_MATERIAL_RGB( m-1, 1, tmp_r, tmp_g, tmp_b, tmp_t )
469
470             n_slicer = n_slicer + 1
471
472!
473!--           Using dolorfunction has not been properly tested
474!             islice_dvrp = n_slicer
475!             CALL DVRP_COLORFUNCTION( m-1, DVRP_CM_HLS, 25,                 &
476!                                      slicer_range_limits_dvrp(:,n_slicer), &
477!                                      color_dvrp )
478
479!
480!--          Set interval of values defining the colortable
481             CALL set_slicer_attributes_dvrp( n_slicer )
482
483!
484!--          Create user-defined colortable
485             CALL user_dvrp_coltab( 'slicer', output_variable )
486
487             CALL DVRP_COLORTABLE_HLS( m-1, 1, interval_values_dvrp,           &
488                                       interval_h_dvrp, interval_l_dvrp,       &
489                                       interval_s_dvrp, interval_a_dvrp )
490
491!
492!--          Compute and plot slicer in dvr-format
493             CALL DVRP_DATA( m-1, local_pf, 1, nx_dvrp, ny_dvrp, nz_dvrp,      &
494                             cyclic_dvrp, cyclic_dvrp, cyclic_dvrp )
495             tmp_pos = slicer_position
496             CALL DVRP_SLICER( m-1, section_mode, tmp_pos )
497
498             CALL DVRP_VISUALIZE( m-1, 2, dvrp_filecount )
499
500             CALL cpu_log( log_point_s(27), 'dvrp_slicer', 'stop' )
501
502          ENDIF
503
504          DEALLOCATE( local_pf )
505
506       ELSEIF ( mode_dvrp(m)(1:9) == 'pathlines' ) THEN
507
508          ALLOCATE( local_pfi(4,nxl:nxr+1,nys:nyn+1,nzb:nz_do3d) )
509          DO  i = nxl, nxr+1
510             DO  j = nys, nyn+1
511                DO  k = nzb, nz_do3d
512                   local_pfi(1,i,j,k) = u(k,j,i)
513                   local_pfi(2,i,j,k) = v(k,j,i)
514                   local_pfi(3,i,j,k) = w(k,j,i)
515                   tmp_norm           = SQRT( u(k,j,i) * u(k,j,i) +            &
516                                              v(k,j,i) * v(k,j,i) +            &
517                                              w(k,j,i) * w(k,j,i) )
518                   tmp_alpha          = ACOS( 0.0_wp * u(k,j,i) / tmp_norm +   &
519                                              0.0_wp * v(k,j,i) / tmp_norm -   &
520                                              1.0_wp * w(k,j,i) / tmp_norm )
521                   tmp_alpha_w        = tmp_alpha / pi * 180.0_wp
522                   local_pfi(4,i,j,k) = tmp_alpha_w
523                ENDDO
524             ENDDO
525          ENDDO
526
527          CALL cpu_log( log_point_s(31), 'dvrp_pathlines', 'start' )
528
529          CALL DVRP_DATA( m-1, local_pfi, 4, nx_dvrp, ny_dvrp, nz_dvrp, &
530                          cyclic_dvrp, cyclic_dvrp, cyclic_dvrp )
531          CALL DVRP_VISUALIZE( m-1, 20, dvrp_filecount )
532
533          CALL cpu_log( log_point_s(31), 'dvrp_pathlines', 'stop' )
534
535          DEALLOCATE( local_pfi )
536
537       ENDIF
538
539       m = m + 1
540
541    ENDDO
542
543    dvrp_filecount = dvrp_filecount + 1
544
545    CALL cpu_log( log_point(27), 'data_output_dvrp', 'stop' )
546
547#endif
548 END SUBROUTINE data_output_dvrp
Note: See TracBrowser for help on using the repository browser.