DVread_field

Synopsis

read an field file and outputs field.

module DVread_field<need_objs="Field_Unif Field_Struct Field_Rect"> {
#ifdef OLD_FIELD_READER
string+Iparam filename; /* name of file to read */
int+Iparam portable=1;
int+Iparam swap=0;
int+Iparam flip=0;
Mesh_Struct+Node_Data+Oparam &out; /* output field */
method+notify_val+notify_inst read_field_update<status=1>
= "DVread_field_update";
#else // new multistep reader from KGT
string+Iparam filename;
int+Iparam portable=1;
int+Iparam swap=0;
int+Iparam flip=0;
int+read store_all;
int+read+write store_all_visible = 0;
int+read+write+notify stepno;
int+read+notify forward;
int+read+notify backward;
int+read+write+nonotify nsteps = 0;
string+write+nonotify time_string<NEportLevels={0,2}> = "";
ptr+read+write file_ptr<NEvisible=0> = 0;
ptr+read+write RF_ptr<NEvisible=0> = 0;
ptr+read+write coord_ptr<NEvisible=0> = 0;
Mesh_Struct+Node_Data+Oparam &out;
Time_Mesh_Struct+Time_Node_Data+Oparam &out_all {
nsteps+opt;
time+opt;
time_coordinates+opt;
time_node_data+opt;
nnode_data+opt;
};
omethod+notify_val+notify_inst read_field_update<status=1> =
"DVread_field_update";
method+notify_deinst read_field_delete()
= "DVread_field_delete";
#endif
};

Description

DVread_field reads a field file and converts its contents into the appropriate Fld structure. This module can read in files containing either standard (single-step) or time-dependednt (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.

flip

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.

portable

Boolean that specifies whether the data is in the machine-dependent XCR format

swap

Boolean indicating whether to swap the bite order when binary data is read in.

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.

Example

Not available.

File

v/dv.v

See also

DVread_net_cdf

DVread_vol