diff --git a/src/problems/analytical_problems.jl b/src/problems/analytical_problems.jl index 937475df4..c7b4a8f57 100644 --- a/src/problems/analytical_problems.jl +++ b/src/problems/analytical_problems.jl @@ -41,12 +41,14 @@ end Holds information on what variables to alias when solving an AnalyticalProblem. Conforms to the AbstractAliasSpecifier interface. - AnalyticalAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing) + `AnalyticalAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)` +When a keyword argument is `nothing`, the default behaviour of the solver is used. + ### Keywords * `alias_p::Union{Bool, Nothing}` * `alias_f::Union{Bool, Nothing}` -* `alias_u0::Union{Bool, Nothing}`: alias the u0 array. Defaults to false . +* `alias_u0::Union{Bool, Nothing}`: alias the u0 array. * `alias_du0::Union{Bool, Nothing}`: alias the du0 array for DAEs. Defaults to false. * `alias_tstops::Union{Bool, Nothing}`: alias the tstops array * `alias::Union{Bool, Nothing}`: sets all fields of the `AnalyticalAliasSpecifier` to `alias` diff --git a/src/problems/bvp_problems.jl b/src/problems/bvp_problems.jl index 20536e2cd..a493807aa 100644 --- a/src/problems/bvp_problems.jl +++ b/src/problems/bvp_problems.jl @@ -453,7 +453,9 @@ end Holds information on what variables to alias when solving an BVP. Conforms to the AbstractAliasSpecifier interface. - BVPAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing) + `BVPAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/dae_problems.jl b/src/problems/dae_problems.jl index 2881f22ab..c613722e5 100644 --- a/src/problems/dae_problems.jl +++ b/src/problems/dae_problems.jl @@ -134,7 +134,9 @@ end Holds information on what variables to alias when solving a DAE. Conforms to the AbstractAliasSpecifier interface. - DAEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing) + `DAEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/dde_problems.jl b/src/problems/dde_problems.jl index 88bc5c926..9441ad264 100644 --- a/src/problems/dde_problems.jl +++ b/src/problems/dde_problems.jl @@ -409,7 +409,9 @@ end Holds information on what variables to alias when solving a DDE. Conforms to the AbstractAliasSpecifier interface. - DDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing) + `DDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/discrete_problems.jl b/src/problems/discrete_problems.jl index fbf10949b..f8b89e258 100644 --- a/src/problems/discrete_problems.jl +++ b/src/problems/discrete_problems.jl @@ -165,7 +165,9 @@ end Holds information on what variables to alias when solving a DiscreteProblem. Conforms to the AbstractAliasSpecifier interface. - DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing) + `DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/implicit_discrete_problems.jl b/src/problems/implicit_discrete_problems.jl index 6179219c5..7d116da45 100644 --- a/src/problems/implicit_discrete_problems.jl +++ b/src/problems/implicit_discrete_problems.jl @@ -131,7 +131,9 @@ end Holds information on what variables to alias when solving an ODE. Conforms to the AbstractAliasSpecifier interface. - DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing) + `DiscreteAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/integral_problems.jl b/src/problems/integral_problems.jl index 4b41f0854..d04ad5e2d 100644 --- a/src/problems/integral_problems.jl +++ b/src/problems/integral_problems.jl @@ -177,7 +177,9 @@ end Holds information on what variables to alias when solving an IntegralProblem. Conforms to the AbstractAliasSpecifier interface. - IntegralAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing) + `IntegralAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)`` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/linear_problems.jl b/src/problems/linear_problems.jl index 44a9acbe2..873cf11be 100644 --- a/src/problems/linear_problems.jl +++ b/src/problems/linear_problems.jl @@ -83,8 +83,11 @@ struct LinearAliasSpecifier <: AbstractAliasSpecifier end @doc doc""" - Holds information on what variables to alias +Holds information on what variables to alias when solving a LinearProblem. Conforms to the AbstractAliasSpecifier interface. + `LinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_A = nothing, alias_b = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords diff --git a/src/problems/nonlinear_problems.jl b/src/problems/nonlinear_problems.jl index bfbf50671..01b1ff881 100644 --- a/src/problems/nonlinear_problems.jl +++ b/src/problems/nonlinear_problems.jl @@ -558,15 +558,17 @@ struct NonlinearAliasSpecifier <: AbstractAliasSpecifier end @doc doc""" - Holds information on what variables to alias when solving a `NonlinearProblem`. +Holds information on what variables to alias when solving a `NonlinearProblem`. Conforms to the AbstractAliasSpecifier interface. + `NonlinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` * `alias_f::Union{Bool, Nothing}` -* `alias_A::Union{Bool, Nothing}`: alias the `A` array. -* `alias_b::Union{Bool, Nothing}`: alias the `b` array. +* `alias_u0::Union{Bool, Nothing}`: alias the `u0` array. * `alias::Union{Bool, Nothing}`: sets all fields of the `NonlinearAliasSpecifier` to `alias`. """ function NonlinearAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias = nothing) diff --git a/src/problems/ode_problems.jl b/src/problems/ode_problems.jl index 81574834e..bd9885b80 100644 --- a/src/problems/ode_problems.jl +++ b/src/problems/ode_problems.jl @@ -525,7 +525,9 @@ end Holds information on what variables to alias when solving an ODE. Conforms to the AbstractAliasSpecifier interface. - ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing) + `ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/optimization_problems.jl b/src/problems/optimization_problems.jl index aad085f08..74a66b3a3 100644 --- a/src/problems/optimization_problems.jl +++ b/src/problems/optimization_problems.jl @@ -166,7 +166,7 @@ end Holds information on what variables to alias when solving an OptimizationProblem. Conforms to the AbstractAliasSpecifier interface. - OptimizationAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias = nothing) + `OptimizationAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias = nothing)` ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/rode_problems.jl b/src/problems/rode_problems.jl index 05221cd0b..b7c63b3bd 100644 --- a/src/problems/rode_problems.jl +++ b/src/problems/rode_problems.jl @@ -105,7 +105,9 @@ end Holds information on what variables to alias when solving an RODEProblem. Conforms to the AbstractAliasSpecifier interface. - ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing) + `RODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = false, alias_du0 = false, alias_tstops = false, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/sdde_problems.jl b/src/problems/sdde_problems.jl index c2b4db2ac..38c212903 100644 --- a/src/problems/sdde_problems.jl +++ b/src/problems/sdde_problems.jl @@ -186,7 +186,9 @@ end Holds information on what variables to alias when solving an SDDEProblem. Conforms to the AbstractAliasSpecifier interface. - SDDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing) + `SDDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/sde_problems.jl b/src/problems/sde_problems.jl index 6596708df..4bfa93c56 100644 --- a/src/problems/sde_problems.jl +++ b/src/problems/sde_problems.jl @@ -225,7 +225,9 @@ end Holds information on what variables to alias when solving an SDEProblem. Conforms to the AbstractAliasSpecifier interface. - SDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_tstops = nothing, alias = nothing) + `SDEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_tstops = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}` diff --git a/src/problems/steady_state_problems.jl b/src/problems/steady_state_problems.jl index e8711f12f..0e025c854 100644 --- a/src/problems/steady_state_problems.jl +++ b/src/problems/steady_state_problems.jl @@ -134,7 +134,9 @@ end Holds information on what variables to alias when solving a SteadyStateProblem. Conforms to the AbstractAliasSpecifier interface. - ODEAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing) + `SteadyStateAliasSpecifier(;alias_p = nothing, alias_f = nothing, alias_u0 = nothing, alias_du0 = nothing, alias_tstops = nothing, alias = nothing)` + +When a keyword argument is `nothing`, the default behaviour of the solver is used. ### Keywords * `alias_p::Union{Bool, Nothing}`