PCL Reference Manual > Finite Element Functions > Equivalence Action
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Equivalence Action
This section is used to describe some of the functions used to reduce all of the finite element model nodes that coexist at a point in the model space to a single node.
  
fem_equiv_all_group
(group_id, num_groups, tolerance_type, tolerance, updated_tolerance, segment_id)
Description:
 
 
This function will reduce all nodes that coexist at single points to single nodes. The nodes are identified through an array of group ids.
Input:
 
 
INTEGER
group_id(num_groups)
 
 
This value specifies an array of group ids identifying the nodes to be reduced. This value is ignored if the input value num_groups is set to zero.
INTEGER
num_groups
This value specifies the number of groups identifying nodes to be reduced. If this value is set to zero, the entire model will be reduced. This value must be equal to or greater than zero and equal to or less than the number of offsets defined for the input array group_id.
INTEGER
tolerance_type
This value specifies the type of tolerance geometry that will be used to reduce nodes. All nodes that fit in the tolerance region will be reduced to a single node. A cubic tolerance geometry will be used if this value is set to 1 and a spherical tolerance geometry will be used if this value is set to 2.
REAL
tolerance
This value specifies the size of the tolerance region. This value must greater than zero.
Output:
 
 
REAL
updated_tolerance
This value returns the size of the tolerance region, recalculated to prevent the collapse of element edges. The input value tolerance is used as the starting value for the algorithm used to calculate this value.
INTEGER
segment_id
This value returns the segment id for the graphics segment that needs to be cleared. This value will be set to -1 if the graphics segment has already been cleared.
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:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics segment identifiers.
Example:
Please see fem_equiv_all_group.
  
fem_equiv_all_group2
(group_id, num_groups, tolerance_type, tolerance, verify, updated_tolerance, segment_id)
Description:
 
 
This function will reduce all nodes that coexist at single points to single nodes. The nodes are identified through an array of group ids. This function is identical to the fem_equiv_all_group() function except for the addition of the input argument verify, which provides for user verification of the reduction process before the results are saved to the database.
Input:
 
 
INTEGER
group_id(num_groups)
 
 
This value specifies an array of group ids identifying the nodes to be reduced. This value is ignored if the input value num_groups is set to zero.
INTEGER
num_groups
This value specifies the number of groups identifying nodes to be reduced. If this value is set to zero, the entire model will be reduced. This value must be equal to or greater than zero and equal to or less than the number of offsets defined for the input array group_id.
INTEGER
tolerance_type
This value specifies the type of tolerance geometry that will be used to reduce nodes. All nodes that fit in the tolerance region will be reduced to a single node. A cubic tolerance geometry will be used if this value is set to 1 and a spherical tolerance geometry will be used if this value is set to 2.
REAL
tolerance
This value specifies the size of the tolerance region. This value must greater than zero.
LOGICAL
verify
This value specifies, when set to TRUE, that a popup form will be used to get input from the user to either save to the database or discard the reduction results. If this value is set to FALSE, the reduction results will be saved to the database without prompting from the user.
Output:
 
 
REAL
updated_tolerance
This value returns the size of the tolerance region, recalculated to prevent the collapse of element edges. The input value tolerance is used as the starting value for the algorithm used to calculate this value.
INTEGER
segment_id
This value returns the segment id for the graphics segment that needs to be cleared. This value will be set to -1 if the graphics segment has already been cleared.
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:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics segment identifiers.
Example:
Please see fem_equiv_all_group2.
  
