/usr/share/octave/site/m/sundialsTB/idas/function_types/IDARootFn.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 | %IDARootFn - type for user provided root-finding function.
%
% The function ROOTFUN must be defined as
% FUNCTION [G, FLAG] = ROOTFUN(T,YY,YP)
% and must return a vector G corresponding to g(t,yy,yp).
% If a user data structure DATA was specified in IDAInit, then
% ROOTFUN must be defined as
% FUNCTION [G, FLAG, NEW_DATA] = ROOTFUN(T,YY,YP,DATA)
% If the local modifications to the user data structure are needed in
% other user-provided functions then, besides setting the vector G,
% the ROOTFUN 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 ROOTFUN must set FLAG=0 if successful, or FLAG~=0 if
% a failure occurred.
%
% See also IDASetOptions
%
% NOTE: ROOTFUN is specified through the RootsFn property in
% IDASetOptions and is used only if the property NumRoots is a
% positive integer.
% Radu Serban <radu@llnl.gov>
% Copyright (c) 2005, The Regents of the University of California.
% $Revision: 1.2 $Date: 2011/05/26 00:01:23 $
|