/usr/share/octave/site/m/sundialsTB/idas/function_types/IDAJacTimesVecFn.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 | %IDAJacTimesVecFn - type for Jacobian times vector function.
%
% The function JTVFUN must be defined as
% FUNCTION [JV, FLAG] = JTVFUN(T,YY,YP,RR,V,CJ)
% and must return a vector JV corresponding to the product of the
% Jacobian ( df/dyy + cj * df/dyp ) with the vector v.
% The input argument RR contains the current value of f(t,yy,yp).
% If a user data structure DATA was specified in IDAInit, then
% JTVFUN must be defined as
% FUNCTION [JV, FLAG, NEW_DATA] = JTVFUN(T,YY,YP,RR,V,CJ,DATA)
% If the local modifications to the user data structure are needed in
% other user-provided functions then, besides setting the vector JV,
% the JTVFUN 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 JTVFUN must set FLAG=0 if successful, or FLAG~=0 if
% a failure occurred.
%
% See also IDASetOptions
%
% NOTE: JTVFUN is specified through the property JacobianFn to
% IDASetOptions and is used only if the property LinearSolver
% was set to 'GMRES', 'BiCGStab', or 'TFQMR'.
% Radu Serban <radu@llnl.gov>
% Copyright (c) 2007, The Regents of the University of California.
% $Revision: 1.3 $Date: 2011/05/26 00:01:23 $
|