PCL Reference Manual > Finite Element Functions > Sweep Action
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX''">   
Sweep Action
This section is used to describe some of the functions used to duplicate and/or translate finite element model nodes, elements, multi-point constraints (MPCs), meshes, and mesh seeds through the use of sweep operations.
Sweeping elements is the process of creating higher order elements by sweeping a lower order element through a prescribed path. Therefore, a hexagonal element may be created by sweeping a quadrilateral element through space, the edges of the hexagonal being defined by the corners of the quadrilateral as its nodes move along the path. Ten methods for defining the swept paths are provided: arc, extrude, glide, glide-guide, normal, radial cylindrical, radial spherical, spherical theta, vector field and loft.
  
fem_sweep_arc_1
(sweep_elem_select, sweep_node_select, arc_angle, arc_coord_frame, axis_rotation, offset_angle, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the arc sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
arc_angle[]
This value specifies the range of the arc swept in degrees.
STRING
arc_coord_frame[]
This value specifies an identifier for the coordinate frame in which the axis of rotation is defined.
STRING
axis_rotation[]
This value specifies an identifier for the axis of rotation in the input value arc_coord_frame around which the arc sweep operation will take place.
STRING
offset_angle[]
This value specifies the offset angle in degrees between the location of the entities on which the sweep operation will take place and the location along the arc where the entities created by the sweep operation will be placed.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created
[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Arc”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_arc_1.
fem_sweep_cylinder_radial_1
(sweep_elem_select, sweep_node_select, cyl_coord_frame, axis_cylinder, radial_distance, offset_distance, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the radial cylindrical sweep method. This operation will create entities by sweeping along a cylindrical radius that passes through the selected entities and is normal to the cylinder axis.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
cyl_coord_frame[]
This value specifies an identifier for the coordinate frame in which the cylinder axis is defined.
STRING
axis_cylinder[]
This value specifies an identifier for the cylinder axis from which a cylindrical radius will be projected.
STRING
radial_distance[]
This value will specify the distance along the cylindrical radius where the created entities will be placed. This value must represent a real number greater than 0.
STRING
offset_distance[]
This value will specify an offset distance along the cylindrical radius between the entities on which the sweep operation will take place and the location along the cylindrical radius where the entities created by the sweep operation will be placed. This value must represent a real number equal to or greater than zero.
INTEGER
flag
This value specifies, when set to 1, that the original elements from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Radial Cyl.”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_cylinder_radial_1.
 
fem_sweep_extrude_1
(sweep_elem_select, sweep_node_select, vector_coord_frame, vector_direction, extrusion_distance, offset_distance, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the extrude sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
vector_coord_frame[]
This value specifies an identifier for the coordinate frame in which the axis of rotation is defined.
STRING
vector_direction[]
This value specifies a vector that defines the direction in which the extrusion operation will create new entities.
STRING
extrusion_distance[]
This value specifies the distance along the extrusion vector over which new entities will be created.
STRING
offset_distance[]
This value specifies the distance between the location of the entities on which the sweep operation will take place and the location along the extrusion vector where the entities created by the sweep operation will be placed.
INTEGER
flag
This value specifies, when set to 1, that the original elements from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Extrude”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_extrude_1.
 
fem_sweep_glide_1
(sweep_elem_select, sweep_node_select, glide_coord_frame, glide_type, glide_curve, glide_beginning, glide_end, reverse_glide, offset_glide, glide_parameter, glide_pnts_parametric, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the glide sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
glide_coord_frame[]
This value specifies an identifier for the coordinate frame in which the glide points are defined.
STRING
glide_type[]
This value specifies the type of glide operation that will take place. Currently only the case insensitive value “FIXED” is allowed.
STRING
glide_curve[]
This value specifies the curve used for the gliding offset, the glide direction tangent, and the glide frame origin.
STRING
glide_beginning[]
This value specifies a point that defines the beginning of the glide curve. This value is used to define an offset along the glide curve for the start of placement of entities created by the sweep operation.
STRING
glide_end[]
This value specifies a point that defines the end of the glide curve.
LOGICAL
reverse_glide
This value specifies, when set to TRUE, that the direction of the glide path along the glide curve be reversed.
LOGICAL
offset_glide
This value specifies, when set to TRUE, the use of an offset for the entities created along the glide curve by the sweep operation defined by either the input value glide_beginning or by the input value glide_end, depending on the input value reverse_glide.
LOGICAL
glide_parameter
This value specifies, when set to TRUE, that the glide operation will take place in the curve parameter space rather than the arc length space.
LOGICAL
glide_pnts_parametric
This value specifies, when set to TRUE, that the beginning and the end point for the glide curve are defined as curve parametric locations rather than as points in the global coordinate frame.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created
[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Glide”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_glide_1.
 
fem_sweep_glide_guide_1
(sweep_elem_select, sweep_node_select, glide_coord_frame, glide_curve, glide_beginning, glide_end, reverse_glide, offset_glide, glide_parameter, glide_pnts_parametric, flag, entity_select, guide_curve, guide_beginning, guide_end, reverse_guide, offset_guide, guide_parameter, guide_pnts_parameter, preserve_guide_axis, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the glide-guide sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
glide_coord_frame[]
This value specifies an identifier for the coordinate frame in which the glide points are defined.
STRING
glide_curve[]
This value specifies the curve used for the gliding offset, the glide direction tangent, and the glide frame origin.
STRING
glide_beginning[]
This value specifies a point that defines the beginning of the glide curve. This value is used to define an offset along the glide curve for the start of placement of entities created by the sweep operation.
STRING
glide_end[]
This value specifies a point that defines the end of the glide curve.
LOGICAL
reverse_glide
This value specifies, when set to TRUE, that the direction of the glide path along the glide curve be reversed.
LOGICAL
offset_glide
This value specifies, when set to TRUE, that the use of an offset for the entities created along the glide curve by the sweep operation be defined by either the input value glide_beginning or by the input value glide_end, depending on the input value reverse_glide.
LOGICAL
glide_parameter
This value specifies, when set to TRUE, that the glide operation will take place in the curve parameter space rather than the arc length space.
LOGICAL
glide_pnts_parametric
This value specifies, when set to TRUE, that the beginning and the end point for the glide curve are defined as curve parametric locations rather than as points in the global coordinate frame.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
STRING
guide_curve[]
This value specifies the curve used to guide the glide frame orientation as the sweep operation glides along the glide curve.
STRING
guide_beginning[]
This value specifies a point that defines the beginning of the guide curve.
STRING
guide_end[]
This value specifies a point that defines the end of the guide curve.
LOGICAL
reverse_guide
This value specifies, when set to TRUE, that the direction of the guide path along the guide curve be reversed.
LOGICAL
offset_guide
This value specifies, when set to TRUE, that the use of an offset for the entities created along the guide curve by the sweep operation be defined by either the input value guide_beginning or the input value guide_end.
LOGICAL
guide_parameter
This value specifies, when set to TRUE, that the guide operation will take place in the curve parameter space rather than the arc length space.
LOGICAL
guide_pnts_parameter
This value specifies, when set to TRUE, that the beginning and the end point for the guide curve are defined as curve parametric locations rather than as points in the global coordinate frame.
LOGICAL
preserve_guide_axis
This value specifies, when set to TRUE, that the guide curve reference direction rather than the glide curve tangent direction be used when rotating the glide frame orientation along the guide path.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Glide - Guide”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_glide_guide_1.
fem_sweep_loft_1
(sweep_elem_select, sweep_node_select, entity_select, top_elements, start_element, start_element_top, flag, auto_align, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
Description:
This function will create elements by using the loft sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
STRING
top_elements[]
This value specifies a selection of element identifiers that define the top of the sweep operation.
STRING
start_element[]
This value specifies the starting element in the selection of entities on which the sweep operation will take place.
STRING
start_element_top[]
This value specifies the starting element in the selection of element identifiers that define the top of the sweep operation.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
LOGICAL
auto_align
This value specifies, when set to TRUE, that the starting elements specified by the input values start_element and start_element_top will be aligned.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created
[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Loft”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_loft_1.
 
fem_sweep_normal_1
(sweep_elem_select, sweep_node_select, normal_distance, offset_distance, reverse_normal, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the normal sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
normal_distance[]
This value specifies the distance along the normal of each element selected for the sweep operation over which the sweep operation will create new elements.
STRING
offset_distance[]
This value specifies the distance between the location of the entities on which the sweep operation will take place and the location along the element normals where the entities created by the sweep operation will be placed.
LOGICAL
reverse_normal
This value specifies, when set to TRUE, that the normals used by the sweep operation be reversed.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Normal”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_normal_1.
fem_sweep_normal_2
(sweep_elem_select, sweep_node_select, normal_distance, offset_distance, reverse_normal, flag, ignore_geometry, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the normal sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
normal_distance[]
This value specifies the distance along the normal of each element selected for the sweep operation over which the sweep operation will create new elements.
STRING
offset_distance[]
This value specifies the distance between the location of the entities on which the sweep operation will take place and the location along the element normals where the entities created by the sweep operation will be placed.
LOGICAL
reverse_normal
This value specifies, when set to TRUE, that the normals used by the sweep operation be reversed.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
LOGICAL
ignore_geometry
If this value is set to TRUE, the geometry is ignored.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Normal”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_normal_1 (p. 769) in the PCL Reference Manual Examples.
 
fem_sweep_sphere_angle_1
(sweep_elem_select, sweep_node_select, sphere_coord_frame, axis_spherical, sweep_angle, angle_offset, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the spherical theta sweep method. This operation will create entities by sweeping a spherical radius that passes through the selected entities and is normal to the axis of the sphere through which the spherical radius is swept around the axis of the sphere.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
sphere_coord_frame[]
This value specifies an identifier for the coordinate frame in which the spherical axis is defined.
STRING
axis_spherical[]
This value specifies an identifier for the spherical axis from which a spherical radius will be projected.
STRING
sweep_angle[]
This value specifies the angle to be swept by the spherical radius in degrees.
STRING
angle_offset[]
This value will specify an angle in degrees defining an offset along the spherical radius between the entities on which the sweep operation will take place and the location along the cylindrical radius where the entities created by the sweep operation will be placed.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Sph. Theta”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_sphere_angle_1 (p. 771) in the PCL Reference Manual Examples.
 
fem_sweep_sphere_radial_1
(sweep_elem_select, sweep_node_select, sphere_coord_frame, sphere_center, radial_distance, offset_distance, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the radial spherical method. This operation will create entities by sweeping along a spherical radius that passes from the center of a sphere and through the entities selected for this sweep operation.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
sphere_coord_frame[]
This value specifies an identifier for the coordinate frame in which the sphere axis is defined.
STRING
sphere_center[]
This value specifies a point that will be used as the center of a sphere from which a spherical radius will be projected.
STRING
radial_distance[]
This value will specify the distance along the spherical radius where the created entities will be placed.
STRING
offset_distance[]
This value will specify an offset distance along the spherical radius between the entities on which the sweep operation will take place and the location along the spherical radius where the entities created by the sweep operation will be placed.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
 
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created
[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Radial Sph.”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_sphere_radial_1.
 
fem_sweep_vector_field_1
(sweep_elem_select, sweep_node_select, vector_field, field_scale_factor, offset_distance, reverse_field, normalize_field, flag, entity_select, num_topologies, sweep_topologies, anly_coord_frame, ref_coord_frame, mesh_control_type, mesh_control, num_nodes, num_elements, nodes_created, elements_created)
 
Description:
This function will create elements by using the vector field sweep method.
Input:
STRING
sweep_elem_select[]
This value specifies a selection of element identifiers to be assigned to the newly created elements.
STRING
sweep_node_select[]
This value specifies a selection of node identifiers to be assigned to the newly created nodes.
STRING
vector_field[]
This value specifies the name of a vector field.
STRING
field_scale_factor[]
This value specifies a scaling factor to apply to the vector field.
STRING
offset_distance[]
This value will specify an offset distance between the entities on which the sweep operation will take place and the location where the entities created by the sweep operation will be placed.
LOGICAL
reverse_field
This value specifies, when set to TRUE, that the direction of the vectors in the vector field be reversed.
LOGICAL
normalize_field
This value specifies, when set to TRUE, that the vectors in the vector field be normalized. Normalizing the vectors in the vector field will allow magnitude of the sweep operation to be a function of the input value field_scale_factor only.
INTEGER
flag
This value specifies, when set to 1, that the original elements and nodes from which the sweep operation was made will be deleted. When set to 2 this value uses the new numbering control scheme.
STRING
entity_select[]
This value specifies a list of entities on which the sweep operation will take place.
INTEGER
num_topologies
This value specifies the number of sweep topology conversion pairs and should be set to the value 10.
STRING
sweep_topologies[]
(num_topologies)
This value specifies an array of selections of elements used to define the relationship between the types of entities on which the sweep operation will take place and the entities that the sweep operation will create from those entities. The offset into the array is used to define the type of entity from which the geometry will be extended and the value at that offset will define the entity created from the starting geometric type. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
anly_coord_frame[]
This value specifies an identifier for the analysis coordinate frame.
STRING
ref_coord_frame[]
This value specifies an identifier for the reference coordinate frame.
STRING
mesh_control_type[]
This value specifies the type of mesh control to be used with the arc sweep operation. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
STRING
mesh_control[](6)
This value specifies mesh control parameters. See the “Sweep Function Input Value Tables” at the end of this section for a list of values that can be used with this argument.
Output:
INTEGER
num_nodes
This value returns the number of nodes created by the sweep operation.
INTEGER
num_elements
This value returns the number of elements created by the sweep operation.
STRING
nodes_created[VIRTUAL]
This value returns a description of the created nodes.
STRING
elements_created
[VIRTUAL]
This value returns a description of the created 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 to implement the functionality behind the form accessed by the “Finite Elements” switch bar selection when the “Action:” switch is set to “Sweep”, the “Object:” switch is set to “Element”, and the “Method” switch is set to “Vector Field”.
Space is internally allocated for the string returned by the output values nodes_created and elements_created. It is the responsibility of the calling function to free the allocated string storage space.
This function can create and delete elements and nodes that are stored in the database and displayed in a viewport.
Example:
Please see fem_sweep_vector_field_1 (p. 776) in the PCL Reference Manual Examples. 
Sweep Function Input Value Tables
The tables listed below describe the values that can be used with the sweep functions described in this section of the chapter.
The sweep_topologies array of strings:
The input value sweep_topologies defines the following relationships between the original entities and the created entities by being set to the following values:
 
Offset
Original Element Type
Offset Value and the Created Element Type
 
1
Point
“Bar2”
1
Point
“Bar3”
1
Point
“Bar4”
2
Bar2
“Quad4”
3
Bar3
“Quad8”
4
Bar4
“Quad12”
5
Tri3
“Wedge6”
6
Tri6
“Wedge15”
7
Tri9
“Wedge24”
8
Quad4
“Hex8”
9
Quad8
“Hex20”
10
Quad12
“Hex32”
The mesh_control_type string:
The input value mesh_control_type can have the following values:
 
“Uniform: Number of Elements”
“Uniform: Element Length”
“One_Way_Bias: Num Elems and L2/L1”
“One_Way_Bias: L1 and L2”
“Two_Way_Bias: Num Elems and L2/L1”
“Two_Way_Bias: L1 and L2”
The mesh_control array of strings:
The offsets for the input value mesh_control have the following uses:
 
Offset
Description
 
1
This offset is used to define the number of elements created when the input value mesh_control_type is set to “One_Way_Bias: Num Elems and L2/L1” or “Two_Way_Bias: Num Elems and L2/L1”. This value must represent an integer that is greater than 0.
2
This offset is used to define the ratio of L2/ L1 when the input value mesh_control_type is set to “One_Way_Bias: Num Elems and L2/L1” or “Two_Way_Bias: Num Elems and L2/L1”. This value must represent a real number that is greater than 0.
3
This offset is used to define the length of L1 when the input value mesh_control_type is set to “One_Way_Bias: L1 and L2” or “Two_Way_Bias: L1 and L2”. This value must represent a real number that is greater than 0.
4
This offset is used to define the length of L2 when the input value mesh_control_type is set to “One_Way_Bias: L1 and L2” or “Two_Way_Bias: L1 and L2”. This value must represent a real number that is greater than 0.
5
This offset is used to define the element length used when the input value mesh_control_type is set to “Uniform: Element Length”. This value must represent a real number that is greater than 0.
6
This offset is used to define the number of elements created when the input value mesh_control_type is set to “Uniform: Number of Elements”. This value must represent an integer that is greater than 0.