create_fieldplot_layers#

PostProcessorIcepak.create_fieldplot_layers(layers: list, quantity: str, setup: str = None, nets: list = None, plot_on_surface: bool = True, intrinsics: dict = None, name: str = None) → FieldPlot#

Create a field plot of stacked layer plot. This plot is valid from AEDT 2023 R2 and later in HFSS 3D Layout. Nets can be used as a filter. Dielectrics will be included into the plot. It works when a layout components in 3d modeler is used.

Parameters:
layerslist

List of layers to plot. For example: ["Layer1","Layer2"]. If empty list is provided all layers are considered.

quantitystr

Name of the quantity to plot.

setupstr, optional

Name of the setup. The default is None, in which case the nominal_adaptive setup is used. Make sure to build a setup string in the form of "SetupName : SetupSweep", where SetupSweep is the sweep name to use in the export or LastAdaptive.

netslist, optional

List of nets to filter the field plot. Optional.

plot_on_surfacebool, optional

Whether if the plot has to be on surfaces or inside the objects. It is applicable only to layout components. Default is True.

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 in lower or camel case 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.

namestr, optional

Name of the field plot to create.

Returns:
:class:ansys.aedt.core.modules.solutions.FieldPlot or bool

Plot object.

References

>>> oModule.CreateFieldPlot