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

Diff of /trunk/doc/user/escript.tex

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

revision 983 by gross, Tue Feb 20 02:49:08 2007 UTC revision 999 by gross, Tue Feb 27 08:12:37 2007 UTC
# Line 11  Line 11 
11  \chapter{The module \escript}  \chapter{The module \escript}
12  \label{ESCRIPT CHAP}  \label{ESCRIPT CHAP}
13    
 \declaremodule{extension}{escript}  
 \modulesynopsis{Data manipulation}  
14    
15  \begin{figure}  \begin{figure}
16  \includegraphics[width=\textwidth]{figures/EscriptDiagram1.eps}  \includegraphics[width=\textwidth]{figures/EscriptDiagram1.eps}
# Line 259  processing the value for each individual Line 257  processing the value for each individual
257  \escript allows use of constant, tagged and expanded data in a single expression.  \escript allows use of constant, tagged and expanded data in a single expression.
258    
259  The \var{dump} method provides a possibility to save \Data objects to a file, for instance to restart a simuation  The \var{dump} method provides a possibility to save \Data objects to a file, for instance to restart a simuation
260  or to save data for visualization. The file format uses \netCDF~\cite{netCDF} which commonly is using the file extension  or to save data for visualization. The file format uses \netCDF which commonly is using the file extension
261  {\tt nc}. For instance to save the coordinates of the data points of the \FunctionSpace  {\tt nc}. For instance to save the coordinates of the data points of the \FunctionSpace
262  \ContinuousFunction to the file {\tt x.nc} one uses:  \ContinuousFunction to the file {\tt x.nc} one uses:
263  \begin{python}  \begin{python}
# Line 279  Moreover, the ordering of the value is c Line 277  Moreover, the ordering of the value is c
277  \FunctionSpace on the \Domain. In some cases, data points will be reordered.  \FunctionSpace on the \Domain. In some cases, data points will be reordered.
278    
279    
280  \section{\Domain class}  \section{\escript Classes}
281    \declaremodule{extension}{esys.escript}
282    \modulesynopsis{Data manipulation}
283    
284    \subsection{\Domain class}
285  \begin{classdesc}{Domain}{}  \begin{classdesc}{Domain}{}
286  A \Domain object is used to describe a geometrical region together with  A \Domain object is used to describe a geometrical region together with
287  a way of representing functions over this region.  a way of representing functions over this region.
# Line 326  Otherwise \False is returned. Line 328  Otherwise \False is returned.
328  returns string represention of the \Domain.  returns string represention of the \Domain.
329  \end{methoddesc}  \end{methoddesc}
330    
331  \section{\FunctionSpace class}  \subsection{\FunctionSpace class}
332  \begin{classdesc}{FunctionSpace}{}  \begin{classdesc}{FunctionSpace}{}
333  \FunctionSpace objects are used to define properties of \Data objects, such as continuity. \FunctionSpace objects  \FunctionSpace objects are used to define properties of \Data objects, such as continuity. \FunctionSpace objects
334  are instantiated by generator functions. \Data objects in particular \FunctionSpace are  are instantiated by generator functions. \Data objects in particular \FunctionSpace are
# Line 415  partial differential equations \index{pa Line 417  partial differential equations \index{pa
417  for the solution approximation.  for the solution approximation.
418  \end{funcdesc}  \end{funcdesc}
419    
420  \section{\Data Class}  \subsection{\Data Class}
421  \label{SEC ESCRIPT DATA}  \label{SEC ESCRIPT DATA}
422    
423  The following table shows binary and unitary operations that can be applied to  The following table shows binary and unitary operations that can be applied to
# Line 599  save the \Domain. Line 601  save the \Domain.
601  returns a string representation of the object.  returns a string representation of the object.
602  \end{methoddesc}  \end{methoddesc}
603    
604  \section{Functions of \Data class objects}  \subsection{Functions of \Data class objects}
605  This section lists the most important functions for \Data class objects \var{a}.  This section lists the most important functions for \Data class objects \var{a}.
606  A complete list and a more detailed description of the functionality can be fond on \ReferenceGuide.  A complete list and a more detailed description of the functionality can be fond on \ReferenceGuide.
607  \begin{funcdesc}{saveVTK}{filename,**kwdata}  \begin{funcdesc}{saveVTK}{filename,**kwdata}
# Line 1028  returns the $L^2$-norm of \var{a} in its Line 1030  returns the $L^2$-norm of \var{a} in its
1030  \end{equation}  \end{equation}
1031  \end{funcdesc}  \end{funcdesc}
1032    
1033  \section{\Operator Class}  \subsection{\Operator Class}
1034  The \Operator class provides an abstract access to operators build  The \Operator class provides an abstract access to operators build
1035  within the \LinearPDE class. \Operator objects are created  within the \LinearPDE class. \Operator objects are created
1036  when a PDE is handed over to a PDE solver library and handled  when a PDE is handed over to a PDE solver library and handled

Legend:
Removed from v.983  
changed lines
  Added in v.999

  ViewVC Help
Powered by ViewVC 1.1.26