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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 6797 - (show annotations)
Tue Mar 5 04:51:59 2019 UTC (7 weeks ago) by aellery
File MIME type: application/x-tex
File size: 3569 byte(s)
Improved documentation for the escript subworld feature.


1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % Copyright (c) 2003-2018 by The University of Queensland
4 % http://www.uq.edu.au
5 %
6 % Primary Business: Queensland, Australia
7 % Licensed under the Apache License, version 2.0
8 % http://www.apache.org/licenses/LICENSE-2.0
9 %
10 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11 % Development 2012-2013 by School of Earth Sciences
12 % Development from 2014 by Centre for Geoscience Computing (GeoComp)
13 %
14 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15
16 \documentclass{esysdoc}
17 \usepackage{makeidx} %already in the esysdoc class but putting it here prompts kile to run makeidx
18
19 % grab the handy definitions and \usepackage statements etc
20 \input{user_defs}
21 \usepackage{upquote} %used to prevent LaTeX from mucking up '
22 \usepackage{graphicx, subfigure}
23
24 \input{verinfo}
25 % \newcommand{\hackscore}{_}
26
27 % title, author, etc stuff
28 \title{\emph{esys-Escript} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
29 \author{Lutz Gross\etal~(Editor)}
30 \authoraddress{
31 Centre for Geoscience Computing (GeoComp) \\
32 School of Earth Sciences \\
33 The University of Queensland \\
34 Brisbane, Australia \\
35 %Email: \email{esys@esscc.uq.edu.au}
36 }
37 \date{\reldate}
38 \release{\relver}
39 %\release{development}
40
41 \makeindex
42
43 % the actual start of the document
44 \begin{document}
45
46 \maketitle
47
48 % This must be after the make title or latex markup will end up in the title
49 \ifpdf
50 \pdfinfo{
51 /Author (Lutz Gross et al. (Editor))
52 /Title (esys-Escript User's Guide)
53 /Keywords (escript, PDEs)
54 }
55 \fi
56
57
58 \input{copyrights}
59 \input{docguide}
60
61 \begin{abstract}\pdfbookmark[0]{Abstract}{abstract}%
62 \escript is a \PYTHON-based environment for implementing mathematical models, in particular those based on coupled, non-linear, time-dependent partial differential equations.
63 It consists of five major components:
64 \begin{itemize}
65 \item \escript core library
66 \item finite element solvers \finley, \dudley, \ripley, and \speckley (which
67 use fast vendor-supplied solvers or the included \PASO linear solver library)
68 \item the meshing interface \pycad
69 \item a model library
70 \item an inversion module.
71 \end{itemize}
72
73 All \escript modules should work under both \PYTHON 2 and \PYTHON 3, see
74 Appendix~\ref{app:py3}.
75 The current version supports parallelization through \MPI for distributed
76 memory, \OPENMP for shared memory on CPUs, as well as \CUDA for some GPU-based
77 solvers.
78
79 This release comes with some significant changes and new features.
80 Please see Appendix~\ref{app:changes} for a detailed list.
81 In particular, if you wish to solve PDEs with complex coefficients, please consult the install guide regarding Trilinos support.
82
83 If you use this software in your research, then we would appreciate (but do not
84 require) a citation.
85 Some relevant references can be found in Appendix~\ref{app:ourrefs}.
86 \end{abstract}
87
88 \input{currentdev}
89 \cleardoublepage\pdfbookmark[0]{Contents}{contents}%
90 \tableofcontents
91
92 \include{TutorialPDE}
93 \include{execute}
94 \include{escript}
95 \include{linearPDE}
96 \include{pycad}
97 \include{Models}
98 \include{finley}
99 \include{ripley}
100 \include{speckley}
101 \include{weipa}
102 \include{symbolic}
103 \include{subworlds}
104
105 \esysappendix %So hyperef builds table of contents links properly
106
107 %\input{modelframe}
108 \include{appendix}
109
110 \cleardoublepage
111 \phantomsection
112 \addcontentsline{toc}{chapter}{\indexname}
113 \printindex
114
115 \cleardoublepage
116 \phantomsection
117 \addcontentsline{toc}{chapter}{Bibliography}
118 \bibliographystyle{plain}
119 \bibliography{esys}
120
121 \end{document}

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/3.4/doc/user/user.tex:4453-4490 /branches/4.0fordebian/doc/user/user.tex:5567-5588 /branches/diaplayground/doc/user/user.tex:4940-5147 /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/release3.4/doc/user/user.tex:4452 /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 /branches/symbolic_from_3470/doc/user/user.tex:3471-3974 /branches/symbolic_from_3470/ripley/test/python/doc/user/user.tex:3517-3974 /branches/trilinos_from_5897/doc/user/user.tex:5898-6118 /release/3.0/doc/user/guide.tex:2591-2601 /release/4.0/doc/user/user.tex:5380-5406 /trunk/ripley/test/python/doc/user/user.tex:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26