/[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 6678 - (hide annotations)
Mon Jun 11 04:05:30 2018 UTC (17 months, 1 week ago) by jfenwick
File MIME type: application/x-tex
File size: 9432 byte(s)
Fixing overfull hboxes

1 ksteube 1811
2 jfenwick 3989 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 jfenwick 6651 % Copyright (c) 2003-2018 by The University of Queensland
4 jfenwick 3989 % http://www.uq.edu.au
5 gross 625 %
6 ksteube 1811 % Primary Business: Queensland, Australia
7 jfenwick 6112 % Licensed under the Apache License, version 2.0
8     % http://www.apache.org/licenses/LICENSE-2.0
9 gross 625 %
10 jfenwick 3989 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11 jfenwick 4657 % Development 2012-2013 by School of Earth Sciences
12     % Development from 2014 by Centre for Geoscience Computing (GeoComp)
13 jfenwick 3989 %
14     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15 jgs 82
16 lgraham 2128 \usepackage{subfigure}
17 caltinay 3306 \usepackage{color}
18 jgs 82
19 caltinay 3281 \graphicspath{{figures/}}
20 gross 3502 \setcounter{secnumdepth}{3}
21 jgs 82
22 gross 3502
23 caltinay 3293 % default width for figures
24     \newcommand{\figwidth}{100mm}
25    
26     % commands useful in cross-referencing
27     \newcommand{\Ref}[1]{Reference~\cite{#1}}
28     \newcommand{\Sec}[1]{Section~\ref{#1}}
29     \newcommand{\App}[1]{Appendix~\ref{#1}}
30     \newcommand{\Chap}[1]{Chapter~\ref{#1}}
31     \newcommand{\etal}{\emph{~et~al.}}
32     \newcommand{\fig}[1]{Figure~\ref{#1}}
33     \newcommand{\eqn}[1]{Equation~(\ref{#1})}
34     \newcommand{\tab}[1]{Table~\ref{#1}}
35     \newcommand{\env}[1]{\textbf{\mbox{#1}}\index{Environment!#1}}
36 caltinay 3975 \newcommand{\fracp}[2]{\frac{\partial #1}{\partial #2}}
37 caltinay 3293
38 jgs 82 % define some handy commands for escript stuff
39 caltinay 5295 \newcommand{\CUDA}{{\it CUDA}\xspace}
40 gross 565 \newcommand{\LINUX}{{\it Linux}\xspace}
41 gross 2316 \newcommand{\WINDOWS}{{\it MS Windows}\xspace}
42     \newcommand{\PYTHON}{{\it python}\xspace}
43 jfenwick 3894 \newcommand{\pythonthree}{\textit{python3}\xspace}
44     \newcommand{\pythontwo}{\textit{python2}\xspace}
45 jfenwick 2331 \newcommand{\netCDF}{{\it netCDF}\index{netCDF}\xspace}
46 jgs 107 \newcommand{\escript}{\module{esys.escript}\xspace}
47 caltinay 3366 \newcommand{\dudley}{\module{esys.dudley}\xspace}
48 jgs 107 \newcommand{\finley}{\module{esys.finley}\xspace}
49 sshaw 5279 \newcommand{\ripley}{\module{esys.ripley}\xspace}
50     \newcommand{\speckley}{\module{esys.speckley}\xspace}
51 caltinay 3348 \newcommand{\weipa}{\module{esys.weipa}\xspace}
52 gross 999 \newcommand{\esys}{\module{esys}\xspace}
53 gross 993 \newcommand{\pycad}{\module{esys.pycad}\xspace}
54 caltinay 5302 \newcommand{\downunder}{\module{esys.downunder}\xspace}
55 gross 999 \newcommand{\gmsh}{\module{esys.pycad.gmsh}\xspace}
56 caltinay 3293 \newcommand{\gmshextern}{{\it Gmsh}\cite{GMSH}\index{Gmsh}\xspace}
57     \newcommand{\SCIPY}{{\it SciPy}\cite{SCIPY}\index{SciPy}\xspace}
58 jfenwick 2923 \newcommand{\MPI}{{\it MPI}\index{Message Passing Interface!MPI}\xspace}
59 jfenwick 2331 \newcommand{\OPENMP}{{\it OpenMP}\xspace\index{OpenMP!threading}\xspace}
60 gross 565 \newcommand{\linearPDEs}{\module{esys.escript.linearPDEs}\xspace}
61 jgs 102 \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}
62 caltinay 4891 \newcommand{\NLPDE}{\class{NonlinearPDE}\xspace}
63 jgs 121 \newcommand{\modelframe}{\module{esys.modelframe}\xspace}
64 gross 2864 \newcommand{\pdetools}{\module{esys.escript.pdetools}\xspace}
65 caltinay 3293 \newcommand{\False}{\constant{False}\xspace}
66     \newcommand{\True}{\constant{True}\xspace}
67     \newcommand{\warning}[1]{\emph{Warning: #1}}
68 gross 565
69 gross 2474 \newcommand{\SolverOptions}{\class{SolverOptions}\xspace}
70 jgs 102 \newcommand{\Poisson}{\class{Poisson}\xspace}
71 gross 568 \newcommand{\Helmholtz}{\class{Helmholtz}\xspace}
72 gross 653 \newcommand{\Lame}{\class{Lame}\xspace}
73 jgs 82 \newcommand{\Data}{\class{Data}\xspace}
74 jfenwick 1955 \newcommand{\EmptyData}{empty \class{Data}\index{empty Data}\xspace}
75 jgs 102 \newcommand{\Domain}{\class{Domain}\xspace}
76 caltinay 5296 \newcommand{\gnuplot}{{\it gnuplot}\cite{GNUPLOT}\index{visualization!gnuplot}\index{gnuplot}\xspace}
77 jgs 102 \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}
78 gross 2573 \newcommand{\PCG}{\member{SolverOptions.PCG}\xspace\index{linear solver!PCG}\index{PCG}}
79     \newcommand{\BiCGStab}{\member{SolverOptions.BICGSTAB}\xspace\index{linear solver!BiCGStab}\index{BiCGStab}}
80     \newcommand{\Direct}{\member{SolverOptions.DIRECT}\xspace\index{linear solver!Direct}\index{Direct solver}}
81     \newcommand{\GMRES}{\member{SolverOptions.GMRES}\xspace\index{linear solver!GMRES}\index{GMRES}}
82     \newcommand{\PRESTWENTY}{\member{SolverOptions.PRES20}\xspace\index{linear solver!PRES20}\index{PRES20}}
83     \newcommand{\JACOBI}{\member{SolverOptions.JACOBI}\xspace\index{preconditioner!Jacobi}\index{Jacobi}}
84     \newcommand{\ILU}{\member{SolverOptions.ILU0}\xspace\index{preconditioner!ILU0}\index{ILU0}}
85     \newcommand{\ILUT}{\member{SolverOptions.ILUT}\xspace\index{preconditioner!ILUT}\index{ILUT}}
86     \newcommand{\RILU}{\member{SolverOptions.RILU}\xspace\index{preconditioner!RILU}\index{RILU}}
87 gross 3379 \newcommand{\HRZLUMPING}{\member{SolverOptions.HRZ_LUMPING}\xspace\index{linear solver!row sum lumping}\index{row sum lumping}}
88     \newcommand{\ROWSUMLUMPING}{\member{SolverOptions.ROWSUM_LUMPING}\xspace\index{linear solver!HRZ lumping}\index{HRZ lumping}}
89 jfenwick 3295 \newcommand{\NOREORDERING}{\member{SolverOptions.NO_REORDERING}\xspace}
90 gross 2573 \newcommand{\AMG}{\member{SolverOptions.AMG}\xspace\index{linear solver!AMG}\index{algebraic Multi-grid}\index{AMG}}
91 jfenwick 3295 \newcommand{\GAUSSSEIDEL}{\member{SolverOptions.GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
92     \newcommand{\LOCALGAUSSSEIDEL}{\member{SolverOptions.LOCAL_GAUSS_SEIDEL}\xspace\index{linear solver!Gauss-Seidel}\index{preconditioner!Gauss-Seidel}\index{Gauss-Seidel Scheme}}
93 gross 2558 \newcommand{\MKL}{\texttt{MKL}\xspace\index{packages!MKL}\index{MKL}}
94     \newcommand{\UMFPACK}{\texttt{UMFPACK}\xspace\index{packages!UMFPACK}\index{UMFPACK}}
95     \newcommand{\PASO}{\texttt{PASO}\xspace\index{packages!PASO}\index{PASO}}
96 jgs 82
97 jgs 102 \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}
98     \newcommand{\Operator}{\class{Operator}\xspace}
99     \newcommand{\SolutionFS}{solution \class{FunctionSpace}\index{solution}\xspace}
100     \newcommand{\ReducedSolutionFS}{reduced solution \class{FunctionSpace}\index{solution!reduced}\xspace}
101     \newcommand{\FunctionOnBoundary}{boundary \class{FunctionSpace}\xspace}
102     \newcommand{\Function}{general \class{FunctionSpace}\xspace}
103     \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}
104     \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}
105     \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}
106 gross 5670 \newcommand{\DiracDeltaFunctions}{Dirac delta-function \class{FunctionSpace}\xspace}
107 gross 565 \newcommand{\RankOne}{{rank-1 \Data object}\xspace}
108 jgs 102 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}
109     \newcommand{\RankThree}{{rank-3 \Data object}\xspace}
110     \newcommand{\RankFour}{{rank-4 \Data object}\xspace}
111 gross 660 \newcommand{\Tensor}{{tensor \Data object}\xspace}
112     \newcommand{\Vector}{{vector \Data object}\xspace}
113 jgs 102 \newcommand{\Scalar}{{scalar \Data object}\xspace}
114 jfenwick 6678 \newcommand{\Scalars}{{scalar \Data objects}\xspace}
115 jfenwick 1955 \newcommand{\DataSample}{{data sample}\index{data sample}\xspace}
116     \newcommand{\DataSamplePoints}{{data sample points}\index{data sample!points}\xspace}
117 jfenwick 2463 \newcommand{\numpy}{\module{numpy}\xspace}
118 sshaw 4554 \newcommand{\numpyNDA}{\module{numpy.\class{ndarray}}\xspace}
119 jfenwick 2463
120 jgs 102 \newcommand{\Shape}{shape\xspace\index{shape}}
121 gross 565 \newcommand{\Rank}{rank\xspace\index{shape}}
122 jgs 102 \newcommand{\ExampleDirectory}{example directory\xspace}
123 caltinay 5297 \newcommand{\ReferenceGuide}{\url{http://esys.geocomp.uq.edu.au/docs.html}\xspace}
124 caltinay 3293 \newcommand{\Point}{\class{Point}\xspace}
125     \newcommand{\PropertySet}{\class{PropertySet}\xspace}
126     \newcommand{\Design}{\class{Design}\xspace}
127     \newcommand{\TagMap}{\class{TagMap}\xspace}
128     \newcommand{\ManifoldOneD}{\class{Manifold1D}\xspace}
129     \newcommand{\ManifoldTwoD}{\class{Manifold2D}\xspace}
130     \newcommand{\ManifoldThreeD}{\class{Manifold3D}\xspace}
131 jgs 102
132 caltinay 3278 % handy commands related to visualization
133 gross 2574 \newcommand{\VTK}{{\it VTK}\index{visualization!VTK}\index{VTK}\xspace}
134 caltinay 3278 \newcommand{\SILO}{{\it SILO}\index{visualization!SILO}\index{SILO}\xspace}
135 caltinay 4455 \newcommand{\Voxet}{{\it Voxet}\index{visualization!Voxet}\index{Voxet}\xspace}
136 gross 2574 \newcommand{\MATPLOTLIB}{\module{matplotlib}\index{visualization!matplotlib}\index{matplotlib}\xspace}
137     \newcommand{\VTKUrl}{\url{http://www.vtk.org/}\index{visualization!VTK}\index{VTK}\xspace}
138     \newcommand{\VisIt}{{\it VisIt}\index{visualization!VisIt}\index{VisIt}\xspace}
139 caltinay 5662 \newcommand{\mayavi}{{\it Mayavi2}\index{visualization!mayavi}\index{mayavi}\xspace}
140 caltinay 4455 \newcommand{\GOCAD}{{\it GOCAD}\index{visualization!GOCAD}\index{GOCAD}\xspace}
141 caltinay 3293 \newcommand{\OpenDX}{{\it OpenDX}\index{visualization!OpenDX}\index{OpenDX}\cite{OPENDX}\xspace}
142 gross 2574
143 jduplessis 4881 % handy commands related to Symbolics
144     \newcommand{\EVALUATOR}{{\class{Evaluator}}\xspace}
145     \newcommand{\SYMBOL}{{\class{Symbol}}\xspace}
146 jgs 102
147 jduplessis 4881
148    
149 jgs 102 % this stops one figure taking up a whole page and lets more text onto
150     % the one page when a figure exists
151 caltinay 3293 \renewcommand{\floatpagefraction}{0.8} % Default = 0.5
152 jgs 102
153 jgs 82 % improved version of caption handling
154     \usepackage{ccaption}
155     \captionnamefont{\scshape}
156     \captionstyle{}
157     \makeatletter
158     \renewcommand{\fnum@figure}[1]{\quad\small\textsc{\figurename~\thefigure}:}
159     \renewcommand{\@makecaption}[2]{%
160     \vskip\abovecaptionskip
161     \sbox\@tempboxa{#1: #2}%
162     \ifdim \wd\@tempboxa >\hsize
163     \def\baselinestretch{1}\@normalsize
164     #1: #2\par
165     \def\baselinestretch{1.5}\@normalsize
166     \else
167     \global \@minipagefalse
168     \hb@xt@\hsize{\hfil\box\@tempboxa\hfil}%
169     \fi
170     \vskip\belowcaptionskip}
171     \makeatother
172    
173     % this is for when one uses pdflatex and therefore needs to load pdf
174     % figures into \includegraphics
175     \ifpdf
176 caltinay 3291 \DeclareGraphicsExtensions{.pdf,.png} % this command defined in graphicx
177 jgs 82 \pdfcompresslevel=9 % 0: no compression, 9: highest compression
178     % or, set compress_level 9 in file pdftex.cfg
179     \else
180     \DeclareGraphicsExtensions{.eps}
181     \fi
182 jgs 102
183 jfenwick 3308 \include{elist}
184 jgs 102
185 jfenwick 2335
186    
187 jfenwick 2338 %Ensures that latex doesn't have an error if we don't specify the version
188     \providecommand{\RepVersion}{Unknown\xspace}
189     % to set this value use:
190     % (pdf)latex '\newcommand{\RepVersion}{version\xspace}\input{guide.tex}'
191 gross 2372 % as your command-line

Properties

Name Value
svn:eol-style native
svn:keywords Author Date Id Revision
svn:mergeinfo /branches/3.4/doc/user/user_defs.tex:4453-4490 /branches/4.0fordebian/doc/user/user_defs.tex:5567-5588 /branches/lapack2681/doc/user/guide_defs.tex:2682-2741 /branches/pasowrap/doc/user/user_defs.tex:3661-3674 /branches/py3_attempt2/doc/user/user_defs.tex:3871-3891 /branches/release3.4/doc/user/user_defs.tex:4452 /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 /branches/symbolic_from_3470/doc/user/user_defs.tex:3471-3974 /branches/symbolic_from_3470/ripley/test/python/doc/user/user_defs.tex:3517-3974 /branches/trilinos_from_5897/doc/user/user_defs.tex:5898-6118 /release/3.0/doc/user/guide_defs.tex:2591-2601 /release/4.0/doc/user/user_defs.tex:5380-5406 /trunk/ripley/test/python/doc/user/user_defs.tex:3480-3515

  ViewVC Help
Powered by ViewVC 1.1.26