diff --git a/docs/contents/cvode.rst b/docs/contents/cvode.rst index 87ecdb309..367e160d4 100644 --- a/docs/contents/cvode.rst +++ b/docs/contents/cvode.rst @@ -20,9 +20,10 @@ is satisfied: In NMODL, all ``KINETIC`` blocks are internally first converted to ``DERIVATIVE`` blocks. The ``DERIVATIVE`` block is then converted to a ``CVODE`` block, which contains two parts; the first part contains the update -step for linear systems, while the second part contains the update step for -non-linear systems (see `CVODES documentation`_, eqs. (4.8) and (4.9)). Given -a ``DERIVATIVE`` block of the form: +step for non-stiff systems (functional iteration), while the second part +contains the update step for stiff systems (additional step using the +Jacobian). For more information, see `CVODES documentation`_, eqs. (4.8) and +(4.9). Given a ``DERIVATIVE`` block of the form: .. _CVODES documentation: https://sundials.readthedocs.io/en/latest/cvodes/Mathematics_link.html diff --git a/src/pybind/wrapper.cpp b/src/pybind/wrapper.cpp index ae9d41497..65fe2b6d6 100644 --- a/src/pybind/wrapper.cpp +++ b/src/pybind/wrapper.cpp @@ -186,8 +186,6 @@ except Exception as e: return {std::move(solution), std::move(exception_message)}; } -/// \brief A blunt instrument that differentiates expression w.r.t. variable -/// \return The tuple (solution, exception) std::tuple call_diff2c( const std::string& expression, const std::string& variable, diff --git a/src/pybind/wrapper.hpp b/src/pybind/wrapper.hpp index b4ec0a2df..694b0143d 100644 --- a/src/pybind/wrapper.hpp +++ b/src/pybind/wrapper.hpp @@ -45,6 +45,12 @@ std::tuple call_analytic_diff( const std::vector& expressions, const std::set& used_names_in_block); + +/// \brief Differentiates an expression with respect to a variable +/// \param expression The expression we want to differentiate +/// \param variable The name of the independent variable we are differentiating against +/// \param index_vars A map of array (indexable) variables (and their associated indices) that +/// appear in \ref expression \return The tuple (solution, exception) std::tuple call_diff2c( const std::string& expression, const std::string& variable,