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.GetGroups
 172    Mesh.NbGroups
 173    Mesh.GetGroupNames
 174    Mesh.GetGroupByName
 175
 176
 177 Using operations on groups
 178 ==========================
 179
 180 .. autosummary::
 181
 182    Mesh.UnionGroups
 183    Mesh.UnionListOfGroups
 184    Mesh.IntersectGroups
 185    Mesh.IntersectListOfGroups
 186    Mesh.CutGroups
 187    Mesh.CutListOfGroups
 188    Mesh.CreateDimGroup
 189    Mesh.ConvertToStandalone
 190
 191 Deleting Groups
 192 ===============
 193
 194 .. autosummary::
 195
 196    Mesh.RemoveGroup
 197    Mesh.RemoveGroupWithContents
 198
 199 ****************
 200 Mesh Information
 201 ****************
 202
 203 .. autosummary::
 204
 205    smeshBuilder.GetMeshInfo
 206    Mesh.GetGeometryByMeshElement
 207    Mesh.MeshDimension
 208    Mesh.GetMeshInfo
 209    Mesh.NbNodes
 210    Mesh.NbElements
 211    Mesh.Nb0DElements
 212    Mesh.NbBalls
 213    Mesh.NbEdges
 214    Mesh.NbEdgesOfOrder
 215    Mesh.NbFaces
 216    Mesh.NbFacesOfOrder
 217    Mesh.NbTriangles
 218    Mesh.NbTrianglesOfOrder
 219    Mesh.NbBiQuadTriangles
 220    Mesh.NbQuadrangles
 221    Mesh.NbQuadranglesOfOrder
 222    Mesh.NbBiQuadQuadrangles
 223    Mesh.NbPolygons
 224    Mesh.NbVolumes
 225    Mesh.NbVolumesOfOrder
 226    Mesh.NbTetras
 227    Mesh.NbTetrasOfOrder
 228    Mesh.NbHexas
 229    Mesh.NbHexasOfOrder
 230    Mesh.NbTriQuadraticHexas
 231    Mesh.NbPyramids
 232    Mesh.NbPyramidsOfOrder
 233    Mesh.NbPrisms
 234    Mesh.NbPrismsOfOrder
 235    Mesh.NbHexagonalPrisms
 236    Mesh.NbPolyhedrons
 237    Mesh.NbSubMesh
 238    Mesh.GetNodesId
 239    Mesh.GetElementsId
 240    Mesh.GetElementsByType
 241    Mesh.GetElementType
 242    Mesh.GetElementGeomType
 243    Mesh.GetElementShape
 244    Mesh.GetSubMeshElementsId
 245    Mesh.GetSubMeshNodesId
 246    Mesh.GetSubMeshElementType
 247    Mesh.GetNodeXYZ
 248    Mesh.GetNodeInverseElements
 249    Mesh.GetNodePosition
 250    Mesh.GetElementPosition
 251    Mesh.GetShapeID
 252    Mesh.GetShapeIDForElem
 253    Mesh.GetElemNbNodes
 254    Mesh.GetElemNode
 255    Mesh.GetElemNodes
 256    Mesh.IsMediumNode
 257    Mesh.IsMediumNodeOfAnyElem
 258    Mesh.ElemNbEdges
 259    Mesh.ElemNbFaces
 260    Mesh.GetElemFaceNodes
 261    Mesh.GetFaceNormal
 262    Mesh.FindElementByNodes
 263    Mesh.GetElementsByNodes
 264    Mesh.IsPoly
 265    Mesh.IsQuadratic
 266    Mesh.GetBallDiameter
 267    Mesh.BaryCenter
 268    Mesh.FindNodeClosestTo
 269    Mesh.FindElementsByPoint
 270    Mesh.GetPointState
 271    Mesh.Dump
 272
 273 ******************************
 274 Quality controls and Filtering
 275 ******************************
 276
 277 .. autosummary::
 278
 279    smeshBuilder.GetEmptyCriterion
 280    smeshBuilder.GetCriterion
 281    smeshBuilder.GetFilter
 282    smeshBuilder.GetFilterFromCriteria
 283    smeshBuilder.GetFunctor
 284    Mesh.GetIdsFromFilter
 285    Mesh.GetMaxElementLength
 286    Mesh.GetAspectRatio
 287    Mesh.GetWarping
 288    Mesh.GetMinimumAngle
 289    Mesh.GetTaper
 290    Mesh.GetSkew
 291    Mesh.GetMinMax
 292    Mesh.IsManifold
 293    Mesh.IsCoherentOrientation2D
 294
 295 ************
 296 Measurements
 297 ************
 298
 299 .. autosummary::
 300
 301    smeshBuilder.MinDistance
 302    smeshBuilder.GetMinDistance
 303    smeshBuilder.BoundingBox
 304    smeshBuilder.GetBoundingBox
 305    smeshBuilder.GetLength
 306    smeshBuilder.GetArea
 307    smeshBuilder.GetVolume
 308    Mesh.GetFreeBorders
 309    Mesh.MinDistance
 310    Mesh.GetMinDistance
 311    Mesh.BoundingBox
 312    Mesh.GetBoundingBox
 313    Mesh.GetFunctor
 314    Mesh.FunctorValue
 315    Mesh.GetLength
 316    Mesh.GetArea
 317    Mesh.GetVolume
 318
 319 ****************
 320 Modifying meshes
 321 ****************
 322
 323 .. autosummary::
 324
 325    smeshBuilder.GetPattern
 326    Mesh.GetMeshEditor
 327
 328 Adding nodes and elements
 329 =========================
 330
 331 .. autosummary::
 332
 333    Mesh.AddNode
 334    Mesh.Add0DElement
 335    Mesh.Add0DElementsToAllNodes
 336    Mesh.AddBall
 337    Mesh.AddEdge
 338    Mesh.AddFace
 339    Mesh.AddPolygonalFace
 340    Mesh.AddQuadPolygonalFace
 341    Mesh.AddVolume
 342    Mesh.AddPolyhedralVolume
 343    Mesh.AddPolyhedralVolumeByFaces
 344    Mesh.SetNodeOnVertex
 345    Mesh.SetNodeOnEdge
 346    Mesh.SetNodeOnFace
 347    Mesh.SetNodeInVolume
 348    Mesh.SetMeshElementOnShape
 349    Mesh.Make2DMeshFrom3D
 350    Mesh.MakeBoundaryMesh
 351    Mesh.MakeBoundaryElements
 352    Mesh.GetLastCreatedNodes
 353    Mesh.GetLastCreatedElems
 354    Mesh.ClearLastCreated
 355
 356 Removing nodes and elements
 357 ===========================
 358
 359 .. autosummary::
 360
 361    Mesh.RemoveElements
 362    Mesh.RemoveNodes
 363    Mesh.RemoveOrphanNodes
 364
 365 Modifying nodes and elements
 366 ============================
 367
 368 .. autosummary::
 369
 370    Mesh.MoveNode
 371    Mesh.MoveClosestNodeToPoint
 372    Mesh.MeshToPassThroughAPoint
 373    Mesh.ChangeElemNodes
 374
 375 Convert to/from Quadratic Mesh
 376 ==============================
 377
 378 .. autosummary::
 379
 380    Mesh.ConvertToQuadratic
 381    Mesh.ConvertFromQuadratic
 382
 383 Extrusion and Revolution
 384 ========================
 385
 386 .. autosummary::
 387
 388    Mesh.RotationSweepObjects
 389    Mesh.RotationSweep
 390    Mesh.RotationSweepObject
 391    Mesh.RotationSweepObject1D
 392    Mesh.RotationSweepObject2D
 393    Mesh.ExtrusionSweepObjects
 394    Mesh.ExtrusionSweep
 395    Mesh.ExtrusionByNormal
 396    Mesh.ExtrusionSweepObject
 397    Mesh.ExtrusionSweepObject1D
 398    Mesh.ExtrusionSweepObject2D
 399    Mesh.AdvancedExtrusion
 400    Mesh.ExtrusionAlongPathObjects
 401    Mesh.ExtrusionAlongPathX
 402    Mesh.ExtrusionAlongPath
 403    Mesh.ExtrusionAlongPathObject
 404    Mesh.ExtrusionAlongPathObject1D
 405    Mesh.ExtrusionAlongPathObject2D
 406
 407 Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
 408 ======================================================================
 409
 410 .. autosummary::
 411
 412    Mesh.Mirror
 413    Mesh.MirrorMakeMesh
 414    Mesh.MirrorObject
 415    Mesh.MirrorObjectMakeMesh
 416    Mesh.Translate
 417    Mesh.TranslateMakeMesh
 418    Mesh.TranslateObject
 419    Mesh.TranslateObjectMakeMesh
 420    Mesh.Rotate
 421    Mesh.RotateMakeMesh
 422    Mesh.RotateObject
 423    Mesh.RotateObjectMakeMesh
 424    Mesh.FindCoincidentNodes
 425    Mesh.FindCoincidentNodesOnPart
 426    Mesh.MergeNodes
 427    Mesh.FindEqualElements
 428    Mesh.MergeElements
 429    Mesh.MergeEqualElements
 430    Mesh.FindFreeBorders
 431    Mesh.FillHole
 432    Mesh.FindCoincidentFreeBorders
 433    Mesh.SewCoincidentFreeBorders
 434    Mesh.SewFreeBorders
 435    Mesh.SewConformFreeBorders
 436    Mesh.SewBorderToSide
 437    Mesh.SewSideElements
 438
 439 Changing orientation of elements
 440 ================================
 441
 442 .. autosummary::
 443
 444    Mesh.Reorient
 445    Mesh.ReorientObject
 446    Mesh.Reorient2D
 447    Mesh.Reorient2DBy3D
 448
 449 Uniting triangles
 450 =================
 451
 452 .. autosummary::
 453
 454    Mesh.DeleteDiag
 455    Mesh.TriToQuad
 456    Mesh.TriToQuadObject
 457
 458 Cutting elements
 459 ================
 460
 461 .. autosummary::
 462
 463    Mesh.InverseDiag
 464    Mesh.QuadToTri
 465    Mesh.QuadToTriObject
 466    Mesh.QuadTo4Tri
 467    Mesh.SplitQuad
 468    Mesh.SplitQuadObject
 469    Mesh.BestSplit
 470    Mesh.SplitVolumesIntoTetra
 471    Mesh.SplitBiQuadraticIntoLinear
 472    Mesh.SplitHexahedraIntoPrisms
 473    Mesh.SplitQuadsNearTriangularFacets
 474    Mesh.SplitHexaToTetras
 475    Mesh.SplitHexaToPrisms
 476
 477 Smoothing
 478 =========
 479
 480 .. autosummary::
 481
 482    Mesh.Smooth
 483    Mesh.SmoothObject
 484    Mesh.SmoothParametric
 485    Mesh.SmoothParametricObject
 486
 487 Duplication of nodes and elements (to emulate cracks)
 488 =====================================================
 489
 490 .. autosummary::
 491
 492    Mesh.DoubleElements
 493    Mesh.DoubleNodes
 494    Mesh.DoubleNode
 495    Mesh.DoubleNodeGroup
 496    Mesh.DoubleNodeGroups
 497    Mesh.DoubleNodeElem
 498    Mesh.DoubleNodeElemInRegion
 499    Mesh.DoubleNodeElemGroup
 500    Mesh.DoubleNodeElemGroupInRegion
 501    Mesh.DoubleNodeElemGroups
 502    Mesh.DoubleNodeElemGroupsInRegion
 503    Mesh.AffectedElemGroupsInRegion
 504    Mesh.DoubleNodesOnGroupBoundaries
 505    Mesh.CreateFlatElementsOnFacesGroups
 506
 507 Renumbering nodes and elements
 508 ==============================
 509
 510 .. autosummary::
 511
 512    Mesh.RenumberNodes
 513    Mesh.RenumberElements
 514
 515
 516 *****************
 517 Auxiliary methods
 518 *****************
 519
 520 .. autosummary::
 521
 522    GetName
 523    DegreesToRadians
 524    New