1 // Copyright (C) 2007-2023 CEA, EDF, 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"
37 #include "SMESH_subMesh.hxx"
46 #include <TopoDS_Shape.hxx>
47 #include <TopTools_IndexedMapOfShape.hxx>
49 class SMESHDS_Document;
52 class SMESH_ParallelMesh;
56 typedef SMESH_Hypothesis::Hypothesis_Status TAlgoStateErrorName;
58 typedef struct studyContextStruct
60 std::map < int, SMESH_Hypothesis * >mapHypothesis;
61 std::map < int, SMESH_Mesh * >mapMesh;
62 SMESHDS_Document * myDocument;
65 typedef std::set<int> TSetOfInt;
67 class SMESH_EXPORT SMESH_Gen
73 SMESH_Mesh* CreateMesh(bool theIsEmbeddedMode);
74 SMESH_ParallelMesh* CreateParallelMesh(bool theIsEmbeddedMode);
78 SHAPE_ONLY = 1, // to ignore algo->OnlyUnaryInput() feature and to compute a given shape only.
79 UPWARD = 2, // to compute from vertices up to more complex shape (internal usage)
80 COMPACT_MESH = 4, // to compact the mesh at the end
81 SHAPE_ONLY_UPWARD = 3 // SHAPE_ONLY | UPWARD
84 * \brief Computes aMesh on aShape
85 * \param aMesh - the mesh.
86 * \param aShape - the shape.
87 * \param aFlags - ComputeFlags. By default compute the whole mesh and compact at the end.
88 * \param aDim - upper level dimension of the mesh computation (for preview)
89 * \param aShapesId - list of shapes with computed mesh entities (elements or nodes)
90 * \param anAllowedSubShapes - shapes to mesh only. Mesh all if empty or nullptr
91 * \retval bool - true if none sub-mesh failed to compute
93 bool Compute(::SMESH_Mesh & aMesh,
94 const TopoDS_Shape & aShape,
95 const int aFlags = COMPACT_MESH,
96 const ::MeshDimension aDim=::MeshDim_3D,
97 TSetOfInt* aShapesId=0,
98 TopTools_IndexedMapOfShape* anAllowedSubShapes=0);
100 void PrepareCompute(::SMESH_Mesh & aMesh,
101 const TopoDS_Shape & aShape);
102 void CancelCompute(::SMESH_Mesh & aMesh,
103 const TopoDS_Shape & aShape);
105 const SMESH_subMesh* GetCurrentSubMesh() const;
108 * \brief evaluates size of prospective mesh on a shape
109 * \param aMesh - the mesh
110 * \param aShape - the shape
111 * \param aResMap - map for prospective numbers of elements
112 * \retval bool - is a success
114 bool Evaluate(::SMESH_Mesh & aMesh,
115 const TopoDS_Shape & aShape,
116 MapShapeNbElems& aResMap,
117 const bool anUpward=false,
118 TSetOfInt* aShapesId=0);
120 bool CheckAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape);
121 // notify on bad state of attached algos, return false
122 // if Compute() would fail because of some algo bad state
125 * \brief Sets number of segments per diagonal of boundary box of geometry by which
126 * default segment length of appropriate 1D hypotheses is defined
128 void SetBoundaryBoxSegmentation( int theNbSegments ) { _segmentation = theNbSegments; }
129 int GetBoundaryBoxSegmentation() const { return _segmentation; }
131 * \brief Sets default number of segments per edge
133 void SetDefaultNbSegments(int nb) { _nbSegments = nb; }
134 int GetDefaultNbSegments() const { return _nbSegments; }
136 struct TAlgoStateError
138 TAlgoStateErrorName _name;
139 const SMESH_Algo* _algo;
143 TAlgoStateError(): _name(SMESH_Hypothesis::HYP_OK), _algo(0), _algoDim(0) {}
144 void Set(TAlgoStateErrorName name, const SMESH_Algo* algo, bool isGlobal)
145 { _name = name; _algo = algo; _algoDim = algo->GetDim(); _isGlobalAlgo = isGlobal; }
146 void Set(TAlgoStateErrorName name, const int algoDim, bool isGlobal)
147 { _name = name; _algo = 0; _algoDim = algoDim; _isGlobalAlgo = isGlobal; }
150 bool GetAlgoState(SMESH_Mesh& aMesh, const TopoDS_Shape& aShape,
151 std::list< SMESH_Gen::TAlgoStateError > & theErrors);
152 // notify on bad state of attached algos, return false
153 // if Compute() would fail because of some algo bad state
154 // theErrors list contains problems description
156 StudyContextStruct *GetStudyContext();
158 static int GetShapeDim(const TopAbs_ShapeEnum & aShapeType);
159 static int GetShapeDim(const TopoDS_Shape & aShape)
160 { return GetShapeDim( aShape.ShapeType() ); }
161 static int GetFlatShapeDim(const TopoDS_Shape &aShape);
163 SMESH_Algo* GetAlgo(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape, TopoDS_Shape* assignedTo=0);
164 SMESH_Algo* GetAlgo(SMESH_subMesh * aSubMesh, TopoDS_Shape* assignedTo=0);
166 static bool IsGlobalHypothesis(const SMESH_Hypothesis* theHyp, SMESH_Mesh& aMesh);
168 static std::vector< std::string > GetPluginXMLPaths();
173 void send_mesh(SMESH_Mesh & aMesh, std::string filename);
175 bool parallelComputeSubMeshes(
177 const TopoDS_Shape & aShape,
178 const ::MeshDimension aDim,
179 TSetOfInt* aShapesId,
180 TopTools_IndexedMapOfShape* allowedSubShapes,
181 SMESH_subMesh::compute_event &computeEvent,
182 const bool includeSelf,
183 const bool complexShapeFirst,
184 const bool aShapeOnly);
186 bool sequentialComputeSubMeshes(
188 const TopoDS_Shape & aShape,
189 const ::MeshDimension aDim,
190 TSetOfInt* aShapesId /*=0*/,
191 TopTools_IndexedMapOfShape* allowedSubShapes,
192 SMESH_subMesh::compute_event &computeEvent,
193 const bool includeSelf,
194 const bool complexShapeFirst,
195 const bool aShapeOnly);
201 int _localId; // unique Id of created objects, within SMESH_Gen entity
202 StudyContextStruct* _studyContext;
204 // hypotheses managing
207 // number of segments per diagonal of boundary box of geometry by which
208 // default segment length of appropriate 1D hypotheses is defined
210 // default number of segments
213 void setCurrentSubMesh(SMESH_subMesh* sm);
214 void resetCurrentSubMesh();
216 volatile bool _compute_canceled;
217 std::list< SMESH_subMesh* > _sm_current;