idl/BLSURFPlugin_Algorithm.idl

   1 // Copyright (C) 2007-2016  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 // ---
  21 // File    : BLSURFPlugin_Algorithm.idl
  22 // Authors : Francis KLOSS (OCC) & Patrick LAUG (INRIA) & Lioka RAZAFINDRAZAKA (CEA)
  23 //           Size maps developement: Nicolas GEIMER (OCC) & Gilles DAVID (EURIWARE)
  24 // ---
  25 //
  26 #ifndef _SMESH_BLSURFALGORITHM_IDL_
  27 #define _SMESH_BLSURFALGORITHM_IDL_
  28
  29 #include "SMESH_Hypothesis.idl"
  30 #include "GEOM_Gen.idl"
  31 #include "SALOME_Exception.idl"
  32
  33 /*!
  34  * BLSURFPlugin: interfaces to BLSURF related hypotheses and algorithms
  35  */
  36 module BLSURFPlugin
  37 {
  38   typedef sequence<string> string_array;
  39
  40   // Enforced vertex name
  41   typedef string TEnfName;
  42   // Entry
  43   typedef string TEntry;
  44   typedef sequence<TEntry> TEntryList;
  45   // Group name
  46   typedef string TEnfGroupName;
  47
  48   // Coordinates of enforced vertex
  49   typedef sequence<double,3> TEnfVertexCoords;
  50   // List of coords
  51   typedef sequence<TEnfVertexCoords> TEnfVertexCoordsList;
  52
  53   // Enforced vertex
  54   struct TEnfVertex {
  55     TEnfName name;
  56     TEntry geomEntry;
  57     TEnfVertexCoords coords;
  58     TEnfGroupName grpName;
  59     TEntryList faceEntries;
  60   };
  61   // List of enforced vertices
  62   typedef sequence<TEnfVertex> TEnfVertexList;
  63
  64   // Map Face Entry / List of enforced vertices
  65   struct TFaceEntryEnfVertexListMapElement {
  66     TEntry faceEntry;
  67     TEnfVertexList enfVertexList;
  68   };
  69   typedef sequence<TFaceEntryEnfVertexListMapElement> TFaceEntryEnfVertexListMap;
  70
  71   // Map Face Entry / List of coords
  72   struct TFaceEntryCoordsListMapElement {
  73     TEntry faceEntry;
  74     TEnfVertexCoordsList coordsList;
  75   };
  76   typedef sequence<TFaceEntryCoordsListMapElement> TFaceEntryCoordsListMap;
  77
  78   // Map Face Entry / List of enf vertex entries
  79   struct TFaceEntryEnfVertexEntryListMapElement {
  80     TEntry faceEntry;
  81     TEntryList enfVertexEntryList;
  82   };
  83   typedef sequence<TFaceEntryEnfVertexEntryListMapElement> TFaceEntryEnfVertexEntryListMap;
  84
  85   // Map Coords / Enforced vertex
  86   struct TCoordsEnfVertexElement {
  87     TEnfVertexCoords coords;
  88     TEnfVertex enfVertex;
  89   };
  90   typedef sequence<TCoordsEnfVertexElement> TCoordsEnfVertexMap;
  91
  92   // Map Enf Vertex Entry / Enforced vertex
  93   struct TEnfVertexEntryEnfVertexElement {
  94     TEntry enfVertexEntry;
  95     TEnfVertex enfVertex;
  96   };
  97   typedef sequence<TEnfVertexEntryEnfVertexElement> TEnfVertexEntryEnfVertexMap;
  98
  99   // List of Face Entry with internal enforced vertices activated
 100   typedef sequence<TEntry> TFaceEntryInternalVerticesList;
 101
 102   // Attractors
 103   struct TAttractorParams {
 104     string faceEntry;
 105     string attEntry;
 106     double startSize;
 107     double endSize;
 108     double infDist;
 109     double constDist;
 110   };
 111   typedef sequence<TAttractorParams> TAttParamsMap;
 112
 113   // Periodicity
 114   struct TPreCadPeriodicity {
 115     TEntry shape1Entry;
 116     TEntry shape2Entry;
 117     TEntryList theSourceVerticesEntries;
 118     TEntryList theTargetVerticesEntries;
 119   };
 120
 121   typedef sequence<TPreCadPeriodicity> TPeriodicityList;
 122
 123   // Hyper-patches
 124   typedef sequence<long> THyperPatch;
 125   typedef sequence<THyperPatch> THyperPatchList;
 126
 127   /*!
 128    * BLSURFPlugin_BLSURF: interface of BLSURF algorithm
 129    */
 130   interface BLSURFPlugin_BLSURF : SMESH::SMESH_2D_Algo
 131   {
 132   };
 133
 134   /*!
 135    * BLSURFPlugin_Hypothesis: interface of "BLSURF parameters" hypothesis
 136    */
 137   interface BLSURFPlugin_Hypothesis : SMESH::SMESH_Hypothesis
 138   {
 139
 140     /*!
 141      * Sets a way to define size of mesh elements to generate
 142      * 0 - size is defined automatically
 143      * 1 - size is set by SetPhySize() method
 144      * 2 - size is set by SetPhySize() method. A sizemap is defined.
 145      */
 146     void SetPhysicalMesh(in long isCustom);
 147     long GetPhysicalMesh();
 148
 149     /*!
 150      * Sets a way to define maximum angular deflection of mesh from CAD model
 151      * 0 - deflection is defined automatically
 152      * 1 - deflection is set by SetAngleMesh() method
 153      * 2 - deflection is set by SetAngleMesh() method. A sizemap is defined (TODO).
 154      */
 155     void SetGeometricMesh(in long isCustom);
 156     long GetGeometricMesh();
 157
 158     /*!
 159      * Sets size of mesh elements to generate
 160      */
 161     void SetPhySize(in double size);
 162     void SetPhySizeRel(in double size);
 163     double GetPhySize();
 164     boolean IsPhySizeRel();
 165
 166     /*!
 167      * Sets lower boundary of mesh element size
 168      */
 169     void SetMinSize(in double theMinSize);
 170     void SetMinSizeRel(in double theMinSize);
 171     double GetMinSize();
 172     boolean IsMinSizeRel();
 173
 174     /*!
 175      * Sets upper boundary of mesh element size
 176      */
 177     void SetMaxSize(in double theMaxSize);
 178     void SetMaxSizeRel(in double theMaxSize);
 179     double GetMaxSize();
 180     boolean IsMaxSizeRel();
 181
 182     /*!
 183      * Sets maximal allowed ratio between the lengths of two adjacent edges
 184      */
 185     void SetUseGradation(in boolean toUse);
 186     boolean GetUseGradation();
 187     void SetGradation(in double ratio);
 188     double GetGradation();
 189
 190     /*!
 191      * Sets maximal allowed ratio between the lengths of two adjacent edges in 3D mesh
 192      */
 193     void SetUseVolumeGradation(in boolean toUse);
 194     boolean GetUseVolumeGradation();
 195     void SetVolumeGradation(in double ratio);
 196     double GetVolumeGradation();
 197
 198     /*!
 199      * Sets to create quadrilateral elements or not
 200      */
 201     void SetQuadAllowed(in boolean allowed);
 202     boolean GetQuadAllowed();
 203
 204     /*!
 205      * Sets angular deflection (in degrees) of a mesh face and edge from CAD surface
 206      */
 207     void SetAngleMesh(in double angle);
 208     double GetAngleMesh();
 209
 210     /*!
 211      * Sets the maximum desired distance between a triangle and its supporting CAD surface
 212      */
 213     void SetChordalError(in double distance);
 214     double GetChordalError();
 215
 216     /*!
 217      * Determines whether the generated mesh will be isotropic or anisotropic
 218      */
 219     void SetAnisotropic(in boolean anisotropic);
 220     boolean GetAnisotropic();
 221
 222     /*!
 223      * Defines the maximum anisotropic ratio of the metric governing the anisotropic process.
 224      * The default value of 0 means that the metric (and thus the generated elements)
 225      * can be arbitrarily stretched.
 226      */
 227     void SetAnisotropicRatio(in double ratio);
 228     double GetAnisotropicRatio();
 229
 230     /*!
 231      * This patch-independent correction option can be activated to remove the tiny
 232      * (nano) edges from the generated mesh, without taking into account the tags
 233      * (attributes) specifications.
 234      */
 235     void SetRemoveTinyEdges(in boolean remove);
 236     boolean GetRemoveTinyEdges();
 237
 238     /*!
 239      * Defines the minimal length under which an edge is considered to be a tiny one
 240      */
 241     void SetTinyEdgeLength(in double length);
 242     double GetTinyEdgeLength();
 243
 244     /*!
 245      *  This patch-independent correction option can be activated to remove the tiny
 246      * edges (defined by the option tiny edge optimisation length) from the generated
 247      * mesh when it improves the local mesh quality, without taking into account the
 248      * tags (attributes) specifications.
 249      */
 250     void SetOptimiseTinyEdges(in boolean toOptimise);
 251     boolean GetOptimiseTinyEdges();
 252
 253     /*!
 254      * Defines the minimal length under which an edge is considered to be a tiny one
 255      * to be optimised out by the optimise tiny edges option
 256      */
 257     void SetTinyEdgeOptimisationLength(in double length);
 258     double GetTinyEdgeOptimisationLength();
 259
 260     /*!
 261      * Activate correction of all surface intersections
 262      */
 263     void SetCorrectSurfaceIntersection(in boolean toCorrect);
 264     boolean GetCorrectSurfaceIntersection();
 265
 266     /*!
 267      * Defines the time the user is ready to spend in the intersection prevention process.
 268      * For example, maxCost = 3 means that MeshGems-CADSurf will not spend more time
 269      * in the intersection removal process than 3 times the time required to mesh
 270      * without processing the intersections.
 271      */
 272     void SetCorrectSurfaceIntersectionMaxCost(in double maxCost);
 273     double GetCorrectSurfaceIntersectionMaxCost();
 274
 275     /*!
 276      * This patch independent correction option can be activated to remove the bad
 277      * elements (often called slivers) from the generated mesh, without taking into account
 278      * the tags (attributes) specification.
 279      */
 280     void SetBadElementRemoval(in boolean remove);
 281     boolean GetBadElementRemoval();
 282
 283     /*!
 284      * This parameter defines the aspect ratio triggering the "bad element"
 285      * classification for the force bad surface element removal option.
 286      */
 287     void SetBadElementAspectRatio(in double ratio);
 288     double GetBadElementAspectRatio();
 289
 290     /*!
 291      * If this option is activated, MeshGems-CADSurf will optimize the mesh in order to
 292      * get better shaped elements, during a process which respects the patch independent options.
 293      * This optimisation cannot be fully performed when correct_surface_intersections = 1.
 294      */
 295     void SetOptimizeMesh(in boolean optimize);
 296     boolean GetOptimizeMesh();
 297
 298     /*!
 299      * Determines the order of mesh elements to be generated (linear or quadratic)
 300      */
 301     void SetQuadraticMesh(in boolean quadratic);
 302     boolean GetQuadraticMesh();
 303
 304     /*!
 305      * Sets topology usage way defining how mesh conformity is assured
 306      * value=0 - mesh conformity is assured by conformity of a shape
 307      * value=1,2 - mesh conformity is assured by pre-processing a CAD model (OBSOLETE)
 308      * value=3 - mesh conformity is assured by pre-processing a CAD model with Pre-CAD
 309      */
 310     void SetTopology(in long way);
 311     long GetTopology();
 312
 313     /*!
 314      * Sets verbosity level in the range 0 to 100.
 315      */
 316     void SetVerbosity(in short theVal) raises (SALOME::SALOME_Exception);
 317     short GetVerbosity();
 318
 319     /*!
 320      * Set enforce_cad_edge_sizes parameter
 321      *
 322      * Relaxes the given sizemap constraint around CAD edges to allow a better
 323      * element quality and a better geometric approximation. It is only useful in
 324      * combination with the gradation option.
 325      */
 326     void SetEnforceCadEdgesSize( in boolean toEnforce );
 327     boolean GetEnforceCadEdgesSize();
 328
 329     /*!
 330      * Set jacobian_rectification_respect_geometry parameter
 331      *
 332      * While making the mesh quadratic, allows to lose the CAD-mesh associativity in order
 333      * to correct elements with nagative Jacobian
 334      */
 335     void SetJacobianRectificationRespectGeometry( in boolean allowRectification );
 336     boolean GetJacobianRectificationRespectGeometry();
 337
 338     /*!
 339      * Set rectify_jacobian parameter
 340      *
 341      * While making the mesh quadratic, allow to fix nagative Jacobian surface elements
 342      */
 343     void SetJacobianRectification( in boolean allowRectification );
 344     boolean GetJacobianRectification();
 345
 346     /*!
 347      * Set use_deprecated_patch_mesher parameter (compatibility with older versions of Meshgems)
 348      *
 349      * the use_deprecated_patch_mesher parameter allows to keep the same behaviour than
 350      * in salome < 8.3 (meshgems 2.1.11 instead of meshgems >= 2.4.5)
 351      */
 352     void SetUseDeprecatedPatchMesher( in boolean useDeprecatedPatchMesher );
 353     boolean GetUseDeprecatedPatchMesher();
 354
 355     /*!
 356      * Set max_number_of_points_per_patch parameter
 357      *
 358      * This parameter controls the maximum amount of points MeshGems-CADSurf is allowed
 359      * to generate on a single CAD patch. For an automatic gestion of the memory, one
 360      * can set this parameter to 0
 361      */
 362     void SetMaxNumberOfPointsPerPatch( in long nb ) raises (SALOME::SALOME_Exception);
 363     long GetMaxNumberOfPointsPerPatch();
 364
 365
 366     /*!
 367      * Set max_number_of_threads parameter
 368      *
 369      * Set the maximum of threads to use for multithreading mesh computation.
 370      */
 371     void SetMaxNumberOfThreads( in long nb ) raises (SALOME::SALOME_Exception);
 372     long GetMaxNumberOfThreads();
 373
 374     /*!
 375      * Set respect_geometry parameter
 376      *
 377      *  This patch independent option can be deactivated to allow MeshGems-CADSurf
 378      * to lower the geometry accuracy in its patch independent process.
 379      */
 380     void SetRespectGeometry( in boolean toRespect );
 381     boolean GetRespectGeometry();
 382
 383     /*!
 384      * Set tiny_edges_avoid_surface_intersections parameter
 385      *
 386      * This option defines the priority between the tiny feature
 387      * suppression and the surface intersection prevention.
 388      */
 389     void SetTinyEdgesAvoidSurfaceIntersections( in boolean toAvoidIntersection );
 390     boolean GetTinyEdgesAvoidSurfaceIntersections();
 391
 392     /*!
 393      * Set closed_geometry parameter parameter
 394      *
 395      *  Describes whether the geometry is expected to be closed or not.
 396      * When activated, this option helps MeshGems-PreCAD to treat the dirtiest geometries.
 397      */
 398     void SetClosedGeometry( in boolean isClosed );
 399     boolean GetClosedGeometry();
 400
 401     /*!
 402      * Set debug parameter
 403      *
 404      * Make MeshGems-CADSurf will be very verbose and will output some intermediate
 405      * files in the working directory. This option is mainly meant for Distene support issues.
 406      */
 407     void SetDebug( in boolean isDebug );
 408     boolean GetDebug();
 409
 410     /*!
 411      * Set periodic_tolerance parameter
 412      *
 413      *  This parameter defines the maximum size difference between two periodic edges
 414      * and also the maximum distance error between two periodic entities.
 415      */
 416     void SetPeriodicTolerance( in double tol ) raises (SALOME::SALOME_Exception);
 417     double GetPeriodicTolerance() raises (SALOME::SALOME_Exception);
 418
 419     /*!
 420      * Set required_entities parameter
 421      *
 422      * The required entities control the correction operations.
 423      * Accepted values for this parameter are :
 424      * - "respect" : MeshGems-CADSurf is not allowed to alter any required entity,
 425      *             even for correction purposes,
 426      * - "ignore" : MeshGems-CADSurf will ignore the required entities in its processing,
 427      * - "clear" : MeshGems-CADSurf will clear any required status for the entities.
 428      *           There will not be any entity marked as required in the generated mesh.
 429      */
 430     void SetRequiredEntities( in string howToTreat ) raises (SALOME::SALOME_Exception);
 431     string GetRequiredEntities();
 432
 433     /*!
 434      * Set sewing_tolerance parameter
 435      *
 436      * This parameter is the tolerance of the assembly.
 437      */
 438     void SetSewingTolerance( in double tol ) raises (SALOME::SALOME_Exception);
 439     double GetSewingTolerance() raises (SALOME::SALOME_Exception);
 440
 441     /*!
 442      * Set tags parameter
 443      *
 444      *  The tag (attribute) system controls the optimisation process.
 445      *  Accepted values for this parameter are :
 446      * - "respect"  : the CAD tags will be preserved and unaltered by the optimisation operations,
 447      * - "ignore" : the CAD tags will be ignored by the optimisation operations
 448      *              but they will still be present in the output mesh,
 449      * - "clear" : MeshGems-CADSurf will clear any tag on any entity and optimise accordingly.
 450      *             There will not be any tag in the generated mesh.
 451      */
 452     void SetTags( in string howToTreat ) raises (SALOME::SALOME_Exception);
 453     string GetTags();
 454
 455     /*!
 456      * Set hyper-patches
 457      */
 458     void SetHyperPatches(in THyperPatchList hpl);
 459     THyperPatchList GetHyperPatches();
 460
 461     /*!
 462      * To merges edges.
 463      */
 464     void SetPreCADMergeEdges(in boolean toMergeEdges);
 465     boolean GetPreCADMergeEdges();
 466
 467     /*!
 468      * To remove duplicate CAD faces.
 469      */
 470     void SetPreCADRemoveDuplicateCADFaces(in boolean toRemoveDuplicateCADFaces);
 471     boolean GetPreCADRemoveDuplicateCADFaces();
 472
 473     /*!
 474      * To process 3D topology.
 475      */
 476     void SetPreCADProcess3DTopology(in boolean toProcess);
 477     boolean GetPreCADProcess3DTopology();
 478
 479
 480     /*!
 481      * To compute topology from scratch
 482      */
 483     void SetPreCADDiscardInput(in boolean toDiscardInput);
 484     boolean GetPreCADDiscardInput();
 485
 486     /*!
 487      * Sets advanced option value
 488      */
 489     void SetOptionValue(in string optionName,
 490                         in string optionValue) raises (SALOME::SALOME_Exception);
 491     void SetPreCADOptionValue(in string optionName,
 492                         in string optionValue) raises (SALOME::SALOME_Exception);
 493     string GetOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
 494     string GetPreCADOptionValue(in string optionName) raises (SALOME::SALOME_Exception);
 495     /*!
 496      * Unsets advanced option
 497      */
 498     void UnsetOption(in string optionName);
 499     void UnsetPreCADOption(in string optionName);
 500
 501     /*!
 502      * Adds custom advanced option and its value
 503      */
 504     void SetAdvancedOption(in string optionsAndValues) // in a form "option_1 v1 option_2 v2'"
 505       raises (SALOME::SALOME_Exception);
 506     void AddOption(in string optionName, in string optionValue);
 507     void AddPreCADOption(in string optionName, in string optionValue);
 508     string GetOption(in string optionName);
 509     string GetPreCADOption(in string optionName);
 510
 511     /*!
 512      * Return array of strings each of which is option name concatenated
 513      * with option value devided by semicolon - "option_name:option_value:option_type".
 514      * Option value is empty if an option is not set.
 515      * option_type: 1 if user-define, 0 if default
 516      * Note: the method is mostly for interaction with GUI.
 517      */
 518     string_array GetOptionValues();
 519     string_array GetPreCADOptionValues();
 520     string_array GetAdvancedOptionValues();
 521
 522     /*!
 523      * Set option values each in the form "option_name[:option_value][:option_type]".
 524      * Note: the method is mostly for interaction with GUI.
 525      */
 526     void SetOptionValues(in string_array options) raises (SALOME::SALOME_Exception);
 527     void SetPreCADOptionValues(in string_array options) raises (SALOME::SALOME_Exception);
 528     void SetAdvancedOptionValues(in string_array options);
 529
 530     /*!
 531      * SizeMap
 532      */
 533     void SetSizeMapEntries(in string_array sizeMaps) raises (SALOME::SALOME_Exception);
 534     void ClearSizeMaps();
 535
 536     void UnsetEntry(in string entry);
 537
 538     /*!
 539      * Set/unset a SizeMap on geom object
 540      */
 541     void         SetSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap) raises (SALOME::SALOME_Exception);
 542     void         SetConstantSizeMap(in GEOM::GEOM_Object GeomObj, in double sizeMap);
 543     void         UnsetSizeMap(in GEOM::GEOM_Object GeomObj);
 544
 545     /*!
 546      * Set a SizeMap on geom object given by entry
 547      */
 548     void         SetSizeMapEntry(in string entry, in string sizeMap) raises (SALOME::SALOME_Exception);
 549     void         SetConstantSizeMapEntry(in string entry, in GEOM::shape_type shapeType, in double sizeMap) raises (SALOME::SALOME_Exception);
 550     string       GetSizeMapEntry(in string entry) raises (SALOME::SALOME_Exception);
 551     string_array GetSizeMapEntries();
 552
 553     /*!
 554      * Set/unset an attractor on geom object
 555      */
 556     void         SetAttractor(in GEOM::GEOM_Object GeomObj, in string attractor);
 557     void         UnsetAttractor(in GEOM::GEOM_Object GeomObj);
 558
 559     /*!
 560      * Set an attractor on geom object given by entry
 561      */
 562     void         SetAttractorEntry(in string entry, in string attractor) raises (SALOME::SALOME_Exception);
 563     string       GetAttractorEntry(in string entry) raises (SALOME::SALOME_Exception);
 564     string_array GetAttractorEntries();
 565
 566     /*!
 567      * Set/unset an attractor given as geom object on another geom object
 568      */
 569     void         SetAttractorGeom(in GEOM::GEOM_Object GeomObj, in GEOM::GEOM_Object AttractorShape, in double StartSize, in double EndSize, in double ActionRadius, in double ConstantRadius);
 570     void         UnsetAttractorGeom(in GEOM::GEOM_Object GeomObj, in GEOM::GEOM_Object AttractorShape);
 571     void         UnsetAttractorEntry(in string entry, in string attractor);
 572
 573     /*!
 574      * Set an attractor given by entry on a geom object given by entry
 575      */
 576     void         SetClassAttractorEntry(in string entry, in string att_entry, in double StartSize, in double EndSize, in double ActionRadius, in double ConstantRadius ) raises (SALOME::SALOME_Exception);
 577     BLSURFPlugin::TAttParamsMap GetAttractorParams();
 578
 579 /*
 580     void         SetCustomSizeMapEntry(in string entry, in string sizeMap);
 581     string       GetCustomSizeMapEntry(in string entry);
 582     void         SetCustomSizeMap(in GEOM::GEOM_Object GeomObj, in string sizeMap);
 583     void         UnsetCustomSizeMap(in GEOM::GEOM_Object GeomObj);
 584     string_array GetCustomSizeMapEntries();
 585 */
 586     ///////////////////////
 587     // ENFORCED VERTEXES //
 588     ///////////////////////
 589
 590     TFaceEntryEnfVertexListMap      GetAllEnforcedVerticesByFace();
 591     TEnfVertexList                  GetAllEnforcedVertices();
 592
 593     TFaceEntryCoordsListMap         GetAllCoordsByFace();
 594     TCoordsEnfVertexMap             GetAllEnforcedVerticesByCoords();
 595
 596     TFaceEntryEnfVertexEntryListMap GetAllEnfVertexEntriesByFace();
 597     TEnfVertexEntryEnfVertexMap     GetAllEnforcedVerticesByEnfVertexEntry();
 598
 599     void                            ClearAllEnforcedVertices();
 600
 601    /*!
 602     * Set/get/unset an enforced vertex on geom face
 603     */
 604     // OBSOLETE
 605     boolean SetEnforcedVertex(in GEOM::GEOM_Object theFace, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 606     boolean SetEnforcedVertexNamed(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfName theVertexName) raises (SALOME::SALOME_Exception);
 607     boolean SetEnforcedVertexGeom(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 608     boolean SetEnforcedVertexWithGroup(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 609     boolean SetEnforcedVertexNamedWithGroup(in GEOM::GEOM_Object theFace, in double x, in double y, in double z, in TEnfName theVertexName, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 610     boolean SetEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 611
 612     TEnfVertexList GetEnforcedVertices(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 613     boolean UnsetEnforcedVertex(in GEOM::GEOM_Object theFace, in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 614     boolean UnsetEnforcedVertexGeom(in GEOM::GEOM_Object theFace, in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 615     boolean UnsetEnforcedVertices(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 616
 617     // NEW - no face
 618     boolean AddEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 619     boolean AddEnforcedVertexNamed(in double x, in double y, in double z, in TEnfName theVertexName) raises (SALOME::SALOME_Exception);
 620     boolean AddEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 621     boolean AddEnforcedVertexWithGroup(in double x, in double y, in double z, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 622     boolean AddEnforcedVertexNamedWithGroup(in double x, in double y, in double z, in TEnfName theVertexName, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 623     boolean AddEnforcedVertexGeomWithGroup(in GEOM::GEOM_Object theVertex, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 624
 625     boolean RemoveEnforcedVertex(in double x, in double y, in double z) raises (SALOME::SALOME_Exception);
 626     boolean RemoveEnforcedVertexGeom(in GEOM::GEOM_Object theVertex) raises (SALOME::SALOME_Exception);
 627     boolean RemoveEnforcedVertices() raises (SALOME::SALOME_Exception);
 628
 629     /*!
 630      * Set/get/unset an enforced vertex on geom face given by entry
 631      */
 632     boolean SetEnforcedVertexEntry(in TEntry theFaceEntry, in double x, in double y, in double z,
 633                                    in TEnfName theVertexName, in TEntry theVertexEntry, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 634
 635     TEnfVertexList GetEnforcedVerticesEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 636     boolean UnsetEnforcedVertexEntry(in TEntry theFaceEntry, in double x, in double y, in double z, in TEntry theVertexEntry) raises (SALOME::SALOME_Exception);
 637 //    boolean UnsetEnforcedVertexEntryGeom(in TEntry theFaceEntry, in TEntry theVertexEntry) raises (SALOME::SALOME_Exception);
 638     boolean UnsetEnforcedVerticesEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 639
 640     /*!
 641      * To get/set internal vertices as enforced vertices
 642      */
 643     void          SetInternalEnforcedVertexAllFaces(in boolean toEnforceInternalVertices);
 644     boolean       GetInternalEnforcedVertexAllFaces();
 645     void          SetInternalEnforcedVertexAllFacesGroup(in TEnfGroupName groupName);
 646     TEnfGroupName GetInternalEnforcedVertexAllFacesGroup();
 647
 648 //  Enable internal enforced vertices on specific face if requested by user
 649 //    void          SetInternalEnforcedVertex(in GEOM::GEOM_Object theFace,in boolean toEnforceInternalVertices) raises (SALOME::SALOME_Exception);
 650 //    void          SetInternalEnforcedVertexWithGroup(in GEOM::GEOM_Object theFace, in boolean toEnforceInternalVertices, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 651 //    void          SetInternalEnforcedVertexEntry(in TEntry theFaceEntry, in boolean toEnforceInternalVertices, in TEnfGroupName groupName) raises (SALOME::SALOME_Exception);
 652 //    boolean       GetInternalEnforcedVertex(in GEOM::GEOM_Object theFace) raises (SALOME::SALOME_Exception);
 653 //    boolean       GetInternalEnforcedVertexEntry(in TEntry theFaceEntry) raises (SALOME::SALOME_Exception);
 654 //    TFaceEntryInternalVerticesList GetAllInternalEnforcedVerticesFaces();
 655     ///////////////////////
 656
 657
 658     ///////////////////////
 659     // PERIODICITY       //
 660     ///////////////////////
 661
 662     void ClearPreCadPeriodicityVectors();
 663     void AddPreCadFacesPeriodicity(in GEOM::GEOM_Object theFace1, in GEOM::GEOM_Object theFace2) raises (SALOME::SALOME_Exception);
 664     void AddPreCadFacesPeriodicityWithVertices(in GEOM::GEOM_Object theFace1, in GEOM::GEOM_Object theFace2, in GEOM::ListOfGO theSourceVertices, in GEOM::ListOfGO theTargetVertices) raises (SALOME::SALOME_Exception);
 665     void AddPreCadFacesPeriodicityEntry(in TEntry theFace1, in TEntry theFace2, in TEntryList theSourceVertices, in TEntryList theTargetVertices)  raises (SALOME::SALOME_Exception);
 666     void AddPreCadEdgesPeriodicity(in GEOM::GEOM_Object theEdge1, in GEOM::GEOM_Object theEdge2) raises (SALOME::SALOME_Exception);
 667     void AddPreCadEdgesPeriodicityWithVertices(in GEOM::GEOM_Object theEdge1, in GEOM::GEOM_Object theEdge2, in GEOM::ListOfGO theSourceVertices, in GEOM::ListOfGO theTargetVertices) raises (SALOME::SALOME_Exception);
 668     void AddPreCadEdgesPeriodicityEntry(in TEntry theEdge1, in TEntry theEdge2, in TEntryList theSourceVertices, in TEntryList theTargetVertices)  raises (SALOME::SALOME_Exception);
 669     TPeriodicityList GetPreCadFacesPeriodicityVector();
 670     TPeriodicityList GetPreCadEdgesPeriodicityVector();
 671     ///////////////////////
 672
 673     /*!
 674      * Sets the file for export resulting mesh in GMF format
 675      */
 676 //     void SetGMFFile(in string theFileName, in boolean isBinary);
 677     void SetGMFFile(in string theFileName);
 678     string GetGMFFile();
 679 //     boolean GetGMFFileMode();
 680
 681     //
 682     // Obsolete methods - To be removed in V7
 683     //
 684     void SetPhyMin(in double theMinSize);
 685     double GetPhyMin();
 686     void SetPhyMax(in double theMaxSize);
 687     double GetPhyMax();
 688     void SetGeoMin(in double theMinSize);
 689     double GetGeoMin();
 690     void SetGeoMax(in double theMaxSize);
 691     double GetGeoMax();
 692     void SetAngleMeshS(in double angle);
 693     double GetAngleMeshS();
 694     void SetAngleMeshC(in double angle);
 695     double GetAngleMeshC();
 696     void SetDecimesh(in boolean toIgnoreEdges);
 697     boolean GetDecimesh();
 698     void SetPreCADRemoveNanoEdges(in boolean toRemoveNanoEdges);
 699     boolean GetPreCADRemoveNanoEdges();
 700     void SetPreCADEpsNano(in double epsNano);
 701     double GetPreCADEpsNano();
 702   };
 703 };
 704
 705 #endif