/usr/share/octave/site/m/sundialsTB/kinsol/function_types/KINJacTimesVecFn.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 | %KINJacTimesVecFn - type for user provided Jacobian times vector function.
%
% The function JTVFUN must be defined as
% FUNCTION [JV, NEW_Y, FLAG] = JTVFUN(Y, V, NEW_Y)
% and must return a vector JV corresponding to the product of the
% Jacobian of f(y) with the vector v. On input, NEW_Y indicates if
% the iterate has been updated in the interim. JV must be update
% or reevaluated, if appropriate, unless NEW_Y=false. This flag must
% be reset by the user.
% If a user data structure DATA was specified in KINInit, then
% JTVFUN must be defined as
% FUNCTION [JV, NEW_Y, FLAG, NEW_DATA] = JTVFUN(Y, V, NEW_Y, DATA)
% If the local modifications to the user data structure are needed in
% other user-provided functions then, besides setting the vector JV, and
% flags NEW_Y and FLAG, 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).
%
% If successful, FLAG should be set to 0. If an error occurs, FLAG should
% be set to a nonzero value.
%
% See also KINSetOptions
%
% NOTE: JTVFUN is specified through the property JacobianFn to KINSetOptions
% and is used only if the property LinearSolver was set to 'GMRES' or 'BiCGStab'.
% Radu Serban <radu@llnl.gov>
% Copyright (c) 2005, The Regents of the University of California.
% $Revision: 1.2 $Date: 2011/06/01 21:01:10 $
|