Grid Class Reference

This class defines a grid. More...

Public Member Functions
def	__init__
def	__repr__
def	addOrientation
	Add orientation information to the structural element part. More...
def	build
	Build the geometric shapes and the markers corresponding to the structural element part in the study studyId. 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
	Create the geometrical shapes representing the grid. More...
def	_buildGridForNormalFace
	Create the geometrical shapes representing the grid for a given non-cylindrical face. More...
def	_buildGridForCylinderFace
	Create the geometrical shapes representing the grid for a given cylindrical face. More...
def	_buildMarkers
	Create the markers defining the orientation of the grid. More...

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

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

Member Function Documentation

def _buildPart (   self )

private

Create the geometrical shapes representing the grid.

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

def _buildGridForNormalFace (   self,   face  )

private

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

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

def _buildGridForCylinderFace (   self,   face  )

private

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

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

def _buildMarkers (   self )

private

Create the markers defining the orientation of the grid.

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

def __repr__ (   self )

inherited

References InvalidParameterError.groupName, and StructuralElementPart.groupName.

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.

def build (   self )

inherited

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

References StructuralElementPart._buildMarkers(), StructuralElementPart._buildPart(), and StructuralElementPart.color.

Field Documentation

string DEFAULT_NAME = "Grid"

static

xr

yr

zr

vx

vy

vz

offset

inherited

groupName

inherited

name

inherited

geom

inherited

baseShapesSet

inherited

isMainShape

inherited

color

inherited