Streamline
Create a streamline plot.
Syntax
model.result(<pgtag>).create(<ftag>,"Streamline");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Streamline") creates a streamline plot feature named <ftag> belonging to the plot group <pgtag>.
Streamlines visualize a vector quantity on domains. A streamline is a curve everywhere tangent to an instantaneous vector field. Streamlines are available in 2D and 3D plot groups.
The following properties are available:
The number of arrows, if pointtype is arrow and arrowcountactive is on.
on | off
equalarc | equaltime | equalinvtime
normalized | proportional | logarithmic
arrow | arrowhead | cone
on | off
custom | black | blue | cyan | fromtheme | gray | green | magenta | red | white | yellow
black (2D), red (3D)
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
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.
none | plot name
If inheritplot is not none: Determines if the color and data ranges are inherited.
If inheritplot is not none: Determines if the ribbon scale is inherited.
If inheritplot is not none and linetype is tube or ribbon: Determines if the tube or ribbon scale is inherited.
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 | ribbon | none
The local time for the streamline time integration, if pointtype is interactivearrow or interactivepoint.
Extra release times of arrows or points, if pointtype is interactivearrow or interactivepoint.
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, but only for transient solutions. Available when data is not parent and the underlying data has multiple solutions.
manual | automatic
The density of the streamlines. Active when posmethod is set to magnitude. Only available in 2D.
Starting distance factor. Active when madv is set to manual. Only available in 3D.
on | off
on | off
on when vector field should be normalized.
cutplane | cartesian
Point radius expression, if pointtype is interactivepoint.
none | arrow | interactivearrow | interactivepoint
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
cylindrical | cartesian
If posmethod is selection and selpointdistr is meshbased. The refinement of mesh-based point distribution on the selected edges (2D) or surfaces (3D).
If posmethod is selection and selpointdistr is uniform. The approximate number of streamlines placed on the selected edges (2D) or surfaces (3D).
uniform | meshbased
If posmethod is selection: Use a uniform point distribution or a mesh-based point distribution.
none | material | internal | everywhere | expression
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.
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.
on | off
If on, sphereradiusscale is used; otherwise the scale factor is computed automatically. Available if pointtype is interactivepoint.
none | cut line or cut plane name
Active when posmethod is start: The line or plane 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.
on | off
If true, widthscale is used; otherwise, the scale factor is computed automatically.
Absolute coordinates in the z direction, active when startmethod is set to coord. Available in 3D only.
Attributes
Color, Deform, Export, Filter (Plot Attribute), MaterialAppearance, Selection, Translation, Transparency (3D only)
Compatibility
The linearrowtype property in previous versions of COMSOL Multiphysics has been replaced and extended by pointtype in version 5.5.
See Also
Particle, ParticleMass, StreamlineSurface