1 |
% $Id$ |
|
2 |
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
3 |
|
% |
4 |
|
% Copyright (c) 2003-2008 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 |
|
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% |
13 |
|
|
14 |
|
|
15 |
\documentclass{manual} |
\documentclass{manual} |
16 |
|
|
17 |
% grab the handy definitions and \usepackage statements etc |
% grab the handy definitions and \usepackage statements etc |
18 |
\input{guide_defs} |
\input{guide_defs} |
19 |
|
|
20 |
% title, author, etc stuff |
% title, author, etc stuff |
21 |
\title{ESyS Users Guide} |
\title{\esys Users Guide: Solving Partial Differential Equations With Escript and Finley} |
22 |
|
|
23 |
\author{Lutz Gross (Editor)} |
\author{Lutz Gross et. al.(Editor)} |
24 |
\authoraddress{ |
\authoraddress{ |
25 |
Earth Systems Science Computational Centre (ESSCC) \\ |
Earth Systems Science Computational Centre (ESSCC) \\ |
26 |
The University of Queensland \\ |
The University of Queensland \\ |
27 |
Australia \\ |
Brisbane, Australia \\ |
28 |
Email: \email{esys@access.edu.au} |
Email: \email{esys@access.edu.au} |
29 |
} |
} |
30 |
\date{\today} |
\date{\today} |
31 |
\release{$Id$} |
\release{$Revision$} |
32 |
\setreleaseinfo{} |
\setreleaseinfo{Beta} |
33 |
\setshortversion{} |
\setshortversion{} |
34 |
|
|
35 |
\makeindex |
\makeindex |
42 |
\input{copyrights} |
\input{copyrights} |
43 |
|
|
44 |
\begin{abstract} |
\begin{abstract} |
45 |
This document is a guide of how to use the \ESyS software and |
\escript is a python-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations. |
46 |
associated tools. |
|
47 |
|
It consists of four major components |
48 |
|
\begin{itemize} |
49 |
|
\item \escript core library |
50 |
|
\item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library) |
51 |
|
\item the meshing interface \pycad |
52 |
|
\item VTK visualization interface \pyvisi |
53 |
|
\item model library modellib |
54 |
|
\end{itemize} |
55 |
|
The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory. |
56 |
\end{abstract} |
\end{abstract} |
57 |
|
|
58 |
\tableofcontents |
\tableofcontents |
59 |
|
|
60 |
\input{introduction} |
\input{Installation} |
61 |
\input{firststep} |
\input{TutorialPDE} |
62 |
\input{diffusion} |
|
|
% \input{wavepropagation} |
|
63 |
|
|
64 |
\input{escript} |
\input{escript} |
65 |
\input{linearPDE} |
\input{linearPDE} |
66 |
%\input{bruce} |
|
67 |
|
\input{pycad} |
68 |
|
|
69 |
|
\input{pyvisi} |
70 |
|
|
71 |
\input{finley} |
\input{finley} |
72 |
|
% \input{MPI} |
73 |
|
|
74 |
|
\input{modelframe} |
75 |
|
%\input{bruce} |
76 |
|
|
77 |
|
\input{Models} |
78 |
|
|
79 |
|
\input{appendix} |
80 |
|
|
|
\input{troubleshooting} |
|
81 |
\makemodindex |
\makemodindex |
82 |
|
|
83 |
\printindex |
\printindex |