ArrowVolume, ArrowSurface, ArrowLine
Create volume, surface, or line arrow plots.
Syntax
model.result(<pgtag>).create(<ftag>,"ArrowVolume");
model.result(<pgtag>).create(<ftag>,"ArrowSurface");
model.result(<pgtag>).create(<ftag>,"ArrowLine");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Arrow...") creates an arrow plot feature named <ftag>.
Arrow plots are available in 2D and 3D. ArrowLine plots arrows on lines in 2D or 3D such as geometry boundaries in 2D or cut plane edges in 3D. ArrowSurface plots arrows on surfaces in 2D or 3D. ArrowVolume plots arrows in a 3D volume.
The following properties are available:
Table 7-8: Valid Property/Value Pairs for Arrow Plots
Property
Value
Default
Description
arrowbase
heat|tail|
center
head
Whether the head, tail, or center of the arrow is located at the arrow position.
arrowcount
positive integer
200
If placement is uniform: The approximate number of arrows. Available for ArrowEdge in 2D and 3D and for ArrowSurface in 3D.
arrowlength
normalized | proportional | logarithmic
proportional
The arrow scaling: Proportional uses the actual arrow length, normalized a unit length, and logarithmic a length proportional to the logarithm of the arrow length.
arrowtype
arrow | cone
arrow
The type of arrow to draw.
arrowxmethod
number | coord
number
Indicates whether the x-coordinates of the arrows should be specified by number of points to distribute evenly across the data or by coordinates. Available for ArrowSurface in 2D and ArrowVolume in 3D.
arrowymethod
number | coord
number
Indicates whether the y-coordinates of the arrows should be specified by number of points to distribute evenly across the data or by coordinates. Available for ArrowSurface in 2D and ArrowVolume in 3D.
arrowzmethod
number | coord
number
Indicates whether the z-coordinates of the arrows should be specified by number of points to distribute evenly across the data or by coordinates. Available for ArrowVolume in 3D.
color
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The color to use.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
customcolor
RGB-triplet
{1,0,0} or last used color.
The uniform color to use. Active when color is set to custom.
data
none | parent | data set name
parent
The data set this feature refers to.
descr
String
Model-dependent
The description of the expressions in expr. Is used in the automatic title.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
differential
on | off
on
Whether the expression should be linearized at the linearization point. Applicable only if evalmethod is harmonic.
evalmethod
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
harmonic
Applicable only for solutions with a stored linearization point. Controls if the linearization point, the perturbation, or a combination should be used when evaluating the expression.
expr
String array of length 2 in 2D and 3 in 3D
Mode-dependent
The components of the vector to plot as arrows.
inheritarrowscale
Boolean
true
If inheritplot is not none: Determines if arrow scale is inherited.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited.
inheritplot
none | plot name
none
The plot that arrow scale, color, and deformation scale are inherited from.
interp
double array
Time corresponding to last selected solnum for transient levels.
The time to use, for transient levels. Available when data is not parent and the underlying data is transient.
logrange
double > 1
100
If arrowlength is logarithmic: The ratio between the maximum arrow length and the arrow length below which no arrow is drawn.
looplevel
array of nonnegative integers and strings
Last solution for transient or parametric solution for each level. Otherwise first solution for each level.
The index of the solution to use, per level, or interp, but only for transient solutions. Available when data is not parent and the underlying data has multiple solutions.
outersolnum
nonnegative integer
1
The index of the outer solutions to use. Applicable only for parametric sweep models.
placement
elements | uniform | uniformanis
uniform
If uniform, then the arrows are distributed uniformly. If uniformanisotropic, then the arrows are distributed uniformly with weights taken from the weight property. If elements, then arrows are drawn in the mesh nodes for each element. Available for ArrowEdge in 2D and 3D and for ArrowSurface in 3D.
planecoordsys
cutplane | cartesian
cartesian
Coordinate system for arrow vectors. Only available for plots that use a cut plane data set that points to a 3D solution or mesh data set.
plotcomp
all | normal | tangential
all
Choose to plot arrows that represent all components of the vector in expr or only its normal or tangential components. Available for ArrowSurface in 3D.
prefixintitle
String
Empty
Added prefix to contribution to title.
revcoordsys
cylindrical | cartesian
cartesian
Coordinate system for arrow vectors. Only available for plots that use a 1D or 2D revolution data set that has default axis settings and points to a solution or mesh data set for an axisymmetric geometry.
scale
positive double
1
If scaleactive is true: The length scale factor.
scaleactive
Boolean
false
Whether to use manual scaling.
solnum
nonnegative integer
Last solution for transient or parametric solution. Otherwise first solution.
The index of the solution to use. Available when data is not parent and the underlying data has multiple solutions.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active
suffixintitle
String
Empty
Added suffix to contribution to title
t
double
Time corresponding to last selected solnum.
The time to use, for transient problems. Available when data is not parent and the underlying data is transient.
timeinterp
on | off
off
on if t is used to determine time steps, off if solnum is used.
title
String
The auto-title.
The title to use when titletype is manual.
titletype
auto | custom | manual | none
auto
auto if the title contribution should be computed automatically, possibly using the group’s customization. custom if the title contribution should be computed automatically, but customized. manual if the manual title contribution should be used (the title property). none if no title contribution should be used.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
weight
double array
1
If placement is uniformani: The weights given to the different axis directions.
xnumber
nonnegative integer
15 (3D), 7 (2D)
Number of points in the x-direction. Active when arrowxmethod is set to number. Available for ArrowSurface in 2D and ArrowVolume in 3D.
xcoord
String array
Empty
Absolute coordinates in the x-direction, active when arrowxmethod is set to coord. Available for ArrowSurface in 2D and ArrowVolume in 3D.
ynumber
integer
15 (3D), 7 (2D)
Number of points in the y-direction. Active when arrowymethod is set to number. Available for ArrowSurface in 2D and ArrowVolume in 3D.
ycoord
String array
Empty
Absolute coordinates in the z-direction, active when arrowymethod is set to coord. Available for ArrowSurface in 2D and ArrowVolume in 3D.
znumber
integer
15 (3D), 7 (2D)
Number of points in the z-direction. Active when arrowzmethod is set to number. Available for ArrowVolume in 3D.
zcoord
String array
Empty
Absolute coordinates in the z-direction, active when arrowzmethod is set to coord. Available for ArrowVolume in 3D.
Attributes
Color, Deform, Filter
See Also
Line, ScatterVolume, ScatterSurface, Surface, Volume