post_objects_container

Module providing visualization objects to facilitate integration with libraries like Matplotlib and pyvista.

Classes:

Container(session, container_type, module, ...)	Base class for containers, for example, Plots, Graphics.
Graphics(session, module, post_api_helper[, ...])	Provides the pyvista Graphics objects manager.
Plots(session, module, post_api_helper[, ...])	Provides the Matplotlib Plots objects manager.

class ansys.fluent.core.post_objects.post_objects_container.Container(session, container_type, module, post_api_helper, local_surfaces_provider=None)

Bases: object

Base class for containers, for example, Plots, Graphics.

Parameters:

sessionobject

Session object.

container_type: object

Container type (for example, Plots, Graphics)

module: object

Python module containing post definitions

post_api_helper: object

Provides helper APIs for post-processing

local_surfaces_providerobject, optional

Object providing local surfaces so that user can access surfaces created in other modules, such as PyVista. The default is None.

Methods:

__init__(session, container_type, module, ...)	__init__ method of Container class.
get_path()	Get container path.
update(value)	Update the value.

Attributes:

type

Type.

__init__(session, container_type, module, post_api_helper, local_surfaces_provider=None)

__init__ method of Container class.

get_path()

Get container path.

property type

Type.

update(value)

Update the value.

class ansys.fluent.core.post_objects.post_objects_container.Graphics(session, module, post_api_helper, local_surfaces_provider=None)

Bases: Container

Provides the pyvista Graphics objects manager.

This class provides access to Graphics object containers for a given session so that graphics objects can be created.

Parameters:

sessionobj

Session object.

module: object

Python module containing post definitions

post_api_helper: object

Provides helper APIs for post-processing

local_surfaces_providerobject, optional

Object providing local surfaces so that you can access surfaces created in other modules, such as pyvista. The default is None.

Attributes:

Meshesdict

Container for mesh objects.

Surfacesdict

Container for surface objects.

Contoursdict

Container for contour objects.

Vectorsdict

Container for vector objects.

Methods:

__init__(session, module, post_api_helper[, ...])	__init__ method of Graphics class.
add_outline_mesh()	Add a mesh outline.

__init__(session, module, post_api_helper, local_surfaces_provider=None)

__init__ method of Graphics class.

add_outline_mesh()

Add a mesh outline.

Parameters:

None

Returns:

None

class ansys.fluent.core.post_objects.post_objects_container.Plots(session, module, post_api_helper, local_surfaces_provider=None)

Bases: Container

Provides the Matplotlib Plots objects manager.

This class provides access to Plots object containers for a given session so that plots can be created.

Parameters:

sessionobj

Session object.

module: object

Python module containing post definitions

post_api_helper: object

Provides helper APIs for post-processing

local_surfaces_providerobject, optional

Object providing local surfaces so that you can access surfaces created in other modules, such as pyvista. The default is None.

Attributes:

XYPlotsdict

Container for XY plot objects.

MonitorPlotsdict

Container for monitor plot objects.

Methods:

__init__(session, module, post_api_helper[, ...])

__init__ method of Plots class.

__init__(session, module, post_api_helper, local_surfaces_provider=None)

__init__ method of Plots class.