IntersectPlane

Intersect an imported 3D mesh with a plane. The operation will partition geometric entities and intersect mesh entities to introduce planar intersections. Supported entities are unmeshed domains, boundaries, and edges. Meshed faces are created within the intersection edges if the edges form closed loops.

Syntax

model.component(<ctag>).mesh(<tag>).create(<ftag>,"IntersectPlane");

model.component(<ctag>).mesh(<tag>).feature(<ftag>).selection();

model.component(<ctag>).mesh(<tag>).feature(<ftag>).selection(property);

model.component(<ctag>).mesh(<tag>).feature(<ftag>).set(property,<value>);

model.component(<ctag>).mesh(<tag>).feature(<ftag>).getType(property);

Description

Use model.component(<ctag>).mesh(<tag>).create(<ftag>,"IntersectPlane") to partition geometric entities and mesh elements of an imported 3D mesh by specifying a plane.

The following properties are available:

Table 4-15: Available Properties.
Property	Value	Default	Description
planetype	quick \| faceparallel \| edgeparallel \| normalvector \| vertices \| coordinates	quick	How the plane is specified. See tables Table 4-16 to Table 4-21 for additional properties.
additionalplane	on \| off	off	Specify if to add additional parallel planes
planedistance	double[]		Sequence of numbers specifying desired offsets of additional planes. Both positive and negative values are allowed.
reversedistance	on \| off	off	Generate the additional planes in the opposite direction
createface	on \| off	on	Generate faces for closed loops in the intersection
toltype	auto \| relative \| absolute	auto	How snapping tolerance is specified.
abstol	double		Absolute point snapping tolerance, if toltype is absolute.
reltol	double	0.01	Relative point snapping tolerance, if toltype is relative.
cleanup	on \| off	on	Cleanup of resulting mesh by collapsing mesh edges within specified toltype tolerance.
placement	linear \| curved	curved	Specifies the placement of mesh vertices in the plane intersection.
selabove	on \| off	off	Specifies if to create a selection of resulting domains above the plane.
selbelow	on \| off	off	Specifies if to create a selection of resulting domains below the plane.
selinter	on \| off	off	Specifies if to create a face selection of resulting boundaries in intersection plane.
selinteredg	on \| off	off	Specifies if to create an edge selection of resulting intersection edges in the plane.

Quick

This defines a plane parallel to one of the global coordinate planes.

Table 4-16: Valid Properties, Quick.
Property	Value	Default	Description
quickplane	xy \| yz \| zx \| yx \| zy \| xz	xy	Specify which coordinate plane to use.
quickx	double	0	x-coordinate for plane (used when plane is yz or zy).
quicky	double	0	y-coordinate for plane (used when plane is xz or zx).
quickz	double	0	z-coordinate for plane (used when plane is xy or yx).
quickoffsettype	distance \| vertex	distance	Type of offset specification.
offsetvertex	Selection		Specify vertex when quickoffsettype is vertex.

Face Parallel

This specifies a plane that is parallel to a planar face in a mesh.

Table 4-17: Valid Properties, FaceParallel.
Property	Value	Default	Description
face	Selection		Planar face selection.
offset	double	0	Specify offset in the normal direction of plane.
reverse	on \| off	off	Reverse normal direction of plane.
offsettype	distance \| vertex	distance	Type of offset specification.
offsetvertex	Selection		Specify vertex when offsettype is vertex.

Edge Parallel

This defines a plane that is parallel to a planar edge in a mesh.

Table 4-18: Valid Properties, edgeParallel.
Property	Value	Default	Description
planaredge	Selection		Planar edge selection.
offset	double	0	Specify offset in the normal direction of plane.
reverse	on \| off	off	Reverse normal direction of plane.
offsettype	distance \| vertex	distance	Type of offset specification.
offsetvertex	Selection		Specify vertex when offsettype is vertex.

Normal Vector

This specifies a plane defined by a normal vector and a point on the plane.

Table 4-19: Valid Properties, normalvector.
Property	Value	Default	Description
normalvector	double[3]	{0,0,1}	Normal vector specification.
normalpoint	coord \| vertex	coord	Point on plane (defined using coordinates or as a geometry vertex).
normalcoord	double[3]	{0,0,1}	Coordinates of point, used when normalpoint is set to coord.
normalvertex	Selection		Vertex for point, used when normalpoint is set to vertex.

Vertices

This creates a plane parallel to a plane through three vertices v1, v2, and v3.

Table 4-20: Valid Properties, Vertices.
Property	Value	Default	Description
vertex1	Selection		Specification of first vertex.
vertex2	Selection		Specification of second vertex.
vertex3	Selection		Specification of third vertex.
offset	double	0	Specify offset in the normal direction of plane.
reverse	on \| off	off	Reverse normal direction of plane.

Coordinates

This creates a plane through three points p1, p2, and p3.

Table 4-21: Valid Property, Coordinates.
Property	Value	Default	Description
genpoints	double[3][3]	{{0,0,0},{1,0,0},{0,1,0}}	Specification of points.

genpoints[n][i] is the ith coordinate of the nth point.

Table 4-22: Available Additional Properties When selabove, Selbelow. selinter and selinteredg are SET to on.
Property	Value	Default	Description
colorabove	none \| custom \| integer between 1 and the number of colors in the current theme	none	The color of the domain selection, either given as an integer indicating a color in the color theme, or as a custom color in the customcolorabove property.
colorbelow	none \| custom \| integer between 1 and the number of colors in the current theme	none	The color of the domain selection, either given as an integer indicating a color in the color theme, or as a custom color in the customcolorbelow property.
colorinter	none \| custom \| integer between 1 and the number of colors in the current theme	none	The color of the face selection, either given as an integer indicating a color in the color theme, or as a custom color in the customcolorinter property.
customcolorabove	RGB-triplet	Next available theme color	The color to use. Active when colorabove is set to custom.
customcolorbelow	RGB-triplet	Next available theme color	The color to use. Active when colorbelow is set to custom.
customcolorinter	RGB-triplet	Next available theme color	The color to use. Active when colorinter is set to custom.
selaboveshow	off \| all \| pnt \| edg \| bnd \| dom	dom	Specifies on which geometric level the selection is shown in physics, materials, and so on. For mesh parts, this option shows selection outside the part. Used if selabove is on.
selbelowshow	off \| all \| pnt \| edg \| bnd \| dom	dom	Specifies on which geometric level the selection is shown in physics,, materials, and so on. For mesh parts, this option shows selection outside the part. Used if selbelow is on.
selintershow	on \| off	on	Show face selection in physics, materials, and so on. For mesh parts, this option shows selection outside the part. Used if selinter is on.
selinteredgshow	on \| off	on	Show edge selection in physics, materials, and so on. For mesh parts, this option shows selection outside the part. Used if selinteredg is on.