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.GetGroups
 173    Mesh.NbGroups
 174    Mesh.GetGroupNames
 175    Mesh.GetGroupByName
 176
 177
 178 Using 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    Mesh.CreateDimGroup
 190    Mesh.ConvertToStandalone
 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.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.Dump
 273
 274 ******************************
 275 Quality controls and Filtering
 276 ******************************
 277
 278 .. autosummary::
 279
 280    smeshBuilder.GetEmptyCriterion
 281    smeshBuilder.GetCriterion
 282    smeshBuilder.GetFilter
 283    smeshBuilder.GetFilterFromCriteria
 284    smeshBuilder.GetFunctor
 285    Mesh.GetIdsFromFilter
 286    Mesh.GetMaxElementLength
 287    Mesh.GetAspectRatio
 288    Mesh.GetWarping
 289    Mesh.GetMinimumAngle
 290    Mesh.GetTaper
 291    Mesh.GetSkew
 292    Mesh.GetMinMax
 293    Mesh.IsManifold
 294    Mesh.IsCoherentOrientation2D
 295
 296 ************
 297 Measurements
 298 ************
 299
 300 .. autosummary::
 301
 302    smeshBuilder.MinDistance
 303    smeshBuilder.GetMinDistance
 304    smeshBuilder.BoundingBox
 305    smeshBuilder.GetBoundingBox
 306    smeshBuilder.GetLength
 307    smeshBuilder.GetArea
 308    smeshBuilder.GetVolume
 309    smeshBuilder.GetAngle
 310    Mesh.GetFreeBorders
 311    Mesh.MinDistance
 312    Mesh.GetMinDistance
 313    Mesh.BoundingBox
 314    Mesh.GetBoundingBox
 315    Mesh.GetFunctor
 316    Mesh.FunctorValue
 317    Mesh.GetLength
 318    Mesh.GetArea
 319    Mesh.GetVolume
 320    Mesh.GetAngle
 321
 322 ****************
 323 Modifying meshes
 324 ****************
 325
 326 .. autosummary::
 327
 328    smeshBuilder.GetPattern
 329    Mesh.GetMeshEditor
 330
 331 Adding nodes and elements
 332 =========================
 333
 334 .. autosummary::
 335
 336    Mesh.AddNode
 337    Mesh.Add0DElement
 338    Mesh.Add0DElementsToAllNodes
 339    Mesh.AddBall
 340    Mesh.AddEdge
 341    Mesh.AddFace
 342    Mesh.AddPolygonalFace
 343    Mesh.AddQuadPolygonalFace
 344    Mesh.AddVolume
 345    Mesh.AddPolyhedralVolume
 346    Mesh.AddPolyhedralVolumeByFaces
 347    Mesh.SetNodeOnVertex
 348    Mesh.SetNodeOnEdge
 349    Mesh.SetNodeOnFace
 350    Mesh.SetNodeInVolume
 351    Mesh.SetMeshElementOnShape
 352    Mesh.Make2DMeshFrom3D
 353    Mesh.MakeBoundaryMesh
 354    Mesh.MakeBoundaryElements
 355    Mesh.GetLastCreatedNodes
 356    Mesh.GetLastCreatedElems
 357    Mesh.ClearLastCreated
 358
 359 Removing nodes and elements
 360 ===========================
 361
 362 .. autosummary::
 363
 364    Mesh.RemoveElements
 365    Mesh.RemoveNodes
 366    Mesh.RemoveOrphanNodes
 367
 368 Modifying nodes and elements
 369 ============================
 370
 371 .. autosummary::
 372
 373    Mesh.MoveNode
 374    Mesh.MoveClosestNodeToPoint
 375    Mesh.MeshToPassThroughAPoint
 376    Mesh.ChangeElemNodes
 377
 378 Convert to/from Quadratic Mesh
 379 ==============================
 380
 381 .. autosummary::
 382
 383    Mesh.ConvertToQuadratic
 384    Mesh.ConvertFromQuadratic
 385
 386 Extrusion and Revolution
 387 ========================
 388
 389 .. autosummary::
 390
 391    Mesh.RotationSweepObjects
 392    Mesh.RotationSweep
 393    Mesh.RotationSweepObject
 394    Mesh.RotationSweepObject1D
 395    Mesh.RotationSweepObject2D
 396    Mesh.ExtrusionSweepObjects
 397    Mesh.ExtrusionSweep
 398    Mesh.ExtrusionByNormal
 399    Mesh.ExtrusionSweepObject
 400    Mesh.ExtrusionSweepObject1D
 401    Mesh.ExtrusionSweepObject2D
 402    Mesh.AdvancedExtrusion
 403    Mesh.ExtrusionAlongPathObjects
 404    Mesh.ExtrusionAlongPathX
 405    Mesh.ExtrusionAlongPath
 406    Mesh.ExtrusionAlongPathObject
 407    Mesh.ExtrusionAlongPathObject1D
 408    Mesh.ExtrusionAlongPathObject2D
 409
 410 Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
 411 ======================================================================
 412
 413 .. autosummary::
 414
 415    Mesh.Mirror
 416    Mesh.MirrorMakeMesh
 417    Mesh.MirrorObject
 418    Mesh.MirrorObjectMakeMesh
 419    Mesh.Translate
 420    Mesh.TranslateMakeMesh
 421    Mesh.TranslateObject
 422    Mesh.TranslateObjectMakeMesh
 423    Mesh.Rotate
 424    Mesh.RotateMakeMesh
 425    Mesh.RotateObject
 426    Mesh.RotateObjectMakeMesh
 427    Mesh.FindCoincidentNodes
 428    Mesh.FindCoincidentNodesOnPart
 429    Mesh.MergeNodes
 430    Mesh.FindEqualElements
 431    Mesh.MergeElements
 432    Mesh.MergeEqualElements
 433    Mesh.FindFreeBorders
 434    Mesh.FillHole
 435    Mesh.FindCoincidentFreeBorders
 436    Mesh.SewCoincidentFreeBorders
 437    Mesh.SewFreeBorders
 438    Mesh.SewConformFreeBorders
 439    Mesh.SewBorderToSide
 440    Mesh.SewSideElements
 441
 442 Changing orientation of elements
 443 ================================
 444
 445 .. autosummary::
 446
 447    Mesh.Reorient
 448    Mesh.ReorientObject
 449    Mesh.Reorient2D
 450    Mesh.Reorient2DBy3D
 451
 452 Uniting triangles
 453 =================
 454
 455 .. autosummary::
 456
 457    Mesh.DeleteDiag
 458    Mesh.TriToQuad
 459    Mesh.TriToQuadObject
 460
 461 Cutting elements
 462 ================
 463
 464 .. autosummary::
 465
 466    Mesh.InverseDiag
 467    Mesh.QuadToTri
 468    Mesh.QuadToTriObject
 469    Mesh.QuadTo4Tri
 470    Mesh.SplitQuad
 471    Mesh.SplitQuadObject
 472    Mesh.BestSplit
 473    Mesh.SplitVolumesIntoTetra
 474    Mesh.SplitBiQuadraticIntoLinear
 475    Mesh.SplitHexahedraIntoPrisms
 476    Mesh.SplitQuadsNearTriangularFacets
 477    Mesh.SplitHexaToTetras
 478    Mesh.SplitHexaToPrisms
 479
 480 Smoothing
 481 =========
 482
 483 .. autosummary::
 484
 485    Mesh.Smooth
 486    Mesh.SmoothObject
 487    Mesh.SmoothParametric
 488    Mesh.SmoothParametricObject
 489
 490 Duplication of nodes and elements (to emulate cracks)
 491 =====================================================
 492
 493 .. autosummary::
 494
 495    Mesh.DoubleElements
 496    Mesh.DoubleNodes
 497    Mesh.DoubleNode
 498    Mesh.DoubleNodeGroup
 499    Mesh.DoubleNodeGroups
 500    Mesh.DoubleNodeElem
 501    Mesh.DoubleNodeElemInRegion
 502    Mesh.DoubleNodeElemGroup
 503    Mesh.DoubleNodeElemGroupInRegion
 504    Mesh.DoubleNodeElemGroups
 505    Mesh.DoubleNodeElemGroupsInRegion
 506    Mesh.AffectedElemGroupsInRegion
 507    Mesh.DoubleNodesOnGroupBoundaries
 508    Mesh.CreateFlatElementsOnFacesGroups
 509
 510 Renumbering nodes and elements
 511 ==============================
 512
 513 .. autosummary::
 514
 515    Mesh.RenumberNodes
 516    Mesh.RenumberElements
 517
 518
 519 *****************
 520 Auxiliary methods
 521 *****************
 522
 523 .. autosummary::
 524
 525    GetName
 526    DegreesToRadians
 527    New