Package schrodinger :: Package application :: Package matsci :: Module shapes :: Class Slab

[frames] | no frames]

Class Slab

      object --+        
               |        
ConvexPolyhedron --+    
                   |    
      Parallelepiped --+
                       |
          object --+   |
                   |   |
    ConvexPolyhedron --+
                       |
                      Slab

Class to manage a slab.

Instance Methods

__init__(self, a_param, b_param, c_param, center=ORIGIN, ref_face_idx=1, ref_face_normal_along=Z_AXIS, ref_edge_idx=1, ref_edge_along=X_AXIS)
Create an instance.

Inherited from Parallelepiped: getLatticeVectors, getParallelepipedVertices, getVolume

Inherited from ConvexPolyhedron: addAlignmentAxesToTemplate, addNormalsToTemplate, addPointsToTemplate, addSegmentPlaneIntersectionsToTemplate, alignPolyhedron, allFacesIntersected, getFaces, getReferenceFaces, getSegmentPlaneIntersections, getSurfaceArea, getVertices, makeTemplate, pointInside, translateVertices, updateShape

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

NAME = 'slab'

DEFAULT = [5.0, 10.0, 12.0]

DESCRIPTION = ['edge a length', 'edge b length', 'edge c length']

Inherited from Parallelepiped: INDICES, NUM_UNIQUE_EDGES, NUM_UNIQUE_FACES, TYPE

Properties

Inherited from object: __class__

Method Details

init(self, a_param, b_param, c_param, center=ORIGIN, ref_face_idx=1, ref_face_normal_along=Z_AXIS, ref_edge_idx=1, ref_edge_along=X_AXIS)
(Constructor)

Create an instance.

Parameters:

a_param (float) - the length of the parallelepiped along edge a
b_param (float) - the length of the parallelepiped along edge b
c_param (float) - the length of the parallelepiped along edge c
center (numpy.array) - the center of the polyhedron
ref_face_idx (int) - specifies which of this polyhedron's available reference faces (symmetry unique faces sorted by decreasing area) to use in the alignment
ref_face_normal_along (numpy.array triple) - specifies the vector along which the reference face normal will be aligned
ref_edge_idx (int) - specifies which of the reference faces available reference edges (symmetry unique edges sorted by decreasing length) to use in the alignment
ref_edge_along (numpy.array triple) - specifies the vector along which the reference edge will be aligned

Overrides: object.__init__