doc/salome/gui/SMESH/input/modules.rst

   1 ########################
   2 Structured documentation
   3 ########################
   4
   5 .. contents::
   6
   7 .. currentmodule:: smeshBuilder
   8
   9 ***************
  10 Creating meshes
  11 ***************
  12
  13 .. autosummary::
  14
  15    smeshBuilder.Concatenate
  16    smeshBuilder.CopyMesh
  17
  18 Importing and exporting meshes
  19 ==============================
  20
  21 .. autosummary::
  22
  23    smeshBuilder.CreateMeshesFromUNV
  24    smeshBuilder.CreateMeshesFromMED
  25    smeshBuilder.CreateMeshesFromSTL
  26    smeshBuilder.CreateMeshesFromCGNS
  27    smeshBuilder.CreateMeshesFromGMF
  28    smeshBuilder.CreateMeshesFromSAUV
  29    Mesh.ExportMED
  30    Mesh.ExportUNV
  31    Mesh.ExportSTL
  32    Mesh.ExportCGNS
  33    Mesh.ExportDAT
  34    Mesh.ExportSAUV
  35    Mesh.ExportGMF
  36
  37
  38 Constructing meshes
  39 ===================
  40
  41 .. autosummary::
  42
  43    smeshBuilder.Mesh
  44    Mesh.SetName
  45    Mesh.SetMeshOrder
  46    Mesh.Compute
  47    Mesh.Evaluate
  48    Mesh.Clear
  49    Mesh.GetMesh
  50    Mesh.GetShape
  51    Mesh.HasShapeToMesh
  52    Mesh.GetComputeErrors
  53    Mesh.GetAlgoState
  54    Mesh.GetFailedShapes
  55    Mesh.GetMeshOrder
  56
  57 Defining Algorithms
  58 ===================
  59
  60 .. autosummary::
  61
  62    Mesh.Segment
  63    Mesh.Triangle
  64    Mesh.Quadrangle
  65    Mesh.Hexahedron
  66    Mesh.Prism
  67    Mesh.BodyFitted
  68    Mesh.Projection1D
  69    Mesh.Projection2D
  70    Mesh.Projection1D2D
  71    Mesh.Projection3D
  72    Mesh.UseExisting1DElements
  73    Mesh.UseExisting2DElements
  74    Mesh.UseExistingSegments
  75    Mesh.UseExistingFaces
  76    Mesh.AutomaticTetrahedralization
  77    Mesh.AutomaticHexahedralization
  78    smesh_algorithm.Mesh_Algorithm
  79
  80 Defining hypotheses
  81 ===================
  82
  83 .. currentmodule:: StdMeshersBuilder
  84
  85 1D Meshing Hypotheses
  86 ---------------------
  87
  88 .. autosummary::
  89
  90    StdMeshersBuilder_Segment.NumberOfSegments
  91    StdMeshersBuilder_Segment.LocalLength
  92    StdMeshersBuilder_Segment.MaxSize
  93    StdMeshersBuilder_Segment.Arithmetic1D
  94    StdMeshersBuilder_Segment.GeometricProgression
  95    StdMeshersBuilder_Segment.FixedPoints1D
  96    StdMeshersBuilder_Segment.StartEndLength
  97    StdMeshersBuilder_Segment.Adaptive
  98    StdMeshersBuilder_Segment.Deflection1D
  99    StdMeshersBuilder_Segment.AutomaticLength
 100    StdMeshersBuilder_Segment_Python.PythonSplit1D
 101
 102 2D Meshing Hypotheses
 103 ---------------------
 104
 105 .. autosummary::
 106
 107    StdMeshersBuilder_Triangle_MEFISTO.MaxElementArea
 108    StdMeshersBuilder_Triangle_MEFISTO.LengthFromEdges
 109    StdMeshersBuilder_Quadrangle.QuadrangleParameters
 110    StdMeshersBuilder_Quadrangle.QuadranglePreference
 111    StdMeshersBuilder_Quadrangle.TrianglePreference
 112    StdMeshersBuilder_Quadrangle.Reduced
 113    StdMeshersBuilder_Quadrangle.TriangleVertex
 114
 115 Additional Hypotheses
 116 ---------------------
 117
 118 .. autosummary::
 119
 120    smesh_algorithm.Mesh_Algorithm.ViscousLayers
 121    smesh_algorithm.Mesh_Algorithm.ViscousLayers2D
 122    StdMeshersBuilder.StdMeshersBuilder_Segment.Propagation
 123    StdMeshersBuilder.StdMeshersBuilder_Segment.PropagationOfDistribution
 124    StdMeshersBuilder.StdMeshersBuilder_Segment.QuadraticMesh
 125
 126 Constructing sub-meshes
 127 =======================
 128
 129 .. currentmodule:: smeshBuilder
 130
 131 .. autosummary::
 132
 133    Mesh.GetSubMesh
 134    Mesh.ClearSubMesh
 135
 136 Editing Meshes
 137 ==============
 138
 139 .. autosummary::
 140
 141    Mesh.AddHypothesis
 142    Mesh.RemoveHypothesis
 143    Mesh.RemoveGlobalHypotheses
 144    Mesh.GetHypothesisList
 145    Mesh.IsUsedHypothesis
 146
 147 *****************
 148 Grouping elements
 149 *****************
 150
 151 .. autosummary::
 152
 153    Mesh.SetAutoColor
 154    Mesh.GetAutoColor
 155    Mesh.HasDuplicatedGroupNamesMED
 156
 157 Creating groups
 158 ===============
 159
 160 .. autosummary::
 161
 162    Mesh.CreateEmptyGroup
 163    Mesh.Group
 164    Mesh.GroupOnGeom
 165    Mesh.GroupOnFilter
 166    Mesh.MakeGroupByIds
 167    Mesh.MakeGroup
 168    Mesh.MakeGroupByCriterion
 169    Mesh.MakeGroupByCriteria
 170    Mesh.MakeGroupByFilter
 171    Mesh.FaceGroupsSeparatedByEdges
 172    Mesh.CreateDimGroup
 173    Mesh.ConvertToStandalone
 174    Mesh.GetGroups
 175    Mesh.NbGroups
 176    Mesh.GetGroupNames
 177    Mesh.GetGroupByName
 178
 179
 180 Operations on groups
 181 ====================
 182
 183 .. autosummary::
 184
 185    Mesh.UnionGroups
 186    Mesh.UnionListOfGroups
 187    Mesh.IntersectGroups
 188    Mesh.IntersectListOfGroups
 189    Mesh.CutGroups
 190    Mesh.CutListOfGroups
 191
 192 Deleting Groups
 193 ===============
 194
 195 .. autosummary::
 196
 197    Mesh.RemoveGroup
 198    Mesh.RemoveGroupWithContents
 199
 200 ****************
 201 Mesh Information
 202 ****************
 203
 204 .. autosummary::
 205
 206    smeshBuilder.GetMeshInfo
 207    Mesh.GetEngine
 208    Mesh.GetGeomEngine
 209    Mesh.GetGeometryByMeshElement
 210    Mesh.MeshDimension
 211    Mesh.GetMeshInfo
 212    Mesh.NbNodes
 213    Mesh.NbElements
 214    Mesh.Nb0DElements
 215    Mesh.NbBalls
 216    Mesh.NbEdges
 217    Mesh.NbEdgesOfOrder
 218    Mesh.NbFaces
 219    Mesh.NbFacesOfOrder
 220    Mesh.NbTriangles
 221    Mesh.NbTrianglesOfOrder
 222    Mesh.NbBiQuadTriangles
 223    Mesh.NbQuadrangles
 224    Mesh.NbQuadranglesOfOrder
 225    Mesh.NbBiQuadQuadrangles
 226    Mesh.NbPolygons
 227    Mesh.NbVolumes
 228    Mesh.NbVolumesOfOrder
 229    Mesh.NbTetras
 230    Mesh.NbTetrasOfOrder
 231    Mesh.NbHexas
 232    Mesh.NbHexasOfOrder
 233    Mesh.NbTriQuadraticHexas
 234    Mesh.NbPyramids
 235    Mesh.NbPyramidsOfOrder
 236    Mesh.NbPrisms
 237    Mesh.NbPrismsOfOrder
 238    Mesh.NbHexagonalPrisms
 239    Mesh.NbPolyhedrons
 240    Mesh.NbSubMesh
 241    Mesh.GetNodesId
 242    Mesh.GetElementsId
 243    Mesh.GetElementsByType
 244    Mesh.GetElementType
 245    Mesh.GetElementGeomType
 246    Mesh.GetElementShape
 247    Mesh.GetSubMeshElementsId
 248    Mesh.GetSubMeshNodesId
 249    Mesh.GetSubMeshElementType
 250    Mesh.GetNodeXYZ
 251    Mesh.GetNodeInverseElements
 252    Mesh.GetNodePosition
 253    Mesh.GetElementPosition
 254    Mesh.GetShapeID
 255    Mesh.GetShapeIDForElem
 256    Mesh.GetElemNbNodes
 257    Mesh.GetElemNode
 258    Mesh.GetElemNodes
 259    Mesh.IsMediumNode
 260    Mesh.IsMediumNodeOfAnyElem
 261    Mesh.ElemNbEdges
 262    Mesh.ElemNbFaces
 263    Mesh.GetElemFaceNodes
 264    Mesh.GetFaceNormal
 265    Mesh.FindElementByNodes
 266    Mesh.GetElementsByNodes
 267    Mesh.IsPoly
 268    Mesh.IsQuadratic
 269    Mesh.GetBallDiameter
 270    Mesh.BaryCenter
 271    Mesh.FindNodeClosestTo
 272    Mesh.FindElementsByPoint
 273    Mesh.GetPointState
 274    Mesh.Get1DBranches
 275    Mesh.Dump
 276
 277 ******************************
 278 Quality controls and Filtering
 279 ******************************
 280
 281 .. autosummary::
 282
 283    smeshBuilder.GetEmptyCriterion
 284    smeshBuilder.GetCriterion
 285    smeshBuilder.GetFilter
 286    smeshBuilder.GetFilterFromCriteria
 287    smeshBuilder.GetFunctor
 288    Mesh.GetIdsFromFilter
 289    Mesh.GetMaxElementLength
 290    Mesh.GetAspectRatio
 291    Mesh.GetWarping
 292    Mesh.GetMinimumAngle
 293    Mesh.GetTaper
 294    Mesh.GetSkew
 295    Mesh.GetMinMax
 296    Mesh.IsManifold
 297    Mesh.IsCoherentOrientation2D
 298
 299 ************
 300 Measurements
 301 ************
 302
 303 .. autosummary::
 304
 305    smeshBuilder.MinDistance
 306    smeshBuilder.GetMinDistance
 307    smeshBuilder.BoundingBox
 308    smeshBuilder.GetBoundingBox
 309    smeshBuilder.GetLength
 310    smeshBuilder.GetArea
 311    smeshBuilder.GetVolume
 312    smeshBuilder.GetAngle
 313    Mesh.GetFreeBorders
 314    Mesh.MinDistance
 315    Mesh.GetMinDistance
 316    Mesh.BoundingBox
 317    Mesh.GetBoundingBox
 318    Mesh.GetFunctor
 319    Mesh.FunctorValue
 320    Mesh.GetLength
 321    Mesh.GetArea
 322    Mesh.GetVolume
 323    Mesh.GetAngle
 324
 325 ****************
 326 Modifying meshes
 327 ****************
 328
 329 .. autosummary::
 330
 331    smeshBuilder.GetPattern
 332    Mesh.GetMeshEditor
 333
 334 Adding nodes and elements
 335 =========================
 336
 337 .. autosummary::
 338
 339    Mesh.AddNode
 340    Mesh.Add0DElement
 341    Mesh.Add0DElementsToAllNodes
 342    Mesh.AddBall
 343    Mesh.AddEdge
 344    Mesh.AddFace
 345    Mesh.AddPolygonalFace
 346    Mesh.AddQuadPolygonalFace
 347    Mesh.AddVolume
 348    Mesh.AddPolyhedralVolume
 349    Mesh.AddPolyhedralVolumeByFaces
 350    Mesh.SetNodeOnVertex
 351    Mesh.SetNodeOnEdge
 352    Mesh.SetNodeOnFace
 353    Mesh.SetNodeInVolume
 354    Mesh.SetMeshElementOnShape
 355    Mesh.Make2DMeshFrom3D
 356    Mesh.MakeBoundaryMesh
 357    Mesh.MakeBoundaryElements
 358    Mesh.Append
 359    Mesh.GetLastCreatedNodes
 360    Mesh.GetLastCreatedElems
 361    Mesh.ClearLastCreated
 362
 363 Removing nodes and elements
 364 ===========================
 365
 366 .. autosummary::
 367
 368    Mesh.RemoveElements
 369    Mesh.RemoveNodes
 370    Mesh.RemoveOrphanNodes
 371
 372 Modifying nodes and elements
 373 ============================
 374
 375 .. autosummary::
 376
 377    Mesh.MoveNode
 378    Mesh.MoveClosestNodeToPoint
 379    Mesh.MeshToPassThroughAPoint
 380    Mesh.ChangeElemNodes
 381
 382 Convert to/from Quadratic Mesh
 383 ==============================
 384
 385 .. autosummary::
 386
 387    Mesh.ConvertToQuadratic
 388    Mesh.ConvertFromQuadratic
 389
 390 Extrusion and Revolution
 391 ========================
 392
 393 .. autosummary::
 394
 395    Mesh.RotationSweepObjects
 396    Mesh.RotationSweep
 397    Mesh.RotationSweepObject
 398    Mesh.RotationSweepObject1D
 399    Mesh.RotationSweepObject2D
 400    Mesh.ExtrusionSweepObjects
 401    Mesh.ExtrusionSweep
 402    Mesh.ExtrusionByNormal
 403    Mesh.ExtrusionSweepObject
 404    Mesh.ExtrusionSweepObject1D
 405    Mesh.ExtrusionSweepObject2D
 406    Mesh.AdvancedExtrusion
 407    Mesh.ExtrusionAlongPathObjects
 408    Mesh.ExtrusionAlongPathX
 409    Mesh.ExtrusionAlongPath
 410    Mesh.ExtrusionAlongPathObject
 411    Mesh.ExtrusionAlongPathObject1D
 412    Mesh.ExtrusionAlongPathObject2D
 413
 414 Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
 415 ======================================================================
 416
 417 .. autosummary::
 418
 419    Mesh.Mirror
 420    Mesh.MirrorMakeMesh
 421    Mesh.MirrorObject
 422    Mesh.MirrorObjectMakeMesh
 423    Mesh.Translate
 424    Mesh.TranslateMakeMesh
 425    Mesh.TranslateObject
 426    Mesh.TranslateObjectMakeMesh
 427    Mesh.Rotate
 428    Mesh.RotateMakeMesh
 429    Mesh.RotateObject
 430    Mesh.RotateObjectMakeMesh
 431    Mesh.FindCoincidentNodes
 432    Mesh.FindCoincidentNodesOnPart
 433    Mesh.MergeNodes
 434    Mesh.FindEqualElements
 435    Mesh.MergeElements
 436    Mesh.MergeEqualElements
 437    Mesh.FindFreeBorders
 438    Mesh.FillHole
 439    Mesh.FindCoincidentFreeBorders
 440    Mesh.SewCoincidentFreeBorders
 441    Mesh.SewFreeBorders
 442    Mesh.SewConformFreeBorders
 443    Mesh.SewBorderToSide
 444    Mesh.SewSideElements
 445
 446 Changing orientation of elements
 447 ================================
 448
 449 .. autosummary::
 450
 451    Mesh.Reorient
 452    Mesh.ReorientObject
 453    Mesh.Reorient2D
 454    Mesh.Reorient2DBy3D
 455
 456 Uniting triangles
 457 =================
 458
 459 .. autosummary::
 460
 461    Mesh.DeleteDiag
 462    Mesh.TriToQuad
 463    Mesh.TriToQuadObject
 464
 465 Cutting elements
 466 ================
 467
 468 .. autosummary::
 469
 470    Mesh.InverseDiag
 471    Mesh.QuadToTri
 472    Mesh.QuadToTriObject
 473    Mesh.QuadTo4Tri
 474    Mesh.SplitQuad
 475    Mesh.SplitQuadObject
 476    Mesh.BestSplit
 477    Mesh.SplitVolumesIntoTetra
 478    Mesh.SplitBiQuadraticIntoLinear
 479    Mesh.SplitHexahedraIntoPrisms
 480    Mesh.SplitQuadsNearTriangularFacets
 481    Mesh.SplitHexaToTetras
 482    Mesh.SplitHexaToPrisms
 483
 484 Smoothing
 485 =========
 486
 487 .. autosummary::
 488
 489    Mesh.Smooth
 490    Mesh.SmoothObject
 491    Mesh.SmoothParametric
 492    Mesh.SmoothParametricObject
 493
 494 Duplication of nodes and elements (to emulate cracks)
 495 =====================================================
 496
 497 .. autosummary::
 498
 499    Mesh.DoubleElements
 500    Mesh.DoubleNodes
 501    Mesh.DoubleNode
 502    Mesh.DoubleNodeGroup
 503    Mesh.DoubleNodeGroups
 504    Mesh.DoubleNodeElem
 505    Mesh.DoubleNodeElemInRegion
 506    Mesh.DoubleNodeElemGroup
 507    Mesh.DoubleNodeElemGroupInRegion
 508    Mesh.DoubleNodeElemGroups
 509    Mesh.DoubleNodeElemGroupsInRegion
 510    Mesh.AffectedElemGroupsInRegion
 511    Mesh.DoubleNodesOnGroupBoundaries
 512    Mesh.CreateFlatElementsOnFacesGroups
 513
 514 Renumbering nodes and elements
 515 ==============================
 516
 517 .. autosummary::
 518
 519    Mesh.RenumberNodes
 520    Mesh.RenumberElements
 521
 522
 523 *****************
 524 Auxiliary methods
 525 *****************
 526
 527 .. autosummary::
 528
 529    GetName
 530    DegreesToRadians
 531    New