COMSOL 6.2 - ArrowData

model.result(<pgtag>).create(<ftag>,"ArrowData");

model.result(<pgtag>).feature(<ftag>).set(property,<value>);

model.result(<pgtag>).feature(<ftag>).run();

model.result(<pgtag>).create(<ftag>,"ArrowData") creates an arrow data plot feature named <ftag> belonging to the 2D or 3D plot group <pgtag>.

Arrow data plots are used to visualize raw vector data given as points, vectors, and colors (see the example below). Arrow data plots can be added to 2D and 3D plot groups.

The following properties are available:

Table 7-13: Valid Property/Value Pairs for Arrow Data Plots.
name	Value	Default	Description
arrowbase	head \| tail \| center	tail	Whether the head, tail, or center of the arrow is located at the arrow position.
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 \| arrowhead \| cone	arrow	The type of arrow to draw.
bottomcolor	custom \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	black	The bottom color to use for a color gradient. Active when coloring is gradient.
color	custom \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	red	The uniform color to use. Active when coloring is uniform.
colorcalibration	double	0	A color calibration value (-1.5 to 1.5) when colortabletrans is set to nonlinear or nonlinearsymmetric.
colordata	double 1D array		The color data for the arrow data plot as a real N-vector.
coloring	colortable \| uniform \| gradient	colortable	How to color the plot: using a color table, a uniform color, or a color gradient.
colorlegend	on \| off	on	Whether to show color legend when coloring is set to colortable.
colorscalemode	linear \| linearsymmetric \| logarithmic	linear	Scaling of the color table: linear, linear symmetric around 0, or logarithmic, when coloring is set to colortable or gradient.
colortable	color table name	Rainbow	The color table to use when coloring is set to colortable. See Color Tables for a list of color tables.
colortabletrans	none \| reverse \| nonlinear \| nonlinearsymmetric	none	Transformation of the color table, when coloring is set to colortable or gradient.
custombottomcolor	RGB-triplet	{1,0,0} or last used color	The uniform color to use. Active when bottomcolor is set to custom.
customcolor	RGB-triplet	{1,0,0} or last used color	The uniform color to use. Active when color is set to custom.
customtopcolor	RGB-triplet	{1,0,0} or last used color	The uniform color to use. Active when topcolor is set to custom.
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.
nonlinearcolortablerev	on \| off	off	Whether to reverse to color table or gradient when coloring is set to colortable or gradient and colortabletrans is set to nonlinear or nonlinearsymmetric.
pointdata	double 2D array		The point data for the arrows’ starting points in the arrow data plot, as x and y-coordinates in 2D and x-, y-, and z-coordinates in 3D in an sdim-by-N real matrix.
rangecoloractive	on \| off	off	Whether to use the manual color range specified in rangecolormin and rangecolormax. The color range specifies the minimum and maxim value in the plotted colors. Default is the minimum and maximum data values.
rangecolormax	double	Plot dependent	The maximum color range value. Active when rangecoloractive is on.
rangecolormin	double	Plot dependent	The minimum color range value. Active when rangecoloractive is on.
rangedatactive	on \| off	off	Whether to use the manual data range specified in rangedatamin and rangedatamax. Values outside the data range are not plotted.
rangedatamax	double	Plot dependent	The maximum data value. Active when rangedataactive is on.
rangedatamin	double	Plot dependent	The minimum data value. Active when rangedataactive is on.
title	String	The auto-title.	The title to use when titletype is manual.
titletype	auto \| label \| manual \| none	auto	auto, if the title should be computed automatically. label, if the title should be the plot group’s label. manual, if the manual title should be used (the title property). none, if no title should be displayed.
topcolor	custom \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	white	The top color to use for a color gradient. Active when coloring is gradient.
vectordata	double 2D array		The vector data for the arrow data plot, as sign and length of the arrows in the x and y directions in 2D and in the x, y, and z directions in 3D in an sdim-by-N real matrix.