/[escript]/trunk/doc/user/user_defs.tex
ViewVC logotype

Contents of /trunk/doc/user/user_defs.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3792 - (show annotations)
Wed Feb 1 06:16:25 2012 UTC (6 years, 11 months ago) by caltinay
File MIME type: application/x-tex
File size: 11140 byte(s)
Merged ripley rectangular domain into trunk.

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