fem_equiv_all_group3
(group_names, num_groups, crg, tolerance_type, tolerance, verify, updated_tolerance, segment_id)
Description:
 
 
This function will reduce all nodes that coexist at single points to single nodes. The nodes are identified through an array of group ids. This function is identical to the fem_equiv_all_group() function except for the addition of the input argument verify, which provides for user verification of the reduction process before the results are saved to the database and the use of group names instead of group ids.
Input:
 
 
STRING
group_names[](num_groups)
 
 
This value specifies an array of group names identifying the nodes to be reduced. This value is ignored if the input value num_groups is set to zero.
INTEGER
num_groups
This value specifies the number of groups identifying nodes to be reduced. If this value is set to zero, the entire model will be reduced. This value must be equal to or greater than zero and equal to or less than the number of offsets defined for the input array group_names.
STRING
crg
This value specifies a string containing ids of group names identifying the nodes to be excluded from the reduction process.
STRING
tolerance_type
This value specifies the type of tolerance geometry that will be used to reduce nodes. All nodes that fit in the tolerance region will be reduced to a single node. A cubic tolerance geometry will be used if this value is set to 1 and a spherical tolerance geometry will be used if this value is set to 2.
INTEGER
tolerance
This value specifies the size of the tolerance region. This value must be greater than zero.
LOGICAL
verify
This value specifies, when set to TRUE, that a popup form will be used to get input from the user to either save to the database or discard the reduction results. If this value is set to FALSE, the reduction results will be saved to the database without prompting from the user.
Output:
 
 
REAL
updated_tolerance
This value returns the size of the tolerance region, recalculated to prevent the collapse of element edges. The input value tolerance is used as the starting value for the algorithm used to calculate this value.
INTEGER
segment_id
This value returns the segment id for the graphics segment that needs to be cleared. This value will be set to -1 if the graphics segment has already been cleared.
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:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics segment identifiers.
Example:
Please see fem_equiv_all_group3.
  
fem_equiv_list
(node_select, tolerance_type, tolerance, updated_tolerance, segment_id)
Description:
 
 
This function will reduce all selected nodes that coexist at a single point to a single node.
Input:
 
 
STRING
node_select[]
This value specifies a selection of node identifiers defining the nodes to be reduced.
INTEGER
tolerance_type
This value specifies the type of tolerance geometry that will be used to reduce nodes. All nodes that fit in the tolerance region will be reduced to a single node. A cubic tolerance geometry will be used if this value is set to 1 and a spherical tolerance geometry will be used if this value is set to 2.
REAL
tolerance
This value specifies the size of the tolerance region. This value must greater than zero.
Output:
 
 
REAL
updated_tolerance
This value returns the size of the tolerance region, recalculated to prevent the collapse of element edges. The input value tolerance is used as the starting value for the algorithm used to calculate this value.
INTEGER
segment_id
This value returns the segment id for the graphics segment that needs to be cleared. This value will be set to -1 if the graphics segment has already been cleared.
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:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics segment identifiers.
Example:
Please see fem_equiv_list.
  
fem_equiv_list2
(node_select, tolerance_type, tolerance, verify, updated_tolerance, segment_id)
Description:
 
 
This function will reduce all selected nodes that coexist at a single point to a single node. This function is identical to the fem_equiv_list() function except for the addition of the input argument verify, which provides for user verification of the reduction process before the results are saved to the database.
Input:
 
 
STRING
node_select[]
This value specifies a selection of node identifiers defining the nodes to be reduced.
INTEGER
tolerance_type
This value specifies the type of tolerance geometry that will be used to reduce nodes. All nodes that fit in the tolerance region will be reduced to a single node. A cubic tolerance geometry will be used if this value is set to 1 and a spherical tolerance geometry will be used if this value is set to 2.
REAL
tolerance
This value specifies the size of the tolerance region. This value must greater than zero.
LOGICAL
verify
This value specifies, when set to TRUE, that a popup form will be used to get input from the user to either save to the database or discard the reduction results. If this value is set to FALSE, the reduction results will be saved to the database without prompting from the user.
Output:
 
 
REAL
updated_tolerance
This value returns the size of the tolerance region, recalculated to prevent the collapse of element edges. The input value tolerance is used as the starting value for the algorithm used to calculate this value.
INTEGER
segment_id
This value returns the segment id for the graphics segment that needs to be cleared. This value will be set to -1 if the graphics segment has already been cleared.
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:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics segment identifiers.
Example:
Please see fem_equiv_list2.
  
