Skip to content

Commit bb4baaf

Browse files
committed
Document more
1 parent a1269be commit bb4baaf

File tree

1 file changed

+23
-1
lines changed

1 file changed

+23
-1
lines changed

src/systems/abstractsystem.jl

Lines changed: 23 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1093,6 +1093,12 @@ function dependent_parameters(sys::AbstractSystem)
10931093
end
10941094
end
10951095

1096+
"""
1097+
$(TYPEDSIGNATURES)
1098+
Get the parameter dependencies of the system `sys` and its subsystems.
1099+
1100+
See also [`defaults`](@ref) and [`ModelingToolkit.get_parameter_dependencies`](@ref).
1101+
"""
10961102
function parameter_dependencies(sys::AbstractSystem)
10971103
pdeps = get_parameter_dependencies(sys)
10981104
if isnothing(pdeps)
@@ -1111,6 +1117,13 @@ function full_parameters(sys::AbstractSystem)
11111117
vcat(parameters(sys), dependent_parameters(sys))
11121118
end
11131119

1120+
"""
1121+
$(TYPEDSIGNATURES)
1122+
1123+
Get the guesses for variables in the initialization system of the system `sys` and its subsystems.
1124+
1125+
See also [`initialization_equations`](@ref) and [`ModelingToolkit.get_guesses`](@ref).
1126+
"""
11141127
function guesses(sys::AbstractSystem)
11151128
guess = get_guesses(sys)
11161129
systems = get_systems(sys)
@@ -1141,6 +1154,15 @@ end
11411154

11421155
Base.@deprecate default_u0(x) defaults(x) false
11431156
Base.@deprecate default_p(x) defaults(x) false
1157+
1158+
"""
1159+
$(TYPEDSIGNATURES)
1160+
1161+
Get the default values of the system sys and its subsystems.
1162+
If they are not explicitly provided, variables and parameters are initialized to these values.
1163+
1164+
See also [`initialization_equations`](@ref), [`parameter_dependencies`](@ref) and [`ModelingToolkit.get_defaults`](@ref).
1165+
"""
11441166
function defaults(sys::AbstractSystem)
11451167
systems = get_systems(sys)
11461168
defs = get_defaults(sys)
@@ -1199,7 +1221,7 @@ $(TYPEDSIGNATURES)
11991221
12001222
Get the initialization equations of the system `sys` and its subsystems.
12011223
1202-
See also [`ModelingToolkit.get_initialization_eqs`](@ref).
1224+
See also [`guesses`](@ref), [`defaults`](@ref), [`parameter_dependencies`](@ref) and [`ModelingToolkit.get_initialization_eqs`](@ref).
12031225
"""
12041226
function initialization_equations(sys::AbstractSystem)
12051227
eqs = get_initialization_eqs(sys)

0 commit comments

Comments
 (0)