Vector

class ansys.fluent.visualization.pyvista.pyvista_objects.Vector(name, parent, api_helper)

Provides for displaying vector graphics.

Parameters:

name

parent

api_helper

.. code-block:: python

from ansys.fluent.visualization.pyvista import Graphics

graphics_session = Graphics(session) vector1 = graphics_session.Vectors[“vector-1”] vector1.surfaces_list = [‘symmetry’] vector1.scale = 4.0 vector1.skip = 4 vector1.display(“window-0”)

Attributes

Member	Summary
field	Vector color field.
field.allowed_values	field allowed values.
range	Range definition.
scale	Vector scale.
show_edges	Show edges.
skip	Vector skip.
surfaces_list	List of surfaces for vector graphics.
surfaces_list.allowed_values	surfaces_list allowed values.
vectors_of	Vector type.
vectors_of.allowed_values	vectors_of allowed values.

Commands

Command	Summary
display	Display graphics.
get_ancestors_by_name
get_ancestors_by_type
get_path
get_root
get_session
get_session_handle

ansys.fluent.core.post_objects.post_object_definitions.VectorDefn.range

Attributes

Member	Summary
auto_range_off	Auto range off definition.
auto_range_on	Auto range on definition.
option	Range option.
option.allowed_values	option allowed values.

Commands

Command	Summary
get_ancestors_by_name
get_ancestors_by_type
get_path
get_root
get_session
get_session_handle

Included in

Parent	Summary
Vector	Vector’s child

ansys.fluent.core.post_objects.post_object_definitions.VectorDefn.range.auto_range_off

Attributes

Member	Summary
clip_to_range	Clip vector within range.
maximum	Range maximum.
minimum	Range minimum.

Commands

Command	Summary
get_ancestors_by_name
get_ancestors_by_type
get_path
get_root
get_session
get_session_handle

Included in

Parent	Summary
range	range’s child

ansys.fluent.core.post_objects.post_object_definitions.VectorDefn.range.auto_range_on

Attributes

Member	Summary
global_range	Show global range.

Commands

Command	Summary
get_ancestors_by_name
get_ancestors_by_type
get_path
get_root
get_session
get_session_handle

Included in

Parent	Summary
range	range’s child