== dvr parameters ==


'''Package: (mrun option -r) dvrp_graphics\\
NAMELIST group name: dvrp_graphics_par'''


||='''Parameter Name'''  =||='''FORTRAN Type'''  =||='''Default Value'''  =||='''Explanation'''  =||
|----------------
{{{#!td style="vertical-align:top;width:150px"
[=#clip_dvrp_l '''clip_dvrp_l''']
}}}
{{{#!td style="vertical-align:top;width:50px"
R
}}}
{{{#!td style="vertical-align:top;width:100px"
0.0
}}}
{{{#!td
Left boundary of the displayed domain (in m).\\\\
This parameter can be used to restrict the display of the total horizontal domain, e.g. to reduce the data size of the dvr-output in order to speed-up the animated sequence.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#clip_dvrp_n '''clip_dvrp_n''']
}}}
{{{#!td style="vertical-align:top"
R
}}}
{{{#!td style="vertical-align:top"
([../inipar#ny ny]+1)*[../inipar#dy dy]
}}}
{{{#!td
North boundary of the displayed domain (in m).\\\\
This parameter can be used to restrict the display of the total horizontal domain, e.g. to reduce the data size of the dvr-output in order to speed-up the animated sequence.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#clip_dvrp_r '''clip_dvrp_r''']
}}}
{{{#!td style="vertical-align:top"
R
}}}
{{{#!td style="vertical-align:top"
([../inipar#nx nx]+1)*[../inipar#dx dx]
}}}
{{{#!td
Right boundary of the displayed domain (in m).\\\\
This parameter can be used to restrict the display of the total horizontal domain, e.g. to reduce the data size of the dvr-output in order to speed-up the animated sequence.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#clip_dvrp_s '''clip_dvrp_s''']
}}}
{{{#!td style="vertical-align:top"
R
}}}
{{{#!td style="vertical-align:top"
0.0
}}}
{{{#!td
South boundary of the displayed domain (in m).\\\\
This parameter can be used to restrict the display of the total horizontal domain, e.g. to reduce the data size of the dvr-output in order to speed-up the animated sequence.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#cluster_size '''cluster_size''']
}}}
{{{#!td style="vertical-align:top"
I
}}}
{{{#!td style="vertical-align:top"
}}}
{{{#!td
Vertex cluster size for polygon reduction of topography.\\\\
This parameter can be used to reduce the number of polygones which form the topography isosurface. In case of large numerical grids (large number of gridpoints) and /or complex topography, cluster_size > 1 may speed up the animation significantly. Disadvantage: buildings may loose their strict rectangular shape.\\\\
The allowed range of values is 1 <= '''cluster_size''' <= 5.\\\\
'''Warning:''' The allowed range of values is not checked. Wrong values may lead to unforseen effects or even aborts!
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#color_interval '''color_interval''']
}}}
{{{#!td style="vertical-align:top"
R(2)
}}}
{{{#!td style="vertical-align:top"
0.0, 1.0
}}}
{{{#!td
Interval of values used for determining the particle color displayed in the animation.\\\\
See [#particle_color particle_color] for further explanation.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dt_dvrp '''dt_dvrp''']
}}}
{{{#!td style="vertical-align:top"
R
}}}
{{{#!td style="vertical-align:top"
9999999.9
}}}
{{{#!td
Temporal interval of scenes to be displayed with the '''dvr''' software (in s).\\\\
Isosurfaces, cross sections and particles can be displayed simultaneous. The display of particles requires that the particle transport is switched on (see [../parpar#dt_prel dt_prel]). Objects to be displayed have to be determined with [#mode_dvrp mode_dvrp].\\\\
If output of scenes created by '''dvr''' software is switched on (see [#mode_dvrp mode_dvrp]), this parameter can be used to assign the temporal interval at which scenes are to be created (and the respective  graphical data is to be output to the streaming server). Reference time is the beginning of  the simulation, i.e. output takes place at times t = '''dt_dvrp''', 2*'''dt_dvrp''', 3*'''dt_dvrp''', etc. The actual output times can deviate from these theoretical values (see [../d3par#dt_dopr dt_dopr]).  Is '''dt_dvrp''' < [../d3par#dt dt], then scenes are created and output after each time step (if this is requested it should be '''dt_dvrp''' = 0). 
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrpsize_interval '''dvrpsize_interval''']
}}}
{{{#!td style="vertical-align:top"
R(2)
}}}
{{{#!td style="vertical-align:top"
0.0, 1.0
}}}
{{{#!td
Interval of values used for determining the particle size displayed in the animation.\\\\
See [#particle_dvrpsize particle_dvrpsize] for further explanation.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrp_directory '''dvrp_directory''']
}}}
{{{#!td style="vertical-align:top"
C*80
}}}
{{{#!td style="vertical-align:top"
'default'
}}}
{{{#!td
Name of the directory into which data created by the '''dvr''' software shall be saved.\\\\
By default, the directory name is generated from the user name (see package parameter [#dvrp_username dvrp_username]) and the base file name (given as the argument of '''mrun''' option -d) as '' '<user name>/<base file name>'.''
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrp_file '''dvrp_file''']
}}}
{{{#!td style="vertical-align:top"
C*80
}}}
{{{#!td style="vertical-align:top"
'default'
}}}
{{{#!td
Name of the file into which data created by the '''dvr''' software shall be output.\\\\
This parameter can be given a value only in case of [#dvrp_output dvrp_output] = '' 'local' '' which determines that the data created by '''dvr''' is output to a local file (on the machine where PALM is executed). Apart from the default, it is only allowed to assign '' '/dev/null' '' (which means that no output is really stored). This can be used for special runtime measurements of the '''dvr''' software.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrp_host '''dvrp_host''']
}}}
{{{#!td style="vertical-align:top"
C*80
}}}
{{{#!td style="vertical-align:top"
'origin.rvs.uni-hannover.de'
}}}
{{{#!td
Name of the computer to which data created by the '''dvr''' software shall be transferred. \\\\
In case of [#dvrp_output dvrp_output] = '' 'rtsp' '' only the default value is allowed (streaming server of the RRZN). For [#dvrp_output dvrp_output] = '' 'local' '' the assigned value is ignored.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrp_output '''dvrp_output''']
}}}
{{{#!td style="vertical-align:top"
C*10
}}}
{{{#!td style="vertical-align:top"
'rtsp'
}}}
{{{#!td
Output mode for the '''dvr''' software.\\\\
The following settings are allowed:\\
{{{#!table style="border:none"
{{{#!td style="vertical-align:top;border:none"
'' 'rtsp' ''
}}}
{{{#!td style="vertical-align:top;border:none"
Data created by the '''dvr''' software is transferred using a special transmission protocol to a so-called streaming server, which is able to continuously transfer visualization data with a high transmission rate. 
Additionally, with this output mode a set of files is generated automatically within a directory on the streaming server (beside the visualization data e.g. some html-files) which can be used to visualize the data via an internet-browser plugin. Host (streaming-server) and directory can be defined by the user with [#dvrp_host dvrp_host] and [#dvrp_directory dvrp_directory].
}}}
|------
{{{#!td style="vertical-align:top;border:none"
'' 'ftp' ''
}}}
{{{#!td style="vertical-align:top;border:none"
Data created by the '''dvr''' software is transferred to the destination host (see [#dvrp_host dvrp_host] and [#dvrp_directory dvrp_directory]) using ftp.\\
}}}
|------
{{{#!td style="vertical-align:top;border:none"
'' 'local' ''
}}}
{{{#!td style="vertical-align:top;border:none"
Data created by the '''dvr''' software is output locally on a file defined by [#dvrp_file dvrp_file].
}}}
}}}
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrp_password '''dvrp_password''']
}}}
{{{#!td style="vertical-align:top"
C*80
}}}
{{{#!td style="vertical-align:top"
'!**!**!**!**'
}}}
{{{#!td
Password for the computer to which data created by the dvr software is to be transferred.\\\\
Assigning a password is only necessary in case of [#dvrp_output dvrp_output] = '' 'ftp'.'' For [#dvrp_output dvrp_output] = '' 'rtsp' '' the default value must not be changed!
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrp_psize '''dvrp_psize''']
}}}
{{{#!td style="vertical-align:top"
R
}}}
{{{#!td style="vertical-align:top"
0.2 * [#dx dx]
}}}
{{{#!td
Diameter that particles are given in visualizations with the '''dvr''' software (in m).\\
In case that particles are visualized with the '''dvr''' software (see [wiki:chapter_457 chapter 4.5.7]), their size can be set by parameter '''dvrp_psize'''. All particles are displayed with this same size.\\
Alternatively, the particle size can be controlled by certain flow parameters using parameter [#particle_dvrpsize particle_dvrpsize].\\
Another way to control the particles diameter is to set it with the user-interface in routine {{{user_init_particles}}} (at the beginning of the simulation) and/or to redefine it after each timestep in routine {{{user_particle_attributes}}}.\\
'''Note:''' This parameter determines exclusively the size under which particles appear in the '''dvr''' visualization. The flow relevant particle radius is determined via the particle parameter [#radius radius]!
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#dvrp_username '''dvrp_username''']
}}}
{{{#!td style="vertical-align:top"
C*80
}}}
{{{#!td style="vertical-align:top"
}}}
{{{#!td
User name of a valid account on the computer to which data created by the '''dvr''' software is to be transferred.\\\\
Assigning a value to this parameter is required in case of [#dvrp_output dvrp_output] = '' 'rtsp' '' or '' 'ftp'.''
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#groundplate_color '''groundplate_color''']
}}}
{{{#!td style="vertical-align:top"
R(3)
}}}
{{{#!td style="vertical-align:top"
0.0, 0.6, 0.0
}}}
{{{#!td
Color of the ground plate.\\\\
The color is given in RGB (red/green/blue) portions. The default color of the ground plate is green.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#isosurface_color '''isosurface_color''']
}}}
{{{#!td style="vertical-align:top"
R(3,10)
}}}
{{{#!td style="vertical-align:top"
0.9, 0.9, 0.9
0.8, 0.1, 0.1
0.1, 0.1, 0.8
0.1, 0.8, 0.1
0.6, 0.1, 0.1
0.1, 0.1, 0.6
0.1, 0.6, 0.1
0.4, 0.1, 0.1
0.1, 0.1, 0.4
0.1, 0.4, 0.1
}}}
{{{#!td style="vertical-align:top"
Color of the isosurface(s).\\\\
Colors are given in RGB (red/green/blue) portions. By default, the first isosurface has a gray color, the second a red color, the third a blue color, etc.
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#mode_dvrp '''mode_dvrp''']
}}}
{{{#!td style="vertical-align:top"
C*20(10)
}}}
{{{#!td style="vertical-align:top"
10 * {{{''}}}
}}}
{{{#!td
Graphical objects (isosurfaces, slicers, particles) which are to be created by the '''dvr''' software.\\\\
Several different objects can be assigned simultaneously and will be displayed in the same scene. Allowed values for '''mode_dvrp''' are'' 'isosurface##' ''(isosurface),'' 'slicer##' ''(cross sections), and'' 'particles'.'' Within the strings the hash characters (''"##"'') have to be replaced by two digits 01≤''##''≤99. Up to 10 objects can be assigned at the same time, e.g.:
    '''mode_dvrp''' ='' 'isosurface02', 'slicer01', 'particles', 'slicer02' ''
In this case one isosurface, two cross sections, and particles will be created. The quantities for which isosurfaces or cross sections are to be created have to be selected with the parameter [../d3par#data_output data_output] ('''data_output''' also determines the orientation of the cross section, thus xy, xz, or yz). Since for '''data_output''' lists of variables may be assigned, the digits at the end of the '''mode_dvrp'''-string select the quantity, which is given at the respective position in the respective list (e.g.'' 'isosurface02' ''selects the second 3D quantity of '''data_output''','' 'slicer01' ''selects the first 2D quantity of '''data_output'''). If e.g. '''data_output''' is assigned as '''data_output''' ='' 'u_xy', 'w_xz', 'v_yz', 'pt', 'u', 'w','' then - assuming the above assignment of mode_dvrp - an isosurface of u, a horizontal cross section of u and a vertical cross section (xz) of w are created. For locations of the cross sections see [../d3par#data_output data_output]. The theshold value for which the isosurface is to be created can be defined with parameter [#threshold threshold]. The isosurface color is controlled by parameter [#isosurface_color isosurface_color].\\\\
The particles color and size can be set using parameters [#particle_color particle_color] and [#particle_dvrpsize particle_dvrpsize].\\\\
The vertical extension of the displayed domain is given by [../d3par#nz_do3d nz_do3d].\\\\
The displayed horizontal domain can be restricted using parameters [#clip_dvrp_l clip_dvrp_l], [#clip_dvrp_r clip_dvrp_r], [#clip_dvrp_n clip_dvrp_n], [#clip_dvrp_s clip_dvrp_s].\\\\
If user-defined dvrp objects exist (see [../chapter_3_5_4 chapter 3.5.4]), then '''mode_dvrp''' may also refer to quantities selected with the parameter [../userpar#data_output_user data_output_user] (internally PALM appends them to those selected with the parameter [../d3par#data_output data_output]).\\\\
'''Assignments of mode_dvrp must correspond to those of data_output and data_output_user! '''If e.g. '''data_output''' ='' 'pt_xy', 'w' ''was set, then only the digits "01" are allowed for '''mode_dvrp''', thus'' 'isosurface01' ''and/or'' 'slicer01'.''\\\\
Further details about using the '''dvr''' software are given in [../chapter_4_5_7 chapter 4.5.7].\\\\
'''Note:'''\\
The declaration of color charts to be used still have to be given "manually" in subroutine [../userinterface#user_dvrp_coltab user_dvrp_coltab] (file {{{user_dvrp_coltab.f90}}}).  
}}}
|----------------
{{{#!td style="vertical-align:top"
[=#particle_color '''particle_color''']
}}}
{{{#!td style="vertical-align:top"
C*10
}}}
{{{#!td style="vertical-align:top"
'none'
}}}
{{{#!td
Parameter, which allows to bind the displayed particle color to certain flow quantities.

By default, particles have a black color.

Allowed values for particle_color are:

'absuv' 	Particle color depends on the absolute value of the resolved-scale horizontal velocity (SQRT(u2+v2) at the particle position.
'pt*' 	Particle color depends on the deviation of the resolved-scale potential temperature at the particle position from the horizontally averaged potential temperature (total domain).
'z' 	Particle color depends on the height of the particle with respect to the bottom boundary (z=0).

The colortable used for particles ranges from deep blue to deep red with yellow in between. The interval of values from the above listed quantities to be mapped to these colors is defined by parameter color_interval.

Example:
If particle_color = 'pt*' and color_interval = -0.5, +0.5, then all particles at positions with pt* <= -0.5 K will have a deep blue color and those at positions with pt* >= +0.5 K will have a deep red color, while those with -0.5 < pt* < +0.5 will vary in color from deep blue to deep red and transition from yellow to blue indicate pt* ~ 0.0.
}}}