/usr/share/octave/site/m/sundialsTB/idas/function_types/IDAGcommFnB.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 | %IDAGcommFnB - type for communication function (BBDPre) for backward problems.
%
% The function GCOMFUNB must be defined either as
% FUNCTION FLAG = GCOMFUNB(T, YY, YP, YYB, YPB)
% or as
% FUNCTION [FLAG, NEW_DATA] = GCOMFUNB(T, YY, YP, YYB, YPB, DATA)
% depending on whether a user data structure DATA was specified in
% IDAInit.
%
% The function GCOMFUNB must set FLAG=0 if successful, FLAG<0 if an
% unrecoverable failure occurred, or FLAG>0 if a recoverable error
% occurred.
%
% See also IDAGlocalFnB, IDAGcommFn, IDASetOptions
%
% NOTES:
% GCOMFUNB is specified through the GcommFn property in IDASetOptions
% and is used only if the property PrecModule is set to 'BBDPre'.
%
% Each call to GCOMFUNB is preceded by a call to the residual function
% DAEFUN with the same arguments T, YY, YP and YYB and YPB.
% Thus GCOMFUNB can omit any communication done by DAEFUNB if relevant
% to the evaluation of G by GLOCFUNB. If all necessary communication
% was done by DAEFUNB, GCOMFUNB need not be provided.
% Radu Serban <radu@llnl.gov>
% Copyright (c) 2007, The Regents of the University of California.
% $Revision: 1.2 $Date: 2011/05/26 00:01:23 $
|