plot_field_from_fieldplot

PostProcessor3DLayout.plot_field_from_fieldplot(plot_name: str, project_path: str = '', mesh_plot: bool = False, image_format: str = 'jpg', view: str = 'isometric', plot_label: str = 'Temperature', plot_folder: str = None, show: bool = True, scale_min: float = None, scale_max: float = None, plot_cad_objs: bool = True, log_scale: bool = True, dark_mode: bool = False, show_grid: bool = False, show_bounding: bool = False, show_legend: bool = True, plot_as_separate_objects: bool = True, file_format: str = 'case') → ModelPlotter

Export a field plot to an image file (JPG or PNG) using Python PyVista.

This method does not support streamlines plot.

Note

The PyVista module rebuilds the mesh and the overlap fields on the mesh.

Parameters:

plot_namestr

Name of the field plot to export.

project_pathstr, optional

Path for saving the image file. The default is "".

mesh_plotbool, optional

Whether to create and plot the mesh over the fields. The default is False.

image_formatstr, optional

Format of the image file. Options are "jpg", "png", "svg", and "webp". The default is "jpg".

viewstr, optional

View to export. Options are "isometric", "xy", "xz", "yz".

plot_labelstr, optional

Type of the plot. The default is "Temperature".

plot_folderstr, optional

Plot folder to update before exporting the field. The default is None, in which case all plot folders are updated.

showbool, optional

Export Image without plotting on UI.

scale_minfloat, optional

Fix the Scale Minimum value.

scale_maxfloat, optional

Fix the Scale Maximum value.

plot_cad_objsbool, optional

Whether to include objects in the plot. The default is True.

log_scalebool, optional

Whether to plot fields in log scale. The default is True.

dark_modebool, optional

Whether to display the model in dark mode or not. The default is False.

show_gridbool, optional

Whether to display the axes grid or not. The default is False.

show_boundingbool, optional

Whether to display the axes bounding box or not. The default is False.

show_legendbool, optional

Whether to display the legend. The default is True.

plot_as_separate_objectsbool, optional

Whether to plot each object separately, which can require more time to export from AEDT. The default is True.

file_formatstr, optional

File format to export the plot to. The default is "case". Options are ``"aedtplt" and "case". If the active design is a Q3D design, the file format is automatically set to "fldplt".

Returns:

ansys.aedt.core.generic.plot.ModelPlotter

Model Object.