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>.
Streamline plots 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:
on | off
equalarc | equaltime | equalinvtime
normalized | proportional | logarithmic
arrow | arrowhead | cone
on | off
custom | black | blue | cyan | gray | green | magenta | red | white | yellow
Parameters to use in the expressions as an N‑by‑3 matrix containing name, value, and description. Only parameters provided by the physics interfaces in the model can be set.
{1,0,0} or last used color
none | parent | dataset name
The description of the expression in expr. Is used in the automatic title.
on | off
on | off
linpoint | harmonic | lintotal | lintotalavg | lintotalrms | lintotalpeak
parent | manual
on | off
If inheritplot is not none: Determines if arrow scale is inherited.
If inheritplot is not none: Determines if the color is inherited.
If inheritplot is not none: Determines if the deformation scale is inherited.
If inheritplot is not none: Determines if the color and data ranges are inherited.
none | plot name
If inheritplot is not none: Determines if the transparency settings are inherited.
If inheritplot is not none and linetype is tube or ribbon: Determines if the tube or ribbon scale is inherited.
rk2 | rk4
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.
line | tube | none
If arrowlength is logarithmic: The ratio between the maximum arrow length and the arrow length below which no arrow is drawn.
The index of the solution to use, per level, or interp or last, but only for transient solutions. Available when data is not parent and the underlying data has multiple solutions.
manual | automatic
cutplane | cartesian
magnitude | start | uniform | selection
off | pprint | ppr
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.
norefine | coarse | normal | fine | finer | extrafine | custom
Controls the plot’s resolution, when evaluationsettings is set to manual. 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.
If posmethod is selection and selpointdistr is meshbased. The refinement of mesh-based point distribution on the selected edges.
If posmethod is selection and selpointdistr is uniform. The approximate number of streamlines placed on the selected edges.
uniform | selmagctrl | meshbased
If posmethod is selection: Use a uniform point distribution, a magnitude-controlled point distribution, or a mesh-based point distribution.
none | material | internal | everywhere | expression
Smoothing settings, when evaluationsettings is set to manual. 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.
The expression to use for smoothing when smooth is set to expression.
The index of the solution to use. Available when data is not parent and the underlying data has multiple solutions.
solnum | solutioninfo
manual | parent
If data is a local dataset with nontrivial data, specify solutions manually or take them from the parent plot group.
none | cut line name
Active when posmethod is start: The line where the starting points are distributed evenly.
number | coord
Active when posmethod is start. Indicates whether the starting points should be specified by number of points to distribute evenly or by coordinates.
The time to use, for transient problems. Available when data is not parent and the underlying data is transient.
manual | none
Threshold value (0–1), if threshold is set to manual.
on | off
on if t is used to determine time steps; off if solnum is used.
The title to use when titletype is manual.
auto | custom | label | manual | none
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.
on | off
manual | automatic
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.
Attributes
Color, Deform, Export, Filter (Plot Attribute), MaterialAppearance, Transformation, Transparency
Compatibility
When posmethod is set to magnitude, the mdist property has been removed from version 6.4. Likewise, when posmethod is set to uniform, the udist property has been removed from version 6.4. Use the magdensity and udensity properties instead.
When posmethod is set to magnitude, the mdensity property has been removed from version 6.1. Instead, use the mdist property.
See Also
Particle, ParticleMass, Streamline