1 // Copyright (C) 2007-2016 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, or (at your option) any later version.
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
23 // SMESH SMESH : implementaion of SMESH idl descriptions
24 // File : StdMeshers_Prism_3D.hxx
27 #ifndef _SMESH_Prism_3D_HXX_
28 #define _SMESH_Prism_3D_HXX_
30 #include "SMESH_StdMeshers.hxx"
32 #include "SMESHDS_Mesh.hxx"
33 #include "SMESH_Block.hxx"
34 #include "SMESH_Mesh.hxx"
35 #include "SMESH_MesherHelper.hxx"
36 #include "SMESH_TypeDefs.hxx"
37 #include "SMESH_Comment.hxx"
38 #include "SMESH_subMesh.hxx"
40 #include <Adaptor2d_Curve2d.hxx>
41 #include <Adaptor3d_Curve.hxx>
42 #include <Adaptor3d_Surface.hxx>
43 #include <BRepAdaptor_Surface.hxx>
44 #include <TopTools_IndexedMapOfOrientedShape.hxx>
45 #include <TopoDS_Face.hxx>
46 #include <gp_Trsf.hxx>
56 namespace StdMeshers_ProjectionUtils
60 class SMESHDS_SubMesh;
63 typedef TopTools_IndexedMapOfOrientedShape TBlockShapes;
64 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
65 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
66 typedef std::map< double, TNodeColumn >::const_iterator TParam2ColumnIt;
67 // map of bottom nodes to the column of nodes above them
68 // (the column includes the bottom nodes)
69 typedef std::map< Prism_3D::TNode, TNodeColumn > TNode2ColumnMap;
74 // ===============================================
76 * \brief Structure containing node relative data
80 const SMDS_MeshNode* myNode;
81 mutable gp_XYZ myParams;
83 gp_XYZ GetCoords() const { return gp_XYZ( myNode->X(), myNode->Y(), myNode->Z() ); }
84 gp_XYZ GetParams() const { return myParams; }
85 gp_XYZ& ChangeParams() const { return myParams; }
86 bool HasParams() const { return myParams.X() >= 0.0; }
87 SMDS_TypeOfPosition GetPositionType() const
88 { return myNode ? myNode->GetPosition()->GetTypeOfPosition() : SMDS_TOP_UNSPEC; }
89 bool IsNeighbor( const TNode& other ) const;
91 TNode(const SMDS_MeshNode* node = 0): myNode(node), myParams(-1,-1,-1) {}
92 bool operator < (const TNode& other) const { return myNode->GetID() < other.myNode->GetID(); }
94 // ===============================================
96 * \brief Topological data of the prism
98 typedef std::list< TFaceQuadStructPtr > TQuadList;
102 TopoDS_Shape myShape3D;
103 TopoDS_Face myBottom;
105 std::list< TopoDS_Edge > myBottomEdges;
106 std::vector< TQuadList> myWallQuads; // wall sides can be vertically composite
107 std::vector< int > myRightQuadIndex; // index of right neighbour wall quad
108 std::list< int > myNbEdgesInWires;
113 void SetUpsideDown();
117 // ===============================================================
119 * \brief Tool analyzing and giving access to a prism geometry
120 * treating it like a block, i.e. the four side faces are
121 * emulated by division/uniting of missing/excess faces.
122 * It also manage associations between block sub-shapes and a mesh.
124 class STDMESHERS_EXPORT StdMeshers_PrismAsBlock: public SMESH_Block
128 * \brief Constructor. Initialization is needed
130 StdMeshers_PrismAsBlock();
132 ~StdMeshers_PrismAsBlock();
135 * \brief Initialization.
136 * \param helper - helper loaded with mesh and 3D shape
137 * \param prism - prism topology
138 * \retval bool - false if a mesh or a shape are KO
140 bool Init(SMESH_MesherHelper* helper, const Prism_3D::TPrismTopo& prism);
143 * \brief Return problem description
145 SMESH_ComputeErrorPtr GetError() const { return myError; }
148 * \brief Free allocated memory
153 * \brief Return number of nodes on every vertical edge
154 * \retval int - number of nodes including end nodes
156 int VerticalSize() const { return myParam2ColumnMaps[0].begin()->second.size(); }
158 bool HasNotQuadElemOnTop() const { return myNotQuadOnTop; }
161 * \brief Return pointer to column of nodes
162 * \param node - bottom node from which the returned column goes up
163 * \retval const TNodeColumn* - the found column
165 const TNodeColumn* GetNodeColumn(const SMDS_MeshNode* node) const;
168 * \brief Return TParam2ColumnMap for a base edge
169 * \param baseEdgeID - base edge SMESHDS Index
170 * \param isReverse - columns in-block orientation
171 * \retval const TParam2ColumnMap* - map
173 const TParam2ColumnMap* GetParam2ColumnMap(const int baseEdgeID,
174 bool & isReverse) const
176 std::map< int, std::pair< TParam2ColumnMap*, bool > >::const_iterator i_mo =
177 myShapeIndex2ColumnMap.find( baseEdgeID );
178 if ( i_mo == myShapeIndex2ColumnMap.end() ) return 0;
180 const std::pair< TParam2ColumnMap*, bool >& col_frw = i_mo->second;
181 isReverse = !col_frw.second;
182 return col_frw.first;
186 * \brief Return pointer to column of nodes
187 * \param node - bottom node from which the returned column goes up
188 * \retval const TNodeColumn* - the found column
190 bool HasNodeColumn(const SMDS_MeshNode* node) const
192 return myShapeIndex2ColumnMap.count( node->getshapeId() );
196 * \brief Return transformations to get coordinates of nodes of each internal layer
197 * by nodes of the bottom. Layer is a set of nodes at a certain step
198 * from bottom to top.
200 bool GetLayersTransformation(std::vector<gp_Trsf> & trsf,
201 const Prism_3D::TPrismTopo& prism) const;
204 * \brief Return pointer to mesh
205 * \retval SMESH_Mesh - mesh
207 SMESH_Mesh* Mesh() const { return myHelper->GetMesh(); }
210 * \brief Return pointer to mesh DS
211 * \retval SMESHDS_Mesh - mesh DS
213 SMESHDS_Mesh* MeshDS() const { return Mesh()->GetMeshDS(); }
216 * \brief Return submesh of a shape
217 * \param shapeID - shape given by in-block index
218 * \retval SMESH_subMesh* - found submesh
220 SMESH_subMesh* SubMesh(const int shapeID) const
221 { return Mesh()->GetSubMesh( Shape( shapeID )); }
224 * \brief Return submesh DS of a shape
225 * \param shapeID - shape given by in-block index
226 * \retval SMESHDS_SubMesh* - found submesh DS
228 SMESHDS_SubMesh* SubMeshDS(const int shapeID) const
229 { return SubMesh(shapeID)->GetSubMeshDS(); }
232 * \brief Return a in-block shape
233 * \param shapeID - shape given by in-block index
234 * \retval SMESHDS_SubMesh* - found submesh
236 const TopoDS_Shape& Shape(const int shapeID) const
237 { return myShapeIDMap( shapeID ); }
240 * \brief Return in-block ID of a shape
241 * \param shape - block sub-shape
242 * \retval int - ID or zero if the shape has no ID
244 int ShapeID(const TopoDS_Shape& shape) const
245 { return myShapeIDMap.FindIndex( shape ); }
248 * \brief Check curve orientation of a bootom edge
249 * \param meshDS - mesh DS
250 * \param columnsMap - node columns map of side face
251 * \param bottomEdge - the bootom edge
252 * \param sideFaceID - side face in-block ID
253 * \retval bool - true if orienation coinside with in-block froward orienation
255 static bool IsForwardEdge(SMESHDS_Mesh* meshDS,
256 const TParam2ColumnMap& columnsMap,
257 const TopoDS_Edge & bottomEdge,
258 const int sideFaceID);
262 // --------------------------------------------------------------------
264 * \brief Class representing a part of a geom face or
265 * a union of seleral faces. Or just an ordinary geom face
267 * It's parametrization is within [0,1] range.
268 * It redefines Adaptor3d_Surface::Value(U,V) where U and V are within [0,1]
270 // --------------------------------------------------------------------
271 class TSideFace: public Adaptor3d_Surface
273 typedef boost::shared_ptr<BRepAdaptor_Surface> PSurface;
275 int myID; //!< in-block ID
276 // map used to find out real UV by it's normalized UV
277 TParam2ColumnMap* myParamToColumnMap;
279 TopoDS_Edge myBaseEdge;
280 std::map< int, PSurface > myShapeID2Surf;
281 // first and last normalized params and orientaion for each component or it-self
282 std::vector< std::pair< double, double> > myParams; // select my columns in myParamToColumnMap
284 std::vector< TSideFace* > myComponents;
285 SMESH_MesherHelper myHelper;
287 TSideFace( SMESH_Mesh& mesh,
289 const Prism_3D::TQuadList& quadList,
290 const TopoDS_Edge& baseEdge,
291 TParam2ColumnMap* columnsMap,
292 const double first = 0.0,
293 const double last = 1.0);
294 TSideFace( SMESH_Mesh& mesh,
295 const std::vector< TSideFace* >& components,
296 const std::vector< std::pair< double, double> > & params);
297 TSideFace( const TSideFace& other );
299 bool IsComplex() const
300 { return ( NbComponents() > 0 || myParams[0].first != 0. || myParams[0].second != 1. ); }
301 int FaceID() const { return myID; }
302 SMESH_Mesh* GetMesh() const { return myHelper.GetMesh(); }
303 TParam2ColumnMap* GetColumns() const { return myParamToColumnMap; }
304 gp_XY GetNodeUV(const TopoDS_Face& F, const SMDS_MeshNode* n, const SMDS_MeshNode* n2=0) const
305 { return ((SMESH_MesherHelper&) myHelper).SetSubShape(F), myHelper.GetNodeUV( F, n, n2 ); }
306 const TopoDS_Edge & BaseEdge() const { return myBaseEdge; }
307 int ColumnHeight() const {
308 if ( NbComponents() ) return GetComponent(0)->GetColumns()->begin()->second.size();
309 else return GetColumns()->begin()->second.size(); }
310 double GetColumns(const double U, TParam2ColumnIt & col1, TParam2ColumnIt& col2 ) const;
311 void GetNodesAtZ(const int Z, std::map<double, const SMDS_MeshNode* >& nodes ) const;
312 int NbComponents() const { return myComponents.size(); }
313 TSideFace* GetComponent(const int i) const { return myComponents.at( i ); }
314 void SetComponent(const int i, TSideFace* c)
315 { if ( myComponents[i] ) delete myComponents[i]; myComponents[i]=c; }
316 TSideFace* GetComponent(const double U, double& localU) const;
317 bool IsForward() const { return myIsForward; }
318 // boundary geometry for a face
319 Adaptor3d_Surface* Surface() const { return new TSideFace( *this ); }
320 bool GetPCurves(Adaptor2d_Curve2d* pcurv[4]) const;
321 Adaptor2d_Curve2d* HorizPCurve(const bool isTop, const TopoDS_Face& horFace) const;
322 Adaptor3d_Curve* HorizCurve(const bool isTop) const;
323 Adaptor3d_Curve* VertiCurve(const bool isMax) const;
324 TopoDS_Edge GetEdge( const int edge ) const;
325 int InsertSubShapes( TBlockShapes& shapeMap ) const;
326 // redefine Adaptor methods
327 gp_Pnt Value(const Standard_Real U,const Standard_Real V) const;
329 void dumpNodes(int nbNodes) const;
332 // --------------------------------------------------------------------
334 * \brief Class emulating geometry of a vertical edge
336 // --------------------------------------------------------------------
337 class STDMESHERS_EXPORT TVerticalEdgeAdaptor: public Adaptor3d_Curve
339 const TNodeColumn* myNodeColumn;
341 TVerticalEdgeAdaptor( const TParam2ColumnMap* columnsMap, const double parameter );
342 gp_Pnt Value(const Standard_Real U) const;
343 Standard_Real FirstParameter() const { return 0; }
344 Standard_Real LastParameter() const { return 1; }
346 void dumpNodes(int nbNodes) const;
349 // --------------------------------------------------------------------
351 * \brief Class emulating geometry of a hirizontal edge
353 // --------------------------------------------------------------------
354 class STDMESHERS_EXPORT THorizontalEdgeAdaptor: public Adaptor3d_Curve
356 const TSideFace* mySide;
359 THorizontalEdgeAdaptor( const TSideFace* sideFace, const bool isTop)
360 :mySide(sideFace), myV( isTop ? 1.0 : 0.0 ) {}
361 gp_Pnt Value(const Standard_Real U) const;
362 Standard_Real FirstParameter() const { return 0; }
363 Standard_Real LastParameter() const { return 1; }
365 void dumpNodes(int nbNodes) const;
368 // --------------------------------------------------------------------
370 * \brief Class emulating pcurve on a hirizontal face
372 // --------------------------------------------------------------------
373 class STDMESHERS_EXPORT TPCurveOnHorFaceAdaptor: public Adaptor2d_Curve2d
375 std::map< double, gp_XY > myUVmap; // normalized parameter to UV on a horizontal face
377 TPCurveOnHorFaceAdaptor( const TSideFace* sideFace,
379 const TopoDS_Face& horFace);
380 gp_Pnt2d Value(const Standard_Real U) const;
381 Standard_Real FirstParameter() const { return 0; }
382 Standard_Real LastParameter() const { return 1; }
386 SMESH_MesherHelper* myHelper;
387 TBlockShapes myShapeIDMap;
388 SMESH_ComputeErrorPtr myError;
390 // container of 4 side faces
392 // node columns for each base edge
393 std::vector< TParam2ColumnMap > myParam2ColumnMaps;
394 // to find a column for a node by edge SMESHDS Index
395 std::map< int, std::pair< TParam2ColumnMap*, bool > > myShapeIndex2ColumnMap;
398 * \brief store error and comment and then return ( error == COMPERR_OK )
400 bool error(int error, const SMESH_Comment& comment = "") {
401 myError = SMESH_ComputeError::New(error,comment);
402 return myError->IsOK();
405 * \brief Prints a script creating a normal grid on the prism side
407 void faceGridToPythonDump(const SMESH_Block::TShapeID face,
410 }; // class StdMeshers_PrismAsBlock
412 // ===============================================
414 * \brief Tool building internal nodes in a prism
416 struct StdMeshers_Sweeper
418 std::vector< TNodeColumn* > myBndColumns; // boundary nodes
419 std::vector< TNodeColumn* > myIntColumns; // internal nodes
421 typedef std::vector< double > TZColumn;
422 std::vector< TZColumn > myZColumns; // Z distribution of boundary nodes
424 bool ComputeNodes( SMESH_MesherHelper& helper,
426 const bool allowHighBndError );
430 bool ComputeNodesOnStraightSameZ( SMESH_MesherHelper& helper );
432 bool ComputeNodesOnStraight( SMESH_MesherHelper& helper,
433 const TopoDS_Face& bottom,
434 const TopoDS_Face& top);
438 gp_XYZ bndPoint( int iP, int z ) const
439 { return SMESH_TNodeXYZ( (*myBndColumns[ iP ])[ z ]); }
441 gp_XYZ intPoint( int iP, int z ) const
442 { return SMESH_TNodeXYZ( (*myIntColumns[ iP ])[ z ]); }
444 static bool projectIntPoints(const std::vector< gp_XYZ >& fromBndPoints,
445 const std::vector< gp_XYZ >& toBndPoints,
446 const std::vector< gp_XYZ >& fromIntPoints,
447 std::vector< gp_XYZ >& toIntPoints,
448 StdMeshers_ProjectionUtils::TrsfFinder3D& trsf,
449 std::vector< gp_XYZ > * bndError);
451 static void applyBoundaryError(const std::vector< gp_XYZ >& bndPoints,
452 const std::vector< gp_XYZ >& bndError1,
453 const std::vector< gp_XYZ >& bndError2,
455 std::vector< gp_XYZ >& toIntPoints,
456 std::vector< double >& int2BndDist);
458 static void fillZColumn( TZColumn& zColumn,
459 TNodeColumn& nodes );
462 // ===============================================
464 * \brief Algo building prisms on a prism shape
466 class STDMESHERS_EXPORT StdMeshers_Prism_3D: public SMESH_3D_Algo
469 StdMeshers_Prism_3D(int hypId, int studyId, SMESH_Gen* gen);
470 virtual ~StdMeshers_Prism_3D();
472 virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
473 const TopoDS_Shape& aShape,
474 SMESH_Hypothesis::Hypothesis_Status& aStatus);
476 virtual bool Compute(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
478 virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape,
479 MapShapeNbElems& aResMap);
482 * \brief Enable removal of quadrangles from the bottom face and
483 * triangles creation there by projection from the top
484 * (sole face meshed with triangles is considered to be a bottom one).
485 * If there are two faces with triangles, triangles must
486 * be of the same topology, else the algo fails.
487 * The method must be called before Compute()
489 void ProjectTriangles() { myProjectTriangles = true; }
492 * \brief Create prisms
493 * \param nodeColumns - columns of nodes generated from nodes of a mesh face
494 * \param helper - helper initialized by mesh and shape to add prisms to
496 static bool AddPrisms( std::vector<const TNodeColumn*> & nodeColumns,
497 SMESH_MesherHelper* helper);
499 static bool IsApplicable(const TopoDS_Shape & aShape, bool toCheckAll);
504 * \brief Analyse shape geometry and mesh.
505 * If there are triangles on one of faces, it becomes 'bottom'
507 bool initPrism(Prism_3D::TPrismTopo& thePrism,
508 const TopoDS_Shape& theSolid,
509 const bool selectBottom = true);
512 * \brief Fill thePrism.myWallQuads and thePrism.myTopEdges
514 bool getWallFaces( Prism_3D::TPrismTopo& thePrism,
515 const int totalNbFaces);
518 * \brief Compute mesh on a SOLID
520 bool compute(const Prism_3D::TPrismTopo& thePrism);
523 * \brief Compute 2D mesh on walls FACEs of a prism
525 bool computeWalls(const Prism_3D::TPrismTopo& thePrism);
528 * \brief Returns a source EDGE of propagation to a given EDGE
530 TopoDS_Edge findPropagationSource( const TopoDS_Edge& E );
533 * \brief Find correspondence between bottom and top nodes.
534 * If elements on the bottom and top faces are topologically different,
535 * and projection is possible and allowed, perform the projection
536 * \retval bool - is a success or not
538 bool assocOrProjBottom2Top( const gp_Trsf & bottomToTopTrsf,
539 const Prism_3D::TPrismTopo& thePrism);
542 * \brief Remove quadrangles from the top face and
543 * create triangles there by projection from the bottom
544 * \retval bool - a success or not
546 bool projectBottomToTop( const gp_Trsf & bottomToTopTrsf,
547 const Prism_3D::TPrismTopo& thePrism );
550 * \brief Compute tolerance to pass to StdMeshers_Sweeper
552 double getSweepTolerance( const Prism_3D::TPrismTopo& thePrism );
555 * \brief Defines if it's safe to use the block approach
557 bool isSimpleBottom( const Prism_3D::TPrismTopo& thePrism );
560 * \brief Defines if all "vertical" EDGEs are straight
562 bool allVerticalEdgesStraight( const Prism_3D::TPrismTopo& thePrism );
565 * \brief Project mesh faces from a source FACE of one prism to
566 * a source FACE of another prism
567 * \retval bool - a success or not
569 bool project2dMesh(const TopoDS_Face& source, const TopoDS_Face& target);
572 * \brief Set projection coordinates of a node to a face and it's sub-shapes
573 * \param faceID - the face given by in-block ID
574 * \param params - node normalized parameters
575 * \retval bool - is a success
577 bool setFaceAndEdgesXYZ( const int faceID, const gp_XYZ& params, int z );
580 * \brief If (!isOK), sets the error to a sub-mesh of a current SOLID
582 bool toSM( bool isOK );
585 * \brief Return index of a shape
587 int shapeID( const TopoDS_Shape& S );
591 bool myProjectTriangles;
595 StdMeshers_PrismAsBlock myBlock;
596 SMESH_MesherHelper* myHelper;
598 std::vector<gp_XYZ> myShapeXYZ; // point on each sub-shape of the block
600 // map of bottom nodes to the column of nodes above them
601 // (the column includes the bottom node)
602 TNode2ColumnMap myBotToColumnMap;
604 TopTools_IndexedMapOfShape* myPropagChains;
606 }; // class StdMeshers_Prism_3D