Class Hierarchy

object: The most base type
- unreachable.instance
  - gengeo.AGenerator2D: Abstract base class for 2D InsertGenerators
    - gengeo.HGrainGenerator2D: A particle packing algorithm for filling 2D spaces with hexagonal grains.
    - gengeo.InsertGenerator2D: A particle packing algorithm for filling an AVolume2D space
      - gengeo.HexAggregateInsertGenerator2D: A particle packing algorithm for filling AVolume2D spaces with hexagonal aggregates of particles
        
        gengeo.HexAggregateInsertGenerator2DRand: A particle packing algorithm for filling 2D spaces with hexagonal aggregates of particles
  - gengeo.AGenerator3D: Abstract base class for 3D InsertGenerators
    - gengeo.InsertGenerator3D: A particle packing algorithm for filling AVolume3D spaces.
      - gengeo.HexAggregateInsertGenerator3D: A particle packing algorithm for filling AVolume3D volumes with hexahedral aggregates of particles
  - gengeo.AVolume: Abstract base class for Volume classes in 2D or 3D.
    - gengeo.AVolume2D: Abstract base class for 2D Volumes.
      - gengeo.BoxWithLines2D: A class defining a rectangular volume in 2D optionally bounded by lines.
        
        gengeo.BoxWithLines2DSubVol: A class defining a rectangular sub-volume in 2D bounded by lines.
      - gengeo.CircleVol: A class defining a circular AVolume2D.
      - gengeo.ClippedCircleVol: A class defining a circle in 2D space clipped by lines.
      - gengeo.PolygonWithLines2D: A class defining a polygonal area in 2D space bounded by lines.
      - gengeo.TriWithLines2D: A class defining a triangular AVolume2D bounded by lines.
    - gengeo.AVolume3D: Abstract base class for 3D Volumes.
      - gengeo.BoxWithPlanes3D: A class defining a rectangular volume in 3D optionally bounded by planes.
        
        gengeo.BoxWithJointSet: A class defining a rectangular volume in 3D containing a joint set.
        
        gengeo.ConvexPolyhedron: A class defining a convex polyhedral AVolume3D bounded by planes.
      - gengeo.ClippedSphereVol: A class defining a sphere in 3D space clipped by planes.
      - gengeo.CylinderVol: A class defining a cylindrical AVolume3D.
        
        gengeo.DogBone: A class defining a dogbone volume.
      - gengeo.CylinderWithJointSet: A class defining a cylinder in 3D space containing an optional joint set.
      - gengeo.DifferenceVol: A class defining a volume consisting of the difference between two volumes
      - gengeo.EllipsoidVol: A class defining an ellipsoid.
      - gengeo.IntersectionVol: A class defining a volume consisting of the intersection of two volumes in 3D.
      - gengeo.MeshVolume: A class defining a volume bounded by a triangle mesh.
        
        gengeo.MeshVolWithJointSet: A class defining a volume bounded by a triangle mesh containing joints.
      - gengeo.SphereSectionVol: A class defining a section of a spherical AVolume3D.
      - gengeo.SphereVol: A class defining a spherical AVolume3D.
        
        gengeo.SphereVolWithJointSet: A class defining a spherical AVolume3D containing joints.
      - gengeo.TriBox: A class defining a triangular prism AVolume3D bounded by planes.
      - gengeo.UnionVol: A class defining a volume consisting of the union of two volumes in 3D.
  - gengeo.Line2D: A class defining a line in 2D space.
    - gengeo.LineSegment2D: A class defining a line segment in 2 dimensions.
  - gengeo.MNTable2D: A multi-group neighbour table for constructing 2D particle assemblies
    - gengeo.CircMNTable2D: A multi-group neighbours table for constructing 2D particle setups with circular boundary conditions in the X-direction.
      - gengeo.CircMNTableXY2D: A multi-group neighbours table for constructing 2D particle setups with circular boundary conditions in both (X and Y) directions.
    - gengeo.CircMNTableXY2D: A multi-group neighbours table for constructing 2D particle setups with circular boundary conditions in both (X and Y) directions.
  - gengeo.MNTable3D: A multi-group neighbour table for constructing 3D particle assemblies
    - gengeo.CircMNTable3D: A multi-group neighbours table for constructing 3D particle setups with circular boundary conditions in the X-direction.
      - gengeo.FullCircMNTable3D: A multi-group neighbours table for constructing 3D particle setups with circular boundary conditions in all three directions (X, Y and Z).
  - gengeo.Plane: A class defining a plane in 3D space.
  - gengeo.Shape: A shape designed for insertion into a ShapeList.
  - gengeo.ShapeList: A list of 3D shapes to be inserted into a packing by replacing spheres with scaled versions of the specified shape.
  - gengeo.Sphere: A class defining a sphere.
  - gengeo.TriPatchSet: A collection of triangular patches defining a joint set
  - gengeo.Vector3: A class defining a location or vector in 3D space