Module Hierarchy

• esys
  • esys.lsm
    • esys.lsm.Logging
    • esys.lsm.benchmarks: Package containing various simulations to be used as a basis for performance analysis.
      • esys.lsm.benchmarks.BondedBlock: Module for running a suite of bonded-block benchmark simulations.
      • esys.lsm.benchmarks.Gravity: Module for running a suite of gravity benchmark simulations.
      • esys.lsm.benchmarks.Util: Common functionality between benchmarks.
      • esys.lsm.benchmarks.compress: Elastically bonded block-compression simulations.
        • esys.lsm.benchmarks.compress.compbench: Defines runSimulation function which executes compression simulation.
      • esys.lsm.benchmarks.gouge2d
        • esys.lsm.benchmarks.gouge2d.gouge2dbench: Defines runSimulation function which executes gouge shear simulation.
    • esys.lsm.doc: Documentation package.
      • esys.lsm.doc.GravityTut
      • esys.lsm.doc.InitialConfigTut
      • esys.lsm.doc.Installation
      • esys.lsm.doc.Overview
      • esys.lsm.doc.VisualisationTut
    • esys.lsm.examples: Example LSM python modules and packages.
      • esys.lsm.examples.DisplacementPlotter
      • esys.lsm.examples.Wave2d
      • esys.lsm.examples.simple: Package containing basic example scripts for running LSM simulations.
        • esys.lsm.examples.simple.compress3d: Example simulation of compression of an elastically bonded block of non-rotational spheres.
      • esys.lsm.examples.waveprop: Wave propagation example package.
        • esys.lsm.examples.waveprop.FixedLidWaveSim: Defines single class FixedLidWaveSim.FixedLidWaveSim which extends WaveSim.WaveSim.
        • esys.lsm.examples.waveprop.OptionParser: Defines classes for parsing command line options of wave propagation simulations.
        • esys.lsm.examples.waveprop.WaveSim
    • esys.lsm.geometry: Defines modules and classes which can be used to generate various packings of particles and creating bonds/connections to be used in conjunction with the LSM.
      • esys.lsm.geometry.SingleParticleGrainGen: Defines the SingleParticleGrainGen class which extends RndGrainGen.
      • esys.lsm.geometry.SphericalGrainGen: Defines classes, instances of which, can be used to generate spherical grains packed with randomly sized circular particles.
    • esys.lsm.sim
      • esys.lsm.sim.WavePropagation
    • esys.lsm.tools
    • esys.lsm.util
      • esys.lsm.util.FileUtil
      • esys.lsm.util.InstallInfo: Provides install path infomation.
      • esys.lsm.util.OptParse: Defines OptionParser class which extends optparse.OptionParser class by adding 'string_list', 'int_list' and 'float_list' option types.
      • esys.lsm.util.PathSearcher
      • esys.lsm.util.Process
    • esys.lsm.vis: Visualisation.
      • esys.lsm.vis.core: Defines common base classes for render packages.
        • esys.lsm.vis.core.Arrow: Defines the Arrow base class
        • esys.lsm.vis.core.ArrowExtractor: Defines the Arrow base class
        • esys.lsm.vis.core.Box: Defines the Box base class
        • esys.lsm.vis.core.Camera: Defines the Camera base class
        • esys.lsm.vis.core.Capsule: Defines the Capsule base class
        • esys.lsm.vis.core.Color: Defines RgbColor base class and Colors pseudo class.
        • esys.lsm.vis.core.Cone: Defines the TruncatedCone and Cone base classes
        • esys.lsm.vis.core.Cylinder: Defines the Cylinder and Disk base classes
        • esys.lsm.vis.core.CylinderExtractor: Defines the CylinderExtractor class.
        • esys.lsm.vis.core.EdgeData: Defines the EdgeData class.
        • esys.lsm.vis.core.EdgeExtractor: Defines the EdgeExtractor class.
        • esys.lsm.vis.core.Exception: Defines helper function raiseNotImplemented for raising an exception in abstract methods of base classes.
        • esys.lsm.vis.core.Extractor: Defines the Extractor base class.
        • esys.lsm.vis.core.GlyphData: Defines GlyphData base class.
        • esys.lsm.vis.core.ImageFormat: Defines the ImageFormat class and functions for mapping a file name extension to an associated ImageFormat object.
        • esys.lsm.vis.core.Modifier: Defines classes which relate to modifying renderable objects.
        • esys.lsm.vis.core.PointExtractor: Defines the PointExtractor class.
        • esys.lsm.vis.core.Scene: Defines the Scene base class.
        • esys.lsm.vis.core.Sphere: Defines the Sphere base class
        • esys.lsm.vis.core.SphereExtractor: Defines the SphereExtractor class.
        • esys.lsm.vis.core.SurfaceData: Defines the SurfaceData class.
        • esys.lsm.vis.core.TriangulatedSurface: Defines the TriangulatedSurface class.