particle_track_child

class ansys.cfx.core.generated.post_processing.settings_261.particle_track_child.particle_track_child(name: str | None = None, parent=None)

Bases: Group

‘child_object_type’ of particle_track.

Attributes

Attribute	Summary
activate_filter	A Logical field indicating whether to use the filter to select which tracks to display.
any_all_condition	The way the Filtering conditions should be combined. ‘Any’ means that all tracks that meet any of the conditions will be displayed. ‘All’ means that only the tracks that meet all of the conditions will be displayed.
apply_instancing_transform	Toggles the instancing transformation for this graphics object in the viewer.
colour	A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used when colouring the faces of an object by constant colour.
colour_map	The name of the colour map to use when colouring the object.
colour_mode	Sets the mode used to colour the object. If set equal to “Constant” then the “Colour” parameter is used to determine the plot colour. If set equal to “Variable”, then the “Colour Variable” parameter is used.
colour_scale	Sets whether to colour the object with a Linear or Logarithmic scale. By default, the colour scale is Linear.
colour_variable	The name of the variable to be used in colouring the object. Should be set equal to the name of a currently defined VARIABLE object.
colour_variable_boundary_values	Sets the type of boundary values to be presented for colour variables in this object (Conservative or Hybrid).
culling_mode	Controls the face culling of this object in the viewer.
domain_list	The list of domains over which to define this object.
draw_contours	Enables/disables drawing of the contour lines.
draw_faces	Toggles the visibility filled faces for this graphics object in the viewer.
draw_lines	Toggles the visibility of lines around each face of this graphics object.
draw_symbols	Draw symbols on the streams at specified times.
draw_tracks	If false do not draw tracks, but allow drawing of symbols.
ending_boundary	A list of Boundary names to filter particle tracks that end on the specified boundaries.
filter_on_diameter	A Logical field indicating whether to use Particle Diameter when filtering.
filter_on_end	A Logical field indicating whether to use the Ending Boundary when filtering.
filter_on_start	A Logical field indicating whether to use the Starting Boundary when filtering.
filter_on_track_selection	A Logical field indicating whether to use the Track Selection when filtering.
font	The font name for an item of text.
injection_filter	Contains a list of the Injection names that should be filtered for in this FLUENT Particle Track object.
injection_filter_list	Internal Parameter listing all available injections for FLUENT Particle Tracks.
injection_id_list	Contains a list of the Injection IDs associated with this FLUENT particle track object.
input_file	The name of the file to be read that contains the definition of one or more polylines or user surfaces and associated path variables.
instancing_transform	Defines the TRANSFORM object that is used for the object instancing.
lighting	Toggles the lighting of this graphics object in the viewer.
limit_track_option	Specifies how the tracks should be limited.
line_colour	A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used for colouring the lines on a graphics object.
line_width	Controls the width (in pixels) of lines drawn for this graphics object.
max	The maximum value of a variable in the colour map when using a “User Specified” range.
maximum_number_of_tracks	Specifies the maximum number of tracks that should be displayed. This parameter is mutually exclusive with the Reduction Factor Parameter.
min	The minimum value of a variable in the colour map when using a “User Specified” range.
number_of_contours	Specifies number of contour lines in a contour plot.
number_of_sides	The number of sides of a ‘round’ tube.
option	‘option’ child.
particle_diameter	The Particle Diameter to use in filtering tracks.
particle_diameter_condition	The condition to test for when filtering with Particle Diameter. The values with their equivalent meanings are: gt (>), gte (>=), lt (<), lte (<=), eq (==).
particle_diameter_condition_two	The condition to test for when filtering with Particle Diameter. The values with their equivalent meanings are: gt (>), gte (>=), lt (<), lte (<=), eq (==). If this parameter is set to NA, then this parameter is not applicable, and can be ignored.
particle_diameter_two	The Particle Diameter to use in filtering tracks.
range	Sets the method used to calculate the extents of the colour map on an object. “Global” uses the range of values in the problem domain. “Local” uses the range of values on the current object.
reduction_factor	Reduces the number of items that should be displayed for a particular locator.
reduction_or_max_tracks	This indicates whether to use ‘Reduction Factor’ to reduce the number of tracks, or to use ‘Maximum Number of Tracks’.
show_track_labels	Indicates whether or not to show the track number labels.
size_range_factor	Specifies the scaling factor for particle symbol.
specular_lighting	Toggles the specular lighting of this object in the viewer.
starting_boundary	A list of Boundary names to filter particle tracks that start on the specified boundaries.
surface_drawing	Sets the algorithm used to shade the faces for this graphics object.
symbol_max_time_selection	Indicates how to determine the ‘Symbol Start Time’, either allow the user to set the parameter, or use the current time.
symbol_scale_type	Indicates whether to scale the parameters in a relative or absolute manner.
symbol_size	A scaling factor for all symbols in the plot.
symbol_size_option	Use this parameter to change how the the size of the particle track symbols is determined.
symbol_start_time	The particle age at which to draw the first symbol.
symbol_stop_time	Draw no symbols with particle age lower than this.
symbol_time_interval	Draw symbols at regular times separated by this value.
text_colour	A list of three numbers between 0 and 1, which represent the RGB (Red/Green/Blue) values to be used when colouring the text.
text_colour_mode	Determines where to get the text colour from.
text_height	The height an item of text should be, proportional to the screen.
track_drawing_mode	The streamline drawing mode.
track_end_distance	The particle travelling distance at which to stop drawing the track.
track_end_time	The particle age at which to stop drawing the track.
track_file_type	The type of file to read the particle tracks from. This is only available if the Particle Track Option is ‘From File’. Currently supports CFX4 and FLUENT PT files.
track_initial_direction	Defines the initial plane of a stream ribbon.
track_limit_type	Indicates whether to limit the portion of the track to be displayed by time or by distance.
track_line_width	The width of the streamline.
track_material	Specifies the material of the track for this object.
track_selection	A string list containing a subset of track numbers to select the tracks to display.
track_size	The initial width of stream ribbons or tubes.
track_start_distance	The particle travelling distance at which to start drawing the track.
track_start_time	The particle age at which to start drawing the track.
track_symbol	Name of streamline symbol to be used for plot.
transparency	Set between 0.0 (fully opaque) and 1.0 (fully transparent) to control the transparency of this graphics object in the viewer.
visibility	Toggles the visibility of this graphics object in the viewer. THIS PARAMETER IS DEPRECATED!.
object_view_transform	This object contains object transformation info to be processed by the viewer. Like instance transform, this object should be associated with each geometry. It is usually specified as a sub-object.

Methods

Method	Summary
hide	Hide the object in a given view(s).
show	Show the object in a given view(s).
suspend	Suspend immediate update for the object.
unsuspend	Restore immediate update for the object.

Included in:

Parent	Summary
particle_track	‘particle_track’ child.