/[escript]/trunk/doc/cookbook/escpybas.tex
ViewVC logotype

Diff of /trunk/doc/cookbook/escpybas.tex

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

revision 2860 by ahallam, Wed Nov 25 05:01:43 2009 UTC revision 2861 by gross, Wed Jan 20 02:47:42 2010 UTC
# Line 22  The \pyt scripting language is a powerfu Line 22  The \pyt scripting language is a powerfu
22  \item Another comprehensive tutorial: \url{http://www.tutorialspoint.com/python/index.htm}  \item Another comprehensive tutorial: \url{http://www.tutorialspoint.com/python/index.htm}
23  \end{itemize}  \end{itemize}
24    
25  \subsection{The \modesys Library Tree}  \subsection{The \modesys Modules}
26  The \esys  library tree has three main modules, \verb escript , \verb finley  and \verb pycad . These three modules contain the bulk of the \esc package functions and data structures.  \esc is part of the \esys package.
27    Besides the particle simualation code
28    \verb|ESyS-Particle|\footnote{see \url{https://launchpad.net/esys-particle}} which is not covered
29    in this tutorial \esys includes the following modules
30  \begin{enumerate}  \begin{enumerate}
31  \item \modescript  is the PDE solving module.  \item \modescript is the PDE solving module.
32  \item \modfinley is the discretisation tool and finite element package.  \item \modfinley is the discretisation tool and finite element package.
33  \item \modpycad  is a special development for creating irregular domains and models. That are easily interpretable by \esc .  \item \modpycad  is a special development for creating irregular shaped domains.
34  \end{enumerate}  \end{enumerate}
35  Further explanations on each of these is available in the \esc user guide or in the API documentation \footnote{Available from \url{https://launchpad.net/escript-finley/+download}}. \esc is also dependent on a few other open-source packages which are not maintained by the \esc development team. These are \modnumpy an array and matrix handling package, \modmpl \footnote{\modnumpy and \modmpl are maintained by SciPy, \url{http://www.scipy.org/}} a simple plotting and visualisation tool, \modvtk \footnote{See \url{http://www.vtk.org/}} an advanced plotting and visualisation package and \verb gmsh \footnote{See \url{http://www.geuz.org/gmsh/}} which is required by \modpycad. These packages (\textbf{except} for \verb gmsh ) are included with the binary release but may not be the most recent and up to date.  Further explanations on each of these is available in the \esc user guide or in the API documentation\footnote{Available from \url{https://launchpad.net/escript-finley/+download}}.
36    \esc is also dependent on a few other open-source packages which are not maintained by the \esc development team. These are \modnumpy an array and matrix handling package, \modmpl \footnote{\modnumpy and \modmpl are part of the SciPy package, see \url{http://www.scipy.org/}} a simple plotting tool, \modvtk \footnote{See \url{http://www.vtk.org/}} an advanced visualisation package and \verb gmsh \footnote{See \url{http://www.geuz.org/gmsh/}} which is required by \modpycad. These packages (\textbf{except} for \verb gmsh ) are included with the support bundles.
37    
38    
39    
40    
41    
 \subsection{The Domain Constructor in \esc}  
 \label{ss:domcon}  
 It is important at this particular stage, to describe how domains and data are organised and related to each other in \esc.  
42  \begin{figure}[t]  \begin{figure}[t]
43   \centering   \centering
44     \includegraphics[width=6in]{figures/functionspace.pdf}     \includegraphics[width=6in]{figures/functionspace.pdf}
45     \label{fig:fs}     \label{fig:fs}
46     \caption{\esc domain construction overview}     \caption{\esc domain construction overview}
47  \end{figure}  \end{figure}
48  When the domain variables are submitted to the domain constructor or meshing algorithm, three function spaces are also created (Figure \ref{fig:fs.}) They are;  
49    \subsection{The Domain Constructor in \esc}
50    \label{ss:domcon}
51    It is important at this particular stage, to describe how domains and data are organised and related to each other in \esc.
52    
53    When the domain variables are submitted to the domain constructor or meshing algorithm, three function spaces are also created (Figure \ref{fig:fs}) They are;
54  \begin{enumerate}  \begin{enumerate}
55  \item the nodes, called by \verb|ContinuousFunction(domain)| ;  \item the nodes, called by \verb|ContinuousFunction(domain)| ;
56  \item the elements/coefficients, called by \verb|Function(domain)| ; and  \item the elements/coefficients, called by \verb|Function(domain)| ; and

Legend:
Removed from v.2860  
changed lines
  Added in v.2861

  ViewVC Help
Powered by ViewVC 1.1.26