Whirl
Create a whirl plot in a 3D plot group. This plot type is only available with a license for the Rotordynamics Module.
Syntax
model.result(<pgtag>).create(<ftag>,"Whirl");
model.result(<pgtag>).feature(<ftag>).set(property,<value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
 model.result(<pgtag>).create(<ftag>,"Whirl") creates a whirl plot feature named <ftag> belonging to the plot group <pgtag>.
The whirl plot creates a plot of the mode shapes of a rotor rotated about the rotor axis at discrete rotation intervals.
The following properties are available:
Table 7-166: Valid Properties for Whirl Plots.
Property
Value
Default
Description
colorcalibration
double
0
A color calibration value (-1.5 to 1.5) when colortabletrans is set to nonlinear or nonlinearsymmetric.
colortable
color table name
Rainbow
The color table to use. 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.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
data
none | parent | dataset name
parent
The dataset 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 array
Model dependent
The x, y, and z components of 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 and tube radius scale are inherited from.
inherittubescale
Boolean
true
If inheritplot is not none: Determines if the tube radius scale is inherited.
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.
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.
nplanes
nonnegative integer
4
Number of planes in the whirl plot.
nrings
nonnegative integer
4
Number of rings in the whirl plot.
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.
radiusexpr
String
Empty
The tube radius expression.
recover
off | pprint | ppr
off
The derivative recovery method (off, within domains, or everywhere).
refine
nonnegative integer
1
The element refinement to use, if resolution is set to manual. Bear in mind that this is the refinement used for the base dataset, so the number of elements in the model can increase radically if the plot uses, for example, a revolve dataset.
resolution
norefine | coarse | normal | fine | finer | extrafine | custom
normal
Controls the plot’s resolution. A finer setting results in a higher resolution by modifying the internally computed default refinement. Use custom to enter your own refinement in the refine property.
ringcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
blue
The color to use for the rings in the whirl plot.
smooth
none | material | internal | everywhere | expression
material
Smoothing settings. With material, smoothing is done inside domains with the same material. 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.
solutionparams
manual | parent
manual
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
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.
threshold
manual | none
none
Use a smoothing threshold.
thresholdvalue
double
0.1
Threshold value (0–1), if threshold is set to manual.
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 | 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.
tuberadiusscale
double
1
The scale factor applied to the tube radii if tuberadiusscaleactive is true.
tuberadiusscaleactive
Boolean
false
If true, tuberadiusscale is used, otherwise the scale factor is computed automatically.
typeintitle
on | off
on
Whether the title contribution should contain the type when titletype is custom.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom.
Attributes
 Color, MaterialAppearance, Transparency