smesh/doc/salome/gui/SMESH/input/modules.rst

532 lines
11 KiB
ReStructuredText
Raw Normal View History

2018-05-25 22:04:48 +05:00
########################
Structured documentation
########################
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. contents::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. currentmodule:: smeshBuilder
2017-12-08 19:09:48 +05:00
***************
2018-05-25 22:04:48 +05:00
Creating meshes
2017-12-08 19:09:48 +05:00
***************
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
smeshBuilder.Concatenate
smeshBuilder.CopyMesh
2017-12-08 19:09:48 +05:00
Importing and exporting meshes
2018-05-25 22:04:48 +05:00
==============================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
smeshBuilder.CreateMeshesFromUNV
smeshBuilder.CreateMeshesFromMED
smeshBuilder.CreateMeshesFromSTL
smeshBuilder.CreateMeshesFromCGNS
smeshBuilder.CreateMeshesFromGMF
smeshBuilder.CreateMeshesFromSAUV
Mesh.ExportMED
Mesh.ExportUNV
Mesh.ExportSTL
Mesh.ExportCGNS
Mesh.ExportDAT
Mesh.ExportSAUV
Mesh.ExportGMF
2017-12-08 19:09:48 +05:00
Constructing meshes
2018-05-25 22:04:48 +05:00
===================
.. autosummary::
smeshBuilder.Mesh
Mesh.SetName
Mesh.SetMeshOrder
Mesh.Compute
Mesh.Evaluate
Mesh.Clear
Mesh.GetMesh
Mesh.GetShape
Mesh.HasShapeToMesh
2018-05-25 22:04:48 +05:00
Mesh.GetComputeErrors
Mesh.GetAlgoState
Mesh.GetFailedShapes
Mesh.GetMeshOrder
2017-12-08 19:09:48 +05:00
Defining Algorithms
2018-05-25 22:04:48 +05:00
===================
.. autosummary::
Mesh.Segment
Mesh.Triangle
Mesh.Quadrangle
Mesh.Hexahedron
Mesh.Prism
Mesh.BodyFitted
Mesh.Projection1D
Mesh.Projection2D
Mesh.Projection1D2D
Mesh.Projection3D
Mesh.UseExisting1DElements
Mesh.UseExisting2DElements
Mesh.UseExistingSegments
Mesh.UseExistingFaces
Mesh.AutomaticTetrahedralization
Mesh.AutomaticHexahedralization
smesh_algorithm.Mesh_Algorithm
2017-12-08 19:09:48 +05:00
Defining hypotheses
2018-05-25 22:04:48 +05:00
===================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. currentmodule:: StdMeshersBuilder
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
1D Meshing Hypotheses
---------------------
.. autosummary::
StdMeshersBuilder_Segment.NumberOfSegments
StdMeshersBuilder_Segment.LocalLength
StdMeshersBuilder_Segment.MaxSize
StdMeshersBuilder_Segment.Arithmetic1D
StdMeshersBuilder_Segment.GeometricProgression
StdMeshersBuilder_Segment.FixedPoints1D
StdMeshersBuilder_Segment.StartEndLength
StdMeshersBuilder_Segment.Adaptive
StdMeshersBuilder_Segment.Deflection1D
StdMeshersBuilder_Segment.AutomaticLength
StdMeshersBuilder_Segment_Python.PythonSplit1D
2017-12-08 19:09:48 +05:00
2D Meshing Hypotheses
2018-05-25 22:04:48 +05:00
---------------------
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
StdMeshersBuilder_Triangle_MEFISTO.MaxElementArea
StdMeshersBuilder_Triangle_MEFISTO.LengthFromEdges
StdMeshersBuilder_Quadrangle.QuadrangleParameters
StdMeshersBuilder_Quadrangle.QuadranglePreference
StdMeshersBuilder_Quadrangle.TrianglePreference
StdMeshersBuilder_Quadrangle.Reduced
StdMeshersBuilder_Quadrangle.TriangleVertex
2017-12-08 19:09:48 +05:00
Additional Hypotheses
2018-05-25 22:04:48 +05:00
---------------------
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
smesh_algorithm.Mesh_Algorithm.ViscousLayers
smesh_algorithm.Mesh_Algorithm.ViscousLayers2D
StdMeshersBuilder.StdMeshersBuilder_Segment.Propagation
StdMeshersBuilder.StdMeshersBuilder_Segment.PropagationOfDistribution
StdMeshersBuilder.StdMeshersBuilder_Segment.QuadraticMesh
2017-12-08 19:09:48 +05:00
Constructing sub-meshes
2018-05-25 22:04:48 +05:00
=======================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. currentmodule:: smeshBuilder
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.GetSubMesh
Mesh.ClearSubMesh
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Editing Meshes
==============
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.AddHypothesis
Mesh.RemoveHypothesis
Mesh.RemoveGlobalHypotheses
Mesh.GetHypothesisList
Mesh.IsUsedHypothesis
2017-12-08 19:09:48 +05:00
*****************
Grouping elements
*****************
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.SetAutoColor
Mesh.GetAutoColor
Mesh.HasDuplicatedGroupNamesMED
2017-12-08 19:09:48 +05:00
Creating groups
2018-05-25 22:04:48 +05:00
===============
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.CreateEmptyGroup
Mesh.Group
Mesh.GroupOnGeom
Mesh.GroupOnFilter
Mesh.MakeGroupByIds
Mesh.MakeGroup
Mesh.MakeGroupByCriterion
Mesh.MakeGroupByCriteria
Mesh.MakeGroupByFilter
Mesh.FaceGroupsSeparatedByEdges
Mesh.CreateDimGroup
Mesh.ConvertToStandalone
2018-05-25 22:04:48 +05:00
Mesh.GetGroups
Mesh.NbGroups
Mesh.GetGroupNames
Mesh.GetGroupByName
2017-12-08 19:09:48 +05:00
Operations on groups
====================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.UnionGroups
Mesh.UnionListOfGroups
Mesh.IntersectGroups
Mesh.IntersectListOfGroups
Mesh.CutGroups
Mesh.CutListOfGroups
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Deleting Groups
===============
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.RemoveGroup
Mesh.RemoveGroupWithContents
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
****************
Mesh Information
****************
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
smeshBuilder.GetMeshInfo
Mesh.GetEngine
Mesh.GetGeomEngine
2018-05-25 22:04:48 +05:00
Mesh.GetGeometryByMeshElement
Mesh.MeshDimension
Mesh.GetMeshInfo
Mesh.NbNodes
Mesh.NbElements
Mesh.Nb0DElements
Mesh.NbBalls
Mesh.NbEdges
Mesh.NbEdgesOfOrder
Mesh.NbFaces
Mesh.NbFacesOfOrder
Mesh.NbTriangles
Mesh.NbTrianglesOfOrder
Mesh.NbBiQuadTriangles
Mesh.NbQuadrangles
Mesh.NbQuadranglesOfOrder
Mesh.NbBiQuadQuadrangles
Mesh.NbPolygons
Mesh.NbVolumes
Mesh.NbVolumesOfOrder
Mesh.NbTetras
Mesh.NbTetrasOfOrder
Mesh.NbHexas
Mesh.NbHexasOfOrder
Mesh.NbTriQuadraticHexas
Mesh.NbPyramids
Mesh.NbPyramidsOfOrder
Mesh.NbPrisms
Mesh.NbPrismsOfOrder
Mesh.NbHexagonalPrisms
Mesh.NbPolyhedrons
Mesh.NbSubMesh
Mesh.GetNodesId
Mesh.GetElementsId
Mesh.GetElementsByType
Mesh.GetElementType
Mesh.GetElementGeomType
Mesh.GetElementShape
Mesh.GetSubMeshElementsId
Mesh.GetSubMeshNodesId
Mesh.GetSubMeshElementType
Mesh.GetNodeXYZ
Mesh.GetNodeInverseElements
Mesh.GetNodePosition
Mesh.GetElementPosition
Mesh.GetShapeID
Mesh.GetShapeIDForElem
Mesh.GetElemNbNodes
Mesh.GetElemNode
Mesh.GetElemNodes
Mesh.IsMediumNode
Mesh.IsMediumNodeOfAnyElem
Mesh.ElemNbEdges
Mesh.ElemNbFaces
Mesh.GetElemFaceNodes
Mesh.GetFaceNormal
Mesh.FindElementByNodes
Mesh.GetElementsByNodes
Mesh.IsPoly
Mesh.IsQuadratic
Mesh.GetBallDiameter
Mesh.BaryCenter
Mesh.FindNodeClosestTo
Mesh.FindElementsByPoint
Mesh.GetPointState
Mesh.Get1DBranches
2018-05-25 22:04:48 +05:00
Mesh.Dump
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
******************************
Quality controls and Filtering
******************************
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
smeshBuilder.GetEmptyCriterion
smeshBuilder.GetCriterion
smeshBuilder.GetFilter
smeshBuilder.GetFilterFromCriteria
smeshBuilder.GetFunctor
Mesh.GetIdsFromFilter
Mesh.GetMaxElementLength
Mesh.GetAspectRatio
Mesh.GetWarping
Mesh.GetMinimumAngle
Mesh.GetTaper
Mesh.GetSkew
Mesh.GetMinMax
Mesh.IsManifold
Mesh.IsCoherentOrientation2D
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
************
Measurements
************
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
smeshBuilder.MinDistance
smeshBuilder.GetMinDistance
smeshBuilder.BoundingBox
smeshBuilder.GetBoundingBox
smeshBuilder.GetLength
smeshBuilder.GetArea
smeshBuilder.GetVolume
smeshBuilder.GetAngle
2018-05-25 22:04:48 +05:00
Mesh.GetFreeBorders
Mesh.MinDistance
Mesh.GetMinDistance
Mesh.BoundingBox
Mesh.GetBoundingBox
Mesh.GetFunctor
Mesh.FunctorValue
Mesh.GetLength
Mesh.GetArea
Mesh.GetVolume
Mesh.GetAngle
2017-12-08 19:09:48 +05:00
****************
Modifying meshes
****************
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
smeshBuilder.GetPattern
Mesh.GetMeshEditor
2017-12-08 19:09:48 +05:00
Adding nodes and elements
2018-05-25 22:04:48 +05:00
=========================
.. autosummary::
Mesh.AddNode
Mesh.Add0DElement
Mesh.Add0DElementsToAllNodes
Mesh.AddBall
Mesh.AddEdge
Mesh.AddFace
Mesh.AddPolygonalFace
Mesh.AddQuadPolygonalFace
Mesh.AddVolume
Mesh.AddPolyhedralVolume
Mesh.AddPolyhedralVolumeByFaces
Mesh.SetNodeOnVertex
Mesh.SetNodeOnEdge
Mesh.SetNodeOnFace
Mesh.SetNodeInVolume
Mesh.SetMeshElementOnShape
Mesh.Make2DMeshFrom3D
Mesh.MakeBoundaryMesh
Mesh.MakeBoundaryElements
Mesh.Append
2018-05-25 22:04:48 +05:00
Mesh.GetLastCreatedNodes
Mesh.GetLastCreatedElems
Mesh.ClearLastCreated
2017-12-08 19:09:48 +05:00
Removing nodes and elements
2018-05-25 22:04:48 +05:00
===========================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.RemoveElements
Mesh.RemoveNodes
Mesh.RemoveOrphanNodes
2017-12-08 19:09:48 +05:00
Modifying nodes and elements
2018-05-25 22:04:48 +05:00
============================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.MoveNode
Mesh.MoveClosestNodeToPoint
Mesh.MeshToPassThroughAPoint
Mesh.ChangeElemNodes
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Convert to/from Quadratic Mesh
==============================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.ConvertToQuadratic
Mesh.ConvertFromQuadratic
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Extrusion and Revolution
========================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
Mesh.RotationSweepObjects
Mesh.RotationSweep
Mesh.RotationSweepObject
Mesh.RotationSweepObject1D
Mesh.RotationSweepObject2D
Mesh.ExtrusionSweepObjects
Mesh.ExtrusionSweep
Mesh.ExtrusionByNormal
Mesh.ExtrusionSweepObject
Mesh.ExtrusionSweepObject1D
Mesh.ExtrusionSweepObject2D
Mesh.AdvancedExtrusion
Mesh.ExtrusionAlongPathObjects
Mesh.ExtrusionAlongPathX
Mesh.ExtrusionAlongPath
Mesh.ExtrusionAlongPathObject
Mesh.ExtrusionAlongPathObject1D
Mesh.ExtrusionAlongPathObject2D
2017-12-08 19:09:48 +05:00
Transforming meshes (Translation, Rotation, Symmetry, Sewing, Merging)
2018-05-25 22:04:48 +05:00
======================================================================
.. autosummary::
Mesh.Mirror
Mesh.MirrorMakeMesh
Mesh.MirrorObject
Mesh.MirrorObjectMakeMesh
Mesh.Translate
Mesh.TranslateMakeMesh
Mesh.TranslateObject
Mesh.TranslateObjectMakeMesh
Mesh.Rotate
Mesh.RotateMakeMesh
Mesh.RotateObject
Mesh.RotateObjectMakeMesh
Mesh.FindCoincidentNodes
Mesh.FindCoincidentNodesOnPart
Mesh.MergeNodes
Mesh.FindEqualElements
Mesh.MergeElements
Mesh.MergeEqualElements
Mesh.FindFreeBorders
Mesh.FillHole
Mesh.FindCoincidentFreeBorders
Mesh.SewCoincidentFreeBorders
Mesh.SewFreeBorders
Mesh.SewConformFreeBorders
Mesh.SewBorderToSide
Mesh.SewSideElements
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Changing orientation of elements
================================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.Reorient
Mesh.ReorientObject
Mesh.Reorient2D
Mesh.Reorient2DBy3D
2017-12-08 19:09:48 +05:00
Uniting triangles
2018-05-25 22:04:48 +05:00
=================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.DeleteDiag
Mesh.TriToQuad
Mesh.TriToQuadObject
2017-12-08 19:09:48 +05:00
Cutting elements
2018-05-25 22:04:48 +05:00
================
.. autosummary::
Mesh.InverseDiag
Mesh.QuadToTri
Mesh.QuadToTriObject
Mesh.QuadTo4Tri
Mesh.SplitQuad
Mesh.SplitQuadObject
Mesh.BestSplit
Mesh.SplitVolumesIntoTetra
Mesh.SplitBiQuadraticIntoLinear
Mesh.SplitHexahedraIntoPrisms
Mesh.SplitQuadsNearTriangularFacets
Mesh.SplitHexaToTetras
Mesh.SplitHexaToPrisms
2017-12-08 19:09:48 +05:00
Smoothing
2018-05-25 22:04:48 +05:00
=========
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.Smooth
Mesh.SmoothObject
Mesh.SmoothParametric
Mesh.SmoothParametricObject
2017-12-08 19:09:48 +05:00
Duplication of nodes and elements (to emulate cracks)
2018-05-25 22:04:48 +05:00
=====================================================
.. autosummary::
Mesh.DoubleElements
Mesh.DoubleNodes
Mesh.DoubleNode
Mesh.DoubleNodeGroup
Mesh.DoubleNodeGroups
Mesh.DoubleNodeElem
Mesh.DoubleNodeElemInRegion
Mesh.DoubleNodeElemGroup
Mesh.DoubleNodeElemGroupInRegion
Mesh.DoubleNodeElemGroups
Mesh.DoubleNodeElemGroupsInRegion
Mesh.AffectedElemGroupsInRegion
Mesh.DoubleNodesOnGroupBoundaries
Mesh.CreateFlatElementsOnFacesGroups
Renumbering nodes and elements
==============================
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
Mesh.RenumberNodes
Mesh.RenumberElements
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
*****************
Auxiliary methods
*****************
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
.. autosummary::
2017-12-08 19:09:48 +05:00
2018-05-25 22:04:48 +05:00
GetName
DegreesToRadians
New