/[escript]/branches/symbolic_from_3470/doc/user/user.tex
ViewVC logotype

Annotation of /branches/symbolic_from_3470/doc/user/user.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3343 - (hide annotations)
Wed Nov 10 02:01:29 2010 UTC (8 years, 6 months ago) by jfenwick
Original Path: trunk/doc/user/user.tex
File MIME type: application/x-tex
File size: 2820 byte(s)
Rename users guide to user.pdf from guide.pdf to match the conventions 
we follow with the other files.

Corrected the description of Einstein convention from "convenient"
to "compact". 

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

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/lapack2681/doc/user/guide.tex:2682-2741 /branches/restext/doc/user/guide.tex:2610-2624 /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