Version: 9.15.0
Home

This class is an "abstract" class for all 1D structural element parts. More...

Public Member Functions

def __init__ (self, groupName, groupGeomObj, parameters, name=DEFAULT_NAME, color=None)
 
def __repr__ (self)
 
def addOrientation (self, orientParams)
 Add orientation information to the structural element part. More...
 
def build (self)
 Build the geometric shapes and the markers corresponding to the structural element part in the study. More...
 

Data Fields

 filling
 
 groupName
 
 name
 
 geom
 
 baseShapesSet
 
 isMainShape
 
 color
 

Static Public Attributes

string DEFAULT_NAME = "Beam"
 

Private Member Functions

def _isReversed (self, path)
 This method checks if a 1D object is "reversed", i.e. More...
 
def _getVertexAndTangentOnOrientedWire (self, path, param)
 Get a vertex and the corresponding tangent on a wire by parameter. More...
 
def _makeSolidPipeFromWires (self, wire1, wire2, point1, point2, path)
 Create a solid by the extrusion of section wire1 to section wire2 along path. More...
 
def _buildPart (self)
 Build the structural element part. More...
 
def _buildMarkers (self)
 Build the markers defining the orientation of the structural element part. More...
 
def _getParameter (self, nameList, default=None)
 This method finds the value of a parameter in the parameters dictionary. More...
 
def _getParamUserName (self, paramName)
 This method finds the user name for a parameter. More...
 
def _checkSize (self, value, mindim, expression)
 This method checks that some parameters or some expressions involving those parameters are greater than a minimum value. More...
 
def _getSubShapes (self, minDim=MIN_LENGTH_FOR_EXTRUSION)
 Find and return the base sub-shapes in the structural element part. More...
 

Private Attributes

 _orientation
 
 _parameters
 
 _groupGeomObj
 
 _paramUserName
 

Detailed Description

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.

Constructor & Destructor Documentation

◆ __init__()

def __init__ (   self,
  groupName,
  groupGeomObj,
  parameters,
  name = DEFAULT_NAME,
  color = None 
)

Reimplemented from StructuralElementPart.

Reimplemented in GeneralBeam, RectangularBeam, and CircularBeam.

Member Function Documentation

◆ _isReversed()

def _isReversed (   self,
  path 
)
private

This method checks if a 1D object is "reversed", i.e.

if its orientation is different than the orientation of the underlying OCC object.

References Orientation1D.geom, Orientation2D.geom, and StructuralElementPart.geom.

◆ _getVertexAndTangentOnOrientedWire()

def _getVertexAndTangentOnOrientedWire (   self,
  path,
  param 
)
private

Get a vertex and the corresponding tangent on a wire by parameter.

This method takes into account the "real" orientation of the wire (i.e. the orientation of the underlying OCC object).

References Beam._isReversed(), Orientation1D.geom, Orientation2D.geom, and StructuralElementPart.geom.

◆ _makeSolidPipeFromWires()

def _makeSolidPipeFromWires (   self,
  wire1,
  wire2,
  point1,
  point2,
  path 
)
private

Create a solid by the extrusion of section wire1 to section wire2 along path.

References Orientation1D.geom, Orientation2D.geom, and StructuralElementPart.geom.

◆ _buildPart()

◆ _buildMarkers()

◆ _getParameter()

def _getParameter (   self,
  nameList,
  default = None 
)
privateinherited

This method finds the value of a parameter in the parameters dictionary.

The argument is a list because some parameters can have several different names.

References StructuralElementPart._parameters, and StructuralElementPart._paramUserName.

◆ _getParamUserName()

def _getParamUserName (   self,
  paramName 
)
privateinherited

This method finds the user name for a parameter.

References StructuralElementPart._paramUserName.

◆ __repr__()

def __repr__ (   self)
inherited

◆ addOrientation()

def addOrientation (   self,
  orientParams 
)
inherited

Add orientation information to the structural element part.

See class salome.geom.structelem.orientation.Orientation1D for the description of the parameters.

References StructuralElementPart._orientation, Beam._orientation, and StructuralElementPart2D._orientation.

◆ _checkSize()

def _checkSize (   self,
  value,
  mindim,
  expression 
)
privateinherited

This method checks that some parameters or some expressions involving those parameters are greater than a minimum value.

References InvalidParameterError.groupName, and StructuralElementPart.groupName.

◆ build()

def build (   self)
inherited

◆ _getSubShapes()

Field Documentation

◆ DEFAULT_NAME

string DEFAULT_NAME = "Beam"
static

◆ _orientation

_orientation
private

◆ filling

filling

◆ _parameters

_parameters
privateinherited

◆ groupName

groupName
inherited

◆ _groupGeomObj

_groupGeomObj
privateinherited

◆ _paramUserName

_paramUserName
privateinherited

◆ name

name
inherited

◆ geom

geom
inherited

◆ baseShapesSet

baseShapesSet
inherited

◆ isMainShape

isMainShape
inherited

◆ color

color
inherited