create_surface_rake

ptrace.create_surface_rake(p0: float, p1: float, p2: float, p3: float, p4: float) → int

Create surface restricted particle traces from a screen pick rake location.

The “ptrace: surface_restricted” command must be ON prior to this command.

The default attributes and/or any “ptrace:” attribute commands between “ptrace: begin” and “ptrace: end” commands are used for the trace creation. A parent part or parts (containing the flow field) must be selected prior to this command.

Args:

p0:

‘num_points’ number of equally spaced points along the rake to use as emitters

p1:

‘x1’ screen x coordinate of the first end of the rake (0.0 to 1.0)

p2:

‘y1’ screen y coordinate of the first end of the rake (0.0 to 1.0)

p3:

‘x2’ screen x coordinate of the second end of the rake (0.0 to 1.0)

p4:

‘y2’ screen y coordinate of the second end of the rake (0.0 to 1.0)

Examples:

#
# Selecting the parent part(s)
#
ensight.part.select_begin(1,3,4)
#
# Setting some attributes before creation
# (surface_restricted must be on)
#
ensight.ptrace.begin()
ensight.ptrace.surface_restricted("ON")
ensight.ptrace.variable("VITESSE")
ensight.ptrace.type("streamline")
ensight.ptrace.component(1.0000e+00,1.0000e+00,1.0000e+00)
ensight.ptrace.representation("line")
ensight.ptrace.emit_at_current_time("ON")
ensight.ptrace.end()
#
# Creating 10 traces from a screen rake location
#
ensight.ptrace.create_surface_rake(10,0.117150,0.540862,0.117150,0.442793)

Returns:

zero on success, non-zero on error