| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
|---|
| 2 | <html><head> |
|---|
| 3 | <meta http-equiv="CONTENT-TYPE" content="text/html; charset=windows-1252"><title>PALM chapter 3.5.5</title> <meta name="GENERATOR" content="StarOffice 7 (Win32)"> <meta name="AUTHOR" content="Siegfried Raasch"> <meta name="CREATED" content="20040802;14050943"> <meta name="CHANGED" content="20041117;12180008"> <meta name="KEYWORDS" content="parallel LES model"> <style> |
|---|
| 4 | <!-- |
|---|
| 5 | @page { size: 21cm 29.7cm } |
|---|
| 6 | --> |
|---|
| 7 | </style></head> |
|---|
| 8 | <body style="direction: ltr;" lang="en-US"><h3 style="line-height: 100%;"><font size="4">3.5.4 |
|---|
| 9 | User-defined output quantities<br> |
|---|
| 10 | </font></h3>A very typical request of users is the |
|---|
| 11 | calculation and |
|---|
| 12 | output of |
|---|
| 13 | quantities which are not part of PALM's standard output. The basic user |
|---|
| 14 | interface includes a number of subroutines which allow the calculation |
|---|
| 15 | of user-defined quantities and output of these quantities as time series, (horizontally averaged) vertical profile, 2d cross |
|---|
| 16 | section or 3d volume data. The respective subroutines |
|---|
| 17 | contain sample code lines (written as comment lines) for defining, calculating and |
|---|
| 18 | output of such quantities.<br><br>The |
|---|
| 19 | rest of this chapter explains step-by-step how to modify/extend the |
|---|
| 20 | default file user_interface.f90 in order to generate the respective output.<br><br><br><h4>Output of vertical profiles</h4><br><br><h4><span style="font-weight: bold;">Output of 2d cross sections or 3d volume data</span></h4><br>This example shows the output of the |
|---|
| 21 | quantity "square of the u-component" (<span style="font-weight: bold;">Note:</span> this quantity |
|---|
| 22 | could of course easily be calculated from the u-component by |
|---|
| 23 | postprocessing the PALM output so that calculation within PALM is not |
|---|
| 24 | necessarily required). If more than one user-defined |
|---|
| 25 | quantity shall be output, these steps have to be carried out in the |
|---|
| 26 | same way for each of the quantities.<br><br><ol><li>The |
|---|
| 27 | quantity has to be given a unique string identifier, e.g. <span style="font-style: italic;">'u2'</span>. |
|---|
| 28 | This identifier must be different from the identifiers used for the |
|---|
| 29 | PALM standard output (see list in description of parameter <a href="chapter_4.2.html#data_output">data_output</a>). |
|---|
| 30 | To switch on output of this quantity, the user has to assign the string |
|---|
| 31 | identifier to the parameter <a href="chapter_4.3.html#data_output_user">data_output_user</a>, |
|---|
| 32 | eg.:<br><br><span style="font-family: monospace;"> |
|---|
| 33 | data_output_user</span> = <span style="font-style: italic;">'u2'</span>, <span style="font-style: italic;"> 'u2_xy_av'</span><br><br>The |
|---|
| 34 | pure string <span style="font-style: italic;">'u2'</span> |
|---|
| 35 | switches on the output of instantaneous 3d volume data. Output of cross |
|---|
| 36 | section data and time averaged data is switched on by additionally |
|---|
| 37 | appending the strings <span style="font-style: italic;">'_xy'</span>, |
|---|
| 38 | <span style="font-style: italic;">'_xz'</span>, <span style="font-style: italic;">'_yz'</span>, and/or <span style="font-style: italic;">'_av'</span> (for a |
|---|
| 39 | detailed explanation see parameter <a href="chapter_4.2.html#data_output">data_output</a>).<br><br></li><li>In |
|---|
| 40 | order to store the quantities' grid point data within PALM, a 3d data |
|---|
| 41 | array has to be declared in module <a href="chapter_3.5.1.html#user"><span style="font-family: monospace;">user</span></a>:<br><br><span style="font-family: monospace;"> REAL, |
|---|
| 42 | DIMENSION(:,:,:), ALLOCATABLE :: u2, u2_av</span><br><br>The |
|---|
| 43 | second array <span style="font-family: monospace;">u2_av</span> |
|---|
| 44 | is needed in case that output of time averaged data is requested. It is |
|---|
| 45 | used to store the sum of the data of the respective time levels over |
|---|
| 46 | which the average has to be carried out.<br><br><br></li><li>The |
|---|
| 47 | data array has to be allocated in subroutine <a href="chapter_3.5.1.html#user_init"><span style="font-family: monospace;">user_init</span></a>:<br><br><span style="font-family: monospace;"> |
|---|
| 48 | ALLOCATE( u2(nzb:nzt+1,nys-1:nyn+1,nxl-1:nxr+1) )</span><br><br>In |
|---|
| 49 | case that output of time averaged data is requested, the array |
|---|
| 50 | containing the sum has possibly to be read from the restart file (local |
|---|
| 51 | filename <a href="chapter_3.4.html#BININ">BININ</a>) |
|---|
| 52 | by executing the following code in <span style="font-family: monospace;">user_init</span>:<br><br><span style="font-family: monospace;"> |
|---|
| 53 | IF ( initializing_actions == 'read_restart_data' ) |
|---|
| 54 | THEN</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 55 | READ ( 13 ) field_chr</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 56 | DO WHILE ( TRIM( field_chr ) /= '*** end |
|---|
| 57 | user ***' )</span><br style="font-family: monospace;"><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 58 | SELECT CASE ( TRIM( field_chr ) )</span><br style="font-family: monospace;"><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 59 | CASE ( 'u2_av' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 60 | ALLOCATE( |
|---|
| 61 | u2_av(nzb:nzt+1,nys-1:nyn+1,nxl-1:nxr+1) )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 62 | READ ( 13 ) u2_av</span><br style="font-family: monospace;"><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 63 | CASE DEFAULT</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 64 | PRINT*, |
|---|
| 65 | '+++ user_init: unknown |
|---|
| 66 | variable named "', &</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 67 | |
|---|
| 68 | |
|---|
| 69 | TRIM( |
|---|
| 70 | field_chr ), '" found in'</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 71 | PRINT*, |
|---|
| 72 | ' |
|---|
| 73 | data from prior run on PE ', myid</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 74 | |
|---|
| 75 | CALL local_stop</span><br style="font-family: monospace;"><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 76 | END SELECT<br> |
|---|
| 77 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 78 | ENDIF</span><br style="font-family: monospace;"><br><br></li><li>The |
|---|
| 79 | quantity has to be given a unit (subroutine <a href="chapter_3.5.1.html#user_check_data_output"><span style="font-family: monospace;">user_check_data_output</span></a>):<br><br><span style="font-family: monospace;"> CASE ( |
|---|
| 80 | 'u2' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 81 | unit = 'm2/s2'</span><br> <br>Otherwise, |
|---|
| 82 | PALM will abort.<br><br><br></li><li>The |
|---|
| 83 | vertical grid on which the quantity is defined (given by the levels |
|---|
| 84 | 'zu' or 'zw', on which the u- or w-component of the velocity are |
|---|
| 85 | defined) has to be specified for the NetCDF output files in subroutine <a href="chapter_3.5.1.html#user_define_netcdf_grid"><span style="font-family: monospace;">user_define_netcdf_grid</span></a>:<br><br><span style="font-family: monospace;"> |
|---|
| 86 | CASE ( 'u2', 'u2_xy', 'u2_xz', 'u2_yz' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 87 | grid = 'zu'</span><br> <br>As |
|---|
| 88 | the example shows, this grid has to be defined for the 3d volume data |
|---|
| 89 | as well as for all of the three cross sections.<br><span style="font-family: monospace;"><br><br></span></li><li>After |
|---|
| 90 | each timestep, the quantity has to be calculated at all gridpoints and |
|---|
| 91 | to be stored. This has to be done in subroutine <a href="chapter_3.5.1#user_actions"><span style="font-family: monospace;">user_actions</span></a> |
|---|
| 92 | at location 'after_integration':<br><br><span style="font-family: monospace;"> CASE |
|---|
| 93 | ( 'after_integration' )</span><br style="font-family: monospace;"><span style="font-family: monospace;">!</span><br style="font-family: monospace;"><span style="font-family: monospace;">!-- |
|---|
| 94 | Enter actions to be done after every time integration (before</span><br style="font-family: monospace;"><span style="font-family: monospace;">!-- |
|---|
| 95 | data output)</span><br style="font-family: monospace;"><span style="font-family: monospace;">!-- |
|---|
| 96 | Sample for user-defined output:</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 97 | DO i = nxl-1, nxr+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 98 | DO j = nys-1, nyn+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 99 | DO k = nzb, nzt+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 100 | u2(k,j,i) = u(k,j,i)**2</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 101 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 102 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 103 | ENDDO</span><br><br> <br></li><li>In |
|---|
| 104 | case that output of time-averaged data is requested, the sum- and |
|---|
| 105 | average-operations as well as the allocation of the sum-array have to |
|---|
| 106 | be carried out in subroutine <a href="chapter_3.5.1.html#user_3d_data_averaging"><span style="font-family: monospace;">user_3d_data_averaging</span></a>:<br><br><span style="font-family: monospace;"> |
|---|
| 107 | IF ( mode == 'allocate' ) THEN<br> |
|---|
| 108 | ...</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 109 | CASE ( 'u2' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 110 | IF ( .NOT. ALLOCATED( u2_av ) ) THEN</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 111 | ALLOCATE( u2_av(nzb:nzt+1,nys-1:nyn+1,nxl-1:nxr+1) )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 112 | ENDIF</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 113 | u2_av = 0.0<br> ...</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 114 | ELSEIF ( mode == 'sum' ) THEN<br> |
|---|
| 115 | ...</span><br style="font-family: monospace;"><span style="font-family: monospace;"> CASE |
|---|
| 116 | ( 'u2' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 117 | DO i = nxl-1, nxr+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 118 | DO j = nys-1, nyn+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 119 | DO k = nzb, nzt+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 120 | u2_av(k,j,i) = u2_av(k,j,i) + u2(k,j,i)</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 121 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 122 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 123 | ENDDO<br> ...</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 124 | ELSEIF ( mode == 'average' ) THEN<br> |
|---|
| 125 | ...</span><br style="font-family: monospace;"><span style="font-family: monospace;"> CASE |
|---|
| 126 | ( 'u2' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 127 | DO i = nxl-1, nxr+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 128 | DO j = nys-1, nyn+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 129 | DO k = nzb, nzt+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 130 | u2_av(k,j,i) = u2_av(k,j,i) / REAL( average_count_3d )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 131 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 132 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 133 | ENDDO</span><br><br> </li><li>For |
|---|
| 134 | output of 2d cross sections, the gridpoint data of the quantity has to |
|---|
| 135 | be resorted to array <span style="font-family: monospace;">local_pf</span> |
|---|
| 136 | in subroutine <a href="chapter_3.5.1.html#user_data_output_2d"><span style="font-family: monospace;">user_data_output_2d</span></a>. |
|---|
| 137 | Also the vertical grid, on which the quantity is defined, has to be set |
|---|
| 138 | again:<br><br><span style="font-family: monospace;"> CASE |
|---|
| 139 | ( 'u2_xy', 'u2_xz', 'u2_yz' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 140 | IF ( av == 0 ) THEN</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 141 | DO i = nxl-1, nxr+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 142 | DO j = nys-1, nyn+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 143 | DO k = nzb, nzt+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 144 | local_pf(i,j,k) = u2(k,j,i)</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 145 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 146 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 147 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 148 | ELSE</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 149 | DO i = nxl-1, nxr+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 150 | DO j = nys-1, nyn+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 151 | DO k = nzb, nzt+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 152 | local_pf(i,j,k) = u2_av(k,j,i)</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 153 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 154 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 155 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 156 | ENDIF</span><br style="font-family: monospace;"><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 157 | grid = 'zu'</span><br> <br>The <span style="font-family: monospace;">ELSE</span> case is |
|---|
| 158 | only needed in case that output of time-averaged data is requested.<br><br><br></li><li>For |
|---|
| 159 | output of 3d volume data, the gridpoint data of the quantity has to be |
|---|
| 160 | resorted to array <span style="font-family: monospace;">local_pf</span> |
|---|
| 161 | in subroutine <a href="chapter_3.5.1.html#user_data_output_3d"><span style="font-family: monospace;">user_data_output_3d</span></a>. |
|---|
| 162 | Also the vertical grid, on which the quantity is defined, has to be set |
|---|
| 163 | again:<br><br><span style="font-family: monospace;"> CASE |
|---|
| 164 | ( 'u2' )</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 165 | IF ( av == 0 ) THEN</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 166 | DO i = nxl-1, nxr+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 167 | DO j = nys-1, nyn+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 168 | DO k = nzb, nz_do</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 169 | local_pf(i,j,k) = u2(k,j,i)</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 170 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 171 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 172 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 173 | ELSE</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 174 | DO i = nxl-1, nxr+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 175 | DO j = nys-1, nyn+1</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 176 | DO k = nzb, nz_do</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 177 | local_pf(i,j,k) = u2_av(k,j,i)</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 178 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 179 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 180 | ENDDO</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 181 | ENDIF</span><br style="font-family: monospace;"><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 182 | grid = 'zu'</span><br><br>The <span style="font-family: monospace;">ELSE</span> case is |
|---|
| 183 | only needed in case that output of time-averaged data is requested.<br><br><br></li><li>In |
|---|
| 184 | case of job chains, the sum array has to be written to the (binary) |
|---|
| 185 | restart file (local filename <a href="chapter_3.4.html#BINOUT">BINOUT</a>) |
|---|
| 186 | in subroutine <a href="chapter_3.5.1.html#user_last_actions"><span style="font-family: monospace;">user_last_actions</span></a>:<br><br><span style="font-family: monospace;"> |
|---|
| 187 | IF ( ALLOCATED( u2_av ) ) THEN</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 188 | WRITE ( 14 ) |
|---|
| 189 | 'u2_av |
|---|
| 190 | '; WRITE ( 14 ) u2_av</span><br style="font-family: monospace;"><span style="font-family: monospace;"> |
|---|
| 191 | ENDIF</span><br><br>Otherwise, the calculated |
|---|
| 192 | time-average may be wrong. </li></ol><hr> |
|---|
| 193 | <p style="line-height: 100%;"><br><font color="#000080"><font color="#000080"><a href="chapter_3.5.3.html"><font color="#000080"><img src="left.gif" name="Grafik1" align="bottom" border="2" height="32" width="32"></font></a><a href="index.html"><font color="#000080"><img src="up.gif" name="Grafik2" align="bottom" border="2" height="32" width="32"></font></a><a href="chapter_3.5.5.html"><font color="#000080"><img style="border: 2px solid ; width: 32px; height: 32px;" alt="" src="right.gif" name="Grafik3"></font></a></font></font></p> |
|---|
| 194 | <p style="line-height: 100%;"><i>Last |
|---|
| 195 | change: </i> $Id: chapter_3.5.4.html 88 2007-05-22 15:48:17Z raasch $</p> |
|---|
| 196 | </body></html> |
|---|
