HVIEW2D.DAT
From BAWiki
Basic Information
File-Type
hview2d.dat
File-Form
FORMATTED
Version
V9.x / April 2009
Description-Date
April 2009
Significance of the File
contains general input data for the program HVIEW2D
File-Contents (in Catchwords)
Input Steering Data
- general steering data (block Program_Parameters)
- key "Language" : language selection for descriptive text:
- DE = German,
- EN = English.
- input files (block Input_Files).
- key "Lights_File" : colour table definitions file (filetype lights.dat)
- key "Isoerg_File" : definition of additional isolines for bathymetry (filetype isoerg.dat)
- key "Layout_File" : layout file (filetype layout.dat)
- (optional) key "Insel_File" : structural lines (filetype insel.dat)
- (optional) key "Frames_File" : definition of static frames (filetype frames.dat)
- (optional) key "Tideclock_File" : informations for a tide clock representation (filetype tideclock.dat)
- (optional) key "Grid_File" : grid for 2D/3D-data (filetype gitter05.dat/bin or selafin or untrim_grid.dat)
- Notice: for 3D data sets with time varying bathymetry the depth values in the grid file must be equivalent to the depth of the non-erodible layer, whereas for corresponding 2D data sets values for actual depth are sufficient. In connexion with data sets defined for constant bathymetry the grid file must contain values for actual depth without exception.
- (optional) key "Fkvz_File" : list of edges (filetype fkvz.bin)
- Notice: file will be automatically generated if not present
- (optional) key "Fkez_File" : list of neighbour elements (filetype fkez.bin)
- Notice: file will be automatically generated if not present
- (optional) result files (block Result_Files).
- key "Result" : result files (files of type dirz.bin.r, dirz.bin.i and dirz.bin)
- (optional) log file (block Log_File).
- key "Log_File" : GKS-Logfile to record user interaction for the current session or to replay a session which was recorded before (filetype Log.dat).
- Notice: if the log-file is present, the recorded session will be replayed. If the log-file does not exist, the current session is going to be be recorded.
introductory remarks concerning the subsequent optional blocks:
- switches can be used to influence the graphics displayed (see switches of the program HVIEW2D).
- the default setting of the program can be altered within subsequent blocks.
- the contents of the log-file ist independent of the settings used.
- all switches are either .true. or .false..
- caution: not all combinations yield reasonable results!
- (optional) switches Level2 (block Switches_Level_2)
- (optional) key "Display_Overlay_Grid" : superpose grid / do not superpose grid.
- (optional) key "Display_Fixed_Points" : display fixed points / do not display fixed points.
- (optional) key "Display_Structures" : read structural informations from insel.dat / do not read.
- (optional) key "Display_Boundary_Polygon" : display boundary polygon / do not display boundary polygon.
- (optional) key "Display_Stamp_and_Logo" : display company logo / do not display company logo.
- (optional) key "Display_Length_Scale" : display scale / do not display scale.
- (optional) key "Display_Additional_Informations" : display supplementary informations / do not display supplementary informations.
- (optional) key "Display_Vector_Arrows" : display superimposed vectors / do not display superimposed vectors when vector quantities are plotted (works in combination with key Overlay_Vector_Arrows in block Switches_Level_3).
- (optional) switches Level3 (block Switches_Level_3)
- (optional) key "Display_Filled_Areas" : use coloured isosurface representation / use isoline representation.
- (optional) key "Use_Fill_Area" : fill polygons with colour / fill polygons with coloured pixels.
- (optional) key "Display_Data_Contours" : show additional data-isolines / do not show additional data-isolines.
- (optional) key "Display_Bathymetry_Contours" : show additional bathymetry-isolines / do not show additional bathymetry-isolines.
- (optional) key "Label_Data_Contours" : label data-isolines / do not label data-isolines.
- Notice: labelling isolines is time consuming for large grids.
- (optional) key "Label_Bathymetry_Contours" : label bathymetry-isolines / do not label bathymetry-isolines.
- Notice: labelling isolines is time consuming for large grids.
- (optional) key "Overlay_Vector_Arrows" : coloured isosurface representation with superimposed vector arrows of constant length / vector representation with vector arrows of constant or variable length and width; when superimposed vector arrows of constant length are plotted then also key Display_Vector_Arrows of block Switches_Level_2 will influence the contents of the resulting scene.
- (optional) key "Use_Variable_Vector_Arrow_Length" : length and width of vector arrows is proportional to the value of the vector quantity / length and width of vector arrows is constant.
- (optional) key "Display_Hatches" : generate hatching representation / do not generate hatching representation.
- Notice: key Display_Filled_Areas of block Switches_Level_2 must be TRUE in this case.
- (optional) key "Use_Hatches_and_Filled_Areas" : in case of hatching representation, a background coloured isosurface representation is generated / not generated.
- (optional) key "Use_Hatches_Independent_of_Sign" : in case of hatching representation, only two different hachures are used to show areas with positive and negative values of the data / many hachures are used.
- (optional) key "Use_Manual_Bathymetry_Contours" : additional contour lines for bathymetry can be defined manually / are defined from the definitions prescribed in the file isoerg.dat.
- (optional) key "Use_Manual_Contour_Label_Height" : character height for labelled contour lines can be not modified manually / may be modified manually during program execution and different character heights for depth contour lines as well as data contour lines are possible.
- (optional) key "Draw_Contour_Label_Box" : a box is drawn / not drawn around the labels of the contour lines.
- (optional) switches Level4 (block Switches_Level_4)
- (optional) key "Activate_Colours_Update" : read the contents of the file lights.dat before generating a picture / do not read.
- (optional) key "Activate_Metafile_Output" : write graphical information to a plot metafile / do not write.
- parameter 1 : switch (.true., .false.);
- parameter 2 : organizational description (K1, K2, K3, W1, W2, W3, W4, ALR);
- parameter 3 : type of metafile (cgm, gksm, eps, gif, iris, jpeg, miff, pcx, tiff, xbm);
- (optional) parameter 4 : window name. Must be prescribed if the type of the metafile is neither cgm nor gksm.
- (optional) key "Activate_No_Stop_Run" : all selected time steps of synoptic data are displayed one after the other in non stop mode / stop for user interaction after each figure.
- (optional) key "Display_Surface_Layer" : if the selected data set is truely three-dimensional the results for the surface layer will be displayed.
- (optional) key "Display_Bottom_Layer" : if the selected data set is truely three-dimensional the results for the bottom layer will be displayed.
- (optional) key "Display_Depth_Layer" : if the selected data set is truely three-dimensional results for a single layer (e.g. at constant depth) can be displayed. Several layers can be selected from a separate menu.
- (optional) key "Display_Info_At_PickPoints" : out of function
- (optional) key "Display_Additional_Texts" : additional comment lines which are stored in a file of type layout.dat are displayed in the figure / not displayed.
- (optional) key "Save_Data_In_Ascii_File" : displayed data are stored / not stored in an ascii file of type outhview2d.dat.
- (optional) switches supplementary informations (Block Switches_Additional_Infos)
- (optional) key "Display_Bounding_Box" : a box is drawn / not drawn around the text area containing supplementary informations and the area is filled / not filled with background colour.
- (optional) key "Display_All_General_Informations" : all general informations which are related to the actually displayed physical quantity (e.g. limiting water depth to distinguish between dry and wet land) are displayed / not displayed.
- (optional) key "Display_Special_Quantity_Infos" : all special informations which are related to the actually displayed physical quantity (e.g. upper and lower limit) are displayed / not displayed.
- (optional) key "Display_Bathymetry_File_Name" : the name of the bathymetry file is displayed / not displayed.
- (optional) key "Display_Data_File_Name" : the name of the data file is displayed / not displayed.
- (optional) key "Arrange_Texts_Primarily_Vertical" : supplementary informations are mainly arranged vertically / horizontally.
- (optional) switches special features (Block Switches_Special_Features)
- (optional) key "Modify_Contour_Colours" : modify / not modify colour of isolines
- (optional) key "Modify_Vector_Arrow_Colours" : modify / not modify colour of vector arrows
- (optional) key "Modify_Const_Vector_Arrow_Length" : modify / not modify size of vector arrows
- (optional) key "Modify_Legend" : modify / not modify size of colour legend
- (optional) key "Draw_Legend_Box" : a background box is drawn / not drawn behind the colour legend.
General Remarks
- While reading this steering data file the dictionary file hview2d_dico.dat will be automatically accessed in directory $PROGHOME/dic/ to support input.
- For HVIEW2D the following standard configuration files from the directory $PROGHOME/cfg/ are required:
- GKS parameter file: gkssystem.computername.dat
- definition of physical quantities and physical units: phydef.*.dat
- definition of hatching styles: hatch.cfg.dat
- (optional) definition of desired points of time (filetype zeitpunkte.dat)
- (optional) time series of water level elevation (file of type boewrt.dat or file of type solwrt.dat)
- Notice: must be present together with tideclock.dat.
Programs using this Type of File
Example-File
$PROGHOME/examples/hview2d/hview2d.dat
back to: File Descriptions