From: abn Date: Mon, 29 Jun 2015 13:23:26 +0000 (+0200) Subject: Doc: added images for SplittingPolicy + sort class list in NAMESPACE index. X-Git-Tag: V7_7_0a1~12 X-Git-Url: http://git.salome-platform.org/gitweb/?a=commitdiff_plain;h=faf9b41dc9515b8d03bace70d2921ae2c94a4be1;p=tools%2Fmedcoupling.git Doc: added images for SplittingPolicy + sort class list in NAMESPACE index. --- diff --git a/doc/doxygen/Doxyfile_med_user.in b/doc/doxygen/Doxyfile_med_user.in index 131302393..5845b2807 100644 --- a/doc/doxygen/Doxyfile_med_user.in +++ b/doc/doxygen/Doxyfile_med_user.in @@ -58,6 +58,7 @@ ENABLED_SECTIONS = user MEDCOUPLING_ug MAX_INITIALIZER_LINES = 30 OPTIMIZE_OUTPUT_FOR_C = NO SHOW_USED_FILES = NO +SORT_BRIEF_DOCS = YES #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- @@ -126,7 +127,7 @@ FILE_PATTERNS = InterpKernelDEC.* \ MEDCoupling1GTUMesh.* \ MEDCouplingPointSet.* \ MEDCouplingCMesh.* \ - MEDCouplingIMesh.* \ + MEDCouplingIMesh.* \ MEDCouplingStructuredMesh.* \ MEDCouplingCurveLinearMesh.* \ MEDCouplingExtrudedMesh.* \ @@ -137,8 +138,8 @@ FILE_PATTERNS = InterpKernelDEC.* \ MEDCouplingFieldTemplate.* \ MEDCouplingFieldDiscretization.* \ MEDCouplingTimeDiscretization.* \ - MEDCouplingAMRAttribute.* \ - MEDCouplingCartesianAMRMesh.* \ + MEDCouplingAMRAttribute.* \ + MEDCouplingCartesianAMRMesh.* \ MEDCouplingTimeLabel.* \ MEDCouplingRefCountObject.* \ MEDCouplingMemArray.* \ diff --git a/doc/doxygen/figures/tetra_simplexize_24_48.jpg b/doc/doxygen/figures/tetra_simplexize_24_48.jpg new file mode 100644 index 000000000..a3933c142 Binary files /dev/null and b/doc/doxygen/figures/tetra_simplexize_24_48.jpg differ diff --git a/doc/doxygen/figures/tetra_simplexize_5_6.jpg b/doc/doxygen/figures/tetra_simplexize_5_6.jpg new file mode 100644 index 000000000..a6786485e Binary files /dev/null and b/doc/doxygen/figures/tetra_simplexize_5_6.jpg differ diff --git a/src/INTERP_KERNEL/Bases/NormalizedGeometricTypes b/src/INTERP_KERNEL/Bases/NormalizedGeometricTypes index 9e2cdbaf0..b02d2cb72 100644 --- a/src/INTERP_KERNEL/Bases/NormalizedGeometricTypes +++ b/src/INTERP_KERNEL/Bases/NormalizedGeometricTypes @@ -54,10 +54,16 @@ namespace INTERP_KERNEL NORM_MAXTYPE = 33 } NormalizedCellType; - /// Type describing the different ways in which the hexahedron can be split into tetrahedra. - /// The PLANAR_* policies persume that each face is to be considered planar, while the general - /// policies make no such hypothesis. The integer at the end gives the number of tetrahedra - /// that result from the split. + /*! Type describing the different ways in which the hexahedron can be split into tetrahedra. + * The PLANAR_* policies persume that each face is to be considered planar, while the general + * policies make no such hypothesis. The integer at the end gives the number of tetrahedra + * that result from the split. + * + * The images below illustrates the policies in their respective order. + * + * \image html tetra_simplexize_5_6.jpg + * \image html tetra_simplexize_24_48.jpg + */ typedef enum { PLANAR_FACE_5 = 5, PLANAR_FACE_6 = 6, GENERAL_24 = 24, GENERAL_48 = 48 } SplittingPolicy; } diff --git a/src/MEDCoupling/MEDCouplingUMesh.cxx b/src/MEDCoupling/MEDCouplingUMesh.cxx index 4f7ee4b68..70db4e588 100644 --- a/src/MEDCoupling/MEDCouplingUMesh.cxx +++ b/src/MEDCoupling/MEDCouplingUMesh.cxx @@ -5529,11 +5529,14 @@ void MEDCouplingUMesh::tessellate2DCurve(double eps) * The semantic of \a policy is: * - 0 - to split QUAD4 by cutting it along 0-2 diagonal (for 2D mesh only). * - 1 - to split QUAD4 by cutting it along 1-3 diagonal (for 2D mesh only). - * - INTERP_KERNEL::PLANAR_FACE_5 - to split HEXA8 into 5 TETRA4 (for 3D mesh only). - * - INTERP_KERNEL::PLANAR_FACE_6 - to split HEXA8 into 6 TETRA4 (for 3D mesh only). + * - INTERP_KERNEL::PLANAR_FACE_5 - to split HEXA8 into 5 TETRA4 (for 3D mesh only - see INTERP_KERNEL::SplittingPolicy for an image). + * - INTERP_KERNEL::PLANAR_FACE_6 - to split HEXA8 into 6 TETRA4 (for 3D mesh only - see INTERP_KERNEL::SplittingPolicy for an image). + * + * * \return DataArrayInt * - a new instance of DataArrayInt holding, for each new cell, * an id of old cell producing it. The caller is to delete this array using - * decrRef() as it is no more needed. + * decrRef() as it is no more needed. + * * \throw If \a policy is 0 or 1 and \a this->getMeshDimension() != 2. * \throw If \a policy is INTERP_KERNEL::PLANAR_FACE_5 or INTERP_KERNEL::PLANAR_FACE_6 * and \a this->getMeshDimension() != 3. @@ -11329,7 +11332,7 @@ DataArrayInt *MEDCouplingUMesh::ComputeRangesFromTypeDistribution(const std::vec * more tuples (nodes) than in \a this. Anyway, all the nodes in \a this (with the same order) will be in the returned mesh. * * \param [in] policy - the policy of splitting that must be in (PLANAR_FACE_5, PLANAR_FACE_6, GENERAL_24, GENERAL_48). The policy will be used only for INTERP_KERNEL::NORM_HEXA8 cells. - * For all other cells, the splitting policy will be ignored. + * For all other cells, the splitting policy will be ignored. See INTERP_KERNEL::SplittingPolicy for the images. * \param [out] nbOfAdditionalPoints - number of nodes added to \c this->_coords. If > 0 a new coordinates object will be constructed result of the aggregation of the old one and the new points added. * \param [out] n2oCells - A new instance of DataArrayInt holding, for each new cell, * an id of old cell producing it. The caller is to delete this array using