create_report#
- PostProcessor3D.create_report(expressions=None, setup_sweep_name=None, domain='Sweep', variations=None, primary_sweep_variable=None, secondary_sweep_variable=None, report_category=None, plot_type='Rectangular Plot', context=None, subdesign_id=None, polyline_points=1001, plot_name=None)#
Create a report in AEDT. It can be a 2D plot, 3D plot, polar plot, or a data table.
- Parameters:
- expressions
str
orlist
,optional
One or more formulas to add to the report. Example is value =
"dB(S(1,1))"
.- setup_sweep_name
str
,optional
Setup name with the sweep. The default is
""
.- domain
str
,optional
Plot Domain. Options are “Sweep”, “Time”, “DCIR”.
- variations
dict
,optional
Dictionary of all families including the primary sweep. The default is
{"Freq": ["All"]}
.- primary_sweep_variable
str
,optional
Name of the primary sweep. The default is
"Freq"
.- secondary_sweep_variable
str
,optional
Name of the secondary sweep variable in 3D Plots.
- report_category
str
,optional
Category of the Report to be created. If None default data Report is used. The Report Category can be one of the types available for creating a report depend on the simulation setup. For example for a Far Field Plot in HFSS the UI shows the report category as “Create Far Fields Report”. The report category is “Far Fields” in this case. Depending on the setup different categories are available. If
None
default category is used (the first item in the Results drop down menu in AEDT).- plot_type
str
,optional
The format of Data Visualization. Default is
Rectangular Plot
.- context
str
,dict
,optional
The default is
None
. - For HFSS 3D Layout, options are"Bondwires"
,"Differential Pairs"
,None
,"Probes"
,"RL"
,"Sources"
, and"Vias"
. - For Q2D or Q3D, specify the name of a reduced matrix. - For a far fields plot, specify the name of an infinite sphere. - For Maxwell 2D/3D Eddy Current solution types this can be provided as a dictionary where the key is the matrix name and value the reduced matrix.- plot_name
str
,optional
Name of the plot. The default is
None
.- polyline_points
int
, optional, Number of points to create the report for plots on polylines on.
- subdesign_id
int
,optional
Specify a subdesign ID to export a Touchstone file of this subdesign. Valid for Circuit Only. The default value is
None
.
- expressions
- Returns:
ansys.aedt.core.modules.report_templates.Standard
True
when successful,False
when failed.
References
>>> oModule.CreateReport
Examples
>>> from ansys.aedt.core import Hfss >>> hfss = Hfss() >>> hfss.post.create_report("dB(S(1,1))") >>> variations = hfss.available_variations.nominal_w_values_dict >>> variations["Theta"] = ["All"] >>> variations["Phi"] = ["All"] >>> variations["Freq"] = ["30GHz"] >>> hfss.post.create_report(expressions="db(GainTotal)", ... setup_sweep_name=hfss.nominal_adaptive, ... variations=variations, ... primary_sweep_variable="Phi", ... secondary_sweep_variable="Theta", ... report_category="Far Fields", ... plot_type="3D Polar Plot", ... context="3D") >>> hfss.post.create_report("S(1,1)",hfss.nominal_sweep,variations=variations,plot_type="Smith Chart") >>> hfss.release_desktop(False, False)
>>> from ansys.aedt.core import Maxwell2d >>> m2d = Maxwell2d() >>> m2d.post.create_report(expressions="InputCurrent(PHA)", ... domain="Time", ... primary_sweep_variable="Time", ... plot_name="Winding Plot 1") >>> m2d.release_desktop(False, False)
>>> from ansys.aedt.core import Maxwell3d >>> m3d = Maxwell3d(solution_type="EddyCurrent") >>> rectangle1 = m3d.modeler.create_rectangle(0, [0.5, 1.5, 0], [2.5, 5], name="Sheet1") >>> rectangle2 = m3d.modeler.create_rectangle(0, [9, 1.5, 0], [2.5, 5], name="Sheet2") >>> rectangle3 = m3d.modeler.create_rectangle(0, [16.5, 1.5, 0], [2.5, 5], name="Sheet3") >>> m3d.assign_current(rectangle1.faces[0], amplitude=1, name="Cur1") >>> m3d.assign_current(rectangle2.faces[0], amplitude=1, name="Cur2") >>> m3d.assign_current(rectangle3.faces[0], amplitude=1, name="Cur3") >>> L = m3d.assign_matrix(assignment=["Cur1", "Cur2", "Cur3"], matrix_name="Matrix1") >>> out = L.join_series(sources=["Cur1", "Cur2"], matrix_name="ReducedMatrix1") >>> expressions = m3d.post.available_report_quantities(report_category="EddyCurrent", ... display_type="Data Table", ... context={"Matrix1": "ReducedMatrix1"}) >>> report = m3d.post.create_report( ... expressions=expressions, ... context={"Matrix1": "ReducedMatrix1"}, ... plot_type="Data Table", ... plot_name="reduced_matrix") >>> m3d.release_desktop(False, False)