PCL Reference Manual > Results Postprocessing Functions > Quick Plot Functions
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Quick Plot Functions
 
res_display_anim_qk_setup
(number_frames, graphics_method, string)
Description:
 
 
This function specifies the number of frames and graphics method to be used for creating an image animation.
Input:
 
 
INTEGER
number_frames
This value specifies the number of animation frames to create.
STRING
graphics_method[]
This value specifies the graphics method for animation. Valid values are: "2D", "3D", "Preview", and "MPEG".
STRING
string[]
For future use. Set value to an empty string.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
See the Status Messages for information on any error values returned by this function.
Remarks:
None
Example:
None
 
res_display_anim_qk_fringe_data
(location, result_type, primary_result, secondary_result, layer, derivation, coordinate, averaging_method, averaging_domain, extrapolation)
Description:
 
 
This function specifies a result to be extracted and manipulated into a format for subsequent display.
Input:
 
 
STRING
location[]
This value specifies the model entity with which the results data is associated. Valid values are: "C" = centroid, "N" = nodal, "EN" = element nodal, and "EL" = element.
STRING
result_type[]
This value specifies the results data type. Valid values are: "S" = scalar, "V" = vector, and "T" = tensor.
STRING
primary_result[]
This value specifies the identifier of the primary result.
STRING
secondary_result[]
This value specifies the identifier of the secondary result.
STRING
layer[]
This value specifies the layer position identifier.
STRING
derivation[10]
This value specifies the derivation specifier if the results are to be derived. A null will leave the result as is. See the remarks in res_data_load_dbresults() for more information.
STRING
coordinate[]
This value specifies the coordinate for transformations. Valid values are: ““ = as is, “Coord i” = Db coordinate system, "M" = material system, "IJK" = element ijk system, "N" = nodal system, and "G" = global.
STRING
averaging_method[]
This value specifies the averaging method: “derive-avg” to perform derivations and transformations, then average the results, “avg-derive” (transform to global, average, then derive/transform), “difference” (calculate the difference versus average, derivations performed first), and “sum” (sum all of the element nodal components at the nodes).
STRING
averaging_domain[]
This value specifies the averaging domain: “All”, “Matl”, “Prop”, “Target” (only consider entities in the target definition), and “Element”.
STRING
extrapolation[]
This value specifies the extrapolation method: “ShapeFunc”, “Average” (constant in element computed as the average), and “Centroid” (constant in element as computed centroidal value).
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
See the Status Messages for information on any error values returned by this function.
Remarks:
See the remarks in res_data_load_dbresult for more information.
Example:
None.
 
res_display_anim_qk_layers
(derivation, count, layers)
Description:
 
 
This function specifies the element layer information.
Input:
 
 
STRING
derivation[]
This value specifies the results data be scanned for the maximum, minimum, summation, or averaged values. Valid values are: "MAXIMUM", "MINIMUM", "SUM", and "AVERAGE".
INTEGER
count
This value specifies the number of layers selected.
STRING
layers[](count)
This value specifies the layer position labels.
Output:
 
 
None
 
 
Error Conditions:
 
None
Remarks:
None
 
Example:
Note
.
res_display_anim_qk_fringe_ttle
(title)
Description:
 
 
This function specifies a title string to be associated with the fringe plot. If this title is not specified, a default title based on the source of the data will be used.
Input:
 
 
STRING
title[]
This value specifies the fringe title.
Output:
 
 
None
 
 
Error Conditions:
 
None
Remarks:
None.
Example:
None.
 
res_display_anim_qk_fringe_attr
( nattribs, attributes, deformed_flag, spectrum_flag, range_flag)
Description:
 
 
This function creates a fringe plot tool definition.
Input:
 
 
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See remarks in res_display_fringe_create() for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
LOGICAL
spectrum_flag
This value is set to TRUE to display the spectrum bar with this plot.
LOGICAL
range_flag
This value is set to TRUE to flag this tool to control the range info in the viewport.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
See the Status Messages for information on any error values returned by this function.
Remarks:
See remarks in res_display_fringe_create for more information.
 
