1 // Copyright (C) 2007-2020 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_Gen.hxx
25 // Author : Paul RASCLE, EDF
28 #ifndef _SMESH_GEN_HXX_
29 #define _SMESH_GEN_HXX_
31 #include "SMESH_SMESH.hxx"
33 #include "Utils_SALOME_Exception.hxx"
35 #include "SMESH_Algo.hxx"
36 #include "SMESH_ComputeError.hxx"
44 #include <TopoDS_Shape.hxx>
45 #include <TopTools_IndexedMapOfShape.hxx>
47 class SMESHDS_Document;
53 typedef SMESH_Hypothesis::Hypothesis_Status TAlgoStateErrorName;
55 typedef struct studyContextStruct
57 std::map < int, SMESH_Hypothesis * >mapHypothesis;
58 std::map < int, SMESH_Mesh * >mapMesh;
59 SMESHDS_Document * myDocument;
62 typedef std::set<int> TSetOfInt;
64 class SMESH_EXPORT SMESH_Gen
70 SMESH_Mesh* CreateMesh(bool theIsEmbeddedMode)
71 throw(SALOME_Exception);
75 SHAPE_ONLY = 1, // to ignore algo->OnlyUnaryInput() feature and to compute a given shape only.
76 UPWARD = 2, // to compute from vertices up to more complex shape (internal usage)
77 COMPACT_MESH = 4, // to compact the mesh at the end
78 SHAPE_ONLY_UPWARD = 3 // SHAPE_ONLY | UPWARD
81 * \brief Computes aMesh on aShape
82 * \param aMesh - the mesh.
83 * \param aShape - the shape.
84 * \param aFlags - ComputeFlags. By default compute the whole mesh and compact at the end.
85 * \param aDim - upper level dimension of the mesh computation (for preview)
86 * \param aShapesId - list of shapes with computed mesh entities (elements or nodes)
87 * \param anAllowedSubShapes - shapes to mesh only. Mesh all if empty or nullptr
88 * \retval bool - true if none sub-mesh failed to compute
90 bool Compute(::SMESH_Mesh & aMesh,
91 const TopoDS_Shape & aShape,
92 const int aFlags = COMPACT_MESH,
93 const ::MeshDimension aDim=::MeshDim_3D,
94 TSetOfInt* aShapesId=0,
95 TopTools_IndexedMapOfShape* anAllowedSubShapes=0);
97 void PrepareCompute(::SMESH_Mesh & aMesh,
98 const TopoDS_Shape & aShape);
99 void CancelCompute(::SMESH_Mesh & aMesh,
100 const TopoDS_Shape & aShape);
102 const SMESH_subMesh* GetCurrentSubMesh() const;
105 * \brief evaluates size of prospective mesh on a shape
106 * \param aMesh - the mesh
107 * \param aShape - the shape
108 * \param aResMap - map for prospective numbers of elements
109 * \retval bool - is a success
111 bool Evaluate(::SMESH_Mesh & aMesh,
112 const TopoDS_Shape & aShape,
113 MapShapeNbElems& aResMap,
114 const bool anUpward=false,
115 TSetOfInt* aShapesId=0);
117 bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
118 // notify on bad state of attached algos, return false
119 // if Compute() would fail because of some algo bad state
122 * \brief Sets number of segments per diagonal of boundary box of geometry by which
123 * default segment length of appropriate 1D hypotheses is defined
125 void SetBoundaryBoxSegmentation( int theNbSegments ) { _segmentation = theNbSegments; }
126 int GetBoundaryBoxSegmentation() const { return _segmentation; }
128 * \brief Sets default number of segments per edge
130 void SetDefaultNbSegments(int nb) { _nbSegments = nb; }
131 int GetDefaultNbSegments() const { return _nbSegments; }
133 struct TAlgoStateError
135 TAlgoStateErrorName _name;
136 const SMESH_Algo* _algo;
140 TAlgoStateError(): _name(SMESH_Hypothesis::HYP_OK), _algo(0), _algoDim(0) {}
141 void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
142 { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
143 void Set(TAlgoStateErrorName name, const int algoDim, bool isGlobal)
144 { _name = name; _algo = 0; _algoDim = algoDim; _isGlobalAlgo = isGlobal; }
147 bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
148 std::list< SMESH_Gen::TAlgoStateError > & theErrors);
149 // notify on bad state of attached algos, return false
150 // if Compute() would fail because of some algo bad state
151 // theErrors list contains problems description
153 StudyContextStruct *GetStudyContext();
155 static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
156 static int GetShapeDim(const TopoDS_Shape & aShape)
157 { return GetShapeDim( aShape.ShapeType() ); }
159 SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
160 SMESH_Algo* GetAlgo(SMESH_subMesh * aSubMesh, TopoDS_Shape* assignedTo=0);
162 static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
164 static std::vector< std::string > GetPluginXMLPaths();
170 int _localId; // unique Id of created objects, within SMESH_Gen entity
171 StudyContextStruct* _studyContext;
173 // hypotheses managing
176 // number of segments per diagonal of boundary box of geometry by which
177 // default segment length of appropriate 1D hypotheses is defined
179 // default number of segments
182 void setCurrentSubMesh(SMESH_subMesh* sm);
183 void resetCurrentSubMesh();
185 volatile bool _compute_canceled;
186 std::list< SMESH_subMesh* > _sm_current;