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 : implementation of SMESH idl descriptions
24 // File : SMESH_Algo.hxx
25 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_ALGO_HXX_
29 #define _SMESH_ALGO_HXX_
31 #include "SMESH_SMESH.hxx"
33 #include "SMDSAbs_ElementType.hxx"
34 #include "SMESH_Comment.hxx"
35 #include "SMESH_ComputeError.hxx"
36 #include "SMESH_Hypothesis.hxx"
38 #include <GeomAbs_Shape.hxx>
48 class SMESHDS_SubMesh;
50 class SMESH_HypoFilter;
52 class SMESH_MesherHelper;
53 class SMESH_ProxyMesh;
62 typedef std::map< SMESH_subMesh*, std::vector<int> > MapShapeNbElems;
63 typedef std::map< SMESH_subMesh*, std::vector<int> >::iterator MapShapeNbElemsItr;
65 // ==================================================================================
67 * \brief Root of all algorithms
69 * Methods of the class are grouped into several parts:
70 * - main lifecycle methods, like Compute()
71 * - methods describing features of the algorithm, like NeedShape()
72 * - methods related to dependencies between sub-meshes imposed by the algorithm
73 * - static utilities, like EdgeLength()
75 // ==================================================================================
77 class SMESH_EXPORT SMESH_Algo : public SMESH_Hypothesis
80 //==================================================================================
82 * \brief Structure describing algorithm features
84 // --------------------------------------------------------------------------------
88 std::set<SMDSAbs_GeometryType> _inElemTypes; // acceptable types of input mesh element
89 std::set<SMDSAbs_GeometryType> _outElemTypes; // produced types of mesh elements
90 std::string _label; // GUI type name
92 bool IsCompatible( const Features& algo2 ) const;
95 * \brief Returns a structure describing algorithm features
97 static const Features& GetFeatures( const std::string& algoType );
98 const Features& GetFeatures() const { return GetFeatures( _name ); }
101 //==================================================================================
103 * \brief Creates algorithm
104 * \param hypId - algorithm ID
105 * \param studyId - study ID
106 * \param gen - SMESH_Gen
108 SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
113 virtual ~ SMESH_Algo();
116 * \brief Saves nothing in a stream
117 * \param save - the stream
118 * \retval std::ostream & - the stream
120 virtual std::ostream & SaveTo(std::ostream & save);
123 * \brief Loads nothing from a stream
124 * \param load - the stream
125 * \retval std::ostream & - the stream
127 virtual std::istream & LoadFrom(std::istream & load);
130 * \brief Returns all types of compatible hypotheses
132 const std::vector < std::string > & GetCompatibleHypothesis();
135 * \brief Check hypothesis definition to mesh a shape
136 * \param aMesh - the mesh
137 * \param aShape - the shape
138 * \param aStatus - check result
139 * \retval bool - true if hypothesis is well defined
141 * Textual description of a problem can be stored in _comment field.
143 virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
144 const TopoDS_Shape& aShape,
145 SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
147 * \brief Computes mesh on a shape
148 * \param aMesh - the mesh
149 * \param aShape - the shape
150 * \retval bool - is a success
152 * Algorithms that !NeedDiscreteBoundary() || !OnlyUnaryInput() are
153 * to set SMESH_ComputeError returned by SMESH_submesh::GetComputeError()
154 * to report problematic sub-shapes
156 virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
159 * \brief Computes mesh without geometry
160 * \param aMesh - the mesh
161 * \param aHelper - helper that must be used for adding elements to \aaMesh
162 * \retval bool - is a success
164 * The method is called if ( !aMesh->HasShapeToMesh() )
166 virtual bool Compute(SMESH_Mesh & aMesh, SMESH_MesherHelper* aHelper);
169 * \brief Return true if the algorithm can mesh a given shape
170 * \param [in] aShape - shape to check
171 * \param [in] toCheckAll - if true, this check returns OK if all shapes are OK,
172 * else, returns OK if at least one shape is OK
173 * \retval bool - \c true by default
175 virtual bool IsApplicableToShape(const TopoDS_Shape & shape, bool toCheckAll) const;
178 * \brief Sets _computeCanceled to true. It's usage depends on
179 * implementation of a particular mesher.
181 virtual void CancelCompute();
184 * \brief If possible, returns progress of computation [0.,1.]
186 virtual double GetProgress() const;
189 * \brief evaluates size of prospective mesh on a shape
190 * \param aMesh - the mesh
191 * \param aShape - the shape
192 * \param aResMap - prospective number of elements by SMDSAbs_ElementType by a sub-mesh
193 * \retval bool - is a success
195 virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape,
196 MapShapeNbElems& aResMap) = 0;
199 * \brief Returns a list of compatible hypotheses used to mesh a shape
200 * \param aMesh - the mesh
201 * \param aShape - the shape
202 * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list
203 * \retval const std::list <const SMESHDS_Hypothesis*> - hypotheses list
205 * List the hypothesis used by the algorithm associated to the shape.
206 * Hypothesis associated to father shape -are- taken into account (see
207 * GetAppliedHypothesis). Relevant hypothesis have a name (type) listed in
208 * the algorithm. This method could be surcharged by specific algorithms, in
209 * case of several hypothesis simultaneously applicable.
211 virtual const std::list <const SMESHDS_Hypothesis *> &
212 GetUsedHypothesis(SMESH_Mesh & aMesh,
213 const TopoDS_Shape & aShape,
214 const bool ignoreAuxiliary=true) const;
216 * \brief Returns a list of compatible hypotheses assigned to a shape in a mesh
217 * \param aMesh - the mesh
218 * \param aShape - the shape
219 * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list
220 * \retval const std::list <const SMESHDS_Hypothesis*> - hypotheses list
222 * List the relevant hypothesis associated to the shape. Relevant hypothesis
223 * have a name (type) listed in the algorithm. Hypothesis associated to
224 * father shape -are not- taken into account (see GetUsedHypothesis)
226 const std::list <const SMESHDS_Hypothesis *> &
227 GetAppliedHypothesis(SMESH_Mesh & aMesh,
228 const TopoDS_Shape & aShape,
229 const bool ignoreAuxiliary=true) const;
231 * \brief Returns the filter recognizing only compatible hypotheses
232 * \param ignoreAuxiliary - make filter ignore compatible auxiliary hypotheses
233 * \retval SMESH_HypoFilter* - the filter that can be NULL
235 const SMESH_HypoFilter* GetCompatibleHypoFilter(const bool ignoreAuxiliary) const;
238 * \brief Just return false as the algorithm does not hold parameters values
240 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
241 virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);
244 * \brief return compute error
246 SMESH_ComputeErrorPtr GetComputeError() const;
248 * \brief initialize compute error etc. before call of Compute()
250 void InitComputeError();
252 * \brief Return compute progress by nb of calls of this method
254 double GetProgressByTic() const;
256 * Return a vector of sub-meshes to Compute()
258 std::vector<SMESH_subMesh*>& SubMeshesToCompute() { return _smToCompute; }
261 // ==================================================================
262 // Algo features influencing how Compute() is called:
263 // in what turn and with what input shape
264 // ==================================================================
266 // SMESH_Hypothesis::GetDim();
267 // 1 - dimension of target mesh
269 bool OnlyUnaryInput() const { return _onlyUnaryInput; }
270 // 2 - is collection of tesselatable shapes inacceptable as input;
271 // "collection" means a shape containing shapes of dim equal
273 // Algo which can process a collection shape should expect
274 // an input temporary shape that is neither MainShape nor
277 bool NeedDiscreteBoundary() const { return _requireDiscreteBoundary; }
278 // 3 - is a Dim-1 mesh prerequisite
280 bool NeedShape() const { return _requireShape; }
281 // 4 - is shape existence required
283 bool SupportSubmeshes() const { return _supportSubmeshes; }
284 // 5 - whether supports submeshes if !NeedDiscreteBoundary()
286 bool NeedLowerHyps(int dim) const { return _neededLowerHyps[ dim ]; }
287 // 6 - if algo !NeedDiscreteBoundary() but requires presence of
288 // hypotheses of dimension <dim> to generate all-dimensional mesh.
289 // This info is used not to issue warnings on hiding of lower global algos.
292 // ==================================================================
293 // Methods to track non hierarchical dependencies between submeshes
294 // ==================================================================
297 * \brief Sets event listener to submeshes if necessary
298 * \param subMesh - submesh where algo is set
300 * This method is called when a submesh gets HYP_OK algo_state.
301 * After being set, event listener is notified on each event of a submesh.
302 * By default none listener is set
304 virtual void SetEventListener(SMESH_subMesh* subMesh);
307 * \brief Allow algo to do something after persistent restoration
308 * \param subMesh - restored submesh
310 * This method is called only if a submesh has HYP_OK algo_state.
312 virtual void SubmeshRestored(SMESH_subMesh* subMesh);
315 // ==================================================================
316 // Common algo utilities
317 // ==================================================================
319 * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
320 * \param theMesh - The mesh containing nodes
321 * \param theEdge - The geometrical edge of interest
322 * \param theParams - The resulting vector of sorted node parameters
323 * \retval bool - false if not all parameters are OK
324 * \warning Nodes moved to other geometry by MergeNodes() are NOT returned.
326 static bool GetNodeParamOnEdge(const SMESHDS_Mesh* theMesh,
327 const TopoDS_Edge& theEdge,
328 std::vector< double > & theParams);
330 * \brief Fill map of node parameter on geometrical edge to node it-self
331 * \param theMesh - The mesh containing nodes
332 * \param theEdge - The geometrical edge of interest
333 * \param theNodes - The resulting map
334 * \param ignoreMediumNodes - to store medium nodes of quadratic elements or not
335 * \param typeToCheck - type of elements to check for medium nodes
336 * \retval bool - false if not all parameters are OK
337 * \warning Nodes moved to other geometry by MergeNodes() are NOT returned.
339 static bool GetSortedNodesOnEdge(const SMESHDS_Mesh* theMesh,
340 const TopoDS_Edge& theEdge,
341 const bool ignoreMediumNodes,
342 std::map< double, const SMDS_MeshNode* > & theNodes,
343 const SMDSAbs_ElementType typeToCheck = SMDSAbs_All);
346 * \brief Compute length of an edge
347 * \param E - the edge
348 * \retval double - the length
350 static double EdgeLength(const TopoDS_Edge & E);
352 int NumberOfPoints(SMESH_Mesh& aMesh,const TopoDS_Wire& W);
355 * \brief Return continuity of two edges
356 * \param E1 - the 1st edge
357 * \param E2 - the 2nd edge
358 * \retval GeomAbs_Shape - regularity at the junction between E1 and E2
360 static GeomAbs_Shape Continuity(const TopoDS_Edge& E1, const TopoDS_Edge& E2);
363 * \brief Return true if an edge can be considered as a continuation of another
365 static bool IsContinuous(const TopoDS_Edge & E1, const TopoDS_Edge & E2) {
366 return ( Continuity( E1, E2 ) >= GeomAbs_G1 );
369 * \brief Return true if an edge can be considered straight
371 static bool IsStraight( const TopoDS_Edge & E, const bool degenResult=false );
373 * \brief Return true if an edge has no 3D curve
375 static bool isDegenerated( const TopoDS_Edge & E, const bool checkLength=false );
378 * \brief Return the node built on a vertex
379 * \param V - the vertex
380 * \param meshDS - mesh data structure
381 * \retval const SMDS_MeshNode* - found node or NULL
383 static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, const SMESHDS_Mesh* meshDS);
386 * \brief Return the node built on a vertex.
387 * A node moved to other geometry by MergeNodes() is also returned.
388 * \param V - the vertex
390 * \retval const SMDS_MeshNode* - found node or NULL
392 static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, const SMESH_Mesh* mesh);
395 * \brief Return the node built on a vertex.
396 * A node moved to other geometry by MergeNodes() is also returned.
397 * \param V - the vertex
398 * \param edgeSM - sub-mesh of a meshed EDGE sharing the vertex
399 * \param mesh - the mesh
400 * \param checkV - if \c true, presence of a node on the vertex is checked
401 * \retval const SMDS_MeshNode* - found node or NULL
403 static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V,
404 const SMESHDS_SubMesh* edgeSM,
405 const SMESH_Mesh* mesh,
406 const bool checkV=true);
408 enum EMeshError { MEr_OK = 0, MEr_HOLES, MEr_BAD_ORI, MEr_EMPTY };
411 * \brief Finds topological errors of a sub-mesh
413 static EMeshError GetMeshError(SMESH_subMesh* subMesh);
418 * \brief store error and comment and then return ( error == COMPERR_OK )
420 bool error(int error, const SMESH_Comment& comment = "");
422 * \brief store COMPERR_ALGO_FAILED error and comment and then return false
424 bool error(const SMESH_Comment& comment = "")
425 { return error(COMPERR_ALGO_FAILED, comment); }
427 * \brief store error and return error->IsOK()
429 bool error(SMESH_ComputeErrorPtr error);
431 * \brief store a bad input element preventing computation,
432 * which may be a temporary one i.e. not residing the mesh,
433 * then it will be deleted by InitComputeError()
435 void addBadInputElement(const SMDS_MeshElement* elem);
437 void addBadInputElements(const SMESHDS_SubMesh* sm,
438 const bool addNodes=false);
442 const SMESH_HypoFilter * _compatibleAllHypFilter;
443 const SMESH_HypoFilter * _compatibleNoAuxHypFilter;
444 std::vector<std::string> _compatibleHypothesis;
445 std::list<const SMESHDS_Hypothesis *> _appliedHypList;
446 std::list<const SMESHDS_Hypothesis *> _usedHypList;
449 // Algo features influencing which Compute() and how is called:
450 // in what turn and with what input shape.
451 // These fields must be redefined if necessary by each descendant at constructor.
452 bool _onlyUnaryInput; // mesh one shape of GetDim() at once. Default TRUE
453 bool _requireDiscreteBoundary;// GetDim()-1 mesh must be present. Default TRUE
454 bool _requireShape; // work with GetDim()-1 mesh bound to geom only. Default TRUE
455 bool _supportSubmeshes; // if !_requireDiscreteBoundary. Default FALSE
456 bool _neededLowerHyps[4]; // hyp dims needed by algo that !_requireDiscreteBoundary. Df. FALSE
458 // indicates if quadratic mesh creation is required,
459 // is usually set like this: _quadraticMesh = SMESH_MesherHelper::IsQuadraticSubMesh(shape)
462 int _error; //!< SMESH_ComputeErrorName or anything algo specific
463 std::string _comment; //!< any text explaining what is wrong in Compute()
464 std::list<const SMDS_MeshElement*> _badInputElements; //!< to explain COMPERR_BAD_INPUT_MESH
465 const SMDS_Mesh* _mesh; //!< mesh being computed, needed to create SMESH_BadInputElements
467 volatile bool _computeCanceled; //!< is set to True while computing to stop it
469 double _progress; /* progress of Compute() [0.,1.],
470 to be set by an algo really tracking the progress */
471 int _progressTic; // counter of calls from SMESH_Mesh::GetComputeProgress()
472 std::vector<SMESH_subMesh*> _smToCompute; // sub-meshes to Compute()
476 class SMESH_EXPORT SMESH_0D_Algo: public SMESH_Algo
479 SMESH_0D_Algo(int hypId, int studyId, SMESH_Gen* gen);
482 class SMESH_EXPORT SMESH_1D_Algo: public SMESH_Algo
485 SMESH_1D_Algo(int hypId, int studyId, SMESH_Gen* gen);
488 class SMESH_EXPORT SMESH_2D_Algo: public SMESH_Algo
491 SMESH_2D_Algo(int hypId, int studyId, SMESH_Gen* gen);
493 * \brief Method in which an algorithm generating a structured mesh
494 * fixes positions of in-face nodes after there movement
495 * due to insertion of viscous layers.
497 virtual bool FixInternalNodes(const SMESH_ProxyMesh& mesh,
498 const TopoDS_Face& face);
501 class SMESH_EXPORT SMESH_3D_Algo: public SMESH_Algo
504 SMESH_3D_Algo(int hypId, int studyId, SMESH_Gen* gen);