Salome HOME
Doc fix and enhancement.
authorabn <adrien.bruneton@cea.fr>
Tue, 9 Feb 2016 14:37:41 +0000 (15:37 +0100)
committerabn <adrien.bruneton@cea.fr>
Tue, 9 Feb 2016 14:38:22 +0000 (15:38 +0100)
src/MEDCoupling/MEDCouplingUMesh.cxx
src/MEDLoader/MEDFileMesh.cxx

index 043cfaaee13239d1b089039849c0329bb7b0b681..fb05c737cba1ab4c6f96a80146a5c11ff795cd1d 100644 (file)
@@ -1277,6 +1277,8 @@ void MEDCouplingUMesh::convertExtrudedPolyhedra()
  * \warning Cells of the result mesh are \b not sorted by geometric type, hence,
  *          to write this mesh to the MED file, its cells must be sorted using
  *          sortCellsInMEDFileFrmt().
+ * \warning Cells (and most notably polyhedrons) must be correctly oriented for this to work
+ *          properly. See orientCorrectlyPolyhedrons() and arePolyhedronsNotCorrectlyOriented().
  * \return \c true if at least one cell has been converted, \c false else. In the
  *         last case the nodal connectivity remains unchanged.
  * \throw If the coordinates array is not set.
@@ -1898,7 +1900,7 @@ void MEDCouplingUMesh::FindCommonCellsAlg(int compType, int startCellId, const D
 /*!
  * Checks if \a this mesh includes all cells of an \a other mesh, and returns an array
  * giving for each cell of the \a other an id of a cell in \a this mesh. A value larger
- * than \a other->getNumberOfCells() in the returned array means that there is no
+ * than \a this->getNumberOfCells() in the returned array means that there is no
  * corresponding cell in \a this mesh.
  * It is expected that \a this and \a other meshes share the same node coordinates
  * array, if it is not so an exception is thrown. 
index 0c6c6e2878f09429b3377d14fa9f91e9ecde7338..0c5163fdad4a32b0bf1b03bf920e3585424f3f2d 100644 (file)
@@ -3893,7 +3893,10 @@ void MEDFileUMesh::buildInnerBoundaryAlongM1Group(const std::string& grpNameM1,
   cellsNotModified=cellsToModifyConn1.retn();
 }
 
-/*!
+/*! Similar to MEDCouplingUMesh::unPolyze():  converts all polygons (if \a this is a 2D mesh) or polyhedrons
+ * (if \a this is a 3D mesh) to cells of classical types. The cells remain correctly sorted by geometric type
+ * in this method.
+ *
  * \param [out] oldCode retrieves the distribution of types before the call if true is returned
  * \param [out] newCode etrieves the distribution of types after the call if true is returned
  * \param [out] o2nRenumCell tells for **all levels** the old 2 new renumbering of cells.