particle_tracks#

class ansys.fluent.core.solver.tui_231.main_menu.display.set.particle_tracks(path, service)#

Bases: TUIMenu

Enters the particle-tracks menu to set parameters for display of particle tracks.

Methods:

`arrow_scale`(args, *kwargs)	Sets the scale factor for arrows drawn on particle tracks.
`arrow_space`(args, *kwargs)	Sets the spacing factor for arrows drawn on particle tracks.
`coarsen_factor`(args, *kwargs)	Sets the coarsening factor for particle tracks.
`display`(args, *kwargs)	Determines whether particle tracks shall be displayed or only tracked.
`history_filename`(args, *kwargs)	Specifies the name of the particle history file.
`line_width`(args, *kwargs)	Sets the width for particle track.
`marker_size`(args, *kwargs)	Sets the size of markers used to represent particle tracks.
`particle_skip`(args, *kwargs)	Specifies how many particle tracks should be displayed.
`radius`(args, *kwargs)	Sets the radius for particle track (ribbon/cylinder only) cross-section.
`report_default_variables`(args, *kwargs)	Sets the report variables to default.
`report_to`(args, *kwargs)	Specifies the destination for the report (console, file, none).
`report_type`(args, *kwargs)	Sets the report type for particle tracks.
`report_variables`(args, *kwargs)	Sets the report variables.
`sphere_attrib`(args, *kwargs)	Specifies the size and number of slices to be used in drawing spheres.
`style`(args, *kwargs)	Sets the display style for particle track (line/ribbon/cylinder/sphere).
`track_single_particle_stream`(args, *kwargs)	Specifies the stream ID to be tracked.
`twist_factor`(args, *kwargs)	Sets the scale factor for twisting (ribbons only).

Classes:

`filter_settings`(path, service)	Set filter for particle display.
`sphere_settings`(path, service)	Provide sphere specific input.
`vector_settings`(path, service)	Set vector specific input.

arrow_scale(*args, **kwargs)#: Sets the scale factor for arrows drawn on particle tracks.

arrow_space(*args, **kwargs)#: Sets the spacing factor for arrows drawn on particle tracks.

coarsen_factor(*args, **kwargs)#: Sets the coarsening factor for particle tracks.

display(*args, **kwargs)#: Determines whether particle tracks shall be displayed or only tracked.

class filter_settings(path, service)#

Bases: TUIMenu

Set filter for particle display.

Methods:

`enable_filtering`(args, *kwargs)	Specifies whether particle display is filtered.
`filter_variable`(args, *kwargs)	Selects a variable used for filtering of particles.
`inside`(args, *kwargs)	Specifies whether filter variable must be inside min/max to be displayed (else outside min/max).
`maximum`(args, *kwargs)	Specifies the upper bound for the filter variable.
`minimum`(args, *kwargs)	Specifies the lower bound for the filter variable.

enable_filtering(*args, **kwargs)#: Specifies whether particle display is filtered.

filter_variable(*args, **kwargs)#: Selects a variable used for filtering of particles.

inside(*args, **kwargs)#: Specifies whether filter variable must be inside min/max to be displayed (else outside min/max).

maximum(*args, **kwargs)#: Specifies the upper bound for the filter variable.

minimum(*args, **kwargs)#: Specifies the lower bound for the filter variable.

history_filename(*args, **kwargs)#: Specifies the name of the particle history file.

line_width(*args, **kwargs)#: Sets the width for particle track.

marker_size(*args, **kwargs)#: Sets the size of markers used to represent particle tracks.

particle_skip(*args, **kwargs)#: Specifies how many particle tracks should be displayed.

radius(*args, **kwargs)#: Sets the radius for particle track (ribbon/cylinder only) cross-section.

report_default_variables(*args, **kwargs)#: Sets the report variables to default.

report_to(*args, **kwargs)#: Specifies the destination for the report (console, file, none).

report_type(*args, **kwargs)#: Sets the report type for particle tracks.

