PhasePortrait
Create a phase portrait plot.
Syntax
model.result(<pgtag>).create(<ftag>,"PhasePortrait");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"PhasePortrait") creates a plot feature named <ftag> belonging to the plot group <pgtag>.
You can use phase portraits in 2D and 2D axisymmetric models to visualize large datasets of particle trajectories.
The following properties are available:
Table 7-79: Valid Property/Value Pairs for Phase Portrait
name
Value
Default
Description
data
none | parent | dataset name
parent
The dataset this feature refers to.
descriptionintitle
on | off
on
Whether the title contribution should contain the description when titletype is custom.
fixedpointsize
Boolean
false
Use constant radii for the plotted spheres.
inheritcolor
Boolean
true
If inheritplot is not none: Determines if the color is inherited. Available in 2D and 3D.
inheritrange
Boolean
true
If inheritplot is not none: Determines if the color and data ranges are inherited.
inheritspherescale
Boolean
true
If inheritplot is not none: Determines if the radius scale factor is inherited.
innerinput
all | first | last | manual | manualindices | interp
all
How to input the solution to use. manual indicates that solnum is used. manualindices indicates that solnumindices is used. interp indicates that t is used.
interp
double row matrix
Empty on all levels.
The times to use, for transient levels. Available when data is not parent and the underlying data is transient.
looplevel
integer row matrix
all on all levels
The solutions to use, per level.
looplevelindices
integer row matrix
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when looplevelinput is manualindices on a level.
looplevelinput
String array with all | first | last | manual | manualindices | interp on each level
all on all levels
How to input the solution to use, per level. manual on a level indicates that looplevel is used on that level. manualindices on a level indicates that looplevelindices is used on that level. interp on a level indicates that interp is used on that level.
outerinput
all | first | last | manual | manualindices
all
How to input the outer solutions to use. Applicable only for parametric sweep models. manual indicates that outersolnum is used. manualindices indicates that outersolnumindices is used.
outersolnum
nonnegative integer array
1
The index of the outer solutions to use. Applicable only for parametric sweep models. Since the various outer solutions can have different number of solnum, the solnum property is not used.
outersolnumindices
String or integer array
Empty
An alternative way to specify the outer solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when outerinput is manualindices.
prefixintitle
String
Empty
Added prefix to contribution to title.
pointcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The uniform color to use for points.
pointradiusexpr
String
1
The point radius expression.
solnum
nonnegative integer array
All solutions
The solutions to plot. Available when data is not parent and the underlying data has multiple solutions.
solnumindices
String or integer array
Empty
An alternative way to specify the solutions to use, allowing you to enter, for example, range(1,1,20). Applicable when innerinput is manualindices.
solrepresentation
solnum | solutioninfo
solutioninfo
Indicates which method of selecting solutions is active.
sphereradiusscale
positive double
 
The scale factor applied to the point radii if sphereradiusscaleactive is on.
sphereradiusscaleactive
Boolean
false
If true, sphereradiusscale is used; otherwise the scale factor is computed automatically.
suffixintitle
String
Empty
Added suffix to contribution to title
t
double array
Empty
The times to plot. Available when data is not parent and the underlying solution is transient.
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.
unitintitle
on | off
on
Whether the title contribution should contain the unit when titletype is custom
xdata
position | manual
position
Whether to use the particle position or user-defined x-axis data.
xmanual
String
Empty
User-defined x-axis data used if xdata is set to manual.
ydata
position | manual
position
Whether to use the particle position or user-defined y-axis data.
ymanual
String
Empty
User-defined y-axis data used if ydata is set to manual.
Attributes
Color