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