Salome HOME
Merge from V6_main_20120808 08Aug12
[modules/smesh.git] / src / StdMeshers_I / StdMeshers_CartesianParameters3D_i.hxx
diff --git a/src/StdMeshers_I/StdMeshers_CartesianParameters3D_i.hxx b/src/StdMeshers_I/StdMeshers_CartesianParameters3D_i.hxx
new file mode 100644 (file)
index 0000000..e09422d
--- /dev/null
@@ -0,0 +1,116 @@
+// Copyright (C) 2007-2012  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.
+//
+// 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
+//
+//  File   : StdMeshers_CartesianParameters3D_i.hxx
+//  Module : SMESH
+//
+#ifndef _SMESH_CartesianParameters3D_I_HXX_
+#define _SMESH_CartesianParameters3D_I_HXX_
+
+#include "SMESH_StdMeshers_I.hxx"
+
+#include <SALOMEconfig.h>
+#include CORBA_SERVER_HEADER(SMESH_BasicHypothesis)
+
+#include "SMESH_Hypothesis_i.hxx"
+
+class SMESH_Gen;
+class StdMeshers_CartesianParameters3D;
+
+// ======================================================
+// "CartesianParameters3D" hypothesis
+// ======================================================
+
+class STDMESHERS_I_EXPORT StdMeshers_CartesianParameters3D_i:
+  public virtual POA_StdMeshers::StdMeshers_CartesianParameters3D,
+  public virtual SMESH_Hypothesis_i
+{
+ public:
+  // Constructor
+  StdMeshers_CartesianParameters3D_i( PortableServer::POA_ptr thePOA,
+                                      int                     theStudyId,
+                                      ::SMESH_Gen*            theGenImpl );
+  // Destructor
+  virtual ~StdMeshers_CartesianParameters3D_i();
+
+  /*!
+   * Set size threshold. A polyhedral cell got by cutting an initial
+   * hexahedron by geometry boundary is considered small and is removed if
+   * it's size is \athreshold times less than the size of the initial hexahedron. 
+   * threshold must be > 1.0
+   */
+  void SetSizeThreshold(CORBA::Double threshold) throw (SALOME::SALOME_Exception);
+  CORBA::Double GetSizeThreshold();
+
+  /*!
+   * \brief Set node coordinates along an axis (counterd from zero)
+   */
+  void SetGrid(const SMESH::double_array& coords,
+               CORBA::Short               axis) throw (SALOME::SALOME_Exception);
+  SMESH::double_array* GetGrid(CORBA::Short axis) throw (SALOME::SALOME_Exception);
+
+  /*!
+   * \brief Set grid spacing along an axis
+   *  \param spaceFunctions - functions defining spacing value at given point on axis
+   *  \param internalPoints - points dividing a grid into parts along each direction
+   *  \param axis - index of an axis counterd from zero, i.e. 0==X, 1==Y, 2==Z
+   *
+   * Parameter t of spaceFunction f(t) is a position [0,1] withing bounding box of
+   * the shape to mesh or withing an interval defined by internal points
+   */
+  void SetGridSpacing(const SMESH::string_array& spaceFunctions,
+                      const SMESH::double_array& internalPoints,
+                      CORBA::Short               axis) throw (SALOME::SALOME_Exception);
+
+  void GetGridSpacing(SMESH::string_array_out xSpaceFunctions,
+                      SMESH::double_array_out xInternalPoints,
+                      CORBA::Short            axis) throw (SALOME::SALOME_Exception);
+
+  /*!
+   * \brief Return true if the grid is defined by spacing functions and 
+   *        not by node coordinates
+   */
+  CORBA::Boolean IsGridBySpacing(CORBA::Short axis);
+
+  /*!
+   * \brief Computes node coordinates by spacing functions
+   *  \param x0 - lower coordinate
+   *  \param x1 - upper coordinate
+   *  \param spaceFuns - space functions
+   *  \param points - internal points
+   *  \param coords - the computed coordinates
+   */
+  SMESH::double_array* ComputeCoordinates(CORBA::Double              x0,
+                                          CORBA::Double              x1,
+                                          const SMESH::string_array& spaceFuns,
+                                          const SMESH::double_array& points,
+                                          const char*                axisName )
+    throw (SALOME::SALOME_Exception);
+
+  // Get implementation
+  ::StdMeshers_CartesianParameters3D* GetImpl();
+
+  // Verify whether hypothesis supports given entity type 
+  CORBA::Boolean IsDimSupported( SMESH::Dimension type );
+};
+
+#endif
+