streamline_child

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

Bases: Group

‘child_object_type’ of streamline.

Attributes

Attribute	Summary
absolute_tolerance	Length to use as a maximum step tolerance.
add_sample_vertex_normals	‘add_sample_vertex_normals’ child.
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).
cross_periodics	If true allows a streamline to cross a periodic boundary.
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_streams	If false do not draw streams, but allow drawing of symbols.
draw_symbols	Draw symbols on the streams at specified times.
grid_tolerance	Fraction of local grid size to use as a maximum step tolerance.
instancing_transform	Defines the TRANSFORM object that is used for the object instancing.
lighting	Toggles the lighting of this graphics object in the viewer.
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.
location_list	A comma delimited list of locator names.
locator_sampling_method	Specifies point cloud sampling method on a surface.
max	The maximum value of a variable in the colour map when using a “User Specified” range.
maximum_number_of_items	‘maximum_number_of_items’ child.
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_samples	‘number_of_samples’ child.
number_of_sides	The number of sides of a ‘round’ tube.
random_seed	The seed to be used for a random number series.
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_number	This indicates whether to use ‘Reduction Factor’ to reduce the number of items, or to use ‘Maximum Number of Items’.
sample_spacing	A value between 0 and 1 relative to domain extents indicating number points in one direction for grid sampling.
sampling_accuracy	An indicator for points sampling accuracy.
sampling_aspect_ratio	Specifies spacing aspect ratio for grid sampling.
sampling_grid_angle	Specifies the rotation angle for a sampling grid.
seed_location_list	A comma delimited list of locator names.
seed_point_type	Specifies seed points used for Surface Streamlines.
simplify_geometry	Flag indicates if nodes would be ‘coarsened’ for surface streamline geometry.
specular_lighting	Toggles the specular lighting of this object in the viewer.
stream_drawing_mode	The streamline drawing mode.
stream_initial_direction	Defines the initial plane of a stream ribbon.
stream_size	The initial width of stream ribbons or tubes.
stream_symbol	Name of streamline symbol to be used for plot.
streamline_direction	The direction in which 3D streams are to be calculated.
streamline_maximum_periods	Limits the number of times a streamline may cross a periodic boundary.
streamline_maximum_segments	Stops streamline calculation when number of segments exceeds this.
streamline_maximum_time	Stops streamline calculation when particle age exceeds this.
streamline_periodic_time_interval	Time interval for streamline periodic time animation.
streamline_solver_type	The solver to use to calculate the streamlines.
streamline_type	Specifies the streamline type. Surface Streamlines are restricted to a surface location.
streamline_width	The width of the streamline.
surface_drawing	Sets the algorithm used to shade the faces for this graphics object.
surface_streamline_direction	The direction in which surface streams are to be calculated.
symbol_size	A scaling factor for all symbols in the plot.
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.
tolerance_mode	Whether Grid Tolerance or Absolute Tolerance are used.
transparency	Set between 0.0 (fully opaque) and 1.0 (fully transparent) to control the transparency of this graphics object in the viewer.
variable	The name of the variable used to create the object. Should be set equal to the name of a currently defined VARIABLE object.
variable_boundary_values	‘variable_boundary_values’ child.
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
streamline	‘streamline’ child.
internal_streamline	‘internal_streamline’ child.