/usr/share/octave/site/m/sundialsTB/cvodes/function_types/CVBandJacFn.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 | %CVBandJacFn - type for user provided banded Jacobian function.
%
% The function BJACFUN must be defined as
% FUNCTION [J, FLAG] = BJACFUN(T, Y, FY)
% and must return a matrix J corresponding to the banded Jacobian of f(t,y).
% The input argument FY contains the current value of f(t,y).
% If a user data structure DATA was specified in CVodeInit, then
% BJACFUN must be defined as
% FUNCTION [J, FLAG, NEW_DATA] = BJACFUN(T, Y, FY, DATA)
% If the local modifications to the user data structure are needed in
% other user-provided functions then, besides setting the matrix J,
% the BJACFUN function must also set NEW_DATA. Otherwise, it should
% set NEW_DATA=[] (do not set NEW_DATA = DATA as it would lead to
% unnecessary copying).
%
% The function BJACFUN must set FLAG=0 if successful, FLAG<0 if an
% unrecoverable failure occurred, or FLAG>0 if a recoverable error
% occurred.
%
% See also CVodeSetOptions
%
% See the CVODES user guide for more informaiton on the structure of
% a banded Jacobian.
%
% NOTE: BJACFUN is specified through the property JacobianFn to
% CVodeSetOptions and is used only if the property LinearSolver
% was set to 'Band'.
% Radu Serban <radu@llnl.gov>
% Copyright (c) 2005, The Regents of the University of California.
% $Revision: 1.2 $Date: 2011/06/01 20:44:05 $
|