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{\escript Users Guide} |
\title{\module{esys} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley} |
22 |
|
|
23 |
\author{Lutz Gross et. al.(Editor)} |
\ifpdf |
24 |
|
\pdfinfo { |
25 |
|
/Author (Lutz Gross et al (Editor)) |
26 |
|
/Title (escript User's Guide) |
27 |
|
/Keywords (escript, PDEs) |
28 |
|
} |
29 |
|
\fi |
30 |
|
|
31 |
|
\author{Lutz Gross\etal~(Editor)} |
32 |
\authoraddress{ |
\authoraddress{ |
33 |
Earth Systems Science Computational Centre (ESSCC) \\ |
Earth Systems Science Computational Centre (ESSCC) \\ |
34 |
The University of Queensland \\ |
The University of Queensland \\ |
35 |
Australia \\ |
Brisbane, Australia \\ |
36 |
Email: \email{esys@access.edu.au} |
Email: \email{esys@esscc.uq.edu.au} |
37 |
} |
} |
38 |
\date{\today} |
\date{\today} |
39 |
\release{$Revision: 149 $} |
\release{Revision: \RepVersion} |
40 |
\setreleaseinfo{} |
\setreleaseinfo{Beta} |
41 |
\setshortversion{} |
\setshortversion{} |
42 |
|
|
43 |
\makeindex |
\makeindex |
50 |
\input{copyrights} |
\input{copyrights} |
51 |
|
|
52 |
\begin{abstract} |
\begin{abstract} |
53 |
This document is a guide of how to use the \escript 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. |
54 |
associated tools. |
|
55 |
|
It consists of four major components |
56 |
|
\begin{itemize} |
57 |
|
\item \escript core library |
58 |
|
\item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library) |
59 |
|
\item the meshing interface \pycad |
60 |
|
\item VTK visualization interface \pyvisi |
61 |
|
\item model library modellib |
62 |
|
\end{itemize} |
63 |
|
The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory. |
64 |
\end{abstract} |
\end{abstract} |
65 |
|
|
66 |
\tableofcontents |
\tableofcontents |
67 |
|
|
68 |
\input{Installation} |
\include{TutorialPDE} |
69 |
\input{TutorialPDE} |
\include{execute} |
70 |
|
|
71 |
|
\include{escript} |
72 |
|
\include{linearPDE} |
73 |
|
|
74 |
|
\include{pycad} |
75 |
|
|
76 |
|
\include{pyvisi} |
77 |
|
|
78 |
|
\include{Models} |
79 |
|
|
80 |
|
\include{finley} |
81 |
|
% \input{MPI} |
82 |
|
|
83 |
|
%\input{modelframe} |
84 |
|
|
85 |
\input{escript} |
\include{appendix} |
|
\input{timeseries} |
|
|
\input{modelframe} |
|
|
\input{pdetools} |
|
|
%\input{bruce} |
|
|
\input{finley} |
|
86 |
|
|
|
\input{troubleshooting} |
|
87 |
\makemodindex |
\makemodindex |
88 |
|
|
89 |
\printindex |
\printindex |