/[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

revision 97 by jgs, Tue Dec 14 05:39:33 2004 UTC revision 100 by jgs, Wed Dec 15 03:48:48 2004 UTC
# Line 15  Line 15 
15  \newcommand{\ESyS}{\module{ESyS}\xspace}  \newcommand{\ESyS}{\module{ESyS}\xspace}
16  \newcommand{\escript}{\module{escript}\xspace}  \newcommand{\escript}{\module{escript}\xspace}
17  \newcommand{\finley}{\module{finley}\xspace}  \newcommand{\finley}{\module{finley}\xspace}
18  \newcommand{\linearPDEsPack}{\module{linearPDEs}\xspace}  \newcommand{\linearPDE}{\class{linearPDE}\xspace}
 \newcommand{\LinearPDE}{\class{LinearPDE}\xspace}  
 \newcommand{\AdvectivePDE}{\class{AdvectivePDE}\xspace}  
 \newcommand{\Poisson}{\class{Poisson}\xspace}  
19  \newcommand{\Data}{\class{Data}\xspace}  \newcommand{\Data}{\class{Data}\xspace}
 \newcommand{\EmptyData}{empty \class{Data} \index{empty Data}\xspace}  
 \newcommand{\Domain}{\class{Domain}\xspace}  
 \newcommand{\OpenDX}{{\it OpenDX}\xspace}  
 \newcommand{\finleyelement}[1]{{\it #1}\index{finley!#1}}  
 \newcommand{\False}{\constant{False}\xspace}  
 \newcommand{\True}{\constant{True}\xspace}  
 \newcommand{\PCG}{\constant{PCG}\index{linear solver!PCG}\index{PCG}}  
 \newcommand{\BiCGStab}{\constant{BICGSTAB}\index{linear solver!BiCGStab}\index{BiCGStab}}  
 \newcommand{\Direct}{\constant{DIRECT}\index{linear solver!Direct}\index{Direct solver}}  
 \newcommand{\GMRES}{\constant{GMRES}\index{linear solver!GMRES}\index{GMRES}}  
 \newcommand{\PRESTWENTY}{\constant{PRES20}\index{linear solver!PRES20}\index{PRES20}}  
   
 \newcommand{\FunctionSpace}{\class{FunctionSpace}\xspace}  
 \newcommand{\Operator}{\class{Operator}\xspace}  
 \newcommand{\SolutionFS}{solution \class{FunctionSpace}\index{solution}\xspace}  
 \newcommand{\ReducedSolutionFS}{reduced solution \class{FunctionSpace}\index{solution!reduced}\xspace}  
 \newcommand{\FunctionOnBoundary}{boundary \class{FunctionSpace}\xspace}  
 \newcommand{\Function}{general \class{FunctionSpace}\xspace}  
 \newcommand{\FunctionOnContactZero}{contact \class{FunctionSpace} on side 0\xspace}  
 \newcommand{\FunctionOnContactOne}{contact \class{FunctionSpace} on side 1\xspace}  
 \newcommand{\ContinuousFunction}{continuous \class{FunctionSpace}\xspace}  
 \newcommand{\RankTwo}{{rank-2 \Data object}\xspace}  
 \newcommand{\RankOne}{{rank-1 \Data object}\xspace}  
 \newcommand{\RankThree}{{rank-3 \Data object}\xspace}  
 \newcommand{\RankFour}{{rank-4 \Data object}\xspace}  
 \newcommand{\Scalar}{{scalar \Data object}\xspace}  
 \newcommand{\DataSample}{{data sample} \index{data sample}\xspace}  
 \newcommand{\DataSamplePoints}{{data sample points} \index{data sample!points}\xspace}  
 \newcommand{\numarray}{\module{numarray}\xspace}  
 \newcommand{\Shape}{shape\xspace\index{shape}}  
   
   
20    
21  % default width for figures  % default width for figures
22  \newcommand{\figwidth}{100mm}  \newcommand{\figwidth}{100mm}
23    
24  % commands useful in cross-referencing  % commands useful in cross-referencing
25  \newcommand {\Ref}[1] {Reference~\cite{#1}}  \newcommand {\Ref}[1] {Reference~\cite{#1}}
26  \newcommand {\Sec}[1] {Section~\ref{#1}}  \newcommand {\Sec}[1] {Section~\ref{#1}}
# Line 65  Line 31 
31  \newcommand {\eqn}[1] {Equation~(\ref{#1})}  \newcommand {\eqn}[1] {Equation~(\ref{#1})}
32  \newcommand {\tab}[1] {Table~\ref{#1}}  \newcommand {\tab}[1] {Table~\ref{#1}}
33    
 % this stops one figure taking up a whole page and lets more text onto  
 % the one page when a figure exists  
 \renewcommand{\floatpagefraction}{0.8} %   Default = 0.5  
   
34  % improved version of caption handling  % improved version of caption handling
35  \usepackage{ccaption}  \usepackage{ccaption}
36  \captionnamefont{\scshape}  \captionnamefont{\scshape}
# Line 99  Line 61 
61    
62  \definecolor{pycolor}{rgb}{0,0.4,0}  \definecolor{pycolor}{rgb}{0,0.4,0}
63    
64  %% \DefineVerbatimEnvironment{python}{Verbatim}  \DefineVerbatimEnvironment{python}{Verbatim}
65  %% {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},  {frame=leftline,framerule=.5mm,rulecolor=\color{pycolor},
66  %% formatcom=\color{pycolor}\small,fontshape=rm}  formatcom=\color{pycolor}\small,fontshape=rm}
67    
68  %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}  %\DefineShortVerb[formatcom=\color{dgreen}\small,fontshape=sl]{\|}
69    
# Line 118  Line 80 
80  \else  \else
81      \DeclareGraphicsExtensions{.eps}      \DeclareGraphicsExtensions{.eps}
82  \fi  \fi
   
 % defines the colour for the background of code examples  
 \definecolor{LightGrey}{gray}{0.9}  
   
 % add the listings package to pretty print the code output  
 \usepackage{listings}  
   
 \lstdefinestyle{myC++}{%  
 %\lstset{%  
 language=C++,  
 showstringspaces=false,  
 basicstyle=\small\ttfamily,  
 commentstyle=\color[named]{BrickRed}\ttfamily,  
 keywordstyle=\color[named]{Purple}\ttfamily,  
 %identifierstyle=\color[named]{Blue}\ttfamily,  
 %functionstyle=\color[named]{Blue}\ttfamily,  
 %typestyle=\color[named]{ForestGreen}\ttfamily,  
 stringstyle=\color[named]{Tan}\ttfamily,%  
 morekeywords={,complex,}%  
 frame=none,%  
 backgroundcolor=\color{LightGrey}%  
 }  
   
 \lstdefinestyle{myMatlab}{%  
 %\lstset{%  
 language=Matlab,  
 showstringspaces=false,  
 basicstyle=\small\ttfamily,  
 commentstyle=\color[named]{BrickRed}\ttfamily,  
 keywordstyle=\color[named]{Purple}\ttfamily,  
 %identifierstyle=\color[named]{Blue}\ttfamily,  
 %functionstyle=\color[named]{Blue}\ttfamily,  
 %typestyle=\color[named]{ForestGreen}\ttfamily,  
 stringstyle=\color[named]{Tan}\ttfamily,%  
 frame=none,%  
 backgroundcolor=\color{LightGrey}%  
 }  
   
 \lstdefinestyle{myScilab}{%  
 %\lstset{%  
 language=Scilab,  
 showstringspaces=false,  
 basicstyle=\small\ttfamily,  
 commentstyle=\color[named]{BrickRed}\ttfamily,  
 keywordstyle=\color[named]{Purple}\ttfamily,  
 %identifierstyle=\color[named]{Blue}\ttfamily,  
 %functionstyle=\color[named]{Blue}\ttfamily,  
 %typestyle=\color[named]{ForestGreen}\ttfamily,  
 stringstyle=\color[named]{Tan}\ttfamily,%  
 frame=none,%  
 backgroundcolor=\color{LightGrey}%  
 }  
   
 \lstdefinestyle{myShell}{%  
 %\lstset{%  
 language=ksh,  
 showstringspaces=false,  
 basicstyle=\small\ttfamily,  
 commentstyle=\color[named]{Black}\ttfamily,  
 keywordstyle=\color[named]{Black}\ttfamily,  
 %identifierstyle=\color[named]{Blue}\ttfamily,  
 %functionstyle=\color[named]{Blue}\ttfamily,  
 %typestyle=\color[named]{ForestGreen}\ttfamily,  
 stringstyle=\color[named]{Black}\ttfamily,%  
 frame=none,%  
 backgroundcolor=\color{LightGrey}%  
 }  
   
 \lstdefinestyle{myPython}{%  
 %\lstset{%  
 language=python,  
 showstringspaces=false,  
 basicstyle=\small\ttfamily,  
 commentstyle=\color[named]{BrickRed}\ttfamily,  
 keywordstyle=\color[named]{Purple}\ttfamily,  
 %identifierstyle=\color[named]{Blue}\ttfamily,  
 %functionstyle=\color[named]{Blue}\ttfamily,  
 %typestyle=\color[named]{ForestGreen}\ttfamily,  
 stringstyle=\color[named]{Tan}\ttfamily,%  
 frame=none,%  
 %backgroundcolor=\color{LightGrey}%  
 }  
   
 \lstdefinestyle{myhtml}{%  
 %\lstset{%  
 language=xml,  
 showstringspaces=false,  
 basicstyle=\small\ttfamily,  
 commentstyle=\color[named]{BrickRed}\ttfamily,  
 keywordstyle=\color[named]{Purple}\ttfamily,  
 %identifierstyle=\color[named]{Blue}\ttfamily,  
 %functionstyle=\color[named]{Blue}\ttfamily,  
 %typestyle=\color[named]{ForestGreen}\ttfamily,  
 stringstyle=\color[named]{Tan}\ttfamily,  
 morekeywords={,simulation,prop_dim,error_check,stochastic,%  
   globals,field,dimensions,lattice,domains,samples,vector,%  
   components,fourier_space,sequence,integrate,algorithm,%  
   interval,k_operators,constant,operator_names,vectors,%  
   output,filename,group,sampling,moments,benchmark,use_double,%  
   use_wisdom,use_prefs,binary_output,cycles,filter,post_propagation,%  
   default_value,argv,arg,iterations,cross_propagation,%  
   use_mpi,paths,seed,noises,author,description,name,type,%  
 }  
 frame=none,%  
 %framerule=2pt,%  
 backgroundcolor=\color{LightGrey}%  
 }  
   
 % this implements producing nice code blocks  
 % it also saves time, typing and  
 % *should* reduce errors in the text by removing doubling up of code  
 \lstnewenvironment{xmdsCode}[1][]{\lstset{style=myhtml}\lstset{#1}}{}  
   
 % this implements nicely formatted shell code  
 \lstnewenvironment{shellCode}[1][]{\lstset{style=myShell}\lstset{#1}}{}  
   
 % this implements nicely formatted Perl code  
 \lstnewenvironment{perlCode}[1][]{\lstset{style=myPerl}\lstset{#1}}{}  
   
 % this implements nicely formatted Python code  
 \lstnewenvironment{python}[1][]{\lstset{style=myPython}\lstset{#1}}{}  
   
 % this implements nicely formatted C++ code  
 \lstnewenvironment{CCode}{\lstset{style=myC++}}{}  
   
 % this implements nicely formatted matlab code  
 \lstnewenvironment{matlabCode}{\lstset{style=myMatlab}}{}  
   
 % this implements nicely formatted scilab code  
 \lstnewenvironment{scilabCode}{\lstset{style=myScilab}}{}  
   

Legend:
Removed from v.97  
changed lines
  Added in v.100

  ViewVC Help
Powered by ViewVC 1.1.26