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