include/opencascade/IMeshTools_Parameters.hxx

0001 // Created on: 2016-04-07
0002 // Copyright (c) 2016 OPEN CASCADE SAS
0003 // Created by: Oleg AGASHIN
0004 //
0005 // This file is part of Open CASCADE Technology software library.
0006 //
0007 // This library is free software; you can redistribute it and/or modify it under
0008 // the terms of the GNU Lesser General Public License version 2.1 as published
0009 // by the Free Software Foundation, with special exception defined in the file
0010 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0011 // distribution for complete text of the license and disclaimer of any warranty.
0012 //
0013 // Alternatively, this file may be used under the terms of Open CASCADE
0014 // commercial license or contractual agreement.
0015
0016 #ifndef _IMeshTools_Parameters_HeaderFile
0017 #define _IMeshTools_Parameters_HeaderFile
0018
0019 #include <IMeshTools_MeshAlgoType.hxx>
0020 #include <Precision.hxx>
0021
0022 //! Structure storing meshing parameters
0023 struct IMeshTools_Parameters {
0024
0025   //! Default constructor
0026   IMeshTools_Parameters ()
0027     :
0028     MeshAlgo (IMeshTools_MeshAlgoType_DEFAULT),
0029     Angle(0.5),
0030     Deflection(0.001),
0031     AngleInterior(-1.0),
0032     DeflectionInterior(-1.0),
0033     MinSize (-1.0),
0034     InParallel (Standard_False),
0035     Relative (Standard_False),
0036     InternalVerticesMode (Standard_True),
0037     ControlSurfaceDeflection (Standard_True),
0038     EnableControlSurfaceDeflectionAllSurfaces(Standard_False),
0039     CleanModel (Standard_True),
0040     AdjustMinSize (Standard_False),
0041     ForceFaceDeflection (Standard_False),
0042     AllowQualityDecrease (Standard_False)
0043   {
0044   }
0045
0046   //! Returns factor used to compute default value of MinSize
0047   //! (minimum mesh edge length) from deflection
0048   static Standard_Real RelMinSize()
0049   {
0050     return 0.1;
0051   }
0052
0053   //! 2D Delaunay triangulation algorithm factory to use
0054   IMeshTools_MeshAlgoType                          MeshAlgo;
0055
0056   //! Angular deflection used to tessellate the boundary edges
0057   Standard_Real                                    Angle;
0058
0059   //!Linear deflection used to tessellate the boundary edges
0060   Standard_Real                                    Deflection;
0061
0062   //! Angular deflection used to tessellate the face interior
0063   Standard_Real                                    AngleInterior;
0064
0065   //! Linear deflection used to tessellate the face interior
0066   Standard_Real                                    DeflectionInterior;
0067
0068   //! Minimum size parameter limiting size of triangle's edges to prevent
0069   //! sinking into amplification in case of distorted curves and surfaces.
0070   Standard_Real                                    MinSize;
0071
0072   //! Switches on/off multi-thread computation
0073   Standard_Boolean                                 InParallel;
0074
0075   //! Switches on/off relative computation of edge tolerance<br>
0076   //! If true, deflection used for the polygonalisation of each edge will be
0077   //! <defle> * Size of Edge. The deflection used for the faces will be the
0078   //! maximum deflection of their edges.
0079   Standard_Boolean                                 Relative;
0080
0081   //! Mode to take or not to take internal face vertices into account
0082   //! in triangulation process
0083   Standard_Boolean                                 InternalVerticesMode;
0084
0085   //! Parameter to check the deviation of triangulation and interior of
0086   //! the face
0087   Standard_Boolean                                 ControlSurfaceDeflection;
0088
0089   // Enables/disables check triggered by ControlSurfaceDeflection flag
0090   // for all types of surfaces including analytical.
0091   Standard_Boolean                                 EnableControlSurfaceDeflectionAllSurfaces;
0092
0093   //! Cleans temporary data model when algorithm is finished.
0094   Standard_Boolean                                 CleanModel;
0095
0096   //! Enables/disables local adjustment of min size depending on edge size.
0097   //! Disabled by default.
0098   Standard_Boolean                                 AdjustMinSize;
0099
0100   //! Enables/disables usage of shape tolerances for computing face deflection.
0101   //! Disabled by default.
0102   Standard_Boolean                                 ForceFaceDeflection;
0103
0104   //! Allows/forbids the decrease of the quality of the generated mesh
0105   //! over the existing one.
0106   Standard_Boolean                                 AllowQualityDecrease;
0107 };
0108
0109 #endif