doc/gui/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_Quadrangle.QuadrangleParameters
 106    StdMeshersBuilder_Quadrangle.QuadranglePreference
 107    StdMeshersBuilder_Quadrangle.TrianglePreference
 108    StdMeshersBuilder_Quadrangle.Reduced
 109    StdMeshersBuilder_Quadrangle.TriangleVertex
 110
 111 Additional Hypotheses
 112 ---------------------
 113
 114 .. autosummary::
 115
 116    smesh_algorithm.Mesh_Algorithm.ViscousLayers
 117    smesh_algorithm.Mesh_Algorithm.ViscousLayers2D
 118    StdMeshersBuilder.StdMeshersBuilder_Segment.Propagation
 119    StdMeshersBuilder.StdMeshersBuilder_Segment.PropagationOfDistribution
 120    StdMeshersBuilder.StdMeshersBuilder_Segment.QuadraticMesh
 121
 122 Constructing sub-meshes
 123 =======================
 124
 125 .. currentmodule:: smeshBuilder
 126
 127 .. autosummary::
 128
 129    Mesh.GetSubMesh
 130    Mesh.ClearSubMesh
 131
 132 Editing Meshes
 133 ==============
 134
 135 .. autosummary::
 136
 137    Mesh.AddHypothesis
 138    Mesh.RemoveHypothesis
 139    Mesh.RemoveGlobalHypotheses
 140    Mesh.GetHypothesisList
 141    Mesh.IsUsedHypothesis
 142
 143 *****************
 144 Grouping elements
 145 *****************
 146
 147 .. autosummary::
 148
 149    Mesh.SetAutoColor
 150    Mesh.GetAutoColor
 151    Mesh.HasDuplicatedGroupNamesMED
 152
 153 Creating groups
 154 ===============
 155
 156 .. autosummary::
 157
 158    Mesh.CreateEmptyGroup
 159    Mesh.Group
 160    Mesh.GroupOnGeom
 161    Mesh.GroupOnFilter
 162    Mesh.MakeGroupByIds
 163    Mesh.MakeGroup
 164    Mesh.MakeGroupByCriterion
 165    Mesh.MakeGroupByCriteria
 166    Mesh.MakeGroupByFilter
 167    Mesh.FaceGroupsSeparatedByEdges
 168    Mesh.CreateDimGroup
 169    Mesh.ConvertToStandalone
 170    Mesh.GetGroups
 171    Mesh.NbGroups
 172    Mesh.GetGroupNames
 173    Mesh.GetGroupByName
 174
 175
 176 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
 188 Deleting Groups
 189 ===============
 190
 191 .. autosummary::
 192
 193    Mesh.RemoveGroup
 194    Mesh.RemoveGroupWithContents
 195
 196 ****************
 197 Mesh Information
 198 ****************
 199
 200 .. autosummary::
 201
 202    smeshBuilder.GetMeshInfo
 203    Mesh.GetEngine
 204    Mesh.GetGeomEngine
 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.Get1DBranches
 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    smeshBuilder.GetAngle
 309    Mesh.GetFreeBorders
 310    Mesh.MinDistance
 311    Mesh.GetMinDistance
 312    Mesh.BoundingBox
 313    Mesh.GetBoundingBox
 314    Mesh.GetFunctor
 315    Mesh.FunctorValue
 316    Mesh.GetLength
 317    Mesh.GetArea
 318    Mesh.GetVolume
 319    Mesh.GetAngle
 320
 321 ****************
 322 Modifying meshes
 323 ****************
 324
 325 .. autosummary::
 326
 327    smeshBuilder.GetPattern
 328    Mesh.GetMeshEditor
 329
 330 Adding nodes and elements
 331 =========================
 332
 333 .. autosummary::
 334
 335    Mesh.AddNode
 336    Mesh.Add0DElement
 337    Mesh.Add0DElementsToAllNodes
 338    Mesh.AddBall
 339    Mesh.AddEdge
 340    Mesh.AddFace
 341    Mesh.AddPolygonalFace
 342    Mesh.AddQuadPolygonalFace
 343    Mesh.AddVolume
 344    Mesh.AddPolyhedralVolume
 345    Mesh.AddPolyhedralVolumeByFaces
 346    Mesh.SetNodeOnVertex
 347    Mesh.SetNodeOnEdge
 348    Mesh.SetNodeOnFace
 349    Mesh.SetNodeInVolume
 350    Mesh.SetMeshElementOnShape
 351    Mesh.Make2DMeshFrom3D
 352    Mesh.MakeBoundaryMesh
 353    Mesh.MakeBoundaryElements
 354    Mesh.Append
 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.RemoveNodeWithReconnection
 367    Mesh.RemoveOrphanNodes
 368
 369 Modifying nodes and elements
 370 ============================
 371
 372 .. autosummary::
 373
 374    Mesh.MoveNode
 375    Mesh.MoveClosestNodeToPoint
 376    Mesh.MeshToPassThroughAPoint
 377    Mesh.ChangeElemNodes
 378
 379 Convert to/from Quadratic Mesh
 380 ==============================
 381
 382 .. autosummary::
 383
 384    Mesh.ConvertToQuadratic
 385    Mesh.ConvertFromQuadratic
 386
 387 Extrusion and Revolution
 388 ========================
 389
 390 .. autosummary::
 391
 392    Mesh.RotationSweepObjects
 393    Mesh.RotationSweep
 394    Mesh.RotationSweepObject
 395    Mesh.RotationSweepObject1D
 396    Mesh.RotationSweepObject2D
 397    Mesh.ExtrusionSweepObjects
 398    Mesh.ExtrusionSweep
 399    Mesh.ExtrusionByNormal
 400    Mesh.ExtrusionSweepObject
 401    Mesh.ExtrusionSweepObject1D
 402    Mesh.ExtrusionSweepObject2D
 403    Mesh.AdvancedExtrusion
 404    Mesh.ExtrusionAlongPathObjects
 405    Mesh.ExtrusionAlongPathX
 406    Mesh.ExtrusionAlongPath
 407    Mesh.ExtrusionAlongPathObject
 408    Mesh.ExtrusionAlongPathObject1D
 409    Mesh.ExtrusionAlongPathObject2D
 410
 411 Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
 412 ======================================================================
 413
 414 .. autosummary::
 415
 416    Mesh.Mirror
 417    Mesh.MirrorMakeMesh
 418    Mesh.MirrorObject
 419    Mesh.MirrorObjectMakeMesh
 420    Mesh.Translate
 421    Mesh.TranslateMakeMesh
 422    Mesh.TranslateObject
 423    Mesh.TranslateObjectMakeMesh
 424    Mesh.Rotate
 425    Mesh.RotateMakeMesh
 426    Mesh.RotateObject
 427    Mesh.RotateObjectMakeMesh
 428    Mesh.FindCoincidentNodes
 429    Mesh.FindCoincidentNodesOnPart
 430    Mesh.MergeNodes
 431    Mesh.FindEqualElements
 432    Mesh.MergeElements
 433    Mesh.MergeEqualElements
 434    Mesh.FindFreeBorders
 435    Mesh.FillHole
 436    Mesh.FindCoincidentFreeBorders
 437    Mesh.SewCoincidentFreeBorders
 438    Mesh.SewFreeBorders
 439    Mesh.SewConformFreeBorders
 440    Mesh.SewBorderToSide
 441    Mesh.SewSideElements
 442
 443 Changing orientation of elements
 444 ================================
 445
 446 .. autosummary::
 447
 448    Mesh.Reorient
 449    Mesh.ReorientObject
 450    Mesh.Reorient2D
 451    Mesh.Reorient2DByNeighbours
 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    Mesh.AddNodeOnSegment
 482    Mesh.AddNodeOnFace
 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