Skip to content

refactor AP transform into exported API #3665

New issue

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

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 2, 2025
Merged
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
2 changes: 1 addition & 1 deletion src/ModelingToolkit.jl
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ export independent_variable, equations, controls, observed, full_equations, jump
brownians
export initialization_equations, guesses, defaults, parameter_dependencies, hierarchy
export mtkcompile, expand_connections, linearize, linearization_function,
LinearizationProblem, structural_simplify
LinearizationProblem, linearization_ap_transform, structural_simplify
export solve
export Pre

Expand Down
23 changes: 19 additions & 4 deletions src/systems/analysis_points.jl
Original file line number Diff line number Diff line change
Expand Up @@ -930,13 +930,22 @@ function open_loop(sys, ap::Union{Symbol, AnalysisPoint}; system_modifier = iden
return system_modifier(sys), vars
end

function linearization_function(sys::AbstractSystem,
"""
sys, input_vars, output_vars = $(TYPEDSIGNATURES)

Apply analysis-point transformations to prepare a system for linearization.

Returns
- `sys`: The transformed system.
- `input_vars`: A vector of input variables corresponding to the input analysis points.
- `output_vars`: A vector of output variables corresponding to the output analysis points.
"""
function linearization_ap_transform(sys,
inputs::Union{Symbol, Vector{Symbol}, AnalysisPoint, Vector{AnalysisPoint}},
outputs; loop_openings = [], system_modifier = identity, kwargs...)
outputs, loop_openings)
loop_openings = Set(map(nameof, canonicalize_ap(sys, loop_openings)))
inputs = canonicalize_ap(sys, inputs)
outputs = canonicalize_ap(sys, outputs)

input_vars = []
for input in inputs
if nameof(input) in loop_openings
Expand All @@ -958,9 +967,15 @@ function linearization_function(sys::AbstractSystem,
end
push!(output_vars, output_var)
end

sys = handle_loop_openings(sys, map(AnalysisPoint, collect(loop_openings)))
return sys, input_vars, output_vars
end

function linearization_function(sys::AbstractSystem,
inputs::Union{Symbol, Vector{Symbol}, AnalysisPoint, Vector{AnalysisPoint}},
outputs; loop_openings = [], system_modifier = identity, kwargs...)

sys, input_vars, output_vars = linearization_ap_transform(sys, inputs, outputs, loop_openings)
Comment on lines 977 to +978
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[JuliaFormatter] reported by reviewdog 🐶

Suggested change
sys, input_vars, output_vars = linearization_ap_transform(sys, inputs, outputs, loop_openings)
sys, input_vars, output_vars = linearization_ap_transform(
sys, inputs, outputs, loop_openings)

return linearization_function(system_modifier(sys), input_vars, output_vars; kwargs...)
end

Expand Down
Loading