PCL Reference Manual > Finite Element Functions > Delete Action
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Delete Action
This section is used to describe some of the function used to delete elements, nodes, and meshes from a finite element model.
     
fem_delete_elem_and_node
(element_select, deleted_elements)
Description:
 
 
This function will delete elements and their associated nodes from the database and the graphics window.
Input:
 
 
STRING
element_select[]
This value specifies a selection of nodes and elements to be deleted.
Output:
 
 
STRING
deleted_elements[VIRTUAL]
 
 
This value returns a description of the deleted nodes and elements.
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 is used in the implementation of the “Finite Elements” switch bar form that is displayed when the action is set to “Delete” and the object is set to “Any” or “Element”.
This function will delete an element and any associated nodes for each element listed in the input value element_select, provided that the element is not essential for any other entity. The element will be deleted if it meets that criteria and its associated nodes will be deleted provided that they too are not essential to any other entity. The association of the element with loads, boundary conditions, material properties, element properties and groups will be broken but these entities will not be deleted. Each element deleted will be removed from the graphics window.
Space is internally allocated for the string returned by the output value deleted_elements. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_delete_elem_and_node.
 
   
fem_delete_element
(element_select, deleted_elements)
Description:
 
 
This function will delete elements from the database and the graphics window.
Input:
 
 
STRING
element_select[]
This value specifies a selection of elements to be deleted.
Output:
 
 
STRING
deleted_elements[VIRTUAL]
 
 
This value returns a description of the deleted elements.
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 is used in the implementation of the “Finite Elements” switch bar form that is displayed when the action is set to “Delete” and the object is set to “Any” or “Element”.
This function will delete each element listed in the input value element_select, provided that the element is not essential for any other entity. Any nodes formerly associated with the deleted elements will not be deleted. The association of the element with loads, boundary conditions, material properties, element properties and groups will be broken but these entities will not be deleted. Each element deleted will be removed from the graphics window.
Space is internally allocated for the string returned by the output value deleted_elements. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_delete_element.
   
fem_delete_free_node
(node_select, deleted_nodes, not_found_nodes
Description:
 
 
Deletes a set of nodes from the database and the graphics window.
Input:
 
 
STRING
node_select[]
This value specifies a selection of nodes to be deleted.
Output:
 
 
STRING
deleted_nodes[VIRTUAL]
 
 
This value returns a description of the deleted nodes.
STRING
not_found_nodes[VIRTUAL]
 
 
This value returns a description of any nodes that were listed in the input value node_select but not found in the database.
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 is used in the implementation of the “Finite Elements” switch bar form that is displayed when the action is set to “Delete” and the object is set to “Node”.
This function will delete each node listed in the input value node_select, provided that the node is free and not essential for any other entity. The association of the node with loads, boundary conditions, material properties and groups will be broken but these entities will not be deleted. Each deleted node is removed from the graphics window.
Space is internally allocated for the string returned by the output values deleted_nodes and not_found_nodes. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_delete_free_node.
   
fem_delete_mesh_from_curve
(curve_select, deleted_mesh, not_found_mesh)
Description:
 
 
This function will delete a mesh from a set of curves. The curves may be edges of surfaces or solids.
Input:
 
 
STRING
curve_select[]
This value specifies a selection of curves from which the mesh is to be deleted.
Output:
 
 
STRING
deleted_mesh[VIRTUAL]
 
 
This value returns a description of the curves from which the mesh was deleted.
STRING
not_found_mesh[VIRTUAL]
 
 
This value returns a description of the curves from which there was no mesh that could be deleted.
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 is used in the implementation of the “Finite Elements” switch bar form that is displayed when the action is set to “Delete”, the object is set to “Mesh” and the type is set to “Curve”.
This function will delete the elements and nodes that comprise the mesh for each curve listed in the input value curve_select, provided that the elements and nodes are not essential for any other entity. The association of the elements and nodes with loads, boundary conditions, material properties and groups will be broken but these entities will not be deleted. Each deleted element and node is removed from the graphics window.
Space is internally allocated for the string returned by the output values deleted_mesh and not_found_mesh. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_delete_mesh_from_curve.
   
fem_delete_mesh_from_surface
(surface_select, deleted_mesh, not_found_mesh)
Description:
 
 
This function will delete a mesh from a set of surfaces.
Input:
 
 
STRING
surface_select[]
This value specifies a selection of surfaces from which the mesh is to be deleted.
Output:
 
 
STRING
deleted_mesh[VIRTUAL]
 
 
This value returns a description of the surfaces from which the mesh was deleted.
STRING
not_found_mesh[VIRTUAL]
 
 
This value returns a description of the surfaces from which there was no mesh that could be deleted.
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 is used in the implementation of the “Finite Elements” switch bar form that is displayed when the action is set to “Delete”, the object is set to “Mesh” and the type is set to “Surface”.
This function will delete the elements and nodes that comprise the mesh for each surface listed in the input value surface_select, provided that the elements and nodes are not essential for any other entity. The association of the elements and nodes with loads, boundary conditions, material properties and groups will be broken but these entities will not be deleted. Each deleted element and node is removed from the graphics window.
Space is internally allocated for the string returned by the output values deleted_mesh and not_found_mesh. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_delete_mesh_from_surface.
   
fem_delete_mesh_from_solid
(solid_select, deleted_mesh, not_found_mesh)
Description:
 
 
This function will delete a mesh from a set of solids.
Input:
 
 
STRING
solid_select[]
This value specifies a selection of solids from which the mesh is to be deleted.
Output:
 
 
STRING
deleted_mesh[VIRTUAL]
 
 
This value returns a description of the solids from which the mesh was deleted.
STRING
not_found_mesh[VIRTUAL]
 
 
This value returns a description of the solids from which there was no mesh that could be deleted.
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 is used in the implementation of the “Finite Elements” switch bar form that is displayed when the action is set to “Delete”, the object is set to “Mesh” and the type is set to “Solid”.
This function will delete the elements and nodes that comprise the mesh for each solid listed in the input value solid_select, provided that the elements and nodes are not essential for any other entity. The association of the elements and nodes with loads, boundary conditions, material properties and groups will be broken but these entities will not be deleted. Each deleted element and node is removed from the graphics window.
Space is internally allocated for the string returned by the output values deleted_mesh and not_found_mesh. It is the responsibility of the calling function to free the allocated string storage space.
Example:
Please see fem_delete_mesh_from_solid.