Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Improve parameters and full_parameters #3509

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
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
32 changes: 24 additions & 8 deletions src/systems/abstractsystem.jl
Original file line number Diff line number Diff line change
Expand Up @@ -1330,11 +1330,17 @@ end
"""
$(TYPEDSIGNATURES)

Get the parameters of the system `sys` and its subsystems.
Get the standard parameters of the system `sys` and its subsystems.

See also [`@parameters`](@ref) and [`ModelingToolkit.get_ps`](@ref).
# Keyword arguments

- `initial_parameters`: Whether to include parameters for initial values of variables in the initialization system.
- `dependent_parameters`: Whether to include parameters that are determined by parameter dependencies.

See also [`full_parameters`](@ref) and [`ModelingToolkit.get_ps`](@ref).
"""
function parameters(sys::AbstractSystem; initial_parameters = false)
function parameters(
sys::AbstractSystem; initial_parameters = false, dependent_parameters = false)
ps = get_ps(sys)
if ps == SciMLBase.NullParameters()
return []
Expand All @@ -1343,12 +1349,15 @@ function parameters(sys::AbstractSystem; initial_parameters = false)
ps = first.(ps)
end
systems = get_systems(sys)
result = unique(isempty(systems) ? ps :
[ps; reduce(vcat, namespace_parameters.(systems))])
ps = unique(isempty(systems) ? ps :
[ps; reduce(vcat, namespace_parameters.(systems))])
if !initial_parameters && !is_initializesystem(sys)
filter!(x -> !iscall(x) || !isa(operation(x), Initial), result)
filter!(x -> !iscall(x) || !isa(operation(x), Initial), ps)
end
return result
if dependent_parameters
ps = vcat(ps, ModelingToolkit.dependent_parameters(sys))
end
return ps
end

function dependent_parameters(sys::AbstractSystem)
Expand Down Expand Up @@ -1387,8 +1396,15 @@ function parameter_dependencies(sys::AbstractSystem)
return vcat(namespaced_deps, pdeps)
end

"""
$(TYPEDSIGNATURES)

Get all parameters of the system `sys` and its subsystems, including initial values and dependent parameters.

See also [`parameters`](@ref) and [`ModelingToolkit.get_ps`](@ref).
"""
function full_parameters(sys::AbstractSystem)
vcat(parameters(sys; initial_parameters = true), dependent_parameters(sys))
return parameters(sys; initial_parameters = true, dependent_parameters = true)
end

"""
Expand Down
17 changes: 17 additions & 0 deletions test/split_parameters.jl
Original file line number Diff line number Diff line change
Expand Up @@ -311,3 +311,20 @@ end
@test sysref.subsys.c in ps
@test length(ps) == 2
end

@testset "Parameter getter flags" begin
evalinterp(I, t) = I(t)
@register_symbolic evalinterp(I::LinearInterpolation, t)

@parameters P1 P2 (C::LinearInterpolation)(..) I::LinearInterpolation
@variables x(t) y(t)
eqs = [D(x) ~ P1 + P2 + C(t) + evalinterp(I, y), y ~ 2 * x]
pdeps = [P1 ~ 2 * P2]
@named M = ODESystem(eqs, t; parameter_dependencies = pdeps)
Ms = structural_simplify(M)

@test Set(parameters(Ms)) == Set([P2, I, C])
@test Set(parameters(Ms; initial_parameters = true)) ==
Set([P2, I, C, Initial(P1), Initial(x), Initial(y)])
@test Set(parameters(Ms; dependent_parameters = true)) == Set([P2, I, C, P1])
end
Loading