Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Documenter = "1.4"
ExplicitImports = "1.6"
HarmonicSteadyState = "0.2.1"
JET = "0.9.18, 0.10"
ModelingToolkit = "9.60"
ModelingToolkit = "9.60, 10"
OrdinaryDiffEqTsit5 = "1.1"
PrecompileTools = "1.2"
QuestBase = "0.3.1"
Random = "1.10"
Expand All @@ -44,9 +45,10 @@ JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
QuestBase = "7e80f742-43d6-403d-a9ea-981410111d43"
Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
OrdinaryDiffEqTsit5 = "b1df2697-797e-41e3-8120-5422d3b24e4a"
SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"

[targets]
test = ["Aqua", "JET", "SymbolicUtils", "Symbolics", "ExplicitImports", "Test", "Random", "ModelingToolkit", "Documenter", "QuestBase"]
test = ["Aqua", "JET", "SymbolicUtils", "Symbolics", "ExplicitImports", "Test", "Random", "ModelingToolkit", "Documenter", "QuestBase", "OrdinaryDiffEqTsit5"]
36 changes: 19 additions & 17 deletions ext/ModelingToolkitExt.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module ModelingToolkitExt

using DocStringExtensions

export ODESystem, ODEProblem, SteadyStateProblem, NonlinearProblem
export System, ODEProblem, SteadyStateProblem, NonlinearProblem

using QuestBase:
is_rearranged, rearrange_standard, rearrange_standard!, is_rearranged_standard
Expand All @@ -14,14 +14,15 @@ using Symbolics:
simplify, Equation, substitute, Num, @variables, expand, unwrap, arguments, wrap
using ModelingToolkit:
ModelingToolkit,
ODESystem,
System,
ODEProblem,
NonlinearProblem,
SteadyStateProblem,
varmap_to_vars,
parameters,
unknowns,
@parameters,
@mtkbuild,
@mtkcompile,
@independent_variables

swapsides(eq::Equation) = Equation(eq.rhs, eq.lhs)
Expand All @@ -36,7 +37,7 @@ end
@doc """
$(TYPEDSIGNATURES)

Creates and ModelingToolkit.ODESystem from a HarmonicEquation.
Creates and ModelingToolkit.System from a HarmonicEquation.

### Example
```julia
Expand All @@ -49,12 +50,12 @@ diff_eq = DifferentialEquation(
add_harmonic!(diff_eq, x, ω) #
harmonic_eq = get_harmonic_equations(diff_eq)

sys = ODESystem(harmonic_eq)
sys = System(harmonic_eq)
param = (α => 1.0, ω0 => 1.1, F => 0.01, γ => 0.01, ω => 1.1)
ODEProblem(sys, [1.0, 0.0], (0, 100), param)
```
"""
function ModelingToolkit.ODESystem(eom::HarmonicEquation)
function ModelingToolkit.System(eom::HarmonicEquation)
if !is_rearranged(eom) # check if time-derivatives of the variable are on the right hand side
eom = rearrange_standard(eom)
end
Expand All @@ -74,15 +75,15 @@ function ModelingToolkit.ODESystem(eom::HarmonicEquation)
eqs = simplify.(expand.(eqs))
eqs = substitute(eqs, Dict(zip(eom.parameters, par_names)))

# ∨ mtk v9 need @mtkbuild
@mtkbuild sys = ODESystem(eqs, first(slow_time_ivp), vars, par_names)
# ∨ mtk v10 need @mtkcompile
@mtkcompile sys = System(eqs, first(slow_time_ivp), vars, par_names)
return sys
end

@doc """
$(TYPEDSIGNATURES)

Creates and ModelingToolkit.ODESystem from a DifferentialEquation.
Creates and ModelingToolkit.System from a DifferentialEquation.

### Example
```julia
Expand All @@ -92,14 +93,14 @@ using ModelingToolkit
diff_eq = DifferentialEquation(
d(x, t, 2) + ω0^2 * x + α * x^3 + γ * d(x, t) ~ F * cos(ω * t), x
)
sys = ODESystem(diff_eq)
sys = System(diff_eq)

param = (α => 1.0, ω0 => 1.1, F => 0.01, γ => 0.01, ω => 1.1)

ODEProblem(sys, [1.0, 0.0], (0, 100), param)
```
"""
function ModelingToolkit.ODESystem(diff_eq::DifferentialEquation)
function ModelingToolkit.System(diff_eq::DifferentialEquation)
diff_eq = deepcopy(diff_eq)
if !is_rearranged_standard(diff_eq)
rearrange_standard!(diff_eq)
Expand All @@ -120,7 +121,7 @@ function ModelingToolkit.ODESystem(diff_eq::DifferentialEquation)

