1 // Copyright (C) 2007-2012 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
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 "SMDS_MeshNode.hxx"
33 #include "SMDS_TypeOfPosition.hxx"
34 #include "SMESHDS_Mesh.hxx"
35 #include "SMESH_Algo.hxx"
36 #include "SMESH_Block.hxx"
37 #include "SMESH_Comment.hxx"
38 #include "SMESH_Mesh.hxx"
39 #include "SMESH_MesherHelper.hxx"
40 #include "SMESH_TypeDefs.hxx"
41 #include "SMESH_subMesh.hxx"
43 #include <Adaptor2d_Curve2d.hxx>
44 #include <Adaptor3d_Curve.hxx>
45 #include <Adaptor3d_Surface.hxx>
46 #include <BRepAdaptor_Surface.hxx>
47 #include <TopTools_IndexedMapOfOrientedShape.hxx>
48 #include <TopoDS_Face.hxx>
49 #include <gp_Trsf.hxx>
59 class SMESHDS_SubMesh;
62 typedef TopTools_IndexedMapOfOrientedShape TBlockShapes;
63 typedef std::vector<const SMDS_MeshNode* > TNodeColumn;
64 typedef std::map< double, TNodeColumn > TParam2ColumnMap;
65 typedef std::map< double, TNodeColumn >::const_iterator TParam2ColumnIt;
66 // map of bottom nodes to the column of nodes above them
67 // (the column includes the bottom nodes)
68 typedef std::map< Prism_3D::TNode, TNodeColumn > TNode2ColumnMap;
73 // ===============================================
75 * \brief Structure containing node relative data
79 const SMDS_MeshNode* myNode;
80 mutable gp_XYZ myParams;
82 gp_XYZ GetCoords() const { return gp_XYZ( myNode->X(), myNode->Y(), myNode->Z() ); }
83 gp_XYZ GetParams() const { return myParams; }
84 gp_XYZ& ChangeParams() const { return myParams; }
85 bool HasParams() const { return myParams.X() >= 0.0; }
86 SMDS_TypeOfPosition GetPositionType() const
87 { return myNode ? myNode->GetPosition()->GetTypeOfPosition() : SMDS_TOP_UNSPEC; }
88 bool IsNeighbor( const TNode& other ) const;
90 TNode(const SMDS_MeshNode* node = 0): myNode(node), myParams(-1,-1,-1) {}
91 bool operator < (const TNode& other) const { return myNode->GetID() < other.myNode->GetID(); }
93 // ===============================================
95 * \brief Topological data of the prism
97 typedef std::list< TFaceQuadStructPtr > TQuadList;
101 TopoDS_Shape myShape3D;
102 TopoDS_Face myBottom;
104 std::list< TopoDS_Edge > myBottomEdges;
105 std::vector< TQuadList> myWallQuads; // wall sides can be vertically composite
106 std::vector< int > myRightQuadIndex; // index of right neighbour wall quad
107 std::list< int > myNbEdgesInWires;
115 // ===============================================================
117 * \brief Tool analyzing and giving access to a prism geometry
118 * treating it like a block, i.e. the four side faces are
119 * emulated by division/uniting of missing/excess faces.
120 * It also manage associations between block sub-shapes and a mesh.
122 class STDMESHERS_EXPORT StdMeshers_PrismAsBlock: public SMESH_Block
126 * \brief Constructor. Initialization is needed
128 StdMeshers_PrismAsBlock();
130 ~StdMeshers_PrismAsBlock();
133 * \brief Initialization.
134 * \param helper - helper loaded with mesh and 3D shape
135 * \param prism - prism topology
136 * \retval bool - false if a mesh or a shape are KO
138 bool Init(SMESH_MesherHelper* helper, const Prism_3D::TPrismTopo& prism);
141 * \brief Return problem description
143 SMESH_ComputeErrorPtr GetError() const { return myError; }
146 * \brief Free allocated memory
151 * \brief Return number of nodes on every vertical edge
152 * \retval int - number of nodes including end nodes
154 int VerticalSize() const { return myParam2ColumnMaps[0].begin()->second.size(); }
156 bool HasNotQuadElemOnTop() const { return myNotQuadOnTop; }
159 * \brief Return pointer to column of nodes
160 * \param node - bottom node from which the returned column goes up
161 * \retval const TNodeColumn* - the found column
163 const TNodeColumn* GetNodeColumn(const SMDS_MeshNode* node) const;
166 * \brief Return TParam2ColumnMap for a base edge
167 * \param baseEdgeID - base edge SMESHDS Index
168 * \param isReverse - columns in-block orientation
169 * \retval const TParam2ColumnMap* - map
171 const TParam2ColumnMap* GetParam2ColumnMap(const int baseEdgeID,
172 bool & isReverse) const
174 std::map< int, std::pair< TParam2ColumnMap*, bool > >::const_iterator i_mo =
175 myShapeIndex2ColumnMap.find( baseEdgeID );
176 if ( i_mo == myShapeIndex2ColumnMap.end() ) return 0;
178 const std::pair< TParam2ColumnMap*, bool >& col_frw = i_mo->second;
179 isReverse = !col_frw.second;
180 return col_frw.first;
184 * \brief Return transformations to get coordinates of nodes of each internal layer
185 * by nodes of the bottom. Layer is a set of nodes at a certain step
186 * from bottom to top.
188 bool GetLayersTransformation(std::vector<gp_Trsf> & trsf) const;
191 * \brief Return pointer to mesh
192 * \retval SMESH_Mesh - mesh
194 SMESH_Mesh* Mesh() const { return myHelper->GetMesh(); }
197 * \brief Return pointer to mesh DS
198 * \retval SMESHDS_Mesh - mesh DS
200 SMESHDS_Mesh* MeshDS() const { return Mesh()->GetMeshDS(); }
203 * \brief Return submesh of a shape
204 * \param shapeID - shape given by in-block index
205 * \retval SMESH_subMesh* - found submesh
207 SMESH_subMesh* SubMesh(const int shapeID) const
208 { return Mesh()->GetSubMesh( Shape( shapeID )); }
211 * \brief Return submesh DS of a shape
212 * \param shapeID - shape given by in-block index
213 * \retval SMESHDS_SubMesh* - found submesh DS
215 SMESHDS_SubMesh* SubMeshDS(const int shapeID) const
216 { return SubMesh(shapeID)->GetSubMeshDS(); }
219 * \brief Return a in-block shape
220 * \param shapeID - shape given by in-block index
221 * \retval SMESHDS_SubMesh* - found submesh
223 const TopoDS_Shape& Shape(const int shapeID) const
224 { return myShapeIDMap( shapeID ); }
227 * \brief Return in-block ID of a shape
228 * \param shape - block sub-shape
229 * \retval int - ID or zero if the shape has no ID
231 int ShapeID(const TopoDS_Shape& shape) const
232 { return myShapeIDMap.FindIndex( shape ); }
235 * \brief Check curve orientation of a bootom edge
236 * \param meshDS - mesh DS
237 * \param columnsMap - node columns map of side face
238 * \param bottomEdge - the bootom edge
239 * \param sideFaceID - side face in-block ID
240 * \retval bool - true if orienation coinside with in-block froward orienation
242 static bool IsForwardEdge(SMESHDS_Mesh* meshDS,
243 const TParam2ColumnMap& columnsMap,
244 const TopoDS_Edge & bottomEdge,
245 const int sideFaceID);
249 // --------------------------------------------------------------------
251 * \brief Class representing a part of a geom face or
252 * a union of seleral faces. Or just an ordinary geom face
254 * It's parametrization is within [0,1] range.
255 * It redefines Adaptor3d_Surface::Value(U,V) where U and V are within [0,1]
257 // --------------------------------------------------------------------
258 class TSideFace: public Adaptor3d_Surface
260 typedef boost::shared_ptr<BRepAdaptor_Surface> PSurface;
262 int myID; //!< in-block ID
263 // map used to find out real UV by it's normalized UV
264 TParam2ColumnMap* myParamToColumnMap;
266 TopoDS_Edge myBaseEdge;
267 map< int, PSurface > myShapeID2Surf;
268 // first and last normalized params and orientaion for each component or it-self
269 std::vector< std::pair< double, double> > myParams;
271 std::vector< TSideFace* > myComponents;
272 SMESH_MesherHelper * myHelper;
274 TSideFace( SMESH_MesherHelper* helper,
276 const Prism_3D::TQuadList& quadList,
277 const TopoDS_Edge& baseEdge,
278 TParam2ColumnMap* columnsMap,
279 const double first = 0.0,
280 const double last = 1.0);
281 TSideFace( const std::vector< TSideFace* >& components,
282 const std::vector< std::pair< double, double> > & params);
283 TSideFace( const TSideFace& other );
285 bool IsComplex() const
286 { return ( NbComponents() > 0 || myParams[0].first != 0. || myParams[0].second != 1. ); }
287 int FaceID() const { return myID; }
288 TParam2ColumnMap* GetColumns() const { return myParamToColumnMap; }
289 gp_XY GetNodeUV(const TopoDS_Face& F, const SMDS_MeshNode* n) const
290 { return myHelper->GetNodeUV( F, n ); }
291 const TopoDS_Edge & BaseEdge() const { return myBaseEdge; }
292 int ColumnHeight() const {
293 if ( NbComponents() ) return GetComponent(0)->GetColumns()->begin()->second.size();
294 else return GetColumns()->begin()->second.size(); }
295 double GetColumns(const double U, TParam2ColumnIt & col1, TParam2ColumnIt& col2 ) const;
296 int NbComponents() const { return myComponents.size(); }
297 TSideFace* GetComponent(const int i) const { return myComponents.at( i ); }
298 void SetComponent(const int i, TSideFace* c)
299 { if ( myComponents[i] ) delete myComponents[i]; myComponents[i]=c; }
300 TSideFace* GetComponent(const double U, double& localU) const;
301 bool IsForward() const { return myIsForward; }
302 // boundary geometry for a face
303 Adaptor3d_Surface* Surface() const { return new TSideFace( *this ); }
304 bool GetPCurves(Adaptor2d_Curve2d* pcurv[4]) const;
305 Adaptor2d_Curve2d* HorizPCurve(const bool isTop, const TopoDS_Face& horFace) const;
306 Adaptor3d_Curve* HorizCurve(const bool isTop) const;
307 Adaptor3d_Curve* VertiCurve(const bool isMax) const;
308 TopoDS_Edge GetEdge( const int edge ) const;
309 int InsertSubShapes( TBlockShapes& shapeMap ) const;
310 // redefine Adaptor methods
311 gp_Pnt Value(const Standard_Real U,const Standard_Real V) const;
313 void dumpNodes(int nbNodes) const;
316 // --------------------------------------------------------------------
318 * \brief Class emulating geometry of a vertical edge
320 // --------------------------------------------------------------------
321 class STDMESHERS_EXPORT TVerticalEdgeAdaptor: public Adaptor3d_Curve
323 const TNodeColumn* myNodeColumn;
325 TVerticalEdgeAdaptor( const TParam2ColumnMap* columnsMap, const double parameter );
326 gp_Pnt Value(const Standard_Real U) const;
327 Standard_Real FirstParameter() const { return 0; }
328 Standard_Real LastParameter() const { return 1; }
330 void dumpNodes(int nbNodes) const;
333 // --------------------------------------------------------------------
335 * \brief Class emulating geometry of a hirizontal edge
337 // --------------------------------------------------------------------
338 class STDMESHERS_EXPORT THorizontalEdgeAdaptor: public Adaptor3d_Curve
340 const TSideFace* mySide;
343 THorizontalEdgeAdaptor( const TSideFace* sideFace, const bool isTop)
344 :mySide(sideFace), myV( isTop ? 1.0 : 0.0 ) {}
345 gp_Pnt Value(const Standard_Real U) const;
346 Standard_Real FirstParameter() const { return 0; }
347 Standard_Real LastParameter() const { return 1; }
349 void dumpNodes(int nbNodes) const;
352 // --------------------------------------------------------------------
354 * \brief Class emulating pcurve on a hirizontal face
356 // --------------------------------------------------------------------
357 class STDMESHERS_EXPORT TPCurveOnHorFaceAdaptor: public Adaptor2d_Curve2d
359 const TSideFace* mySide;
363 TPCurveOnHorFaceAdaptor( const TSideFace* sideFace,
365 const TopoDS_Face& horFace)
366 : mySide(sideFace), myFace(horFace), myZ(isTop ? mySide->ColumnHeight() - 1 : 0 ) {}
367 gp_Pnt2d Value(const Standard_Real U) const;
368 Standard_Real FirstParameter() const { return 0; }
369 Standard_Real LastParameter() const { return 1; }
373 SMESH_MesherHelper* myHelper;
374 TBlockShapes myShapeIDMap;
375 SMESH_ComputeErrorPtr myError;
377 // container of 4 side faces
379 // node columns for each base edge
380 std::vector< TParam2ColumnMap > myParam2ColumnMaps;
381 // to find a column for a node by edge SMESHDS Index
382 std::map< int, std::pair< TParam2ColumnMap*, bool > > myShapeIndex2ColumnMap;
385 * \brief store error and comment and then return ( error == COMPERR_OK )
387 bool error(int error, const SMESH_Comment& comment = "") {
388 myError = SMESH_ComputeError::New(error,comment);
389 return myError->IsOK();
391 }; // class StdMeshers_PrismAsBlock
393 // =============================================
395 * \brief Algo building prisms on a prism shape
397 class STDMESHERS_EXPORT StdMeshers_Prism_3D: public SMESH_3D_Algo
400 StdMeshers_Prism_3D(int hypId, int studyId, SMESH_Gen* gen);
401 virtual ~StdMeshers_Prism_3D();
403 virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
404 const TopoDS_Shape& aShape,
405 SMESH_Hypothesis::Hypothesis_Status& aStatus);
407 virtual bool Compute(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
409 virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape,
410 MapShapeNbElems& aResMap);
413 * \brief Enable removal of quadrangles from the bottom face and
414 * triangles creation there by projection from the top
415 * (sole face meshed with triangles is considered to be a bottom one).
416 * If there are two faces with triangles, triangles must
417 * be of the same topology, else the algo fails.
418 * The method must be called before Compute()
420 void ProjectTriangles() { myProjectTriangles = true; }
423 * \brief Create prisms
424 * \param nodeColumns - columns of nodes generated from nodes of a mesh face
425 * \param helper - helper initialized by mesh and shape to add prisms to
427 static void AddPrisms( std::vector<const TNodeColumn*> & nodeColumns,
428 SMESH_MesherHelper* helper);
433 * \brief Analyse shape geometry and mesh.
434 * If there are triangles on one of faces, it becomes 'bottom'
436 bool initPrism(Prism_3D::TPrismTopo& thePrism, const TopoDS_Shape& theSolid);
439 * \brief Fill thePrism.myWallQuads and thePrism.myTopEdges
441 bool getWallFaces( Prism_3D::TPrismTopo& thePrism,
442 const int totalNbFaces);
445 * \brief Compute mesh on a SOLID
447 bool compute(const Prism_3D::TPrismTopo& thePrism);
450 * \brief Compute 2D mesh on walls FACEs of a prism
452 bool computeWalls(const Prism_3D::TPrismTopo& thePrism);
455 * \brief Find correspondence between bottom and top nodes.
456 * If elements on the bottom and top faces are topologically different,
457 * and projection is possible and allowed, perform the projection
458 * \retval bool - is a success or not
460 bool assocOrProjBottom2Top();
463 * \brief Remove quadrangles from the top face and
464 * create triangles there by projection from the bottom
465 * \retval bool - a success or not
467 bool projectBottomToTop();
470 * \brief Project mesh faces from a source FACE of one prism to
471 * a source FACE of another prism
472 * \retval bool - a success or not
474 bool project2dMesh(const TopoDS_Face& source, const TopoDS_Face& target);
477 * \brief Set projection coordinates of a node to a face and it's sub-shapes
478 * \param faceID - the face given by in-block ID
479 * \param params - node normalized parameters
480 * \retval bool - is a success
482 bool setFaceAndEdgesXYZ( const int faceID, const gp_XYZ& params, int z );
485 * \brief If (!isOK), sets the error to a sub-mesh of a current SOLID
487 bool toSM( bool isOK );
490 * \brief Return index of a shape
492 int shapeID( const TopoDS_Shape& S );
496 bool myProjectTriangles;
499 StdMeshers_PrismAsBlock myBlock;
500 SMESH_MesherHelper* myHelper;
502 std::vector<gp_XYZ> myShapeXYZ; // point on each sub-shape of the block
504 // map of bottom nodes to the column of nodes above them
505 // (the column includes the bottom node)
506 TNode2ColumnMap myBotToColumnMap;
508 }; // class StdMeshers_Prism_3D