ReadVis5D

Synopsis

This module reads a Vis5D data file. It allows the user to select a single time step and computes a wind vector.

Parameters

ReadVis5DParams
Name Type Description UI Control

filename string Name of the Vis5D file to read. File Dialog
load_all_steps boolean if set the reader caches the all timesteps. Toggle
timestep int The timestep to be read from cache or from file. ListBox
show_title boolean if set the reader outputs a headline object. Toggle
time_steps string[] The list of all the timesteps (date/time) in the input file. Listbox
var_names string[] The list of variable names. Listbox
var_info string[] Info related to the corresponding variable. TextLabel
status string Status and error messages. TextLabel
wind_components int[3] The three variables that must be combined to form the wind component. ListBox

Output Ports

Name Type Description

filename string Name of the Vis5D file.
vars3d_out Field_Struct Field structure containing the data for the selected time-step.
vars2d_out Field_Unif+group One timestep with all the 2D variables (variables with nlevels = 1) as node data.
vars3d_obj DataObject directly renderable object of the selected time-step
vars2d_obj DataObject directly renderable object of the 2D variables
title DataObject directly renderable object of a headline containing the time-step information

Description

This module reads a Vis5D data file, selects one time step on request and computes the wind vector. The code kernel used for this module is from the official Vis5D distribution.

Parameters

ReadVis5DParams

filename

String parameter that specifies which Vis5D file should be read. The filename string should contain the full path name of the file and can contain any of the AVS/Express environment variables (e.g. $XP_PATH<1>)

load_all_steps

If this boolean parameter is set, the reader caches all timesteps stored in the file when it is opened. Otherwise it reads only the requestes time-step from the file.

time_step

This int parameter specifies the time-step that should be read.

time_steps[]

This array of strings contains the description of all the timesteps stored in the Vis5D file. It contains the date and the time of each individual timestep.

var_names[]

This array of strings contains the names of all variables stored in the Vis5D file.

var_info[]

This array of strings contains the description of all variables stored in the Vis5D file. It contains infomation such as the number of rows, number of columns, number of levels, low-level, minimum and maximum values for each variable.

status

String parameter that contains status and error information from the last read operation.

wind_components

This array of three int values contains the indices of the variables that have to be combined to form the wind component. If the file contais variables called U, V, W they are selected for the three wind components. Zero means that this component must be zero. Positive is the ordinal number of the variable plus one. If all three components are zero, no wind component is created.

Outputs

filename

String output of the filename given by the user. This Output is used to be connected to the Vis5Dfile input in the ReadVis5DTopography module.

vars3d_out

Structured Field that contains one timestep with all the variables which have more than one level as node data. If the wind_components parameter specifies that a vectorial component has to be created this is added at the end of the node data list with the variable name "COMPWIND". The grid is usually rectilinear. If the vertical levels are equidistant, this grid is changed to Uniform. The xform is set to scale the height to an acceptable value.

vars2d_out

Field_Unif+group that contains one timestep with all the 2D variables (variables with nlevels = 1) as node data.

vars3d_obj

Directly renderable object of the data stored in vars3d_out.

vars2d_obj

Directly renderable object of the data stored in vars2d_out.

title

Directly renderable object of a headline containing the time-step information.

Utility Macros

The ReadVis5DFunc functional macro uses the low-level ReadVis5DCore module. The macro takes as input the parameter block ReadVis5DParams. The macro outputs the data read from the Vis5D file as Field Structures and directly renderable objects.

The ReadVis5DFunc functional macro and the ReadVis5DUI user interface macro are both used by the ReadVis5D user macro. All of these macros use the ReadVis5DParams parameter block to communicate.

Example

The project includes an example application that demonstrates the use of the ReadVis5D macro. The ReadVis5DEg application uses the ReadVis5D macro to read a Vis5D file. The Example contains an isosurface and a bounds module to show the inner structure of the fields array which is read by the ReadVis5D macro.

Files

iac_proj/rd_vis5d/rv5dmods.v contains the V definitions of the ReadVis5DCore module and the ReadVis5DParams parameter block.

iac_proj/rd_vis5d/rv5dmacs.v contains the V definitions of the ReadVis5DUI UI macro, the ReadVis5DFunc functional macro and the ReadVis5D user macro.

iac_proj/rd_tecpl/rv5dapps.v contains the V definition of the ReadVis5DEg example application.

Other Notes

The low-level ReadVis5DMods library containing the low-level module ReadVis5DCore does not specify a process. By default the express process will be used.

Author

Mario Valle,
AVS Italy

Dr. Jean M. Favre, 
CSCS, Swiss Center for Scientific Computing 

Modifications

Tobias Schiebeck,
International AVS Centre

Contact

International AVS Centre
Manchester Visualization Centre
Manchester Computing
University of Manchester
Oxford Road
Manchester
United Kingdom
M13 9PL

See Also

Vis5D website

ReadVis5DTopography