/usr/share/octave/site/m/sundialsTB/idas/function_types/IDAGcommFn.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 30 31 32 33 34 | %IDAGcommFn - type for communication function (BBDPre).
%
% The function GCOMFUN must be defined as
% FUNCTION FLAG = GCOMFUN(T, YY, YP)
% and can be used to perform all interprocess communication necessary
% to evaluate the approximate residual function for the BBDPre
% preconditioner module.
% If a user data structure DATA was specified in IDAInit, then
% GCOMFUN must be defined as
% FUNCTION [FLAG, NEW_DATA] = GCOMFUN(T, YY, YP, DATA)
% If the local modifications to the user data structure are needed
% in other user-provided functions then the GCOMFUN 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 GCOMFUN must set FLAG=0 if successful, FLAG<0 if an
% unrecoverable failure occurred, or FLAG>0 if a recoverable error
% occurred.
%
% See also IDAGlocalFn, IDASetOptions
%
% NOTES:
% GCOMFUN is specified through the GcommFn property in IDASetOptions
% and is used only if the property PrecModule is set to 'BBDPre'.
%
% Each call to GCOMFUN is preceded by a call to the residual function
% DAEFUN with the same arguments T, YY, and YP.
% Thus GCOMFUN can omit any communication done by DAEFUN if relevant
% to the evaluation of G by GLOCFUN. If all necessary communication
% was done by DAEFUN, GCOMFUN need not be provided.
% 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 $
|