TubeSelectionRule#
- class ansys.acp.core.TubeSelectionRule(*, name='TubeSelectionrule', edge_set=None, outer_radius=1.0, inner_radius=0.0, include_rule_type=True, extend_endings=False, symmetrical_extension=True, head=(0.0, 0.0, 0.0), head_extension=0.0, tail_extension=0.0)#
Instantiate a Tube Selection Rule.
- Parameters:
name (
str, default:'TubeSelectionrule') – Name of the Tube Selection Rule.edge_set (
EdgeSet|None, default:None) – Edge Set defining the path of the tube.outer_radius (
float, default:1.0) – Outer radius of the tube.inner_radius (
float, default:0.0) – Inner radius of the tube.include_rule_type (
bool, default:True) – Include or exclude area in rule. Setting this toFalseinverts the selection.extend_endings (
bool, default:False) – Enable this option to extend the endings of the tube.symmetrical_extension (
bool, default:True) – Whether the extensions have equal length on both sides or not.head (
tuple[float,float,float], default:(0.0, 0.0, 0.0)) – Defines the head of the tube. Select a point nearby one of the free ends of the tube. Only needed if the extensions are asymmetric.head_extension (
float, default:0.0) – Defines the length of the extension at the head of the tube. In case of symmetry, this value is used for both sides.tail_extension (
float, default:0.0) – Defines the length of the extension at the tail of the tube. Only needed if the extensions are asymmetric.
Methods
TubeSelectionRule.clone(*[, unlink])Create a new unstored object with the same properties.
Delete the object.
TubeSelectionRule.store(parent)Store the object on the server.
Attributes
Identifier of the object, used for example as key in maps.
The name of the object.