@@ -1188,58 +1188,20 @@ Return the SciMLFunction created via calling `constructor`, the initial conditio
1188
1188
and parameter object `p` given the system `sys`, and user-provided initial values `u0map`
1189
1189
and `pmap`. `u0map` and `pmap` are converted into variable maps via [`to_varmap`](@ref).
1190
1190
1191
- The order of unknowns is determined by `unknowns(sys)`. If the system is split
1192
- [`is_split`](@ref) create an [`MTKParameters`](@ref) object. Otherwise, a parameter vector.
1193
- Initial values provided in terms of other variables will be symbolically evaluated using
1194
- [`evaluate_varmap!`](@ref). The type of `u0map` and `pmap` will be used to determine the
1195
- type of the containers (if parameters are not in an `MTKParameters` object). `Dict`s will be
1196
- turned into `Array`s.
1191
+ $U0_P_DOCS
1197
1192
1198
1193
This will also build the initialization problem and related objects and pass them to the
1199
1194
SciMLFunction as keyword arguments.
1200
1195
1201
1196
Keyword arguments:
1202
- - `build_initializeprob`: If `false`, avoids building the initialization problem.
1203
- - `t`: The initial time of the `ODEProblem`. If this is not provided, the initialization
1204
- problem cannot be built.
1197
+ $PROBLEM_KWARGS
1198
+ $PROBLEM_INTERNAL_KWARGS
1199
+ - `t`: The initial time of the `SciMLProblem`. This does not need to be provided for time-
1200
+ independent problems. If not provided for time-dependent problems, will be assumed as
1201
+ zero.
1205
1202
- `implicit_dae`: Also build a mapping of derivatives of states to values for implicit DAEs.
1206
- Changes the return value of this function to `(f, du0, u0, p)` instead of
1207
- `(f, u0, p)`.
1208
- - `guesses`: The guesses for variables in the system, used as initial values for the
1209
- initialization problem.
1210
- - `warn_initialize_determined`: Warn if the initialization system is under/over-determined.
1211
- - `initialization_eqs`: Extra equations to use in the initialization problem.
1212
- - `eval_expression`: Whether to compile any functions via `eval` or `RuntimeGeneratedFunctions`.
1213
- - `eval_module`: If `eval_expression == true`, the module to `eval` into. Otherwise, the module
1214
- in which to generate the `RuntimeGeneratedFunction`.
1215
- - `fully_determined`: Override whether the initialization system is fully determined.
1216
- - `check_initialization_units`: Enable or disable unit checks when constructing the
1217
- initialization problem.
1218
- - `tofloat`: Passed to [`varmap_to_vars`](@ref) when building the parameter vector of
1219
- a non-split system.
1220
- - `u0_eltype`: The `eltype` of the `u0` vector. If `nothing`, finds the promoted floating point
1221
- type from `op`.
1222
- - `u0_constructor`: A function to apply to the `u0` value returned from `varmap_to_vars`
1223
- to construct the final `u0` value.
1224
- - `p_constructor`: A function to apply to each array buffer created when constructing the parameter object.
1225
- - `check_length`: Whether to check the number of equations along with number of unknowns and
1226
- length of `u0` vector for consistency. If `false`, do not check with equations. This is
1227
- forwarded to `check_eqs_u0`
1203
+ Changes the return value of this function to `(f, du0, u0, p)` instead of `(f, u0, p)`.
1228
1204
- `symbolic_u0` allows the returned `u0` to be an array of symbolics.
1229
- - `warn_cyclic_dependency`: Whether to emit a warning listing out cycles in initial
1230
- conditions provided for unknowns and parameters.
1231
- - `circular_dependency_max_cycle_length`: Maximum length of cycle to check for.
1232
- Only applicable if `warn_cyclic_dependency == true`.
1233
- - `circular_dependency_max_cycles`: Maximum number of cycles to check for.
1234
- Only applicable if `warn_cyclic_dependency == true`.
1235
- - `substitution_limit`: The number times to substitute initial conditions into each
1236
- other to attempt to arrive at a numeric value.
1237
- - `use_scc`: Whether to use `SCCNonlinearProblem` for initialization if the system is fully
1238
- determined.
1239
- - `force_initialization_time_independent`: Whether to force the initialization to not use
1240
- the independent variable of `sys`.
1241
- - `algebraic_only`: Whether to build the initialization problem using only algebraic equations.
1242
- - `allow_incomplete`: Whether to allow incomplete initialization problems.
1243
1205
1244
1206
All other keyword arguments are passed as-is to `constructor`.
1245
1207
"""
0 commit comments