DVread_ucd

Synopsis

read an ucd file and outputs field.

module DVread_ucd {
#ifdef OLD_UCD_READER
string+Iparam filename; /* name of file to read */
Mesh+Cell_Data+Node_Data+Oparam out; /* output field */
method+notify_val+notify_inst read_ucd_update<status=1>
= "DVread_ucd_update";
#else // new multistep reader from KGT
string+Iparam filename;
int+read store_all;
int+read+write store_all_visible = 0;
int+read+write+notify current_step;
int+read+notify forward;
int+read+notify backward;
int+read+write+nonotify total = 0;
string+write+nonotify step_title<NEportLevels={0,2}> = "";
ptr+read+write file_ptr<NEvisible=0> = 0;
ptr+read+write file_pos<NEvisible=0> = 0;
ptr+read+write top<NEvisible=0> = 0;
string+read+write cycle_type = 0;
int+read+write new_format = 0;
ptr+read+write all_comments<NEvisible=0> = 0;
Mesh+Cell_Data+Node_Data+Oparam out;
Time_Mesh+Time_Cell_Data+Time_Node_Data+Oparam out_all;
omethod+notify_val+notify_inst read_ucd_update<status=1> =
"DVread_ucd2_update";
method+notify_deinst read_ucd_delete() = "DVread_ucd2_delete";
#endif
};

Description

DVread_ucd reads in a UCD file (identified by the extension .inp) and converts its contents into the appropriate Fld structure. This module can read in files containing either standard data or time-dependent (multistep) data.

Input

filename

A string. Names the input file to be read. The string can be either the complete absolute pathname, or a relative pathname. If it is relative, it will be interpreted relative to the user's working directory when AVS/Express was started.

store_all

Boolean indicating whether to invert the image about the x axis, i.e. in the vertical direction. The renderers assume that the image origin is at the lower left: toggle the flip param if the image is rendered upside-down.

total

int specifies the total number of steps of time-dependent data. This object appears only if the file specified with the UCD Filename parameter contains time-dependent data.

current_steps

string specifies the number of the step whose data is currently being output. To output the data corresponding to a particular step, enter a step number in the text box.

foward

outputs the data for the next step. This object appears only if the file specified with the Field Filename parameter contains time-dependent data.

backward

outputs the data for the previous step. This object appears only if the file specified with the Field Filename parameter contains time-dependent data.

nsteps

An int number of steps

Output

out

The output is a new Mesh_Unif object.

Example

Not available.

File

v/dv.v

See also

DVread_vol

DVread_net_cdf