src/StdMeshers_I/StdMeshers_CartesianParameters3D_i.hxx

   1 // Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  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.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22 //  File   : StdMeshers_CartesianParameters3D_i.hxx
  23 //  Module : SMESH
  24 //
  25 #ifndef _SMESH_CartesianParameters3D_I_HXX_
  26 #define _SMESH_CartesianParameters3D_I_HXX_
  27
  28 #include "SMESH_StdMeshers_I.hxx"
  29
  30 #include <SALOMEconfig.h>
  31 #include CORBA_SERVER_HEADER(SMESH_BasicHypothesis)
  32
  33 #include "SMESH_Hypothesis_i.hxx"
  34
  35 class SMESH_Gen;
  36 class StdMeshers_CartesianParameters3D;
  37
  38 // ======================================================
  39 // "CartesianParameters3D" hypothesis
  40 // ======================================================
  41
  42 class STDMESHERS_I_EXPORT StdMeshers_CartesianParameters3D_i:
  43   public virtual POA_StdMeshers::StdMeshers_CartesianParameters3D,
  44   public virtual SMESH_Hypothesis_i
  45 {
  46  public:
  47   // Constructor
  48   StdMeshers_CartesianParameters3D_i( PortableServer::POA_ptr thePOA,
  49                                       int                     theStudyId,
  50                                       ::SMESH_Gen*            theGenImpl );
  51   // Destructor
  52   virtual ~StdMeshers_CartesianParameters3D_i();
  53
  54   /*!
  55    * Set size threshold. A polyhedral cell got by cutting an initial
  56    * hexahedron by geometry boundary is considered small and is removed if
  57    * it's size is \athreshold times less than the size of the initial hexahedron.
  58    * threshold must be > 1.0
  59    */
  60   void SetSizeThreshold(CORBA::Double threshold) throw (SALOME::SALOME_Exception);
  61   CORBA::Double GetSizeThreshold();
  62
  63   /*!
  64    * \brief Set node coordinates along an axis (counterd from zero)
  65    */
  66   void SetGrid(const SMESH::double_array& coords,
  67                CORBA::Short               axis) throw (SALOME::SALOME_Exception);
  68   SMESH::double_array* GetGrid(CORBA::Short axis) throw (SALOME::SALOME_Exception);
  69
  70   /*!
  71    * \brief Set grid spacing along an axis
  72    *  \param spaceFunctions - functions defining spacing value at given point on axis
  73    *  \param internalPoints - points dividing a grid into parts along each direction
  74    *  \param axis - index of an axis counterd from zero, i.e. 0==X, 1==Y, 2==Z
  75    *
  76    * Parameter t of spaceFunction f(t) is a position [0,1] withing bounding box of
  77    * the shape to mesh or withing an interval defined by internal points
  78    */
  79   void SetGridSpacing(const SMESH::string_array& spaceFunctions,
  80                       const SMESH::double_array& internalPoints,
  81                       CORBA::Short               axis) throw (SALOME::SALOME_Exception);
  82
  83   void GetGridSpacing(SMESH::string_array_out xSpaceFunctions,
  84                       SMESH::double_array_out xInternalPoints,
  85                       CORBA::Short            axis) throw (SALOME::SALOME_Exception);
  86
  87   /*!
  88    * \brief Return true if the grid is defined by spacing functions and
  89    *        not by node coordinates
  90    */
  91   CORBA::Boolean IsGridBySpacing(CORBA::Short axis);
  92
  93   /*!
  94    * \brief Computes node coordinates by spacing functions
  95    *  \param x0 - lower coordinate
  96    *  \param x1 - upper coordinate
  97    *  \param spaceFuns - space functions
  98    *  \param points - internal points
  99    *  \param coords - the computed coordinates
 100    */
 101   SMESH::double_array* ComputeCoordinates(CORBA::Double              x0,
 102                                           CORBA::Double              x1,
 103                                           const SMESH::string_array& spaceFuns,
 104                                           const SMESH::double_array& points,
 105                                           const char*                axisName )
 106     throw (SALOME::SALOME_Exception);
 107
 108   // Get implementation
 109   ::StdMeshers_CartesianParameters3D* GetImpl();
 110
 111   // Verify whether hypothesis supports given entity type
 112   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
 113 };
 114
 115 #endif
 116