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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3892 - (show annotations)
Tue Apr 10 08:57:23 2012 UTC (6 years, 9 months ago) by jfenwick
File MIME type: application/x-tex
File size: 2971 byte(s)
Merged changes across from the attempt2 branch.
This version builds and passes python2 tests.
It also passes most python3 tests.



1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %
4 % Copyright (c) 2003-2010 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{esysdoc}
16 \usepackage{makeidx} %already in the esysdoc class but putting it here prompts kile to run makeidx
17
18 % grab the handy definitions and \usepackage statements etc
19 \input{user_defs}
20 \usepackage{upquote} %used to precent LaTeX from mucking up '
21
22 % \newcommand{\hackscore}{_}
23
24 % title, author, etc stuff
25 \title{\emph{esys-Escript} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
26 \author{Lutz Gross\etal~(Editor)}
27 \authoraddress{
28 Earth Systems Science Computational Centre (ESSCC) \\
29 School of Earth Sciences \\
30 The University of Queensland \\
31 Brisbane, Australia \\
32 Email: \email{esys@esscc.uq.edu.au}
33 }
34 \date{\today}
35
36 \makeindex
37
38 % the actual start of the document
39 \begin{document}
40
41 \maketitle
42
43 % This must be after the make title or latex markup will end up in the title
44 \ifpdf
45 \pdfinfo{
46 /Author (Lutz Gross et al. (Editor))
47 /Title (esys-Escript User's Guide)
48 /Keywords (escript, PDEs)
49 }
50 \fi
51
52 \input{copyrights}
53
54 \begin{abstract}
55 \escript is a python-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations.
56
57 It consists of four major components
58 \begin{itemize}
59 \item \escript core library
60 \item finite element solver \finley (which uses fast vendor-supplied solvers or our paso linear solver library)
61 \item the meshing interface \pycad
62 % \item VTK visualization interface \pyvisi
63 \item a model library.
64 \end{itemize}
65 The current version supports parallelization through both MPI for distributed memory and OpenMP for distributed shared memory.
66
67 \emph{Please see Chapter~\ref{EXECUTION} for changes to the way to launch \escript scripts.}
68 For more info on this and other changes from previous releases see Appendix~\ref{app:changes}.
69
70 If you use this software in your research, then we would appreciate (but do not require) a citation.
71 Some relevant references can be found in Appendix~\ref{app:ourrefs}.
72 \end{abstract}
73 \input{currentdev}
74 \cleardoublepage\pdfbookmark[0]{Contents}{contents}%
75 \tableofcontents
76
77 \include{TutorialPDE}
78 \include{execute}
79 \include{escript}
80 \include{linearPDE}
81 \include{pycad}
82 \include{Models}
83 \include{finley}
84 \include{weipa}
85 \esysappendix %So hyperef builds table of contents links properly
86
87 %\input{modelframe}
88 \include{appendix}
89 %\include{pyvisi}
90
91 \cleardoublepage
92 \phantomsection
93 \addcontentsline{toc}{chapter}{\indexname}
94 \printindex
95
96 \cleardoublepage
97 \phantomsection
98 \addcontentsline{toc}{chapter}{Bibliography}
99 \bibliographystyle{plain}
100 \bibliography{esys}
101
102 \end{document}
103

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/lapack2681/doc/user/guide.tex:2682-2741 /branches/pasowrap/doc/user/user.tex:3661-3674 /branches/py3_attempt2/doc/user/user.tex:3871-3891 /branches/restext/doc/user/guide.tex:2610-2624 /branches/ripleygmg_from_3668/doc/user/user.tex:3669-3791 /branches/stage3.0/doc/user/guide.tex:2569-2590 /release/3.0/doc/user/guide.tex:2591-2601

  ViewVC Help
Powered by ViewVC 1.1.26