Salome HOME
Implement sweep mesh elements along a path (PAL7218).
[modules/smesh.git] / src / SMESH / SMESH_MeshEditor.hxx
1 //  SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
2 //
3 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS 
5 // 
6 //  This library is free software; you can redistribute it and/or 
7 //  modify it under the terms of the GNU Lesser General Public 
8 //  License as published by the Free Software Foundation; either 
9 //  version 2.1 of the License. 
10 // 
11 //  This library is distributed in the hope that it will be useful, 
12 //  but WITHOUT ANY WARRANTY; without even the implied warranty of 
13 //  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
14 //  Lesser General Public License for more details. 
15 // 
16 //  You should have received a copy of the GNU Lesser General Public 
17 //  License along with this library; if not, write to the Free Software 
18 //  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA 
19 // 
20 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org 
21 //
22 //
23 //
24 // File      : SMESH_MeshEditor.hxx
25 // Created   : Mon Apr 12 14:56:19 2004
26 // Author    : Edward AGAPOV (eap)
27 // Module    : SMESH
28
29
30 #ifndef SMESH_MeshEditor_HeaderFile
31 #define SMESH_MeshEditor_HeaderFile
32
33 #include "SMESH_Mesh.hxx"
34 #include "SMESH_Controls.hxx"
35
36 #include <list>
37 #include <map>
38
39 class SMDS_MeshElement;
40 class SMDS_MeshFace;
41 class SMDS_MeshNode;
42 class gp_Ax1;
43 class gp_Vec;
44 class gp_Pnt;
45
46 class SMESH_MeshEditor {
47  public:
48
49   SMESH_MeshEditor( SMESH_Mesh* theMesh );
50
51   bool Remove (const std::list< int >& theElemIDs, const bool isNodes);
52   // Remove a node or an element.
53   // Modify a compute state of sub-meshes which become empty
54
55   bool InverseDiag (const SMDS_MeshElement * theTria1,
56                     const SMDS_MeshElement * theTria2 );
57   // Replace two neighbour triangles with ones built on the same 4 nodes
58   // but having other common link.
59   // Return False if args are improper
60
61   bool InverseDiag (const SMDS_MeshNode * theNode1,
62                     const SMDS_MeshNode * theNode2 );
63   // Replace two neighbour triangles sharing theNode1-theNode2 link
64   // with ones built on the same 4 nodes but having other common link.
65   // Return false if proper faces not found
66
67   bool DeleteDiag (const SMDS_MeshNode * theNode1,
68                    const SMDS_MeshNode * theNode2 );
69   // Replace two neighbour triangles sharing theNode1-theNode2 link
70   // with a quadrangle built on the same 4 nodes.
71   // Return false if proper faces not found
72
73   bool Reorient (const SMDS_MeshElement * theFace);
74   // Reverse the normal of theFace
75   // Return false if theFace is null
76
77
78   bool TriToQuad (std::set<const SMDS_MeshElement*> &  theElems,
79                   SMESH::Controls::NumericalFunctorPtr theCriterion,
80                   const double                         theMaxAngle);
81   // Fuse neighbour triangles into quadrangles.
82   // theCriterion is used to choose a neighbour to fuse with.
83   // theMaxAngle is a max angle between element normals at which
84   // fusion is still performed; theMaxAngle is mesured in radians.
85
86   bool QuadToTri (std::set<const SMDS_MeshElement*> &  theElems,
87                   SMESH::Controls::NumericalFunctorPtr theCriterion);
88   // Cut quadrangles into triangles.
89   // theCriterion is used to choose a diagonal to cut
90
91   bool QuadToTri (std::set<const SMDS_MeshElement*> & theElems,
92                   const bool                          the13Diag);
93   // Cut quadrangles into triangles
94
95
96   enum SmoothMethod { LAPLACIAN = 0, CENTROIDAL };
97
98   void Smooth (std::set<const SMDS_MeshElement*> & theElements,
99                std::set<const SMDS_MeshNode*> &    theFixedNodes,
100                const SmoothMethod                  theSmoothMethod,
101                const int                           theNbIterations,
102                double                              theTgtAspectRatio = 1.0);
103   // Smooth theElements using theSmoothMethod during theNbIterations
104   // or until a worst element has aspect ratio <= theTgtAspectRatio.
105   // Aspect Ratio varies in range [1.0, inf].
106   // If theElements is empty, the whole mesh is smoothed.
107   // theFixedNodes contains additionally fixed nodes. Nodes built
108   // on edges and boundary nodes are always fixed.
109
110
111   void RotationSweep (std::set<const SMDS_MeshElement*> & theElements,
112                       const gp_Ax1&                       theAxis,
113                       const double                        theAngle,
114                       const int                           theNbSteps,
115                       const double                        theToler);
116   // Generate new elements by rotation of theElements around theAxis
117   // by theAngle by theNbSteps
118
119   void ExtrusionSweep (std::set<const SMDS_MeshElement*> & theElements,
120                        const gp_Vec&                       theStep,
121                        const int                           theNbSteps);
122   // Generate new elements by extrusion of theElements 
123   // by theStep by theNbSteps
124
125   enum Extrusion_Error {
126     EXTR_OK,
127     EXTR_NO_ELEMENTS, 
128     EXTR_PATH_NOT_EDGE,
129     EXTR_BAD_PATH_SHAPE,
130     EXTR_BAD_STARTING_NODE,
131     EXTR_BAD_ANGLES_NUMBER,
132     EXTR_CANT_GET_TANGENT
133     };
134   
135   Extrusion_Error ExtrusionAlongTrack (std::set<const SMDS_MeshElement*> & theElements,
136                                        SMESH_subMesh*                      theTrackPattern,
137                                        const SMDS_MeshNode*                theNodeStart,
138                                        const bool                          theHasAngles,
139                                        std::list<double>&                  theAngles,
140                                        const bool                          theHasRefPoint,
141                                        const gp_Pnt&                       theRefPoint);
142   // Generate new elements by extrusion of theElements along path given by theTrackPattern,
143   // theHasAngles are the rotation angles, base point can be given by theRefPoint
144
145   void Transform (std::set<const SMDS_MeshElement*> & theElements,
146                   const gp_Trsf&                      theTrsf,
147                   const bool                          theCopy);
148   // Move or copy theElements applying theTrsf to their nodes
149
150   typedef std::list< std::list< const SMDS_MeshNode* > > TListOfListOfNodes;
151
152   void FindCoincidentNodes (std::set<const SMDS_MeshNode*> & theNodes,
153                             const double                     theTolerance,
154                             TListOfListOfNodes &             theGroupsOfNodes);
155   // Return list of group of nodes close to each other within theTolerance.
156   // Search among theNodes or in the whole mesh if theNodes is empty.
157
158   void MergeNodes (TListOfListOfNodes & theNodeGroups);
159   // In each group, the cdr of nodes are substituted by the first one
160   // in all elements.
161
162   void MergeEqualElements();
163   // Remove all but one of elements built on the same nodes.
164   // Return nb of successfully merged groups.
165
166   static bool CheckFreeBorderNodes(const SMDS_MeshNode* theNode1,
167                                    const SMDS_MeshNode* theNode2,
168                                    const SMDS_MeshNode* theNode3 = 0);
169   // Return true if the three nodes are on a free border
170
171   enum Sew_Error {
172     SEW_OK,
173     // for SewFreeBorder()
174     SEW_BORDER1_NOT_FOUND,
175     SEW_BORDER2_NOT_FOUND,
176     SEW_BOTH_BORDERS_NOT_FOUND,
177     SEW_BAD_SIDE_NODES,
178     SEW_VOLUMES_TO_SPLIT,
179     // for SewSideElements()
180     SEW_DIFF_NB_OF_ELEMENTS,
181     SEW_TOPO_DIFF_SETS_OF_ELEMENTS,
182     SEW_BAD_SIDE1_NODES,
183     SEW_BAD_SIDE2_NODES
184     };
185     
186
187   Sew_Error SewFreeBorder (const SMDS_MeshNode* theBorderFirstNode,
188                            const SMDS_MeshNode* theBorderSecondNode,
189                            const SMDS_MeshNode* theBorderLastNode,
190                            const SMDS_MeshNode* theSide2FirstNode,
191                            const SMDS_MeshNode* theSide2SecondNode,
192                            const SMDS_MeshNode* theSide2ThirdNode = 0,
193                            bool                 theSide2IsFreeBorder = true);
194   // Sew the free border to the side2 by replacing nodes in
195   // elements on the free border with nodes of the elements
196   // of the side 2. If nb of links in the free border and
197   // between theSide2FirstNode and theSide2LastNode are different,
198   // additional nodes are inserted on a link provided that no
199   // volume elements share the splitted link.
200   // The side 2 is a free border if theSide2IsFreeBorder == true.
201   // Sewing is peformed between the given first, second and last
202   // nodes on the sides.
203   // theBorderFirstNode is merged with theSide2FirstNode.
204   // if (!theSide2IsFreeBorder) then theSide2SecondNode gives
205   // the last node on the side 2, which will be merged with
206   // theBorderLastNode.
207   // if (theSide2IsFreeBorder) then theSide2SecondNode will
208   // be merged with theBorderSecondNode.
209   // if (theSide2IsFreeBorder && theSide2ThirdNode == 0) then
210   // the 2 free borders are sewn link by link and no additional
211   // nodes are inserted.
212   // Return false, if sewing failed.
213
214   Sew_Error SewSideElements (std::set<const SMDS_MeshElement*>& theSide1,
215                              std::set<const SMDS_MeshElement*>& theSide2,
216                              const SMDS_MeshNode*               theFirstNode1ToMerge,
217                              const SMDS_MeshNode*               theFirstNode2ToMerge,
218                              const SMDS_MeshNode*               theSecondNode1ToMerge,
219                              const SMDS_MeshNode*               theSecondNode2ToMerge);
220   // Sew two sides of a mesh. Nodes belonging to theSide1 are
221   // merged with nodes of elements of theSide2.
222   // Number of elements in theSide1 and in theSide2 must be
223   // equal and they should have similar node connectivity.
224   // The nodes to merge should belong to side s borders and
225   // the first node should be linked to the second.
226
227   void InsertNodesIntoLink(const SMDS_MeshElement*          theFace,
228                            const SMDS_MeshNode*             theBetweenNode1,
229                            const SMDS_MeshNode*             theBetweenNode2,
230                            std::list<const SMDS_MeshNode*>& theNodesToInsert);
231   // insert theNodesToInsert into theFace between theBetweenNode1
232   // and theBetweenNode2 and split theElement.
233
234   static int SortQuadNodes (const SMDS_Mesh * theMesh,
235                             int               theNodeIds[] );
236   // Set 4 nodes of a quadrangle face in a good order.
237   // Swap 1<->2 or 2<->3 nodes and correspondingly return
238   // 1 or 2 else 0.
239
240   static bool SortHexaNodes (const SMDS_Mesh * theMesh,
241                              int               theNodeIds[] );
242   // Set 8 nodes of a hexahedron in a good order.
243   // Return success status
244
245   static void AddToSameGroups (const SMDS_MeshElement* elemToAdd,
246                                const SMDS_MeshElement* elemInGroups,
247                                SMESHDS_Mesh *          aMesh);
248   // Add elemToAdd to the groups the elemInGroups belongs to
249
250   static const SMDS_MeshElement*
251     FindFaceInSet(const SMDS_MeshNode*                     n1,
252                   const SMDS_MeshNode*                     n2,
253                   const std::set<const SMDS_MeshElement*>& elemSet,
254                   const std::set<const SMDS_MeshElement*>& avoidSet);
255   // Return a face having linked nodes n1 and n2 and which is
256   // - not in avoidSet,
257   // - in elemSet provided that !elemSet.empty()
258
259   int FindShape (const SMDS_MeshElement * theElem);
260   // Return an index of the shape theElem is on
261   // or zero if a shape not found
262
263
264   SMESH_Mesh * GetMesh() { return myMesh; }
265
266   SMESHDS_Mesh * GetMeshDS() { return myMesh->GetMeshDS(); }
267
268
269  private:
270
271   SMESH_Mesh * myMesh;
272
273 };
274
275 #endif