From 80779154ce6101eb1fb5a14c9a7b274a15143d75 Mon Sep 17 00:00:00 2001 From: Daniel Weindl Date: Mon, 8 Jan 2024 19:08:28 +0100 Subject: [PATCH] Doc: t0 (#2263) Closes #2248 --- include/amici/model.h | 6 ++++++ include/amici/simulation_parameters.h | 9 ++++++++- 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/include/amici/model.h b/include/amici/model.h index d355ea7fee..481164afdf 100644 --- a/include/amici/model.h +++ b/include/amici/model.h @@ -704,6 +704,12 @@ class Model : public AbstractModel, public ModelDimensions { /** * @brief Set simulation start time. + * + * Output timepoints are absolute timepoints, independent of + * \f$ t_{0} \f$. + * For output timepoints \f$ t < t_{0} \f$, the initial state will be + * returned. + * @param t0 Simulation start time */ void setT0(double t0); diff --git a/include/amici/simulation_parameters.h b/include/amici/simulation_parameters.h index 55db090184..8a1c1ec23d 100644 --- a/include/amici/simulation_parameters.h +++ b/include/amici/simulation_parameters.h @@ -175,7 +175,14 @@ class SimulationParameters { */ std::vector plist; - /** starting time */ + /** + * @brief Starting time of the simulation. + * + * Output timepoints are absolute timepoints, independent of + * \f$ t_{start} \f$. + * For output timepoints \f$ t < t_{start} \f$, the initial state will be + * returned. + */ realtype tstart_{0.0}; /**