Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
package owl-ode
Legend:
Library
Module
Module type
Parameter
Class
Class type
Library
Module
Module type
Parameter
Class
Class type
type state = Owl_dense_matrix_d.mat * Owl_dense_matrix_d.matstate is the type of the state (and thus also of the initial condition) provided to Owl_ode_base.Ode.odeint. For example Owl.Mat.mat.
type f =
(Owl_dense_matrix_d.mat * Owl_dense_matrix_d.mat) ->
float ->
Owl_dense_matrix_d.matf is type of the evolution function. For example, in the case of sympletic solvers, type state = Owl.Mat.(mat*mat) and type f = state -> float -> Owl.Mat.mat.
type step_output = (Owl_dense_matrix_d.mat * Owl_dense_matrix_d.mat) * floatstep_output defines the type of the output of Owl_ode.Ode.step. For example, in the case of native adaptive solvers, type output = Owl.Mat.(mat * float * float * bool), corresponds to matrices and floats that contain respectively the y1, t1, dt, and whether this step was valid
type solve_output =
Owl_dense_matrix_d.mat * Owl_dense_matrix_d.mat * Owl_dense_matrix_d.matsolve_output defines the type of the output of Owl_ode.Ode.odeint. For example, in the case of sympletc solvers, type output = Owl.Mat.(mat * mat * mat), corresponds to matrices that contain respectively the time, position, and momentum coordinates of the integrated solution
val step : f -> dt:float -> state -> float -> step_outputstep f dt y0 t0 () solves for one step given dt, y0, t0 and the evolution function. Several such functions have already been implemented in this library and can be used as reference.
val solve : f -> state -> Owl_ode_base.Types.tspec -> unit -> solve_outputsolve f y0 tspec () solves the initial value problem
∂ₜ y = f(y, t) y(t₀) = y₀
with the given evolution function f, initial condition y0, and temporal specification tspec, and returns the desired outputs of type output. Several such functions have already been implemented in this library and can be used as reference.