diff --git a/src/scimlfunctions.jl b/src/scimlfunctions.jl index e74af51a5..31fd0e0ce 100644 --- a/src/scimlfunctions.jl +++ b/src/scimlfunctions.jl @@ -289,9 +289,9 @@ the usage of `f`. These include: based on the sparsity pattern. Defaults to `nothing`, which means a color vector will be internally computed on demand when required. The cost of this operation is highly dependent on the sparsity pattern. -- `nlfunc`: a `NonlinearFunction` with signature `f(u, (u_tmp, _t, p)) = u_tmp`. - where `u` and `u_tmp` are of the same type as `u`, and `_t` is of the same type of t. - This will be used as the nonlinear function inside an implicit solver by specifying `u, u_tmp` and `_t` +- `nlprob`: a `NonlinearProblem` that solves `f(u, t, p) = u_tmp` + where the nonlinear parameters are the tuple `(t, u_tmp, p)`. + This will be used as the nonlinear problem inside an implicit solver by specifying `u, u_tmp` and `t` such that solving this function produces a solution to the implicit step of your solver. ## iip: In-Place vs Out-Of-Place @@ -406,7 +406,7 @@ numerically-defined functions. """ struct ODEFunction{iip, specialize, F, TMM, Ta, Tt, TJ, JVP, VJP, JP, SP, TW, TWt, WP, TPJ, O, TCV, SYS, - IProb, UIProb, IProbMap, IProbPmap, NLF} <: AbstractODEFunction{iip} + IProb, UIProb, IProbMap, IProbPmap, NLP} <: AbstractODEFunction{iip} f::F mass_matrix::TMM analytic::Ta @@ -427,7 +427,7 @@ struct ODEFunction{iip, specialize, F, TMM, Ta, Tt, TJ, JVP, VJP, JP, SP, TW, TW update_initializeprob!::UIProb initializeprobmap::IProbMap initializeprobpmap::IProbPmap - nlfunc::NLF + nlprob::NLP end @doc doc""" @@ -531,7 +531,7 @@ information on generating the SplitFunction from this symbolic engine. struct SplitFunction{ iip, specialize, F1, F2, TMM, C, Ta, Tt, TJ, JVP, VJP, JP, WP, SP, TW, TWt, TPJ, O, TCV, SYS, - IProb, UIProb, IProbMap, IProbPmap, NLF} <: AbstractODEFunction{iip} + IProb, UIProb, IProbMap, IProbPmap, NLP} <: AbstractODEFunction{iip} f1::F1 f2::F2 mass_matrix::TMM @@ -554,7 +554,7 @@ struct SplitFunction{ update_initializeprob!::UIProb initializeprobmap::IProbMap initializeprobpmap::IProbPmap - nlfunc::NLF + nlprob::NLP end @doc doc""" @@ -2433,7 +2433,7 @@ function ODEFunction{iip, specialize}(f; f.update_initializeprob! : nothing, initializeprobmap = __has_initializeprobmap(f) ? f.initializeprobmap : nothing, initializeprobpmap = __has_initializeprobpmap(f) ? f.initializeprobpmap : nothing, - nlfunc = __has_nlfunc(f) ? f.nlfunc : nothing, + nlprob = __has_nlprob(f) ? f.nlprob : nothing, ) where {iip, specialize } @@ -2495,7 +2495,7 @@ function ODEFunction{iip, specialize}(f; jvp, vjp, jac_prototype, sparsity, Wfact, Wfact_t, W_prototype, paramjac, observed, _colorvec, sys, initializeprob, update_initializeprob!, initializeprobmap, - initializeprobpmap, nlfunc) + initializeprobpmap, nlprob) elseif specialize === false ODEFunction{iip, FunctionWrapperSpecialize, typeof(_f), typeof(mass_matrix), typeof(analytic), typeof(tgrad), @@ -2508,12 +2508,12 @@ function ODEFunction{iip, specialize}(f; typeof(update_initializeprob!), typeof(initializeprobmap), typeof(initializeprobpmap), - typeof(nlfunc)}(_f, mass_matrix, + typeof(nlprob)}(_f, mass_matrix, analytic, tgrad, jac, jvp, vjp, jac_prototype, sparsity, Wfact, Wfact_t, W_prototype, paramjac, observed, _colorvec, sys, initializeprob, update_initializeprob!, - initializeprobmap, initializeprobpmap, nlfunc) + initializeprobmap, initializeprobpmap, nlprob) else ODEFunction{iip, specialize, typeof(_f), typeof(mass_matrix), typeof(analytic), typeof(tgrad), @@ -2525,11 +2525,11 @@ function ODEFunction{iip, specialize}(f; typeof(sys), typeof(initializeprob), typeof(update_initializeprob!), typeof(initializeprobmap), typeof(initializeprobpmap), - typeof(nlfunc)}(_f, mass_matrix, analytic, tgrad, jac, + typeof(nlprob)}(_f, mass_matrix, analytic, tgrad, jac, jvp, vjp, jac_prototype, sparsity, Wfact, Wfact_t, W_prototype, paramjac, observed, _colorvec, sys, initializeprob, update_initializeprob!, initializeprobmap, - initializeprobpmap, nlfunc) + initializeprobpmap, nlprob) end end @@ -2552,7 +2552,7 @@ function unwrapped_f(f::ODEFunction, newf = unwrapped_f(f.f)) f.Wfact_t, f.W_prototype, f.paramjac, f.observed, f.colorvec, f.sys, f.initializeprob, f.update_initializeprob!, f.initializeprobmap, - f.initializeprobpmap, f.nlfunc) + f.initializeprobpmap, f.nlprob) else ODEFunction{isinplace(f), specialization(f), typeof(newf), typeof(f.mass_matrix), typeof(f.analytic), typeof(f.tgrad), @@ -2563,11 +2563,11 @@ function unwrapped_f(f::ODEFunction, newf = unwrapped_f(f.f)) typeof(f.sys), typeof(f.initializeprob), typeof(f.update_initializeprob!), typeof(f.initializeprobmap), typeof(f.initializeprobpmap), - typeof(f.nlfunc)}(newf, f.mass_matrix, f.analytic, f.tgrad, f.jac, + typeof(f.nlprob)}(newf, f.mass_matrix, f.analytic, f.tgrad, f.jac, f.jvp, f.vjp, f.jac_prototype, f.sparsity, f.Wfact, f.Wfact_t, f.W_prototype, f.paramjac, f.observed, f.colorvec, f.sys, f.initializeprob, f.update_initializeprob!, - f.initializeprobmap, f.initializeprobpmap, f.nlfunc) + f.initializeprobmap, f.initializeprobpmap, f.nlprob) end end @@ -2670,7 +2670,7 @@ end @add_kwonly function SplitFunction(f1, f2, mass_matrix, cache, analytic, tgrad, jac, jvp, vjp, jac_prototype, W_prototype, sparsity, Wfact, Wfact_t, paramjac, observed, colorvec, sys, initializeprob, update_initializeprob!, - initializeprobmap, initializeprobpmap, nlfunc) + initializeprobmap, initializeprobpmap, nlprob) f1 = ODEFunction(f1) f2 = ODEFunction(f2) @@ -2685,11 +2685,11 @@ end typeof(vjp), typeof(jac_prototype), typeof(W_prototype), typeof(sparsity), typeof(Wfact), typeof(Wfact_t), typeof(paramjac), typeof(observed), typeof(colorvec), typeof(sys), typeof(initializeprob), typeof(update_initializeprob!), typeof(initializeprobmap), - typeof(initializeprobpmap), typeof(nlfunc)}( + typeof(initializeprobpmap), typeof(nlprob)}( f1, f2, mass_matrix, cache, analytic, tgrad, jac, jvp, vjp, jac_prototype, W_prototype, sparsity, Wfact, Wfact_t, paramjac, observed, colorvec, sys, - initializeprob, update_initializeprob!, initializeprobmap, initializeprobpmap, nlfunc) + initializeprob, update_initializeprob!, initializeprobmap, initializeprobpmap, nlprob) end function SplitFunction{iip, specialize}(f1, f2; mass_matrix = __has_mass_matrix(f1) ? @@ -2726,7 +2726,7 @@ function SplitFunction{iip, specialize}(f1, f2; f1.update_initializeprob! : nothing, initializeprobmap = __has_initializeprobmap(f1) ? f1.initializeprobmap : nothing, initializeprobpmap = __has_initializeprobpmap(f1) ? f1.initializeprobpmap : nothing, - nlfunc = __has_nlfunc(f1) ? f1.nlfunc : nothing + nlprob = __has_nlprob(f1) ? f1.nlprob : nothing ) where {iip, specialize } @@ -2742,7 +2742,7 @@ function SplitFunction{iip, specialize}(f1, f2; tgrad, jac, jvp, vjp, jac_prototype, W_prototype, sparsity, Wfact, Wfact_t, paramjac, observed, colorvec, sys, initializeprob.update_initializeprob!, initializeprobmap, - initializeprobpmap, initializeprobpmap, nlfunc) + initializeprobpmap, initializeprobpmap, nlprob) else SplitFunction{iip, specialize, typeof(f1), typeof(f2), typeof(mass_matrix), typeof(_func_cache), typeof(analytic), @@ -2752,11 +2752,11 @@ function SplitFunction{iip, specialize}(f1, f2; typeof(colorvec), typeof(sys), typeof(initializeprob), typeof(update_initializeprob!), typeof(initializeprobmap), - typeof(initializeprobpmap), typeof(nlfunc)}(f1, f2, + typeof(initializeprobpmap), typeof(nlprob)}(f1, f2, mass_matrix, _func_cache, analytic, tgrad, jac, jvp, vjp, jac_prototype, W_prototype, sparsity, Wfact, Wfact_t, paramjac, observed, colorvec, sys, - initializeprob, update_initializeprob!, initializeprobmap, initializeprobpmap, nlfunc) + initializeprob, update_initializeprob!, initializeprobmap, initializeprobpmap, nlprob) end end @@ -4389,7 +4389,7 @@ __has_initializeprob(f) = isdefined(f, :initializeprob) __has_update_initializeprob!(f) = isdefined(f, :update_initializeprob!) __has_initializeprobmap(f) = isdefined(f, :initializeprobmap) __has_initializeprobpmap(f) = isdefined(f, :initializeprobpmap) -__has_nlfunc(f) = isdefined(f, :nl_func) +__has_nlprob(f) = isdefined(f, :nlprob) # compatibility has_invW(f::AbstractSciMLFunction) = false