From: abn <adrien.bruneton@cea.fr>
Date: Fri, 5 Feb 2016 12:47:59 +0000 (+0100)
Subject: getWarpField(): documentation
X-Git-Tag: V7_8_0a2~31
X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=6d52bab427cc2a289e4e92d418d71ee1a872db3c;p=tools%2Fmedcoupling.git

getWarpField(): documentation
---

diff --git a/src/MEDCoupling/MEDCouplingUMesh.cxx b/src/MEDCoupling/MEDCouplingUMesh.cxx
index b50bae909..83f8d492a 100644
--- a/src/MEDCoupling/MEDCouplingUMesh.cxx
+++ b/src/MEDCoupling/MEDCouplingUMesh.cxx
@@ -6487,9 +6487,19 @@ MEDCouplingFieldDouble *MEDCouplingUMesh::getAspectRatioField() const
 
 /*!
  * Creates a new MEDCouplingFieldDouble holding Warping factor values of all
- * cells of \a this 2D mesh in 3D space. Currently cells of the following types are
+ * cells of \a this 2D mesh in 3D space. It is a measure of the "planarity" of 2D cell
+ * in 3D space. Currently only cells of the following types are
  * treated: INTERP_KERNEL::NORM_QUAD4.
  * For a cell of other type an exception is thrown.
+ * The warp field is computed as follows: let (a,b,c,d) be the points of the quad.
+ * Defining
+ * \f$t=\vec{da}\times\vec{ab}\f$,
+ * \f$u=\vec{ab}\times\vec{bc}\f$
+ * \f$v=\vec{bc}\times\vec{cd}\f$
+ * \f$w=\vec{cd}\times\vec{da}\f$, the warp is defined as \f$W^3\f$ with
+ *  \f[
+ *     W=min(\frac{t}{|t|}\cdot\frac{v}{|v|}, \frac{u}{|u|}\cdot\frac{w}{|w|})
+ *  \f]
  *  \return MEDCouplingFieldDouble * - a new instance of MEDCouplingFieldDouble on
  *          cells and one time, lying on \a this mesh. The caller is to delete this
  *          field using decrRef() as it is no more needed. 
@@ -6552,7 +6562,9 @@ MEDCouplingFieldDouble *MEDCouplingUMesh::getWarpField() const
  * The skew is computed as follow for a quad with points (a,b,c,d): let
  * \f$u=\vec{ab}+\vec{dc}\f$ and \f$v=\vec{ac}+\vec{bd}\f$
  * then the skew is computed as:
- *  \f$s=\frac{u}{|u|}\cdot\frac{v}{|v|}\f$
+ *  \f[
+ *    s=\frac{u}{|u|}\cdot\frac{v}{|v|}
+ *  \f]
  *
  * For a cell of other type an exception is thrown.
  *  \return MEDCouplingFieldDouble * - a new instance of MEDCouplingFieldDouble on