SobolIndex

Create a Sobol index plot to visualize Sobol indices for a sensitivity analysis in an uncertainty quantification study This plot type can be added to 1D plot groups.


	The Sobol index plot requires a license for the Uncertainty Quantification Module.

Syntax

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

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

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

Description

model.result(<pgtag>).create(<ftag>,"SobolIndex") creates a Sobol index feature named <ftag> belonging to the 1D plot group <pgtag>. The plot takes a quantity of interest from a table created by an uncertainty quantification study.

The following properties are available:

Table 7-123: Valid Property/Value Pairs for Sobol Index Plots
name	Value	Default	Description
autolegends	on \| off	on	Whether to use the automatically generated legends or the legends defined in the legends property.
customlinecolor	RGB-triplet	{0,0,1} or last used edgecolor.	The color to use for the lines. Active when linecolor is set to custom.
legend	on \| off	off	Whether to show legends.
legendmethod	automatic \| manual	automatic	Whether to use the automatic legends or the legends supplied in the legends property.
legendprefix	String		A prefix added to the automatic legend.
legends	String array	The last computed automatic legends.	Manual legends active when legendmethod is set to manual.
legendsuffix	String		A suffix added to the automatic legend.
linecolor	custom \| cycle \| cyclereset \| fromtheme \| black \| blue \| cyan \| gray \| green \| magenta \| red \| white \| yellow	cycle	How to color the index bars in the graph. Cycle indicates that the colors is different for each bar. Use fromtheme to take the color from the selected color theme.
quantityofinterest	positive integer	1	The column in the table that contains the quantity of interest.
sort	Boolean	false	Sort parameters in decreasing order with respect to the total Sobol index for the quantity of interest.
table	none \| table feature name	First available table	The table feature this plot refers to.
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.