X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FSMESH%2FSMESH_Algo.hxx;h=0e2ab7c2275aa209e8603c57ea3fcfd8918aab36;hb=aa5c100cf71c5a37f71c1ed3b66215e00fa95973;hp=97d1117e56d801da2532cc0a49a9a193f8dd572a;hpb=9d11375af40826e967ab2c3bcb77d1f9d439c90c;p=modules%2Fsmesh.git diff --git a/src/SMESH/SMESH_Algo.hxx b/src/SMESH/SMESH_Algo.hxx index 97d1117e5..0e2ab7c22 100644 --- a/src/SMESH/SMESH_Algo.hxx +++ b/src/SMESH/SMESH_Algo.hxx @@ -1,55 +1,58 @@ -// SMESH SMESH : implementaion of SMESH idl descriptions +// Copyright (C) 2007-2008 CEA/DEN, EDF R&D, OPEN CASCADE +// +// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, +// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License. // -// Copyright (C) 2003 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN, -// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS -// -// This library is free software; you can redistribute it and/or -// modify it under the terms of the GNU Lesser General Public -// License as published by the Free Software Foundation; either -// version 2.1 of the License. -// -// This library is distributed in the hope that it will be useful, -// but WITHOUT ANY WARRANTY; without even the implied warranty of -// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -// Lesser General Public License for more details. -// -// You should have received a copy of the GNU Lesser General Public -// License along with this library; if not, write to the Free Software -// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -// -// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. // +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA // +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com // +// SMESH SMESH : implementaion of SMESH idl descriptions // File : SMESH_Algo.hxx // Author : Paul RASCLE, EDF // Module : SMESH // $Header$ - +// #ifndef _SMESH_ALGO_HXX_ #define _SMESH_ALGO_HXX_ #include "SMESH_SMESH.hxx" #include "SMESH_Hypothesis.hxx" +#include "SMESH_ComputeError.hxx" +#include "SMESH_Comment.hxx" #include #include -#include +#include #include #include #include -#include class SMESH_Gen; class SMESH_Mesh; class SMESH_HypoFilter; +class TopoDS_Vertex; class TopoDS_Face; class TopoDS_Shape; class SMESHDS_Mesh; class SMDS_MeshNode; class SMESH_subMesh; +class SMESH_MesherHelper; + class SMESH_EXPORT SMESH_Algo:public SMESH_Hypothesis { @@ -101,9 +104,23 @@ public: * \param aMesh - the mesh * \param aShape - the shape * \retval bool - is a success + * + * Algorithms that !NeedDescretBoundary() || !OnlyUnaryInput() are + * to set SMESH_ComputeError returned by SMESH_submesh::GetComputeError() + * to report problematic subshapes */ virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0; + /*! + * \brief Computes mesh without geometry + * \param aMesh - the mesh + * \param aHelper - helper that must be used for adding elements to \aaMesh + * \retval bool - is a success + * + * The method is called if ( !aMesh->HasShapeToMesh() ) + */ + virtual bool Compute(SMESH_Mesh & aMesh, SMESH_MesherHelper* aHelper); + /*! * \brief Returns a list of compatible hypotheses used to mesh a shape * \param aMesh - the mesh @@ -146,15 +163,19 @@ public: const bool ignoreAuxiliary) const; /*! * \brief Initialize my parameter values by the mesh built on the geometry - * \param theMesh - the built mesh - * \param theShape - the geometry of interest - * \retval bool - true if parameter values have been successfully defined * * Just return false as the algorithm does not hold parameters values */ virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape); - + /*! + * \brief return compute error + */ + SMESH_ComputeErrorPtr GetComputeError() const; + /*! + * \brief initialize compute error + */ + void InitComputeError(); public: // ================================================================== @@ -176,6 +197,13 @@ public: bool NeedDescretBoundary() const { return _requireDescretBoundary; } // 3 - is a Dim-1 mesh prerequisite + bool NeedShape() const { return _requireShape; } + // 4 - is shape existance required + + bool SupportSubmeshes() const { return _supportSubmeshes; } + // 5 - whether supports submeshes if !NeedDescretBoundary() + + public: // ================================================================== // Methods to track non hierarchical dependencies between submeshes @@ -191,6 +219,14 @@ public: */ virtual void SetEventListener(SMESH_subMesh* subMesh); + /*! + * \brief Allow algo to do something after persistent restoration + * \param subMesh - restored submesh + * + * This method is called only if a submesh has HYP_OK algo_state. + */ + virtual void SubmeshRestored(SMESH_subMesh* subMesh); + public: // ================================================================== // Common algo utilities @@ -221,16 +257,73 @@ public: */ static double EdgeLength(const TopoDS_Edge & E); + /*! + * \brief Return continuity of two edges + * \param E1 - the 1st edge + * \param E2 - the 2nd edge + * \retval GeomAbs_Shape - regularity at the junction between E1 and E2 + */ + static GeomAbs_Shape Continuity(const TopoDS_Edge & E1, const TopoDS_Edge & E2); + + /*! + * \brief Return true if an edge can be considered as a continuation of another + */ + static bool IsContinuous(const TopoDS_Edge & E1, const TopoDS_Edge & E2) { + return ( Continuity( E1, E2 ) >= GeomAbs_G1 ); + } + + /*! + * \brief Return the node built on a vertex + * \param V - the vertex + * \param meshDS - mesh + * \retval const SMDS_MeshNode* - found node or NULL + */ + static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, + SMESHDS_Mesh* meshDS); protected: - bool _onlyUnaryInput; - bool _requireDescretBoundary; - std::vector _compatibleHypothesis; + + /*! + * \brief store error and comment and then return ( error == COMPERR_OK ) + */ + bool error(int error, const SMESH_Comment& comment = ""); + /*! + * \brief store COMPERR_ALGO_FAILED error and comment and then return false + */ + bool error(const SMESH_Comment& comment = "") + { return error(COMPERR_ALGO_FAILED, comment); } + /*! + * \brief store error and return error->IsOK() + */ + bool error(SMESH_ComputeErrorPtr error); + /*! + * \brief store a bad input element preventing computation, + * which may be a temporary one i.e. not residing the mesh, + * then it will be deleted by InitComputeError() + */ + void addBadInputElement(const SMDS_MeshElement* elem); + +protected: + + std::vector _compatibleHypothesis; std::list _appliedHypList; std::list _usedHypList; - // quadratic mesh creation required + // Algo features influencing which Compute() and how is called: + // in what turn and with what input shape. + // This fields must be redefined if necessary by each descendant at constructor. + bool _onlyUnaryInput; // mesh one shape of GetDim() at once. Default TRUE + bool _requireDescretBoundary; // GetDim()-1 mesh must be present. Default TRUE + bool _requireShape; // work with GetDim()-1 mesh bound to geom only. Default TRUE + bool _supportSubmeshes; // if !_requireDescretBoundary. Default FALSE + + // quadratic mesh creation required, + // is usually set trough SMESH_MesherHelper::IsQuadraticSubMesh() bool _quadraticMesh; + + int _error; //!< SMESH_ComputeErrorName or anything algo specific + std::string _comment; //!< any text explaining what is wrong in Compute() + std::list _badInputElements; //!< to explain COMPERR_BAD_INPUT_MESH }; #endif