Salome HOME
fix failure of non-regression test SMESH_TEST/Grids/smesh/mesh_Projection_2D/A1
[modules/smesh.git] / src / SMESH / SMESH_MesherHelper.hxx
index b8dc4cec9daaa6c19c7b36b7a3a706af08455bda..4b4ffdb750b53ba7301658886b02671bf202c51d 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2011  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -58,12 +58,15 @@ typedef gp_XY (*xyFunPtr)(const gp_XY& uv1, const gp_XY& uv2);
 
 //=======================================================================
 /*!
- * \brief It helps meshers to add elements
+ * \brief It helps meshers to add elements and provides other utilities
  *
- * It allow meshers not to care about creation of medium nodes
+ * - It allows meshers not to care about creation of medium nodes
  * when filling a quadratic mesh. Helper does it itself.
- * It defines degree of elements to create when IsQuadraticSubMesh()
+ * It defines order of elements to create when IsQuadraticSubMesh()
  * is called.
+ * - It provides information on a shape it is initialized with:
+ * periodicity, presence of singularities etc.
+ * - ...
  */
 //=======================================================================
 
@@ -73,13 +76,15 @@ public:
   // ---------- PUBLIC UTILITIES ----------
   
   /*!
-   * \brief Returns true if given node is medium
-    * \param n - node to check
-    * \param typeToCheck - type of elements containing the node to ask about node status
+   * \brief Returns true if all elements of a sub-mesh are of same shape
+    * \param smDS - sub-mesh to check elements of
+    * \param shape - expected shape of elements
+    * \param nullSubMeshRes - result value for the case of smDS == NULL
     * \retval bool - check result
    */
-  static bool IsMedium(const SMDS_MeshNode*      node,
-                       const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
+  static bool IsSameElemGeometry(const SMESHDS_SubMesh* smDS,
+                                 SMDSAbs_GeometryType   shape,
+                                 const bool             nullSubMeshRes = true);
 
   /*!
    * \brief Load nodes bound to face into a map of node columns
@@ -107,6 +112,19 @@ public:
                               const TopoDS_Edge& theBaseEdge,
                               SMESHDS_Mesh*      theMesh,
                               SMESH_ProxyMesh*   theProxyMesh=0);
+  /*!
+   * \brief Return true if 2D mesh on FACE is structured
+   */
+  static bool IsStructured( SMESH_subMesh* faceSM );
+
+  /*!
+   * \brief Returns true if given node is medium
+    * \param n - node to check
+    * \param typeToCheck - type of elements containing the node to ask about node status
+    * \retval bool - check result
+   */
+  static bool IsMedium(const SMDS_MeshNode*      node,
+                       const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
   /*!
    * \brief Return support shape of a node
    * \param node - the node
@@ -128,6 +146,17 @@ public:
     return ind;
   }
 
+  /*!
+   * \brief Count nb of sub-shapes
+    * \param shape - the shape
+    * \param type - the type of sub-shapes to count
+    * \param ignoreSame - if true, use map not to count same shapes, esle use explorer
+    * \retval int - the calculated number
+   */
+  static int Count(const TopoDS_Shape&    shape,
+                   const TopAbs_ShapeEnum type,
+                   const bool             ignoreSame);
+
   /*!
    * \brief Return number of unique ancestors of the shape
    */
@@ -140,7 +169,13 @@ public:
   static PShapeIteratorPtr GetAncestors(const TopoDS_Shape& shape,
                                         const SMESH_Mesh&   mesh,
                                         TopAbs_ShapeEnum    ancestorType);
-
+  /*!
+   * \brief Find a common ancestor, of the given type, of two shapes
+   */
+  static TopoDS_Shape GetCommonAncestor(const TopoDS_Shape& shape1,
+                                        const TopoDS_Shape& shape2,
+                                        const SMESH_Mesh&   mesh,
+                                        TopAbs_ShapeEnum    ancestorType);
   /*!
    * \brief Return orientation of sub-shape in the main shape
    */
@@ -157,6 +192,9 @@ public:
 
   static TopoDS_Vertex IthVertex( const bool is2nd, TopoDS_Edge anEdge, const bool CumOri=true );
 
+  static TopAbs_ShapeEnum GetGroupType(const TopoDS_Shape& group,
+                                       const bool          avoidCompound=false);
+
 
 public:
   // ---------- PUBLIC INSTANCE METHODS ----------
@@ -183,18 +221,25 @@ public:
    */
   bool GetIsQuadratic() const { return myCreateQuadratic; }
 
+  /*
+   * \brief Find out elements orientation on a geometrical face
+   */
+  bool IsReversedSubMesh (const TopoDS_Face& theFace);
+
   /*!
    * \brief Move medium nodes of faces and volumes to fix distorted elements
+   * \param error - container of fixed distorted elements
    * \param volumeOnly - fix nodes on geom faces or not if the shape is solid
    */
-  void FixQuadraticElements(bool volumeOnly=true);
+  void FixQuadraticElements(SMESH_ComputeErrorPtr& error, bool volumeOnly=true);
 
   /*!
    * \brief To set created elements on the shape set by IsQuadraticSubMesh()
    *        or the next methods. By defaul elements are set on the shape if
    *        a mesh has no shape to be meshed
    */
-  void SetElementsOnShape(bool toSet) { mySetElemOnShape = toSet; }
+  bool SetElementsOnShape(bool toSet)
+  { bool res = mySetElemOnShape; mySetElemOnShape = toSet; return res; }
 
   /*!
    * \brief Set shape to make elements on without calling IsQuadraticSubMesh()
@@ -214,7 +259,7 @@ public:
   /*!
    * Creates a node
    */
-  SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0);
+  SMDS_MeshNode* AddNode(double x, double y, double z, int ID = 0, double u=0., double v=0.);
   /*!
    * Creates quadratic or linear edge
    */
@@ -290,6 +335,24 @@ public:
                              const int id = 0, 
                              bool force3d = true);
 
