Salome HOME
d9f4d603ab046f60107623980b64f47dd031ac42
[modules/smesh.git] / src / StdMeshers_I / StdMeshers_CartesianParameters3D_i.hxx
1 // Copyright (C) 2007-2016  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, or (at your option) any later version.
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                                       ::SMESH_Gen*            theGenImpl );
50   // Destructor
51   virtual ~StdMeshers_CartesianParameters3D_i();
52
53   /*!
54    * Set size threshold. A polyhedral cell got by cutting an initial
55    * hexahedron by geometry boundary is considered small and is removed if
56    * it's size is \athreshold times less than the size of the initial hexahedron. 
57    * threshold must be > 1.0
58    */
59   void SetSizeThreshold(CORBA::Double threshold) throw (SALOME::SALOME_Exception);
60   CORBA::Double GetSizeThreshold();
61
62   /*!
63    * \brief Set node coordinates along an axis (counterd from zero)
64    */
65   void SetGrid(const SMESH::double_array& coords,
66                CORBA::Short               axis) throw (SALOME::SALOME_Exception);
67   SMESH::double_array* GetGrid(CORBA::Short axis) throw (SALOME::SALOME_Exception);
68
69   /*!
70    * \brief Set grid spacing along an axis
71    *  \param spaceFunctions - functions defining spacing value at given point on axis
72    *  \param internalPoints - points dividing a grid into parts along each direction
73    *  \param axis - index of an axis counterd from zero, i.e. 0==X, 1==Y, 2==Z
74    *
75    * Parameter t of spaceFunction f(t) is a position [0,1] within bounding box of
76    * the shape to mesh or within an interval defined by internal points
77    */
78   void SetGridSpacing(const SMESH::string_array& spaceFunctions,
79                       const SMESH::double_array& internalPoints,
80                       CORBA::Short               axis) throw (SALOME::SALOME_Exception);
81
82   void GetGridSpacing(SMESH::string_array_out xSpaceFunctions,
83                       SMESH::double_array_out xInternalPoints,
84                       CORBA::Short            axis) throw (SALOME::SALOME_Exception);
85   /*!
86    * Set custom direction of axes
87    */
88   void SetAxesDirs(const SMESH::DirStruct& x,
89                    const SMESH::DirStruct& y,
90                    const SMESH::DirStruct& z) throw (SALOME::SALOME_Exception);
91   void GetAxesDirs(SMESH::DirStruct& x,
92                    SMESH::DirStruct& y,
93                    SMESH::DirStruct& z);
94   /*!
95    * Set/unset a fixed point, at which a node will be created provided that grid
96    * is defined by spacing in all directions
97    */
98   void SetFixedPoint(const ::SMESH::PointStruct& p, CORBA::Boolean toUnset);
99   CORBA::Boolean GetFixedPoint(::SMESH::PointStruct& p);
100
101
102   /*!
103    * \brief Enables implementation of geometrical edges into the mesh. If this feature
104    *        is disabled, sharp edges of the shape are lost ("smoothed") in the mesh if
105    *        they don't coincide with the grid lines
106    */
107   void SetToAddEdges(CORBA::Boolean toAdd);
108   CORBA::Boolean GetToAddEdges();
109
110   /*!
111    * \brief Return true if the grid is defined by spacing functions and 
112    *        not by node coordinates
113    */
114   CORBA::Boolean IsGridBySpacing(CORBA::Short axis);
115
116   /*!
117    * Returns axes at which number of hexahedra is maximal
118    */
119   void ComputeOptimalAxesDirs(GEOM::GEOM_Object_ptr shape,
120                               CORBA::Boolean        isOrthogonal,
121                               SMESH::DirStruct&     x,
122                               SMESH::DirStruct&     y,
123                               SMESH::DirStruct&     z) throw (SALOME::SALOME_Exception);
124   /*!
125    * \brief Computes node coordinates by spacing functions
126    *  \param x0 - lower coordinate
127    *  \param x1 - upper coordinate
128    *  \param spaceFuns - space functions
129    *  \param points - internal points
130    *  \param coords - the computed coordinates
131    */
132   SMESH::double_array* ComputeCoordinates(CORBA::Double              x0,
133                                           CORBA::Double              x1,
134                                           const SMESH::string_array& spaceFuns,
135                                           const SMESH::double_array& points,
136                                           const char*                axisName )
137     throw (SALOME::SALOME_Exception);
138
139   // Get implementation
140   ::StdMeshers_CartesianParameters3D* GetImpl();
141
142   // Verify whether hypothesis supports given entity type 
143   CORBA::Boolean IsDimSupported( SMESH::Dimension type );
144 };
145
146 #endif
147