Trees       Indices       Help   
2015-3 Schrodinger Python API
Package schrodinger :: Package application :: Package matsci :: Module shapes :: Class Cube
[hide private]
[frames] | no frames]

Class Cube

      object --+    
               |    
ConvexPolyhedron --+
                   |
                  Cube

Class to manage a cube.

Instance Methods [hide private]
 
__init__(self, scale, center=ORIGIN, ref_face_idx=1, ref_face_normal_along=Z_AXIS, ref_edge_idx=1, ref_edge_along=X_AXIS)
Create an instance.
float
getEdgeLength(self, circumradius)
Return the edge length.
float
getCircumRadius(self, length)
Return the circumradius.
float
getVolume(self, length)
Return the volume.

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 [hide private]
  NAME = 'cube'
  DEFAULT = [5.0]
  DESCRIPTION = ['edge length']
  TYPE = 'platonic'
  VERTICES = [0.5* numpy.array(vertex) for vertex in VERTICES]
  INDICES = [[1, 3, 4, 2], [5, 1, 2, 6], [7, 5, 6, 8], [3, 7, 8,...
  NUM_UNIQUE_EDGES = 1
  NUM_UNIQUE_FACES = 1
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, scale, 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:
  • scale (float) - multiplicative scaling factor
  • 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__

getEdgeLength(self, circumradius)

 

Return the edge length.

Parameters:
  • circumradius (float) - circumradius in Angstrom
Returns: float
edge length in Angstrom

getCircumRadius(self, length)

 

Return the circumradius.

Parameters:
  • length (float) - length in Angstrom
Returns: float
circumradius in Angstrom

getVolume(self, length)

 

Return the volume.

Parameters:
  • length (float) - length in Angstrom
Returns: float
volume in cubic Angstrom

Class Variable Details [hide private]

INDICES

Value:
[[1, 3, 4, 2], [5, 1, 2, 6], [7, 5, 6, 8], [3, 7, 8, 4], [1, 5, 7, 3],\
 [4, 8, 6, 2]]

   Trees       Indices       Help   
2015-3 Schrodinger Python API
Generated by Epydoc 3.0.1 on Thu Aug 6 04:50:42 2015 http://epydoc.sourceforge.net