+  /*!
+   * Creates LINEAR!!!!!!!!! octahedron
+   */
+  SMDS_MeshVolume* AddVolume(const SMDS_MeshNode* n1,
+                             const SMDS_MeshNode* n2,
+                             const SMDS_MeshNode* n3,
+                             const SMDS_MeshNode* n4,
+                             const SMDS_MeshNode* n5,
+                             const SMDS_MeshNode* n6,
+                             const SMDS_MeshNode* n7,
+                             const SMDS_MeshNode* n8,
+                             const SMDS_MeshNode* n9,
+                             const SMDS_MeshNode* n10,
+                             const SMDS_MeshNode* n11,
+                             const SMDS_MeshNode* n12,
+                             const int id = 0, 
+                             bool force3d = true);
+
   /*!
    * Creates polyhedron. In quadratic mesh, adds medium nodes
    */
@@ -297,6 +360,14 @@ public:
                                         const std::vector<int>&                  quantities,
                                         const int                                ID=0,
                                         const bool                               force3d = true);
+  /*!
+   * \brief Enables fixing node parameters on EDGEs and FACEs by
+   * GetNodeU(...,check=true), GetNodeUV(...,check=true), CheckNodeUV() and
+   * CheckNodeU() in case if a node lies on a shape set via SetSubShape().
+   * Default is False
+   */
+  void ToFixNodeParameters(bool toFix);
+
   /*!
    * \brief Return U of the given node on the edge
    */
@@ -307,6 +378,7 @@ public:
   /*!
    * \brief Return node UV on face
    *  \param inFaceNode - a node of element being created located inside a face
+   *  \param check - if provided, returns result of UV check that it enforces
    */
   gp_XY GetNodeUV(const TopoDS_Face&   F,
                   const SMDS_MeshNode* n,
@@ -453,6 +525,12 @@ public:
   const SMDS_MeshNode* GetMediumNode(const SMDS_MeshNode* n1,
                                      const SMDS_MeshNode* n2,
                                      const bool force3d);
+  /*!
+   * \brief Return index and type of the shape (EDGE or FACE only) to set a medium node on
+   */
+  std::pair<int, TopAbs_ShapeEnum> GetMediumPos(const SMDS_MeshNode* n1,
+                                                const SMDS_MeshNode* n2,
+                                                const bool           useCurSubShape=false);
   /*!
    * \brief Add a link in my data structure
    */
@@ -519,9 +597,9 @@ protected:
   SMESH_Mesh*     myMesh;
   int             myShapeID;
 
-  // to create quadratic elements
   bool            myCreateQuadratic;
   bool            mySetElemOnShape;
+  bool            myFixNodeParameters;
 
   std::map< int,bool > myNodePosShapesValidity;
   bool toCheckPosOnShape(int shapeID ) const;