REPORT
From File->Print menu you can print various features of your project. The most important print tool is report (File->Print->Report): its a completely editable document where you can insert a wide series of details. It can be simply printed or even saved as a file.
The template
This is the main concept to be understood and it's the base of your report: here you have to insert a series of tags which will be analyzed by the software and substituted with text, tables or images. This substitution process is performed everytime you pass from template to report tab (which is readonly).
Tags
Tags are the key elements of every report. Suppose you want to print the project name on the report:
go on Template tab;
click somewhere on the template;
go to Insert->Tag menu: the tag selection window will appear. Here you'll find a tree representing all the available tags; select "Project name";
go to Report tab and see the result.
There are several kind of tags:
plain text: they will simply contain text when processed;
tables: you'll recognize them on Report page by their grid shape;
standard views: they will be replaced with an image taken from the viewport;
views: they're the views you've recorded (see views documentation for more information).
Tag options
Parameters can be passed to table, standard views and views tags to control their behaviour. In Template tab, a tag without any option has the form "<tag>"; table tags with options have the form:
"<tag?column1:column2:column3>"
In this way you can specify wich columns of the table will be printed, hiding the rest (every column will be printed if you don't specify any option). Standard views and views tags with options have the form:
"<tag?option1=value1:option2=value2>"
Text tags options
These are text tags options:
f: number of decimal places
Table tag options
Here are the available table tags with their relative columns:
Area list:
name
type
cavity type
conductivity_x
conductivity_y
flow_direction
emissivity
vapour_diffusion
color
specific_heat
volumetric_mass
Materials list: same as Area list
Boundary list:
id
type
name
air_temperature_type
air_temperature
air_temperature_factor
surface_resistance
humidity
phi_sat
color
Temperature and flow analysis:
name
length
min_t
max_t
av_t
min_flux
max_flux
av_flux
Q
dew_length
mold_length
Other tags:
border: width of the table (default: 1; min: 0; max 10);
min_width: minimum width of the table (default: 0).
Standard views and custom views tag options
These are all the options you can pass to standard views and custom views tags:
sim: index of the simulation (default: 0). Ignored by custom views;
width: the width, in pixels, of the image that will be generated (default: 500; min: 64; max: graphic card dependent);
height: the height, in pixels, of the image that will be generated (default: 350; min: 64; max: graphic card dependent);
border: the thickness, in pixels, of the border around the image (default: 1; min: 0; max: 100);
gradient: controls the presence of a colored gradient just below the generated image (default: "yes"; accepted values: "yes" or "no");
zoom_ex: (ignored in standard views) zoom extents the view (default: "no"; accepted values: "yes" or "no");
super_sampling: improves quality using super sampling (default: 2; min: 1; max: 6);
ratio:
(ignored in standard views) with
this option, you can adjust the ratio between height and width of
the view used to generate the print image. These are the
possibilities:
-
viewport_x
(default): the
view will be calculated in a manner so as to contain the exact
horizontal content of the viewport. To do this, the picture may be
cropped or with an edge in the vertical dimension;
-
viewport_y:
the
view will be calculated in a manner so as to contain the exact
vertical content of the viewport. To do this, the picture may be
cropped or with an edge in the horizontal dimension;
-
report:
the
view will be calculated so as to try to contain all the horizontal
and vertical viewport contents;
align: (ignored in standard views) if the parameter ratio is different from "report", the generated image may contain borders or be cropped. This parameter allows you to align the generated image centrally or at the various corners (default: "center"; accepted values: "center", "top", "left", "right", "bottom").
Examples:
<Areas_view?sim=0:width=300:height=200:gradient=no>
<View_1?width=800:height=300:ratio=viewport_x:align=left:border=0>
Plot tag options
Plot tags are the ones used, for example, to draw plots about boundary conditions' curves. Here you are the list of available options:
width: the width, in pixels, of the image that will be generated (default: 500; min: 64; max: 2048);
height: the height, in pixels, of the image that will be generated (default: 350; min: 64; max: 2048).
Section elements analysis tag options
If software supports analysis on section elements (for example, Glaser), these are the options you can pass to these kind of tags:
width: the width, in pixels, of the image that will be generated (default: 500; min: 64; max: 2048);
height: the height, in pixels, of the image that will be generated (default: 250; min: 64; max: 2048);
time: time, in seconds, used to generate image.
Date tag options
Date tag accepts just one option, format. The format you can pass is the same specified here. Example: <date?format=%x>
Gradient tag options
sim: index of the simulation (default: 0).
The text editor
The text editor you'll use to work with your reports is very similar to other text editors you should be familiar with. You'll be able to edit font and paragraph styles, insert text boxes and tables and much more. Remember that templates can be saved and loaded from "File" menu; in this way you can create your own collection to be used by your projects. To make this process easier, on the right side of the editor, you'll find a completely customizable list of templates.