0031251: Add a new meshing parameter to enforce face linear deflection
[occt.git] / src / IMeshTools / IMeshTools_Parameters.hxx
1 // Created on: 2016-04-07
2 // Copyright (c) 2016 OPEN CASCADE SAS
3 // Created by: Oleg AGASHIN
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and/or modify it under
8 // the terms of the GNU Lesser General Public License version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _IMeshTools_Parameters_HeaderFile
17 #define _IMeshTools_Parameters_HeaderFile
18
19 #include <Precision.hxx>
20
21 //! Structure storing meshing parameters
22 struct IMeshTools_Parameters {
23
24   //! Default constructor
25   IMeshTools_Parameters ()
26     :
27     Angle(0.5),
28     Deflection(0.001),
29     AngleInterior(-1.0),
30     DeflectionInterior(-1.0),
31     MinSize (-1.0),
32     InParallel (Standard_False),
33     Relative (Standard_False),
34     InternalVerticesMode (Standard_True),
35     ControlSurfaceDeflection (Standard_True),
36     CleanModel (Standard_True),
37     AdjustMinSize (Standard_False),
38     ForceFaceDeflection (Standard_False)
39   {
40   }
41
42   //! Returns factor used to compute default value of MinSize 
43   //! (minimum mesh edge length) from deflection
44   static Standard_Real RelMinSize()
45   {
46     return 0.1;
47   }
48
49   //! Angular deflection used to tessellate the boundary edges
50   Standard_Real                                    Angle;
51
52   //!Linear deflection used to tessellate the boundary edges
53   Standard_Real                                    Deflection;
54   
55   //! Angular deflection used to tessellate the face interior
56   Standard_Real                                    AngleInterior;
57
58   //! Linear deflection used to tessellate the face interior
59   Standard_Real                                    DeflectionInterior;
60   
61   //! Minimal allowed size of mesh element
62   Standard_Real                                    MinSize;
63
64   //! Switches on/off multi-thread computation
65   Standard_Boolean                                 InParallel;
66
67   //! Switches on/off relative computation of edge tolerance<br>
68   //! If true, deflection used for the polygonalisation of each edge will be 
69   //! <defle> * Size of Edge. The deflection used for the faces will be the 
70   //! maximum deflection of their edges.
71   Standard_Boolean                                 Relative;
72
73   //! Mode to take or not to take internal face vertices into account
74   //! in triangulation process
75   Standard_Boolean                                 InternalVerticesMode;
76
77   //! Parameter to check the deviation of triangulation and interior of
78   //! the face
79   Standard_Boolean                                 ControlSurfaceDeflection;
80
81   //! Cleans temporary data model when algorithm is finished.
82   Standard_Boolean                                 CleanModel;
83
84   //! Enables/disables local adjustment of min size depending on edge size.
85   //! Disabled by default.
86   Standard_Boolean                                 AdjustMinSize;
87
88   //! Enables/disables usage of shape tolerances for computing face deflection.
89   //! Disabled by default.
90   Standard_Boolean                                 ForceFaceDeflection;
91 };
92
93 #endif