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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.26