User does not pass real t and vector state to ode, ode solver does
Nobody has claimed this yet.
- Dominant language
- TeX
- Stars
- 43
- Forks
- 133
- Avg merge
- 11h 32m
- Merged PRs (30d)
- 4
Description
While real t and vector y (the state variable) must be coded into the first two parameters of the ode function, the user does not pass these to the ode function through the ode solver. Instead, the ode solver endogenously supplies them or builds them up. The vector y will match the initial conditions the user passes to the ode solver: y0, t0, ts.
There may be a better explanation than mine above, but having this in the docs will reduce confusion in knowing what to provide to the ode-function and solver-function pair.
The same explanation should be added to the functions reference in the section:
## Ordinary differential equation (ODE) solvers {#functions-ode-solver}
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the ODE explanation in src/stan-users-guide/odes.Rmd and the ODE solver section in src/functions-reference/higher-order_functions.Rmd. Clarify that the solver supplies the time and state arguments to the ODE function, while the user's initial conditions provide y0, t0, and ts. Done means both sections consistently explain what the user passes to each function.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100