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

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/esys2/doc/user/guide_defs.tex revision 121 by jgs, Fri May 6 04:26:16 2005 UTC trunk/doc/user/guide_defs.tex revision 2128 by lgraham, Thu Dec 4 03:48:22 2008 UTC
# Line 1  Line 1 
 % $Id$  
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}  \usepackage{epsfig}
17  \usepackage{graphicx,color}  \usepackage{graphicx,color}
18  \usepackage{makeidx}  % handle the index properly  \usepackage{makeidx}  % handle the index properly
# Line 12  Line 25 
25    
26    
27  % define some handy commands for escript stuff  % define some handy commands for escript stuff
28  \newcommand{\ESyS}{\module{esys}\xspace}  \newcommand{\LINUX}{{\it Linux}\xspace}
29    \newcommand{\netCDF}{{\it netCDF}\cite{NETCDF}\index{netCDF} \xspace}
30  \newcommand{\escript}{\module{esys.escript}\xspace}  \newcommand{\escript}{\module{esys.escript}\xspace}
31  \newcommand{\finley}{\module{esys.finley}\xspace}  \newcommand{\finley}{\module{esys.finley}\xspace}
32  \newcommand{\linearPDEsPack}{\module{esys.linearPDEs}\xspace}  \newcommand{\esys}{\module{esys}\xspace}
33    \newcommand{\pyvisi}{\module{esys.pyvisi}\xspace}
34    \newcommand{\pycad}{\module{esys.pycad}\xspace}
35    \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
36    \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh} \xspace}
37    
38    
39    \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
40  \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}  \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
41  \newcommand{\timeseries}{\module{esys.timeseries}\xspace}  \newcommand{\timeseries}{\module{esys.timeseries}\xspace}
42  \newcommand{\modelframe}{\module{esys.modelframe}\xspace}  \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
43  \newcommand{\pdetools}{\module{esys.pdetools}\xspace}  \newcommand{\pdetools}{\module{esys.pdetools}\xspace}
44    
45  \newcommand{\AdvectivePDE}{\class{AdvectivePDE}\xspace}  \newcommand{\AdvectivePDE}{\class{AdvectivePDE}\xspace}
46  \newcommand{\Poisson}{\class{Poisson}\xspace}  \newcommand{\Poisson}{\class{Poisson}\xspace}
47    \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
48    \newcommand{\Lame}{\class{Lame}\xspace}
49  \newcommand{\Data}{\class{Data}\xspace}  \newcommand{\Data}{\class{Data}\xspace}
50  \newcommand{\EmptyData}{empty \class{Data} \index{empty Data}\xspace}  \newcommand{\EmptyData}{empty \class{Data}\index{empty Data}\xspace}
51  \newcommand{\Domain}{\class{Domain}\xspace}  \newcommand{\Domain}{\class{Domain}\xspace}
52  \newcommand{\OpenDX}{{\it OpenDX}\xspace}  %\newcommand{\VTK}{{\it vtk} \cite{VTK}\index{visualization!vtk} \xspace}
53    \newcommand{\GnuPlot}{{\it gnuplot} \cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}}
54    \newcommand{\mayavi}{{\it mayavi}\index{visualization!mayavi}\index{mayavi}}
55    \newcommand{\OpenDX}{{\it OpenDX} \cite{OPENDX}\xspace}
56  \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}  \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
57  \newcommand{\False}{\constant{False}\xspace}  \newcommand{\False}{\constant{False}\xspace}
58  \newcommand{\True}{\constant{True}\xspace}  \newcommand{\True}{\constant{True}\xspace}
59  \newcommand{\PCG}{\constant{PCG}\index{linear solver!PCG}\index{PCG}}  \newcommand{\PCG}{\constant{LinearPDE.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
60  \newcommand{\BiCGStab}{\constant{BICGSTAB}\index{linear solver!BiCGStab}\index{BiCGStab}}  \newcommand{\BiCGStab}{\constant{LinearPDE.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
61  \newcommand{\Direct}{\constant{DIRECT}\index{linear solver!Direct}\index{Direct solver}}  \newcommand{\Direct}{\constant{LinearPDE.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
62  \newcommand{\GMRES}{\constant{GMRES}\index{linear solver!GMRES}\index{GMRES}}  \newcommand{\GMRES}{\constant{LinearPDE.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
63  \newcommand{\PRESTWENTY}{\constant{PRES20}\index{linear solver!PRES20}\index{PRES20}}  \newcommand{\PRESTWENTY}{\constant{LinearPDE.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
64    \newcommand{\JACOBI}{\constant{LinearPDE.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
65    \newcommand{\ILU}{\constant{LinearPDE.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
66    \newcommand{\ILUT}{\constant{LinearPDE.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
67    \newcommand{\LUMPING}{\constant{LinearPDE.LUMPING}\xspace\index{linear solver!lumping}\index{lumping}}
68    \newcommand{\NOREORDERING}{\constant{LinearPDE.NO\hackscore REORDERING}\xspace}
69    \newcommand{\MINIMUMFILLIN}{\constant{LinearPDE.MINIMUM\hackscore FILL\hackscore IN}\xspace\index{linear solver!minimum fill-in ordering}\index{minimum fill-in ordering}}
70    \newcommand{\NESTEDDESCTION}{\constant{LinearPDE.NESTED\hackscore DISSECTION}\xspace\index{linear solver!nested dissection ordering}\index{nested dissection}}
71    
72  \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}  \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
73  \newcommand{\Operator}{\class{Operator}\xspace}  \newcommand{\Operator}{\class{Operator}\xspace}
# Line 44  Line 78 
78  \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}  \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
79  \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}  \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
80  \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}  \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}  
81  \newcommand{\RankOne}{{rank-1 \Data object}\xspace}  \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
82    \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
83  \newcommand{\RankThree}{{rank-3 \Data object}\xspace}  \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
84  \newcommand{\RankFour}{{rank-4 \Data object}\xspace}  \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
85    \newcommand{\Tensor}{{tensor \Data object}\xspace}
86    \newcommand{\Vector}{{vector \Data object}\xspace}
87  \newcommand{\Scalar}{{scalar \Data object}\xspace}  \newcommand{\Scalar}{{scalar \Data object}\xspace}
88  \newcommand{\DataSample}{{data sample} \index{data sample}\xspace}  \newcommand{\DataSample}{{data sample}\index{data sample}\xspace}
89  \newcommand{\DataSamplePoints}{{data sample points} \index{data sample!points}\xspace}  \newcommand{\DataSamplePoints}{{data sample points}\index{data sample!points}\xspace}
90  \newcommand{\numarray}{\module{numarray}\xspace}  \newcommand{\numarray}{\module{numarray}\xspace}
91    \newcommand{\numarrayNA}{\module{numarray}.\class{NumArray}\xspace}
92  \newcommand{\Shape}{shape\xspace\index{shape}}  \newcommand{\Shape}{shape\xspace\index{shape}}
93    \newcommand{\Rank}{rank\xspace\index{shape}}
94  \newcommand{\ExampleDirectory}{example directory\xspace}  \newcommand{\ExampleDirectory}{example directory\xspace}
95    \newcommand{\ReferenceGuide}{\url{http://shake200.esscc.uq.edu.au/esys/esys13/release/epydoc/index.html}\xspace}
96    \newcommand{\Point}{\class{Point} \xspace}
97    \newcommand{\PropertySet}{\class{PropertySet} \xspace}
98    \newcommand{\Design}{\class{Design} \xspace}
99    \newcommand{\TagMap}{\class{TagMap} \xspace}
100    \newcommand{\ManifoldOneD}{\class{Manifold1D} \xspace}
101    \newcommand{\ManifoldTwoD}{\class{Manifold2D} \xspace}
102    \newcommand{\ManifoldThreeD}{\class{Manifold3D} \xspace}
103    
104    % handy commands for pyvisi
105    \newcommand{\VTK}{{\it VTK} \xspace}
106    \newcommand{\VTKUrl}{\url{http://www.vtk.org/}\xspace}
107    \newcommand{\Scene}{\class{Scene}\xspace}
108    \newcommand{\Camera}{\class{Camera}\xspace}
109    \newcommand{\Light}{\class{Light}\xspace}
110    \newcommand{\DataCollector}{\class{DataCollector}\xspace}
111    \newcommand{\ImageReader}{\class{ImageReader}\xspace}
112    \newcommand{\TextTwoD}{\class{Text2D}\xspace}
113    \newcommand{\ActorTwoD}{\class{Actor2D}\xspace}
114    \newcommand{\ActorThreeD}{\class{Actor3D}\xspace}
115    \newcommand{\Transform}{\class{Transform}\xspace}
116    \newcommand{\Clipper}{\class{Clipper}\xspace}
117    \newcommand{\Map}{\class{Map}\xspace}
118    \newcommand{\MapOnPlaneCut}{\class{MapOnPlaneCut}\xspace}
119    \newcommand{\MapOnPlaneClip}{\class{MapOnPlaneClip}\xspace}
120    \newcommand{\MapOnScalarClip}{\class{MapOnScalarClip}\xspace}
121    \newcommand{\MapOnScalarClipWithRotation}{\class{MapOnScalarClipWithRotation}\xspace}
122    \newcommand{\GlyphThreeD}{\class{Glyph3D}\xspace}
123    \newcommand{\MaskPoints}{\class{MaskPoints}\xspace}
124    \newcommand{\Velocity}{\class{Velocity}\xspace}
125    \newcommand{\VelocityOnPlaneCut}{\class{VelocityOnPlaneCut}\xspace}
126    \newcommand{\VelocityOnPlaneClip}{\class{VelocityOnPlaneClip}\xspace}
127    \newcommand{\Sphere}{\class{Sphere}\xspace}
128    \newcommand{\TensorGlyph}{\class{TensorGlyph}\xspace}
129    \newcommand{\Ellipsoid}{\class{Ellipsoid}\xspace}
130    \newcommand{\EllipsoidOnPlaneCut}{\class{EllipsoidOnPlaneCut}\xspace}
131    \newcommand{\EllipsoidOnPlaneClip}{\class{EllipsoidOnPlaneClip}\xspace}
132    \newcommand{\ContourModule}{\class{ContourModule}\xspace}
133    \newcommand{\Contour}{\class{Contour}\xspace}
134    \newcommand{\ContourOnPlaneCut}{\class{ContourOnPlaneCut}\xspace}
135    \newcommand{\ContourOnPlaneClip}{\class{ContourOnPlaneClip}\xspace}
136    \newcommand{\PointSource}{\class{PointSource}\xspace}
137    \newcommand{\StreamLineModule}{\class{StreamLineModule}\xspace}
138    \newcommand{\Tube}{\class{Tube}\xspace}
139    \newcommand{\StreamLine}{\class{StreamLine}\xspace}
140    \newcommand{\Warp}{\class{Warp}\xspace}
141    \newcommand{\Carpet}{\class{Carpet}\xspace}
142    \newcommand{\PlaneSource}{\class{PlaneSource}\xspace}
143    \newcommand{\Image}{\class{Image}\xspace}
144    \newcommand{\Logo}{\class{Logo}\xspace}
145    \newcommand{\ImageReslice}{\class{ImageReslice}\xspace}
146    \newcommand{\Position}{\class{Position}\xspace}
147    \newcommand{\DataSetMapper}{\class{DataSetMapper}\xspace}
148    \newcommand{\Legend}{\class{Legend}\xspace}
149    \newcommand{\ScalarBar}{\class{ScalarBar}\xspace}
150    \newcommand{\Movie}{\class{Movie}\xspace}
151    \newcommand{\CubeSource}{\class{CubeSource}\xspace}
152    \newcommand{\Rectangle}{\class{Rectangle}\xspace}
153    \newcommand{\LocalPosition}{\class{LocalPosition}\xspace}
154    \newcommand{\GlobalPosition}{\class{GlobalPosition}\xspace}
155    \newcommand{\Rotation}{\class{Rotation}\xspace}
156    \newcommand{\thumbnailwidth}{50mm}
157    
158  % default width for figures  % default width for figures
159  \newcommand{\figwidth}{100mm}  \newcommand{\figwidth}{100mm}
# Line 93  Line 191 
191  \vskip\belowcaptionskip}  \vskip\belowcaptionskip}
192  \makeatother  \makeatother
193    
194  \usepackage{fancyvrb}  % fancy verbatim stuff.  Needed so code below goes  % \usepackage{fancyvrb}  % fancy verbatim stuff.  Needed so code below goes
195  %%% this code grabbed from the PyScript docs  %%% this code grabbed from the PyScript docs
196  %%% pyscript.sourceforge.net  %%% pyscript.sourceforge.net
197    
# Line 101  Line 199 
199  % Code format within \Verb  % Code format within \Verb
200  % --------------------------------------------------------------  % --------------------------------------------------------------
201    
202  \definecolor{pycolor}{rgb}{0,0.4,0}  % \definecolor{pycolor}{rgb}{0,0.4,0}
203    
204  %% \DefineVerbatimEnvironment{python}{Verbatim}  %% \DefineVerbatimEnvironment{python}{Verbatim}
205  %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},  %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},
# Line 109  Line 207 
207    
208  %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}  %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}
209    
210  \RecustomVerbatimCommand{\Verb}{Verb}{formatcom=\color{pycolor}\small,fontshape=rm}  % \RecustomVerbatimCommand{\Verb}{Verb}{formatcom=\color{pycolor}\small,fontshape=rm}
211    
212  %%% end of grabbed code  %%% end of grabbed code
213    

Legend:
Removed from v.121  
changed lines
  Added in v.2128

  ViewVC Help
Powered by ViewVC 1.1.26