From b61198d81f6dc49e96954296f54f36fa26cba0fd Mon Sep 17 00:00:00 2001 From: Ayush1299 Date: Tue, 8 Apr 2025 14:49:08 +0530 Subject: [PATCH 1/3] Refactored ODESystem composition and accessor function docs (#3505); Added troubleshooting guide for detection process (#515) --- docs/src/systems/ODESystem.md | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-) diff --git a/docs/src/systems/ODESystem.md b/docs/src/systems/ODESystem.md index 24e2952fc5..7a8c2e2af7 100644 --- a/docs/src/systems/ODESystem.md +++ b/docs/src/systems/ODESystem.md @@ -8,21 +8,26 @@ ODESystem ## Composition and Accessor Functions - - `get_eqs(sys)` or `equations(sys)`: The equations that define the ODE. - - `get_unknowns(sys)` or `unknowns(sys)`: The set of unknowns in the ODE. - - `get_ps(sys)` or `parameters(sys)`: The parameters of the ODE. - - `get_iv(sys)`: The independent variable of the ODE. - - `get_u0_p(sys, u0map, parammap)` Numeric arrays for the initial condition and parameters given `var => value` maps. - - `continuous_events(sys)`: The set of continuous events in the ODE. - - `discrete_events(sys)`: The set of discrete events in the ODE. - - `alg_equations(sys)`: The algebraic equations (i.e. that does not contain a differential) that defines the ODE. - - `get_alg_eqs(sys)`: The algebraic equations (i.e. that does not contain a differential) that defines the ODE. Only returns equations of the current-level system. - - `diff_equations(sys)`: The differential equations (i.e. that contain a differential) that defines the ODE. - - `get_diff_eqs(sys)`: The differential equations (i.e. that contain a differential) that defines the ODE. Only returns equations of the current-level system. - - `has_alg_equations(sys)`: Returns `true` if the ODE contains any algebraic equations (i.e. that does not contain a differential). - - `has_alg_eqs(sys)`: Returns `true` if the ODE contains any algebraic equations (i.e. that does not contain a differential). Only considers the current-level system. - - `has_diff_equations(sys)`: Returns `true` if the ODE contains any differential equations (i.e. that does contain a differential). - - `has_diff_eqs(sys)`: Returns `true` if the ODE contains any differential equations (i.e. that does contain a differential). Only considers the current-level system. +```@docs +get_eqs +equations +get_unknowns +unknowns +get_ps +parameters +get_iv +get_u0_p +continuous_events +discrete_events +alg_equations +get_alg_eqs +diff_equations +get_diff_eqs +has_alg_equations +has_alg_eqs +has_diff_equations +has_diff_eqs + ## Transformations From f001c5e4ec1349c9cf98efd0ebdfbf1b53646da1 Mon Sep 17 00:00:00 2001 From: AyushRajput <134182912+ayush2281@users.noreply.github.com> Date: Tue, 8 Apr 2025 15:12:07 +0530 Subject: [PATCH 2/3] Update ODESystem.md --- docs/src/systems/ODESystem.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/src/systems/ODESystem.md b/docs/src/systems/ODESystem.md index 7a8c2e2af7..861e34cd5c 100644 --- a/docs/src/systems/ODESystem.md +++ b/docs/src/systems/ODESystem.md @@ -9,6 +9,7 @@ ODESystem ## Composition and Accessor Functions ```@docs +canonical = false here get_eqs equations get_unknowns From 7039d394b6d7c957e2b4ad2650c37aa27a0c7cca Mon Sep 17 00:00:00 2001 From: AyushRajput <134182912+ayush2281@users.noreply.github.com> Date: Tue, 8 Apr 2025 21:03:27 +0530 Subject: [PATCH 3/3] Update ODESystem.md --- docs/src/systems/ODESystem.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/src/systems/ODESystem.md b/docs/src/systems/ODESystem.md index 861e34cd5c..1f4d7a1746 100644 --- a/docs/src/systems/ODESystem.md +++ b/docs/src/systems/ODESystem.md @@ -9,6 +9,7 @@ ODESystem ## Composition and Accessor Functions ```@docs + canonical = false here get_eqs equations @@ -29,7 +30,7 @@ has_alg_eqs has_diff_equations has_diff_eqs - +``` ## Transformations ```@docs