From: nadir <nadir>
Date: Thu, 11 May 2006 14:46:51 +0000 (+0000)
Subject: Adding new Alliances med test files, with a few more test script. a MEDMEM
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=c2d5836302f0bb7ede188595eb9cbd049023d0c6;p=tools%2Fmedcoupling.git

Adding new Alliances med test files, with a few more test script. a MEDMEM
file has to be altered to correct some minor bugs.
---

diff --git a/doc/MEDMEM/MEDMEM_UsersGuide.tex.in b/doc/MEDMEM/MEDMEM_UsersGuide.tex.in
index ab5b149b3..a349bc33c 100644
--- a/doc/MEDMEM/MEDMEM_UsersGuide.tex.in
+++ b/doc/MEDMEM/MEDMEM_UsersGuide.tex.in
@@ -71,7 +71,7 @@
 % |                              LE DOCUMENT                                  |
 % |___________________________________________________________________________|
 %
-\title{User's Guide Of Med Memory}
+\title{User's Guide Of Med Memory V 3.2}
 \author{Patrick Goldbronn \and Eric Fayolle \and Nadir Bouhamou \and Jerome Roy \and Nicolas Crouzet}
 
 %  ___________________________________________________________________________
@@ -104,36 +104,45 @@
 \chapter{Introduction}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
+In this document, one refers to the main user documentation \cite{RefManualMedMemory}
+where the variable \verb+$MED_ROOT_DIR+ is the Med Memory directory installation.
+
 \section{Convention}
 
 \begin{itemize}
 
-\item Difference between local and global number~: when we talk about an 
-element number, we could see $i^{th}$ quadrangle ($i^{th}$ in quadrangles 
-array~: local numbering) or $j^{th}$ element ($j^{th}$ in all elements array~: 
-global numbering). This two numbering are equivalent only if we have one 
-geometric type ;
+\item All numbering begin at one (take care of array index !).
 
-\item All numbering begin at one (take care of array index !) ; 
-\item When you get a C type array with a \texttt{get...} method, you must
+\item When one gets a C (resp. C++) type array (resp. container) using a \texttt{get...} method, one should
 not replace some value of it. Access is in read only. Other use may
-product an impredicable result. To modify a such array use method
-\texttt{set...} ;
-\item Difference between local and global number~: when we talk about an
-element number, we could see \( i^{th} \) quadrangle (\( i^{th} \)
-in quadrangles array~: local numbering) or \( j^{th} \) element
-(\( j^{th} \) in all elements array~: global numbering). This two
-numbering are equivalent only if we have one geometric type.
-\item They are many methods that have two syntax (one singular and one 
-plural). Plurals methods returns array and singulars methods returns one 
+product an impredicable result. To modify a such array (resp. container) use a \texttt{set...}
+method.
+
+\item There are many methods that have two syntax (one singular and one 
+plural). Plural method returns array and singular ones return one 
 particular value in this array (see \method{getCoordinate} and 
-\method{getCoordinates}).
+\method{getCoordinates} for example).
+
+\item Difference between local and global number in mesh element connectivity list~: when one talks about an 
+element number, one could see $i^{th}$ quadrangle ($i^{th}$ in quadrangles 
+array~: local numbering) or $j^{th}$ element ($j^{th}$ in all elements array~: 
+global numbering). These two numbering are equivalent only if one has only one 
+geometric type ;
 
 \end{itemize}
 
 \section{UML diagram}
 
-\includegraphics[width=16cm]{MEDMEM_UML.eps}
+In the following UML diagram, a simple vue of the Med Memory architecture is presented.
+
+\begin{figure}
+\begin{center}
+\leavevmode
+\includegraphics[height=10.63cm,width=14.92cm]{MEDMEM_UML.eps}
+\caption{Main Med Memory UML diagram}
+\label{fig:umldiagfonc}
+\end{center}
+\end{figure}
 
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 \chapter{How to use MED object}
@@ -475,7 +484,7 @@ You could get all basic information (as you set them in \myref{CreateSupport})~:
 \item \verb+getNumber(myGeometricType)+
 \item \verb+getNumberIndex()+
 \end{itemize}
-For details about this methods, see the reference manual \cite{RefManual}.
+For details about this methods, see the reference manual \cite{RefManualMedFile}.
 
 The use of \method{getNumber} and \method{getNumberIndex} are the
 same as \method{getConnectivity} and \method{getConnectivityIndex}
@@ -788,9 +797,18 @@ myGibiMeshDriver.close() ;
 
 \addcontentsline{toc}{chapter}{Bibliography}
 
-\bibitem{RefManual} Reference Manual~: \verb+http://www-drn2.cea.fr/MED/MEDMEM/DOC/html/index.html+
+\bibitem{RefManualMedFile}
+\newblock {Reference Manual for Med File~:} \\
+\newblock {\verb+http://www-drn2.cea.fr/MED/MEDMEM/DOC/html/index.html+}
+
+\bibitem{RefManualMedMemory}
+\newblock {Med Memory Users Reference Manual~:} \\
+\newblock {\verb+file:://$MED_ROOT_DIR/share/salome/doc/html_ref_user/index.html+} \\
+\newblock {\verb+$MED_ROOT_DIR/share/salome/doc/MedMemory_user_2on1.pdf+}
+
 
-\bibitem{vtk} VTK home page~: \verb+http://public.kitware.com/VTK+
+\bibitem{vtk}
+\newblock {VTK home page~: \verb+http://public.kitware.com/VTK+}
 
 \end{thebibliography}
 
diff --git a/doc/MEDMEM/Makefile.in b/doc/MEDMEM/Makefile.in
index b06d7820e..9fdde8788 100644
--- a/doc/MEDMEM/Makefile.in
+++ b/doc/MEDMEM/Makefile.in
@@ -105,7 +105,7 @@ MedMemory_devel_2on1.pdf:
 # User Guide
 
 MEDMEM_UsersGuide.ps: MEDMEM_UsersGuide.dvi
-	dvips -o MEDMEM_UsersGuide.ps MEDMEM_UsersGuide.dvi
+	dvips -t a4 -o MEDMEM_UsersGuide.ps MEDMEM_UsersGuide.dvi
 
 MEDMEM_UsersGuide.pdf: MEDMEM_UsersGuide.ps
 	ps2pdf MEDMEM_UsersGuide.ps MEDMEM_UsersGuide.pdf