Reports

Introduction

Since version 2.0, AQUAgpusph is designed like a sandbox, such that the reports that will be used to perform the simulation can be selected "on the fly". Anyway, in order to do more accessible the code, some Presets are provided "out of the box", which are defining Variables, Definitions, Tools and Reports to carry out specific actions.

The reports are used to print some global data (Scalar variables), either at the output screen or at an specific output file. They are executed each time step, right after all the tools have finished.

Defining new reports

In order to define new reports an specific section should be opened in the simulation definition XML input files (take a look on the examples to learn more about this):

<Reports>
    <!-- ... -->
</Reports>

The new reports will be defined between the new "Reports" opened section. Each tool is defined as follows:

<Report name="NAME" type="TYPE">

Where NAME and TYPE should be conveniently set. Depending on the selected "type", some other specific attributes will be required.

Name

The name of the report can be arbitrary selected. If the XML file was included providing a prefix, the final name of the report will be the concatenation of the prefix and the provided name.

Type

Several types of reports can be used:

screen

Some variables will be printed at the output screen. The attribute fields="VARS" should be provided, replacing VARS by the variables to be printed. The variables to be printed in the same line should be separated by a comma, ",", while to insert a line break a semicolon, ";", should be used to separate the variables.