Waterfall
Create a waterfall plot. The waterfall plot creates a waterfall diagram, which is a plot that can illustrate how an expression depends on two parameters in a sweep.
Syntax
model.result(<pgtag>).create(<ftag>,"Waterfall");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
 model.result(<pgtag>).create(<ftag>,"Waterfall") creates a waterfall plot feature named <ftag> belonging to the plot group <pgtag>.
The following properties are available:
Table 7-102: Valid Property/Value Pairs for Waterfall Plots
Property
Value
Default
Description
colortable
color table name
Rainbow
The color table to use when styletype is set to surface or both. See Color Tables for a list of color tables.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
data
none | parent | data set name
parent
The data set this feature refers to.
descr
String
Model-dependent.
The description of the expression 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
Model-dependent.
The expression to plot.
expressionintitle
on | off
off
Whether the title contribution should contain the expression when titletype is custom.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited.
inheritplot
none | plot name
none
The plot that color is 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.
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.
prefixintitle
String
Empty
Added prefix to contribution to title.
smooth
none | material | internal | everywhere | expression
internal
Smoothing settings. With material, smoothing is done inside material domains With internal, smoothing is done inside geometry domains. With expression, the smoothing is based on the expression in smoothexpr.
smoothexpr
String
dom
The expression to use for smoothing when smooth is set to expression.
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.
styletype
both | line | surface
both
Use a line plot, a surface plot, or both.
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.
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.
xdescr
String
 
A description for the x-axis data expression.
xdescractive
on | off
off
Enable a description for the x-axis data expression.
xexpr
String
 
Expression for the x-axis data.
xunit
String
 
The unit for the x-axis data expression.
ydescr
String
 
A description for the y-axis data expression.
ydescractive
on | off
off
Enable a description for the y-axis data expression.
yexpr
String
 
Expression for the y-axis data.
yunit
String
 
The unit for the y-axis data expression.