src/SMESH/SMESH_subMesh.hxx

   1 //  SMESH SMESH : implementaion of SMESH idl descriptions
   2 //
   3 //  Copyright (C) 2003  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 //  CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   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.
  10 //
  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.
  15 //
  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
  19 //
  20 //  See http://www.opencascade.org/SALOME/ or email : webmaster.salome@opencascade.org
  21 //
  22 //
  23 //
  24 //  File   : SMESH_subMesh.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //  $Header$
  28
  29 #ifndef _SMESH_SUBMESH_HXX_
  30 #define _SMESH_SUBMESH_HXX_
  31
  32 #include "SMESHDS_Mesh.hxx"
  33 #include "SMESHDS_SubMesh.hxx"
  34 #include "SMESH_Hypothesis.hxx"
  35 #include "Utils_SALOME_Exception.hxx"
  36 #include <TopoDS_Shape.hxx>
  37 #include <TColStd_IndexedMapOfTransient.hxx>
  38 #include <TopTools_IndexedDataMapOfShapeListOfShape.hxx>
  39
  40 #include <set>
  41 #include <list>
  42 #include <map>
  43
  44 class SMESH_Mesh;
  45 class SMESH_Hypothesis;
  46 class SMESH_Algo;
  47 class SMESH_Gen;
  48
  49 class SMESH_subMesh
  50 {
  51  public:
  52   SMESH_subMesh(int Id, SMESH_Mesh * father, SMESHDS_Mesh * meshDS,
  53                 const TopoDS_Shape & aSubShape);
  54   virtual ~ SMESH_subMesh();
  55
  56   int GetId() const;
  57
  58   //   bool Contains(const TopoDS_Shape & aSubShape)
  59   //     throw (SALOME_Exception);
  60
  61   SMESHDS_SubMesh * GetSubMeshDS();
  62
  63   SMESHDS_SubMesh* CreateSubMeshDS();
  64   // Explicit SMESHDS_SubMesh creation method, required for persistence mechanism
  65
  66   SMESH_subMesh *GetFirstToCompute();
  67
  68   const map < int, SMESH_subMesh * >&DependsOn();
  69   //const map < int, SMESH_subMesh * >&Dependants();
  70
  71   const TopoDS_Shape & GetSubShape();
  72
  73 //  bool _vertexSet;                    // only for vertex subMesh, set to false for dim > 0
  74
  75   enum compute_state
  76   {
  77     NOT_READY, READY_TO_COMPUTE,
  78     COMPUTE_OK, FAILED_TO_COMPUTE
  79     };
  80   enum algo_state
  81   {
  82     NO_ALGO, MISSING_HYP, HYP_OK
  83     };
  84   enum algo_event
  85   {
  86     ADD_HYP, ADD_ALGO,
  87     REMOVE_HYP, REMOVE_ALGO,
  88     ADD_FATHER_HYP, ADD_FATHER_ALGO,
  89     REMOVE_FATHER_HYP, REMOVE_FATHER_ALGO
  90     };
  91   enum compute_event
  92   {
  93     MODIF_HYP, MODIF_ALGO_STATE, COMPUTE,
  94     CLEAN, CLEANDEP, SUBMESH_COMPUTED, SUBMESH_RESTORED,
  95     MESH_ENTITY_REMOVED, CHECK_COMPUTE_STATE
  96     };
  97
  98   SMESH_Hypothesis::Hypothesis_Status
  99     AlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
 100
 101   SMESH_Hypothesis::Hypothesis_Status
 102     SubMeshesAlgoStateEngine(int event, SMESH_Hypothesis * anHyp);
 103
 104   int GetAlgoState() { return _algoState; }
 105
 106   void DumpAlgoState(bool isMain);
 107
 108   bool ComputeStateEngine(int event);
 109
 110   int GetComputeState()
 111   {
 112     return _computeState;
 113   };
 114
 115   bool IsConform(const SMESH_Algo* theAlgo);
 116   // check if a conform mesh will be produced by the Algo
 117
 118   bool CanAddHypothesis(const SMESH_Hypothesis* theHypothesis) const;
 119   // return true if theHypothesis can be attached to me:
 120   // its dimention is checked
 121
 122   bool IsApplicableHypotesis(const SMESH_Hypothesis* theHypothesis) const;
 123   // return true if theHypothesis can be used to mesh me:
 124   // its shape type is checked
 125
 126   SMESH_Hypothesis::Hypothesis_Status CheckConcurentHypothesis (const int theHypType);
 127   // check if there are several applicable hypothesis on fathers
 128
 129  protected:
 130   void InsertDependence(const TopoDS_Shape aSubShape);
 131
 132   bool SubMeshesComputed();
 133
 134   bool SubMeshesReady();
 135
 136   void RemoveSubMeshElementsAndNodes();
 137   void UpdateDependantsState(const compute_event theEvent);
 138   void UpdateSubMeshState(const compute_state theState);
 139   void ComputeSubMeshStateEngine(int event);
 140   void CleanDependants();
 141   void CleanDependsOn();
 142   void SetAlgoState(int state);
 143
 144   bool IsMeshComputed() const;
 145   // check if _subMeshDS contains mesh elements
 146
 147   TopoDS_Shape GetCollection(SMESH_Gen * theGen, SMESH_Algo* theAlgo);
 148   // return a shape containing all sub-shapes of the MainShape that can be
 149   // meshed at once along with _subShape
 150
 151   bool ApplyToCollection (SMESH_Algo*         theAlgo,
 152                           const TopoDS_Shape& theCollection);
 153   // Apply theAlgo to all subshapes in theCollection
 154
 155   const SMESH_Hypothesis* GetSimilarAttached(const TopoDS_Shape&      theShape,
 156                                              const SMESH_Hypothesis * theHyp,
 157                                              const int                theHypType = 0);
 158   // return a hypothesis attached to theShape.
 159   // If theHyp is provided, similar but not same hypotheses
 160   // is returned; else an applicable ones having theHypType
 161   // is returned
 162
 163   TopoDS_Shape _subShape;
 164   SMESHDS_Mesh * _meshDS;
 165   SMESHDS_SubMesh * _subMeshDS;
 166   int _Id;
 167   SMESH_Mesh *_father;
 168   map < int, SMESH_subMesh * >_mapDepend;
 169   bool _dependenceAnalysed;
 170
 171   int _algoState;
 172   int _computeState;
 173
 174 };
 175
 176 #endif