/[escript]/trunk/doc/cookbook/cookbook_defs.tex
ViewVC logotype

Contents of /trunk/doc/cookbook/cookbook_defs.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2477 - (show annotations)
Wed Jun 17 06:22:15 2009 UTC (10 years, 2 months ago) by gross
Original Path: trunk/doc/cookbook/TEXT/cookbook_defs.tex
File MIME type: application/x-tex
File size: 13798 byte(s)
modification to the cookbook
1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 %
4 % Copyright (c) 2003-2008 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 physici % see http://www.ams.org/tex/amslatex.html
23 \usepackage{alltt} % handy verbatim stuff
24
25
26 %Tony's Commands
27 \newcommand{\editor}[1] {\textit{EDITORIAL: {#1}}}
28 %\newcommand{\eqref}[1] {(\ref{#1})}
29 \newcommand{\esc}{\module{escript}\xspace}
30 \newcommand{\fileex}[1]{\module{\textbackslash examples\textbackslash {#1}}\xspace}
31 \newcommand{\TODO}[1]{\textbf{TODO}:\xspace\textit{#1} }
32 \newcommand{\ESCRIPT}{\textit{escript}\xspace}
33 \newcommand{\ESYS}{\textit{esys}\xspace}
34 \newcommand{\FINLEY}{\textit{finley}\xspace}
35
36 % % define some handy commands for escript stuff
37 % \newcommand{\LINUX}{{\it Linux}\xspace}
38 % \newcommand{\WINDOWS}{{\it MS Windows}\xspace}
39 % \newcommand{\PYTHON}{{\it python}\xspace}
40 % % \newcommand{\netCDF}{{\it netCDF}\cite{NETCDF}\index{netCDF} \xspace}
41 % \newcommand{\netCDF}{{\it netCDF}\index{netCDF}\xspace}
42 % \newcommand{\escript}{\module{esys.escript}\xspace}
43 % \newcommand{\finley}{\module{esys.finley}\xspace}
44 % \newcommand{\esys}{\module{esys}\xspace}
45 % \newcommand{\pyvisi}{\module{esys.pyvisi}\xspace}
46 % \newcommand{\pycad}{\module{esys.pycad}\xspace}
47 % \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
48 % \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh} \xspace}
49 % \newcommand{\env}[1]{\textbf{\mbox{#1}}\index{Environment!#1}}
50 % % \newcommand{\MPI}{{\it MPI}\xspace\index{Message Passing Interface!MPI}\cite{MPI}\xspace}
51 % % \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\cite{OPENMP}\xspace}
52 % \newcommand{\MPI}{{\it MPI}\xspace\index{Message Passing Interface!MPI}\xspace}
53 % \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\xspace}
54 % \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
55 % \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
56 % \newcommand{\timeseries}{\module{esys.timeseries}\xspace}
57 % \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
58 % \newcommand{\pdetools}{\module{esys.pdetools}\xspace}
59 % \newcommand{\esysxml}{{\it esysxml}}
60 %
61 % \newcommand{\AdvectivePDE}{\class{AdvectivePDE}\xspace}
62 % \newcommand{\Poisson}{\class{Poisson}\xspace}
63 % \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
64 % \newcommand{\Lame}{\class{Lame}\xspace}
65 % \newcommand{\Data}{\class{Data}\xspace}
66 % \newcommand{\EmptyData}{empty \class{Data}\index{empty Data}\xspace}
67 % \newcommand{\Domain}{\class{Domain}\xspace}
68 % %\newcommand{\VTK}{{\it vtk} \cite{VTK}\index{visualization!vtk} \xspace}
69 % \newcommand{\GnuPlot}{{\it gnuplot} \cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}}
70 % \newcommand{\mayavi}{{\it mayavi}\index{visualization!mayavi}\index{mayavi}}
71 % \newcommand{\OpenDX}{{\it OpenDX} \cite{OPENDX}\xspace}
72 % \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
73 % \newcommand{\False}{\constant{False}\xspace}
74 % \newcommand{\True}{\constant{True}\xspace}
75 % \newcommand{\PCG}{\constant{LinearPDE.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
76 % \newcommand{\BiCGStab}{\constant{LinearPDE.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
77 % \newcommand{\Direct}{\constant{LinearPDE.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
78 % \newcommand{\GMRES}{\constant{LinearPDE.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
79 % \newcommand{\PRESTWENTY}{\constant{LinearPDE.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
80 % \newcommand{\JACOBI}{\constant{LinearPDE.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
81 % \newcommand{\ILU}{\constant{LinearPDE.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
82 % \newcommand{\ILUT}{\constant{LinearPDE.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
83 % \newcommand{\LUMPING}{\constant{LinearPDE.LUMPING}\xspace\index{linear solver!lumping}\index{lumping}}
84 % \newcommand{\NOREORDERING}{\constant{LinearPDE.NO\hackscore REORDERING}\xspace}
85 % \newcommand{\MINIMUMFILLIN}{\constant{LinearPDE.MINIMUM\hackscore FILL\hackscore IN}\xspace\index{linear solver!minimum fill-in ordering}\index{minimum fill-in ordering}}
86 % \newcommand{\NESTEDDESCTION}{\constant{LinearPDE.NESTED\hackscore DISSECTION}\xspace\index{linear solver!nested dissection ordering}\index{nested dissection}}
87 %
88 % \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
89 % \newcommand{\Operator}{\class{Operator}\xspace}
90 % \newcommand{\SolutionFS}{solution \class{FunctionSpace}\index{solution}\xspace}
91 % \newcommand{\ReducedSolutionFS}{reduced solution \class{FunctionSpace}\index{solution!reduced}\xspace}
92 % \newcommand{\FunctionOnBoundary}{boundary \class{FunctionSpace}\xspace}
93 % \newcommand{\Function}{general \class{FunctionSpace}\xspace}
94 % \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
95 % \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
96 % \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
97 % \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
98 % \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
99 % \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
100 % \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
101 % \newcommand{\Tensor}{{tensor \Data object}\xspace}
102 % \newcommand{\Vector}{{vector \Data object}\xspace}
103 % \newcommand{\Scalar}{{scalar \Data object}\xspace}
104 % \newcommand{\DataSample}{{data sample}\index{data sample}\xspace}
105 % \newcommand{\DataSamplePoints}{{data sample points}\index{data sample!points}\xspace}
106 % \newcommand{\numarray}{\module{numarray}\xspace}
107 % \newcommand{\numarrayNA}{\module{numarray}.\class{NumArray}\xspace}
108 % \newcommand{\Shape}{shape\xspace\index{shape}}
109 % \newcommand{\Rank}{rank\xspace\index{shape}}
110 % \newcommand{\ExampleDirectory}{example directory\xspace}
111 % \newcommand{\ReferenceGuide}{\url{http://shake200.esscc.uq.edu.au/esys/docs.html}\xspace}
112 % \newcommand{\Point}{\class{Point} \xspace}
113 % \newcommand{\PropertySet}{\class{PropertySet} \xspace}
114 % \newcommand{\Design}{\class{Design} \xspace}
115 % \newcommand{\TagMap}{\class{TagMap} \xspace}
116 % \newcommand{\ManifoldOneD}{\class{Manifold1D} \xspace}
117 % \newcommand{\ManifoldTwoD}{\class{Manifold2D} \xspace}
118 % \newcommand{\ManifoldThreeD}{\class{Manifold3D} \xspace}
119 %
120 % % default width for figures
121 % \newcommand{\figwidth}{100mm}
122 % % commands useful in cross-referencing
123 % \newcommand {\Ref}[1] {Reference~\cite{#1}}
124 % \newcommand {\Sec}[1] {Section~\ref{#1}}
125 % \newcommand {\App}[1] {Appendix~\ref{#1}}
126 % \newcommand {\Chap}[1] {Chapter~\ref{#1}}
127 % \newcommand {\etal} {\emph{~et~al.}}
128 % \newcommand {\fig}[1] {Figure~\ref{#1}}
129 % \newcommand {\eqn}[1] {Equation~(\ref{#1})}
130 % \newcommand {\tab}[1] {Table~\ref{#1}}
131 %
132 % % this stops one figure taking up a whole page and lets more text onto
133 % % the one page when a figure exists
134 % \renewcommand{\floatpagefraction}{0.8} % Default = 0.5
135 %
136 % % improved version of caption handling
137 % \usepackage{ccaption}
138 % \captionnamefont{\scshape}
139 % \captionstyle{}
140 % \makeatletter
141 % \renewcommand{\fnum@figure}[1]{\quad\small\textsc{\figurename~\thefigure}:}
142 % \renewcommand{\@makecaption}[2]{%
143 % \vskip\abovecaptionskip
144 % \sbox\@tempboxa{#1: #2}%
145 % \ifdim \wd\@tempboxa >\hsize
146 % \def\baselinestretch{1}\@normalsize
147 % #1: #2\par
148 % \def\baselinestretch{1.5}\@normalsize
149 % \else
150 % \global \@minipagefalse
151 % \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
152 % \fi
153 % \vskip\belowcaptionskip}
154 % \makeatother
155 %
156 % % \usepackage{fancyvrb} % fancy verbatim stuff. Needed so code below goes
157 % %%% this code grabbed from the PyScript docs
158 % %%% pyscript.sourceforge.net
159
160 % --------------------------------------------------------------
161 % Code format within \Verb
162 % --------------------------------------------------------------
163
164 % \definecolor{pycolor}{rgb}{0,0.4,0}
165
166 %% \DefineVerbatimEnvironment{python}{Verbatim}
167 %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},
168 %% formatcom=\color{pycolor}\small,fontshape=rm}
169
170 %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}
171
172 % \RecustomVerbatimCommand{\Verb}{Verb}{formatcom=\color{pycolor}\small,fontshape=rm}
173
174 %%% end of grabbed code
175
176 % this is for when one uses pdflatex and therefore needs to load pdf
177 % figures into \includegraphics
178 % \ifpdf
179 % \DeclareGraphicsExtensions{.pdf} % this command defined in graphicx
180 % \pdfcompresslevel=9 % 0: no compression, 9: highest compression
181 % % or, set compress_level 9 in file pdftex.cfg
182 % \else
183 % \DeclareGraphicsExtensions{.eps}
184 % \fi
185 %
186 % % defines the colour for the background of code examples
187 % \definecolor{LightGrey}{gray}{0.9}
188 %
189 % % add the listings package to pretty print the code output
190 % \usepackage{listings}
191 %
192 %
193 % %Some colour definitions added to keep pdflatex happy
194 % %I make no claim that these values are particularly good
195 % \definecolor{Purple}{rgb}{0.7, 0, 0.6}
196 % \definecolor{Tan}{rgb}{0.5,0.5,0.5}
197 % \definecolor{BrickRed}{rgb}{0.7, 0.2, 0.2}
198 %
199 % % All the \color{x} used to be \color[named]{x}
200 % %end color defs
201 %
202 % \lstdefinestyle{myC++}{%
203 % %\lstset{%
204 % language=C++,
205 % showstringspaces=false,
206 % basicstyle=\small\ttfamily,
207 % commentstyle=\color{BrickRed}\ttfamily,
208 % keywordstyle=\color{Purple}\ttfamily,
209 % %identifierstyle=\color{Blue}\ttfamily,
210 % %functionstyle=\color{Blue}\ttfamily,
211 % %typestyle=\color{ForestGreen}\ttfamily,
212 % stringstyle=\color{Tan}\ttfamily,%
213 % morekeywords={,complex,}%
214 % frame=none,%
215 % backgroundcolor=\color{LightGrey}%
216 % }
217 %
218 % \lstdefinestyle{myMatlab}{%
219 % %\lstset{%
220 % language=Matlab,
221 % showstringspaces=false,
222 % basicstyle=\small\ttfamily,
223 % commentstyle=\color{BrickRed}\ttfamily,
224 % keywordstyle=\color{Purple}\ttfamily,
225 % %identifierstyle=\color{Blue}\ttfamily,
226 % %functionstyle=\color{Blue}\ttfamily,
227 % %typestyle=\color{ForestGreen}\ttfamily,
228 % stringstyle=\color{Tan}\ttfamily,%
229 % frame=none,%
230 % backgroundcolor=\color{LightGrey}%
231 % }
232 %
233 % \lstdefinestyle{myScilab}{%
234 % %\lstset{%
235 % language=Scilab,
236 % showstringspaces=false,
237 % basicstyle=\small\ttfamily,
238 % commentstyle=\color{BrickRed}\ttfamily,
239 % keywordstyle=\color{Purple}\ttfamily,
240 % %identifierstyle=\color{Blue}\ttfamily,
241 % %functionstyle=\color{Blue}\ttfamily,
242 % %typestyle=\color{ForestGreen}\ttfamily,
243 % stringstyle=\color{Tan}\ttfamily,%
244 % frame=none,%
245 % backgroundcolor=\color{LightGrey}%
246 % }
247 %
248 % \lstdefinestyle{myShell}{%
249 % %\lstset{%
250 % language=ksh,
251 % showstringspaces=false,
252 % basicstyle=\small\ttfamily,
253 % commentstyle=\color{Black}\ttfamily,
254 % keywordstyle=\color{Black}\ttfamily,
255 % %identifierstyle=\color{Blue}\ttfamily,
256 % %functionstyle=\color{Blue}\ttfamily,
257 % %typestyle=\color{ForestGreen}\ttfamily,
258 % stringstyle=\color{Black}\ttfamily,%
259 % frame=none,%
260 % backgroundcolor=\color{LightGrey}%
261 % }
262 %
263 % \lstdefinestyle{myPython}{%
264 % %\lstset{%
265 % language=python,
266 % showstringspaces=false,
267 % basicstyle=\small\ttfamily,
268 % commentstyle=\color{BrickRed}\ttfamily,
269 % keywordstyle=\color{Purple}\ttfamily,
270 % %identifierstyle=\color{Blue}\ttfamily,
271 % %functionstyle=\color{Blue}\ttfamily,
272 % %typestyle=\color{ForestGreen}\ttfamily,
273 % stringstyle=\color{Tan}\ttfamily,%
274 % frame=none,%
275 % %backgroundcolor=\color{LightGrey}%
276 % }
277 %
278 % \lstdefinestyle{myhtml}{%
279 % %\lstset{%
280 % language=xml,
281 % showstringspaces=false,
282 % basicstyle=\small\ttfamily,
283 % commentstyle=\color{BrickRed}\ttfamily,
284 % keywordstyle=\color{Purple}\ttfamily,
285 % %identifierstyle=\color{Blue}\ttfamily,
286 % %functionstyle=\color{Blue}\ttfamily,
287 % %typestyle=\color{ForestGreen}\ttfamily,
288 % stringstyle=\color{Tan}\ttfamily,
289 % morekeywords={,simulation,prop_dim,error_check,stochastic,%
290 % globals,field,dimensions,lattice,domains,samples,vector,%
291 % components,fourier_space,sequence,integrate,algorithm,%
292 % interval,k_operators,constant,operator_names,vectors,%
293 % output,filename,group,sampling,moments,benchmark,use_double,%
294 % use_wisdom,use_prefs,binary_output,cycles,filter,post_propagation,%
295 % default_value,argv,arg,iterations,cross_propagation,%
296 % use_mpi,paths,seed,noises,author,description,name,type,%
297 % }
298 % frame=none,%
299 % %framerule=2pt,%
300 % backgroundcolor=\color{LightGrey}%
301 % }
302 %
303 % % this implements producing nice code blocks
304 % % it also saves time, typing and
305 % % *should* reduce errors in the text by removing doubling up of code
306 % \lstnewenvironment{xmdsCode}[1][]{\lstset{style=myhtml}\lstset{#1}}{}
307 %
308 % % this implements nicely formatted shell code
309 % \lstnewenvironment{shellCode}[1][]{\lstset{style=myShell}\lstset{#1}}{}
310 %
311 % % this implements nicely formatted Perl code
312 % \lstnewenvironment{perlCode}[1][]{\lstset{style=myPerl}\lstset{#1}}{}
313 %
314 % % this implements nicely formatted Python code
315 % \lstnewenvironment{python}[1][]{\lstset{style=myPython}\lstset{#1}}{}
316 %
317 % % this implements nicely formatted C++ code
318 % \lstnewenvironment{CCode}{\lstset{style=myC++}}{}
319 %
320 % % this implements nicely formatted matlab code
321 % \lstnewenvironment{matlabCode}{\lstset{style=myMatlab}}{}
322 %
323 % % this implements nicely formatted scilab code
324 % \lstnewenvironment{scilabCode}{\lstset{style=myScilab}}{}
325 %
326 % %Ensures that latex doesn't have an error if we don't specify the version
327 % \providecommand{\RepVersion}{Unknown\xspace}
328 % to set this value use:
329 % (pdf)latex '\newcommand{\RepVersion}{version\xspace}\input{guide.tex}'
330 % as your command-line

  ViewVC Help
Powered by ViewVC 1.1.26