PostProcessor3D#

class ansys.aedt.core.visualization.post.post_common_3d.PostProcessor3D(app)[source]#

Manages the main AEDT postprocessing functions.

The inherited AEDTConfig class contains all _desktop hierarchical calls needed for the class initialization data _desktop and the design types "HFSS", "Icepak", and "HFSS3DLayout".

Note

Some functionalities are available only when AEDT is running in the graphical mode.

Parameters:
appansys.aedt.core.application.analysis_3d.FieldAnalysis3D

Inherited parent object. The parent object must provide the members _modeler, _desktop, _odesign, and logger.

Examples

Basic usage demonstrated with an HFSS, Maxwell, or any other design:

>>> from ansys.aedt.core import Hfss
>>> hfss = Hfss()
>>> post = hfss.post

Methods

PostProcessor3D.animate_fields_from_aedtplt(...)

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

PostProcessor3D.available_display_types([...])

Retrieve display types for a report categories.

PostProcessor3D.available_quantities_categories([...])

Compute the list of all available report categories.

PostProcessor3D.available_report_quantities([...])

Compute the list of all available report quantities of a given report quantity category.

PostProcessor3D.available_report_solutions([...])

Get the list of available solutions that can be used for the reports.

PostProcessor3D.change_field_property(...)

Modify a field plot property.

PostProcessor3D.copy_report_data(plot_name)

Copy report data as static data.

PostProcessor3D.create_3d_plot(solution_data)

Create a 3D plot using Matplotlib.

PostProcessor3D.create_creeping_plane_visual_ray_tracing([...])

Create a Creeping Wave Plane Wave Visual Ray Tracing and return the class object.

PostProcessor3D.create_creeping_point_visual_ray_tracing([...])

Create a Creeping Wave Point Source Visual Ray Tracing and return the class object.

PostProcessor3D.create_fieldplot_cutplane(...)

Create a field plot of cut planes.

PostProcessor3D.create_fieldplot_layers(...)

Create a field plot of stacked layer plot.

PostProcessor3D.create_fieldplot_layers_nets(...)

Create a field plot of stacked layer plot.

PostProcessor3D.create_fieldplot_line(...[, ...])

Create a field plot of the line.

PostProcessor3D.create_fieldplot_line_traces(...)

Create a field plot of the line.

PostProcessor3D.create_fieldplot_surface(...)

Create a field plot of surfaces.

PostProcessor3D.create_fieldplot_volume(...)

Create a field plot of volumes.

PostProcessor3D.create_report([expressions, ...])

Create a report in AEDT.

PostProcessor3D.create_report_from_configuration([...])

Create a report based on a JSON file, TOML file, RPT file, or dictionary of properties.

PostProcessor3D.create_sbr_plane_visual_ray_tracing([...])

Create an SBR Plane Wave Visual Ray Tracing and return the class object.

PostProcessor3D.create_sbr_point_visual_ray_tracing([...])

Create an SBR Point Source Visual Ray Tracing and return the class object.

PostProcessor3D.delete_field_plot(name)

Delete a field plot.

PostProcessor3D.delete_report([plot_name])

Delete all reports or specific report.

PostProcessor3D.export_field_file(quantity)

Use the field calculator to create a field file based on a solution and variation.

PostProcessor3D.export_field_file_on_grid(...)

Use the field calculator to create a field file on a grid based on a solution and variation.

PostProcessor3D.export_field_jpg(file_name, ...)

Export a field plot and coordinate system to a JPG file.

PostProcessor3D.export_field_plot(plot_name, ...)

Export a field plot.

PostProcessor3D.export_mesh_obj([setup, ...])

Export the mesh in AEDTPLT format.

PostProcessor3D.export_model_obj([...])

Export the model.

PostProcessor3D.export_model_picture([...])

Export a snapshot of the model to a JPG file.

PostProcessor3D.export_report_to_csv(...[, ...])

Export the 2D Plot data to a CSV file.

PostProcessor3D.export_report_to_file(...[, ...])

Export a 2D Plot data to a file.

PostProcessor3D.export_report_to_jpg(...[, ...])

Export plot to an image file.

PostProcessor3D.get_all_report_quantities([...])

Return all the possible report categories organized by report types, solution and categories.

PostProcessor3D.get_efields_data([...])

Compute Etheta and EPhi.

PostProcessor3D.get_far_field_data([...])

Generate far field data using the GetSolutionDataPerVariation() method.

PostProcessor3D.get_model_plotter_geometries([...])

Initialize the Model Plotter object with actual modeler objects and return it.

PostProcessor3D.get_scalar_field_value(quantity)

Use the field calculator to Compute Scalar of a Field.

PostProcessor3D.get_solution_data([...])

Get a simulation result from a solved setup and cast it in a SolutionData object.

PostProcessor3D.get_solution_data_per_variation([...])

Retrieve solution data for each variation.

PostProcessor3D.nb_display([show_axis, ...])

Show the Jupyter Notebook display.

PostProcessor3D.paste_report_data()

Paste report data as static data.

PostProcessor3D.plot_animated_field(...[, ...])

Create an animated field plot using Python PyVista and export to a gif file.

PostProcessor3D.plot_field(quantity, assignment)

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

PostProcessor3D.plot_field_from_fieldplot(...)

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

PostProcessor3D.plot_model_obj([objects, ...])

Plot the model or a substet of objects.

PostProcessor3D.plot_scene(frames, gif_path)

Plot the current model 3D scene with overlapping animation coming from a file list and save the gif.

PostProcessor3D.power_budget([units, ...])

Power budget calculation.

PostProcessor3D.rename_report(plot_name, ...)

Rename a plot.

PostProcessor3D.set_tuning_offset(setup, offsets)

Set derivative variable to a specific offset value.

PostProcessor3D.steal_focus_oneditor()

Remove the selection of an object that would prevent the image from exporting correctly.

PostProcessor3D.volumetric_loss(assignment)

Use the field calculator to create a variable for volumetric losses.

Attributes

PostProcessor3D.all_report_names

List of all report names.

PostProcessor3D.available_report_types

Report types.

PostProcessor3D.logger

Logger.

PostProcessor3D.model_units

Model units.

PostProcessor3D.modeler

Modeler.

PostProcessor3D.ofieldsreporter

Fields reporter.

PostProcessor3D.oreportsetup

Report setup.

PostProcessor3D.post_osolution

Solution.

PostProcessor3D.post_solution_type

Design solution type.

PostProcessor3D.update_report_dynamically

Get/Set the boolean to automatically update reports on edits.
On this page
Edit on GitHub
Show Source