fem_equiv_list3
(node_select, exclude_select, tolerance_type, tolerance, verify, updated_tolerance, segment_id)
Description:
 
 
This function will reduce all selected nodes that coexist at a single point to a single node. This function is identical to the fem_equiv_list2() function except for the addition of the input argument exclude_select, which allows a selection of nodes to be excluded from the reduction process.
Input:
 
 
STRING
node_select[]
This value specifies a selection of node identifiers defining the nodes to be reduced.
STRING
exclude_select[]
This value specifies a selection of node identifiers defining the nodes to be excluded from the reduction process.
INTEGER
tolerance_type
This value specifies the type of tolerance geometry that will be used to reduce nodes. All nodes that fit in the tolerance region will be reduced to a single node. A cubic tolerance geometry will be used if this value is set to 1 and a spherical tolerance geometry will be used if this value is set to 2.
REAL
tolerance
This value specifies the size of the tolerance region. This value must greater than zero.
LOGICAL
verify
This value specifies, when set to TRUE, that a popup form will be used to get input from the user to either save to the database or discard the reduction results. If this value is set to FALSE, the reduction results will be saved to the database without prompting from the user.
Output:
 
 
REAL
updated_tolerance
This value returns the size of the tolerance region, recalculated to prevent the collapse of element edges. The input value tolerance is used as the starting value for the algorithm used to calculate this value.
INTEGER
segment_id
This value returns the segment id for the graphics segment that needs to be cleared. This value will be set to -1 if the graphics segment has already been cleared.
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:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics segment identifiers.
Example:
Please see fem_equiv_list3.
  
fem_equiv_list_display.plot
(plot_option, entity_type, entity_selection)
Description:
 
 
This function controls the display of FEM elements and nodes.
Input:
 
 
STRING
plot_option[9]
This value specifies the plot option. See the remarks below for a list of the value that can be used with this argument.
INTEGER
entity_type
This value specifies the entity type for which the display will be modified. This argument can have the following values: 0 = both nodes and elements, 1 = nodes, and 2 = elements.
Output:
 
 
STRING
entity_selection[VIRTUAL]
 
 
This value returns a description of the entities that have been modified by this function.
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:
The string input value option can have the following values:
 
 
Value
Description
 
 
 
 
“init”
This option will save the display and erase all of the entities of the selected type from the current viewport.
 
“erase_all”
This option will erase all of the entities of the selected type from the current viewport.
 
“plot_all”
This option will plot all of the saved entities of the selected type in the current viewport.
 
“free_edge”
This option will plot all of the saved entities of the selected type associated to free edges.
 
“free_face”
This option will plot all of the saved entities of the selected type associated to free faces.
 
“restore”
This option will restore the saved display.
Space is internally allocated for the string returned by the output value entity_selection. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_equiv_list_display.plot.
  
fem_equiv_preview
(node_select, exclude_select, tolerance_type, tolerance, entity_type, updated_tolerance, segment_id, nodes_previewed, elements_previewed, nodes_reduced, elements_reduced)
Description:
 
 
This function will provide a preview of what happens if the selected nodes that coexist at a single point are reduced to a single node. This function is similar to the fem_equiv_list3() function except that no nodes will be deleted; they will only be displayed and marked on the screen.
Input:
 
 
STRING
node_select[]
This value specifies a selection of node identifiers defining the nodes to be reduced.
STRING
exclude_select[]
This value specifies a selection of node identifiers defining the nodes to be excluded from the reduction process.
INTEGER
tolerance_type
This value specifies the type of tolerance geometry that will be used to reduce nodes. All nodes that fit in the tolerance region will be reduced to a single node. A cubic tolerance geometry will be used if this value is set to 1 and a spherical tolerance geometry will be used if this value is set to 2.
REAL
tolerance
This value specifies the size of the tolerance region. This value must greater than zero.
INTEGER
entity_type
This value specifies the entity type for which the display will be modified. This argument can have the following values: 0 = both nodes and elements, 1 = nodes, and 2 = elements.
Output:
 
 
REAL
updated_tolerance
This value returns the size of the tolerance region, recalculated to prevent the collapse of element edges. The input value tolerance is used as the starting value for the algorithm used to calculate this value.
INTEGER
segment_id
This value returns the segment id for the graphics segment that needs to be cleared. This value will be set to -1 if the graphics segment has already been cleared.
STRING
nodes_previewed[VIRTUAL]
 
 
This value returns a description of the nodes that have been previewed.
STRING
elements_previewed[VIRTUAL]
 
 
This value returns a description of the elements that have been previewed.
STRING
nodes_reduced[VIRTUAL]
 
 
This value returns a description of the nodes that have been reduced.
STRING
elements_reduced[VIRTUAL]
 
 
This value returns a description of the elements that have been reduced.
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:
This function will display circles that highlight reduced nodes in the viewport.
All reduced nodes will retain the lowest value of the node ids in the tolerance region.
See the function description for the PCL function gm_segment_delete() for more information on graphics segment identifiers.
Space is internally allocated for the string returned by the output values nodes_reduced and elements_reduced. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_equiv_preview.