1 // Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
22 // SMESH SMESH : implementaion of SMESH idl descriptions
23 // File : StdMeshers_Prism_3D.hxx
26 #ifndef _SMESH_Prism_3D_HXX_
27 #define _SMESH_Prism_3D_HXX_
29 #include "SMESH_StdMeshers.hxx"
31 #include "SMESH_3D_Algo.hxx"
32 #include "SMDS_TypeOfPosition.hxx"
33 #include "SMDS_MeshNode.hxx"
34 #include "SMESH_Block.hxx"
35 #include "SMESH_Mesh.hxx"
36 #include "SMESHDS_Mesh.hxx"
37 #include "SMESH_subMesh.hxx"
38 #include "SMESH_MesherHelper.hxx"
39 #include "SMESH_Comment.hxx"
43 #include <Adaptor3d_Curve.hxx>
44 #include <Adaptor3d_Surface.hxx>
45 #include <Adaptor2d_Curve2d.hxx>
46 #include <BRepAdaptor_Surface.hxx>
47 #include <TopTools_IndexedMapOfOrientedShape.hxx>
51 class SMESHDS_SubMesh;
56 //typedef std::map<const SMDS_MeshNode*, const SMDS_MeshNode*> TNodeNodeMap;
57 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
59 // map of bottom nodes to the column of nodes above them
60 // (the column includes the bottom nodes)
61 typedef std::map< TNode, TNodeColumn > TNode2ColumnMap;
62 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
63 typedef std::map< double, TNodeColumn >::const_iterator TParam2ColumnIt;
65 typedef TopTools_IndexedMapOfOrientedShape TBlockShapes;
67 // ===============================================
69 * \brief Structure containing node relative data
71 // ===============================================
75 const SMDS_MeshNode* myNode;
78 gp_XYZ GetCoords() const { return gp_XYZ( myNode->X(), myNode->Y(), myNode->Z() ); }
79 gp_XYZ GetParams() const { return myParams; }
80 gp_XYZ& ChangeParams() { return myParams; }
81 bool HasParams() const { return myParams.X() >= 0.0; }
82 SMDS_TypeOfPosition GetPositionType() const
83 { return myNode ? myNode->GetPosition()->GetTypeOfPosition() : SMDS_TOP_UNSPEC; }
84 bool IsNeighbor( const TNode& other ) const;
86 TNode(const SMDS_MeshNode* node = 0): myNode(node), myParams(-1,-1,-1) {}
87 bool operator < (const TNode& other) const { return myNode < other.myNode; }
90 // ===============================================================
92 * \brief Tool analyzing and giving access to a prism geometry
93 * treating it like a block, i.e. the four side faces are
94 * emulated by division/uniting of missing/excess faces.
95 * It also manage associations between block subshapes and a mesh.
97 // ===============================================================
99 class STDMESHERS_EXPORT StdMeshers_PrismAsBlock: public SMESH_Block
103 * \brief Constructor. Initialization is needed
105 StdMeshers_PrismAsBlock();
107 ~StdMeshers_PrismAsBlock();
110 * \brief Initialization.
111 * \param helper - helper loaded with mesh and 3D shape
112 * \param shape3D - a closed shell or solid
113 * \retval bool - false if a mesh or a shape are KO
115 * Analyse shape geometry and mesh.
116 * If there are triangles on one of faces, it becomes 'bottom'
118 bool Init(SMESH_MesherHelper* helper, const TopoDS_Shape& shape3D);
121 * \brief Return problem description
123 SMESH_ComputeErrorPtr GetError() const { return myError; }
126 * \brief Return number of nodes on every vertical edge
127 * \retval int - number of nodes including end nodes
129 int VerticalSize() const { return myParam2ColumnMaps[0].begin()->second.size(); }
131 bool HasNotQuadElemOnTop() const { return myNotQuadOnTop; }
134 * \brief Return pointer to column of nodes
135 * \param node - bottom node from which the returned column goes up
136 * \retval const TNodeColumn* - the found column
138 const TNodeColumn* GetNodeColumn(const SMDS_MeshNode* node) const;
141 * \brief Return TParam2ColumnMap for a base edge
142 * \param baseEdgeID - base edge SMESHDS Index
143 * \param isReverse - columns in-block orientation
144 * \retval const TParam2ColumnMap& - map
146 const TParam2ColumnMap& GetParam2ColumnMap(const int baseEdgeID,
149 std::pair< TParam2ColumnMap*, bool > & col_frw =
150 myShapeIndex2ColumnMap[ baseEdgeID ];
151 isReverse = !col_frw.second;
152 return * col_frw.first;
156 * \brief Return pointer to mesh
157 * \retval SMESH_Mesh - mesh
159 SMESH_Mesh* Mesh() const { return myHelper->GetMesh(); }
162 * \brief Return pointer to mesh DS
163 * \retval SMESHDS_Mesh - mesh DS
165 SMESHDS_Mesh* MeshDS() const { return Mesh()->GetMeshDS(); }
168 * \brief Return submesh of a shape
169 * \param shapeID - shape given by in-block index
170 * \retval SMESH_subMesh* - found submesh
172 SMESH_subMesh* SubMesh(const int shapeID) const
173 { return Mesh()->GetSubMesh( Shape( shapeID )); }
176 * \brief Return submesh DS of a shape
177 * \param shapeID - shape given by in-block index
178 * \retval SMESHDS_SubMesh* - found submesh DS
180 SMESHDS_SubMesh* SubMeshDS(const int shapeID) const
181 { return SubMesh(shapeID)->GetSubMeshDS(); }
184 * \brief Return a in-block shape
185 * \param shapeID - shape given by in-block index
186 * \retval SMESHDS_SubMesh* - found submesh
188 const TopoDS_Shape& Shape(const int shapeID) const
189 { return myShapeIDMap( shapeID ); }
192 * \brief Return in-block ID of a shape
193 * \param shape - block subshape
194 * \retval int - ID or zero if the shape has no ID
196 int ShapeID(const TopoDS_Shape& shape) const
197 { return myShapeIDMap.FindIndex( shape ); }
200 * \brief Check curve orientation of a bootom edge
201 * \param meshDS - mesh DS
202 * \param columnsMap - node columns map of side face
203 * \param bottomEdge - the bootom edge
204 * \param sideFaceID - side face in-block ID
205 * \retval bool - true if orienation coinside with in-block froward orienation
207 static bool IsForwardEdge(SMESHDS_Mesh* meshDS,
208 const TParam2ColumnMap& columnsMap,
209 const TopoDS_Edge & bottomEdge,
210 const int sideFaceID);
212 * \brief Find wall faces by bottom edges
213 * \param mesh - the mesh
214 * \param mainShape - the prism
215 * \param bottomFace - the bottom face
216 * \param bottomEdges - edges bounding the bottom face
217 * \param wallFaces - faces list to fill in
219 static bool GetWallFaces( SMESH_Mesh* mesh,
220 const TopoDS_Shape & mainShape,
221 const TopoDS_Shape & bottomFace,
222 const std::list< TopoDS_Edge >& bottomEdges,
223 std::list< TopoDS_Face >& wallFaces);
227 // --------------------------------------------------------------------
229 * \brief Class representing a part of a geom face or
230 * a union of seleral faces. Or just an ordinary geom face
232 * It's parametrization is within [0,1] range.
233 * It redefines Adaptor3d_Surface::Value(U,V) where U and V are within [0,1]
235 // --------------------------------------------------------------------
236 class TSideFace: public Adaptor3d_Surface
238 int myID; //!< in-block ID
239 // map used to find out real UV by it's normalized UV
240 TParam2ColumnMap* myParamToColumnMap;
241 BRepAdaptor_Surface mySurface;
242 TopoDS_Edge myBaseEdge;
243 // first and last normalized params and orientaion for each component or it-self
244 std::vector< std::pair< double, double> > myParams;
246 std::vector< TSideFace* > myComponents;
247 SMESH_MesherHelper * myHelper;
249 TSideFace( SMESH_MesherHelper* helper,
251 const TopoDS_Face& face,
252 const TopoDS_Edge& baseEdge,
253 TParam2ColumnMap* columnsMap,
254 const double first = 0.0,
255 const double last = 1.0);
256 TSideFace( const std::vector< TSideFace* >& components,
257 const std::vector< std::pair< double, double> > & params);
258 TSideFace( const TSideFace& other );
260 bool IsComplex() const
261 { return ( NbComponents() > 0 || myParams[0].first != 0. || myParams[0].second != 1. ); }
262 int FaceID() const { return myID; }
263 TParam2ColumnMap* GetColumns() const { return myParamToColumnMap; }
264 gp_XY GetNodeUV(const TopoDS_Face& F, const SMDS_MeshNode* n) const
265 { return myHelper->GetNodeUV( F, n ); }
266 const TopoDS_Edge & BaseEdge() const { return myBaseEdge; }
267 int ColumnHeight() const {
268 if ( NbComponents() ) return GetComponent(0)->GetColumns()->begin()->second.size();
269 else return GetColumns()->begin()->second.size(); }
270 double GetColumns(const double U, TParam2ColumnIt & col1, TParam2ColumnIt& col2 ) const;
271 int NbComponents() const { return myComponents.size(); }
272 TSideFace* GetComponent(const int i) const { return myComponents.at( i ); }
273 void SetComponent(const int i, TSideFace* c)
274 { if ( myComponents[i] ) delete myComponents[i]; myComponents[i]=c; }
275 TSideFace* GetComponent(const double U, double& localU) const;
276 bool IsForward() const { return myIsForward; }
277 // boundary geometry for a face
278 Adaptor3d_Surface* Surface() const { return new TSideFace( *this ); }
279 bool GetPCurves(Adaptor2d_Curve2d* pcurv[4]) const;
280 Adaptor2d_Curve2d* HorizPCurve(const bool isTop, const TopoDS_Face& horFace) const;
281 Adaptor3d_Curve* HorizCurve(const bool isTop) const;
282 Adaptor3d_Curve* VertiCurve(const bool isMax) const;
283 TopoDS_Edge GetEdge( const int edge ) const;
284 int InsertSubShapes( TBlockShapes& shapeMap ) const;
285 // redefine Adaptor methods
286 gp_Pnt Value(const Standard_Real U,const Standard_Real V) const;
289 // --------------------------------------------------------------------
291 * \brief Class emulating geometry of a vertical edge
293 // --------------------------------------------------------------------
294 class STDMESHERS_EXPORT TVerticalEdgeAdaptor: public Adaptor3d_Curve
296 const TNodeColumn* myNodeColumn;
298 TVerticalEdgeAdaptor( const TParam2ColumnMap* columnsMap, const double parameter );
299 gp_Pnt Value(const Standard_Real U) const;
300 Standard_Real FirstParameter() const { return 0; }
301 Standard_Real LastParameter() const { return 1; }
304 // --------------------------------------------------------------------
306 * \brief Class emulating geometry of a hirizontal edge
308 // --------------------------------------------------------------------
309 class STDMESHERS_EXPORT THorizontalEdgeAdaptor: public Adaptor3d_Curve
311 const TSideFace* mySide;
314 THorizontalEdgeAdaptor( const TSideFace* sideFace, const bool isTop)
315 :mySide(sideFace), myV( isTop ? 1.0 : 0.0 ) {}
316 gp_Pnt Value(const Standard_Real U) const;
317 Standard_Real FirstParameter() const { return 0; }
318 Standard_Real LastParameter() const { return 1; }
321 // --------------------------------------------------------------------
323 * \brief Class emulating pcurve on a hirizontal face
325 // --------------------------------------------------------------------
326 class STDMESHERS_EXPORT TPCurveOnHorFaceAdaptor: public Adaptor2d_Curve2d
328 const TSideFace* mySide;
332 TPCurveOnHorFaceAdaptor( const TSideFace* sideFace,
334 const TopoDS_Face& horFace)
335 : mySide(sideFace), myFace(horFace), myZ(isTop ? mySide->ColumnHeight() - 1 : 0 ) {}
336 gp_Pnt2d Value(const Standard_Real U) const;
337 Standard_Real FirstParameter() const { return 0; }
338 Standard_Real LastParameter() const { return 1; }
340 // --------------------------------------------------------------------
343 SMESH_MesherHelper* myHelper;
344 TBlockShapes myShapeIDMap;
346 // container of 4 side faces
348 // node columns for each base edge
349 std::vector< TParam2ColumnMap > myParam2ColumnMaps;
350 // to find a column for a node by edge SMESHDS Index
351 std::map< int, std::pair< TParam2ColumnMap*, bool > > myShapeIndex2ColumnMap;
353 SMESH_ComputeErrorPtr myError;
355 * \brief store error and comment and then return ( error == COMPERR_OK )
357 bool error(int error, const SMESH_Comment& comment = "") {
358 myError = SMESH_ComputeError::New(error,comment);
359 return myError->IsOK();
361 //vector< SMESH_subMesh* > mySubMeshesVec; // submesh by in-block id
364 // =============================================
366 * \brief Algo building prisms on a prism shape
368 // =============================================
370 class STDMESHERS_EXPORT StdMeshers_Prism_3D: public SMESH_3D_Algo
373 StdMeshers_Prism_3D(int hypId, int studyId, SMESH_Gen* gen);
374 virtual ~StdMeshers_Prism_3D();
376 virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
377 const TopoDS_Shape& aShape,
378 SMESH_Hypothesis::Hypothesis_Status& aStatus);
380 virtual bool Compute(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
383 * \brief Enable removal of quadrangles from the bottom face and
384 * triangles creation there by projection from the top
385 * (sole face meshed with triangles is considered to be a bottom one).
386 * If there are two faces with triangles, triangles must
387 * be of the same topology, else the algo fails.
388 * The method must be called before Compute()
390 void ProjectTriangles() { myProjectTriangles = true; }
393 * \brief Create prisms
394 * \param nodeColumns - columns of nodes generated from nodes of a mesh face
395 * \param helper - helper initialized by mesh and shape to add prisms to
397 static void AddPrisms( std::vector<const TNodeColumn*> & nodeColumns,
398 SMESH_MesherHelper* helper);
403 * \brief Find correspondence between bottom and top nodes.
404 * If elements on the bottom and top faces are topologically different,
405 * and projection is possible and allowed, perform the projection
406 * \retval bool - is a success or not
408 bool assocOrProjBottom2Top();
411 * \brief Remove quadrangles from the top face and
412 * create triangles there by projection from the bottom
413 * \retval bool - a success or not
415 bool projectBottomToTop();
418 * \brief Set projection coordinates of a node to a face and it's subshapes
419 * \param faceID - the face given by in-block ID
420 * \param params - node normalized parameters
421 * \retval bool - is a success
423 bool setFaceAndEdgesXYZ( const int faceID, const gp_XYZ& params, int z );
427 bool myProjectTriangles;
429 StdMeshers_PrismAsBlock myBlock;
430 SMESH_MesherHelper* myHelper;
432 std::vector<gp_XYZ> myShapeXYZ; // point on each sub-shape
434 // map of bottom nodes to the column of nodes above them
435 // (the column includes the bottom node)
436 typedef std::map< TNode, TNodeColumn > TNode2ColumnMap;
437 TNode2ColumnMap myBotToColumnMap;