From: ageay <ageay>
Date: Tue, 10 Jul 2012 13:09:48 +0000 (+0000)
Subject: Docs #3.
X-Git-Tag: V6_main_FINAL~593
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=6b5175d7e256d9e5a1965c5844a2205741c1edfc;p=tools%2Fmedcoupling.git

Docs #3.
---

diff --git a/doc/doxygen/interpkernel.dox b/doc/doxygen/interpkernel.dox
index 83f124b7a..b0c92bd85 100644
--- a/doc/doxygen/interpkernel.dox
+++ b/doc/doxygen/interpkernel.dox
@@ -26,10 +26,9 @@ is too far from an another cell in the target mesh each.
 So for a given type of interpolation, the computation of W is
 performed in two steps :
 
-      -# A filtering process reduces the number of pairs of
-      elements for which the calculation must be carried out by
-      eliminating the pairs whose bounding boxes do not intersect. 
-      -# For all remaining pairs calling for each intersector (click here for the available \ref InterpKerIntersectors).
+-# A filtering process reduces the number of pairs of elements for which the calculation must be carried out by
+   eliminating the pairs whose bounding boxes do not intersect.
+-# For all remaining pairs calling for each intersector (click here for the available \ref InterpKerIntersectors).
 
 Whatever its dimension and type, each interpolator inherits from INTERP_KERNEL::Interpolation which is a
 template (CRTP) class than enable an easy access to the main API without useless CPU cost.
@@ -44,24 +43,24 @@ with \bseveral \b mesh \b formats such as \c MED or \c VTK, \b without \b prefor
 \c MeshType is a concept that should strictly fulfilled the following
 rules :
 
-      - Const values / Types
-        - MyConnType : represents type of connectivity index. This is typically \c int or \c long \c int .
-        - MY_SPACEDIM : space dimension. Dimension relative to coordinates.
-        - MY_MESHDIM : the dimension of all cells in meshes.
-        - My_numPol : policy of numbering. C Format ( \f$ [0,n-1] \f$ ) or FORTRAN ( \f$ [1,n] \f$ ).
-      - Methods
-        -# \code void getBoundingBox(double *boundingBox) const \endcode
-        -# \code INTERP_KERNEL::NormalizedCellType getTypeOfElement(MyConnType eltId) const \endcode
-        -# \code unsigned char getNumberOfNodesOfElement(MyConnType eltId) const \endcode
-        -# \code unsigned long getNumberOfNodes() const \endcode
-        -# \code unsigned long getNumberOfElements() const \endcode
-        -# \code const MyConnType *getConnectivityPtr() const \endcode
-        -# \code const double *getCoordinatesPtr() const \endcode
-        -# \code const MyConnType *getConnectivityIndexPtr() const \endcode
-        -# \code void releaseTempArrays() \endcode
-      - Formats of arrays
-        - the array returned by \c getCoordinatesPtr must be a \b full \b interlace array.
-        - the arrays returned by \c getConnectivityPtr and \c getConnectivityIndexPtr must be with the same principle as it is in \ref medmemConnArrays "medmem". Of course the numbering format may change according to \a My_numPol policy.
+- Const values / Types
+  - MyConnType : represents type of connectivity index. This is typically \c int or \c long \c int .
+  - MY_SPACEDIM : space dimension. Dimension relative to coordinates.
+  - MY_MESHDIM : the dimension of all cells in meshes.
+  - My_numPol : policy of numbering. C Format ( \f$ [0,n-1] \f$ ) or FORTRAN ( \f$ [1,n] \f$ ).
+- Methods
+  -# \code void getBoundingBox(double *boundingBox) const \endcode
+  -# \code INTERP_KERNEL::NormalizedCellType getTypeOfElement(MyConnType eltId) const \endcode
+  -# \code unsigned char getNumberOfNodesOfElement(MyConnType eltId) const \endcode
+  -# \code unsigned long getNumberOfNodes() const \endcode
+  -# \code unsigned long getNumberOfElements() const \endcode
+  -# \code const MyConnType *getConnectivityPtr() const \endcode
+  -# \code const double *getCoordinatesPtr() const \endcode
+  -# \code const MyConnType *getConnectivityIndexPtr() const \endcode
+  -# \code void releaseTempArrays() \endcode
+- Formats of arrays
+  - the array returned by \c getCoordinatesPtr must be a \b full \b interlace array.
+  - the arrays returned by \c getConnectivityPtr and \c getConnectivityIndexPtr must be with the same principle as it is in \ref medmemConnArrays "medmem". Of course the numbering format may change according to \a My_numPol policy.
 
 Note that the array format for connectivity is kept close to MED. It is
 close to VTK format too but slightly different. So it may require for the VTK side a copy
@@ -72,17 +71,15 @@ on wrap. To avoid this copy of a part of the connectivity structure, an iterator
 As already said, the matrix returned by interpolator is typically a sparse matrix. Instances of
 \c class \c MatrixType are used to store the resulting interpolation matrix. To be able to be filled by the interpolator the \c MatrixType class has to match the following concept :
 
-      - Methods
-        -# \code void resize(uint nbrows) \endcode
-        -# \code Row &operator [] (uint irow) \endcode
+- Methods
+  -# \code void resize(uint nbrows) \endcode
+  -# \code Row &operator [] (uint irow) \endcode
 
 \c class \c Row has to match at least the following concept :
 
-      - Methods
-        - \code void insert(const std::pair<int,T>& myPair) \endcode
-
-Note that \c std::vector\c < \c std::map<int,double> > is a candidate for
-\c MatrixType.
+- Methods
+  - \code void insert(const std::pair<int,T>& myPair) \endcode
 
+Note that \c std::vector\c < \c std::map<int,double> > is a candidate for \c MatrixType.
 
 */
\ No newline at end of file