SMESH_Algo.hxx

Go to the documentation of this file.

// Copyright (C) 2007-2016  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, or (at your option) any later version.
//
// 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 "SMDSAbs_ElementType.hxx"
#include "SMESH_Comment.hxx"
#include "SMESH_ComputeError.hxx"
#include "SMESH_Hypothesis.hxx"

#include <GeomAbs_Shape.hxx>

#include <string>
#include <vector>
#include <list>
#include <map>
#include <set>

class SMDS_MeshNode;
class SMESHDS_Mesh;
class SMESHDS_SubMesh;
class SMESH_Gen;
class SMESH_HypoFilter;
class SMESH_Mesh;
class SMESH_MesherHelper;
class SMESH_ProxyMesh;
class SMESH_subMesh;
class TopoDS_Edge;
class TopoDS_Face;
class TopoDS_Shape;
class TopoDS_Vertex;
class TopoDS_Wire;
class gp_XYZ;

typedef std::map< SMESH_subMesh*, std::vector<int> >           MapShapeNbElems;
typedef std::map< SMESH_subMesh*, std::vector<int> >::iterator MapShapeNbElemsItr;

// ==================================================================================
// ==================================================================================

class SMESH_EXPORT SMESH_Algo : public SMESH_Hypothesis
{
 public:
  //==================================================================================
  // --------------------------------------------------------------------------------
  struct Features
  {
    int                            _dim;
    std::set<SMDSAbs_GeometryType> _inElemTypes;  // acceptable types of input mesh element
    std::set<SMDSAbs_GeometryType> _outElemTypes; // produced types of mesh elements
    std::string                    _label;        // GUI type name

    bool IsCompatible( const Features& algo2 ) const;
  };
  static const Features& GetFeatures( const std::string& algoType );
  const Features&        GetFeatures() const { return GetFeatures( _name ); }

 public:
  //==================================================================================
  SMESH_Algo(int hypId, int studyId, SMESH_Gen * gen);

  virtual ~ SMESH_Algo();

  virtual std::ostream & SaveTo(std::ostream & save);

  virtual std::istream & LoadFrom(std::istream & load);

  const std::vector < std::string > & GetCompatibleHypothesis();

  virtual bool CheckHypothesis(SMESH_Mesh&                          aMesh,
                               const TopoDS_Shape&                  aShape,
                               SMESH_Hypothesis::Hypothesis_Status& aStatus) = 0;
  virtual bool Compute(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape) = 0;

  virtual bool Compute(SMESH_Mesh & aMesh, SMESH_MesherHelper* aHelper);

  virtual void CancelCompute();

  virtual double GetProgress() const;

  virtual bool Evaluate(SMESH_Mesh & aMesh, const TopoDS_Shape & aShape,
                        MapShapeNbElems& aResMap) = 0;

  virtual const std::list <const SMESHDS_Hypothesis *> &
  GetUsedHypothesis(SMESH_Mesh &         aMesh,
                    const TopoDS_Shape & aShape,
                    const bool           ignoreAuxiliary=true) const;
  const std::list <const SMESHDS_Hypothesis *> &
  GetAppliedHypothesis(SMESH_Mesh &         aMesh,
                       const TopoDS_Shape & aShape,
                       const bool           ignoreAuxiliary=true) const;
  const SMESH_HypoFilter* GetCompatibleHypoFilter(const bool ignoreAuxiliary) const;

  virtual bool SetParametersByMesh(const SMESH_Mesh* theMesh, const TopoDS_Shape& theShape);
  virtual bool SetParametersByDefaults(const TDefaults& dflts, const SMESH_Mesh* theMesh=0);

  SMESH_ComputeErrorPtr GetComputeError() const;
  void InitComputeError();
  double GetProgressByTic() const;
  std::vector<SMESH_subMesh*>& SubMeshesToCompute() { return _smToCompute; }

public:
  // ==================================================================
  // Algo features influencing how Compute() is called:
  // in what turn and with what input shape
  // ==================================================================

  // SMESH_Hypothesis::GetDim();
  // 1 - dimension 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 existence required

  bool SupportSubmeshes() const { return _supportSubmeshes; }
  // 5 - whether supports submeshes if !NeedDiscreteBoundary()

