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 : SMESH_Algo.hxx
24 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_ALGO_HXX_
29 #define _SMESH_ALGO_HXX_
31 #include "SMESH_SMESH.hxx"
33 #include "SMESH_Hypothesis.hxx"
34 #include "SMESH_ComputeError.hxx"
35 #include "SMESH_Comment.hxx"
37 #include <TopoDS_Shape.hxx>
38 #include <TopoDS_Edge.hxx>
39 #include <GeomAbs_Shape.hxx>
47 class SMESH_HypoFilter;
54 class SMESH_MesherHelper;
57 class SMESH_EXPORT SMESH_Algo:public SMESH_Hypothesis
61 * \brief Creates algorithm
62 * \param hypId - algorithm ID
63 * \param studyId - study ID
64 * \param gen - SMESH_Gen
66 SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);
71 virtual ~ SMESH_Algo();
74 * \brief Saves nothing in a stream
75 * \param save - the stream
76 * \retval virtual std::ostream & - the stream
78 virtual std::ostream & SaveTo(std::ostream & save);
81 * \brief Loads nothing from a stream
82 * \param load - the stream
83 * \retval virtual std::ostream & - the stream
85 virtual std::istream & LoadFrom(std::istream & load);
88 * \brief Returns all types of compatible hypotheses
90 const std::vector < std::string > & GetCompatibleHypothesis();
93 * \brief Check hypothesis definition to mesh a shape
94 * \param aMesh - the mesh
95 * \param aShape - the shape
96 * \param aStatus - check result
97 * \retval bool - true if hypothesis is well defined
99 virtual bool CheckHypothesis(SMESH_Mesh& aMesh,
100 const TopoDS_Shape& aShape,
101 SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
103 * \brief Computes mesh on a shape
104 * \param aMesh - the mesh
105 * \param aShape - the shape
106 * \retval bool - is a success
108 * Algorithms that !NeedDescretBoundary() || !OnlyUnaryInput() are
109 * to set SMESH_ComputeError returned by SMESH_submesh::GetComputeError()
110 * to report problematic subshapes
112 virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;
115 * \brief Computes mesh without geometry
116 * \param aMesh - the mesh
117 * \param aHelper - helper that must be used for adding elements to \aaMesh
118 * \retval bool - is a success
120 * The method is called if ( !aMesh->HasShapeToMesh() )
122 virtual bool Compute(SMESH_Mesh & aMesh, SMESH_MesherHelper* aHelper);
125 * \brief Returns a list of compatible hypotheses used to mesh a shape
126 * \param aMesh - the mesh
127 * \param aShape - the shape
128 * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list
129 * \retval const std::list <const SMESHDS_Hypothesis*> - hypotheses list
131 * List the hypothesis used by the algorithm associated to the shape.
132 * Hypothesis associated to father shape -are- taken into account (see
133 * GetAppliedHypothesis). Relevant hypothesis have a name (type) listed in
134 * the algorithm. This method could be surcharged by specific algorithms, in
135 * case of several hypothesis simultaneously applicable.
137 virtual const std::list <const SMESHDS_Hypothesis *> &
138 GetUsedHypothesis(SMESH_Mesh & aMesh,
139 const TopoDS_Shape & aShape,
140 const bool ignoreAuxiliary=true);
142 * \brief Returns a list of compatible hypotheses assigned to a shape in a mesh
143 * \param aMesh - the mesh
144 * \param aShape - the shape
145 * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list
146 * \retval const std::list <const SMESHDS_Hypothesis*> - hypotheses list
148 * List the relevant hypothesis associated to the shape. Relevant hypothesis
149 * have a name (type) listed in the algorithm. Hypothesis associated to
150 * father shape -are not- taken into account (see GetUsedHypothesis)
152 const std::list <const SMESHDS_Hypothesis *> &
153 GetAppliedHypothesis(SMESH_Mesh & aMesh,
154 const TopoDS_Shape & aShape,
155 const bool ignoreAuxiliary=true);
157 * \brief Make the filter recognize only compatible hypotheses
158 * \param theFilter - the filter to initialize
159 * \param ignoreAuxiliary - make filter ignore compatible auxiliary hypotheses
160 * \retval bool - true if the algo has compatible hypotheses
162 bool InitCompatibleHypoFilter( SMESH_HypoFilter & theFilter,
163 const bool ignoreAuxiliary) const;
165 * \brief Initialize my parameter values by the mesh built on the geometry
167 * Just return false as the algorithm does not hold parameters values
169 virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh,
170 const TopoDS_Shape& theShape);
172 * \brief return compute error
174 SMESH_ComputeErrorPtr GetComputeError() const;
176 * \brief initialize compute error
178 void InitComputeError();
181 // ==================================================================
182 // Algo features influencing how Compute() is called:
183 // in what turn and with what input shape
184 // ==================================================================
186 // SMESH_Hypothesis::GetDim();
187 // 1 - dimention of target mesh
189 bool OnlyUnaryInput() const { return _onlyUnaryInput; }
190 // 2 - is collection of tesselatable shapes inacceptable as input;
191 // "collection" means a shape containing shapes of dim equal
193 // Algo which can process a collection shape should expect
194 // an input temporary shape that is neither MainShape nor
197 bool NeedDescretBoundary() const { return _requireDescretBoundary; }
198 // 3 - is a Dim-1 mesh prerequisite
200 bool NeedShape() const { return _requireShape; }
201 // 4 - is shape existance required
203 bool SupportSubmeshes() const { return _supportSubmeshes; }
204 // 5 - whether supports submeshes if !NeedDescretBoundary()
208 // ==================================================================
209 // Methods to track non hierarchical dependencies between submeshes
210 // ==================================================================
213 * \brief Sets event listener to submeshes if necessary
214 * \param subMesh - submesh where algo is set
216 * This method is called when a submesh gets HYP_OK algo_state.
217 * After being set, event listener is notified on each event of a submesh.
218 * By default non listener is set
220 virtual void SetEventListener(SMESH_subMesh* subMesh);
223 * \brief Allow algo to do something after persistent restoration
224 * \param subMesh - restored submesh
226 * This method is called only if a submesh has HYP_OK algo_state.
228 virtual void SubmeshRestored(SMESH_subMesh* subMesh);
231 // ==================================================================
232 // Common algo utilities
233 // ==================================================================
235 * \brief Fill vector of node parameters on geometrical edge, including vertex nodes
236 * \param theMesh - The mesh containing nodes
237 * \param theEdge - The geometrical edge of interest
238 * \param theParams - The resulting vector of sorted node parameters
239 * \retval bool - false if not all parameters are OK
241 static bool GetNodeParamOnEdge(const SMESHDS_Mesh* theMesh,
242 const TopoDS_Edge& theEdge,
243 std::vector< double > & theParams);
245 * \brief Find out elements orientation on a geometrical face
246 * \param theFace - The face correctly oriented in the shape being meshed
247 * \param theMeshDS - The mesh data structure
248 * \retval bool - true if the face normal and the normal of first element
249 * in the correspoding submesh point in different directions
251 static bool IsReversedSubMesh (const TopoDS_Face& theFace,
252 SMESHDS_Mesh* theMeshDS);
254 * \brief Compute length of an edge
255 * \param E - the edge
256 * \retval double - the length
258 static double EdgeLength(const TopoDS_Edge & E);
261 * \brief Return continuity of two edges
262 * \param E1 - the 1st edge
263 * \param E2 - the 2nd edge
264 * \retval GeomAbs_Shape - regularity at the junction between E1 and E2
266 static GeomAbs_Shape Continuity(const TopoDS_Edge & E1, const TopoDS_Edge & E2);
269 * \brief Return true if an edge can be considered as a continuation of another
271 static bool IsContinuous(const TopoDS_Edge & E1, const TopoDS_Edge & E2) {
272 return ( Continuity( E1, E2 ) >= GeomAbs_G1 );
276 * \brief Return the node built on a vertex
277 * \param V - the vertex
278 * \param meshDS - mesh
279 * \retval const SMDS_MeshNode* - found node or NULL
281 static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V,
282 SMESHDS_Mesh* meshDS);
287 * \brief store error and comment and then return ( error == COMPERR_OK )
289 bool error(int error, const SMESH_Comment& comment = "");
291 * \brief store COMPERR_ALGO_FAILED error and comment and then return false
293 bool error(const SMESH_Comment& comment = "")
294 { return error(COMPERR_ALGO_FAILED, comment); }
296 * \brief store error and return error->IsOK()
298 bool error(SMESH_ComputeErrorPtr error);
300 * \brief store a bad input element preventing computation,
301 * which may be a temporary one i.e. not residing the mesh,
302 * then it will be deleted by InitComputeError()
304 void addBadInputElement(const SMDS_MeshElement* elem);
308 std::vector<std::string> _compatibleHypothesis;
309 std::list<const SMESHDS_Hypothesis *> _appliedHypList;
310 std::list<const SMESHDS_Hypothesis *> _usedHypList;
312 // Algo features influencing which Compute() and how is called:
313 // in what turn and with what input shape.
314 // This fields must be redefined if necessary by each descendant at constructor.
315 bool _onlyUnaryInput; // mesh one shape of GetDim() at once. Default TRUE
316 bool _requireDescretBoundary; // GetDim()-1 mesh must be present. Default TRUE
317 bool _requireShape; // work with GetDim()-1 mesh bound to geom only. Default TRUE
318 bool _supportSubmeshes; // if !_requireDescretBoundary. Default FALSE
320 // quadratic mesh creation required,
321 // is usually set trough SMESH_MesherHelper::IsQuadraticSubMesh()
324 int _error; //!< SMESH_ComputeErrorName or anything algo specific
325 std::string _comment; //!< any text explaining what is wrong in Compute()
326 std::list<const SMDS_MeshElement*> _badInputElements; //!< to explain COMPERR_BAD_INPUT_MESH