available_report_quantities

PostProcessorIcepak.available_report_quantities(report_category=None, display_type=None, solution=None, quantities_category=None, context=None, is_siwave_dc=False, differential_pairs=False)

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

Parameters:

report_categorystr, optional

Report Category. The default is None, in which case the default category is used.

display_typestr, optional

Report Display Type. The default is None, in which case the default type is used. In most of the cases the default type is “Rectangular Plot”.

solutionstr, optional

Report Setup. The default is None, in which case the first nominal adaptive solution is used.

quantities_categorystr, optional

The category that the quantities belong to. It must be one of the available_quantities_categories method. The default is None, in which case the first default quantity is used.

contextstr, dict, optional

Report Context. The default is None, in which case the default context is used. 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.

is_siwave_dcbool, optional

Whether if the setup is SIwave DCIR or not. Default is False.

differential_pairsbool, optional

Whether if return differential pairs traces or not. Default is False.

Returns:

list

References

>>> oModule.GetAllQuantities

Examples

The example shows how to get report expressions for a Maxwell design with Eddy current solution. The context has to be provided as a dictionary where the key is the name of the original matrix and the value is the name of the reduced matrix. >>> 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”}) >>> m3d.release_desktop(False, False)