eqs = substitute(eqs, Dict(zip(param_undeclared, params)))

@mtkbuild sys = ODESystem(eqs, first(iv), vars, params)
@mtkcompile sys = System(eqs, first(iv), vars, params)

return sys
end
Expand Down Expand Up @@ -160,12 +161,13 @@ function ModelingToolkit.ODEProblem(
in_place=true,
kwargs...,
)
sys = ODESystem(eom)
param = varmap_to_vars(p, parameters(sys))
sys = System(eom)
# param = varmap_to_vars(p, parameters(sys))
dict = merge(isempty(u0) ? Dict() : Dict(unknowns(sys) .=> u0), p)
if !in_place # out-of-place
prob = ODEProblem{false}(sys, u0, tspan, param; jac=true, kwargs...)
prob = ODEProblem{false}(sys, dict, tspan; jac=true, kwargs...)
else # in-place
prob = ODEProblem{true}(sys, u0, tspan, param; jac=true, kwargs...)
prob = ODEProblem{true}(sys, dict, tspan; jac=true, kwargs...)
end # compute jacobian for performance
return prob
end
Expand Down Expand Up @@ -220,7 +222,7 @@ SteadyStateProblem(harmonic_eq, [1.0, 0.0], param)
function ModelingToolkit.SteadyStateProblem(
eom::HarmonicEquation, u0, p::AbstractDict; in_place=true, kwargs...
)
sys = ODESystem(eom)
sys = System(eom)
param = varmap_to_vars(p, parameters(sys))
if !in_place # out-of-place
prob = SteadyStateProblem{false}(sys, u0, param; jac=true, kwargs...)
Expand Down
24 changes: 15 additions & 9 deletions test/ModelingToolkitExt.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
using HarmonicBalance
using ModelingToolkit
using ModelingToolkit, OrdinaryDiffEqTsit5
using Test

@testset "Utilities" begin
Expand All @@ -10,22 +10,22 @@ using Test
end

@testset "DifferentialEquation" begin
@testset "ODESystem" begin
@testset "System" begin
@variables α ω ω0 F γ t x(t)
diff_eq = DifferentialEquation(
d(x, t, 2) + ω0^2 * x + α * x^3 + γ * d(x, t) ~ F * cos(ω * t), x
)

fixed = (α => 1.0, ω0 => 1.1, F => 0.01, γ => 0.01)
param = HarmonicBalance.OrderedDict(merge(Dict(fixed), Dict(ω => 1.1)))
sys = ODESystem(diff_eq)
sys = System(diff_eq)

for p in string.([α, ω, ω0, F, γ])
@test p ∈ string.(parameters(sys))
end

# can run a second time without error; diff_eq unmutated
ODESystem(diff_eq)
System(diff_eq)
end
@testset "ODEProblem" begin
@variables α ω ω0 F γ t x(t)
Expand All @@ -36,11 +36,14 @@ end
add_harmonic!(diff_eq, x, ω) #
harmonic_eq = get_harmonic_equations(diff_eq)

sys = ODESystem(harmonic_eq)
sys = System(harmonic_eq)
fixed = (α => 1.0, ω0 => 1.1, F => 0.01, γ => 0.01)
param = HarmonicBalance.OrderedDict(merge(Dict(fixed), Dict(ω => 1.1)))

ODEProblem(diff_eq, [1.0, 0.0], (0, 100), param)
prob = ODEProblem(diff_eq, [1.0, 0.0], (0, 100), param)

sol = solve(prob, Tsit5())
@test all(tt -> +(tt...) isa Float64, sol.u)
end
end

Expand All @@ -55,15 +58,18 @@ end

fixed = (α => 1.0, ω0 => 1.1, F => 0.01, γ => 0.01)
param = HarmonicBalance.OrderedDict(merge(Dict(fixed), Dict(ω => 1.1)))
@testset "ODESystem" begin
sys = ODESystem(harmonic_eq)
@testset "System" begin
sys = System(harmonic_eq)

for p in string.([α, ω, ω0, F, γ])
@test p ∈ string.(parameters(sys))
end
end

@testset "ODEProblem" begin
ODEProblem(harmonic_eq, [1.0, 0.0], (0, 100), param)
prob = ODEProblem(harmonic_eq, [1.0, 0.0], (0, 100), param)

sol = solve(prob, Tsit5())
@test all(tt -> +(tt...) isa Float64, sol.u)
end
end
Loading