Grid Class Reference

This class defines a grid. More...

Public Member Functions
def	__init__ (self, groupName, groupGeomObj, parameters, name=DEFAULT_NAME)
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
	xr
	yr
	zr
	vx
	vy
	vz
	offset
	groupName
	name
	geom
	baseShapesSet
	isMainShape
	color

Static Public Attributes
string	DEFAULT_NAME = "Grid"

Private Member Functions
def	_buildPart (self)
	Create the geometrical shapes representing the grid. More...
def	_buildGridForNormalFace (self, face)
	Create the geometrical shapes representing the grid for a given non-cylindrical face. More...
def	_buildGridForCylinderFace (self, face)
	Create the geometrical shapes representing the grid for a given cylindrical face. More...
def	_buildMarkers (self)
	Create the markers defining the orientation of the grid. More...
def	_makeFaceOffset (self, face, offset, epsilon=1e-6)
	Create a copy of a face at a given offset. More...
def	_buildMarkersWithOffset (self, offset)
	Build the markers for the structural element part with a given offset from the base face. 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 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:

• "Excentre": offset of the grid from the base face.
• "angleAlpha": angle used to build the markers (see class salome.geom.structelem.orientation.Orientation2D)
• "angleBeta": angle used to build the markers (see class salome.geom.structelem.orientation.Orientation2D)
• "Vecteur": vector used instead of the angles to build the markers (see salome.geom.structelem.orientation.Orientation2D)
• "origAxeX": X coordinate of the origin of the axis used to determine the orientation of the frame in the case of a cylindrical grid.
• "origAxeY": Y coordinate of the origin of the axis used to determine the orientation of the frame in the case of a cylindrical grid.
• "origAxeZ": Z coordinate of the origin of the axis used to determine the orientation of the frame in the case of a cylindrical grid.
• "axeX": X coordinate of the axis used to determine the orientation of the frame in the case of a cylindrical grid.
• "axeY": Y coordinate of the axis used to determine the orientation of the frame in the case of a cylindrical grid.

• "axeZ": Z coordinate of the axis used to determine the orientation of the frame in the case of a cylindrical grid.

  See class StructuralElementPart for the description of the other parameters.

Constructor & Destructor Documentation

__init__()

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

Reimplemented from StructuralElementPart2D.

Member Function Documentation

_buildPart()

def _buildPart (   self )

private

Create the geometrical shapes representing the grid.

Reimplemented from StructuralElementPart.

References Grid._buildGridForCylinderFace(), Grid._buildGridForNormalFace(), StructuralElementPart._getSubShapes(), Orientation1D.geom, Orientation2D.geom, StructuralElementPart.geom, Grid.vx, Grid.vy, Grid.vz, Grid.xr, Grid.yr, and Grid.zr.

_buildGridForNormalFace()

def _buildGridForNormalFace (   self,   face  )

private

Create the geometrical shapes representing the grid for a given non-cylindrical face.

References StructuralElementPart2D._makeFaceOffset(), StructuralElementPart._orientation, Beam._orientation, StructuralElementPart2D._orientation, Orientation1D.geom, Orientation2D.geom, StructuralElementPart.geom, and StructuralElementPart2D.offset.

_buildGridForCylinderFace()

def _buildGridForCylinderFace (   self,   face  )

private

Create the geometrical shapes representing the grid for a given cylindrical face.

References StructuralElementPart2D._makeFaceOffset(), Orientation1D.geom, Orientation2D.geom, StructuralElementPart.geom, StructuralElementPart2D.offset, Grid.vx, Grid.vy, Grid.vz, Grid.xr, Grid.yr, and Grid.zr.

_buildMarkers()

def _buildMarkers (   self )

private

Create the markers defining the orientation of the grid.

Reimplemented from StructuralElementPart.

References StructuralElementPart2D._buildMarkersWithOffset(), and StructuralElementPart2D.offset.

_makeFaceOffset()

def _makeFaceOffset (   self,   face,   offset,   epsilon = 1e-6  )

privateinherited

Create a copy of a face at a given offset.

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

_buildMarkersWithOffset()

def _buildMarkersWithOffset (   self,   offset  )

privateinherited

Build the markers for the structural element part with a given offset from the base face.

References StructuralElementPart._getSubShapes(), StructuralElementPart2D._makeFaceOffset(), StructuralElementPart._orientation, Beam._orientation, StructuralElementPart2D._orientation, Orientation1D.geom, Orientation2D.geom, and StructuralElementPart.geom.

_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

References InvalidParameterError.groupName, and StructuralElementPart.groupName.

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

Build the geometric shapes and the markers corresponding to the structural element part in the study.

References StructuralElementPart._buildMarkers(), Beam._buildMarkers(), ThickShell._buildMarkers(), Grid._buildMarkers(), StructuralElementPart._buildPart(), Beam._buildPart(), ThickShell._buildPart(), Grid._buildPart(), and StructuralElementPart.color.

_getSubShapes()

def _getSubShapes (   self,   minDim = MIN_LENGTH_FOR_EXTRUSION  )

privateinherited

Find and return the base sub-shapes in the structural element part.

References StructuralElementPart._groupGeomObj, StructuralElementPart.baseShapesSet, Orientation1D.geom, Orientation2D.geom, StructuralElementPart.geom, InvalidParameterError.groupName, StructuralElementPart.groupName, and StructuralElementPart.isMainShape.

Field Documentation

DEFAULT_NAME

string DEFAULT_NAME = "Grid"

static

xr

xr

yr

yr

zr

zr

vx

vx

vy

vy

vz

vz

_orientation

_orientation

privateinherited

offset

offset

inherited

_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