1 // Copyright (C) 2007-2021 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 : implementation 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_Comment.hxx"
35 #include "SMESH_Mesh.hxx"
36 #include "SMESH_MesherHelper.hxx"
37 #include "SMESH_TypeDefs.hxx"
38 #include "SMESH_subMesh.hxx"
39 #include "StdMeshers_ProjectionUtils.hxx"
41 #include <Adaptor2d_Curve2d.hxx>
42 #include <Adaptor3d_Curve.hxx>
43 #include <Adaptor3d_Surface.hxx>
44 #include <BRepAdaptor_Surface.hxx>
45 #include <TColStd_DataMapOfIntegerInteger.hxx>
46 #include <TopTools_IndexedMapOfOrientedShape.hxx>
47 #include <TopoDS_Face.hxx>
48 #include <gp_Trsf.hxx>
58 class SMESHDS_SubMesh;
61 typedef TopTools_IndexedMapOfOrientedShape TBlockShapes;
62 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
63 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
64 typedef std::map< double, TNodeColumn >::const_iterator TParam2ColumnIt;
65 // map of bottom nodes to the column of nodes above them
66 // (the column includes the bottom nodes)
67 typedef std::map< Prism_3D::TNode, TNodeColumn > TNode2ColumnMap;
72 // ===============================================
74 * \brief Structure containing node relative data
78 const SMDS_MeshNode* myNode;
79 mutable gp_XYZ myParams;
81 gp_XYZ GetCoords() const { return gp_XYZ( myNode->X(), myNode->Y(), myNode->Z() ); }
82 gp_XYZ GetParams() const { return myParams; }
83 gp_XYZ& ChangeParams() const { return myParams; }
84 bool HasParams() const { return myParams.X() >= 0.0; }
85 SMDS_TypeOfPosition GetPositionType() const
86 { return myNode ? myNode->GetPosition()->GetTypeOfPosition() : SMDS_TOP_UNSPEC; }
87 bool IsNeighbor( const TNode& other ) const;
89 TNode(const SMDS_MeshNode* node = 0): myNode(node), myParams(-1,-1,-1) {}
90 bool operator < (const TNode& other) const { return myNode->GetID() < other.myNode->GetID(); }
92 // ===============================================
94 * \brief Topological data of the prism
96 typedef std::list< TFaceQuadStructPtr > TQuadList;
100 TopoDS_Shape myShape3D;
101 TopoDS_Face myBottom;
103 std::list< TopoDS_Edge > myBottomEdges;
104 std::vector< TQuadList> myWallQuads; // wall sides can be vertically composite
105 std::vector< int > myRightQuadIndex; // index of right neighbour wall quad
106 std::list< int > myNbEdgesInWires;
109 mutable SMESH_subMesh* myAlgoSM; // sub-mesh with algo which computed myBottom
111 size_t NbWires() const { return myNbEdgesInWires.size(); }
114 void SetUpsideDown();
118 // ===============================================================
120 * \brief Tool analyzing and giving access to a prism geometry
121 * treating it like a block, i.e. the four side faces are
122 * emulated by division/uniting of missing/excess faces.
123 * It also manage associations between block sub-shapes and a mesh.
125 class STDMESHERS_EXPORT StdMeshers_PrismAsBlock: public SMESH_Block
129 * \brief Constructor. Initialization is needed
131 StdMeshers_PrismAsBlock();
133 ~StdMeshers_PrismAsBlock();
136 * \brief Initialization.
137 * \param helper - helper loaded with mesh and 3D shape
138 * \param prism - prism topology
139 * \retval bool - false if a mesh or a shape are KO
141 bool Init(SMESH_MesherHelper* helper, const Prism_3D::TPrismTopo& prism);
144 * \brief Return problem description
146 SMESH_ComputeErrorPtr GetError() const { return myError; }
149 * \brief Free allocated memory
154 * \brief Return number of nodes on every vertical edge
155 * \retval int - number of nodes including end nodes
157 size_t VerticalSize() const { return myParam2ColumnMaps[0].begin()->second.size(); }
159 bool HasNotQuadElemOnTop() const { return myNotQuadOnTop; }
162 * \brief Return pointer to column of nodes
163 * \param node - bottom node from which the returned column goes up
164 * \retval const TNodeColumn* - the found column
166 const TNodeColumn* GetNodeColumn(const SMDS_MeshNode* node) const;
169 * \brief Return TParam2ColumnMap for a base edge
170 * \param baseEdgeID - base edge SMESHDS Index
171 * \param isReverse - columns in-block orientation
172 * \retval const TParam2ColumnMap* - map
174 const TParam2ColumnMap* GetParam2ColumnMap(const int baseEdgeID,
175 bool & isReverse) const
177 std::map< int, std::pair< TParam2ColumnMap*, bool > >::const_iterator i_mo =
178 myShapeIndex2ColumnMap.find( baseEdgeID );
179 if ( i_mo == myShapeIndex2ColumnMap.end() ) return 0;
181 const std::pair< TParam2ColumnMap*, bool >& col_frw = i_mo->second;
182 isReverse = !col_frw.second;
183 return col_frw.first;
187 * \brief Return pointer to column of nodes
188 * \param node - bottom node from which the returned column goes up
189 * \retval const TNodeColumn* - the found column
191 bool HasNodeColumn(const SMDS_MeshNode* node) const
193 return myShapeIndex2ColumnMap.count( node->getshapeId() );
197 * \brief Return transformations to get coordinates of nodes of each internal layer
198 * by nodes of the bottom. Layer is a set of nodes at a certain step
199 * from bottom to top.
201 bool GetLayersTransformation(std::vector<gp_Trsf> & trsf,
202 const Prism_3D::TPrismTopo& prism) const;
205 * \brief Return pointer to mesh
206 * \retval SMESH_Mesh - mesh
208 SMESH_Mesh* Mesh() const { return myHelper->GetMesh(); }
211 * \brief Return pointer to mesh DS
212 * \retval SMESHDS_Mesh - mesh DS
214 SMESHDS_Mesh* MeshDS() const { return Mesh()->GetMeshDS(); }
217 * \brief Return submesh of a shape
218 * \param shapeID - shape given by in-block index
219 * \retval SMESH_subMesh* - found submesh
221 SMESH_subMesh* SubMesh(const int shapeID) const
222 { return Mesh()->GetSubMesh( Shape( shapeID )); }
225 * \brief Return submesh DS of a shape
226 * \param shapeID - shape given by in-block index
227 * \retval SMESHDS_SubMesh* - found submesh DS
229 SMESHDS_SubMesh* SubMeshDS(const int shapeID) const
230 { return SubMesh(shapeID)->GetSubMeshDS(); }
233 * \brief Return a in-block shape
234 * \param shapeID - shape given by in-block index
235 * \retval SMESHDS_SubMesh* - found submesh
237 const TopoDS_Shape& Shape(const int shapeID) const
238 { return myShapeIDMap( shapeID ); }
241 * \brief Return in-block ID of a shape
242 * \param shape - block sub-shape
243 * \retval int - ID or zero if the shape has no ID
245 int ShapeID(const TopoDS_Shape& shape) const
246 { return myShapeIDMap.FindIndex( shape ); }
249 * \brief Check curve orientation of a bottom edge
250 * \param meshDS - mesh DS
251 * \param columnsMap - node columns map of side face
252 * \param bottomEdge - the bottom edge
253 * \param sideFaceID - side face in-block ID
254 * \retval bool - true if orientation coincide with in-block forward orientation
256 static bool IsForwardEdge(SMESHDS_Mesh* meshDS,
257 const TParam2ColumnMap& columnsMap,
258 const TopoDS_Edge & bottomEdge,
259 const int sideFaceID);
263 // --------------------------------------------------------------------
265 * \brief Class representing a part of a geom face or
266 * a union of seleral faces. Or just an ordinary geom face
268 * It's parametrization is within [0,1] range.
269 * It redefines Adaptor3d_Surface::Value(U,V) where U and V are within [0,1]
271 // --------------------------------------------------------------------
272 class TSideFace: public Adaptor3d_Surface
274 typedef boost::shared_ptr<BRepAdaptor_Surface> PSurface;
276 int myID; //!< in-block ID
277 // map used to find out real UV by it's normalized UV
278 TParam2ColumnMap* myParamToColumnMap;
280 TopoDS_Edge myBaseEdge;
281 std::map< int, PSurface > myShapeID2Surf;
282 // first and last normalized params and orientation for each component or it-self
283 std::vector< std::pair< double, double> > myParams; // select my columns in myParamToColumnMap
285 std::vector< TSideFace* > myComponents;
286 SMESH_MesherHelper myHelper;
288 TSideFace( SMESH_Mesh& mesh,
290 const Prism_3D::TQuadList& quadList,
291 const TopoDS_Edge& baseEdge,
292 TParam2ColumnMap* columnsMap,
293 const double first = 0.0,
294 const double last = 1.0);
295 TSideFace( SMESH_Mesh& mesh,
296 const std::vector< TSideFace* >& components,
297 const std::vector< std::pair< double, double> > & params);
298 TSideFace( const TSideFace& other );
300 bool IsComplex() const
301 { return ( NbComponents() > 0 || myParams[0].first != 0. || myParams[0].second != 1. ); }
302 int FaceID() const { return myID; }
303 SMESH_Mesh* GetMesh() const { return myHelper.GetMesh(); }
304 TParam2ColumnMap* GetColumns() const { return myParamToColumnMap; }
305 gp_XY GetNodeUV(const TopoDS_Face& F, const SMDS_MeshNode* n, const SMDS_MeshNode* n2=0) const
306 { return ((SMESH_MesherHelper&) myHelper).SetSubShape(F), myHelper.GetNodeUV( F, n, n2 ); }
307 const TopoDS_Edge & BaseEdge() const { return myBaseEdge; }
308 int ColumnHeight() const {
309 if ( NbComponents() ) return GetComponent(0)->GetColumns()->begin()->second.size();
310 else return GetColumns()->begin()->second.size(); }
311 double GetColumns(const double U, TParam2ColumnIt & col1, TParam2ColumnIt& col2 ) const;
312 void GetNodesAtZ(const int Z, std::map<double, const SMDS_MeshNode* >& nodes ) const;
313 int NbComponents() const { return myComponents.size(); }
314 TSideFace* GetComponent(const int i) const { return myComponents.at( i ); }
315 void SetComponent(const int i, TSideFace* c)
316 { if ( myComponents[i] ) delete myComponents[i]; myComponents[i]=c; }
317 TSideFace* GetComponent(const double U, double& localU) const;
318 bool IsForward() const { return myIsForward; }
319 // boundary geometry for a face
320 Adaptor3d_Surface* Surface() const { return new TSideFace( *this ); }
321 bool GetPCurves(Adaptor2d_Curve2d* pcurv[4]) const;
322 Adaptor2d_Curve2d* HorizPCurve(const bool isTop, const TopoDS_Face& horFace) const;
323 Adaptor3d_Curve* HorizCurve(const bool isTop) const;
324 Adaptor3d_Curve* VertiCurve(const bool isMax) const;
325 TopoDS_Edge GetEdge( const int edge ) const;
326 int InsertSubShapes( TBlockShapes& shapeMap ) const;
327 // redefine Adaptor methods
328 gp_Pnt Value(const Standard_Real U,const Standard_Real V) const;
330 void dumpNodes(int nbNodes) const;
333 // --------------------------------------------------------------------
335 * \brief Class emulating geometry of a vertical edge
337 // --------------------------------------------------------------------
338 class STDMESHERS_EXPORT TVerticalEdgeAdaptor: public Adaptor3d_Curve
340 const TNodeColumn* myNodeColumn;
342 TVerticalEdgeAdaptor( const TParam2ColumnMap* columnsMap, const double parameter );
343 gp_Pnt Value(const Standard_Real U) const;
344 Standard_Real FirstParameter() const { return 0; }
345 Standard_Real LastParameter() const { return 1; }
347 void dumpNodes(int nbNodes) const;
350 // --------------------------------------------------------------------
352 * \brief Class emulating geometry of a hirizontal edge
354 // --------------------------------------------------------------------
355 class STDMESHERS_EXPORT THorizontalEdgeAdaptor: public Adaptor3d_Curve
357 const TSideFace* mySide;
360 THorizontalEdgeAdaptor( const TSideFace* sideFace, const bool isTop)
361 :mySide(sideFace), myV( isTop ? 1.0 : 0.0 ) {}
362 gp_Pnt Value(const Standard_Real U) const;
363 Standard_Real FirstParameter() const { return 0; }
364 Standard_Real LastParameter() const { return 1; }
366 void dumpNodes(int nbNodes) const;
369 // --------------------------------------------------------------------
371 * \brief Class emulating pcurve on a hirizontal face
373 // --------------------------------------------------------------------
374 class STDMESHERS_EXPORT TPCurveOnHorFaceAdaptor: public Adaptor2d_Curve2d
376 std::map< double, gp_XY > myUVmap; // normalized parameter to UV on a horizontal face
378 TPCurveOnHorFaceAdaptor( const TSideFace* sideFace,
380 const TopoDS_Face& horFace);
381 gp_Pnt2d Value(const Standard_Real U) const;
382 Standard_Real FirstParameter() const { return 0; }
383 Standard_Real LastParameter() const { return 1; }
387 SMESH_MesherHelper* myHelper;
388 TBlockShapes myShapeIDMap;
389 SMESH_ComputeErrorPtr myError;
391 // container of 4 side faces
393 // node columns for each base edge
394 std::vector< TParam2ColumnMap > myParam2ColumnMaps;
395 // to find a column for a node by edge SMESHDS Index
396 std::map< int, std::pair< TParam2ColumnMap*, bool > > myShapeIndex2ColumnMap;
399 * \brief store error and comment and then return ( error == COMPERR_OK )
401 bool error(int error, const SMESH_Comment& comment = "") {
402 myError = SMESH_ComputeError::New(error,comment);
403 return myError->IsOK();
406 * \brief Prints a script creating a normal grid on the prism side
408 void faceGridToPythonDump(const SMESH_Block::TShapeID face,
411 }; // class StdMeshers_PrismAsBlock
413 // ===============================================
415 * \brief Tool building internal nodes in a prism
417 struct StdMeshers_Sweeper
420 SMESH_MesherHelper* myHelper;
421 TopoDS_Face myBotFace;
422 TopoDS_Face myTopFace;
423 std::vector< TNodeColumn* > myBndColumns; // boundary nodes
425 std::vector< TNodeColumn* > myIntColumns; // internal nodes
427 bool ComputeNodesByTrsf( const double tol,
428 const bool allowHighBndError );
432 bool ComputeNodesOnStraightSameZ();
434 bool ComputeNodesOnStraight();
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 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,
449 StdMeshers_ProjectionUtils::TrsfFinder3D& trsf,
450 std::vector< gp_XYZ > * bndError);
452 typedef std::vector< double > TZColumn;
453 static void fillZColumn( TZColumn& zColumn,
454 TNodeColumn& nodes );
456 void prepareTopBotDelaunay();
457 bool findDelaunayTriangles();
459 std::vector< TZColumn > myZColumns; // Z distribution of boundary nodes
461 StdMeshers_ProjectionUtils::DelaunayPtr myTopDelaunay;
462 StdMeshers_ProjectionUtils::DelaunayPtr myBotDelaunay;
463 TColStd_DataMapOfIntegerInteger myNodeID2ColID;
465 // top and bottom Delaulay triangles including an internal column
466 struct TopBotTriangles
468 double myBotBC[3], myTopBC[3]; // barycentric coordinates of a node within a triangle
469 int myBotTriaNodes[3], myTopTriaNodes[3]; // indices of boundary columns
471 void SetTopByBottom();
473 std::vector< TopBotTriangles> myTopBotTriangles;
476 // ===============================================
478 * \brief Algo building prisms on a prism shape
480 class STDMESHERS_EXPORT StdMeshers_Prism_3D: public SMESH_3D_Algo
483 StdMeshers_Prism_3D(int hypId, SMESH_Gen* gen);
484 virtual ~StdMeshers_Prism_3D();
486 virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
487 const TopoDS_Shape& aShape,
488 SMESH_Hypothesis::Hypothesis_Status& aStatus);
490 virtual bool Compute(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
492 virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape,
493 MapShapeNbElems& aResMap);
496 * \brief Enable removal of quadrangles from the bottom face and
497 * triangles creation there by projection from the top
498 * (sole face meshed with triangles is considered to be a bottom one).
499 * If there are two faces with triangles, triangles must
500 * be of the same topology, else the algo fails.
501 * The method must be called before Compute()
503 void ProjectTriangles() { myProjectTriangles = true; }
506 * \brief Create prisms
507 * \param nodeColumns - columns of nodes generated from nodes of a mesh face
508 * \param helper - helper initialized by mesh and shape to add prisms to
510 static bool AddPrisms( std::vector<const TNodeColumn*> & nodeColumns,
511 SMESH_MesherHelper* helper);
513 static bool IsApplicable(const TopoDS_Shape & aShape, bool toCheckAll);
514 virtual bool IsApplicableToShape(const TopoDS_Shape & shape, bool toCheckAll) const
516 return IsApplicable( shape, toCheckAll );
522 * \brief Analyse shape geometry and mesh.
523 * If there are triangles on one of faces, it becomes 'bottom'
525 bool initPrism(Prism_3D::TPrismTopo& thePrism,
526 const TopoDS_Shape& theSolid,
527 const bool selectBottom = true);
530 * \brief Fill thePrism.myWallQuads and thePrism.myTopEdges
532 bool getWallFaces( Prism_3D::TPrismTopo& thePrism,
533 const int totalNbFaces);
536 * \brief Compute mesh on a SOLID
538 bool compute(const Prism_3D::TPrismTopo& thePrism);
541 * \brief Compute the base face of a prism
543 bool computeBase(const Prism_3D::TPrismTopo& thePrism);
546 * \brief Compute 2D mesh on walls FACEs of a prism
548 bool computeWalls(const Prism_3D::TPrismTopo& thePrism);
551 * \brief Create artificial wall quads for vertical projection between the outer and inner walls
553 void makeQuadsForOutInProjection( const Prism_3D::TPrismTopo& thePrism,
554 std::multimap< int, int >& wgt2quad,
555 std::map< int, FaceQuadStruct >& iW2oiQuads);
557 * \brief Returns a source EDGE of propagation to a given EDGE
559 TopoDS_Edge findPropagationSource( const TopoDS_Edge& E );
562 * \brief Find correspondence between bottom and top nodes.
563 * If elements on the bottom and top faces are topologically different,
564 * and projection is possible and allowed, perform the projection
565 * \retval bool - is a success or not
567 bool assocOrProjBottom2Top( const gp_Trsf & bottomToTopTrsf,
568 const Prism_3D::TPrismTopo& thePrism);
571 * \brief Remove quadrangles from the top face and
572 * create triangles there by projection from the bottom
573 * \retval bool - a success or not
575 bool projectBottomToTop( const gp_Trsf & bottomToTopTrsf,
576 const Prism_3D::TPrismTopo& thePrism );
579 * \brief Compute tolerance to pass to StdMeshers_Sweeper
581 double getSweepTolerance( const Prism_3D::TPrismTopo& thePrism );
584 * \brief Defines if it's safe to use the block approach
586 bool isSimpleBottom( const Prism_3D::TPrismTopo& thePrism );
589 * \brief Defines if all "vertical" EDGEs are straight
591 bool allVerticalEdgesStraight( const Prism_3D::TPrismTopo& thePrism );
594 * \brief Project mesh faces from a source FACE of one prism to
595 * a source FACE of another prism
596 * \retval bool - a success or not
598 bool project2dMesh(const TopoDS_Face& source, const TopoDS_Face& target);
601 * \brief Set projection coordinates of a node to a face and it's sub-shapes
602 * \param faceID - the face given by in-block ID
603 * \param params - node normalized parameters
604 * \retval bool - is a success
606 bool setFaceAndEdgesXYZ( const int faceID, const gp_XYZ& params, int z );
609 * \brief If (!isOK), sets the error to a sub-mesh of a current SOLID
611 bool toSM( bool isOK );
614 * \brief Return index of a shape
616 int shapeID( const TopoDS_Shape& S );
620 bool myProjectTriangles;
624 StdMeshers_PrismAsBlock myBlock;
625 SMESH_MesherHelper* myHelper;
626 SMESH_subMesh* myPrevBottomSM;
628 std::vector<gp_XYZ> myShapeXYZ; // point on each sub-shape of the block
630 // map of bottom nodes to the column of nodes above them
631 // (the column includes the bottom node)
632 TNode2ColumnMap myBotToColumnMap;
634 TopTools_IndexedMapOfShape* myPropagChains;
636 }; // class StdMeshers_Prism_3D