/usr/share/octave/site/m/sundialsTB/cvodes/CVodeQuadSetOptions.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 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 | function options = CVodeQuadSetOptions(varargin)
%CVodeQuadSetOptions creates an options structure for quadrature integration with CVODES.
%
% Usage: OPTIONS = CVodeQuadSetOptions('NAME1',VALUE1,'NAME2',VALUE2,...)
% OPTIONS = CVodeQuadSetOptions(OLDOPTIONS,'NAME1',VALUE1,...)
%
% OPTIONS = CVodeQuadSetOptions('NAME1',VALUE1,'NAME2',VALUE2,...) creates
% a CVODES options structure OPTIONS in which the named properties have
% the specified values. Any unspecified properties have default values.
% It is sufficient to type only the leading characters that uniquely
% identify the property. Case is ignored for property names.
%
% OPTIONS = CVodeQuadSetOptions(OLDOPTIONS,'NAME1',VALUE1,...) alters an
% existing options structure OLDOPTIONS.
%
% CVodeQuadSetOptions with no input arguments displays all property names
% and their possible values.
%
%CVodeQuadSetOptions properties
%(See also the CVODES User Guide)
%
%ErrControl - Error control strategy for quadrature variables [ {false} | true ]
% Specifies whether quadrature variables are included in the error test.
%RelTol - Relative tolerance for quadrature variables [ scalar {1e-4} ]
% Specifies the relative tolerance for quadrature variables. This parameter is
% used only if ErrControl = true.
%AbsTol - Absolute tolerance for quadrature variables [ scalar or vector {1e-6} ]
% Specifies the absolute tolerance for quadrature variables. This parameter is
% used only if ErrControl = true.
%
%SensDependent - Backward problem depending on sensitivities [ {false} | true ]
% Specifies whether the backward problem quadrature right-hand side depends
% on forward sensitivites. If TRUE, the right-hand side function provided for
% this backward problem must have the appropriate type (see CVQuadRhsFnB).
%
%
% See also
% CVodeQuadInit, CVodeQuadReInit.
% CVodeQuadInitB, CVodeQuadReInitB
% Radu Serban <radu@llnl.gov>
% Copyright (c) 2007, The Regents of the University of California.
% $Revision: 1.3 $Date: 2007/08/21 17:42:38 $
% If called without input and output arguments, print out the possible keywords
if (nargin == 0) && (nargout == 0)
fprintf(' ErrControl: [ {false} | true ]\n');
fprintf(' RelTol: [ positive scalar {1e-4} ]\n');
fprintf(' AbsTol: [ positive scalar or vector {1e-6} ]\n');
fprintf('\n');
fprintf(' SensDependent: [ {false} | true ]\n');
fprintf('\n');
return;
end
KeyNames = {
'ErrControl'
'RelTol'
'AbsTol'
'SensDependent'
};
options = cvm_options(KeyNames,varargin{:});
|