res_display_anim_qk_deform_data
(register, location, result_type, primary_result, secondary_result, layer, derivation, coordinate, averaging_method, averaging_domain, extrapolation)
Description:
 
 
This function specifies a result to be extracted from the database and manipulated into a format for subsequent display. This description will be stored in the specified register.
Input:
 
 
INTEGER
register
This value specifies the register identifier.
STRING
location[]
This value specifies the model entity with which the results data is associated. Valid values are: "C" = centroid, "N" = nodal, "EN" = element nodal, and "EL" = element.
STRING
result_type[]
This value specifies the results data type. Valid values are: "S" = scalar, "V" = vector, and "T" = tensor.
STRING
primary_result[]
This value specifies the identifier of the primary result.
STRING
secondary_result[]
This value specifies the identifier of the secondary result.
STRING
layer[]
This value specifies the layer position identifier.
STRING
derivation[10]
This value specifies the derivation specifier if the results are to be derived. A null will leave the result as is. See the remarks in res_data_load_dbresults() for more information.
STRING
coordinate[]
This value specifies the coordinate for transformations. Valid values are: ““ = as is, “Coord i” = Db coordinate system, "M" = material system, "IJK" = element ijk system, "N" = nodal system, and "G" = global.
STRING
averaging_method[]
This value specifies the averaging method: “derive-avg” to perform derivations and transformations, then average the results, “avg-derive” (transform to global, average, then derive/transform), “difference” (calculate the difference versus average, derivations performed first), and “sum” (sum all of the element nodal components at the nodes).
STRING
averaging_domain[]
This value specifies the averaging domain: “All”, “Matl”, “Prop”, “Target” (only consider entities in the target definition), and “Element”.
STRING
extrapolation[]
This value specifies the extrapolation method: “ShapeFunc”, “Average” (constant in element computed as the average), and “Centroid” (constant in element as computed centroidal value).
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
See the Status Messages for information on any error values returned by this function.
Remarks:
See remarks in res_display_fringe_create for more information.
Example:
None.
.
res_display_anim_qk_deform_ttle
(register, location, register_type, count, titles)
Description:
 
 
This function specifies a title string to be associated with the deformed plot. If this title is not specified, a default title based on the source of the data will be used.
Input:
 
 
STRING
titles[]
This value specifies the fringe title.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
See the Status Messages for information on any error values returned by this function.
Remarks:
None.
Example:
None.
 
res_display_anim_qk_deform_attr
nattribs, attributes, deformed_flag, spectrum_flag, range_flag )
Description:
 
 
This function defines the deformation attributes for the plot tool definition.
Input:
 
 
INTEGER
nattribs
This value specifies the number of offsets in the input value attributes.
STRING
attributes[](nattribs)
This value specifies the attributes. See the remarks below for more information.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed shape if deformation tools are posted
LOGICAL
spectrum_flag
This value is set to TRUE to display the spectrum bar with this plot.
LOGICAL
range_flag
This value is set to TRUE to flag this tool to control the range info in the viewport.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
See the Status Messages for information on any error values returned by this function.
Remarks:
See remarks in res_display_fringe_create for more information.
Example:
None.
 
res_display_anim_qk_res_list
(fringe_flag, deform_flag, graphics_method, fringe_range, const_range_flag, num_cases, load_case, subcase)
Description:
 
 
This function specifies a series of database result specifiers to be associated with a specific register.
Input:
 
 
LOGICAL
fringe_flag
This value is set to TRUE to enable displaying in the fringe.
LOGICAL
deformed_flag
This value is set to TRUE to enable displaying in the deformed.
STRING
graphics_method[]
This value specifies the graphics method for animation. Valid values are: "2D", "3D", "Preview", and "MPEG".
STRING
fringe_range
This value specifies the fringe spectrum for display.
LOGICAL
const_range_flag
This value is set to TRUE to enable use a constant range values the spectrum bar.
INTEGER
num_cases
This value specifies the number of result cases.
STRING
load_case[](num_cases)
This value specifies the load case identifiers.
STRING
subcase[](num_cases)
This value specifies the subcase identifiers.
Output:
 
 
INTEGER
<Return Value>
This function returns a value of 0 when executed successfully and a non zero value to indicate a change in status or an error.
Error Conditions:
 
See the Status Messages for information on any error values returned by this function.
Remarks:
None
Example:
None