plot_field

PostProcessorIcepak.plot_field(quantity, assignment, plot_type='Surface', setup=None, intrinsics=None, mesh_on_fields=False, view='isometric', plot_label=None, show=True, scale_min=None, scale_max=None, plot_cad_objs=True, log_scale=False, export_path='', image_format='jpg', keep_plot_after_generation=False, dark_mode=False, show_bounding=False, show_grid=False, show_legend=True, filter_objects=None, plot_as_separate_objects=True)

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

Note

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

Parameters:

quantitystr

Quantity to plot. For example, "Mag_E".

assignmentstr, list

One or more objects or faces to apply the field plot to.

plot_typestr, optional

Plot type. The default is Surface. Options are "CutPlane", "Surface", and "Volume".

setupstr, optional

Setup and sweep name on which create the field plot. Default is None for nominal setup usage.

intrinsicsdict, str, optional

Intrinsic variables required to compute the field before the export. These are typically: frequency, time and phase. It can be provided either as a dictionary or as a string. If it is a dictionary, keys depend on the solution type and can be expressed as:

• "Freq" or "Frequency".

• "Time".

• "Phase".

If it is a string, it can either be "Freq" or "Time" depending on the solution type. The default is None in which case the intrinsics value is automatically computed based on the setup.

mesh_on_fieldsbool, optional

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

viewstr, optional

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

plot_labelstr, optional

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

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 False.

export_pathstr, optional

Image export path. Default is None to not export the image.

image_formatstr, optional

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

keep_plot_after_generationbool, optional

Either to keep the Field Plot in AEDT after the generation is completed. Default is False.

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 or not. The default is True.

filter_objectslist, optional

Objects list for filtering the CutPlane plots.

plot_as_separate_objectsbool, optional

Plot each object separately. It may require more time to export from AEDT.

Returns:

ansys.aedt.core.visualization.plot.pyvista.ModelPlotter

Model Object.