-
-
Notifications
You must be signed in to change notification settings - Fork 204
/
abstractsystem.jl
1523 lines (1331 loc) · 48.1 KB
/
abstractsystem.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
const SYSTEM_COUNT = Threads.Atomic{UInt}(0)
"""
```julia
calculate_tgrad(sys::AbstractTimeDependentSystem)
```
Calculate the time gradient of a system.
Returns a vector of [`Num`](@ref) instances. The result from the first
call will be cached in the system object.
"""
function calculate_tgrad end
"""
```julia
calculate_gradient(sys::AbstractSystem)
```
Calculate the gradient of a scalar system.
Returns a vector of [`Num`](@ref) instances. The result from the first
call will be cached in the system object.
"""
function calculate_gradient end
"""
```julia
calculate_jacobian(sys::AbstractSystem)
```
Calculate the jacobian matrix of a system.
Returns a matrix of [`Num`](@ref) instances. The result from the first
call will be cached in the system object.
"""
function calculate_jacobian end
"""
```julia
calculate_control_jacobian(sys::AbstractSystem)
```
Calculate the jacobian matrix of a system with respect to the system's controls.
Returns a matrix of [`Num`](@ref) instances. The result from the first
call will be cached in the system object.
"""
function calculate_control_jacobian end
"""
```julia
calculate_factorized_W(sys::AbstractSystem)
```
Calculate the factorized W-matrix of a system.
Returns a matrix of [`Num`](@ref) instances. The result from the first
call will be cached in the system object.
"""
function calculate_factorized_W end
"""
```julia
calculate_hessian(sys::AbstractSystem)
```
Calculate the hessian matrix of a scalar system.
Returns a matrix of [`Num`](@ref) instances. The result from the first
call will be cached in the system object.
"""
function calculate_hessian end
"""
```julia
generate_tgrad(sys::AbstractTimeDependentSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; kwargs...)
```
Generates a function for the time gradient of a system. Extra arguments control
the arguments to the internal [`build_function`](@ref) call.
"""
function generate_tgrad end
"""
```julia
generate_gradient(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; kwargs...)
```
Generates a function for the gradient of a system. Extra arguments control
the arguments to the internal [`build_function`](@ref) call.
"""
function generate_gradient end
"""
```julia
generate_jacobian(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; sparse = false, kwargs...)
```
Generates a function for the jacobian matrix matrix of a system. Extra arguments control
the arguments to the internal [`build_function`](@ref) call.
"""
function generate_jacobian end
"""
```julia
generate_factorized_W(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; sparse = false, kwargs...)
```
Generates a function for the factorized W-matrix matrix of a system. Extra arguments control
the arguments to the internal [`build_function`](@ref) call.
"""
function generate_factorized_W end
"""
```julia
generate_hessian(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; sparse = false, kwargs...)
```
Generates a function for the hessian matrix matrix of a system. Extra arguments control
the arguments to the internal [`build_function`](@ref) call.
"""
function generate_hessian end
"""
```julia
generate_function(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; kwargs...)
```
Generate a function to evaluate the system's equations.
"""
function generate_function end
mutable struct Substitutions
subs::Vector{Equation}
deps::Vector{Vector{Int}}
subed_eqs::Union{Nothing, Vector{Equation}}
end
Substitutions(subs, deps) = Substitutions(subs, deps, nothing)
Base.nameof(sys::AbstractSystem) = getfield(sys, :name)
#Deprecated
function independent_variable(sys::AbstractSystem)
Base.depwarn("`independent_variable` is deprecated. Use `get_iv` or `independent_variables` instead.",
:independent_variable)
isdefined(sys, :iv) ? getfield(sys, :iv) : nothing
end
#Treat the result as a vector of symbols always
function independent_variables(sys::AbstractSystem)
systype = typeof(sys)
@warn "Please declare ($systype) as a subtype of `AbstractTimeDependentSystem`, `AbstractTimeIndependentSystem` or `AbstractMultivariateSystem`."
if isdefined(sys, :iv)
return [getfield(sys, :iv)]
elseif isdefined(sys, :ivs)
return getfield(sys, :ivs)
else
return []
end
end
independent_variables(sys::AbstractTimeDependentSystem) = [getfield(sys, :iv)]
independent_variables(sys::AbstractTimeIndependentSystem) = []
independent_variables(sys::AbstractMultivariateSystem) = getfield(sys, :ivs)
iscomplete(sys::AbstractSystem) = isdefined(sys, :complete) && getfield(sys, :complete)
"""
$(TYPEDSIGNATURES)
Mark a system as completed. If a system is complete, the system will no longer
namespace its subsystems or variables, i.e. `isequal(complete(sys).v.i, v.i)`.
"""
function complete(sys::AbstractSystem)
isdefined(sys, :complete) ? (@set! sys.complete = true) : sys
end
for prop in [:eqs
:tag
:noiseeqs
:iv
:states
:ps
:tspan
:var_to_name
:ctrls
:defaults
:observed
:tgrad
:jac
:ctrl_jac
:Wfact
:Wfact_t
:systems
:structure
:op
:constraints
:controls
:loss
:bcs
:domain
:ivs
:dvs
:connector_type
:connections
:preface
:torn_matching
:tearing_state
:substitutions
:metadata
:discrete_subsystems]
fname1 = Symbol(:get_, prop)
fname2 = Symbol(:has_, prop)
@eval begin
$fname1(sys::AbstractSystem) = getfield(sys, $(QuoteNode(prop)))
$fname2(sys::AbstractSystem) = isdefined(sys, $(QuoteNode(prop)))
end
end
const EMPTY_TGRAD = Vector{Num}(undef, 0)
const EMPTY_JAC = Matrix{Num}(undef, 0, 0)
function invalidate_cache!(sys::AbstractSystem)
if has_tgrad(sys)
get_tgrad(sys)[] = EMPTY_TGRAD
end
if has_jac(sys)
get_jac(sys)[] = EMPTY_JAC
end
if has_ctrl_jac(sys)
get_ctrl_jac(sys)[] = EMPTY_JAC
end
if has_Wfact(sys)
get_Wfact(sys)[] = EMPTY_JAC
end
if has_Wfact_t(sys)
get_Wfact_t(sys)[] = EMPTY_JAC
end
return sys
end
function Setfield.get(obj::AbstractSystem, ::Setfield.PropertyLens{field}) where {field}
getfield(obj, field)
end
@generated function ConstructionBase.setproperties(obj::AbstractSystem, patch::NamedTuple)
if issubset(fieldnames(patch), fieldnames(obj))
args = map(fieldnames(obj)) do fn
if fn in fieldnames(patch)
:(patch.$fn)
else
:(getfield(obj, $(Meta.quot(fn))))
end
end
kwarg = :($(Expr(:kw, :checks, false))) # Inputs should already be checked
return Expr(:block,
Expr(:meta, :inline),
Expr(:call, :(constructorof($obj)), args..., kwarg))
else
error("This should never happen. Trying to set $(typeof(obj)) with $patch.")
end
end
rename(x, name) = @set x.name = name
function Base.propertynames(sys::AbstractSystem; private = false)
if private
return fieldnames(typeof(sys))
else
names = Symbol[]
for s in get_systems(sys)
push!(names, getname(s))
end
has_states(sys) && for s in get_states(sys)
push!(names, getname(s))
end
has_ps(sys) && for s in get_ps(sys)
push!(names, getname(s))
end
has_observed(sys) && for s in get_observed(sys)
push!(names, getname(s.lhs))
end
return names
end
end
function Base.getproperty(sys::AbstractSystem, name::Symbol; namespace = !iscomplete(sys))
wrap(getvar(sys, name; namespace = namespace))
end
function getvar(sys::AbstractSystem, name::Symbol; namespace = !iscomplete(sys))
systems = get_systems(sys)
if isdefined(sys, name)
Base.depwarn("`sys.name` like `sys.$name` is deprecated. Use getters like `get_$name` instead.",
"sys.$name")
return getfield(sys, name)
elseif !isempty(systems)
i = findfirst(x -> nameof(x) == name, systems)
if i !== nothing
return namespace ? renamespace(sys, systems[i]) : systems[i]
end
end
if has_var_to_name(sys)
avs = get_var_to_name(sys)
v = get(avs, name, nothing)
v === nothing || return namespace ? renamespace(sys, v) : v
else
sts = get_states(sys)
i = findfirst(x -> getname(x) == name, sts)
if i !== nothing
return namespace ? renamespace(sys, sts[i]) : sts[i]
end
if has_ps(sys)
ps = get_ps(sys)
i = findfirst(x -> getname(x) == name, ps)
if i !== nothing
return namespace ? renamespace(sys, ps[i]) : ps[i]
end
end
end
sts = get_states(sys)
i = findfirst(x -> getname(x) == name, sts)
if i !== nothing
return namespace ? renamespace(sys, sts[i]) : sts[i]
end
if has_observed(sys)
obs = get_observed(sys)
i = findfirst(x -> getname(x.lhs) == name, obs)
if i !== nothing
return namespace ? renamespace(sys, obs[i].lhs) : obs[i].lhs
end
end
throw(ArgumentError("System $(nameof(sys)): variable $name does not exist"))
end
function Base.setproperty!(sys::AbstractSystem, prop::Symbol, val)
# We use this weird syntax because `parameters` and `states` calls are
# potentially expensive.
if (params = parameters(sys);
idx = findfirst(s -> getname(s) == prop, params);
idx !== nothing)
get_defaults(sys)[params[idx]] = value(val)
elseif (sts = states(sys);
idx = findfirst(s -> getname(s) == prop, sts);
idx !== nothing)
get_defaults(sys)[sts[idx]] = value(val)
else
setfield!(sys, prop, val)
end
end
abstract type SymScope end
struct LocalScope <: SymScope end
LocalScope(sym::Union{Num, Symbolic}) = setmetadata(sym, SymScope, LocalScope())
struct ParentScope <: SymScope
parent::SymScope
end
function ParentScope(sym::Union{Num, Symbolic})
setmetadata(sym, SymScope, ParentScope(getmetadata(value(sym), SymScope, LocalScope())))
end
struct DelayParentScope <: SymScope
parent::SymScope
N::Int
end
function DelayParentScope(sym::Union{Num, Symbolic}, N)
setmetadata(sym, SymScope,
DelayParentScope(getmetadata(value(sym), SymScope, LocalScope()), N))
end
DelayParentScope(sym::Union{Num, Symbolic}) = DelayParentScope(sym, 1)
struct GlobalScope <: SymScope end
GlobalScope(sym::Union{Num, Symbolic}) = setmetadata(sym, SymScope, GlobalScope())
renamespace(sys, eq::Equation) = namespace_equation(eq, sys)
renamespace(names::AbstractVector, x) = foldr(renamespace, names, init = x)
function renamespace(sys, x)
sys === nothing && return x
x = unwrap(x)
if x isa Symbolic
if istree(x) && operation(x) isa Operator
return similarterm(x, operation(x), Any[renamespace(sys, only(arguments(x)))])
end
let scope = getmetadata(x, SymScope, LocalScope())
if scope isa LocalScope
rename(x, renamespace(getname(sys), getname(x)))
elseif scope isa ParentScope
setmetadata(x, SymScope, scope.parent)
elseif scope isa DelayParentScope
if scope.N > 0
x = setmetadata(x, SymScope,
DelayParentScope(scope.parent, scope.N - 1))
rename(x, renamespace(getname(sys), getname(x)))
else
#rename(x, renamespace(getname(sys), getname(x)))
setmetadata(x, SymScope, scope.parent)
end
else # GlobalScope
x
end
end
elseif x isa AbstractSystem
rename(x, renamespace(sys, nameof(x)))
else
Symbol(getname(sys), :₊, x)
end
end
namespace_variables(sys::AbstractSystem) = states(sys, states(sys))
namespace_parameters(sys::AbstractSystem) = parameters(sys, parameters(sys))
namespace_controls(sys::AbstractSystem) = controls(sys, controls(sys))
function namespace_defaults(sys)
defs = defaults(sys)
Dict((isparameter(k) ? parameters(sys, k) : states(sys, k)) => namespace_expr(defs[k],
sys)
for k in keys(defs))
end
function namespace_equations(sys::AbstractSystem)
eqs = equations(sys)
isempty(eqs) && return Equation[]
map(eq -> namespace_equation(eq, sys), eqs)
end
function namespace_equation(eq::Equation, sys, n = nameof(sys))
_lhs = namespace_expr(eq.lhs, sys, n)
_rhs = namespace_expr(eq.rhs, sys, n)
_lhs ~ _rhs
end
function namespace_assignment(eq::Assignment, sys)
_lhs = namespace_expr(eq.lhs, sys)
_rhs = namespace_expr(eq.rhs, sys)
Assignment(_lhs, _rhs)
end
function namespace_expr(O, sys, n = nameof(sys))
ivs = independent_variables(sys)
O = unwrap(O)
if any(isequal(O), ivs)
return O
elseif isvariable(O)
renamespace(n, O)
elseif istree(O)
renamed = map(a -> namespace_expr(a, sys, n), arguments(O))
if symtype(operation(O)) <: FnType
renamespace(n, O)
else
similarterm(O, operation(O), renamed)
end
elseif O isa Array
map(o -> namespace_expr(o, sys, n), O)
else
O
end
end
function states(sys::AbstractSystem)
sts = get_states(sys)
systems = get_systems(sys)
unique(isempty(systems) ?
sts :
[sts; reduce(vcat, namespace_variables.(systems))])
end
function parameters(sys::AbstractSystem)
ps = get_ps(sys)
systems = get_systems(sys)
unique(isempty(systems) ? ps : [ps; reduce(vcat, namespace_parameters.(systems))])
end
function controls(sys::AbstractSystem)
ctrls = get_ctrls(sys)
systems = get_systems(sys)
isempty(systems) ? ctrls : [ctrls; reduce(vcat, namespace_controls.(systems))]
end
function observed(sys::AbstractSystem)
obs = get_observed(sys)
systems = get_systems(sys)
[obs;
reduce(vcat,
(map(o -> namespace_equation(o, s), observed(s)) for s in systems),
init = Equation[])]
end
Base.@deprecate default_u0(x) defaults(x) false
Base.@deprecate default_p(x) defaults(x) false
function defaults(sys::AbstractSystem)
systems = get_systems(sys)
defs = get_defaults(sys)
# `mapfoldr` is really important!!! We should prefer the base model for
# defaults, because people write:
#
# `compose(ODESystem(...; defaults=defs), ...)`
#
# Thus, right associativity is required and crucial for correctness.
isempty(systems) ? defs : mapfoldr(namespace_defaults, merge, systems; init = defs)
end
states(sys::AbstractSystem, v) = renamespace(sys, v)
parameters(sys::AbstractSystem, v) = toparam(states(sys, v))
for f in [:states, :parameters]
@eval $f(sys::AbstractSystem, vs::AbstractArray) = map(v -> $f(sys, v), vs)
end
flatten(sys::AbstractSystem, args...) = sys
function equations(sys::ModelingToolkit.AbstractSystem)
eqs = get_eqs(sys)
systems = get_systems(sys)
if isempty(systems)
return eqs
else
eqs = Equation[eqs;
reduce(vcat,
namespace_equations.(get_systems(sys));
init = Equation[])]
return eqs
end
end
function preface(sys::ModelingToolkit.AbstractSystem)
has_preface(sys) || return nothing
pre = get_preface(sys)
systems = get_systems(sys)
if isempty(systems)
return pre
else
pres = pre === nothing ? [] : pre
for sys in systems
pre = get_preface(sys)
pre === nothing && continue
for eq in pre
push!(pres, namespace_assignment(eq, sys))
end
end
return isempty(pres) ? nothing : pres
end
end
function islinear(sys::AbstractSystem)
rhs = [eq.rhs for eq in equations(sys)]
all(islinear(r, states(sys)) for r in rhs)
end
function isaffine(sys::AbstractSystem)
rhs = [eq.rhs for eq in equations(sys)]
all(isaffine(r, states(sys)) for r in rhs)
end
function time_varying_as_func(x, sys::AbstractTimeDependentSystem)
# if something is not x(t) (the current state)
# but is `x(t-1)` or something like that, pass in `x` as a callable function rather
# than pass in a value in place of x(t).
#
# This is done by just making `x` the argument of the function.
if istree(x) &&
operation(x) isa Sym &&
!(length(arguments(x)) == 1 && isequal(arguments(x)[1], get_iv(sys)))
return operation(x)
end
return x
end
struct AbstractSysToExpr
sys::AbstractSystem
states::Vector
end
AbstractSysToExpr(sys) = AbstractSysToExpr(sys, states(sys))
function (f::AbstractSysToExpr)(O)
!istree(O) && return toexpr(O)
any(isequal(O), f.states) && return nameof(operation(O)) # variables
if isa(operation(O), Sym)
return build_expr(:call, Any[nameof(operation(O)); f.(arguments(O))])
end
return build_expr(:call, Any[operation(O); f.(arguments(O))])
end
###
### System utils
###
function push_vars!(stmt, name, typ, vars)
isempty(vars) && return
vars_expr = Expr(:macrocall, typ, nothing)
for s in vars
if istree(s)
f = nameof(operation(s))
args = arguments(s)
ex = :($f($(args...)))
else
ex = nameof(s)
end
push!(vars_expr.args, ex)
end
push!(stmt, :($name = $collect($vars_expr)))
return
end
function round_trip_expr(t, var2name)
name = get(var2name, t, nothing)
name !== nothing && return name
t isa Sym && return nameof(t)
istree(t) || return t
f = round_trip_expr(operation(t), var2name)
args = map(Base.Fix2(round_trip_expr, var2name), arguments(t))
return :($f($(args...)))
end
function round_trip_eq(eq::Equation, var2name)
if eq.lhs isa Connection
syss = get_systems(eq.rhs)
call = Expr(:call, connect)
for sys in syss
strs = split(string(nameof(sys)), "₊")
s = Symbol(strs[1])
for st in strs[2:end]
s = Expr(:., s, Meta.quot(Symbol(st)))
end
push!(call.args, s)
end
call
else
Expr(:call, (~), round_trip_expr(eq.lhs, var2name),
round_trip_expr(eq.rhs, var2name))
end
end
function push_eqs!(stmt, eqs, var2name)
eqs_name = gensym(:eqs)
eqs_expr = Expr(:vcat)
eqs_blk = Expr(:(=), eqs_name, eqs_expr)
for eq in eqs
push!(eqs_expr.args, round_trip_eq(eq, var2name))
end
push!(stmt, eqs_blk)
return eqs_name
end
function push_defaults!(stmt, defs, var2name)
defs_name = gensym(:defs)
defs_expr = Expr(:call, Dict)
defs_blk = Expr(:(=), defs_name, defs_expr)
for d in defs
n = round_trip_expr(d.first, var2name)
v = round_trip_expr(d.second, var2name)
push!(defs_expr.args, :($(=>)($n, $v)))
end
push!(stmt, defs_blk)
return defs_name
end
###
### System I/O
###
function toexpr(sys::AbstractSystem)
sys = flatten(sys)
expr = Expr(:block)
stmt = expr.args
name = Meta.quot(nameof(sys))
ivs = independent_variables(sys)
ivname = gensym(:iv)
for iv in ivs
ivname = gensym(:iv)
push!(stmt, :($ivname = (@variables $(getname(iv)))[1]))
end
stsname = gensym(:sts)
sts = states(sys)
push_vars!(stmt, stsname, Symbol("@variables"), sts)
psname = gensym(:ps)
ps = parameters(sys)
push_vars!(stmt, psname, Symbol("@parameters"), ps)
var2name = Dict{Any, Symbol}()
for v in Iterators.flatten((sts, ps))
var2name[v] = getname(v)
end
eqs_name = push_eqs!(stmt, equations(sys), var2name)
defs_name = push_defaults!(stmt, defaults(sys), var2name)
if sys isa ODESystem
iv = get_iv(sys)
ivname = gensym(:iv)
push!(stmt, :($ivname = (@variables $(getname(iv)))[1]))
push!(stmt,
:($ODESystem($eqs_name, $ivname, $stsname, $psname; defaults = $defs_name,
name = $name, checks = false)))
elseif sys isa NonlinearSystem
push!(stmt,
:($NonlinearSystem($eqs_name, $stsname, $psname; defaults = $defs_name,
name = $name, checks = false)))
end
striplines(expr) # keeping the line numbers is never helpful
end
Base.write(io::IO, sys::AbstractSystem) = write(io, readable_code(toexpr(sys)))
function get_or_construct_tearing_state(sys)
if has_tearing_state(sys)
state = get_tearing_state(sys)
if state === nothing
state = TearingState(sys)
end
else
state = nothing
end
state
end
# TODO: what about inputs?
function n_extra_equations(sys::AbstractSystem)
isconnector(sys) && return length(get_states(sys))
sys, csets = generate_connection_set(sys)
ceqs, instream_csets = generate_connection_equations_and_stream_connections(csets)
n_outer_stream_variables = 0
for cset in instream_csets
n_outer_stream_variables += count(x -> x.isouter, cset.set)
end
#n_toplevel_unused_flows = 0
#toplevel_flows = Set()
#for cset in csets
# e1 = first(cset.set)
# e1.sys.namespace === nothing || continue
# for e in cset.set
# get_connection_type(e.v) === Flow || continue
# push!(toplevel_flows, e.v)
# end
#end
#for m in get_systems(sys)
# isconnector(m) || continue
# n_toplevel_unused_flows += count(x->get_connection_type(x) === Flow && !(x in toplevel_flows), get_states(m))
#end
nextras = n_outer_stream_variables + length(ceqs)
end
function Base.show(io::IO, mime::MIME"text/plain", sys::AbstractSystem)
eqs = equations(sys)
vars = states(sys)
nvars = length(vars)
if eqs isa AbstractArray && eltype(eqs) <: Equation
neqs = count(eq -> !(eq.lhs isa Connection), eqs)
Base.printstyled(io, "Model $(nameof(sys)) with $neqs "; bold = true)
nextras = n_extra_equations(sys)
if nextras > 0
Base.printstyled(io, "("; bold = true)
Base.printstyled(io, neqs + nextras; bold = true, color = :magenta)
Base.printstyled(io, ") "; bold = true)
end
Base.printstyled(io, "equations\n"; bold = true)
else
Base.printstyled(io, "Model $(nameof(sys))\n"; bold = true)
end
# The reduced equations are usually very long. It's not that useful to print
# them.
#Base.print_matrix(io, eqs)
#println(io)
rows = first(displaysize(io)) ÷ 5
limit = get(io, :limit, false)
Base.printstyled(io, "States ($nvars):"; bold = true)
nrows = min(nvars, limit ? rows : nvars)
limited = nrows < length(vars)
defs = has_defaults(sys) ? defaults(sys) : nothing
for i in 1:nrows
s = vars[i]
print(io, "\n ", s)
if defs !== nothing
val = get(defs, s, nothing)
if val !== nothing
print(io, " [defaults to ")
show(IOContext(io, :compact => true, :limit => true,
:displaysize => (1, displaysize(io)[2])), val)
print(io, "]")
end
description = getdescription(s)
if description !== nothing && description != ""
print(io, ": ", description)
end
end
end
limited && print(io, "\n⋮")
println(io)
vars = parameters(sys)
nvars = length(vars)
Base.printstyled(io, "Parameters ($nvars):"; bold = true)
nrows = min(nvars, limit ? rows : nvars)
limited = nrows < length(vars)
for i in 1:nrows
s = vars[i]
print(io, "\n ", s)
if defs !== nothing
val = get(defs, s, nothing)
if val !== nothing
print(io, " [defaults to ")
show(IOContext(io, :compact => true, :limit => true,
:displaysize => (1, displaysize(io)[2])), val)
print(io, "]")
end
description = getdescription(s)
if description !== nothing && description != ""
print(io, ": ", description)
end
end
end
limited && print(io, "\n⋮")
if has_torn_matching(sys) && has_tearing_state(sys)
# If the system can take a torn matching, then we can initialize a tearing
# state on it. Do so and get show the structure.
state = get_tearing_state(sys)
if state !== nothing
Base.printstyled(io, "\nIncidence matrix:"; color = :magenta)
show(io, mime, incidence_matrix(state.structure.graph, Num(Sym{Real}(:×))))
end
end
return nothing
end
function split_assign(expr)
if !(expr isa Expr && expr.head === :(=) && expr.args[2].head === :call)
throw(ArgumentError("expression should be of the form `sys = foo(a, b)`"))
end
name, call = expr.args
end
function _named(name, call, runtime = false)
has_kw = false
call isa Expr || throw(Meta.ParseError("The rhs must be an Expr. Got $call."))
if length(call.args) >= 2 && call.args[2] isa Expr
# canonicalize to use `:parameters`
if call.args[2].head === :kw
call.args[2] = Expr(:parameters, Expr(:kw, call.args[2].args...))
has_kw = true
elseif call.args[2].head === :parameters
has_kw = true
end
end
if !has_kw
param = Expr(:parameters)
if length(call.args) == 1
push!(call.args, param)
else
insert!(call.args, 2, param)
end
end
is_sys_construction = gensym("###__is_system_construction###")
kws = call.args[2].args
for (i, kw) in enumerate(kws)
if Meta.isexpr(kw, (:(=), :kw))
kw.args[2] = :($is_sys_construction ? $(kw.args[2]) :
$default_to_parentscope($(kw.args[2])))
elseif kw isa Symbol
rhs = :($is_sys_construction ? $(kw) : $default_to_parentscope($(kw)))
kws[i] = Expr(:kw, kw, rhs)
end
end
if !any(kw -> (kw isa Symbol ? kw : kw.args[1]) == :name, kws) # don't overwrite `name` kwarg
pushfirst!(kws, Expr(:kw, :name, runtime ? name : Meta.quot(name)))
end
op = call.args[1]
quote
$is_sys_construction = ($op isa $DataType) && ($op <: $AbstractSystem)
$call
end
end
function _named_idxs(name::Symbol, idxs, call)
if call.head !== :->
throw(ArgumentError("Not an anonymous function"))
end
if !isa(call.args[1], Symbol)
throw(ArgumentError("not a single-argument anonymous function"))
end
sym, ex = call.args
ex = Base.Cartesian.poplinenum(ex)
ex = _named(:(Symbol($(Meta.quot(name)), :_, $sym)), ex, true)
ex = Base.Cartesian.poplinenum(ex)
:($name = $map($sym -> $ex, $idxs))
end
function check_name(name)
name isa Symbol ||
throw(Meta.ParseError("The lhs must be a symbol (a) or a ref (a[1:10]). Got $name."))
end
"""
@named y = foo(x)
@named y[1:10] = foo(x)
@named y 1:10 i -> foo(x*i) # This is not recommended
Pass the LHS name to the model. When it's calling anything that's not an
AbstractSystem, it wraps all keyword arguments in `default_to_parentscope` so
that namespacing works intuitively when passing a symbolic default into a
component.
Examples:
```julia-repl
julia> using ModelingToolkit
julia> foo(i; name) = (; i, name)
foo (generic function with 1 method)
julia> x = 41
41
julia> @named y = foo(x)
(i = 41, name = :y)
julia> @named y[1:3] = foo(x)
3-element Vector{NamedTuple{(:i, :name), Tuple{Int64, Symbol}}}:
(i = 41, name = :y_1)
(i = 41, name = :y_2)
(i = 41, name = :y_3)
```
"""
macro named(expr)
name, call = split_assign(expr)
if Meta.isexpr(name, :ref)
name, idxs = name.args
check_name(name)
var = gensym(name)
ex = quote
$var = $(_named(name, call))
$name = map(i -> $rename($var, Symbol($(Meta.quot(name)), :_, i)), $idxs)
end
esc(ex)
else
check_name(name)
esc(:($name = $(_named(name, call))))
end
end
macro named(name::Symbol, idxs, call)
esc(_named_idxs(name, idxs, call))
end
function default_to_parentscope(v)
uv = unwrap(v)
uv isa Symbolic && !hasmetadata(uv, SymScope) ? ParentScope(v) : v
end
function _config(expr, namespace)
cn = Base.Fix2(_config, namespace)
if Meta.isexpr(expr, :.)
return :($getproperty($(map(cn, expr.args)...); namespace = $namespace))
elseif Meta.isexpr(expr, :function)
def = splitdef(expr)
def[:args] = map(cn, def[:args])
def[:body] = cn(def[:body])
combinedef(def)
elseif expr isa Expr && !isempty(expr.args)
return Expr(expr.head, map(cn, expr.args)...)
elseif Meta.isexpr(expr, :(=))
return Expr(:(=), map(cn, expr.args)...)
else
expr
end
end
"""
$(SIGNATURES)
Rewrite `@nonamespace a.b.c` to
`getvar(getvar(a, :b; namespace = false), :c; namespace = false)`.
This is the default behavior of `getvar`. This should be used when inheriting states from a model.
"""
macro nonamespace(expr)
esc(_config(expr, false))
end
"""
$(SIGNATURES)
Rewrite `@namespace a.b.c` to
`getvar(getvar(a, :b; namespace = true), :c; namespace = true)`.