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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 5662 - (show annotations)
Thu Jun 18 04:40:34 2015 UTC (4 years ago) by caltinay
File MIME type: application/x-tex
File size: 9304 byte(s)
Fixes #259 - replaced all references to mayavi by Mayavi2 in the docs.
The arguments were already correct.

1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % Copyright (c) 2003-2015 by The University of Queensland
4 % http://www.uq.edu.au
5 %
6 % Primary Business: Queensland, Australia
7 % Licensed under the Open Software License version 3.0
8 % http://www.opensource.org/licenses/osl-3.0.php
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 \usepackage{subfigure}
17 \usepackage{color}
18
19 \graphicspath{{figures/}}
20 \setcounter{secnumdepth}{3}
21
22
23 % default width for figures
24 \newcommand{\figwidth}{100mm}
25
26 % commands useful in cross-referencing
27 \newcommand{\Ref}[1]{Reference~\cite{#1}}
28 \newcommand{\Sec}[1]{Section~\ref{#1}}
29 \newcommand{\App}[1]{Appendix~\ref{#1}}
30 \newcommand{\Chap}[1]{Chapter~\ref{#1}}
31 \newcommand{\etal}{\emph{~et~al.}}
32 \newcommand{\fig}[1]{Figure~\ref{#1}}
33 \newcommand{\eqn}[1]{Equation~(\ref{#1})}
34 \newcommand{\tab}[1]{Table~\ref{#1}}
35 \newcommand{\env}[1]{\textbf{\mbox{#1}}\index{Environment!#1}}
36 \newcommand{\fracp}[2]{\frac{\partial #1}{\partial #2}}
37
38 % define some handy commands for escript stuff
39 \newcommand{\CUDA}{{\it CUDA}\xspace}
40 \newcommand{\LINUX}{{\it Linux}\xspace}
41 \newcommand{\WINDOWS}{{\it MS Windows}\xspace}
42 \newcommand{\PYTHON}{{\it python}\xspace}
43 \newcommand{\pythonthree}{\textit{python3}\xspace}
44 \newcommand{\pythontwo}{\textit{python2}\xspace}
45 \newcommand{\netCDF}{{\it netCDF}\index{netCDF}\xspace}
46 \newcommand{\escript}{\module{esys.escript}\xspace}
47 \newcommand{\dudley}{\module{esys.dudley}\xspace}
48 \newcommand{\finley}{\module{esys.finley}\xspace}
49 \newcommand{\ripley}{\module{esys.ripley}\xspace}
50 \newcommand{\speckley}{\module{esys.speckley}\xspace}
51 \newcommand{\weipa}{\module{esys.weipa}\xspace}
52 \newcommand{\esys}{\module{esys}\xspace}
53 \newcommand{\pycad}{\module{esys.pycad}\xspace}
54 \newcommand{\downunder}{\module{esys.downunder}\xspace}
55 \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
56 \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh}\xspace}
57 \newcommand{\SCIPY}{{\it SciPy}\cite{SCIPY}\index{SciPy}\xspace}
58 \newcommand{\MPI}{{\it MPI}\index{Message Passing Interface!MPI}\xspace}
59 \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\xspace}
60 \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
61 \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
62 \newcommand{\NLPDE}{\class{NonlinearPDE}\xspace}
63 \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
64 \newcommand{\pdetools}{\module{esys.escript.pdetools}\xspace}
65 \newcommand{\False}{\constant{False}\xspace}
66 \newcommand{\True}{\constant{True}\xspace}
67 \newcommand{\warning}[1]{\emph{Warning: #1}}
68
69 \newcommand{\SolverOptions}{\class{SolverOptions}\xspace}
70 \newcommand{\Poisson}{\class{Poisson}\xspace}
71 \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
72 \newcommand{\Lame}{\class{Lame}\xspace}
73 \newcommand{\Data}{\class{Data}\xspace}
74 \newcommand{\EmptyData}{empty \class{Data}\index{empty Data}\xspace}
75 \newcommand{\Domain}{\class{Domain}\xspace}
76 \newcommand{\gnuplot}{{\it gnuplot}\cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}\xspace}
77 \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
78 \newcommand{\PCG}{\member{SolverOptions.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
79 \newcommand{\BiCGStab}{\member{SolverOptions.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
80 \newcommand{\Direct}{\member{SolverOptions.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
81 \newcommand{\GMRES}{\member{SolverOptions.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
82 \newcommand{\PRESTWENTY}{\member{SolverOptions.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
83 \newcommand{\JACOBI}{\member{SolverOptions.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
84 \newcommand{\ILU}{\member{SolverOptions.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
85 \newcommand{\ILUT}{\member{SolverOptions.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
86 \newcommand{\RILU}{\member{SolverOptions.RILU}\xspace\index{preconditioner!RILU}\index{RILU}}
87 \newcommand{\HRZLUMPING}{\member{SolverOptions.HRZ_LUMPING}\xspace\index{linear solver!row sum lumping}\index{row sum lumping}}
88 \newcommand{\ROWSUMLUMPING}{\member{SolverOptions.ROWSUM_LUMPING}\xspace\index{linear solver!HRZ lumping}\index{HRZ lumping}}
89 \newcommand{\NOREORDERING}{\member{SolverOptions.NO_REORDERING}\xspace}
90 \newcommand{\AMG}{\member{SolverOptions.AMG}\xspace\index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}}
91 \newcommand{\GAUSSSEIDEL}{\member{SolverOptions.GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
92 \newcommand{\LOCALGAUSSSEIDEL}{\member{SolverOptions.LOCAL_GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
93 \newcommand{\MKL}{\texttt{MKL}\xspace\index{packages!MKL}\index{MKL}}
94 \newcommand{\UMFPACK}{\texttt{UMFPACK}\xspace\index{packages!UMFPACK}\index{UMFPACK}}
95 \newcommand{\PASO}{\texttt{PASO}\xspace\index{packages!PASO}\index{PASO}}
96
97 \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
98 \newcommand{\Operator}{\class{Operator}\xspace}
99 \newcommand{\SolutionFS}{solution \class{FunctionSpace}\index{solution}\xspace}
100 \newcommand{\ReducedSolutionFS}{reduced solution \class{FunctionSpace}\index{solution!reduced}\xspace}
101 \newcommand{\FunctionOnBoundary}{boundary \class{FunctionSpace}\xspace}
102 \newcommand{\Function}{general \class{FunctionSpace}\xspace}
103 \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
104 \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
105 \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
106 \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
107 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
108 \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
109 \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
110 \newcommand{\Tensor}{{tensor \Data object}\xspace}
111 \newcommand{\Vector}{{vector \Data object}\xspace}
112 \newcommand{\Scalar}{{scalar \Data object}\xspace}
113 \newcommand{\DataSample}{{data sample}\index{data sample}\xspace}
114 \newcommand{\DataSamplePoints}{{data sample points}\index{data sample!points}\xspace}
115 \newcommand{\numpy}{\module{numpy}\xspace}
116 \newcommand{\numpyNDA}{\module{numpy.\class{ndarray}}\xspace}
117
118 \newcommand{\Shape}{shape\xspace\index{shape}}
119 \newcommand{\Rank}{rank\xspace\index{shape}}
120 \newcommand{\ExampleDirectory}{example directory\xspace}
121 \newcommand{\ReferenceGuide}{\url{http://esys.geocomp.uq.edu.au/docs.html}\xspace}
122 \newcommand{\Point}{\class{Point}\xspace}
123 \newcommand{\PropertySet}{\class{PropertySet}\xspace}
124 \newcommand{\Design}{\class{Design}\xspace}
125 \newcommand{\TagMap}{\class{TagMap}\xspace}
126 \newcommand{\ManifoldOneD}{\class{Manifold1D}\xspace}
127 \newcommand{\ManifoldTwoD}{\class{Manifold2D}\xspace}
128 \newcommand{\ManifoldThreeD}{\class{Manifold3D}\xspace}
129
130 % handy commands related to visualization
131 \newcommand{\VTK}{{\it VTK}\index{visualization!VTK}\index{VTK}\xspace}
132 \newcommand{\SILO}{{\it SILO}\index{visualization!SILO}\index{SILO}\xspace}
133 \newcommand{\Voxet}{{\it Voxet}\index{visualization!Voxet}\index{Voxet}\xspace}
134 \newcommand{\MATPLOTLIB}{\module{matplotlib}\index{visualization!matplotlib}\index{matplotlib}\xspace}
135 \newcommand{\VTKUrl}{\url{http://www.vtk.org/}\index{visualization!VTK}\index{VTK}\xspace}
136 \newcommand{\VisIt}{{\it VisIt}\index{visualization!VisIt}\index{VisIt}\xspace}
137 \newcommand{\mayavi}{{\it Mayavi2}\index{visualization!mayavi}\index{mayavi}\xspace}
138 \newcommand{\GOCAD}{{\it GOCAD}\index{visualization!GOCAD}\index{GOCAD}\xspace}
139 \newcommand{\OpenDX}{{\it OpenDX}\index{visualization!OpenDX}\index{OpenDX}\cite{OPENDX}\xspace}
140
141 % handy commands related to Symbolics
142 \newcommand{\EVALUATOR}{{\class{Evaluator}}\xspace}
143 \newcommand{\SYMBOL}{{\class{Symbol}}\xspace}
144
145
146
147 % this stops one figure taking up a whole page and lets more text onto
148 % the one page when a figure exists
149 \renewcommand{\floatpagefraction}{0.8} % Default = 0.5
150
151 % improved version of caption handling
152 \usepackage{ccaption}
153 \captionnamefont{\scshape}
154 \captionstyle{}
155 \makeatletter
156 \renewcommand{\fnum@figure}[1]{\quad\small\textsc{\figurename~\thefigure}:}
157 \renewcommand{\@makecaption}[2]{%
158 \vskip\abovecaptionskip
159 \sbox\@tempboxa{#1: #2}%
160 \ifdim \wd\@tempboxa >\hsize
161 \def\baselinestretch{1}\@normalsize
162 #1: #2\par
163 \def\baselinestretch{1.5}\@normalsize
164 \else
165 \global \@minipagefalse
166 \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
167 \fi
168 \vskip\belowcaptionskip}
169 \makeatother
170
171 % this is for when one uses pdflatex and therefore needs to load pdf
172 % figures into \includegraphics
173 \ifpdf
174 \DeclareGraphicsExtensions{.pdf,.png} % this command defined in graphicx
175 \pdfcompresslevel=9 % 0: no compression, 9: highest compression
176 % or, set compress_level 9 in file pdftex.cfg
177 \else
178 \DeclareGraphicsExtensions{.eps}
179 \fi
180
181 \include{elist}
182
183
184
185 %Ensures that latex doesn't have an error if we don't specify the version
186 \providecommand{\RepVersion}{Unknown\xspace}
187 % to set this value use:
188 % (pdf)latex '\newcommand{\RepVersion}{version\xspace}\input{guide.tex}'
189 % as your command-line

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/3.4/doc/user/user_defs.tex:4453-4490 /branches/4.0fordebian/doc/user/user_defs.tex:5567-5588 /branches/lapack2681/doc/user/guide_defs.tex:2682-2741 /branches/pasowrap/doc/user/user_defs.tex:3661-3674 /branches/py3_attempt2/doc/user/user_defs.tex:3871-3891 /branches/release3.4/doc/user/user_defs.tex:4452 /branches/restext/doc/user/guide_defs.tex:2610-2624 /branches/ripleygmg_from_3668/doc/user/user_defs.tex:3669-3791 /branches/stage3.0/doc/user/guide_defs.tex:2569-2590 /branches/symbolic_from_3470/doc/user/user_defs.tex:3471-3974 /branches/symbolic_from_3470/ripley/test/python/doc/user/user_defs.tex:3517-3974 /release/3.0/doc/user/guide_defs.tex:2591-2601 /release/4.0/doc/user/user_defs.tex:5380-5406 /trunk/ripley/test/python/doc/user/user_defs.tex:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26