add docs

Author: TorkelE

docs/src/systems/ODESystem.md

@@ -13,8 +13,16 @@ ODESystem
   - `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
+  - `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.
 
 ## Transformations
 

docs/src/systems/SDESystem.md

@@ -19,8 +19,16 @@ sde = SDESystem(ode, noiseeqs)
   - `get_unknowns(sys)` or `unknowns(sys)`: The set of unknowns in the SDE.
   - `get_ps(sys)` or `parameters(sys)`: The parameters of the SDE.
   - `get_iv(sys)`: The independent variable of the SDE.
-  - `continuous_events(sys)`: The set of continuous events in the SDE
-  - `discrete_events(sys)`: The set of discrete events in the SDE
+  - `continuous_events(sys)`: The set of continuous events in the SDE.
+  - `discrete_events(sys)`: The set of discrete events in the SDE.
+  - `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.
 
 ## Transformations
 

test/equation_type_accessors.jl

@@ -1,6 +1,7 @@
 # Fetch packages.
 using ModelingToolkit
 import ModelingToolkit: get_systems, namespace_equations
+import ModelingToolkit: is_alg_equation, is_diff_equation
 import ModelingToolkit: t_nounits as t, D_nounits as D, wrap, get_eqs
 
 # Creates equations.

test/runtests.jl

@@ -69,7 +69,7 @@ end
             @safetestset "Generate Custom Function Test" include("generate_custom_function.jl")
             @safetestset "Initial Values Test" include("initial_values.jl")
             @safetestset "Discrete System" include("discrete_system.jl")
-            @safetestset "Equation Type Accessors Test" include("equation_type_accessors.jl")           
+            @safetestset "Equation Type Accessors Test" include("equation_type_accessors.jl")
         end
     end