IntersectionPoint2D, IntersectionPoint3D
Create a dataset that enables the evaluation of expressions at the intersection points of particle or ray trajectories and a curve or surface. These datasets can use a Ray or Particle dataset as their input.
Syntax
model.result().dataset().create(<dtag>,"InsterSectionPoint3D");
model.result().dataset(<dtag>).set(property, <value>);
Description
model.result().dataset().create(<dtag>,"IntersectionPoint2D") creates an intersection point 2D dataset with the name <dtag>.
The following properties are available:
Table 7-55: Valid Property/Value Pairs for Intersection Point 2D and Intersection Point 3D Datasets
Property
Value
Default
Description
axis
double array
{0, 1}
Axis direction for a semicircle used as the curve type or a hemisphere used as the plane type.
bounded
on | off
on
Control if a line used as the curve type should be bounded by the points or not.
center
double array
{0, 0,}
Center coordinates for a circle, semicircle, sphere, or hemisphere as the curve or plane type.
data
none | dataset name
First compatible dataset
The dataset this feature refers to.
expr
String
 
Expression for a general curve or plane.
extrasteps
none | specifiedtimes|
proportional
specifiedtimes
Controls how the number of extra time steps to find all intersections are added. These extra time steps typically correspond to the exact times of reflections or velocity reinitializations.
genparaactive
on | off
off
Decides if parallel lines or planes should be drawn.
genparadist
double array
{}
Active when genparaactive is on, this property contains the distances from the extra parallel lines or planes to the base plane.
genmethod
threepoint | pointnormal
threepoint
Active when planetype equals general, this property indicates whether the plane should be specified by three points or through one point and a normal.
genpoints
double
0 or 1, depending on index position ([0, 0, 0; 1 0 0;
0 1 0])
Active when method equals threepoint, this property contains the coordinates of the three points in the rows of the matrix. See below for the use of this property and the setIndex method.
genpnpoint
String array of length three
Zero string vector
Active when genmethod equals pointnormal, this property contains the coordinates of the point.
genpnvec
String array of length three
Zero string vector
Active when genmethod equals pointnormal, this property contains the normal vector.
interpolation
linear | cubic
linear
The polynomial order of the method used to interpolate between time steps to evaluate expressions at the intersection points. If cubic is selected, the derivatives at the time steps are also taken into account.
normal
String array of length two or three
Created from the feature tag.
The names of the variables that can be used to evaluate the curve’s or plane’s normal.
numextrasteps
Nonnegative integer
100
If extrasteps is specifiedtimes, controls the maximum number of extra time steps to use to find all intersections.
planetype
quick | general
quick
Specify plane type for the surface type plane (3D).
propextrasteps
Nonnegative integer
1
If extrasteps is proportional, controls the maximum number of extra time steps to use to find all intersections. The maximum number of extra steps is the product of this proportionality factor with the number of solution times.
radius
double
1
Radius for a circle, semicircle, sphere, or hemisphere as the curve or plane type.
quickplane
xy | yz | zx | yx | zy | xz
yz
Specify quick plane type. Active when planetype is quick.
quickx
String
"0"
x-coordinate if planetype is yz or zy.
quicky
String
"0"
y-coordinate if planetype is zx or xz.
quickz
String
"0"
z-coordinate if planetype is xy or yx.
spacevars
String array of length 2
Created from the feature tag.
The names of the variables that evaluate to the plane’s parameterization.
type
line | circle | semicircle | general (2D); plane | sphere | hemisphere | general (3D)
line (2D); plane (3D)
The type of curve (2D) or surface (3D).
For specifying the coordinates for a line curve type, for example, use the setIndex method:
model.result().dataset("ip2").setIndex("genpoints", "1.3", 0, 1);
That line sets the y coordinate of point one to the value 1.3.