ViewVC logotype

Contents of /trunk/doc/user/changes.tex

Parent Directory Parent Directory | Revision Log Revision Log

Revision 2540 - (show annotations)
Mon Jul 20 00:09:55 2009 UTC (10 years, 1 month ago) by jfenwick
File MIME type: application/x-tex
File size: 3406 byte(s)
Deprecating pyvisi in the user guide.
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %
4 % Copyright (c) 2009 by University of Queensland
5 % Earth Systems Science Computational Center (ESSCC)
6 % http://www.uq.edu.au/esscc
7 %
8 % Primary Business: Queensland, Australia
9 % Licensed under the Open Software License version 3.0
10 % http://www.opensource.org/licenses/osl-3.0.php
11 %
12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14 \section{Changes from previous releases}
15 \label{app:changes}
17 \subsection*{2.0 to 3.0}
18 \begin{itemize}
19 \item The major change here was replacing \module{numarray} with \numpy.
20 For general instructions on converting scripts to use numpy see \url{http://www.stsci.edu/resources/software_hardware/numarray/numarray2numpy.pdf}.
21 The specific changes to \escript are:
22 \begin{itemize}
23 \item getValueOfDataPoint() which returned a \module{numarray}.array has been replaced by
24 getTupleForDataPoint() which returns a \PYTHON tuple containing
25 the components of the data point. In the case of matricies or higher ranked data, the tuples will be nested. Use
26 \numpy.array(data.getTupleForDataPoint()) if a \numpyNDA object is required.
27 \item getValueOfGlobalDataPoint has similarly been replaced by getTupleForGlobalDataPoint().
28 \item integrate(data) now returns a \numpyNDA instead of a \module{numarray}.array.
29 \end{itemize}
30 Any python methods which previously accepted \module{numarray} objects will accept \numpy objects instead.
32 \item
33 The way solver options are defined for \LinearPDE objects has been changed. There is now a \SolverOptions object attached to the \LinearPDE object which is handeling the options of solvers used to solve the PDE. The following changes apply:
34 \begin{itemize}
35 \item The \method{setTolerance} and \method{setAbsoluteTolerance} methods have been removed. Use now \method{getSolverOptions().setTolerance}
36 and \method{getSolverOptions().setAbsoluteTolerance}
38 \item The \method{setSolverPackage} and \method{setSolverMethod} methods have been removed. Use now \method{getSolverOptions().setPackage},
39 \method{getSolverOptions().setSolverMethod} and
40 \method{getSolverOptions().setPreconditioner}.
42 \item The \method{setSolverPackage} and \method{setSolverMethod} methods have been removed. Use now \method{getSolverOptions().setPackage},
43 \method{getSolverOptions().setSolverMethod} and
44 \method{getSolverOptions().setPreconditioner}.
46 \item The static class variables defining packages, solvers and preconditioners have been removed and are now accessed via the corresponding static class variables in \SolverOptions. For instance use \method{SolverOptions.PCG} instead of
47 \method{LinearPDE.PCG} to select the preconditioned conjugate gradient method.
49 \item The \method{getSolution} takes now no argument. Use the corresponding
50 methods of the \SolverOptions object returned by \method{getSolverOptions()}
51 to set values, e.g. use
52 \method{getSolverOptions().setVerbosityOn()} instead of argument \code{verbose=True}
53 and \method{getSolverOptions().setIterMax(1000)} instead of argument \code{iter_max=1000}
54 \end{itemize}
56 \item
57 The \pyvisi module from previous releases has been deprecated and will no longer be supported.
58 It is still present in the source code and can still be used if you compile \escript from source.
59 It will not be available in binary releases.
60 Its use is discouraged.
61 The documentation for \pyvisi can be found in Appendix~\ref{PYVISI CHAP}.
63 \end{itemize}

  ViewVC Help
Powered by ViewVC 1.1.26