]> SALOME platform Git repositories - tools/medcoupling.git/commitdiff
Salome HOME
getSkewField(): documentation.
authorabn <adrien.bruneton@cea.fr>
Fri, 5 Feb 2016 12:05:38 +0000 (13:05 +0100)
committerabn <adrien.bruneton@cea.fr>
Fri, 5 Feb 2016 12:05:38 +0000 (13:05 +0100)
src/MEDCoupling/MEDCouplingUMesh.cxx

index 66153a584412ae2cb854070c4f8bbe38045a48f3..b50bae9093e65038342d94386f9e55c8e57c9625 100644 (file)
@@ -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