X-Git-Url: http://git.salome-platform.org/gitweb/?p=modules%2Fsmesh.git;a=blobdiff_plain;f=src%2FSMESH%2FSMESH_Algo.hxx;h=1a3be0876eb8dc012a137455948ae486836bff51;hp=de6c671626fb8b8c44c5226e6eb1711af0b568d5;hb=f5016d85b7b4b88623723027a1585c6414c4dc66;hpb=0b959120c59670d73c0a1f6d46bfa72a6ceb49cf diff --git a/src/SMESH/SMESH_Algo.hxx b/src/SMESH/SMESH_Algo.hxx index de6c67162..1a3be0876 100644 --- a/src/SMESH/SMESH_Algo.hxx +++ b/src/SMESH/SMESH_Algo.hxx @@ -1,60 +1,415 @@ -//============================================================================= -// File : SMESH_Algo.hxx -// Created : sam mai 18 09:20:46 CEST 2002 -// Author : Paul RASCLE, EDF -// Project : SALOME -// Copyright : EDF 2002 -// $Header$ -//============================================================================= +// Copyright (C) 2007-2012 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. +// +// 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 +// #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 -class SMESH_gen; +class SMESH_Gen; class SMESH_Mesh; +class SMESH_HypoFilter; +class TopoDS_Vertex; +class TopoDS_Wire; +class TopoDS_Face; +class TopoDS_Shape; +class SMESHDS_Mesh; +class SMDS_MeshNode; +class SMESH_subMesh; +class SMESH_MesherHelper; +class gp_XYZ; + +typedef std::map< SMESH_subMesh*, std::vector > MapShapeNbElems; +typedef std::map< SMESH_subMesh*, std::vector >::iterator MapShapeNbElemsItr; -class SMESH_Algo: - public SMESH_Hypothesis +/*! + * \brief Root of all algorithms + * + * Methods of the class are grouped into several parts: + * - main lifecycle methods, like Compute() + * - methods describing features of the algorithm, like NeedShape() + * - methods related to dependencies between sub-meshes imposed by the algorith + * - static utilities, like EdgeLength() + */ +class SMESH_EXPORT SMESH_Algo:public SMESH_Hypothesis { public: - SMESH_Algo(int hypId, int studyId, SMESH_Gen* gen); - virtual ~SMESH_Algo(); + /*! + * \brief Creates algorithm + * \param hypId - algorithm ID + * \param studyId - study ID + * \param gen - SMESH_Gen + */ + SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen); + + /*! + * \brief Destructor + */ + virtual ~ SMESH_Algo(); + + /*! + * \brief Saves nothing in a stream + * \param save - the stream + * \retval std::ostream & - the stream + */ + virtual std::ostream & SaveTo(std::ostream & save); + + /*! + * \brief Loads nothing from a stream + * \param load - the stream + * \retval std::ostream & - the stream + */ + virtual std::istream & LoadFrom(std::istream & load); + + /*! + * \brief Returns all types of compatible hypotheses + */ + const std::vector < std::string > & GetCompatibleHypothesis(); + + /*! + * \brief Check hypothesis definition to mesh a shape + * \param aMesh - the mesh + * \param aShape - the shape + * \param aStatus - check result + * \retval bool - true if hypothesis is well defined + */ + virtual bool CheckHypothesis(SMESH_Mesh& aMesh, + const TopoDS_Shape& aShape, + SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0; + /*! + * \brief Computes mesh on a shape + * \param aMesh - the mesh + * \param aShape - the shape + * \retval bool - is a success + * + * Algorithms that !NeedDiscreteBoundary() || !OnlyUnaryInput() are + * to set SMESH_ComputeError returned by SMESH_submesh::GetComputeError() + * to report problematic sub-shapes + */ + 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 Sets _computeCanceled to true. It's usage depends on + * implementation of a particular mesher. + */ + virtual void CancelCompute(); + + /*! + * \brief evaluates size of prospective mesh on a shape + * \param aMesh - the mesh + * \param aShape - the shape + * \param aNbElems - prospective number of elements by types + * \retval bool - is a success + */ + virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, + MapShapeNbElems& aResMap) = 0; + + /*! + * \brief Returns a list of compatible hypotheses used to mesh a shape + * \param aMesh - the mesh + * \param aShape - the shape + * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list + * \retval const std::list - hypotheses list + * + * List the hypothesis used by the algorithm associated to the shape. + * Hypothesis associated to father shape -are- taken into account (see + * GetAppliedHypothesis). Relevant hypothesis have a name (type) listed in + * the algorithm. This method could be surcharged by specific algorithms, in + * case of several hypothesis simultaneously applicable. + */ + virtual const std::list & + GetUsedHypothesis(SMESH_Mesh & aMesh, + const TopoDS_Shape & aShape, + const bool ignoreAuxiliary=true); + /*! + * \brief Returns a list of compatible hypotheses assigned to a shape in a mesh + * \param aMesh - the mesh + * \param aShape - the shape + * \param ignoreAuxiliary - do not include auxiliary hypotheses in the list + * \retval const std::list - hypotheses list + * + * List the relevant hypothesis associated to the shape. Relevant hypothesis + * have a name (type) listed in the algorithm. Hypothesis associated to + * father shape -are not- taken into account (see GetUsedHypothesis) + */ + const list & + GetAppliedHypothesis(SMESH_Mesh & aMesh, + const TopoDS_Shape & aShape, + const bool ignoreAuxiliary=true); + /*! + * \brief Make the filter recognize only compatible hypotheses + * \param theFilter - the filter to initialize + * \param ignoreAuxiliary - make filter ignore compatible auxiliary hypotheses + * \retval bool - true if the algo has compatible hypotheses + */ + bool InitCompatibleHypoFilter( SMESH_HypoFilter & theFilter, + const bool ignoreAuxiliary) const; + /*! + * \brief Just return false as the algorithm does not hold parameters values + */ + virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape); + virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0); + /*! + * \brief return compute error + */ + SMESH_ComputeErrorPtr GetComputeError() const; + /*! + * \brief initialize compute error + */ + void InitComputeError(); + +public: + // ================================================================== + // Algo features influencing how Compute() is called: + // in what turn and with what input shape + // ================================================================== + + // SMESH_Hypothesis::GetDim(); + // 1 - dimention of target mesh + + bool OnlyUnaryInput() const { return _onlyUnaryInput; } + // 2 - is collection of tesselatable shapes inacceptable as input; + // "collection" means a shape containing shapes of dim equal + // to GetDim(). + // Algo which can process a collection shape should expect + // an input temporary shape that is neither MainShape nor + // its child. + + bool NeedDiscreteBoundary() const { return _requireDiscreteBoundary; } + // 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 !NeedDiscreteBoundary() + + +public: + // ================================================================== + // Methods to track non hierarchical dependencies between submeshes + // ================================================================== + + /*! + * \brief Sets event listener to submeshes if necessary + * \param subMesh - submesh where algo is set + * + * This method is called when a submesh gets HYP_OK algo_state. + * After being set, event listener is notified on each event of a submesh. + * By default none listener is set + */ + 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 + // ================================================================== + /*! + * \brief Fill vector of node parameters on geometrical edge, including vertex nodes + * \param theMesh - The mesh containing nodes + * \param theEdge - The geometrical edge of interest + * \param theParams - The resulting vector of sorted node parameters + * \retval bool - false if not all parameters are OK + */ + static bool GetNodeParamOnEdge(const SMESHDS_Mesh* theMesh, + const TopoDS_Edge& theEdge, + std::vector< double > & theParams); + /*! + * \brief Fill map of node parameter on geometrical edge to node it-self + * \param theMesh - The mesh containing nodes + * \param theEdge - The geometrical edge of interest + * \param theNodes - The resulting map + * \param ignoreMediumNodes - to store medium nodes of quadratic elements or not + * \retval bool - false if not all parameters are OK + */ + static bool GetSortedNodesOnEdge(const SMESHDS_Mesh* theMesh, + const TopoDS_Edge& theEdge, + const bool ignoreMediumNodes, + std::map< double, const SMDS_MeshNode* > & theNodes); + /*! + * \brief Find out elements orientation on a geometrical face + * \param theFace - The face correctly oriented in the shape being meshed + * \param theMeshDS - The mesh data structure + * \retval bool - true if the face normal and the normal of first element + * in the correspoding submesh point in different directions + */ + static bool IsReversedSubMesh (const TopoDS_Face& theFace, + SMESHDS_Mesh* theMeshDS); + /*! + * \brief Compute length of an edge + * \param E - the edge + * \retval double - the length + */ + static double EdgeLength(const TopoDS_Edge & E); + + /*! + * \brief Calculate normal of a mesh face + */ + static bool FaceNormal(const SMDS_MeshElement* F, gp_XYZ& normal, bool normalized=true); - const vector & GetCompatibleHypothesis(); - virtual bool CheckHypothesis(SMESH_Mesh& aMesh, - const TopoDS_Shape& aShape); + static int NumberOfWires(const TopoDS_Shape& S); + int NumberOfPoints(SMESH_Mesh& aMesh,const TopoDS_Wire& W); - virtual bool Compute(SMESH_Mesh& aMesh, - const TopoDS_Shape& aShape); + /*! + * \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(TopoDS_Edge E1, TopoDS_Edge E2); - virtual const list& - GetUsedHypothesis(SMESH_Mesh& aMesh, - const TopoDS_Shape& aShape); + /*! + * \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 ); + } - const list& - GetAppliedHypothesis(SMESH_Mesh& aMesh, - const TopoDS_Shape& aShape); + /*! + * \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, const SMESHDS_Mesh* meshDS); - static double EdgeLength(const TopoDS_Edge& E); + /*! + * \brief Return nodes common to two elements + */ + static std::vector< const SMDS_MeshNode*> GetCommonNodes(const SMDS_MeshElement* e1, + const SMDS_MeshElement* e2); - virtual ostream & SaveTo(ostream & save); - virtual istream & LoadFrom(istream & load); - friend ostream& operator << (ostream & save, SMESH_Algo & hyp); - friend istream& operator >> (istream & load, SMESH_Algo & hyp); + enum EMeshError { MEr_OK = 0, MEr_HOLES, MEr_BAD_ORI, MEr_EMPTY }; + + /*! + * \brief Finds topological errors of a sub-mesh + */ + static EMeshError GetMeshError(SMESH_subMesh* subMesh); + + protected: + + /*! + * \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: - vector _compatibleHypothesis; - list _appliedHypList; - list _usedHypList; + + std::vector _compatibleHypothesis; + std::list _appliedHypList; + std::list _usedHypList; + + // Algo features influencing which Compute() and how is called: + // in what turn and with what input shape. + // These fields must be redefined if necessary by each descendant at constructor. + bool _onlyUnaryInput; // mesh one shape of GetDim() at once. Default TRUE + bool _requireDiscreteBoundary; // GetDim()-1 mesh must be present. Default TRUE + bool _requireShape; // work with GetDim()-1 mesh bound to geom only. Default TRUE + bool _supportSubmeshes; // if !_requireDiscreteBoundary. Default FALSE + + // indicates if quadratic mesh creation is required, + // is usually set like this: _quadraticMesh = SMESH_MesherHelper::IsQuadraticSubMesh(shape) + 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 + + volatile bool _computeCanceled; //!< is set to True while computing to stop it +}; + +class SMESH_EXPORT SMESH_0D_Algo: public SMESH_Algo +{ +public: + SMESH_0D_Algo(int hypId, int studyId, SMESH_Gen* gen); +}; + +class SMESH_EXPORT SMESH_1D_Algo: public SMESH_Algo +{ +public: + SMESH_1D_Algo(int hypId, int studyId, SMESH_Gen* gen); +}; + +class SMESH_EXPORT SMESH_2D_Algo: public SMESH_Algo +{ +public: + SMESH_2D_Algo(int hypId, int studyId, SMESH_Gen* gen); +}; + +class SMESH_EXPORT SMESH_3D_Algo: public SMESH_Algo +{ +public: + SMESH_3D_Algo(int hypId, int studyId, SMESH_Gen* gen); }; #endif