This file is indexed.

/usr/share/octave/packages/ocs-0.1.3/tst/tst_theta_method.m is in octave-ocs 0.1.3-1build1.

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
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
## Copyright (C) 2006,2007,2008  Carlo de Falco            
##
## This file is part of:
## OCS - A Circuit Simulator for Octave
##
## OCS is free software; you can redistribute it and/or modify
## it under the terms of the GNU General Public License as published by
## the Free Software Foundation.
##
## This program is distributed in the hope that it will be useful,
## but WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
## GNU General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with this program (see the file LICENSE); if not,
## see <http://www.gnu.org/licenses/>.
##
## author: Carlo de Falco <cdf _AT_ users.sourceforge.net> 

## -*- texinfo -*-
##
## @deftypefn{Function File} {[@var{out},@var{niter}] =}  tst_theta_method @
## (@var{cirstruct},@var{x},@var{t},@var{tol},@
## @var{maxit},@var{theta},@var{pltvars},@
## @var{verbosity});
##
## Perform a transient simulation of the system described by
## @var{cirstruct} over the time interval @var{t} using the
## theta-method with parameter @var{theta}.
##
## The initial value for the state vector is computed by solving a
## steady state problem at @var{t}(1), with starting guess @var{x}.
##
## @var{tol} and @var{maxit} are parameters passed to
## @code{nls_newton_raphson}.
##
## The output @var{out} will contain the value of the state vector at
## each point of @var{t}.
##
## The optional parameter @var{verbosity} controls the amount of
## output produced: 
## 
## @itemize @minus 
## @item if verbosity(1) != 0, information on the progress
## of the algorithm are output at runtime
## @item if verbosity(2) != 0, the plot of the variables whose names
## are listed in @var{pltvars} is
## produced after the computation
## @end itemize
## 
## The optional output @var{niter} returns the number of Newton iterations
## needed to reach convergence.
## 
## @seealso{tst_backward_euler,tst_daspk,tst_odepkg,nls_newton_raphson}
##
## @end deftypefn

function [out, varargout] = tst_theta_method(outstruct,x,t,tol,maxit,\
					     theta,pltvars,verbosity)

  ## Check input
  ## FIXME: add input check!
  if ((nargin < 7) || (nargin > 8))
    error("tst_theta_method: wrong number of input parameters.");
  endif

  if ~exist("verbosity")
    verbosity = [0,0];
  elseif length(verbosity)<2
    verbosity(2) = 0;
  endif

  out = zeros(rows(x),columns(t));
  out(:,1) = x;

  if nargout > 1
    niter = zeros(length(t),1);
  endif
  
  if (verbosity(1))
    fprintf(1,"Initial value.\n");
  endif
  
  
  [A0,B,C] = asm_initialize_system(outstruct,x);
  
  [out(:,1),ii] = nls_stationary(outstruct,x,tol,maxit);  

  if nargout > 1
    niter(1) = ii;
  endif

  for it=2:length(t)
    
    if(verbosity)
      fprintf(1,"Timestep #%d.\n",it);
    endif


    [A1old,Jacold,resold] = asm_build_system(outstruct, out(:,it-1), t(it-1));
    
    JAC = @(x,A1,Jac,res) TSTTHETAFUNJAC1(outstruct, x, t(it-1), 
					  t(it), A0, B, theta, 
					  A1, Jac, res);
    RES = @(x,A1,Jac,res) TSTTHETAFUNRES1(outstruct, x, out(:,it-1), 
					  t(it-1), t(it), A0, B, C, 
					  resold, theta, A1, Jac, res);
    UPDT = @(x) TSTTHETAFUNUP1 (outstruct, x, t(it));
    
    [out(:,it),ii,resnrm] = nls_newton_raphson(out(:,it-1),RES,JAC,\ 
					       tol, maxit,verbosity(1),\ 
					       UPDT);
    
    if nargout > 1
      niter(it) = ii;
    endif
        
    if (verbosity(2))
      utl_plot_by_name(t(1:it),out(:,1:it),outstruct,pltvars);
      pause(.1);
    endif
    
    if exist("~/.stop_ocs","file")
      break
    end
  endfor

  if nargout > 1
    varargout{1} = niter;
  endif

endfunction

## Jacobian for transient problem
function lhs = TSTTHETAFUNJAC1(outstruct, x, t0, t1, A0, B, theta, A1, Jac, res)

  DT = t1-t0;
  if ( nargin < 10 )
    [A1,Jac,res] = asm_build_system(outstruct,x,t1); 
  endif
  lhs = ( (A0+A1)/DT + theta*(B + Jac) ); 

endfunction
## Residual for transient problem
function rhs = TSTTHETAFUNRES1(outstruct, x, xold, t0, t1, A0, B, C, 
			       resold, theta, A1, Jac, res)
  DT = t1-t0;
  if ( nargin < 13 )
    [A1,Jac,res] = asm_build_system(outstruct,x,t1); 
  endif
  rhs = ( (A1+A0)*(x-xold)/DT  + theta * (res + C + B*x) + 
	 (1-theta) * (resold + C + B*xold) );

endfunction
## Update for transient problem
function update = TSTTHETAFUNUP1(outstruct,x,t1)

  [A1,Jac,res] = asm_build_system(outstruct,x,t1);
  update = {A1,Jac,res};

endfunction