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

Annotation of /trunk/doc/user/user.tex

Parent Directory Parent Directory | Revision Log Revision Log


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


1 caltinay 5293
2 jfenwick 3989 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 jfenwick 6651 % Copyright (c) 2003-2018 by The University of Queensland
4 jfenwick 3989 % http://www.uq.edu.au
5 gross 625 %
6 ksteube 1811 % Primary Business: Queensland, Australia
7 jfenwick 6112 % Licensed under the Apache License, version 2.0
8     % http://www.apache.org/licenses/LICENSE-2.0
9 gross 625 %
10 jfenwick 3989 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11 jfenwick 4657 % Development 2012-2013 by School of Earth Sciences
12     % Development from 2014 by Centre for Geoscience Computing (GeoComp)
13 jfenwick 3989 %
14     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15 ksteube 1316
16 caltinay 3293 \documentclass{esysdoc}
17 caltinay 4891 \usepackage{makeidx} %already in the esysdoc class but putting it here prompts kile to run makeidx
18 jgs 82
19     % grab the handy definitions and \usepackage statements etc
20 jfenwick 3343 \input{user_defs}
21 caltinay 5295 \usepackage{upquote} %used to prevent LaTeX from mucking up '
22 sshaw 5279 \usepackage{graphicx, subfigure}
23 jgs 82
24 jfenwick 5410 \input{verinfo}
25 jfenwick 3295 % \newcommand{\hackscore}{_}
26 caltinay 3293
27 jgs 82 % title, author, etc stuff
28 jfenwick 3339 \title{\emph{esys-Escript} User's Guide:\\ Solving Partial Differential Equations\\ with Escript and Finley}
29 caltinay 1963 \author{Lutz Gross\etal~(Editor)}
30 jgs 82 \authoraddress{
31 caltinay 4891 Centre for Geoscience Computing (GeoComp) \\
32 gross 2370 School of Earth Sciences \\
33 jgs 82 The University of Queensland \\
34 ksteube 1316 Brisbane, Australia \\
35 caltinay 4891 %Email: \email{esys@esscc.uq.edu.au}
36 caltinay 3293 }
37 jfenwick 5410 \date{\reldate}
38     \release{\relver}
39 jfenwick 5407 %\release{development}
40 jgs 82
41     \makeindex
42    
43     % the actual start of the document
44     \begin{document}
45    
46     \maketitle
47    
48 caltinay 3293 % This must be after the make title or latex markup will end up in the title
49 jfenwick 2944 \ifpdf
50 caltinay 3293 \pdfinfo{
51 caltinay 3306 /Author (Lutz Gross et al. (Editor))
52 jfenwick 3339 /Title (esys-Escript User's Guide)
53 jfenwick 2944 /Keywords (escript, PDEs)
54     }
55     \fi
56    
57 jfenwick 4996
58 jgs 82 \input{copyrights}
59 jfenwick 4996 \input{docguide}
60 jgs 82
61 jfenwick 3894 \begin{abstract}\pdfbookmark[0]{Abstract}{abstract}%
62 caltinay 5295 \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 gross 722 \begin{itemize}
65 gross 999 \item \escript core library
66 caltinay 5295 \item finite element solvers \finley, \dudley, \ripley, and \speckley (which
67     use fast vendor-supplied solvers or the included \PASO linear solver library)
68 gross 999 \item the meshing interface \pycad
69 caltinay 5295 \item a model library
70     \item an inversion module.
71 gross 722 \end{itemize}
72 jfenwick 2923
73 caltinay 5295 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 jfenwick 2463
79 caltinay 5295 This release comes with some significant changes and new features.
80     Please see Appendix~\ref{app:changes} for a detailed list.
81 jfenwick 6589 In particular, if you wish to solve PDEs with complex coefficients, please consult the install guide regarding Trilinos support.
82 caltinay 5295
83     If you use this software in your research, then we would appreciate (but do not
84     require) a citation.
85 jfenwick 2463 Some relevant references can be found in Appendix~\ref{app:ourrefs}.
86 caltinay 5295 \end{abstract}
87 jfenwick 3894
88 jfenwick 3382 \input{currentdev}
89 caltinay 3452 \cleardoublepage\pdfbookmark[0]{Contents}{contents}%
90     \tableofcontents
91 jgs 82
92 jfenwick 1955 \include{TutorialPDE}
93 gross 2316 \include{execute}
94 jfenwick 1955 \include{escript}
95     \include{linearPDE}
96     \include{pycad}
97     \include{Models}
98 gross 2415 \include{finley}
99 sshaw 5279 \include{ripley}
100     \include{speckley}
101 caltinay 3366 \include{weipa}
102 jduplessis 4794 \include{symbolic}
103 aellery 6797 \include{subworlds}
104 jduplessis 4794
105 jfenwick 3302 \esysappendix %So hyperef builds table of contents links properly
106 gross 568
107 gross 1859 %\input{modelframe}
108 jfenwick 1955 \include{appendix}
109 jfenwick 2540
110 caltinay 3307 \cleardoublepage
111     \phantomsection
112     \addcontentsline{toc}{chapter}{\indexname}
113     \printindex
114    
115     \cleardoublepage
116     \phantomsection
117     \addcontentsline{toc}{chapter}{Bibliography}
118 jgs 102 \bibliographystyle{plain}
119     \bibliography{esys}
120    
121 jgs 82 \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