BuildSysPro.Utilities.Analysis.Simulation2CSV

# .BuildSysPro.Utilities.Analysis.Simulation2CSV

Function for simulation and recording of variables in CSV format

## Information

Function for recording variables in CSV format

Hypothesis and equations

This function allows you to choose a template, to select parameters to be changed from their default values and then to select the variables to export to a CSV file

It allows the modification of a set of simulation option such as

- Starting time of the simulation, startTime,
- End of the simulation, stopTime,
- Events recording or not, saveEvents,
- Restitution interval, outputInterval, or number of intervals numberOfIntervals,
- Tolerance of the solver used, integrationTolerance,
- Integration time step size when the solver used has a fixed time step, fixedStepSize.

Bibliography

none

Instructions for use

Use the following procedure:

1. Right click on the function then Call Function,
2. In the tab setup, select the name and location of the CSV file and the name of the model to simulate
3. In the tab Model parameters select the parameters to be modified from their default value. Warnings, parameters of type String are not changeable by this function,
4. In the tab Model variables select the variables to be registered in the CSV file, the column description is used to set the title to be associated with the CSV file columns. If it is not given, then the variable name is used.
5. The tab preferences -> simulationOptions allows the modification of simulation parameters (startTime..).

After the successful parameterization of the function, click on Execute in the bottom right of the dialog window. The simulation is performed and variables are saved in the specified CSV file.

This function normally performs a simulation without recording events (saveEvents variable set to false by default), corresponding to the store variables at events box shakeout in the Output tab of the Setup menu (see figure below).

Known limits / Use precautions

Warnings, parameters of type String are not changeable by this function. It is a limit from Dymola.

It happened that Dymola crashes during the model variables selection. This error appears due to the annotation importDsin that must be incorporated in the record Variables and not at the top level in the record SimpleStudySetup.

Validations

Validated function - Gilles Plessis 06/2012

--------------------------------------------------------------
Licensed by EDF under a 3-clause BSD-license
Copyright © EDF 2009 - 2023
BuildSysPro version 3.6.0
Author : Gilles PLESSIS, EDF (2012)
--------------------------------------------------------------

#### Interface

>     function Simulation2CSV
>       import DataFiles;
>       input BuildSysPro.Utilities.Records.SimpleStudySetup setup;
>     end Simulation2CSV;

## Revisions

Gilles Plessis 03/2013 : Ajout des fonctions Dymola pour la simulation avec/sans événements et pas de temps equidistant. Suppresion de la possibilité de paramétrer l'étude en nombre de pas de temps.

Generated at 2026-05-09T18:18:56Z by OpenModelicaOpenModelica 1.26.7 using GenerateDoc.mos