This section describes the python packages and modules of the salome.geom python package. The main part is generated from the code documentation included in source python files.
This module provides tools to facilitate the use of geom engine and geom objects in Salome.
This class provides several methods to manipulate geom objects in Salome study. The parameter studyEditor defines a StudyEditor object used to access the study. If None, the method returns a StudyEditor object on the current study.
This instance attribute contains the underlying StudyEditor object. It can be used to access the study but the attribute itself should not be modified.
Display the geometrical shape whose name in the study is shapeName.
| Parameters: |
|
|---|---|
| Returns: | True if the shape was found, False otherwise |
Return an object behaving exactly like geompy module, except that it is associated with the study studyId. If studyId is None, return a pseudo geompy object for the current study.
This package is used to create and visualize structural elements. It contains three modules:
A structural element is a set of geometric shapes (beams, grids, etc.) that are built semi-automatically along a set of geometric primitives (edges for instance). They are visualized with the same color as their base primitives in the geom viewer.
Structural elements are generally created by the StructuralElementManager class, from a list of commands describing the element to create.
Example:
commandList = [('VisuPoutreGenerale', {'Group_Maille': 'Edge_1'}),
('VisuBarreCercle',
{'R': 30, 'Group_Maille': 'Edge_1', 'EP': 15}),
]
structElemManager = StructuralElementManager()
elem = structElemManager.createElement(commandList)
elem.display()
salome.sg.updateObjBrowser(True)
This class manages the structural elements in the study. It is used to create a new structural element from a list of commands. The parameter studyId defines the ID of the study in which the manager will create structural elements. If it is None or not specified, it will use the ID of the current study as defined by salome.kernel.studyedit.getActiveStudyId() function.
Create a structural element from the list of commands commandList. Each command in this list represent a part of the structural element, that is a specific kind of shape (circular beam, grid, etc.) associated with one or several geometrical primitives. A command must be a tuple. The first element is the structural element part class name or alias name. The second element is a dictionary containing the parameters describing the part. Valid class names are all the classes defined in the module parts and inheriting class StructuralElementPart. There are also several aliases for backward compatibility. Here is the complete list:
The valid parameters in the dictionary depend on the type of the structural element part, and are detailed in the documentation of the corresponding class. The only parameter that is common to all the classes is “MeshGroups” (that can also be named “Group_Maille”). It defines the name of the geometrical object(s) in the study that will be used as primitives to build the structural element part. This parameter can be either a list of strings or a single string with comma separated names.
This class represents a structural element, i.e. a set of geometrical objects built along geometrical primitives. The parameter studyId defines the ID of the study that will contain the structural element. If it is None or not specified, the constructor will use the ID of the active study as defined by salome.kernel.studyedit.getActiveStudyId() function. Structural elements are normally created by the class StructuralElementManager, so this class should not be instantiated directly in the general case.
Add orientation information to a part in the structural element. This information will be used to build the corresponding markers.
| Parameters: |
|
|---|
Add a part to the structural element.
| Parameters: | newpart (StructuralElementPart) – the part to add to the structural element. |
|---|
Build the geometric shapes and the markers corresponding to the different parts of the structural element, and add them to the study.
Display the structural element in the geom view.
Display the structural element corresponding to the study object theSObject
This module defines the different structural element parts. It is used to build the geometric shapes of the structural elements. It should not be used directly in the general case. Structural elements should be created by the class StructuralElementManager.
Bases: salome.geom.structelem.parts.StructuralElementPart
This class is an “abstract” class for all 1D structural element parts. It should not be instantiated directly. See class StructuralElementPart for the description of the parameters.
Bases: salome.geom.structelem.parts.Beam
This class defines a beam with a circular section. It can be full or hollow, and its radius and thickness can vary from one end of the beam to the other. The valid parameters for circular beams are:
See class StructuralElementPart for the description of the other parameters.
Bases: salome.geom.structelem.parts.Beam
This class defines a beam with a generic section. It is represented only as the underlying wire. See class StructuralElementPart for the description of the parameters.
Bases: salome.geom.structelem.parts.StructuralElementPart2D
This class defines a grid. A grid is represented by a 2D face patterned with small lines in the main direction of the grid frame. The valid parameters for grids are:
See class StructuralElementPart for the description of the other parameters.
Bases: exceptions.Exception
This exception is raised when an invalid parameter is used to build a structural element part.
Bases: salome.geom.structelem.parts.Beam
This class defines a beam with a rectangular section. It can be full or hollow, and its dimensions can vary from one end of the beam to the other. The valid parameters for rectangular beams are:
See class StructuralElementPart for the description of the other parameters.
This class is the base class for all structural element parts. It should not be instantiated directly (consider it as an “abstract” class).
| Parameters: |
|
|---|
Add orientation information to the structural element part. See class Orientation1D for the description of the parameters.
Build the geometric shapes and the markers corresponding to the structural element part in the study studyId.
Bases: salome.geom.structelem.parts.StructuralElementPart
This class is an “abstract” class for all 2D structural element parts. It should not be instantiated directly. See class StructuralElementPart for the description of the parameters.
This class enables the use of subshapes in sets or as dictionary keys. It implements __eq__ and __hash__ methods so that subshapes with the same CORBA object mainShape and the same id are considered equal.
Return the subshape (GEOM object). geom is a pseudo-geompy object used to find the geometrical object.
Bases: salome.geom.structelem.parts.StructuralElementPart2D
This class defines a shell with a given thickness. It can be shifted from the base face. The valid parameters for thick shells are:
See class StructuralElementPart for the description of the other parameters.
Alias for class CircularBeam.
Alias for class GeneralBeam.
Alias for class RectangularBeam.
Alias for class CircularBeam.
Alias for class ThickShell.
Alias for class Grid.
Alias for class CircularBeam.
Alias for class GeneralBeam.
Alias for class RectangularBeam.
This module is used to compute the orientation of the different parts in a structural element and to build the corresponding markers (trihedrons).
This class is used to compute the orientation of 1D elements and to build the corresponding markers.
Add orientation parameters. params is a dictionary containing one or several orientation parameters. The valid parameters are:
The parameters can be specified several times. In this case, only the first “VECT_Y” is taken into account, and the values of “ANGL_VRIL” are added to obtain the total rotation angle.
Create a marker with origin center and X axis vecX. geom is the pseudo-geompy object used to build the geometric shapes.
Get the vectors Y and Z for the LCS with origin center and X axis vecX. geom is the pseudo-geompy object used to build the geometric shapes.
This class is used to compute the orientation of 2D elements and to build the corresponding markers. Angles alpha and beta are used to determine the local coordinate system for the 2D element. If vect is not None, it is used instead of alpha and beta.
Create a marker with origin center and normal as Z axis. The other axes are computed using the parameters alpha and beta of the Orientation2D instance. geom is the pseudo-geompy object used to build the geometric shapes. warnings can be used to enable or disable the logging of warning messages.