report_variables(*args, **kwargs)#: Sets the report variables.

sphere_attrib(*args, **kwargs)#: Specifies the size and number of slices to be used in drawing spheres.

class sphere_settings(path, service)#

Bases: TUIMenu

Provide sphere specific input.

Methods:

`auto_range`(args, *kwargs)	Specifies whether displayed spheres should include auto range of variable to size spheres.
`diameter`(args, *kwargs)	Diameter of the spheres whenvary-diameter is disabled.
`maximum`(args, *kwargs)	Sets the maximum value of the sphere to be displayed.
`minimum`(args, *kwargs)	Sets the minimum value of the sphere to be displayed.
`scale_factor`(args, *kwargs)	Specifies a scale factor to enlarge/reduce the size of spheres.
`size_variable`(args, *kwargs)	Selects a particle variable to size the spheres.
`smooth_parameter`(args, *kwargs)	Specifies number of slices to be used in drawing spheres.
`vary_diameter`(args, *kwargs)	Specifies whether the spheres can vary with another variable.

auto_range(*args, **kwargs)#: Specifies whether displayed spheres should include auto range of variable to size spheres.

diameter(*args, **kwargs)#: Diameter of the spheres whenvary-diameter is disabled.

maximum(*args, **kwargs)#: Sets the maximum value of the sphere to be displayed.

minimum(*args, **kwargs)#: Sets the minimum value of the sphere to be displayed.

scale_factor(*args, **kwargs)#: Specifies a scale factor to enlarge/reduce the size of spheres.

size_variable(*args, **kwargs)#: Selects a particle variable to size the spheres.

smooth_parameter(*args, **kwargs)#: Specifies number of slices to be used in drawing spheres.

vary_diameter(*args, **kwargs)#: Specifies whether the spheres can vary with another variable.

style(*args, **kwargs)#: Sets the display style for particle track (line/ribbon/cylinder/sphere).

track_single_particle_stream(*args, **kwargs)#: Specifies the stream ID to be tracked.

twist_factor(*args, **kwargs)#: Sets the scale factor for twisting (ribbons only).

class vector_settings(path, service)#

Bases: TUIMenu

Set vector specific input.

Methods:

`color_variable`(args, *kwargs)	Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color).
`constant_color`(args, *kwargs)	Specifies a constant color for the vectors.
`length_to_head_ratio`(args, *kwargs)	Specifies ratio of length to head for vectors and length to diameter for cylinders.
`length_variable`(args, *kwargs)	Specifies whether the displayed vectors have length varying with another variable.
`scale_factor`(args, *kwargs)	Specifies a scale factor to enlarge/reduce the length of vectors.
`style`(args, *kwargs)	Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder).
`vector_length`(args, *kwargs)	Specifies the length of constant vectors.
`vector_length_variable`(args, *kwargs)	Selects a particle variable to specify the length of vectors.
`vector_variable`(args, *kwargs)	Selects a particle vector function to specify vector direction.

color_variable(*args, **kwargs)#: Specifies whether the vectors should be colored by variable specified in /display/particle-track/particle-track (if false use a constant color).

constant_color(*args, **kwargs)#: Specifies a constant color for the vectors.

length_to_head_ratio(*args, **kwargs)#: Specifies ratio of length to head for vectors and length to diameter for cylinders.

length_variable(*args, **kwargs)#: Specifies whether the displayed vectors have length varying with another variable.

scale_factor(*args, **kwargs)#: Specifies a scale factor to enlarge/reduce the length of vectors.

style(*args, **kwargs)#: Enables and sets the display style for particle vectors (none/vector/centered-vector/centered-cylinder).

vector_length(*args, **kwargs)#: Specifies the length of constant vectors.

vector_length_variable(*args, **kwargs)#: Selects a particle variable to specify the length of vectors.

vector_variable(*args, **kwargs)#: Selects a particle vector function to specify vector direction.