/[escript]/trunk/doc/user/changes.tex
ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3331 - (hide annotations)
Mon Nov 1 05:21:18 2010 UTC (8 years, 9 months ago) by caltinay
File MIME type: application/x-tex
File size: 5214 byte(s)
Appendix done. Fixed some overfull hboxes.

1 jfenwick 2463
2     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3     %
4 jfenwick 2881 % Copyright (c) 2009-2010 by University of Queensland
5 jfenwick 2463 % 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     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13    
14     \section{Changes from previous releases}
15     \label{app:changes}
16    
17 caltinay 3331 %\subsection*{3.1 to 3.2}
18    
19 jfenwick 2923 \subsection*{3.0 to 3.1}
20     \begin{itemize}
21 caltinay 3331 \item The \emph{escript} launcher has been renamed to \emph{run-escript}. The
22     old name will still work in this version but will be removed in the future.
23     \item Lazy evaluation features have been improved and documented (see \Sec{sec:lazy}).
24     \item The \emph{escript} documentation now includes a new Cookbook which
25     demonstrates how to solve sample problems using escript.
26 jfenwick 2923 \item Macro elements have been introduced.
27 caltinay 3331 \item The \var{saveDataCSV} method allows one or more \Data objects to be
28     exported in CSV format (see \Sec{sec:savedatacsv}).
29     \item \Data objects can be populated by interpolating from values in a table.
30     \item The new \var{getInfLocator} and \var{getSupLocator} functions in
31     \pdetools return Locators to a minimal/maximal point over the
32     data.
33     \item There is a new class to model fault systems (\var{esys.escript.faultsystems.FaultSystem}).
34 jfenwick 2923 \item A beta version of an Algebraic Multigrid (AMG) solver is included.
35 caltinay 3331 \item Inverting square matrices larger than 3x3 is now permitted if escript is
36     compiled with Lapack support.
37     \item If escript is compiled with a modern compiler, then inf/sup/Lsup will now
38     report NaN, +/-inf as appropriate if those values appear in the data.
39 jfenwick 2923 \item Data.setTags will take tag names as well as tag numbers.
40 caltinay 3331 \item The Scalar, Vector, Tensor, Tensor3, Tensor4 factory methods can now take
41     arrays/nested sequence like objects as their initial values.
42 jfenwick 2923 \item escript.util.mkDir can now take a list of directories to create.
43 caltinay 3331 \item Behind the scenes, \PYTHON docstrings have been rewritten from epydoc to
44     restructured text.
45 jfenwick 2923 \item Various other bug fixes and performance tweaks.
46     \end{itemize}
47    
48 jfenwick 2463 \subsection*{2.0 to 3.0}
49 gross 2474 \begin{itemize}
50     \item The major change here was replacing \module{numarray} with \numpy.
51 jfenwick 2463 For general instructions on converting scripts to use numpy see \url{http://www.stsci.edu/resources/software_hardware/numarray/numarray2numpy.pdf}.
52     The specific changes to \escript are:
53 caltinay 3331 \begin{itemize}
54     \item getValueOfDataPoint() which returned a \module{numarray}.array has been
55     replaced by getTupleForDataPoint() which returns a \PYTHON tuple
56     containing the components of the data point. In the case of matrices or
57     higher ranked data, the tuples will be nested.
58     Use \numpy.array(data.getTupleForDataPoint()) if a \numpyNDA object is
59     required.
60     \item getValueOfGlobalDataPoint() has similarly been replaced by
61     getTupleForGlobalDataPoint().
62     \item \code{integrate(data)} now returns a \numpyNDA instead of a
63     \module{numarray}.array.
64     \end{itemize}
65     Any python methods which previously accepted \module{numarray} objects now
66     accept \numpy objects instead.
67 jfenwick 2463
68 caltinay 3331 \item The way to define solver options for \LinearPDE objects has changed.
69     There is now a \SolverOptions object attached to the \LinearPDE
70     object which handles the options of solvers used to solve the PDE.
71     The following changes apply:
72     \begin{itemize}
73     \item The \method{setTolerance} and \method{setAbsoluteTolerance} methods
74     have been removed. Instead use \method{setTolerance} and
75     \method{setAbsoluteTolerance} on the \SolverOptions object. For example:
76     \method{getSolverOptions().setTolerance(\ldots)}
77     \item The \method{setSolverPackage} and \method{setSolverMethod} methods have
78     been removed. Instead use the methods \method{setPackage},
79     \method{setSolverMethod} and \method{setPreconditioner}. For example:
80     getSolverOptions().setPackage(\ldots).
81     \item The static class variables defining packages, solvers and
82     preconditioners have been removed and are now accessed via the
83     corresponding static class variables in \SolverOptions.
84     For instance use \method{SolverOptions.PCG} instead of
85     \method{LinearPDE.PCG} to select the preconditioned conjugate gradient
86     method.
87     \item The \method{getSolution} now takes no argument. Use the corresponding
88     methods of the \SolverOptions object returned by
89     \method{getSolverOptions()} to set values,\\ e.g. use
90     \method{getSolverOptions().setVerbosityOn()} instead of argument
91     \code{verbose=True} and \method{getSolverOptions().setIterMax(1000)}
92     instead of argument \code{iter_max=1000}.
93     \end{itemize}
94 gross 2474
95 caltinay 3331 \item The \pyvisi module from previous releases has been deprecated and will no
96     longer be supported. It is still present in the source code and can be used
97     if you compile \escript from source. It will not be available in binary
98     releases and its use is discouraged.
99     \emph{The documentation for \pyvisi is not available in this release.}
100     % The documentation for \pyvisi can be found in Appendix~\ref{PYVISI CHAP}.
101 gross 2474 \end{itemize}
102    

  ViewVC Help
Powered by ViewVC 1.1.26