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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3989 - (hide annotations)
Tue Sep 25 02:21:54 2012 UTC (6 years, 11 months ago) by jfenwick
File MIME type: application/x-tex
File size: 8677 byte(s)
More copyright fixes.
pyvisi traces removed.
Some install doco
1 ksteube 1811
2 jfenwick 3989 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 jfenwick 3911 % Copyright (c) 2003-2012 by University of Queensland
4 jfenwick 3989 % http://www.uq.edu.au
5 gross 625 %
6 ksteube 1811 % 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 gross 625 %
10 jfenwick 3989 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11     % Development since 2012 by School of Earth Sciences
12     %
13     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14 jgs 82
15 lgraham 2128 \usepackage{subfigure}
16 caltinay 3306 \usepackage{color}
17 jgs 82
18 caltinay 3281 \graphicspath{{figures/}}
19 gross 3502 \setcounter{secnumdepth}{3}
20 jgs 82
21 gross 3502
22 caltinay 3293 % default width for figures
23     \newcommand{\figwidth}{100mm}
24    
25     % commands useful in cross-referencing
26     \newcommand{\Ref}[1]{Reference~\cite{#1}}
27     \newcommand{\Sec}[1]{Section~\ref{#1}}
28     \newcommand{\App}[1]{Appendix~\ref{#1}}
29     \newcommand{\Chap}[1]{Chapter~\ref{#1}}
30     \newcommand{\etal}{\emph{~et~al.}}
31     \newcommand{\fig}[1]{Figure~\ref{#1}}
32     \newcommand{\eqn}[1]{Equation~(\ref{#1})}
33     \newcommand{\tab}[1]{Table~\ref{#1}}
34     \newcommand{\env}[1]{\textbf{\mbox{#1}}\index{Environment!#1}}
35 caltinay 3975 \newcommand{\fracp}[2]{\frac{\partial #1}{\partial #2}}
36 caltinay 3293
37 jgs 82 % define some handy commands for escript stuff
38 gross 565 \newcommand{\LINUX}{{\it Linux}\xspace}
39 gross 2316 \newcommand{\WINDOWS}{{\it MS Windows}\xspace}
40     \newcommand{\PYTHON}{{\it python}\xspace}
41 jfenwick 3894 \newcommand{\pythonthree}{\textit{python3}\xspace}
42     \newcommand{\pythontwo}{\textit{python2}\xspace}
43 jfenwick 2331 \newcommand{\netCDF}{{\it netCDF}\index{netCDF}\xspace}
44 jgs 107 \newcommand{\escript}{\module{esys.escript}\xspace}
45 caltinay 3366 \newcommand{\dudley}{\module{esys.dudley}\xspace}
46 jgs 107 \newcommand{\finley}{\module{esys.finley}\xspace}
47 caltinay 3348 \newcommand{\weipa}{\module{esys.weipa}\xspace}
48 gross 999 \newcommand{\esys}{\module{esys}\xspace}
49 gross 993 \newcommand{\pycad}{\module{esys.pycad}\xspace}
50 gross 999 \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
51 caltinay 3293 \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh}\xspace}
52     \newcommand{\SCIPY}{{\it SciPy}\cite{SCIPY}\index{SciPy}\xspace}
53 jfenwick 2923 \newcommand{\MPI}{{\it MPI}\index{Message Passing Interface!MPI}\xspace}
54 jfenwick 2331 \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\xspace}
55 gross 565 \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
56 jgs 102 \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
57 jgs 121 \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
58 gross 2864 \newcommand{\pdetools}{\module{esys.escript.pdetools}\xspace}
59 caltinay 3293 \newcommand{\False}{\constant{False}\xspace}
60     \newcommand{\True}{\constant{True}\xspace}
61     \newcommand{\warning}[1]{\emph{Warning: #1}}
62 gross 565
63 gross 2474 \newcommand{\SolverOptions}{\class{SolverOptions}\xspace}
64 jgs 102 \newcommand{\Poisson}{\class{Poisson}\xspace}
65 gross 568 \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
66 gross 653 \newcommand{\Lame}{\class{Lame}\xspace}
67 jgs 82 \newcommand{\Data}{\class{Data}\xspace}
68 jfenwick 1955 \newcommand{\EmptyData}{empty \class{Data}\index{empty Data}\xspace}
69 jgs 102 \newcommand{\Domain}{\class{Domain}\xspace}
70 caltinay 3293 \newcommand{\gnuplot}{{\it gnuplot}\cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}}
71 jgs 102 \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
72 gross 2573 \newcommand{\PCG}{\member{SolverOptions.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
73     \newcommand{\BiCGStab}{\member{SolverOptions.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
74     \newcommand{\Direct}{\member{SolverOptions.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
75     \newcommand{\GMRES}{\member{SolverOptions.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
76     \newcommand{\PRESTWENTY}{\member{SolverOptions.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
77     \newcommand{\JACOBI}{\member{SolverOptions.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
78     \newcommand{\ILU}{\member{SolverOptions.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
79     \newcommand{\ILUT}{\member{SolverOptions.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
80     \newcommand{\RILU}{\member{SolverOptions.RILU}\xspace\index{preconditioner!RILU}\index{RILU}}
81 gross 3379 \newcommand{\HRZLUMPING}{\member{SolverOptions.HRZ_LUMPING}\xspace\index{linear solver!row sum lumping}\index{row sum lumping}}
82     \newcommand{\ROWSUMLUMPING}{\member{SolverOptions.ROWSUM_LUMPING}\xspace\index{linear solver!HRZ lumping}\index{HRZ lumping}}
83 jfenwick 3295 \newcommand{\NOREORDERING}{\member{SolverOptions.NO_REORDERING}\xspace}
84 gross 2573 \newcommand{\AMG}{\member{SolverOptions.AMG}\xspace\index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}}
85 jfenwick 3295 \newcommand{\GAUSSSEIDEL}{\member{SolverOptions.GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
86     \newcommand{\LOCALGAUSSSEIDEL}{\member{SolverOptions.LOCAL_GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
87 gross 2558 \newcommand{\MKL}{\texttt{MKL}\xspace\index{packages!MKL}\index{MKL}}
88     \newcommand{\UMFPACK}{\texttt{UMFPACK}\xspace\index{packages!UMFPACK}\index{UMFPACK}}
89     \newcommand{\PASO}{\texttt{PASO}\xspace\index{packages!PASO}\index{PASO}}
90 jgs 82
91 jgs 102 \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
92     \newcommand{\Operator}{\class{Operator}\xspace}
93     \newcommand{\SolutionFS}{solution \class{FunctionSpace}\index{solution}\xspace}
94     \newcommand{\ReducedSolutionFS}{reduced solution \class{FunctionSpace}\index{solution!reduced}\xspace}
95     \newcommand{\FunctionOnBoundary}{boundary \class{FunctionSpace}\xspace}
96     \newcommand{\Function}{general \class{FunctionSpace}\xspace}
97     \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
98     \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
99     \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
100 gross 565 \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
101 jgs 102 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
102     \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
103     \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
104 gross 660 \newcommand{\Tensor}{{tensor \Data object}\xspace}
105     \newcommand{\Vector}{{vector \Data object}\xspace}
106 jgs 102 \newcommand{\Scalar}{{scalar \Data object}\xspace}
107 jfenwick 1955 \newcommand{\DataSample}{{data sample}\index{data sample}\xspace}
108     \newcommand{\DataSamplePoints}{{data sample points}\index{data sample!points}\xspace}
109 jfenwick 2463 \newcommand{\numpy}{\module{numpy}\xspace}
110     \newcommand{\numpyNDA}{\module{numpy.\class{ndarray}\xspace}}
111    
112 jgs 102 \newcommand{\Shape}{shape\xspace\index{shape}}
113 gross 565 \newcommand{\Rank}{rank\xspace\index{shape}}
114 jgs 102 \newcommand{\ExampleDirectory}{example directory\xspace}
115 gross 2446 \newcommand{\ReferenceGuide}{\url{http://esys.esscc.uq.edu.au/docs.html}\xspace}
116 caltinay 3293 \newcommand{\Point}{\class{Point}\xspace}
117     \newcommand{\PropertySet}{\class{PropertySet}\xspace}
118     \newcommand{\Design}{\class{Design}\xspace}
119     \newcommand{\TagMap}{\class{TagMap}\xspace}
120     \newcommand{\ManifoldOneD}{\class{Manifold1D}\xspace}
121     \newcommand{\ManifoldTwoD}{\class{Manifold2D}\xspace}
122     \newcommand{\ManifoldThreeD}{\class{Manifold3D}\xspace}
123 jgs 102
124 caltinay 3278 % handy commands related to visualization
125 gross 2574 \newcommand{\VTK}{{\it VTK}\index{visualization!VTK}\index{VTK}\xspace}
126 caltinay 3278 \newcommand{\SILO}{{\it SILO}\index{visualization!SILO}\index{SILO}\xspace}
127 gross 2574 \newcommand{\MATPLOTLIB}{\module{matplotlib}\index{visualization!matplotlib}\index{matplotlib}\xspace}
128     \newcommand{\VTKUrl}{\url{http://www.vtk.org/}\index{visualization!VTK}\index{VTK}\xspace}
129     \newcommand{\VisIt}{{\it VisIt}\index{visualization!VisIt}\index{VisIt}\xspace}
130     \newcommand{\mayavi}{{\it mayavi}\index{visualization!mayavi}\index{mayavi}\xspace}
131 caltinay 3293 \newcommand{\OpenDX}{{\it OpenDX}\index{visualization!OpenDX}\index{OpenDX}\cite{OPENDX}\xspace}
132 gross 2574
133 jgs 102
134     % this stops one figure taking up a whole page and lets more text onto
135     % the one page when a figure exists
136 caltinay 3293 \renewcommand{\floatpagefraction}{0.8} % Default = 0.5
137 jgs 102
138 jgs 82 % improved version of caption handling
139     \usepackage{ccaption}
140     \captionnamefont{\scshape}
141     \captionstyle{}
142     \makeatletter
143     \renewcommand{\fnum@figure}[1]{\quad\small\textsc{\figurename~\thefigure}:}
144     \renewcommand{\@makecaption}[2]{%
145     \vskip\abovecaptionskip
146     \sbox\@tempboxa{#1: #2}%
147     \ifdim \wd\@tempboxa >\hsize
148     \def\baselinestretch{1}\@normalsize
149     #1: #2\par
150     \def\baselinestretch{1.5}\@normalsize
151     \else
152     \global \@minipagefalse
153     \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
154     \fi
155     \vskip\belowcaptionskip}
156     \makeatother
157    
158     % this is for when one uses pdflatex and therefore needs to load pdf
159     % figures into \includegraphics
160     \ifpdf
161 caltinay 3291 \DeclareGraphicsExtensions{.pdf,.png} % this command defined in graphicx
162 jgs 82 \pdfcompresslevel=9 % 0: no compression, 9: highest compression
163     % or, set compress_level 9 in file pdftex.cfg
164     \else
165     \DeclareGraphicsExtensions{.eps}
166     \fi
167 jgs 102
168 jfenwick 3308 \include{elist}
169 jgs 102
170 jfenwick 2335
171    
172 jfenwick 2338 %Ensures that latex doesn't have an error if we don't specify the version
173     \providecommand{\RepVersion}{Unknown\xspace}
174     % to set this value use:
175     % (pdf)latex '\newcommand{\RepVersion}{version\xspace}\input{guide.tex}'
176 gross 2372 % as your command-line

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /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/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 /trunk/ripley/test/python/doc/user/user_defs.tex:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26