  bool NeedLowerHyps(int dim) const { return _neededLowerHyps[ dim ]; }
  // 6 - if algo !NeedDiscreteBoundary() but requires presence of
  // hypotheses of dimension <dim> to generate all-dimensional mesh.
  // This info is used not to issue warnings on hiding of lower global algos.

public:
  // ==================================================================
  // Methods to track non hierarchical dependencies between submeshes 
  // ==================================================================

  virtual void SetEventListener(SMESH_subMesh* subMesh);
  
  virtual void SubmeshRestored(SMESH_subMesh* subMesh);
  
public:
  // ==================================================================
  // Common algo utilities
  // ==================================================================
  static bool GetNodeParamOnEdge(const SMESHDS_Mesh*     theMesh,
                                 const TopoDS_Edge&      theEdge,
                                 std::vector< double > & theParams);
  static bool GetSortedNodesOnEdge(const SMESHDS_Mesh*                        theMesh,
                                   const TopoDS_Edge&                         theEdge,
                                   const bool                                 ignoreMediumNodes,
                                   std::map< double, const SMDS_MeshNode* > & theNodes,
                                   const SMDSAbs_ElementType                  typeToCheck = SMDSAbs_All);

  static double EdgeLength(const TopoDS_Edge & E);

  int NumberOfPoints(SMESH_Mesh& aMesh,const TopoDS_Wire& W);

  static GeomAbs_Shape Continuity(const TopoDS_Edge& E1, const TopoDS_Edge& E2);

  static bool IsContinuous(const TopoDS_Edge & E1, const TopoDS_Edge & E2) {
    return ( Continuity( E1, E2 ) >= GeomAbs_G1 );
  }
  static bool IsStraight( const TopoDS_Edge & E, const bool degenResult=false );
  static bool isDegenerated( const TopoDS_Edge & E, const bool checkLength=false );

  static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, const SMESHDS_Mesh* meshDS);

  static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex& V, const SMESH_Mesh* mesh);

  static const SMDS_MeshNode* VertexNode(const TopoDS_Vertex&   V,
                                         const SMESHDS_SubMesh* edgeSM,
                                         const SMESH_Mesh*      mesh,
                                         const bool             checkV=true);

  enum EMeshError { MEr_OK = 0, MEr_HOLES, MEr_BAD_ORI, MEr_EMPTY };

  static EMeshError GetMeshError(SMESH_subMesh* subMesh);

 protected:

  bool error(int error, const SMESH_Comment& comment = "");
  bool error(const SMESH_Comment& comment = "")
  { return error(COMPERR_ALGO_FAILED, comment); }
  bool error(SMESH_ComputeErrorPtr error);
  void addBadInputElement(const SMDS_MeshElement* elem);

  void addBadInputElements(const SMESHDS_SubMesh* sm,
                           const bool             addNodes=false);

protected:

  const SMESH_HypoFilter *              _compatibleAllHypFilter;
  const SMESH_HypoFilter *              _compatibleNoAuxHypFilter;
  std::vector<std::string>              _compatibleHypothesis;
  std::list<const SMESHDS_Hypothesis *> _appliedHypList;
  std::list<const SMESHDS_Hypothesis *> _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
  bool _neededLowerHyps[4];     // hyp dims needed by algo that !_requireDiscreteBoundary. Df. FALSE

  // indicates if quadratic mesh creation is required,
  // is usually set like this: _quadraticMesh = SMESH_MesherHelper::IsQuadraticSubMesh(shape)
  bool _quadraticMesh;

  int         _error;    
  std::string _comment;  
  std::list<const SMDS_MeshElement*> _badInputElements; 

  volatile bool _computeCanceled; 

  double        _progress;        /* progress of Compute() [0.,1.],
                                     to be set by an algo really tracking the progress */
  int           _progressTic;     // counter of calls from SMESH_Mesh::GetComputeProgress()
  std::vector<SMESH_subMesh*> _smToCompute; // sub-meshes to Compute()
};


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);
  virtual bool FixInternalNodes(const SMESH_ProxyMesh& mesh,
                                const TopoDS_Face&     face);
};

class SMESH_EXPORT SMESH_3D_Algo: public SMESH_Algo
{
public:
  SMESH_3D_Algo(int hypId, int studyId, SMESH_Gen* gen);
};

#endif