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

getSkewField(): documentation.
---

diff --git a/src/MEDCoupling/MEDCouplingUMesh.cxx b/src/MEDCoupling/MEDCouplingUMesh.cxx
index 66153a584..b50bae909 100644
--- a/src/MEDCoupling/MEDCouplingUMesh.cxx
+++ b/src/MEDCoupling/MEDCouplingUMesh.cxx
@@ -6549,6 +6549,11 @@ MEDCouplingFieldDouble *MEDCouplingUMesh::getWarpField() const
  * Creates a new MEDCouplingFieldDouble holding Skew factor values of all
  * cells of \a this 2D mesh in 3D space. Currently cells of the following types are
  * treated: INTERP_KERNEL::NORM_QUAD4.
+ * 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$
+ *
  * For a cell of other type an exception is thrown.
  *  \return MEDCouplingFieldDouble * - a new instance of MEDCouplingFieldDouble on
  *          cells and one time, lying on \a this mesh. The caller is to delete this