create_fieldplot_line#

PostProcessorIcepak.create_fieldplot_line(assignment, quantity, setup=None, intrinsics=None, plot_name=None, field_type='DC R/L Fields')#

Create a field plot of the line.

Parameters:

assignmentlist: List of polylines to plot.
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. Be 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.
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.
plot_namestr, optional: Name of the field plot to create.
field_typestr, optional: Field type to plot. Valid only for Q3D Field plots.

Returns:

type: Plot object.

References

>>> oModule.CreateFieldPlot

Examples

>>> from ansys.aedt.core import Hfss
>>> aedtapp = Hfss()
>>> # Intrinsics is provided as a dictionary.
>>> intrinsics = {"Freq": "5GHz", "Phase": "180deg"}
>>> min_value = aedtapp.post.get_scalar_field_value(quantity_name, "Minimum", setup_name, intrinsics=intrinsics)
>>> plot1 = aedtapp.post.create_fieldplot_line("Polyline1", quantity_name, setup_name, intrinsics=intrinsics)
>>> # Intrinsics is provided as a string. Phase is automatically assigned to 0deg.
>>> min_value = aedtapp.post.get_scalar_field_value(quantity_name, "Minimum", setup_name, intrinsics="5GHz")
>>> plot1 = aedtapp.post.create_fieldplot_line("Polyline1", quantity_name, setup_name, intrinsics="5GHz")
>>> # Intrinsics is provided as a dictionary. Phase is automatically assigned to 0deg.
>>> intrinsics = {"Freq": "5GHz"}
>>> min_value = aedtapp.post.get_scalar_field_value(quantity_name, "Minimum", setup_name, intrinsics=intrinsics)
>>> plot1 = aedtapp.post.create_fieldplot_line("Polyline1", quantity_name, setup_name, intrinsics=intrinsics)
>>> # Intrinsics is not provided and is computed from the setup.
>>> min_value = aedtapp.post.get_scalar_field_value(quantity_name, "Minimum", setup_name)
>>> plot1 = aedtapp.post.create_fieldplot_line("Polyline1", quantity_name, setup_name)