/[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 104 by jgs, Fri Dec 17 07:43:12 2004 UTC trunk/doc/user/guide_defs.tex revision 993 by gross, Fri Feb 23 06:39:38 2007 UTC
# Line 1  Line 1 
1  % $Id$  % $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}  \usepackage{epsfig}
12  \usepackage{graphicx,color}  \usepackage{graphicx,color}
# Line 12  Line 20 
20    
21    
22  % define some handy commands for escript stuff  % define some handy commands for escript stuff
23  \newcommand{\ESyS}{\module{ESyS}\xspace}  \newcommand{\LINUX}{{\it Linux}\xspace}
24  \newcommand{\escript}{\module{escript}\xspace}  \newcommand{\netCDF}{{\it netCDF}\cite{NETCDF}\index{netCDF} \xspace}
25  \newcommand{\finley}{\module{finley}\xspace}  \newcommand{\escript}{\module{esys.escript}\xspace}
26  \newcommand{\linearPDEsPack}{\module{linearPDEs}\xspace}  \newcommand{\finley}{\module{esys.finley}\xspace}
27    \newcommand{\bruce}{\module{esys.bruce}\xspace}
28    \newcommand{\pyvisi}{\module{esys.pyvisi}\xspace}
29    \newcommand{\pycad}{\module{esys.pycad}\xspace}
30    
31    \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
32  \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}  \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
33    \newcommand{\timeseries}{\module{esys.timeseries}\xspace}
34    \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
35    \newcommand{\pdetools}{\module{esys.pdetools}\xspace}
36    
37  \newcommand{\AdvectivePDE}{\class{AdvectivePDE}\xspace}  \newcommand{\AdvectivePDE}{\class{AdvectivePDE}\xspace}
38  \newcommand{\Poisson}{\class{Poisson}\xspace}  \newcommand{\Poisson}{\class{Poisson}\xspace}
39    \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
40    \newcommand{\Lame}{\class{Lame}\xspace}
41  \newcommand{\Data}{\class{Data}\xspace}  \newcommand{\Data}{\class{Data}\xspace}
42  \newcommand{\EmptyData}{empty \class{Data} \index{empty Data}\xspace}  \newcommand{\EmptyData}{empty \class{Data} \index{empty Data}\xspace}
43  \newcommand{\Domain}{\class{Domain}\xspace}  \newcommand{\Domain}{\class{Domain}\xspace}
44  \newcommand{\OpenDX}{{\it OpenDX}\xspace}  \newcommand{\VTK}{{\it vtk} \cite{VTK}\index{visualization!vtk} \xspace}
45    \newcommand{\GnuPlot}{{\it gnuplot} \cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}}
46    \newcommand{\mayavi}{{\it mayavi} \index{visualization!mayavi}\index{mayavi}}
47    \newcommand{\OpenDX}{{\it OpenDX} \cite{OPENDX}\xspace}
48  \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}  \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
49  \newcommand{\False}{\constant{False}\xspace}  \newcommand{\False}{\constant{False}\xspace}
50  \newcommand{\True}{\constant{True}\xspace}  \newcommand{\True}{\constant{True}\xspace}
51  \newcommand{\PCG}{\constant{PCG}\index{linear solver!PCG}\index{PCG}}  \newcommand{\PCG}{\constant{LinearPDE.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
52  \newcommand{\BiCGStab}{\constant{BICGSTAB}\index{linear solver!BiCGStab}\index{BiCGStab}}  \newcommand{\BiCGStab}{\constant{LinearPDE.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
53  \newcommand{\Direct}{\constant{DIRECT}\index{linear solver!Direct}\index{Direct solver}}  \newcommand{\Direct}{\constant{LinearPDE.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
54  \newcommand{\GMRES}{\constant{GMRES}\index{linear solver!GMRES}\index{GMRES}}  \newcommand{\GMRES}{\constant{LinearPDE.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
55  \newcommand{\PRESTWENTY}{\constant{PRES20}\index{linear solver!PRES20}\index{PRES20}}  \newcommand{\PRESTWENTY}{\constant{LinearPDE.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
56    \newcommand{\JACOBI}{\constant{LinearPDE.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
57    \newcommand{\ILU}{\constant{LinearPDE.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
58    \newcommand{\ILUT}{\constant{LinearPDE.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
59    \newcommand{\LUMPING}{\constant{LinearPDE.LUMPING}\xspace\index{linear solver!lumping}\index{lumping}}
60    \newcommand{\NOREORDERING}{\constant{LinearPDE.NO\hackscore REORDERING}\xspace}
61    \newcommand{\MINIMUMFILLIN}{\constant{LinearPDE.MINIMUM\hackscore FILL\hackscore IN}\xspace\index{linear solver!minimum fill-in ordering}\index{minimum fill-in ordering}}
62    \newcommand{\NESTEDDESCTION}{\constant{LinearPDE.NESTED\hackscore DISSECTION}\xspace\index{linear solver!nested dissection ordering}\index{nested dissection}}
63    
64  \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}  \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
65  \newcommand{\Operator}{\class{Operator}\xspace}  \newcommand{\Operator}{\class{Operator}\xspace}
# Line 41  Line 70 
70  \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}  \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
71  \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}  \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
72  \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}  \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}  
73  \newcommand{\RankOne}{{rank-1 \Data object}\xspace}  \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
74    \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
75  \newcommand{\RankThree}{{rank-3 \Data object}\xspace}  \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
76  \newcommand{\RankFour}{{rank-4 \Data object}\xspace}  \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
77    \newcommand{\Tensor}{{tensor \Data object}\xspace}
78    \newcommand{\Vector}{{vector \Data object}\xspace}
79  \newcommand{\Scalar}{{scalar \Data object}\xspace}  \newcommand{\Scalar}{{scalar \Data object}\xspace}
80  \newcommand{\DataSample}{{data sample} \index{data sample}\xspace}  \newcommand{\DataSample}{{data sample} \index{data sample}\xspace}
81  \newcommand{\DataSamplePoints}{{data sample points} \index{data sample!points}\xspace}  \newcommand{\DataSamplePoints}{{data sample points} \index{data sample!points}\xspace}
82  \newcommand{\numarray}{\module{numarray}\xspace}  \newcommand{\numarray}{\module{numarray}\xspace}
83  \newcommand{\Shape}{shape\xspace\index{shape}}  \newcommand{\Shape}{shape\xspace\index{shape}}
84    \newcommand{\Rank}{rank\xspace\index{shape}}
85  \newcommand{\ExampleDirectory}{example directory\xspace}  \newcommand{\ExampleDirectory}{example directory\xspace}
86    \newcommand{\ReferenceGuide}{\url{http://www.iservo.edu.au/esys/epydoc/index.html}}
87    
88    
89    % handy commands for pyvisi
90    \newcommand{\Scene}{\class{Scene}\xspace}
91    \newcommand{\Image}{\class{Image}\xspace}
92    \newcommand{\Text}{\class{Text}\xspace}
93    \newcommand{\DataCollector}{\class{DataCollector}\xspace}
94    \newcommand{\Camera}{\class{Camera}\xspace}
95    \newcommand{\Light}{\class{Light}\xspace}
96    \newcommand{\Map}{\class{Map}\xspace}
97    \newcommand{\MapOnPlane}{\class{MapOnPlane}\xspace}
98    \newcommand{\MapOnClip}{\class{MapOnClip}\xspace}
99    \newcommand{\MapOnScalarClip}{\class{MapOnScalarClip}\xspace}
100    \newcommand{\Arrows}{\class{Arrows}\xspace}
101    \newcommand{\ArrowsOnPlane}{\class{ArrowsOnPlane}\xspace}
102    \newcommand{\ArrowsOnClip}{\class{ArrowsOnClip}\xspace}
103    \newcommand{\IsoSurface}{\class{IsoSurface}\xspace}
104    \newcommand{\IsoSurfaceOnPlane}{\class{IsoSurfaceOnPlane}\xspace}
105    \newcommand{\IsoSurfaceOnClip}{\class{IsoSurfaceOnClip}\xspace}
106    \newcommand{\Contour}{\class{Contour}\xspace}
107    \newcommand{\ContourOnPlane}{\class{ContourOnPlane}\xspace}
108    \newcommand{\ContourOnClip}{\class{ContourOnClip}\xspace}
109    \newcommand{\TensorC}{\class{Tensor}\xspace}
110    \newcommand{\TensorOnPlane}{\class{TensorOnPlane}\xspace}
111    \newcommand{\TensorOnClip}{\class{TensorOnClip}\xspace}
112    \newcommand{\StreamLines}{\class{StreamLines}\xspace}
113    \newcommand{\Carpet}{\class{Carpet}\xspace}
114    \newcommand{\Position}{\class{Position}\xspace}
115    \newcommand{\Transform}{\class{Transform}\xspace}
116    \newcommand{\Style}{\class{Style}\xspace}
117    \newcommand{\BlueToRed}{\class{BlueToRed}\xspace}
118    \newcommand{\RedToBlue}{\class{RedToBlue}\xspace}
119    \newcommand{\Plane}{\class{Plane}\xspace}
120    
121    
122  % default width for figures  % default width for figures
# Line 90  Line 155 
155  \vskip\belowcaptionskip}  \vskip\belowcaptionskip}
156  \makeatother  \makeatother
157    
158  \usepackage{fancyvrb}  % fancy verbatim stuff.  Needed so code below goes  % \usepackage{fancyvrb}  % fancy verbatim stuff.  Needed so code below goes
159  %%% this code grabbed from the PyScript docs  %%% this code grabbed from the PyScript docs
160  %%% pyscript.sourceforge.net  %%% pyscript.sourceforge.net
161    
# Line 98  Line 163 
163  % Code format within \Verb  % Code format within \Verb
164  % --------------------------------------------------------------  % --------------------------------------------------------------
165    
166  \definecolor{pycolor}{rgb}{0,0.4,0}  % \definecolor{pycolor}{rgb}{0,0.4,0}
167    
168  %% \DefineVerbatimEnvironment{python}{Verbatim}  %% \DefineVerbatimEnvironment{python}{Verbatim}
169  %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},  %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},
# Line 106  Line 171 
171    
172  %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}  %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}
173    
174  \RecustomVerbatimCommand{\Verb}{Verb}{formatcom=\color{pycolor}\small,fontshape=rm}  % \RecustomVerbatimCommand{\Verb}{Verb}{formatcom=\color{pycolor}\small,fontshape=rm}
175    
176  %%% end of grabbed code  %%% end of grabbed code
177    

Legend:
Removed from v.104  
changed lines
  Added in v.993

  ViewVC Help
Powered by ViewVC 1.1.26