COMSOL 6.2 - Height, AberrationHeight, HistogramHeight, TableHeight

Height, AberrationHeight, HistogramHeight, TableHeight

Add a height attribute for 2D contour, line, and surface plots; for 2D optical aberration plots; for 2D histogram, matrix histogram, and table histogram plots, and for 2D table surface plots.

Syntax

model.result(<pgtag>).feature(<ftag>).create(<atag>,"Height");

model.result(<pgtag>).feature(<ftag>).create(<atag>,"AberrationHeight");

model.result(<pgtag>).feature(<ftag>).create(<atag>,"HistogramHeight");

model.result(<pgtag>).feature(<ftag>).create(<atag>,"TableHeight");

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

Description

model.result(<pgtag>).feature(<ftag>).create(<atag>,"Height") creates a Height attribute feature with the name <atag>, belonging to the feature <ftag>.

Height attributes are available for 2D contour, line, and surface plots, and with slightly different sets of properties, for 2D optical aberration, histogram, matrix histogram, table histogram, and table surface plots. Adding a height attribute changes the rendered view to 3D. The plot group, however, still remains a 2D plot group. Any other plots in the group that do not have a height attribute are rendered at z = 0. 2D plots with a height attribute can also use a transparency attribute.

The following properties are available:

Table 7-55: Valid Properties for Height Attributes.
Property	Value	Default	Description
coldata	integer		Table data for the height for a table surface with the columns table format. An integer that specifies the column number to use.
data	none \| filled table data	none	Table data for the height for a table surface with the filled table format.
descr	String	Model dependent	The description of the expression in expr. It 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	Model dependent	The expression to plot. For Height attributes only.
expressionintitle	on \| off	off	Whether the title contribution should contain the expression when titletype is custom.
heightdata	parent \| expr or parent \| data	parent	parent uses the expression and description in the plot the height feature has been added to. expr uses the expr and descr properties (for Height attributes only). data uses some specified data from the data or coldata properties (for TableHeight attributes only).
imagplot	on \| off	off	Plot the imaginary part of the height data (for TableHeight attributes only).
offset	double	0	The offset along the z-axis where to place the height plot.
prefixintitle	String	Empty	Added prefix to contribution to title.
preprocz	none \| linear	none	Preprocess the height data with a scaling factor and a shift, if set to linear (for TableHeight attributes only).
scale	positive double	1	If scaleactive is true: The scale factor for the height.
scaleactive	Boolean	false	Whether to use manual scaling.
scalingz	double	1	The scaling factor for the preprocessing, if preprocz is set to linear (for TableHeight attributes only).
shiftz	double	0	The shift for the preprocessing, if preprocz is set to linear (for TableHeight attributes only).
suffixintitle	String	Empty	Added suffix to contribution to title.
title	String	The auto-title.	The title to use when titletype is manual.
titletype	auto \| custom \| label \| manual \| none	auto	auto, if the title should be computed automatically. custom, if the title should be computed automatically, but customized. 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. custom is available for Height attributes only.
typeintitle	on \| off	on	Whether the title contribution should contain the type when titletype is custom.
unit	String	Model dependent	The unit to use for the expression in expr. If the old unit is not valid when the expression changes, the unit property is reset to default.
unitintitle	on \| off	on	Whether the title contribution should contain the unit when titletype is custom.