/[escript]/branches/stage3.1/doc/user/guide_defs.tex
ViewVC logotype

Contents of /branches/stage3.1/doc/user/guide_defs.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2558 - (show annotations)
Mon Jul 27 05:03:32 2009 UTC (10 years, 2 months ago) by gross
Original Path: trunk/doc/user/guide_defs.tex
File MIME type: application/x-tex
File size: 16229 byte(s)
a table added showing the available solver options for finley paso.
1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %
4 % Copyright (c) 2003-2009 by University of Queensland
5 % Earth Systems Science Computational Center (ESSCC)
6 % http://www.uq.edu.au/esscc
7 %
8 % 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 %
12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13
14
15 \usepackage{subfigure}
16 \usepackage{epsfig}
17 \usepackage{graphicx,color}
18 \usepackage{makeidx} % handle the index properly
19 \usepackage{xspace} % handle spaces after commands more nicely
20 % use the ams math stuff, as it makes the maths easier to code, and
21 % nicer output than the standard LaTeX stuff
22 \usepackage{amsmath,amsfonts,amssymb} % this is handy for mathematicians and physicists
23 % see http://www.ams.org/tex/amslatex.html
24 \usepackage{alltt} % handy verbatim stuff
25
26
27 % define some handy commands for escript stuff
28 \newcommand{\LINUX}{{\it Linux}\xspace}
29 \newcommand{\WINDOWS}{{\it MS Windows}\xspace}
30 \newcommand{\PYTHON}{{\it python}\xspace}
31 % \newcommand{\netCDF}{{\it netCDF}\cite{NETCDF}\index{netCDF} \xspace}
32 \newcommand{\netCDF}{{\it netCDF}\index{netCDF}\xspace}
33 \newcommand{\escript}{\module{esys.escript}\xspace}
34 \newcommand{\finley}{\module{esys.finley}\xspace}
35 \newcommand{\esys}{\module{esys}\xspace}
36 \newcommand{\pyvisi}{\module{esys.pyvisi}\xspace}
37 \newcommand{\pycad}{\module{esys.pycad}\xspace}
38 \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
39 \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh} \xspace}
40 \newcommand{\env}[1]{\textbf{\mbox{#1}}\index{Environment!#1}}
41 % \newcommand{\MPI}{{\it MPI}\xspace\index{Message Passing Interface!MPI}\cite{MPI}\xspace}
42 % \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\cite{OPENMP}\xspace}
43 \newcommand{\MPI}{{\it MPI}\xspace\index{Message Passing Interface!MPI}\xspace}
44 \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\xspace}
45 \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
46 \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
47 \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
48 \newcommand{\pdetools}{\module{esys.pdetools}\xspace}
49 \newcommand{\esysxml}{{\it esysxml}}
50
51 \newcommand{\SolverOptions}{\class{SolverOptions}\xspace}
52 \newcommand{\Poisson}{\class{Poisson}\xspace}
53 \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
54 \newcommand{\Lame}{\class{Lame}\xspace}
55 \newcommand{\Data}{\class{Data}\xspace}
56 \newcommand{\EmptyData}{empty \class{Data}\index{empty Data}\xspace}
57 \newcommand{\Domain}{\class{Domain}\xspace}
58 %\newcommand{\VTK}{{\it vtk} \cite{VTK}\index{visualization!vtk} \xspace}
59 \newcommand{\GnuPlot}{{\it gnuplot} \cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}}
60 \newcommand{\mayavi}{{\it mayavi}\index{visualization!mayavi}\index{mayavi}}
61 \newcommand{\OpenDX}{{\it OpenDX} \cite{OPENDX}\xspace}
62 \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
63 \newcommand{\False}{\constant{False}\xspace}
64 \newcommand{\True}{\constant{True}\xspace}
65 \newcommand{\PCG}{\constant{SolverOptions.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
66 \newcommand{\BiCGStab}{\constant{SolverOptions.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
67 \newcommand{\Direct}{\constant{SolverOptions.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
68 \newcommand{\GMRES}{\constant{SolverOptions.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
69 \newcommand{\PRESTWENTY}{\constant{SolverOptions.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
70 \newcommand{\JACOBI}{\constant{SolverOptions.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
71 \newcommand{\ILU}{\constant{SolverOptions.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
72 \newcommand{\ILUT}{\constant{SolverOptions.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
73 \newcommand{\RILU}{\constant{SolverOptions.RILU}\xspace\index{preconditioner!RILU}\index{RILU}}
74 \newcommand{\LUMPING}{\constant{SolverOptions.LUMPING}\xspace\index{linear solver!lumping}\index{lumping}}
75 \newcommand{\NOREORDERING}{\constant{SolverOptions.NO\hackscore REORDERING}\xspace}
76 \newcommand{\MINIMUMFILLIN}{\constant{SolverOptions.MINIMUM\hackscore FILL\hackscore IN}\xspace\index{linear solver!minimum fill-in ordering}\index{minimum fill-in ordering}}
77 \newcommand{\NESTEDDESCTION}{\constant{SolverOptions.NESTED\hackscore DISSECTION}\xspace\index{linear solver!nested dissection ordering}\index{nested dissection}}
78 \newcommand{\AMG}{\constant{SolverOptions.AMG}\xspace\index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}}
79 \newcommand{\GAUSSSEIDEL}{\constant{SolverOptions.GAUSS\hackscore SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
80 \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
84 \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 \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
94 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
95 \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
96 \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
97 \newcommand{\Tensor}{{tensor \Data object}\xspace}
98 \newcommand{\Vector}{{vector \Data object}\xspace}
99 \newcommand{\Scalar}{{scalar \Data object}\xspace}
100 \newcommand{\DataSample}{{data sample}\index{data sample}\xspace}
101 \newcommand{\DataSamplePoints}{{data sample points}\index{data sample!points}\xspace}
102 \newcommand{\numpy}{\module{numpy}\xspace}
103 \newcommand{\numpyNDA}{\module{numpy.\class{ndarray}\xspace}}
104
105 \newcommand{\Shape}{shape\xspace\index{shape}}
106 \newcommand{\Rank}{rank\xspace\index{shape}}
107 \newcommand{\ExampleDirectory}{example directory\xspace}
108 \newcommand{\ReferenceGuide}{\url{http://esys.esscc.uq.edu.au/docs.html}\xspace}
109 \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
117 % handy commands for pyvisi
118 \newcommand{\VTK}{{\it VTK} \xspace}
119 \newcommand{\VTKUrl}{\url{http://www.vtk.org/}\xspace}
120 \newcommand{\Scene}{\class{Scene}\xspace}
121 \newcommand{\Camera}{\class{Camera}\xspace}
122 \newcommand{\Light}{\class{Light}\xspace}
123 \newcommand{\DataCollector}{\class{DataCollector}\xspace}
124 \newcommand{\ImageReader}{\class{ImageReader}\xspace}
125 \newcommand{\TextTwoD}{\class{Text2D}\xspace}
126 \newcommand{\ActorTwoD}{\class{Actor2D}\xspace}
127 \newcommand{\ActorThreeD}{\class{Actor3D}\xspace}
128 \newcommand{\Transform}{\class{Transform}\xspace}
129 \newcommand{\Clipper}{\class{Clipper}\xspace}
130 \newcommand{\Map}{\class{Map}\xspace}
131 \newcommand{\MapOnPlaneCut}{\class{MapOnPlaneCut}\xspace}
132 \newcommand{\MapOnPlaneClip}{\class{MapOnPlaneClip}\xspace}
133 \newcommand{\MapOnScalarClip}{\class{MapOnScalarClip}\xspace}
134 \newcommand{\MapOnScalarClipWithRotation}{\class{MapOnScalarClipWithRotation}\xspace}
135 \newcommand{\GlyphThreeD}{\class{Glyph3D}\xspace}
136 \newcommand{\MaskPoints}{\class{MaskPoints}\xspace}
137 \newcommand{\Velocity}{\class{Velocity}\xspace}
138 \newcommand{\VelocityOnPlaneCut}{\class{VelocityOnPlaneCut}\xspace}
139 \newcommand{\VelocityOnPlaneClip}{\class{VelocityOnPlaneClip}\xspace}
140 \newcommand{\Sphere}{\class{Sphere}\xspace}
141 \newcommand{\TensorGlyph}{\class{TensorGlyph}\xspace}
142 \newcommand{\Ellipsoid}{\class{Ellipsoid}\xspace}
143 \newcommand{\EllipsoidOnPlaneCut}{\class{EllipsoidOnPlaneCut}\xspace}
144 \newcommand{\EllipsoidOnPlaneClip}{\class{EllipsoidOnPlaneClip}\xspace}
145 \newcommand{\ContourModule}{\class{ContourModule}\xspace}
146 \newcommand{\Contour}{\class{Contour}\xspace}
147 \newcommand{\ContourOnPlaneCut}{\class{ContourOnPlaneCut}\xspace}
148 \newcommand{\ContourOnPlaneClip}{\class{ContourOnPlaneClip}\xspace}
149 \newcommand{\PointSource}{\class{PointSource}\xspace}
150 \newcommand{\StreamLineModule}{\class{StreamLineModule}\xspace}
151 \newcommand{\Tube}{\class{Tube}\xspace}
152 \newcommand{\StreamLine}{\class{StreamLine}\xspace}
153 \newcommand{\Warp}{\class{Warp}\xspace}
154 \newcommand{\Carpet}{\class{Carpet}\xspace}
155 \newcommand{\PlaneSource}{\class{PlaneSource}\xspace}
156 \newcommand{\Image}{\class{Image}\xspace}
157 \newcommand{\Logo}{\class{Logo}\xspace}
158 \newcommand{\ImageReslice}{\class{ImageReslice}\xspace}
159 \newcommand{\Position}{\class{Position}\xspace}
160 \newcommand{\DataSetMapper}{\class{DataSetMapper}\xspace}
161 \newcommand{\Legend}{\class{Legend}\xspace}
162 \newcommand{\ScalarBar}{\class{ScalarBar}\xspace}
163 \newcommand{\Movie}{\class{Movie}\xspace}
164 \newcommand{\CubeSource}{\class{CubeSource}\xspace}
165 \newcommand{\Rectangle}{\class{Rectangle}\xspace}
166 \newcommand{\LocalPosition}{\class{LocalPosition}\xspace}
167 \newcommand{\GlobalPosition}{\class{GlobalPosition}\xspace}
168 \newcommand{\Rotation}{\class{Rotation}\xspace}
169 \newcommand{\thumbnailwidth}{50mm}
170
171 % default width for figures
172 \newcommand{\figwidth}{100mm}
173 % commands useful in cross-referencing
174 \newcommand {\Ref}[1] {Reference~\cite{#1}}
175 \newcommand {\Sec}[1] {Section~\ref{#1}}
176 \newcommand {\App}[1] {Appendix~\ref{#1}}
177 \newcommand {\Chap}[1] {Chapter~\ref{#1}}
178 \newcommand {\etal} {\emph{~et~al.}}
179 \newcommand {\fig}[1] {Figure~\ref{#1}}
180 \newcommand {\eqn}[1] {Equation~(\ref{#1})}
181 \newcommand {\tab}[1] {Table~\ref{#1}}
182
183 % this stops one figure taking up a whole page and lets more text onto
184 % the one page when a figure exists
185 \renewcommand{\floatpagefraction}{0.8} % Default = 0.5
186
187 % improved version of caption handling
188 \usepackage{ccaption}
189 \captionnamefont{\scshape}
190 \captionstyle{}
191 \makeatletter
192 \renewcommand{\fnum@figure}[1]{\quad\small\textsc{\figurename~\thefigure}:}
193 \renewcommand{\@makecaption}[2]{%
194 \vskip\abovecaptionskip
195 \sbox\@tempboxa{#1: #2}%
196 \ifdim \wd\@tempboxa >\hsize
197 \def\baselinestretch{1}\@normalsize
198 #1: #2\par
199 \def\baselinestretch{1.5}\@normalsize
200 \else
201 \global \@minipagefalse
202 \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
203 \fi
204 \vskip\belowcaptionskip}
205 \makeatother
206
207 % \usepackage{fancyvrb} % fancy verbatim stuff. Needed so code below goes
208 %%% this code grabbed from the PyScript docs
209 %%% pyscript.sourceforge.net
210
211 % --------------------------------------------------------------
212 % Code format within \Verb
213 % --------------------------------------------------------------
214
215 % \definecolor{pycolor}{rgb}{0,0.4,0}
216
217 %% \DefineVerbatimEnvironment{python}{Verbatim}
218 %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},
219 %% formatcom=\color{pycolor}\small,fontshape=rm}
220
221 %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}
222
223 % \RecustomVerbatimCommand{\Verb}{Verb}{formatcom=\color{pycolor}\small,fontshape=rm}
224
225 %%% end of grabbed code
226
227 % this is for when one uses pdflatex and therefore needs to load pdf
228 % figures into \includegraphics
229 \ifpdf
230 \DeclareGraphicsExtensions{.pdf} % this command defined in graphicx
231 \pdfcompresslevel=9 % 0: no compression, 9: highest compression
232 % or, set compress_level 9 in file pdftex.cfg
233 \else
234 \DeclareGraphicsExtensions{.eps}
235 \fi
236
237 % defines the colour for the background of code examples
238 \definecolor{LightGrey}{gray}{0.9}
239
240 % add the listings package to pretty print the code output
241 \usepackage{listings}
242
243
244 %Some colour definitions added to keep pdflatex happy
245 %I make no claim that these values are particularly good
246 \definecolor{Purple}{rgb}{0.7, 0, 0.6}
247 \definecolor{Tan}{rgb}{0.5,0.5,0.5}
248 \definecolor{BrickRed}{rgb}{0.7, 0.2, 0.2}
249 \definecolor{Black}{rgb}{0, 0, 0}
250
251 % All the \color{x} used to be \color[named]{x}
252 %end color defs
253
254 \lstdefinestyle{myC++}{%
255 %\lstset{%
256 language=C++,
257 showstringspaces=false,
258 basicstyle=\small\ttfamily,
259 commentstyle=\color{BrickRed}\ttfamily,
260 keywordstyle=\color{Purple}\ttfamily,
261 %identifierstyle=\color{Blue}\ttfamily,
262 %functionstyle=\color{Blue}\ttfamily,
263 %typestyle=\color{ForestGreen}\ttfamily,
264 stringstyle=\color{Tan}\ttfamily,%
265 morekeywords={,complex,}%
266 frame=none,%
267 backgroundcolor=\color{LightGrey}%
268 }
269
270 \lstdefinestyle{myMatlab}{%
271 %\lstset{%
272 language=Matlab,
273 showstringspaces=false,
274 basicstyle=\small\ttfamily,
275 commentstyle=\color{BrickRed}\ttfamily,
276 keywordstyle=\color{Purple}\ttfamily,
277 %identifierstyle=\color{Blue}\ttfamily,
278 %functionstyle=\color{Blue}\ttfamily,
279 %typestyle=\color{ForestGreen}\ttfamily,
280 stringstyle=\color{Tan}\ttfamily,%
281 frame=none,%
282 backgroundcolor=\color{LightGrey}%
283 }
284
285 \lstdefinestyle{myScilab}{%
286 %\lstset{%
287 language=Scilab,
288 showstringspaces=false,
289 basicstyle=\small\ttfamily,
290 commentstyle=\color{BrickRed}\ttfamily,
291 keywordstyle=\color{Purple}\ttfamily,
292 %identifierstyle=\color{Blue}\ttfamily,
293 %functionstyle=\color{Blue}\ttfamily,
294 %typestyle=\color{ForestGreen}\ttfamily,
295 stringstyle=\color{Tan}\ttfamily,%
296 frame=none,%
297 backgroundcolor=\color{LightGrey}%
298 }
299
300 \lstdefinestyle{myShell}{%
301 %\lstset{%
302 language=ksh,
303 showstringspaces=false,
304 basicstyle=\small\ttfamily,
305 commentstyle=\color{Black}\ttfamily,
306 keywordstyle=\color{Black}\ttfamily,
307 %identifierstyle=\color{Blue}\ttfamily,
308 %functionstyle=\color{Blue}\ttfamily,
309 %typestyle=\color{ForestGreen}\ttfamily,
310 stringstyle=\color{Black}\ttfamily,%
311 frame=none,%
312 backgroundcolor=\color{LightGrey}%
313 }
314
315 \lstdefinestyle{myPython}{%
316 %\lstset{%
317 language=python,
318 showstringspaces=false,
319 basicstyle=\small\ttfamily,
320 commentstyle=\color{BrickRed}\ttfamily,
321 keywordstyle=\color{Purple}\ttfamily,
322 %identifierstyle=\color{Blue}\ttfamily,
323 %functionstyle=\color{Blue}\ttfamily,
324 %typestyle=\color{ForestGreen}\ttfamily,
325 stringstyle=\color{Tan}\ttfamily,%
326 frame=none,%
327 %backgroundcolor=\color{LightGrey}%
328 }
329
330 \lstdefinestyle{myhtml}{%
331 %\lstset{%
332 language=xml,
333 showstringspaces=false,
334 basicstyle=\small\ttfamily,
335 commentstyle=\color{BrickRed}\ttfamily,
336 keywordstyle=\color{Purple}\ttfamily,
337 %identifierstyle=\color{Blue}\ttfamily,
338 %functionstyle=\color{Blue}\ttfamily,
339 %typestyle=\color{ForestGreen}\ttfamily,
340 stringstyle=\color{Tan}\ttfamily,
341 morekeywords={,simulation,prop_dim,error_check,stochastic,%
342 globals,field,dimensions,lattice,domains,samples,vector,%
343 components,fourier_space,sequence,integrate,algorithm,%
344 interval,k_operators,constant,operator_names,vectors,%
345 output,filename,group,sampling,moments,benchmark,use_double,%
346 use_wisdom,use_prefs,binary_output,cycles,filter,post_propagation,%
347 default_value,argv,arg,iterations,cross_propagation,%
348 use_mpi,paths,seed,noises,author,description,name,type,%
349 }
350 frame=none,%
351 %framerule=2pt,%
352 backgroundcolor=\color{LightGrey}%
353 }
354
355 % this implements producing nice code blocks
356 % it also saves time, typing and
357 % *should* reduce errors in the text by removing doubling up of code
358 \lstnewenvironment{xmdsCode}[1][]{\lstset{style=myhtml}\lstset{#1}}{}
359
360 % this implements nicely formatted shell code
361 \lstnewenvironment{shellCode}[1][]{\lstset{style=myShell}\lstset{#1}}{}
362
363 % this implements nicely formatted Perl code
364 \lstnewenvironment{perlCode}[1][]{\lstset{style=myPerl}\lstset{#1}}{}
365
366 % this implements nicely formatted Python code
367 \lstnewenvironment{python}[1][]{\lstset{style=myPython}\lstset{#1}}{}
368
369 % this implements nicely formatted C++ code
370 \lstnewenvironment{CCode}{\lstset{style=myC++}}{}
371
372 % this implements nicely formatted matlab code
373 \lstnewenvironment{matlabCode}{\lstset{style=myMatlab}}{}
374
375 % this implements nicely formatted scilab code
376 \lstnewenvironment{scilabCode}{\lstset{style=myScilab}}{}
377
378 %Ensures that latex doesn't have an error if we don't specify the version
379 \providecommand{\RepVersion}{Unknown\xspace}
380 % to set this value use:
381 % (pdf)latex '\newcommand{\RepVersion}{version\xspace}\input{guide.tex}'
382 % as your command-line

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision

  ViewVC Help
Powered by ViewVC 1.1.26