src/StdMeshers_I/StdMeshers_CartesianParameters3D_i.hxx

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