/usr/share/octave/site/m/sundialsTB/cvodes/function_types/CVGlocalFnB.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 | %CVGlocalFnB - type for user provided RHS approximation function (BBDPre) for backward problems.
%
% The function GLOCFUNB must be defined either as
% FUNCTION [GLOCB, FLAG] = GLOCFUNB(T,Y,YB)
% or as
% FUNCTION [GLOCB, FLAG, NEW_DATA] = GLOCFUNB(T,Y,YB,DATA)
% depending on whether a user data structure DATA was specified in
% CVodeInit. In either case, it must return the vector GLOCB
% corresponding to an approximation to fB(t,y,yB).
%
% The function GLOCFUNB must set FLAG=0 if successful, FLAG<0 if an
% unrecoverable failure occurred, or FLAG>0 if a recoverable error
% occurred.
%
% See also CVGcommFnB, CVodeSetOptions
%
% NOTE: GLOCFUNB is specified through the GlocalFn property in CVodeSetOptions
% and is used only if the property PrecModule is set to 'BBDPre'.
% 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 $
|