StreamlineSurface
Create a streamline surface plot.
Syntax
model.result(<pgtag>).create(<ftag>,"StreamlineSurface");
model.result(<pgtag>).feature(<ftag>).selection(...);
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
 model.result(<pgtag>).create(<ftag>,"StreamlineSurface") creates a streamline surface plot feature named <ftag> belonging to the plot group <pgtag>.
This streamline plot visualize a vector quantity as streamlines on plane surfaces. A streamline is a curve everywhere tangent to an instantaneous vector field. Streamline surface plots are available in 3D plot groups.
The following properties are available:
Table 7-92: Valid Property/Value Pairs for Streamline Surface Plots
name
Value
Default
Description
back
on | off
on
Allow backward time integration. Only available for time-dependent data sets.
color
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
red
The uniform color to use.
const
String array of property/value pairs
Empty
Parameters to use in the expressions.
customcolor
RGB-triplet
{1,0,0} or last used color.
The uniform color to use. Active when color is set to custom.
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 array of length 2 in 2D and 3 in 3D
Model-dependent
The components to plot.
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, tube scale, and deformation scale are inherited from.
inherittubescale
Boolean
true
If inheritplot is not none and linetype is tube or ribbon: Determines if the tube or ribbon 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.
inttol
positive double
0.001 (2D), 0.01 (3D)
Integration tolerance.
linetype
line | tube
line
Plot streamlines as lines or tubes.
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.
looptol
positive double
0.01
Loop tolerance.
madv
manual | automatic
automatic
Whether to specify advanced parameters when positioning method is magnitude.
maxlen
positive double
Inf
The length of the streamlines as a fraction of the mean bounding box’s size.
maxsteps
positive integer
5000
The maximum number of integration steps.
maxtime
positive double
Inf
Maximum integration time.
mdensity
nonnegative integer
20
The density of the streamlines. Active when posmethod is set to magnitude.
minitref
positive integer
1
Boundary element refinement. Active when madv is set to manual.
normal
on | off
off
on when vector field should be normalized.
number
integer
20
Approximate number of streamlines. Active when startmethod is set to number.
outersolnum
nonnegative integer
1
The index of the outer solutions to use. Applicable only for parametric sweep models.
planecoordsys
cutplane | cartesian
cartesian
Coordinate system for streamline vectors. Only available for plots that use a cut plane data set that points to a 3D solution or mesh data set.
posmethod
magnitude | start | uniform
selection
The type of streamline positioning. Either start point controlled, uniform density, or magnitude controlled.
prefixintitle
String
Empty
Added prefix to contribution to title
radiusexpr
String
1
The tube radius.
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 data set, so the number of elements in the model can increase radically if the plot uses, for example, a revolve data set.
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.
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.
stattol
positive double
0.01
Stationary point stop tolerance.
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 | 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.
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.
uadv
manual | automatic
automatic
Whether to specify advanced parameters when positioning method is uniform.
udistend
nonnegative double
0.5
Terminating distance factor. Active when uadv is set to manual.
uignoredist
nonnegative double
0.5
Fraction of streamline length to ignore. Active when uadv is set to manual.
uinitref
positive integer
1
Boundary element refinement. Active when uadv is set to manual.
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.
usatfactor
nonnegative double
1.3
Starting distance factor. Active when uadv is set to manual.
Attributes
Color, Deform, Export, Filter
See Also
Particle, ParticleMass, Streamline