/[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 3343 - (hide annotations)
Wed Nov 10 02:01:29 2010 UTC (9 years ago) by jfenwick
File MIME type: application/x-tex
File size: 10864 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 jgs 82
14 ksteube 1811
15 lgraham 2128 \usepackage{subfigure}
16 caltinay 3306 \usepackage{color}
17 jgs 82
18 caltinay 3281 \graphicspath{{figures/}}
19 jgs 82
20 caltinay 3293 % default width for figures
21     \newcommand{\figwidth}{100mm}
22    
23     % commands useful in cross-referencing
24     \newcommand{\Ref}[1]{Reference~\cite{#1}}
25     \newcommand{\Sec}[1]{Section~\ref{#1}}
26     \newcommand{\App}[1]{Appendix~\ref{#1}}
27     \newcommand{\Chap}[1]{Chapter~\ref{#1}}
28     \newcommand{\etal}{\emph{~et~al.}}
29     \newcommand{\fig}[1]{Figure~\ref{#1}}
30     \newcommand{\eqn}[1]{Equation~(\ref{#1})}
31     \newcommand{\tab}[1]{Table~\ref{#1}}
32     \newcommand{\env}[1]{\textbf{\mbox{#1}}\index{Environment!#1}}
33    
34 jgs 82 % define some handy commands for escript stuff
35 gross 565 \newcommand{\LINUX}{{\it Linux}\xspace}
36 gross 2316 \newcommand{\WINDOWS}{{\it MS Windows}\xspace}
37     \newcommand{\PYTHON}{{\it python}\xspace}
38 jfenwick 2331 \newcommand{\netCDF}{{\it netCDF}\index{netCDF}\xspace}
39 jgs 107 \newcommand{\escript}{\module{esys.escript}\xspace}
40     \newcommand{\finley}{\module{esys.finley}\xspace}
41 gross 999 \newcommand{\esys}{\module{esys}\xspace}
42 gross 565 \newcommand{\pyvisi}{\module{esys.pyvisi}\xspace}
43 gross 993 \newcommand{\pycad}{\module{esys.pycad}\xspace}
44 gross 999 \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
45 caltinay 3293 \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh}\xspace}
46     \newcommand{\SCIPY}{{\it SciPy}\cite{SCIPY}\index{SciPy}\xspace}
47 jfenwick 2923 \newcommand{\MPI}{{\it MPI}\index{Message Passing Interface!MPI}\xspace}
48 jfenwick 2331 \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\xspace}
49 gross 565 \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
50 jgs 102 \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
51 jgs 121 \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
52 gross 2864 \newcommand{\pdetools}{\module{esys.escript.pdetools}\xspace}
53 caltinay 3293 \newcommand{\False}{\constant{False}\xspace}
54     \newcommand{\True}{\constant{True}\xspace}
55     \newcommand{\warning}[1]{\emph{Warning: #1}}
56 gross 565
57 gross 2474 \newcommand{\SolverOptions}{\class{SolverOptions}\xspace}
58 jgs 102 \newcommand{\Poisson}{\class{Poisson}\xspace}
59 gross 568 \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
60 gross 653 \newcommand{\Lame}{\class{Lame}\xspace}
61 jgs 82 \newcommand{\Data}{\class{Data}\xspace}
62 jfenwick 1955 \newcommand{\EmptyData}{empty \class{Data}\index{empty Data}\xspace}
63 jgs 102 \newcommand{\Domain}{\class{Domain}\xspace}
64 caltinay 3293 \newcommand{\gnuplot}{{\it gnuplot}\cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}}
65 jgs 102 \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
66 gross 2573 \newcommand{\PCG}{\member{SolverOptions.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
67     \newcommand{\BiCGStab}{\member{SolverOptions.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
68     \newcommand{\Direct}{\member{SolverOptions.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
69     \newcommand{\GMRES}{\member{SolverOptions.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
70     \newcommand{\PRESTWENTY}{\member{SolverOptions.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
71     \newcommand{\JACOBI}{\member{SolverOptions.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
72     \newcommand{\ILU}{\member{SolverOptions.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
73     \newcommand{\ILUT}{\member{SolverOptions.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
74     \newcommand{\RILU}{\member{SolverOptions.RILU}\xspace\index{preconditioner!RILU}\index{RILU}}
75     \newcommand{\LUMPING}{\member{SolverOptions.LUMPING}\xspace\index{linear solver!lumping}\index{lumping}}
76 jfenwick 3295 \newcommand{\NOREORDERING}{\member{SolverOptions.NO_REORDERING}\xspace}
77 gross 2573 \newcommand{\AMG}{\member{SolverOptions.AMG}\xspace\index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}}
78 jfenwick 3295 \newcommand{\GAUSSSEIDEL}{\member{SolverOptions.GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
79     \newcommand{\LOCALGAUSSSEIDEL}{\member{SolverOptions.LOCAL_GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
80 gross 2558 \newcommand{\MKL}{\texttt{MKL}\xspace\index{packages!MKL}\index{MKL}}
81     \newcommand{\UMFPACK}{\texttt{UMFPACK}\xspace\index{packages!UMFPACK}\index{UMFPACK}}
82     \newcommand{\PASO}{\texttt{PASO}\xspace\index{packages!PASO}\index{PASO}}
83 jgs 82
84 jgs 102 \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
85     \newcommand{\Operator}{\class{Operator}\xspace}
86     \newcommand{\SolutionFS}{solution \class{FunctionSpace}\index{solution}\xspace}
87     \newcommand{\ReducedSolutionFS}{reduced solution \class{FunctionSpace}\index{solution!reduced}\xspace}
88     \newcommand{\FunctionOnBoundary}{boundary \class{FunctionSpace}\xspace}
89     \newcommand{\Function}{general \class{FunctionSpace}\xspace}
90     \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
91     \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
92     \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
93 gross 565 \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
94 jgs 102 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
95     \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
96     \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
97 gross 660 \newcommand{\Tensor}{{tensor \Data object}\xspace}
98     \newcommand{\Vector}{{vector \Data object}\xspace}
99 jgs 102 \newcommand{\Scalar}{{scalar \Data object}\xspace}
100 jfenwick 1955 \newcommand{\DataSample}{{data sample}\index{data sample}\xspace}
101     \newcommand{\DataSamplePoints}{{data sample points}\index{data sample!points}\xspace}
102 jfenwick 2463 \newcommand{\numpy}{\module{numpy}\xspace}
103     \newcommand{\numpyNDA}{\module{numpy.\class{ndarray}\xspace}}
104    
105 jgs 102 \newcommand{\Shape}{shape\xspace\index{shape}}
106 gross 565 \newcommand{\Rank}{rank\xspace\index{shape}}
107 jgs 102 \newcommand{\ExampleDirectory}{example directory\xspace}
108 gross 2446 \newcommand{\ReferenceGuide}{\url{http://esys.esscc.uq.edu.au/docs.html}\xspace}
109 caltinay 3293 \newcommand{\Point}{\class{Point}\xspace}
110     \newcommand{\PropertySet}{\class{PropertySet}\xspace}
111     \newcommand{\Design}{\class{Design}\xspace}
112     \newcommand{\TagMap}{\class{TagMap}\xspace}
113     \newcommand{\ManifoldOneD}{\class{Manifold1D}\xspace}
114     \newcommand{\ManifoldTwoD}{\class{Manifold2D}\xspace}
115     \newcommand{\ManifoldThreeD}{\class{Manifold3D}\xspace}
116 jgs 102
117 caltinay 3278 % handy commands related to visualization
118 gross 2574 \newcommand{\VTK}{{\it VTK}\index{visualization!VTK}\index{VTK}\xspace}
119 caltinay 3278 \newcommand{\SILO}{{\it SILO}\index{visualization!SILO}\index{SILO}\xspace}
120 gross 2574 \newcommand{\MATPLOTLIB}{\module{matplotlib}\index{visualization!matplotlib}\index{matplotlib}\xspace}
121     \newcommand{\VTKUrl}{\url{http://www.vtk.org/}\index{visualization!VTK}\index{VTK}\xspace}
122     \newcommand{\VisIt}{{\it VisIt}\index{visualization!VisIt}\index{VisIt}\xspace}
123     \newcommand{\mayavi}{{\it mayavi}\index{visualization!mayavi}\index{mayavi}\xspace}
124 caltinay 3293 \newcommand{\OpenDX}{{\it OpenDX}\index{visualization!OpenDX}\index{OpenDX}\cite{OPENDX}\xspace}
125 gross 2574
126 caltinay 3293 % deprecated pyvisi commands
127 jongui 879 \newcommand{\Scene}{\class{Scene}\xspace}
128     \newcommand{\Camera}{\class{Camera}\xspace}
129 jongui 886 \newcommand{\Light}{\class{Light}\xspace}
130 jongui 1035 \newcommand{\DataCollector}{\class{DataCollector}\xspace}
131     \newcommand{\ImageReader}{\class{ImageReader}\xspace}
132     \newcommand{\TextTwoD}{\class{Text2D}\xspace}
133     \newcommand{\ActorTwoD}{\class{Actor2D}\xspace}
134     \newcommand{\ActorThreeD}{\class{Actor3D}\xspace}
135     \newcommand{\Transform}{\class{Transform}\xspace}
136     \newcommand{\Clipper}{\class{Clipper}\xspace}
137 jongui 879 \newcommand{\Map}{\class{Map}\xspace}
138 jongui 1035 \newcommand{\MapOnPlaneCut}{\class{MapOnPlaneCut}\xspace}
139     \newcommand{\MapOnPlaneClip}{\class{MapOnPlaneClip}\xspace}
140 jongui 886 \newcommand{\MapOnScalarClip}{\class{MapOnScalarClip}\xspace}
141 jongui 1211 \newcommand{\MapOnScalarClipWithRotation}{\class{MapOnScalarClipWithRotation}\xspace}
142 jongui 1035 \newcommand{\GlyphThreeD}{\class{Glyph3D}\xspace}
143 jongui 1078 \newcommand{\MaskPoints}{\class{MaskPoints}\xspace}
144 jongui 1035 \newcommand{\Velocity}{\class{Velocity}\xspace}
145     \newcommand{\VelocityOnPlaneCut}{\class{VelocityOnPlaneCut}\xspace}
146     \newcommand{\VelocityOnPlaneClip}{\class{VelocityOnPlaneClip}\xspace}
147     \newcommand{\Sphere}{\class{Sphere}\xspace}
148     \newcommand{\TensorGlyph}{\class{TensorGlyph}\xspace}
149     \newcommand{\Ellipsoid}{\class{Ellipsoid}\xspace}
150     \newcommand{\EllipsoidOnPlaneCut}{\class{EllipsoidOnPlaneCut}\xspace}
151     \newcommand{\EllipsoidOnPlaneClip}{\class{EllipsoidOnPlaneClip}\xspace}
152     \newcommand{\ContourModule}{\class{ContourModule}\xspace}
153 jongui 879 \newcommand{\Contour}{\class{Contour}\xspace}
154 jongui 1035 \newcommand{\ContourOnPlaneCut}{\class{ContourOnPlaneCut}\xspace}
155     \newcommand{\ContourOnPlaneClip}{\class{ContourOnPlaneClip}\xspace}
156     \newcommand{\PointSource}{\class{PointSource}\xspace}
157     \newcommand{\StreamLineModule}{\class{StreamLineModule}\xspace}
158     \newcommand{\Tube}{\class{Tube}\xspace}
159     \newcommand{\StreamLine}{\class{StreamLine}\xspace}
160     \newcommand{\Warp}{\class{Warp}\xspace}
161 jongui 879 \newcommand{\Carpet}{\class{Carpet}\xspace}
162 jongui 1035 \newcommand{\PlaneSource}{\class{PlaneSource}\xspace}
163     \newcommand{\Image}{\class{Image}\xspace}
164 jongui 1112 \newcommand{\Logo}{\class{Logo}\xspace}
165     \newcommand{\ImageReslice}{\class{ImageReslice}\xspace}
166 jongui 879 \newcommand{\Position}{\class{Position}\xspace}
167 jongui 1194 \newcommand{\DataSetMapper}{\class{DataSetMapper}\xspace}
168     \newcommand{\Legend}{\class{Legend}\xspace}
169     \newcommand{\ScalarBar}{\class{ScalarBar}\xspace}
170     \newcommand{\Movie}{\class{Movie}\xspace}
171 jongui 1205 \newcommand{\CubeSource}{\class{CubeSource}\xspace}
172     \newcommand{\Rectangle}{\class{Rectangle}\xspace}
173     \newcommand{\LocalPosition}{\class{LocalPosition}\xspace}
174     \newcommand{\GlobalPosition}{\class{GlobalPosition}\xspace}
175 jongui 1211 \newcommand{\Rotation}{\class{Rotation}\xspace}
176 jongui 1081 \newcommand{\thumbnailwidth}{50mm}
177 caltinay 3293 % end of pyvisi commands
178 jgs 102
179     % this stops one figure taking up a whole page and lets more text onto
180     % the one page when a figure exists
181 caltinay 3293 \renewcommand{\floatpagefraction}{0.8} % Default = 0.5
182 jgs 102
183 jgs 82 % improved version of caption handling
184     \usepackage{ccaption}
185     \captionnamefont{\scshape}
186     \captionstyle{}
187     \makeatletter
188     \renewcommand{\fnum@figure}[1]{\quad\small\textsc{\figurename~\thefigure}:}
189     \renewcommand{\@makecaption}[2]{%
190     \vskip\abovecaptionskip
191     \sbox\@tempboxa{#1: #2}%
192     \ifdim \wd\@tempboxa >\hsize
193     \def\baselinestretch{1}\@normalsize
194     #1: #2\par
195     \def\baselinestretch{1.5}\@normalsize
196     \else
197     \global \@minipagefalse
198     \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
199     \fi
200     \vskip\belowcaptionskip}
201     \makeatother
202    
203     % this is for when one uses pdflatex and therefore needs to load pdf
204     % figures into \includegraphics
205     \ifpdf
206 caltinay 3291 \DeclareGraphicsExtensions{.pdf,.png} % this command defined in graphicx
207 jgs 82 \pdfcompresslevel=9 % 0: no compression, 9: highest compression
208     % or, set compress_level 9 in file pdftex.cfg
209     \else
210     \DeclareGraphicsExtensions{.eps}
211     \fi
212 jgs 102
213 jfenwick 3308 \include{elist}
214 jgs 102
215 jfenwick 2335
216    
217 jfenwick 2338 %Ensures that latex doesn't have an error if we don't specify the version
218     \providecommand{\RepVersion}{Unknown\xspace}
219     % to set this value use:
220     % (pdf)latex '\newcommand{\RepVersion}{version\xspace}\input{guide.tex}'
221 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/restext/doc/user/guide_defs.tex:2610-2624 /branches/stage3.0/doc/user/guide_defs.tex:2569-2590 /release/3.0/doc/user/guide_defs.tex:2591-2601

  ViewVC Help
Powered by ViewVC 1.1.26