/usr/share/octave/site/m/sundialsTB/cvodes/Contents.m is in octave-sundials 2.5.0-3+b1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 | % CVODES, an ODE integrator with sensitivity analysis capabilities
%
% The Matlab interface to the SUNDIALS solver CVODES provides access
% to all functionality of the underlying solver, including IVP simulation
% and sensitvity analysis (both forward and adjoint).
%
% The interface consists of several user-callable functions. In addition,
% the user must provide several required and optional user-supplied
% functions which define the problem to be solved. The user-callable
% functions and the types of user-supplied functions are listed below.
% For completness, some functions appear more than once.
%
% Functions for ODE integration
%
% CVodeSetOptions - create an options structure for an ODE problem.
% CVodeQuadSetOptions - create an options structure for quadrature integration.
% CVodeInit - allocate and initialize memory for CVODES.
% CVodeQuadInit - allocate and initialize memory for quadrature integration.
% CVodeReInit - reinitialize memory for CVODES.
% CVodeQuadReInit - reinitialize memory for quadrature integration.
% CVode - integrate the ODE problem.
% CVodeGetStats - return statistics for the CVODES solver.
% CVodeGet - extract data from CVODES memory.
% CVodeFree - deallocate memory for the CVODES solver.
%
% Functions for forward sensitivity analysis
%
% CVodeSetOptions - create an options structure for an ODE problem.
% CVodeQuadSetOptions - create an options structure for quadrature integration.
% CVodeSensSetOptions - create an options structure for FSA.
% CVodeInit - allocate and initialize memory for CVODES.
% CVodeQuadInit - allocate and initialize memory for quadrature integration.
% CVodeSensInit - allocate and initialize memory for FSA.
% CVodeReInit - reinitialize memory for CVODES.
% CVodeQuadReInit - reinitialize memory for quadrature integration.
% CVodeSensReInit - reinitialize memory for FSA.
% CVodeSensToggleOff - temporarily deactivates FSA.
% CVode - integrate the ODE problem.
% CVodeGetStats - return statistics for the CVODES solver.
% CVodeGet - extract data from CVODES memory.
% CVodeFree - deallocate memory for the CVODES solver.
%
% Functions for adjoint sensitivity analysis
%
% CVodeSetOptions - create an options structure for an ODE problem.
% CVodeQuadSetOptions - create an options structure for quadrature integration.
% CVodeInit - allocate and initialize memory for the forward problem.
% CVodeQuadInit - allocate and initialize memory for forward quadrature integration.
% CVodeQuadReInit - reinitialize memory for forward quadrature integration.
% CVodeReInit - reinitialize memory for the forward problem.
% CVodeAdjInit - allocate and initialize memory for ASA.
% CVodeInitB - allocate and initialize a backward problem.
% CVodeAdjReInit - reinitialize memory for ASA.
% CVodeReInitB - reinitialize a backward problem.
% CVode - integrate the forward ODE problem.
% CVodeB - integrate the backward problems.
% CVodeGetStats - return statistics for the integration of the forward problem.
% CVodeGetStatsB - return statistics for the integration of a backward problem.
% CVodeGet - extract data from CVODES memory.
% CVodeFree - deallocate memory for the CVODES solver.
%
% User-supplied function types for forward problems
%
% CVRhsFn - RHS function
% CVRootFn - root-finding function
% CVQuadRhsFn - quadrature RHS function
% CVSensRhsFn - sensitivity RHS function
% CVDenseJacFn - dense Jacobian function
% CVBandJacFn - banded Jacobian function
% CVJacTimesVecFn - Jacobian times vector function
% CVPrecSetupFn - preconditioner setup function
% CVPrecSolveFn - preconditioner solve function
% CVGlocalFn - RHS approximation function (BBDPre)
% CVGcomFn - communication function (BBDPre)
% CVMonitorFn - monitoring function
%
% User-supplied function types for backward problems
%
% CVRhsFnB - RHS function
% CVQuadRhsFnB - quadrature RHS function
% CVDenseJacFnB - dense Jacobian function
% CVBandJacFnB - banded Jacobian function
% CVJacTimesVecFnB - Jacobian times vector function
% CVPrecSetupFnB - preconditioner setup function
% CVPrecSolveFnB - preconditioner solve function
% CVGlocalFnB - RHS approximation function (BBDPre)
% CVGcomFnB - communication function (BBDPre)
% CVMonitorFnB - monitoring function
%
% Serial examples provided with the toolbox
%
% mcvsRoberts_dns - chemical kinetics problem
% mcvsRoberts_FSA_dns - FSA for the robertson problem
% mcvsRoberts_ASAi_dns - ASA for the robertson problem
% mcvsAdvDiff_bnd - advection-diffusion PDE
% mcvsDiurnal_kry - 2D, 2-species, time dependent PDE
% mcvsPleiades_non - nonstiff celestial mechanics problem
% mcvsVanDPol_dns - Van der Pol problem
% mcvsPollut_FSA_dns - FSA for pollution chemical kinetics
% mcvsOzone_FSA_dns - FSA for ozone chemical kinetics
% mcvsDiscRHS_dns - integration over RHS discontinuities
% mcvsDiscSOL_dns - integration over solution discontinuities
% mcvsHessian_FSA_ASA - illustration for computing Hessian information
% (forward-over-adjoint approach)
%
% Parallel examples provided with the toolbox
%
% mcvsDecoupl_non_p - diagonal ODE example
% mcvsAdvDiff_FSA_non_p - FSA for 1D adv-diff problem (Adams, Functional)
% mcvsAtmDisp_kry_bbd_p - 3D adv-diff with distributed source problem
% (BDF, Newton, GMRES, BBDPre preconditioner)
% Use the mpirun function to run any of the parallel examples
%
% See also nvector, putils
|