Creating a New Report

Following is the general procedure for creating a new report:

  1. On the HFSS menu or the Project Manager, point to Results, select Create <type> Report, and select the Display Type template. There are more Report Type templates available for terminal solutions (terminal, modal, fields, near fields, and far fields) and for modal solutions (modal and fields). For Eigenmode solutions, the Report Type <templates> are for Eigenmode Parameters and for Fields. Characteristic Modes solution reports include quantities for Significance, Value, and Angle.

    The Results tab for the Ribbon will show icons and drop-down menus for available report types for the active project.

    Modal Solution Data Report drop-down menu.

    If you have created custom report templates (for example, including your company name or other format changes), you can also create a report based on that template by selecting HFSS> Results> Report Templates> PersonalLib> <templateName>. You can also make such changes the default for new reports by right-clicking a modified report and selecting Report Templates>Save Settings as default.

    When you have selected the report and display type from the Results menu, the Report dialog box appears, with the Trace tab selected by default.

  2. In the Context section, you make selections depending on the design and solution type.
  3. In the Y Component section of the dialog box, make selections for the following:
    1. Categories - those depend on the Solution type and the design. For example, Eigenmode quantities include Eigenmodes, variables, output variables, and the design. Driven solutions include such categories as S parameters. Report categories for Transient designs include Spectral and Transient. For a Transient Network design with differential pairs defined, the Reporter interface allows selection of single-ended or differential signals just as for driven terminal. Characteristic Mode Data Reports include Characteristic Mode quantities for Significance, Value, and Angle. Report categories for SBR+ designs that include an Incident Plane wave and an RCS selection as Monostatic do not require a geometry selection and include a range of Monostatic Quantities when select Monostatic RCS as the Report Category. For SBR+ designs and RCS Monostatic you can choose between Freq, IWaveTheta and IWavePhi variables for specifying sweeps. The selected Category provides the default plot name. You can edit the plot names in the project tree and the plot header text in the report synchronizes.
    2. Quantities for Y are relative to the selected category.
      Note:

      The Quantity text field can be used to filter the Quantity list by typing in text, or by using the four predefined selections. This is useful if the Category selected produces a lengthy Quantities list. See Filtering Quantity Selections for the Reporter.

      When the matrix is very large, the number of quantities can be correspondingly huge. Therefore, the Quantities field can optionally use a tree structure to divide matrix quantities into groups by their first element name. The initial display shows groups, without initially listing group members. See Report Setup Options.

    3. Function list to apply to the Y quantities.
    4. Value field displays the currently specified Quantity and Function. You can edit this field directly.
      Note:

      Color shows valid expression.

    5. Range Function button -- opens the Set Range Function dialog box. This applies to the currently specified Quantity and Function.
    6. To use a dataset in this report, set the Y component to a Piecewise Linear Function pwl(dataset_expression, primary_sweep) where is the primary_sweep is what you set in the next step.
  4. In the X (Primary Sweep) section, make selections for the following:
    1. Select the Primary value(s) from the drop-down menu.

      To select an X component that is different from the Primary Sweep, uncheck the Default field to enable the X field and Browse [...] button. Click Browse [...] to display the Select X Component dialog.

      Select X Component Dialog

      This lets you specify the X component as you do the Y; that is, in terms of Categories which define the selectable Quantities, and Functions to apply. After making selections, OK the dialog box to assign the X component.

    2. If sweeps are available, you can select Browse [...] to display a panel that lets you select Use all values, or selected sweep or sweeps, or access an Edit Sweep dialog box with further editing options. Post-Processing variables are Post-Processing sweeps/editable sweeps, so you can use the Edit Sweep dialog box to create your own sweep.
    3. The Families tab provides a way to select from valid solutions for sweeps where a simulation has multiple variables defined (for example, for a parametric sweep). If so, the variables other than the one chosen as the X (Primary sweep), are listed under the Families tab with columns for the variable, the value, and an Edit column with an ellipsis [...] button. See Using Families tab for Reports.
  5. Update Report setting
    • Real Time checked -- enable real time updates for all reports while the reports are being edited.
    • Real Time unchecked -- enables drop down menu to Update All Reports or Update Report. Reports will only be updated with one of these user selectable update options or upon exiting the report dialog box. This can be useful if you expect a trace to take time to display. You can then add additional traces without having to wait.
  6. The Report dialog command buttons permit you create a new report with the settings you provide, or to modify an existing report.
    • Output Variables – opens the Output Variables dialog box.
    • Add Trace – this is enabled when you have created or selected a report. Add one or more traces to include in the report.
    • Update Trace – updates the selected traces in a report based on further processing or changes.
    • New Report. Adds a report to the Project tree under the Results icon. The new Report is displayed in the Project window.
    • Options – opens the Report Setup Options dialog box. This contains a check box for using the advanced mode for editing and viewing trace components. This mode is automatic if the trace requires it. It also contains a field for setting the maximum number of significant digits to display for numerical quantities.
    • Close – closes the Report dialog box.
  7. Click New Report to create a new report in the Project Manager.

    The report appears in the view window. It will be listed in the project tree under Results, with the default name based on the Report Category you selected, for example, S Parameter Plot n or Output Variables Plot n. You can edit the plot names in the project tree and the plot header text in the report synchronizes. Traces within the report also appear in the project tree.

    Some plots may take time to complete. Performing a File>Save in such cases after the plot has been created will permit you to review the plot later without having to repeat the calculation time when you reopen the project later.

  8. To speed redraw times for changed plots, perform a Save. This saves the data that comprises expressions. For example if re(S11)*re(S22) is requested over multiple widths, each of the S11 and S22 are stored when you save. If you do not do a save of a changed plot, the changed version is not stored.
Note:

Remember that the evaluated value of an expression is always interpreted in SI units. However, when an angle quantity is plotted in a report, you have the option to plot values in units other than SI. If you want to plot the polar angle of a complex simulation result, S11 say, you can choose between ang_deg(S11) and ang_rad(S11). Both of these return the exact same angle quantity but in degree and radian units respectively.

Note that when used in expressions, some surprising outcomes might result. For example, the expression "1+ang_deg(S11)" represents an ‘angle’ and the number "1" is treated as "1 rad". The angle SI unit is attached to any unitless number that is added/subtracted from an angle value. If you want to treat "1" as degrees, make it explicit and use "1deg + ang_deg(S11)" instead.

If you are interested in unitless degree values, two additional functions exist: ang_deg_val(S11) and cang_deg_val(S11). These return simple numbers and are treated as such by any expression. If the complex S11 lies on the positive Y axis say, ang_deg_val(S11) would be 90 and "1 + ang_deg_val(S11)" will be 91.