The Report Node
The main Report node () contains information about the formatting and defaults for the report.
If you have added a Custom report, you can generate a report tree based on the available templates as specified in the Template section (described below) by clicking Generate (). If the report tree is not empty, you will be asked if you want to replace the current tree.
Regenerating the report tree can be useful if you want to update the tree to reflect changes you have made in the model or if you want to change the report template without replacing the entire report.
Click the Preview Selected () or Preview All () button to show a preview of the report in the Preview window. Click the Write button () in the toolbar for the Settings window for Report to create a report. The Write option is also available by right-clicking any node in the report. Selecting Write from any report node’s context menu generates the entire report.
Template
This section, which is collapsed by default, contains the setting for the level of detail in new nodes that are added to the report manually. It also determines which nodes are added as well as their level of detail if you click Generate () in the main Report node’s toolbar. The Template list takes its initial value from the template used to create the initial report contents. Alternatively, if you added an empty report, the default value is Intermediate. The options available for selection include the values Brief, Intermediate, and Complete as well as any custom report templates found in your user and installation report templates folders and in the current model (see Creating, Exporting, and Using Custom Report Templates).
Format
You can select to create a report in one of the following formats, which you choose from the Output format list:
HTML, for creating the report as an HTML file for display in a web browser.
Microsoft Word, for creating the report as a docx file for use as a document in Microsoft® Word (version 2007 or later).
When adding a new report, the initial setting for the output format is that of the last report you wrote (or previewed).
The Report Generator stores the report in a file with the chosen name and by default gives it the extension .html or .docx. For HTML reports, it stores images included in the report and the style sheet in a subdirectory with the same name as the report plus the suffix _files. Reports in Microsoft Word format are self contained.
Specify the report’s directory path and filename in the Filename text field or click Browse to launch the Specify Report File dialog box, browse to the desired location, and enter the filename in the File name text field. If the text field is empty, you will be asked to specify the filename when you click Write. If you select Always ask for filename, the Specify Report File dialog box will always prompt you for a filename; if specified, the current name is the default choice.
When you add a new report, the filename will by default be empty. You can override this behavior by specifying a default report directory in the Preferences dialog; see the subsection Edit the Default Report Settings below.
Select Open finished report to directly open the generated report in a web browser (HTML) or Microsoft Word.
By default, report output data that refers to model contents will be rendered as hyperlinks if there is a report section for the referenced object. For example, in the report section for a solver you can follow a link to get to the section describing the study step that defines the solver. If you want to disable hyperlinks, for example when printing a report, select the Disable cross-reference hyperlinks check box.
To customize the style of reports in the HTML output format, you can specify the CSS-file to use in the Style sheet list:
Select Default to use the default style file specified in the Preferences dialog (see Edit the Default Report Settings) or the built-in style in COMSOL Multiphysics if no valid default style file has been given.
Select Custom if you want to use a custom style sheet for a particular report. If you select Custom, specify a style sheet in the Style-sheet file field, or click Browse to locate the style-sheet file (CSS file).
Also for reports in the HTML format, select a level from the Generate separate files a section level list: None (the default; one file only), Level 1, Level 2, or Level 3.
For reports in the Microsoft Word format, you can control the layout using the Template list:
Select Default to use as the style template the default Microsoft Word template (.dotx) or Microsoft Word document (.docx) file specified in the Preferences dialog. If no such file has been specified, COMSOL’s built-in template will be used.
Select Custom and type a path to the .dotx or .docx file of your choice in the Template file text field or click Browse to navigate to its location on the file system.
From the Start new page at section level list, choose the section level at which to start a new page of your report in Microsoft Word format: None (no page breaks), Level 1 (the default), Level 2, or Level 3.
For both output formats, choose the section level to which the report should enumerate each section from the Enumerate section to level list: None (no enumerated section), Level 1, Level 2, Level 3 (the default), Level 4, Level 5, Level 6, or All (enumerate all sections).
Publishing and Editing an HTML Report
Once an HTML report is created, it can be published or edited in any HTML editor. If you want to publish a report on the internet or send it to a colleague, also send the HTML file and the folder with the images and style sheet.
Images
From the Size list, you can select the image size as Extra small (240-by-180 pixels for HTML screen output/2.4-by-1.8 inches for print-optimized output), Small (320-by-240 pixels/3-by-2.4 inches), Medium (480-by-360 pixels/4-by-3 inches), Large (600-by-450 pixels/6-by-4.5 inches), or Extra large (720-by-540 pixels/7.2-by-5.4 inches)). All images have an aspect ratio of 4:3. From the Type list, select the image file type: PNG (the default), JPEG, or BMP (not supported for reports in Microsoft Word format; choosing this option gives PNG images).
There are three options for controlling image generation:
Generate images (default): Report images are generated in accordance with the settings for the individual report features each time you write the report.
Suppress image regeneration: Images are generated if they are not available. Use this option if you want to quickly rewrite the report to include changes that only affect the text.
Disable image generation: Images are not generated. This option can be useful, for example, when troubleshooting models with a very large number of nodes.
Number Format
Using the controls in this section, you can customize how numbers are formatted in report table output. The available Format settings are:
Default — Numbers in report tables are displayed in the same way as numbers are displayed by default in the Table window in the COMSOL Desktop. In particular, the precision is then controlled by the Output display precision setting on the General page of the Preferences dialog.
Custom — Choose this option if you want to customize number formatting for your report. You can then specify the Precision as an integer between 1 and 15 (the default is the current Output display precision preference setting); the Notation, with the alternatives
-
Automatic (default) — display numbers in either scientific or decimal notation depending on their magnitude
-
Decimal — display numbers in decimal notation, for example 0.85
-
Engineering — display numbers in engineering notation, for example 850E3
-
Scientific — display numbers in scientific notation, for example 8.5E1
and the Complex notation:
-
Rectangular — display complex numbers in terms of real and imaginary parts, for example 1 + 2i.
-
Polar — display complex number in terms of magnitude and argument, for example 2.236163.435°
For Scientific and Decimal notation, select the Display all significant digits if you want to keep trailing zeros within the chosen precision.
Select the Right align numeric columns check box to right align table columns with purely numeric data.
You can override the report-wide number format settings for individual report feature nodes that generate table data. The Settings window for such a report feature node contains a Number Format section where you can specify the Format as either From report (the default) or Custom. The former option gives the number formatting defined in the corresponding section of the parent Report node, whereas the latter allows you to specify dedicated settings.
Edit the Default Report Settings
Open The Preferences Dialog Box and click Results to control some properties for the report generator.
If the Report directory refers to an existing directory, the default filename for a new report will be based on the model’s name. When the report directory is set in this way, a nonabsolute path in the Filename text field in the Format section of the Report Settings window will be interpreted as relative to this directory.
In the Default report style-sheet file field, type the full path and filename to a style sheet (.css-file) that you want to use as the default style sheet for reports in HTML format. Click Browse to browse to the file’s location.
In the Default report template file field, type the full path and filename to a Microsoft Word template (.dotx-file) that you want to use as the default style template for reports in Microsoft Word format. Click Browse to browse to the file’s location. You can also use a Microsoft Word document (.docx-file) as your default template.
In the Logotype file field, type the full path and filename for an image file (on PNG or JPEG format) to use as the logotype. Click Browse to browse to the logotype file. If empty, the COMSOL logotype appears in the report.
In the Company field, type the name of a company associated with the report if desired.
From the Default image size list, you can select the default size for report images; choose between Extra small, Small, Medium, and Large. Similarly, use the Default image type list to specify the default type for the report images: PNG, JPEG, or BMP.
Select the Prompt for update of table of contents in Microsoft Word check box to make Microsoft Word ask whether you want to update the table of contents when you first launch a report in this format. Such an update is necessary to generate page numbers in the table of contents, but you can choose to do the update after you have opened the document in Microsoft Word. By default this check box is not selected.