(index ("ida-create-solver" 0) ("ida-reinit-solver" 2883) ("ida-destroy-solver" 3029) ("ida-solve" 3174) ("ida-yy" 3409) ("ida-yp" 3531) ("ida-get-last-order" 3664) ("ida-get-last-step" 3804) ("ida-get-num-steps" 3947) ("cvode-create-solver" 4093) ("cvode-reinit-solver" 6761) ("cvode-destroy-solver" 6915) ("cvode-solve" 7066) ("cvode-yy" 7307))
(def (sig (procedure "(ida-create-solver TSTART TSTOP VARIABLES DERIVATIVES RESIDUAL-MAIN [RESIDUAL-INIT] [RESIDUAL-EVENT] [EVENTS] [ALG-OR-DIFF]   [SUPPRESS] [IC] [USER-DATA] [RELTOL] [ABSTOL]) => IDA-SOLVER" (id ida-create-solver))) (p "Creates and initializes an object representing a problem to be solved with the IDA solver.") (p "Arguments " (tt "TSTART") " and " (tt "TSTOP") " must be real numbers that represent the beginning and end of the independent variable range.") (p "Arguments " (tt "VARIABLES") " and " (tt "DERIVATIVES") " must be SRFI-4 " (tt "f64vector") " objects that hold respectively the initial values and derivatives of the system variables.") (p "Argument " (tt "RESIDUAL-MAIN") " is used to compute the residual function " (tt "F") " and must be a procedure of the following form:") (pre "(LAMBDA T YY YP DATA)") (p "or") (pre "(LAMBDA T YY YP)") (p "depending on whether the " (tt "USER-DATA") " optional argument is set, where") (dl (dt (tt "T")) (dd "real-valued independent variable") (dt (tt "YY")) (dd "SRFI-4 " (tt "f64vector") " with current variable values") (dt (tt "YP")) (dd "SRFI-4 " (tt "f64vector") " with current variable derivatives") (dt (tt "DATA")) (dd "is a user data object (if set)")) (p "This procedure must return a SRFI-4 " (tt "f64vector") " containing the residual vector.") (p "Optional keyword argument " (tt "RESIDUAL-EVENT") " must be a procedure of the same form as " (tt "RESIDUAL-MAIN") ", which computes a rootfinding problem to be solved during the integration of the system. It is set only if argument " (tt "EVENTS") " is given.") (p "Optional keyword argument " (tt "EVENTS") " is an SRFI-4 " (tt "s32vector") " that is used for storage of root finding solutions. It must be given if " (tt "RESIDUAL-EVENT") " is given.") (p "Optional keyword argument " (tt "ALG-OR-DIFF") " must be an SRFI-4 " (tt "s32vector") " which indicates the algebraic and differential variables in the system. A value of 1 indiciates differential variable, and a value of 0 indicates an algebraic one. This is required if the " (tt "SUPPRESS") " argument is given and true.") (p "Optional keyword argument " (tt "SUPPRESS") " is a boolean flag that indicates whether algebraic variables must be suppressed in the local error test. If it is true (suppress), then the argument " (tt "ALG-OR-DIFF") " must be given.") (p "Optional keyword argument " (tt "IC") " is a boolean flag that indicates whether the solver must calculate consistent initial conditions, or whether it must use the initial conditions given by " (tt "VARIABLES") ".") (p "Optional keyword argument " (tt "USER-DATA") " is an object that will be passed as an additional argument to the residual functions.") (p "Optional keyword arguments " (tt "RELTOL") " and " (tt "ABSTOL") " specify relative and absolute error tolerance, respectively. These both default to 1e-4."))
(def (sig (procedure "(ida-reinit-solver IDA-SOLVER T0 Y0 YP0)" (id ida-reinit-solver))) (p "Re-initializes IDA for the solution of a problem."))
(def (sig (procedure "(ida-destroy-solver IDA-SOLVER)" (id ida-destroy-solver))) (p "Deallocates the memory associated with the given solver."))
(def (sig (procedure "(ida-solve IDA-SOLVER T)" (id ida-solve))) (p "Integrates the system over an interval in the independent variable. This procedure returns either when the given " (tt "T") " is reached, or when a root is found."))
(def (sig (procedure "(ida-yy IDA-SOLVER)" (id ida-yy))) (p "Returns the vector of current state values of the system."))
(def (sig (procedure "(ida-yp IDA-SOLVER)" (id ida-yp))) (p "Returns the vector of current state derivative values of the system."))
(def (sig (procedure "(ida-get-last-order IDA-SOLVER)" (id ida-get-last-order))) (p "Returns the order used during the last solver step."))
(def (sig (procedure "(ida-get-last-step IDA-SOLVER)" (id ida-get-last-step))) (p "Returns the steps size used during the last solver step."))
(def (sig (procedure "(ida-get-num-steps IDA-SOLVER)" (id ida-get-num-steps))) (p "Returns the cumulative number of steps taken by the solver."))
(def (sig (procedure "(cvode-create-solver TSTART TSTOP VARIABLES RHS-FN [LMM] [ITER] [EWT-FN] [EVENT-FN] [EVENTS] [USER-DATA] [RELTOL] [ABSTOL]) => CVODE-SOLVER" (id cvode-create-solver))) (p "Creates and initializes an object representing a problem to be solved with the CVODE solver.") (p "Arguments " (tt "TSTART") " and " (tt "TSTOP") " must be real numbers that represent the beginning and end of the independent variable range.") (p "Arguments " (tt "VARIABLES") " must be a SRFI-4 " (tt "f64vector") " object that holds the initial values of the system variables.") (p "Argument " (tt "RHS-FN") " is used to compute the right-hand side of the equations, and must be a procedure of the following form:") (pre "(LAMBDA T YY DATA)") (p "or") (pre "(LAMBDA T YY)") (p "depending on whether the " (tt "USER-DATA") " optional argument is set, where") (dl (dt (tt "T")) (dd "real-valued independent variable") (dt (tt "YY")) (dd "SRFI-4 " (tt "f64vector") " with current variable values") (dt (tt "DATA")) (dd "is a user data object (if set)")) (p "This procedure must return a SRFI-4 " (tt "f64vector") " containing the residual vector.") (p "Optional keyword argument " (tt "EWT-FN") " must be a procedure of the same form as " (tt "(LAMBDA YY)") ", which computes error weights for the system variables, and which can be used in place of relative and absolute error tolerance.") (p "Optional keyword argument " (tt "EVENT-FN") " must be a procedure of the same form as " (tt "RHS-FN") ", which computes a rootfinding problem to be solved during the integration of the system. It is set only if argument " (tt "EVENTS") " is given.") (p "Optional keyword argument " (tt "EVENTS") " is an SRFI-4 " (tt "s32vector") " that is used for storage of root finding solutions. It must be given if " (tt "EVENT-FN") " is given.") (p "Optional keyword argument " (tt "LMM") " specifies the linear multistep method to be used and can be one of " (tt "cvode-lmm/adams") " (default) or " (tt "cvode-lmm/bdf") ". " (tt "cvode-lmm/bdf") " is recommended for stiff problems.") (p "Optional keyword argument " (tt "ITER") " specifies the iteration type to be used and can be one of " (tt "cvode-iter/functional") " (default) or " (tt "cvode-iter/newton") ". " (tt "cvode-iter/newton") " is recommended for stiff problems.") (p "Optional keyword argument " (tt "USER-DATA") " is an object that will be passed as an additional argument to the residual functions.") (p "Optional keyword arguments " (tt "RELTOL") " and " (tt "ABSTOL") " specify relative and absolute error tolerance, respectively. These both default to 1e-4. They are only set of " (tt "EWT-FN") " is not specified."))
(def (sig (procedure "(cvode-reinit-solver CVODE-SOLVER T0 Y0 YP0)" (id cvode-reinit-solver))) (p "Re-initializes CVODE for the solution of a problem."))
(def (sig (procedure "(cvode-destroy-solver CVODE-SOLVER)" (id cvode-destroy-solver))) (p "Deallocates the memory associated with the given solver."))
(def (sig (procedure "(cvode-solve CVODE-SOLVER T)" (id cvode-solve))) (p "Integrates the system over an interval in the independent variable. This procedure returns either when the given " (tt "T") " is reached, or when a root is found."))
(def (sig (procedure "(cvode-yy CVODE-SOLVER)" (id cvode-yy))) (p "Returns the vector of current state values of the system."))
