/[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 1205 - (show annotations)
Fri Jun 29 04:44:04 2007 UTC (12 years, 3 months ago) by jongui
Original Path: trunk/doc/user/guide_defs.tex
File MIME type: application/x-tex
File size: 14428 byte(s)
- Fixed a minor bug in the Velocity module.
- Added the Rectangle module which enables rectangles to be created.
- Added corresponding examples and test cases for the Rectangle.
- Updated the guide and necessary epydocs.



1 % $Id$
2 %
3 % Copyright © 2006 by ACcESS MNRF
4 % \url{http://www.access.edu.au
5 % Primary Business: Queensland, Australia.
6 % Licensed under the Open Software License version 3.0
7 % http://www.opensource.org/licenses/osl-3.0.php
8 %
9
10
11 \usepackage{epsfig}
12 \usepackage{graphicx,color}
13 \usepackage{makeidx} % handle the index properly
14 \usepackage{xspace} % handle spaces after commands more nicely
15 % use the ams math stuff, as it makes the maths easier to code, and
16 % nicer output than the standard LaTeX stuff
17 \usepackage{amsmath,amsfonts,amssymb} % this is handy for mathematicians and physicists
18 % see http://www.ams.org/tex/amslatex.html
19 \usepackage{alltt} % handy verbatim stuff
20
21
22 % define some handy commands for escript stuff
23 \newcommand{\LINUX}{{\it Linux}\xspace}
24 \newcommand{\netCDF}{{\it netCDF}\cite{NETCDF}\index{netCDF} \xspace}
25 \newcommand{\escript}{\module{esys.escript}\xspace}
26 \newcommand{\finley}{\module{esys.finley}\xspace}
27 \newcommand{\esys}{\module{esys}\xspace}
28 \newcommand{\bruce}{\module{esys.bruce}\xspace}
29 \newcommand{\pyvisi}{\module{esys.pyvisi}\xspace}
30 \newcommand{\pycad}{\module{esys.pycad}\xspace}
31 \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
32 \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh} \xspace}
33
34
35 \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
36 \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
37 \newcommand{\timeseries}{\module{esys.timeseries}\xspace}
38 \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
39 \newcommand{\pdetools}{\module{esys.pdetools}\xspace}
40
41 \newcommand{\AdvectivePDE}{\class{AdvectivePDE}\xspace}
42 \newcommand{\Poisson}{\class{Poisson}\xspace}
43 \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
44 \newcommand{\Lame}{\class{Lame}\xspace}
45 \newcommand{\Data}{\class{Data}\xspace}
46 \newcommand{\EmptyData}{empty \class{Data} \index{empty Data}\xspace}
47 \newcommand{\Domain}{\class{Domain}\xspace}
48 %\newcommand{\VTK}{{\it vtk} \cite{VTK}\index{visualization!vtk} \xspace}
49 \newcommand{\GnuPlot}{{\it gnuplot} \cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}}
50 \newcommand{\mayavi}{{\it mayavi} \index{visualization!mayavi}\index{mayavi}}
51 \newcommand{\OpenDX}{{\it OpenDX} \cite{OPENDX}\xspace}
52 \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
53 \newcommand{\False}{\constant{False}\xspace}
54 \newcommand{\True}{\constant{True}\xspace}
55 \newcommand{\PCG}{\constant{LinearPDE.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
56 \newcommand{\BiCGStab}{\constant{LinearPDE.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
57 \newcommand{\Direct}{\constant{LinearPDE.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
58 \newcommand{\GMRES}{\constant{LinearPDE.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
59 \newcommand{\PRESTWENTY}{\constant{LinearPDE.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
60 \newcommand{\JACOBI}{\constant{LinearPDE.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
61 \newcommand{\ILU}{\constant{LinearPDE.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
62 \newcommand{\ILUT}{\constant{LinearPDE.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
63 \newcommand{\LUMPING}{\constant{LinearPDE.LUMPING}\xspace\index{linear solver!lumping}\index{lumping}}
64 \newcommand{\NOREORDERING}{\constant{LinearPDE.NO\hackscore REORDERING}\xspace}
65 \newcommand{\MINIMUMFILLIN}{\constant{LinearPDE.MINIMUM\hackscore FILL\hackscore IN}\xspace\index{linear solver!minimum fill-in ordering}\index{minimum fill-in ordering}}
66 \newcommand{\NESTEDDESCTION}{\constant{LinearPDE.NESTED\hackscore DISSECTION}\xspace\index{linear solver!nested dissection ordering}\index{nested dissection}}
67
68 \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
69 \newcommand{\Operator}{\class{Operator}\xspace}
70 \newcommand{\SolutionFS}{solution \class{FunctionSpace}\index{solution}\xspace}
71 \newcommand{\ReducedSolutionFS}{reduced solution \class{FunctionSpace}\index{solution!reduced}\xspace}
72 \newcommand{\FunctionOnBoundary}{boundary \class{FunctionSpace}\xspace}
73 \newcommand{\Function}{general \class{FunctionSpace}\xspace}
74 \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
75 \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
76 \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
77 \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
78 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
79 \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
80 \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
81 \newcommand{\Tensor}{{tensor \Data object}\xspace}
82 \newcommand{\Vector}{{vector \Data object}\xspace}
83 \newcommand{\Scalar}{{scalar \Data object}\xspace}
84 \newcommand{\DataSample}{{data sample} \index{data sample}\xspace}
85 \newcommand{\DataSamplePoints}{{data sample points} \index{data sample!points}\xspace}
86 \newcommand{\numarray}{\module{numarray}\xspace}
87 \newcommand{\Shape}{shape\xspace\index{shape}}
88 \newcommand{\Rank}{rank\xspace\index{shape}}
89 \newcommand{\ExampleDirectory}{example directory\xspace}
90 \newcommand{\ReferenceGuide}{\url{http://www.iservo.edu.au/esys/epydoc/index.html} \xspace}
91 \newcommand{\Point}{\class{Point} \xspace}
92 \newcommand{\PropertySet}{\class{PropertySet} \xspace}
93 \newcommand{\Design}{\class{Design} \xspace}
94 \newcommand{\TagMap}{\class{TagMap} \xspace}
95 \newcommand{\ManifoldOneD}{\class{Manifold1D} \xspace}
96 \newcommand{\ManifoldTwoD}{\class{Manifold2D} \xspace}
97 \newcommand{\ManifoldThreeD}{\class{Manifold3D} \xspace}
98
99 % handy commands for pyvisi
100 \newcommand{\VTK}{{\it VTK} \xspace}
101 \newcommand{\VTKUrl}{\url{http://www.vtk.org/}\xspace}
102 \newcommand{\Scene}{\class{Scene}\xspace}
103 \newcommand{\Camera}{\class{Camera}\xspace}
104 \newcommand{\Light}{\class{Light}\xspace}
105 \newcommand{\DataCollector}{\class{DataCollector}\xspace}
106 \newcommand{\ImageReader}{\class{ImageReader}\xspace}
107 \newcommand{\TextTwoD}{\class{Text2D}\xspace}
108 \newcommand{\ActorTwoD}{\class{Actor2D}\xspace}
109 \newcommand{\ActorThreeD}{\class{Actor3D}\xspace}
110 \newcommand{\Transform}{\class{Transform}\xspace}
111 \newcommand{\Clipper}{\class{Clipper}\xspace}
112 \newcommand{\Map}{\class{Map}\xspace}
113 \newcommand{\MapOnPlaneCut}{\class{MapOnPlaneCut}\xspace}
114 \newcommand{\MapOnPlaneClip}{\class{MapOnPlaneClip}\xspace}
115 \newcommand{\MapOnScalarClip}{\class{MapOnScalarClip}\xspace}
116 \newcommand{\GlyphThreeD}{\class{Glyph3D}\xspace}
117 \newcommand{\MaskPoints}{\class{MaskPoints}\xspace}
118 \newcommand{\Velocity}{\class{Velocity}\xspace}
119 \newcommand{\VelocityOnPlaneCut}{\class{VelocityOnPlaneCut}\xspace}
120 \newcommand{\VelocityOnPlaneClip}{\class{VelocityOnPlaneClip}\xspace}
121 \newcommand{\Sphere}{\class{Sphere}\xspace}
122 \newcommand{\TensorGlyph}{\class{TensorGlyph}\xspace}
123 \newcommand{\Ellipsoid}{\class{Ellipsoid}\xspace}
124 \newcommand{\EllipsoidOnPlaneCut}{\class{EllipsoidOnPlaneCut}\xspace}
125 \newcommand{\EllipsoidOnPlaneClip}{\class{EllipsoidOnPlaneClip}\xspace}
126 \newcommand{\ContourModule}{\class{ContourModule}\xspace}
127 \newcommand{\Contour}{\class{Contour}\xspace}
128 \newcommand{\ContourOnPlaneCut}{\class{ContourOnPlaneCut}\xspace}
129 \newcommand{\ContourOnPlaneClip}{\class{ContourOnPlaneClip}\xspace}
130 \newcommand{\PointSource}{\class{PointSource}\xspace}
131 \newcommand{\StreamLineModule}{\class{StreamLineModule}\xspace}
132 \newcommand{\Tube}{\class{Tube}\xspace}
133 \newcommand{\StreamLine}{\class{StreamLine}\xspace}
134 \newcommand{\Warp}{\class{Warp}\xspace}
135 \newcommand{\Carpet}{\class{Carpet}\xspace}
136 \newcommand{\PlaneSource}{\class{PlaneSource}\xspace}
137 \newcommand{\Image}{\class{Image}\xspace}
138 \newcommand{\Logo}{\class{Logo}\xspace}
139 \newcommand{\ImageReslice}{\class{ImageReslice}\xspace}
140 \newcommand{\Position}{\class{Position}\xspace}
141 \newcommand{\DataSetMapper}{\class{DataSetMapper}\xspace}
142 \newcommand{\Legend}{\class{Legend}\xspace}
143 \newcommand{\ScalarBar}{\class{ScalarBar}\xspace}
144 \newcommand{\Movie}{\class{Movie}\xspace}
145 \newcommand{\CubeSource}{\class{CubeSource}\xspace}
146 \newcommand{\Rectangle}{\class{Rectangle}\xspace}
147 \newcommand{\LocalPosition}{\class{LocalPosition}\xspace}
148 \newcommand{\GlobalPosition}{\class{GlobalPosition}\xspace}
149 \newcommand{\thumbnailwidth}{50mm}
150
151 % default width for figures
152 \newcommand{\figwidth}{100mm}
153 % commands useful in cross-referencing
154 \newcommand {\Ref}[1] {Reference~\cite{#1}}
155 \newcommand {\Sec}[1] {Section~\ref{#1}}
156 \newcommand {\App}[1] {Appendix~\ref{#1}}
157 \newcommand {\Chap}[1] {Chapter~\ref{#1}}
158 \newcommand {\etal} {\emph{~et~al.}}
159 \newcommand {\fig}[1] {Figure~\ref{#1}}
160 \newcommand {\eqn}[1] {Equation~(\ref{#1})}
161 \newcommand {\tab}[1] {Table~\ref{#1}}
162
163 % this stops one figure taking up a whole page and lets more text onto
164 % the one page when a figure exists
165 \renewcommand{\floatpagefraction}{0.8} % Default = 0.5
166
167 % improved version of caption handling
168 \usepackage{ccaption}
169 \captionnamefont{\scshape}
170 \captionstyle{}
171 \makeatletter
172 \renewcommand{\fnum@figure}[1]{\quad\small\textsc{\figurename~\thefigure}:}
173 \renewcommand{\@makecaption}[2]{%
174 \vskip\abovecaptionskip
175 \sbox\@tempboxa{#1: #2}%
176 \ifdim \wd\@tempboxa >\hsize
177 \def\baselinestretch{1}\@normalsize
178 #1: #2\par
179 \def\baselinestretch{1.5}\@normalsize
180 \else
181 \global \@minipagefalse
182 \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
183 \fi
184 \vskip\belowcaptionskip}
185 \makeatother
186
187 % \usepackage{fancyvrb} % fancy verbatim stuff. Needed so code below goes
188 %%% this code grabbed from the PyScript docs
189 %%% pyscript.sourceforge.net
190
191 % --------------------------------------------------------------
192 % Code format within \Verb
193 % --------------------------------------------------------------
194
195 % \definecolor{pycolor}{rgb}{0,0.4,0}
196
197 %% \DefineVerbatimEnvironment{python}{Verbatim}
198 %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},
199 %% formatcom=\color{pycolor}\small,fontshape=rm}
200
201 %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}
202
203 % \RecustomVerbatimCommand{\Verb}{Verb}{formatcom=\color{pycolor}\small,fontshape=rm}
204
205 %%% end of grabbed code
206
207 % this is for when one uses pdflatex and therefore needs to load pdf
208 % figures into \includegraphics
209 \ifpdf
210 \DeclareGraphicsExtensions{.pdf} % this command defined in graphicx
211 \pdfcompresslevel=9 % 0: no compression, 9: highest compression
212 % or, set compress_level 9 in file pdftex.cfg
213 \else
214 \DeclareGraphicsExtensions{.eps}
215 \fi
216
217 % defines the colour for the background of code examples
218 \definecolor{LightGrey}{gray}{0.9}
219
220 % add the listings package to pretty print the code output
221 \usepackage{listings}
222
223 \lstdefinestyle{myC++}{%
224 %\lstset{%
225 language=C++,
226 showstringspaces=false,
227 basicstyle=\small\ttfamily,
228 commentstyle=\color[named]{BrickRed}\ttfamily,
229 keywordstyle=\color[named]{Purple}\ttfamily,
230 %identifierstyle=\color[named]{Blue}\ttfamily,
231 %functionstyle=\color[named]{Blue}\ttfamily,
232 %typestyle=\color[named]{ForestGreen}\ttfamily,
233 stringstyle=\color[named]{Tan}\ttfamily,%
234 morekeywords={,complex,}%
235 frame=none,%
236 backgroundcolor=\color{LightGrey}%
237 }
238
239 \lstdefinestyle{myMatlab}{%
240 %\lstset{%
241 language=Matlab,
242 showstringspaces=false,
243 basicstyle=\small\ttfamily,
244 commentstyle=\color[named]{BrickRed}\ttfamily,
245 keywordstyle=\color[named]{Purple}\ttfamily,
246 %identifierstyle=\color[named]{Blue}\ttfamily,
247 %functionstyle=\color[named]{Blue}\ttfamily,
248 %typestyle=\color[named]{ForestGreen}\ttfamily,
249 stringstyle=\color[named]{Tan}\ttfamily,%
250 frame=none,%
251 backgroundcolor=\color{LightGrey}%
252 }
253
254 \lstdefinestyle{myScilab}{%
255 %\lstset{%
256 language=Scilab,
257 showstringspaces=false,
258 basicstyle=\small\ttfamily,
259 commentstyle=\color[named]{BrickRed}\ttfamily,
260 keywordstyle=\color[named]{Purple}\ttfamily,
261 %identifierstyle=\color[named]{Blue}\ttfamily,
262 %functionstyle=\color[named]{Blue}\ttfamily,
263 %typestyle=\color[named]{ForestGreen}\ttfamily,
264 stringstyle=\color[named]{Tan}\ttfamily,%
265 frame=none,%
266 backgroundcolor=\color{LightGrey}%
267 }
268
269 \lstdefinestyle{myShell}{%
270 %\lstset{%
271 language=ksh,
272 showstringspaces=false,
273 basicstyle=\small\ttfamily,
274 commentstyle=\color[named]{Black}\ttfamily,
275 keywordstyle=\color[named]{Black}\ttfamily,
276 %identifierstyle=\color[named]{Blue}\ttfamily,
277 %functionstyle=\color[named]{Blue}\ttfamily,
278 %typestyle=\color[named]{ForestGreen}\ttfamily,
279 stringstyle=\color[named]{Black}\ttfamily,%
280 frame=none,%
281 backgroundcolor=\color{LightGrey}%
282 }
283
284 \lstdefinestyle{myPython}{%
285 %\lstset{%
286 language=python,
287 showstringspaces=false,
288 basicstyle=\small\ttfamily,
289 commentstyle=\color[named]{BrickRed}\ttfamily,
290 keywordstyle=\color[named]{Purple}\ttfamily,
291 %identifierstyle=\color[named]{Blue}\ttfamily,
292 %functionstyle=\color[named]{Blue}\ttfamily,
293 %typestyle=\color[named]{ForestGreen}\ttfamily,
294 stringstyle=\color[named]{Tan}\ttfamily,%
295 frame=none,%
296 %backgroundcolor=\color{LightGrey}%
297 }
298
299 \lstdefinestyle{myhtml}{%
300 %\lstset{%
301 language=xml,
302 showstringspaces=false,
303 basicstyle=\small\ttfamily,
304 commentstyle=\color[named]{BrickRed}\ttfamily,
305 keywordstyle=\color[named]{Purple}\ttfamily,
306 %identifierstyle=\color[named]{Blue}\ttfamily,
307 %functionstyle=\color[named]{Blue}\ttfamily,
308 %typestyle=\color[named]{ForestGreen}\ttfamily,
309 stringstyle=\color[named]{Tan}\ttfamily,
310 morekeywords={,simulation,prop_dim,error_check,stochastic,%
311 globals,field,dimensions,lattice,domains,samples,vector,%
312 components,fourier_space,sequence,integrate,algorithm,%
313 interval,k_operators,constant,operator_names,vectors,%
314 output,filename,group,sampling,moments,benchmark,use_double,%
315 use_wisdom,use_prefs,binary_output,cycles,filter,post_propagation,%
316 default_value,argv,arg,iterations,cross_propagation,%
317 use_mpi,paths,seed,noises,author,description,name,type,%
318 }
319 frame=none,%
320 %framerule=2pt,%
321 backgroundcolor=\color{LightGrey}%
322 }
323
324 % this implements producing nice code blocks
325 % it also saves time, typing and
326 % *should* reduce errors in the text by removing doubling up of code
327 \lstnewenvironment{xmdsCode}[1][]{\lstset{style=myhtml}\lstset{#1}}{}
328
329 % this implements nicely formatted shell code
330 \lstnewenvironment{shellCode}[1][]{\lstset{style=myShell}\lstset{#1}}{}
331
332 % this implements nicely formatted Perl code
333 \lstnewenvironment{perlCode}[1][]{\lstset{style=myPerl}\lstset{#1}}{}
334
335 % this implements nicely formatted Python code
336 \lstnewenvironment{python}[1][]{\lstset{style=myPython}\lstset{#1}}{}
337
338 % this implements nicely formatted C++ code
339 \lstnewenvironment{CCode}{\lstset{style=myC++}}{}
340
341 % this implements nicely formatted matlab code
342 \lstnewenvironment{matlabCode}{\lstset{style=myMatlab}}{}
343
344 % this implements nicely formatted scilab code
345 \lstnewenvironment{scilabCode}{\lstset{style=myScilab}}{}
346

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26