component

ptrace.component(p0: float, p1: float, p2: float) → int

Specifies the contribution of the components of the flow field vector variable through which the particle trace will be integrated.

The normal situation is to have all three set to 1.0, to get the true vector field.

Args:

p0:

‘x_scal’ scale factor to apply to the x, y, z components of the vector

p1:

‘y_scal’ scale factor to apply to the x, y, z components of the vector

p2:

‘z_scal’ scale factor to apply to the x, y, z components of the vector

Examples:

#
# Selecting the parent part
#
ensight.part.select_begin(1)
#
# Setting some attributes before creation
# (the components are being set here)
#
ensight.ptrace.begin()
ensight.ptrace.type("streamline")
#
# Create the particle trace with
# the x and y components of the vector
#
ensight.ptrace.component(1.0000e+00,1.0000e+00,0.0000e+00)
ensight.ptrace.representation("line")
ensight.ptrace.end()
#
# Creating trace from a point
#
ensight.ptrace.create_pt()

Returns:

zero on success, non-zero on error