Particle
Create a massless particle tracing plot.
Syntax
model.result(<pgtag>).create(<ftag>,"Particle");
model.result(<pgtag>).feature(<ftag>).set(property, <value>);
model.result(<pgtag>).feature(<ftag>).run();
Description
model.result(<pgtag>).create(<ftag>,"Particle") creates a massless particle tracing plot feature named <ftag> belonging to the plot group <pgtag>.
With massless particle tracing, you can visualize pathlines (that is, trajectories of particles released in a flow field), which can be time-dependent or static. For time-dependent flows you can also use a snapshot in time of the flow field as a static field. The motion of the particles does not affect the flow field. Particle tracing is available in 2D and 3D plot groups.
The following properties are available:
Active when pointtype is set to arrow. Determines the direction in which the arrow points.
The arrow scaling: Proportional uses the actual arrow length, normalized a unit length, and logarithmic a length proportional to the logarithm of the arrow length.
If arrowscalefactor is true: the length scale factor
If true, arrowscale is used; otherwise the scale factor is computed automatically.
arrow | arrowhead | cone
manual | automatic
Whether to specify a manual absolute tolerance for the position. automatic indicates that the absolute tolerance for the position is the mean of the lengths of the bounding box of the geometry multiplied by the relative tolerance.
number | coord
Active when posmethod is set to bnd. Available in 2D only.
Active when pointtype is set to comettail. Determines the direction in which the comet tail points.
none | parent | dataset name
The description of the expressions in expr. Is used in the automatic title.
on | off
once | freq | times
The maximum time step. Active when stepsize is set to manual.
The initial time step. Active when stepsize is set to manual.
If inheritplot is not none: Determines if the arrow scale 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 sphere scale is inherited.
If inheritplot is not none and linetype is tube: Determines if the tube 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.
custom | black | blue | cyan | gray | green |magenta | red | white | yellow
black (2D), red (3D)
none | line | tube
double > 1
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.
on | off
Whether to manually specify the maximum number of steps used in particle simulation. off indicates that the limit varies in this way: for static flow fields, the algorithm uses the value 1000; for time-dependent flows, there is no upper limit of the number of steps, and the particle simulation goes on until it reaches the end time.
custom | black | blue | cyan | gray | green |magenta | red | white | yellow
disappear | stick
stick plots the points on the boundary at the exit point, and disappear does not render these points at all.
on | off
on | off
none | point | comettail
start | bnd
coarser | coarse | normal | fine | finer | extrafine
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
Only affects time-dependent problems. When set to on, this property freezes the time and considers this a static flow field.
on | off
Whether to specify the end time for static flow fields automatically. (For time-dependent flows, the automatic end time is the last time that the time-dependent solver returns.) When set to off, there is no upper limit of the time. In this case, the particle simulation goes on until all particles exit the geometry or the simulation reaches the maximum number of steps.
automatic | manual
Whether to specify initial (hstart) and maximum (hmax) time step manually.
The time to use, for transient problems. Available when data is not parent and the underlying data is transient.
Active when pointtype is set to comettail and tailscaleactive is on. Specifies the manual scale factor with which the comet tail expression is multiplied.
on | off
Active when pointtype is set to comettail. Specifies whether manual tail scaling is enabled.
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.
Manual start time. Active when tstartactive is set to on.
on | off
on indicates a manual start time (set in the tstart property). Off indicates that the start time becomes either the first time value that the time-dependent solver returns or 0 for stationary flows. Available when dropmethod is set to once or freq.
on | off
on | off
Absolute coordinates in the z direction, active when posmethod is set to coord. Available in 3D only.
Attributes
Color (applies to lines), Deform
See Also
ParticleMass, Streamline