impure functionsimulate

Simulates a model.

Extends from Internal.simulationArguments (The arguments of simulate, buildModel and the other simulation calls. An argument that is not given is taken from the experiment annotation.).

Information

Simulates a Modelica model by generating C code, building it and running the simulation executable. The only required argument is the className, while all others have some default values.

simulate(className, [startTime], [stopTime], [numberOfIntervals], [tolerance], [method], [fileNamePrefix], [options], [outputFormat], [variableFilter], [cflags], [simflags])

Example command:

simulate(A);

Inputs

TypeNameDefaultDescription
TypeNameclassName (from simulationArguments)the class that should simulated
RealstartTime (from simulationArguments)nan()the start time of the simulation. <default> = 0.0
RealstopTime (from simulationArguments)nan()the stop time of the simulation. <default> = 1.0
IntegernumberOfIntervals (from simulationArguments)-1number of intervals in the result file. <default> = 500
RealstepSize (from simulationArguments)nan()step size that is used for the result file; overrides numberOfIntervals. <default> = 0.002
Realtolerance (from simulationArguments)nan()tolerance used by the integration method. <default> = 1e-6
Stringmethod (from simulationArguments)"<default>"integration method used for simulation. <default> = dassl
StringfileNamePrefix (from simulationArguments)"<default>"fileNamePrefix. <default> = ""
Stringoptions (from simulationArguments)"<default>"options. <default> = ""
StringoutputFormat (from simulationArguments)"<default>"Format for the result file. <default> = "mat"
StringvariableFilter (from simulationArguments)"<default>"Only variables fully matching the regexp are stored in the result file. <default> = ".*"
Stringcflags (from simulationArguments)"<default>"cflags. <default> = ""
Stringsimflags (from simulationArguments)"<default>"simflags. <default> = ""
StringresimulateExecutable""If non-empty, skip translation and build and simulate this already-built executable directly.

Outputs

TypeNameDefaultDescription
SimulationResultsimulationResults

Contents

NameDescription
SimulationResult