Pellets
Create a pellets plot in 2D and 3D plot groups.
Syntax
model.result(<pgtag>).create(<ftag>,"Pellets");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Pellets") creates a plot feature named <ftag> belonging to the plot group <pgtag>.
You can use pellets plots in 3D models to visualize the flow of pellets and similar objects.
Table 7-99: Valid Property/Value Pairs for Pellets Plots
Property
Value
Default
Description
axis
x | y | z
y
The main axis for pellet spheres, if type is sphere.
bottomcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
black
The bottom color to use for a color gradient. Active when coloring is gradient.
color
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The uniform color to use. Active when coloring is uniform.
coloring
colortable | uniform | gradient
colortable
How to color the surface: using a color table, a uniform color, or a color gradient.
colorlegend
on | off
on
Whether to show color legend, when coloring is set to colortable.
colorscalemode
linear | linearsymmetric | logarithmic
linear
Scaling of the color table: linear, linear symmetric around 0, or logarithmic, when coloring is set to colortable or gradient.
colortable
color table name
Rainbow
The color table to use when coloring is set to colortable. 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.
custombottomcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when bottomcolor is set to custom.
customcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when color is set to custom.
customtopcolor
RGB-triplet
{1,0,0} or last used color
The uniform color to use. Active when topcolor is set to custom.
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
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.
inheritdeformscale
Boolean
true
If inheritplot is not none: Determines if the deformation scale is inherited.
inheritplot
none | plot name
none
The plot that color, color range, height scale, and deformation scale are inherited from.
inheritrange
Boolean
true
If inheritplot is not none: Determines if the color and data ranges are inherited.
inherittransparency
Boolean
true
If inheritplot is not none: Determines if the transparency settings are 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.
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.
rangecoloractive
on | off
off
Whether to use the manual color range specified in rangecolormin and rangecolormax. The color range specifies the minimum and maxim value in the plotted colors. Default is the minimum and maximum data values.
rangecolormax
double
Plot dependent
The maximum color range value. Active when rangecoloractive is on.
rangecolormin
double
Plot dependent
The minimum color range value. Active when rangecoloractive is on.
rangedatactive
on | off
off
Whether to use the manual data range specified in rangedatamin and rangedatamax. Values outside the data range is not plotted.
rangedatamax
double
Plot dependent
The maximum data value. Active when rangedataactive is on.
rangedatamin
double
Plot dependent
The minimum data value. Active when rangedataactive is on.
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.
revangle
double
240
The revolution angle (in degrees) for pellet spheres, if type is sphere.
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.
solutionparams
manual | parent
manual
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
startangle
double
210
The start angle (in degrees) for the revolution of pellet spheres, if type is sphere.
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 | 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.
topcolor
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
white
The top color to use for a color gradient. Active when coloring is gradient.
type
sphere | slice
sphere
The type of pellet: sphere or slices (three orthogonal filled circles).
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.
Attributes
Deform, Translation, Transparency (3D only)
See Also
Particle